diff --git a/.github/workflows/star-check.yml b/.github/workflows/star-check.yml deleted file mode 100644 index 24d6c17..0000000 --- a/.github/workflows/star-check.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: Check if PR author has starred required repositories -on: - pull_request: - types: [opened, synchronize, reopened] -jobs: - check-starred: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - - name: Get PR author username and repo info - id: get-info - run: | - echo "username=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV - echo "current_repo=${{ github.event.repository.name }}" >> $GITHUB_ENV - echo "current_owner=${{ github.repository_owner }}" >> $GITHUB_ENV - - name: Pull github provider - uses: stackql/stackql-exec@v2.2.1 - with: - is_command: 'true' - query: "REGISTRY PULL github;" - - name: Run stackql query - id: check-star - uses: stackql/stackql-assert@v2.2.1 - with: - test_query: | - SELECT repo, count(*) as has_starred - FROM github.activity.repo_stargazers - WHERE owner = '${{ env.current_owner }}' and repo IN ('stackql','${{ env.current_repo }}') - AND login = '${{ env.username }}' - GROUP BY repo; - expected_results_str: '[{"has_starred":"1","repo":"stackql"},{"has_starred":"1","repo":"${{ env.current_repo }}"}]' - continue-on-error: true - - name: Check if starred - if: always() # Ensures this runs regardless of check-star outcome - run: | - if [ "${{ steps.check-star.outcome }}" = "success" ]; then - echo "::notice::Thanks for your support!" - else - echo "::error::It seems you haven't starred the required repositories. Please star the following repos before proceeding: https://github.com/${{ env.current_owner }}/${{ env.current_repo }} (this repo) and https://github.com/stackql/stackql (our core repo)" - exit 1 - fi \ No newline at end of file diff --git a/.gitignore b/.gitignore index 1844196..24d9d59 100644 --- a/.gitignore +++ b/.gitignore @@ -46,9 +46,7 @@ output/ .stackql/ stackql stackql-zip -stackql-aws-cloud-shell.sh -stackql-azure-cloud-shell.sh -stackql-google-cloud-shell.sh +stackql-*.sh .env nohup.out diff --git a/README.md b/README.md index 33e3b42..8c5b49d 100644 --- a/README.md +++ b/README.md @@ -28,35 +28,18 @@ Next, split the monolithic OpenAPI specification into service-specific files: rm -rf provider-dev/source/* npm run split -- \ --provider-name github \ - --api-doc provider-dev/downloaded/github-openapi.json \ + --api-doc provider-dev/downloaded/api.github.com.json \ --svc-discriminator tag \ --output-dir provider-dev/source \ - --overwrite \ - --svc-name-overrides "$(cat < { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const providerDir = getArg('--provider-dir'); - const outputDir = getArg('--output-dir'); - const providerDataDir = getArg('--provider-data-dir'); - - if (!providerName || !providerDir || !outputDir || !providerDataDir) { - console.error('Error: Missing required arguments'); - console.error('Usage: node generate-docs.mjs --provider-name NAME --provider-dir DIR --output-dir DIR --provider-data-dir DIR'); - process.exit(1); - } - - try { - console.log(`Generating docs for provider: ${providerName}`); - console.log(`Provider directory: ${providerDir}`); - console.log(`Output directory: ${outputDir}`); - console.log(`Provider data directory: ${providerDataDir}`); - - const result = await docgen.generateDocs({ - providerName, - providerDir, - outputDir, - providerDataDir - }); - - console.log('Documentation generated successfully:', result); - } catch (error) { - console.error('Error generating documentation:', error); - process.exit(1); - } -} - -generateDocs(); \ No newline at end of file diff --git a/bin/generate-docs.sh b/bin/generate-docs.sh deleted file mode 100644 index 0602e15..0000000 --- a/bin/generate-docs.sh +++ /dev/null @@ -1,63 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --provider-dir) - PROVIDER_DIR="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --provider-data-dir) - PROVIDER_DATA_DIR="$2" - shift 2 - ;; - --help) - echo "Usage: generate-docs.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name (default: snowflake)" - echo " --provider-dir DIR Provider directory path (default: $PROVIDER_DIR)" - echo " --output-dir DIR Output directory for docs (default: $OUTPUT_DIR)" - echo " --provider-data-dir DIR Provider data directory (default: $PROVIDER_DATA_DIR)" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -echo "πŸ“š Generating documentation using @stackql/provider-utils..." - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/generate-docs.mjs" \ - --provider-name "$PROVIDER_NAME" \ - --provider-dir "$PROVIDER_DIR" \ - --output-dir "$OUTPUT_DIR" \ - --provider-data-dir "$PROVIDER_DATA_DIR" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Documentation generation failed" - exit 1 -fi - -echo "βœ… Documentation generated successfully" \ No newline at end of file diff --git a/bin/generate-mappings.mjs b/bin/generate-mappings.mjs deleted file mode 100644 index f711fbc..0000000 --- a/bin/generate-mappings.mjs +++ /dev/null @@ -1,42 +0,0 @@ -#!/usr/bin/env node - -import { providerdev } from '@stackql/provider-utils'; - -async function generateMappings() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const inputDir = getArg('--input-dir'); - const outputDir = getArg('--output-dir'); - const verbose = args.includes('--verbose'); - - if (!providerName || !inputDir || !outputDir) { - console.error('Error: Missing required arguments'); - console.error('Usage: node generate-mappings.mjs --provider-name NAME --input-dir DIR --output-dir DIR [--verbose]'); - process.exit(1); - } - - try { - console.log(`Analyzing OpenAPI specs for provider: ${providerName}`); - console.log(`Input directory: ${inputDir}`); - console.log(`Output directory: ${outputDir}`); - - const result = await providerdev.analyze({ - inputDir, - outputDir, - verbose - }); - - console.log('Analysis completed successfully:', result); - } catch (error) { - console.error('Error analyzing OpenAPI specs:', error); - process.exit(1); - } -} - -generateMappings(); \ No newline at end of file diff --git a/bin/generate-mappings.sh b/bin/generate-mappings.sh deleted file mode 100644 index a4921c1..0000000 --- a/bin/generate-mappings.sh +++ /dev/null @@ -1,83 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Default values -PROVIDER_NAME="" -INPUT_DIR="" -OUTPUT_DIR="" -VERBOSE=false - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --input-dir) - INPUT_DIR="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --verbose) - VERBOSE=true - shift - ;; - --help) - echo "Usage: generate-mappings.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name (required)" - echo " --input-dir DIR Input directory containing split OpenAPI files (required)" - echo " --output-dir DIR Output directory for mapping file (required)" - echo " --verbose Enable verbose output" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Check required arguments -if [ -z "$PROVIDER_NAME" ] || [ -z "$INPUT_DIR" ] || [ -z "$OUTPUT_DIR" ]; then - echo "Error: Missing required arguments" - echo "Use --help for usage information" - exit 1 -fi - -echo "πŸ” Analyzing OpenAPI specs to generate mappings..." -echo "Provider: $PROVIDER_NAME" -echo "Input Directory: $INPUT_DIR" -echo "Output Directory: $OUTPUT_DIR" - -# Build command arguments -ARGS=("--provider-name" "$PROVIDER_NAME" "--input-dir" "$INPUT_DIR" "--output-dir" "$OUTPUT_DIR") - -if [ "$VERBOSE" = true ]; then - ARGS+=("--verbose") - echo "Verbose: Yes" -fi - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/generate-mappings.mjs" "${ARGS[@]}" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Mapping generation failed" - exit 1 -fi - -echo "βœ… Mapping file generated successfully at: $OUTPUT_DIR/all_services.csv" \ No newline at end of file diff --git a/bin/generate-provider.mjs b/bin/generate-provider.mjs deleted file mode 100644 index 501eead..0000000 --- a/bin/generate-provider.mjs +++ /dev/null @@ -1,66 +0,0 @@ -#!/usr/bin/env node - -import { providerdev } from '@stackql/provider-utils'; - -async function generateProvider() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const inputDir = getArg('--input-dir'); - const outputDir = getArg('--output-dir'); - const configPath = getArg('--config-path'); - const servers = getArg('--servers'); - const providerConfig = getArg('--provider-config'); - const skipFiles = getArg('--skip-files')?.split(',') || []; - const overwrite = args.includes('--overwrite'); - const verbose = args.includes('--verbose'); - - if (!providerName || !inputDir || !outputDir || !configPath) { - console.error('Error: Missing required arguments'); - console.error('Usage: node generate-provider.mjs --provider-name NAME --input-dir DIR --output-dir DIR --config-path PATH [--servers JSON] [--provider-config JSON] [--skip-files LIST] [--overwrite] [--verbose]'); - process.exit(1); - } - - try { - console.log(`Generating StackQL provider extensions for: ${providerName}`); - console.log(`Input directory: ${inputDir}`); - console.log(`Output directory: ${outputDir}`); - console.log(`Config path: ${configPath}`); - - if (servers) { - console.log(`Custom servers configuration provided`); - } - - if (providerConfig) { - console.log(`Custom provider configuration provided`); - } - - if (skipFiles.length > 0) { - console.log(`Skipping files: ${skipFiles.join(', ')}`); - } - - const result = await providerdev.generate({ - inputDir, - outputDir, - configPath, - providerId: providerName, - servers, - providerConfig, - skipFiles, - overwrite, - verbose - }); - - console.log('Provider generation completed successfully:', result); - } catch (error) { - console.error('Error generating provider extensions:', error); - process.exit(1); - } -} - -generateProvider(); \ No newline at end of file diff --git a/bin/generate-provider.sh b/bin/generate-provider.sh deleted file mode 100644 index 429933a..0000000 --- a/bin/generate-provider.sh +++ /dev/null @@ -1,134 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Default values -PROVIDER_NAME="" -INPUT_DIR="" -OUTPUT_DIR="" -CONFIG_PATH="" -SERVERS="" -PROVIDER_CONFIG="" -SKIP_FILES="" -OVERWRITE=false -VERBOSE=false - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --input-dir) - INPUT_DIR="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --config-path) - CONFIG_PATH="$2" - shift 2 - ;; - --servers) - SERVERS="$2" - shift 2 - ;; - --provider-config) - PROVIDER_CONFIG="$2" - shift 2 - ;; - --skip-files) - SKIP_FILES="$2" - shift 2 - ;; - --overwrite) - OVERWRITE=true - shift - ;; - --verbose) - VERBOSE=true - shift - ;; - --help) - echo "Usage: generate-provider.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name/ID (required)" - echo " --input-dir DIR Input directory containing split OpenAPI files (required)" - echo " --output-dir DIR Output directory for provider (required)" - echo " --config-path PATH Path to CSV mapping file (required)" - echo " --servers JSON JSON string with servers configuration" - echo " --provider-config JSON JSON string with provider configuration" - echo " --skip-files LIST Comma-separated list of files to skip" - echo " --overwrite Overwrite existing files" - echo " --verbose Enable verbose output" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Check required arguments -if [ -z "$PROVIDER_NAME" ] || [ -z "$INPUT_DIR" ] || [ -z "$OUTPUT_DIR" ] || [ -z "$CONFIG_PATH" ]; then - echo "Error: Missing required arguments" - echo "Use --help for usage information" - exit 1 -fi - -echo "πŸ”§ Generating StackQL provider extensions..." -echo "Provider: $PROVIDER_NAME" -echo "Input Directory: $INPUT_DIR" -echo "Output Directory: $OUTPUT_DIR" -echo "Config Path: $CONFIG_PATH" - -# Build command arguments -ARGS=("--provider-name" "$PROVIDER_NAME" "--input-dir" "$INPUT_DIR" "--output-dir" "$OUTPUT_DIR" "--config-path" "$CONFIG_PATH") - -if [ -n "$SERVERS" ]; then - ARGS+=("--servers" "$SERVERS") - echo "Custom servers configuration provided" -fi - -if [ -n "$PROVIDER_CONFIG" ]; then - ARGS+=("--provider-config" "$PROVIDER_CONFIG") - echo "Custom provider configuration provided" -fi - -if [ -n "$SKIP_FILES" ]; then - ARGS+=("--skip-files" "$SKIP_FILES") - echo "Skipping files: $SKIP_FILES" -fi - -if [ "$OVERWRITE" = true ]; then - ARGS+=("--overwrite") - echo "Overwrite: Yes" -fi - -if [ "$VERBOSE" = true ]; then - ARGS+=("--verbose") - echo "Verbose: Yes" -fi - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/generate-provider.mjs" "${ARGS[@]}" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Provider generation failed" - exit 1 -fi - -echo "βœ… Provider generated successfully at: $OUTPUT_DIR" \ No newline at end of file diff --git a/bin/split.mjs b/bin/split.mjs deleted file mode 100644 index 02a344c..0000000 --- a/bin/split.mjs +++ /dev/null @@ -1,76 +0,0 @@ -#!/usr/bin/env node - -import { providerdev } from '@stackql/provider-utils'; - -async function splitOpenApi() { - // Get command line arguments - const args = process.argv.slice(2); - const getArg = (flag) => { - const index = args.indexOf(flag); - return index !== -1 ? args[index + 1] : null; - }; - - const providerName = getArg('--provider-name'); - const apiDoc = getArg('--api-doc'); - const outputDir = getArg('--output-dir'); - const svcDiscriminator = getArg('--svc-discriminator') || 'tag'; - const exclude = getArg('--exclude') || ''; - const overwrite = args.includes('--overwrite'); - const verbose = args.includes('--verbose'); - const svcNameOverridesStr = getArg('--svc-name-overrides') || '{}'; - - let svcNameOverrides = {}; - try { - svcNameOverrides = JSON.parse(svcNameOverridesStr); - } catch (err) { - console.error('Error parsing service name overrides JSON:', err.message); - console.error('Please ensure the JSON format is correct'); - process.exit(1); - } - - if (!providerName || !apiDoc || !outputDir) { - console.error('Error: Missing required arguments'); - console.error('Usage: node split.mjs --provider-name NAME --api-doc PATH --output-dir DIR [--svc-discriminator tag|path] [--exclude LIST] [--svc-name-overrides JSON] [--overwrite] [--verbose]'); - process.exit(1); - } - - try { - console.log(`Splitting OpenAPI doc for provider: ${providerName}`); - console.log(`API Doc: ${apiDoc}`); - console.log(`Output directory: ${outputDir}`); - console.log(`Service Discriminator: ${svcDiscriminator}`); - - if (exclude) { - console.log(`Excluding: ${exclude}`); - } - - const numOverrides = Object.keys(svcNameOverrides).length; - if (numOverrides > 0) { - console.log(`Service name overrides: ${numOverrides} mappings`); - if (verbose) { - console.log('Override mappings:'); - for (const [original, newName] of Object.entries(svcNameOverrides)) { - console.log(` ${original} -> ${newName}`); - } - } - } - - const result = await providerdev.split({ - apiDoc, - providerName, - outputDir, - svcDiscriminator, - exclude, - overwrite, - verbose, - svcNameOverrides - }); - - console.log('Split operation completed successfully:', result); - } catch (error) { - console.error('Error splitting OpenAPI doc:', error); - process.exit(1); - } -} - -splitOpenApi(); \ No newline at end of file diff --git a/bin/split.sh b/bin/split.sh deleted file mode 100644 index 6f961f7..0000000 --- a/bin/split.sh +++ /dev/null @@ -1,123 +0,0 @@ -#!/usr/bin/env bash - -# Exit on error -set -e - -# Get the script directory for relative paths -SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" -REPO_ROOT="$( cd "$SCRIPT_DIR/.." && pwd )" - -# Default values -PROVIDER_NAME="" -API_DOC="" -OUTPUT_DIR="" -SVC_DISCRIMINATOR="tag" -EXCLUDE="" -OVERWRITE=false -VERBOSE=false -SVC_NAME_OVERRIDES="{}" - -# Parse command line arguments -while [[ $# -gt 0 ]]; do - case $1 in - --provider-name) - PROVIDER_NAME="$2" - shift 2 - ;; - --api-doc) - API_DOC="$2" - shift 2 - ;; - --output-dir) - OUTPUT_DIR="$2" - shift 2 - ;; - --svc-discriminator) - SVC_DISCRIMINATOR="$2" - shift 2 - ;; - --exclude) - EXCLUDE="$2" - shift 2 - ;; - --svc-name-overrides) - SVC_NAME_OVERRIDES="$2" - shift 2 - ;; - --overwrite) - OVERWRITE=true - shift - ;; - --verbose) - VERBOSE=true - shift - ;; - --help) - echo "Usage: split.sh [OPTIONS]" - echo "" - echo "Options:" - echo " --provider-name NAME Provider name (required)" - echo " --api-doc PATH Path to OpenAPI document (required)" - echo " --output-dir DIR Output directory for split files (required)" - echo " --svc-discriminator TYPE Service discriminator type: 'tag' or 'path' (default: tag)" - echo " --exclude LIST Comma-separated list of tags or paths to exclude" - echo " --svc-name-overrides JSON JSON object mapping original service names to new names" - echo " --overwrite Overwrite existing files" - echo " --verbose Enable verbose output" - echo " --help Show this help message" - exit 0 - ;; - *) - echo "Unknown option: $1" - echo "Use --help for usage information" - exit 1 - ;; - esac -done - -# Check required arguments -if [ -z "$PROVIDER_NAME" ] || [ -z "$API_DOC" ] || [ -z "$OUTPUT_DIR" ]; then - echo "Error: Missing required arguments" - echo "Use --help for usage information" - exit 1 -fi - -echo "πŸ”ͺ Splitting OpenAPI document..." -echo "Provider: $PROVIDER_NAME" -echo "API Doc: $API_DOC" -echo "Output Directory: $OUTPUT_DIR" -echo "Service Discriminator: $SVC_DISCRIMINATOR" - -# Build command arguments -ARGS=("--provider-name" "$PROVIDER_NAME" "--api-doc" "$API_DOC" "--output-dir" "$OUTPUT_DIR" "--svc-discriminator" "$SVC_DISCRIMINATOR") - -if [ -n "$EXCLUDE" ]; then - ARGS+=("--exclude" "$EXCLUDE") - echo "Excluding: $EXCLUDE" -fi - -if [ "$SVC_NAME_OVERRIDES" != "{}" ]; then - ARGS+=("--svc-name-overrides" "$SVC_NAME_OVERRIDES") - echo "Service Name Overrides: $SVC_NAME_OVERRIDES" -fi - -if [ "$OVERWRITE" = true ]; then - ARGS+=("--overwrite") - echo "Overwrite: Yes" -fi - -if [ "$VERBOSE" = true ]; then - ARGS+=("--verbose") - echo "Verbose: Yes" -fi - -# Run the Node.js script with arguments -node --experimental-modules "$SCRIPT_DIR/split.mjs" "${ARGS[@]}" - -# Check if command succeeded -if [ $? -ne 0 ]; then - echo "❌ Split operation failed" - exit 1 -fi - -echo "βœ… Split operation completed successfully" \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 89f374e..4412fdd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,15 +1,15 @@ { - "name": "stackql-provider-digitalocean", + "name": "stackql-provider-github", "version": "0.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "stackql-provider-digitalocean", + "name": "stackql-provider-github", "version": "0.1.0", "dependencies": { "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.5.0" + "@stackql/provider-utils": "^0.6.4" }, "engines": { "node": ">=14.16.0" @@ -110,9 +110,9 @@ } }, "node_modules/@stackql/provider-utils": { - "version": "0.5.0", - "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.5.0.tgz", - "integrity": "sha512-KwHVVCBC0XwbDI/dDb7FM1fEFqqnXQ0mPJFmiEYkASNs5mXQW0jbAazVBeOFO4JN0PN6AyX6D/vWCVOmpnz9jw==", + "version": "0.6.4", + "resolved": "https://registry.npmjs.org/@stackql/provider-utils/-/provider-utils-0.6.4.tgz", + "integrity": "sha512-Zb1AeebCGsMOYi+Vo2FbN2JLLyBZC4hpruOGX6xfzlVdpyDhhcoEBzqhsJbAkm3ahMexCtvKtiQrC0CSMkNUng==", "license": "MIT", "dependencies": { "@apidevtools/swagger-parser": "^10.1.1", @@ -121,6 +121,10 @@ "js-yaml": "^4.1.0", "pluralize": "^8.0.0" }, + "bin": { + "docgen-utils": "bin/docgen-utils.mjs", + "provider-dev-utils": "bin/provider-dev-utils.mjs" + }, "engines": { "node": ">=16.0.0" } diff --git a/package.json b/package.json index c56e58b..714e85e 100644 --- a/package.json +++ b/package.json @@ -1,13 +1,14 @@ { - "name": "stackql-provider-digitalocean", + "name": "stackql-provider-github", "version": "0.1.0", - "description": "StackQL Provider for Digital Ocean", + "description": "StackQL Provider for GitHub", "type": "module", "scripts": { - "generate-docs": "./bin/generate-docs.sh", - "split": "./bin/split.sh", - "generate-mappings": "./bin/generate-mappings.sh", - "generate-provider": "./bin/generate-provider.sh", + "generate-docs": "node node_modules/@stackql/provider-utils/bin/docgen-utils.mjs generate-docs", + "split": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs split", + "normalize": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs normalize", + "generate-mappings": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs analyze", + "generate-provider": "node node_modules/@stackql/provider-utils/bin/provider-dev-utils.mjs generate", "start-server": "bash ./bin/start-server.sh", "stop-server": "bash ./bin/stop-server.sh", "server-status": "bash ./bin/server-status.sh", @@ -15,11 +16,11 @@ }, "dependencies": { "@stackql/pgwire-lite": "^1.0.1", - "@stackql/provider-utils": "^0.5.0" + "@stackql/provider-utils": "^0.6.4" }, "keywords": [ "stackql", - "digitalocean", + "github", "provider" ], "engines": { diff --git a/provider-dev/config/all_services.csv b/provider-dev/config/all_services.csv new file mode 100644 index 0000000..e5ebcf4 --- /dev/null +++ b/provider-dev/config/all_services.csv @@ -0,0 +1,1192 @@ +filename,path,operationId,formatted_op_id,verb,response_object,tags,formatted_tags,stackql_resource_name,stackql_method_name,stackql_verb,stackql_object_key,op_description +actions.yaml,/orgs/{org}/actions/permissions/selected-actions,actions/get-allowed-actions-organization,actions/get_allowed_actions_organization,get,selected-actions,actions,actions,allowed_actions,get_allowed_actions_organization,select,,Get allowed actions and reusable workflows for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/selected-actions,actions/get-allowed-actions-repository,actions/get_allowed_actions_repository,get,selected-actions,actions,actions,allowed_actions,get_allowed_actions_repository,select,,Get allowed actions and reusable workflows for a repository +actions.yaml,/orgs/{org}/actions/permissions/selected-actions,actions/set-allowed-actions-organization,actions/set_allowed_actions_organization,put,,actions,actions,allowed_actions,set_allowed_actions_organization,replace,,Set allowed actions and reusable workflows for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/selected-actions,actions/set-allowed-actions-repository,actions/set_allowed_actions_repository,put,,actions,actions,allowed_actions,set_allowed_actions_repository,replace,,Set allowed actions and reusable workflows for a repository +actions.yaml,/orgs/{org}/actions/permissions/artifact-and-log-retention,actions/get-artifact-and-log-retention-settings-organization,actions/get_artifact_and_log_retention_settings_organization,get,,actions,actions,artifact_log_retention,get_artifact_and_log_retention_settings_organization,select,,Get artifact and log retention settings for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention,actions/get-artifact-and-log-retention-settings-repository,actions/get_artifact_and_log_retention_settings_repository,get,,actions,actions,artifact_log_retention,get_artifact_and_log_retention_settings_repository,select,,Get artifact and log retention settings for a repository +actions.yaml,/orgs/{org}/actions/permissions/artifact-and-log-retention,actions/set-artifact-and-log-retention-settings-organization,actions/set_artifact_and_log_retention_settings_organization,put,,actions,actions,artifact_log_retention,set_artifact_and_log_retention_settings_organization,replace,,Set artifact and log retention settings for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention,actions/set-artifact-and-log-retention-settings-repository,actions/set_artifact_and_log_retention_settings_repository,put,,actions,actions,artifact_log_retention,set_artifact_and_log_retention_settings_repository,replace,,Set artifact and log retention settings for a repository +actions.yaml,/repos/{owner}/{repo}/actions/artifacts/{artifact_id},actions/delete-artifact,actions/delete_artifact,delete,,actions,actions,artifacts,delete_artifact,delete,,Delete an artifact +actions.yaml,/repos/{owner}/{repo}/actions/artifacts/{artifact_id},actions/get-artifact,actions/get_artifact,get,artifact,actions,actions,artifacts,get_artifact,select,,Get an artifact +actions.yaml,/repos/{owner}/{repo}/actions/artifacts,actions/list-artifacts-for-repo,actions/list_artifacts_for_repo,get,,actions,actions,artifacts,list_artifacts_for_repo,select,,List artifacts for a repository +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts,actions/list-workflow-run-artifacts,actions/list_workflow_run_artifacts,get,,actions,actions,artifacts,list_workflow_run_artifacts,select,,List workflow run artifacts +actions.yaml,/repos/{owner}/{repo}/actions/caches/{cache_id},actions/delete-actions-cache-by-id,actions/delete_actions_cache_by_id,delete,,actions,actions,cache,delete_actions_cache_by_id,delete,,Delete a GitHub Actions cache for a repository (using a cache ID) +actions.yaml,/repos/{owner}/{repo}/actions/caches,actions/delete-actions-cache-by-key,actions/delete_actions_cache_by_key,delete,actions-cache-list,actions,actions,cache,delete_actions_cache_by_key,delete,,Delete GitHub Actions caches for a repository (using a cache key) +actions.yaml,/repos/{owner}/{repo}/actions/caches,actions/get-actions-cache-list,actions/get_actions_cache_list,get,actions-cache-list,actions,actions,cache,get_actions_cache_list,select,,List GitHub Actions caches for a repository +actions.yaml,/enterprises/{enterprise}/actions/cache/retention-limit,actions/get-actions-cache-retention-limit-for-enterprise,actions/get_actions_cache_retention_limit_for_enterprise,get,,actions,actions,cache_retention_limit,get_actions_cache_retention_limit_for_enterprise,select,,Get GitHub Actions cache retention limit for an enterprise +actions.yaml,/organizations/{org}/actions/cache/retention-limit,actions/get-actions-cache-retention-limit-for-organization,actions/get_actions_cache_retention_limit_for_organization,get,,actions,actions,cache_retention_limit,get_actions_cache_retention_limit_for_organization,select,,Get GitHub Actions cache retention limit for an organization +actions.yaml,/repos/{owner}/{repo}/actions/cache/retention-limit,actions/get-actions-cache-retention-limit-for-repository,actions/get_actions_cache_retention_limit_for_repository,get,,actions,actions,cache_retention_limit,get_actions_cache_retention_limit_for_repository,select,,Get GitHub Actions cache retention limit for a repository +actions.yaml,/enterprises/{enterprise}/actions/cache/retention-limit,actions/set-actions-cache-retention-limit-for-enterprise,actions/set_actions_cache_retention_limit_for_enterprise,put,,actions,actions,cache_retention_limit,set_actions_cache_retention_limit_for_enterprise,replace,,Set GitHub Actions cache retention limit for an enterprise +actions.yaml,/organizations/{org}/actions/cache/retention-limit,actions/set-actions-cache-retention-limit-for-organization,actions/set_actions_cache_retention_limit_for_organization,put,,actions,actions,cache_retention_limit,set_actions_cache_retention_limit_for_organization,replace,,Set GitHub Actions cache retention limit for an organization +actions.yaml,/repos/{owner}/{repo}/actions/cache/retention-limit,actions/set-actions-cache-retention-limit-for-repository,actions/set_actions_cache_retention_limit_for_repository,put,,actions,actions,cache_retention_limit,set_actions_cache_retention_limit_for_repository,replace,,Set GitHub Actions cache retention limit for a repository +actions.yaml,/enterprises/{enterprise}/actions/cache/storage-limit,actions/get-actions-cache-storage-limit-for-enterprise,actions/get_actions_cache_storage_limit_for_enterprise,get,,actions,actions,cache_storage_limit,get_actions_cache_storage_limit_for_enterprise,select,,Get GitHub Actions cache storage limit for an enterprise +actions.yaml,/organizations/{org}/actions/cache/storage-limit,actions/get-actions-cache-storage-limit-for-organization,actions/get_actions_cache_storage_limit_for_organization,get,,actions,actions,cache_storage_limit,get_actions_cache_storage_limit_for_organization,select,,Get GitHub Actions cache storage limit for an organization +actions.yaml,/repos/{owner}/{repo}/actions/cache/storage-limit,actions/get-actions-cache-storage-limit-for-repository,actions/get_actions_cache_storage_limit_for_repository,get,,actions,actions,cache_storage_limit,get_actions_cache_storage_limit_for_repository,select,,Get GitHub Actions cache storage limit for a repository +actions.yaml,/enterprises/{enterprise}/actions/cache/storage-limit,actions/set-actions-cache-storage-limit-for-enterprise,actions/set_actions_cache_storage_limit_for_enterprise,put,,actions,actions,cache_storage_limit,set_actions_cache_storage_limit_for_enterprise,replace,,Set GitHub Actions cache storage limit for an enterprise +actions.yaml,/organizations/{org}/actions/cache/storage-limit,actions/set-actions-cache-storage-limit-for-organization,actions/set_actions_cache_storage_limit_for_organization,put,,actions,actions,cache_storage_limit,set_actions_cache_storage_limit_for_organization,replace,,Set GitHub Actions cache storage limit for an organization +actions.yaml,/repos/{owner}/{repo}/actions/cache/storage-limit,actions/set-actions-cache-storage-limit-for-repository,actions/set_actions_cache_storage_limit_for_repository,put,,actions,actions,cache_storage_limit,set_actions_cache_storage_limit_for_repository,replace,,Set GitHub Actions cache storage limit for a repository +actions.yaml,/repos/{owner}/{repo}/actions/cache/usage,actions/get-actions-cache-usage,actions/get_actions_cache_usage,get,actions-cache-usage-by-repository,actions,actions,cache_usage,get_actions_cache_usage,select,,Get GitHub Actions cache usage for a repository +actions.yaml,/orgs/{org}/actions/cache/usage,actions/get-actions-cache-usage-for-org,actions/get_actions_cache_usage_for_org,get,actions-cache-usage-org-enterprise,actions,actions,cache_usage,get_actions_cache_usage_for_org,select,,Get GitHub Actions cache usage for an organization +actions.yaml,/orgs/{org}/actions/permissions/workflow,actions/get-github-actions-default-workflow-permissions-organization,actions/get_github_actions_default_workflow_permissions_organization,get,actions-get-default-workflow-permissions,actions,actions,default_workflow_permissions,get_github_actions_default_workflow_permissions_organization,select,,Get default workflow permissions for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/workflow,actions/get-github-actions-default-workflow-permissions-repository,actions/get_github_actions_default_workflow_permissions_repository,get,actions-get-default-workflow-permissions,actions,actions,default_workflow_permissions,get_github_actions_default_workflow_permissions_repository,select,,Get default workflow permissions for a repository +actions.yaml,/orgs/{org}/actions/permissions/workflow,actions/set-github-actions-default-workflow-permissions-organization,actions/set_github_actions_default_workflow_permissions_organization,put,,actions,actions,default_workflow_permissions,set_github_actions_default_workflow_permissions_organization,replace,,Set default workflow permissions for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/workflow,actions/set-github-actions-default-workflow-permissions-repository,actions/set_github_actions_default_workflow_permissions_repository,put,,actions,actions,default_workflow_permissions,set_github_actions_default_workflow_permissions_repository,replace,,Set default workflow permissions for a repository +actions.yaml,/orgs/{org}/actions/permissions/repositories/{repository_id},actions/disable-selected-repository-github-actions-organization,actions/disable_selected_repository_github_actions_organization,delete,,actions,actions,enabled_repos,disable_selected_repository_github_actions_organization,delete,,Disable a selected repository for GitHub Actions in an organization +actions.yaml,/orgs/{org}/actions/permissions/repositories,actions/list-selected-repositories-enabled-github-actions-organization,actions/list_selected_repositories_enabled_github_actions_organization,get,,actions,actions,enabled_repos,list_selected_repositories_enabled_github_actions_organization,select,,List selected repositories enabled for GitHub Actions in an organization +actions.yaml,/orgs/{org}/actions/permissions/repositories/{repository_id},actions/enable-selected-repository-github-actions-organization,actions/enable_selected_repository_github_actions_organization,put,,actions,actions,enabled_repos,enable_selected_repository_github_actions_organization,replace,,Enable a selected repository for GitHub Actions in an organization +actions.yaml,/orgs/{org}/actions/permissions/repositories,actions/set-selected-repositories-enabled-github-actions-organization,actions/set_selected_repositories_enabled_github_actions_organization,put,,actions,actions,enabled_repos,set_selected_repositories_enabled_github_actions_organization,replace,,Set selected repositories enabled for GitHub Actions in an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval,actions/get-fork-pr-contributor-approval-permissions-repository,actions/get_fork_pr_contributor_approval_permissions_repository,get,,actions,actions,fork_pr_contributor_approval_permissions,get_fork_pr_contributor_approval_permissions_repository,select,,Get fork PR contributor approval permissions for a repository +actions.yaml,/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval,actions/set-fork-pr-contributor-approval-permissions-repository,actions/set_fork_pr_contributor_approval_permissions_repository,put,,actions,actions,fork_pr_contributor_approval_permissions,set_fork_pr_contributor_approval_permissions_repository,replace,,Set fork PR contributor approval permissions for a repository +actions.yaml,/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos,actions/get-private-repo-fork-pr-workflows-settings-repository,actions/get_private_repo_fork_pr_workflows_settings_repository,get,,actions,actions,fork_pr_workflows_private_repos_settings,get_private_repo_fork_pr_workflows_settings_repository,select,,Get private repo fork PR workflow settings for a repository +actions.yaml,/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos,actions/set-private-repo-fork-pr-workflows-settings-repository,actions/set_private_repo_fork_pr_workflows_settings_repository,put,,actions,actions,fork_pr_workflows_private_repos_settings,set_private_repo_fork_pr_workflows_settings_repository,replace,,Set private repo fork PR workflow settings for a repository +actions.yaml,/repos/{owner}/{repo}/actions/oidc/customization/sub,actions/get-custom-oidc-sub-claim-for-repo,actions/get_custom_oidc_sub_claim_for_repo,get,oidc-custom-sub-repo,actions,actions,oidc,get_custom_oidc_sub_claim_for_repo,select,,Get the customization template for an OIDC subject claim for a repository +actions.yaml,/repos/{owner}/{repo}/actions/oidc/customization/sub,actions/set-custom-oidc-sub-claim-for-repo,actions/set_custom_oidc_sub_claim_for_repo,put,empty-object,actions,actions,oidc,set_custom_oidc_sub_claim_for_repo,replace,,Set the customization template for an OIDC subject claim for a repository +actions.yaml,/orgs/{org}/actions/cache/usage-by-repository,actions/get-actions-cache-usage-by-repo-for-org,actions/get_actions_cache_usage_by_repo_for_org,get,,actions,actions,org_cache_usage,get_actions_cache_usage_by_repo_for_org,select,,List repositories with GitHub Actions cache usage for an organization +actions.yaml,/orgs/{org}/actions/permissions/fork-pr-contributor-approval,actions/get-fork-pr-contributor-approval-permissions-organization,actions/get_fork_pr_contributor_approval_permissions_organization,get,,actions,actions,org_fork_pr_contributor_approval_permissions,get_fork_pr_contributor_approval_permissions_organization,select,,Get fork PR contributor approval permissions for an organization +actions.yaml,/orgs/{org}/actions/permissions/fork-pr-contributor-approval,actions/set-fork-pr-contributor-approval-permissions-organization,actions/set_fork_pr_contributor_approval_permissions_organization,put,,actions,actions,org_fork_pr_contributor_approval_permissions,set_fork_pr_contributor_approval_permissions_organization,replace,,Set fork PR contributor approval permissions for an organization +actions.yaml,/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos,actions/get-private-repo-fork-pr-workflows-settings-organization,actions/get_private_repo_fork_pr_workflows_settings_organization,get,,actions,actions,org_fork_pr_workflows_private_repos_settings,get_private_repo_fork_pr_workflows_settings_organization,select,,Get private repo fork PR workflow settings for an organization +actions.yaml,/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos,actions/set-private-repo-fork-pr-workflows-settings-organization,actions/set_private_repo_fork_pr_workflows_settings_organization,put,,actions,actions,org_fork_pr_workflows_private_repos_settings,set_private_repo_fork_pr_workflows_settings_organization,replace,,Set private repo fork PR workflow settings for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version},actions/delete-custom-image-version-from-org,actions/delete_custom_image_version_from_org,delete,,actions,actions,org_hosted_runner_custom_image_versions,delete_custom_image_version_from_org,delete,,Delete an image version of custom image from the organization +actions.yaml,/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version},actions/get-custom-image-version-for-org,actions/get_custom_image_version_for_org,get,,actions,actions,org_hosted_runner_custom_image_versions,get_custom_image_version_for_org,select,,Get an image version of a custom image for GitHub Actions Hosted Runners +actions.yaml,/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions,actions/list-custom-image-versions-for-org,actions/list_custom_image_versions_for_org,get,,actions,actions,org_hosted_runner_custom_image_versions,list_custom_image_versions_for_org,select,,List image versions of a custom image for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id},actions/delete-custom-image-from-org,actions/delete_custom_image_from_org,delete,,actions,actions,org_hosted_runner_custom_images,delete_custom_image_from_org,delete,,Delete a custom image from the organization +actions.yaml,/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id},actions/get-custom-image-for-org,actions/get_custom_image_for_org,get,,actions,actions,org_hosted_runner_custom_images,get_custom_image_for_org,select,,Get a custom image definition for GitHub Actions Hosted Runners +actions.yaml,/orgs/{org}/actions/hosted-runners/images/custom,actions/list-custom-images-for-org,actions/list_custom_images_for_org,get,,actions,actions,org_hosted_runner_custom_images,list_custom_images_for_org,select,,List custom images for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/images/github-owned,actions/get-hosted-runners-github-owned-images-for-org,actions/get_hosted_runners_github_owned_images_for_org,get,,actions,actions,org_hosted_runner_github_images,get_hosted_runners_github_owned_images_for_org,select,,Get GitHub-owned images for GitHub-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/limits,actions/get-hosted-runners-limits-for-org,actions/get_hosted_runners_limits_for_org,get,,actions,actions,org_hosted_runner_limits,get_hosted_runners_limits_for_org,select,$.public_ips,Get limits on GitHub-hosted runners for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/machine-sizes,actions/get-hosted-runners-machine-specs-for-org,actions/get_hosted_runners_machine_specs_for_org,get,,actions,actions,org_hosted_runner_machine_specs,get_hosted_runners_machine_specs_for_org,select,,Get GitHub-hosted runners machine specs for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/images/partner,actions/get-hosted-runners-partner-images-for-org,actions/get_hosted_runners_partner_images_for_org,get,,actions,actions,org_hosted_runner_partner_images,get_hosted_runners_partner_images_for_org,select,,Get partner images for GitHub-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/platforms,actions/get-hosted-runners-platforms-for-org,actions/get_hosted_runners_platforms_for_org,get,,actions,actions,org_hosted_runner_platforms,get_hosted_runners_platforms_for_org,select,,Get platforms for GitHub-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/{hosted_runner_id},actions/delete-hosted-runner-for-org,actions/delete_hosted_runner_for_org,delete,,actions,actions,org_hosted_runners,delete_hosted_runner_for_org,delete,,Delete a GitHub-hosted runner for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/{hosted_runner_id},actions/get-hosted-runner-for-org,actions/get_hosted_runner_for_org,get,,actions,actions,org_hosted_runners,get_hosted_runner_for_org,select,,Get a GitHub-hosted runner for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners,actions/list-hosted-runners-for-org,actions/list_hosted_runners_for_org,get,,actions,actions,org_hosted_runners,list_hosted_runners_for_org,select,,List GitHub-hosted runners for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners/{hosted_runner_id},actions/update-hosted-runner-for-org,actions/update_hosted_runner_for_org,patch,,actions,actions,org_hosted_runners,update_hosted_runner_for_org,update,,Update a GitHub-hosted runner for an organization +actions.yaml,/orgs/{org}/actions/hosted-runners,actions/create-hosted-runner-for-org,actions/create_hosted_runner_for_org,post,,actions,actions,org_hosted_runners,create_hosted_runner_for_org,insert,,Create a GitHub-hosted runner for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners,actions/list-github-hosted-runners-in-group-for-org,actions/list_github_hosted_runners_in_group_for_org,get,,actions,actions,org_runner_group_hosted_runners,list_github_hosted_runners_in_group_for_org,select,,List GitHub-hosted runners in a group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id},actions/remove-repo-access-to-self-hosted-runner-group-in-org,actions/remove_repo_access_to_self_hosted_runner_group_in_org,delete,,actions,actions,org_runner_group_repos,remove_repo_access_to_self_hosted_runner_group_in_org,delete,,Remove repository access to a self-hosted runner group in an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories,actions/list-repo-access-to-self-hosted-runner-group-in-org,actions/list_repo_access_to_self_hosted_runner_group_in_org,get,,actions,actions,org_runner_group_repos,list_repo_access_to_self_hosted_runner_group_in_org,select,,List repository access to a self-hosted runner group in an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id},actions/add-repo-access-to-self-hosted-runner-group-in-org,actions/add_repo_access_to_self_hosted_runner_group_in_org,put,,actions,actions,org_runner_group_repos,add_repo_access_to_self_hosted_runner_group_in_org,replace,,Add repository access to a self-hosted runner group in an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories,actions/set-repo-access-to-self-hosted-runner-group-in-org,actions/set_repo_access_to_self_hosted_runner_group_in_org,put,,actions,actions,org_runner_group_repos,set_repo_access_to_self_hosted_runner_group_in_org,replace,,Set repository access for a self-hosted runner group in an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id},actions/remove-self-hosted-runner-from-group-for-org,actions/remove_self_hosted_runner_from_group_for_org,delete,,actions,actions,org_runner_group_runners,remove_self_hosted_runner_from_group_for_org,delete,,Remove a self-hosted runner from a group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/runners,actions/list-self-hosted-runners-in-group-for-org,actions/list_self_hosted_runners_in_group_for_org,get,,actions,actions,org_runner_group_runners,list_self_hosted_runners_in_group_for_org,select,,List self-hosted runners in a group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id},actions/add-self-hosted-runner-to-group-for-org,actions/add_self_hosted_runner_to_group_for_org,put,,actions,actions,org_runner_group_runners,add_self_hosted_runner_to_group_for_org,replace,,Add a self-hosted runner to a group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id}/runners,actions/set-self-hosted-runners-in-group-for-org,actions/set_self_hosted_runners_in_group_for_org,put,,actions,actions,org_runner_group_runners,set_self_hosted_runners_in_group_for_org,replace,,Set self-hosted runners in a group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id},actions/delete-self-hosted-runner-group-from-org,actions/delete_self_hosted_runner_group_from_org,delete,,actions,actions,org_runner_groups,delete_self_hosted_runner_group_from_org,delete,,Delete a self-hosted runner group from an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id},actions/get-self-hosted-runner-group-for-org,actions/get_self_hosted_runner_group_for_org,get,,actions,actions,org_runner_groups,get_self_hosted_runner_group_for_org,select,,Get a self-hosted runner group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups,actions/list-self-hosted-runner-groups-for-org,actions/list_self_hosted_runner_groups_for_org,get,,actions,actions,org_runner_groups,list_self_hosted_runner_groups_for_org,select,,List self-hosted runner groups for an organization +actions.yaml,/orgs/{org}/actions/runner-groups/{runner_group_id},actions/update-self-hosted-runner-group-for-org,actions/update_self_hosted_runner_group_for_org,patch,,actions,actions,org_runner_groups,update_self_hosted_runner_group_for_org,update,,Update a self-hosted runner group for an organization +actions.yaml,/orgs/{org}/actions/runner-groups,actions/create-self-hosted-runner-group-for-org,actions/create_self_hosted_runner_group_for_org,post,,actions,actions,org_runner_groups,create_self_hosted_runner_group_for_org,insert,,Create a self-hosted runner group for an organization +actions.yaml,/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id},actions/disable-selected-repository-self-hosted-runners-organization,actions/disable_selected_repository_self_hosted_runners_organization,delete,,actions,actions,org_self_hosted_runner_repo_access,disable_selected_repository_self_hosted_runners_organization,delete,,Remove a repository from the list of repositories allowed to use self-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/permissions/self-hosted-runners/repositories,actions/list-selected-repositories-self-hosted-runners-organization,actions/list_selected_repositories_self_hosted_runners_organization,get,,actions,actions,org_self_hosted_runner_repo_access,list_selected_repositories_self_hosted_runners_organization,select,,List repositories allowed to use self-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id},actions/enable-selected-repository-self-hosted-runners-organization,actions/enable_selected_repository_self_hosted_runners_organization,put,,actions,actions,org_self_hosted_runner_repo_access,enable_selected_repository_self_hosted_runners_organization,replace,,Add a repository to the list of repositories allowed to use self-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/permissions/self-hosted-runners/repositories,actions/set-selected-repositories-self-hosted-runners-organization,actions/set_selected_repositories_self_hosted_runners_organization,put,,actions,actions,org_self_hosted_runner_repo_access,set_selected_repositories_self_hosted_runners_organization,replace,,Set repositories allowed to use self-hosted runners in an organization +actions.yaml,/orgs/{org}/actions/permissions/self-hosted-runners,actions/get-self-hosted-runners-permissions-organization,actions/get_self_hosted_runners_permissions_organization,get,,actions,actions,org_self_hosted_runners_permissions,get_self_hosted_runners_permissions_organization,select,,Get self-hosted runners settings for an organization +actions.yaml,/orgs/{org}/actions/permissions/self-hosted-runners,actions/set-self-hosted-runners-permissions-organization,actions/set_self_hosted_runners_permissions_organization,put,,actions,actions,org_self_hosted_runners_permissions,set_self_hosted_runners_permissions_organization,replace,,Set self-hosted runners settings for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments,actions/get-pending-deployments-for-run,actions/get_pending_deployments_for_run,get,pending-deployment,actions,actions,pending_deployments_for_run,get_pending_deployments_for_run,select,,Get pending deployments for a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments,actions/review-pending-deployments-for-run,actions/review_pending_deployments_for_run,post,deployment,actions,actions,pending_deployments_for_run,review_pending_deployments_for_run,exec,,Review pending deployments for a workflow run +actions.yaml,/orgs/{org}/actions/permissions,actions/get-github-actions-permissions-organization,actions/get_github_actions_permissions_organization,get,actions-organization-permissions,actions,actions,permissions,get_github_actions_permissions_organization,select,,Get GitHub Actions permissions for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions,actions/get-github-actions-permissions-repository,actions/get_github_actions_permissions_repository,get,actions-repository-permissions,actions,actions,permissions,get_github_actions_permissions_repository,select,,Get GitHub Actions permissions for a repository +actions.yaml,/orgs/{org}/actions/permissions,actions/set-github-actions-permissions-organization,actions/set_github_actions_permissions_organization,put,,actions,actions,permissions,set_github_actions_permissions_organization,replace,,Set GitHub Actions permissions for an organization +actions.yaml,/repos/{owner}/{repo}/actions/permissions,actions/set-github-actions-permissions-repository,actions/set_github_actions_permissions_repository,put,,actions,actions,permissions,set_github_actions_permissions_repository,replace,,Set GitHub Actions permissions for a repository +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key,actions/get-environment-public-key,actions/get_environment_public_key,get,actions-public-key,actions,actions,public_keys,get_environment_public_key,select,,Get an environment public key +actions.yaml,/orgs/{org}/actions/secrets/public-key,actions/get-org-public-key,actions/get_org_public_key,get,actions-public-key,actions,actions,public_keys,get_org_public_key,select,,Get an organization public key +actions.yaml,/repos/{owner}/{repo}/actions/secrets/public-key,actions/get-repo-public-key,actions/get_repo_public_key,get,actions-public-key,actions,actions,public_keys,get_repo_public_key,select,,Get a repository public key +actions.yaml,/repos/{owner}/{repo}/actions/organization-secrets,actions/list-repo-organization-secrets,actions/list_repo_organization_secrets,get,,actions,actions,repo_org_secrets,list_repo_organization_secrets,select,,List repository organization secrets +actions.yaml,/repos/{owner}/{repo}/actions/organization-variables,actions/list-repo-organization-variables,actions/list_repo_organization_variables,get,,actions,actions,repo_org_variables,list_repo_organization_variables,select,,List repository organization variables +actions.yaml,/orgs/{org}/actions/variables/{name}/repositories/{repository_id},actions/remove-selected-repo-from-org-variable,actions/remove_selected_repo_from_org_variable,delete,,actions,actions,repos_for_org_variable,remove_selected_repo_from_org_variable,delete,,Remove selected repository from an organization variable +actions.yaml,/orgs/{org}/actions/variables/{name}/repositories,actions/list-selected-repos-for-org-variable,actions/list_selected_repos_for_org_variable,get,,actions,actions,repos_for_org_variable,list_selected_repos_for_org_variable,select,,List selected repositories for an organization variable +actions.yaml,/orgs/{org}/actions/variables/{name}/repositories/{repository_id},actions/add-selected-repo-to-org-variable,actions/add_selected_repo_to_org_variable,put,,actions,actions,repos_for_org_variable,add_selected_repo_to_org_variable,insert,,Add selected repository to an organization variable +actions.yaml,/orgs/{org}/actions/variables/{name}/repositories,actions/set-selected-repos-for-org-variable,actions/set_selected_repos_for_org_variable,put,,actions,actions,repos_for_org_variable,set_selected_repos_for_org_variable,replace,,Set selected repositories for an organization variable +actions.yaml,/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id},actions/remove-selected-repo-from-org-secret,actions/remove_selected_repo_from_org_secret,delete,,actions,actions,repos_for_secret,remove_selected_repo_from_org_secret,delete,,Remove selected repository from an organization secret +actions.yaml,/orgs/{org}/actions/secrets/{secret_name}/repositories,actions/list-selected-repos-for-org-secret,actions/list_selected_repos_for_org_secret,get,,actions,actions,repos_for_secret,list_selected_repos_for_org_secret,select,,List selected repositories for an organization secret +actions.yaml,/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id},actions/add-selected-repo-to-org-secret,actions/add_selected_repo_to_org_secret,put,,actions,actions,repos_for_secret,add_selected_repo_to_org_secret,insert,,Add selected repository to an organization secret +actions.yaml,/orgs/{org}/actions/secrets/{secret_name}/repositories,actions/set-selected-repos-for-org-secret,actions/set_selected_repos_for_org_secret,put,,actions,actions,repos_for_secret,set_selected_repos_for_org_secret,replace,,Set selected repositories for an organization secret +actions.yaml,/orgs/{org}/actions/runners/downloads,actions/list-runner-applications-for-org,actions/list_runner_applications_for_org,get,runner-application,actions,actions,runner_applications,list_runner_applications_for_org,select,,List runner applications for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/downloads,actions/list-runner-applications-for-repo,actions/list_runner_applications_for_repo,get,runner-application,actions,actions,runner_applications,list_runner_applications_for_repo,select,,List runner applications for a repository +actions.yaml,/orgs/{org}/actions/runners/generate-jitconfig,actions/generate-runner-jitconfig-for-org,actions/generate_runner_jitconfig_for_org,post,,actions,actions,runner_jit_configs,generate_runner_jitconfig_for_org,insert,,Create configuration for a just-in-time runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/generate-jitconfig,actions/generate-runner-jitconfig-for-repo,actions/generate_runner_jitconfig_for_repo,post,,actions,actions,runner_jit_configs,generate_runner_jitconfig_for_repo,insert,,Create configuration for a just-in-time runner for a repository +actions.yaml,/orgs/{org}/actions/runners/{runner_id}/labels,actions/remove-all-custom-labels-from-self-hosted-runner-for-org,actions/remove_all_custom_labels_from_self_hosted_runner_for_org,delete,,actions,actions,runner_labels,remove_all_custom_labels_from_self_hosted_runner_for_org,delete,,Remove all custom labels from a self-hosted runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id}/labels,actions/remove-all-custom-labels-from-self-hosted-runner-for-repo,actions/remove_all_custom_labels_from_self_hosted_runner_for_repo,delete,,actions,actions,runner_labels,remove_all_custom_labels_from_self_hosted_runner_for_repo,delete,,Remove all custom labels from a self-hosted runner for a repository +actions.yaml,/orgs/{org}/actions/runners/{runner_id}/labels/{name},actions/remove-custom-label-from-self-hosted-runner-for-org,actions/remove_custom_label_from_self_hosted_runner_for_org,delete,,actions,actions,runner_labels,remove_custom_label_from_self_hosted_runner_for_org,delete,,Remove a custom label from a self-hosted runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name},actions/remove-custom-label-from-self-hosted-runner-for-repo,actions/remove_custom_label_from_self_hosted_runner_for_repo,delete,,actions,actions,runner_labels,remove_custom_label_from_self_hosted_runner_for_repo,delete,,Remove a custom label from a self-hosted runner for a repository +actions.yaml,/orgs/{org}/actions/runners/{runner_id}/labels,actions/list-labels-for-self-hosted-runner-for-org,actions/list_labels_for_self_hosted_runner_for_org,get,,actions,actions,runner_labels,list_labels_for_self_hosted_runner_for_org,select,,List labels for a self-hosted runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id}/labels,actions/list-labels-for-self-hosted-runner-for-repo,actions/list_labels_for_self_hosted_runner_for_repo,get,,actions,actions,runner_labels,list_labels_for_self_hosted_runner_for_repo,select,,List labels for a self-hosted runner for a repository +actions.yaml,/orgs/{org}/actions/runners/{runner_id}/labels,actions/add-custom-labels-to-self-hosted-runner-for-org,actions/add_custom_labels_to_self_hosted_runner_for_org,post,,actions,actions,runner_labels,add_custom_labels_to_self_hosted_runner_for_org,insert,,Add custom labels to a self-hosted runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id}/labels,actions/add-custom-labels-to-self-hosted-runner-for-repo,actions/add_custom_labels_to_self_hosted_runner_for_repo,post,,actions,actions,runner_labels,add_custom_labels_to_self_hosted_runner_for_repo,insert,,Add custom labels to a self-hosted runner for a repository +actions.yaml,/orgs/{org}/actions/runners/{runner_id}/labels,actions/set-custom-labels-for-self-hosted-runner-for-org,actions/set_custom_labels_for_self_hosted_runner_for_org,put,,actions,actions,runner_labels,set_custom_labels_for_self_hosted_runner_for_org,replace,,Set custom labels for a self-hosted runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id}/labels,actions/set-custom-labels-for-self-hosted-runner-for-repo,actions/set_custom_labels_for_self_hosted_runner_for_repo,put,,actions,actions,runner_labels,set_custom_labels_for_self_hosted_runner_for_repo,replace,,Set custom labels for a self-hosted runner for a repository +actions.yaml,/orgs/{org}/actions/runners/registration-token,actions/create-registration-token-for-org,actions/create_registration_token_for_org,post,authentication-token,actions,actions,runner_registration_tokens,create_registration_token_for_org,insert,,Create a registration token for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/registration-token,actions/create-registration-token-for-repo,actions/create_registration_token_for_repo,post,authentication-token,actions,actions,runner_registration_tokens,create_registration_token_for_repo,insert,,Create a registration token for a repository +actions.yaml,/orgs/{org}/actions/runners/remove-token,actions/create-remove-token-for-org,actions/create_remove_token_for_org,post,authentication-token,actions,actions,runner_remove_tokens,create_remove_token_for_org,insert,,Create a remove token for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/remove-token,actions/create-remove-token-for-repo,actions/create_remove_token_for_repo,post,authentication-token,actions,actions,runner_remove_tokens,create_remove_token_for_repo,insert,,Create a remove token for a repository +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name},actions/delete-environment-secret,actions/delete_environment_secret,delete,,actions,actions,secrets,delete_environment_secret,delete,,Delete an environment secret +actions.yaml,/orgs/{org}/actions/secrets/{secret_name},actions/delete-org-secret,actions/delete_org_secret,delete,,actions,actions,secrets,delete_org_secret,delete,,Delete an organization secret +actions.yaml,/repos/{owner}/{repo}/actions/secrets/{secret_name},actions/delete-repo-secret,actions/delete_repo_secret,delete,,actions,actions,secrets,delete_repo_secret,delete,,Delete a repository secret +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name},actions/get-environment-secret,actions/get_environment_secret,get,actions-secret,actions,actions,secrets,get_environment_secret,select,,Get an environment secret +actions.yaml,/orgs/{org}/actions/secrets/{secret_name},actions/get-org-secret,actions/get_org_secret,get,organization-actions-secret,actions,actions,secrets,get_org_secret,select,,Get an organization secret +actions.yaml,/repos/{owner}/{repo}/actions/secrets/{secret_name},actions/get-repo-secret,actions/get_repo_secret,get,actions-secret,actions,actions,secrets,get_repo_secret,select,,Get a repository secret +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/secrets,actions/list-environment-secrets,actions/list_environment_secrets,get,,actions,actions,secrets,list_environment_secrets,select,,List environment secrets +actions.yaml,/orgs/{org}/actions/secrets,actions/list-org-secrets,actions/list_org_secrets,get,,actions,actions,secrets,list_org_secrets,select,,List organization secrets +actions.yaml,/repos/{owner}/{repo}/actions/secrets,actions/list-repo-secrets,actions/list_repo_secrets,get,,actions,actions,secrets,list_repo_secrets,select,,List repository secrets +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name},actions/create-or-update-environment-secret,actions/create_or_update_environment_secret,put,empty-object,actions,actions,secrets,create_or_update_environment_secret,insert,,Create or update an environment secret +actions.yaml,/orgs/{org}/actions/secrets/{secret_name},actions/create-or-update-org-secret,actions/create_or_update_org_secret,put,empty-object,actions,actions,secrets,create_or_update_org_secret,insert,,Create or update an organization secret +actions.yaml,/repos/{owner}/{repo}/actions/secrets/{secret_name},actions/create-or-update-repo-secret,actions/create_or_update_repo_secret,put,empty-object,actions,actions,secrets,create_or_update_repo_secret,insert,,Create or update a repository secret +actions.yaml,/orgs/{org}/actions/runners/{runner_id},actions/delete-self-hosted-runner-from-org,actions/delete_self_hosted_runner_from_org,delete,,actions,actions,self_hosted_runners,delete_self_hosted_runner_from_org,delete,,Delete a self-hosted runner from an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id},actions/delete-self-hosted-runner-from-repo,actions/delete_self_hosted_runner_from_repo,delete,,actions,actions,self_hosted_runners,delete_self_hosted_runner_from_repo,delete,,Delete a self-hosted runner from a repository +actions.yaml,/orgs/{org}/actions/runners/{runner_id},actions/get-self-hosted-runner-for-org,actions/get_self_hosted_runner_for_org,get,runner,actions,actions,self_hosted_runners,get_self_hosted_runner_for_org,select,,Get a self-hosted runner for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners/{runner_id},actions/get-self-hosted-runner-for-repo,actions/get_self_hosted_runner_for_repo,get,runner,actions,actions,self_hosted_runners,get_self_hosted_runner_for_repo,select,,Get a self-hosted runner for a repository +actions.yaml,/orgs/{org}/actions/runners,actions/list-self-hosted-runners-for-org,actions/list_self_hosted_runners_for_org,get,,actions,actions,self_hosted_runners,list_self_hosted_runners_for_org,select,,List self-hosted runners for an organization +actions.yaml,/repos/{owner}/{repo}/actions/runners,actions/list-self-hosted-runners-for-repo,actions/list_self_hosted_runners_for_repo,get,,actions,actions,self_hosted_runners,list_self_hosted_runners_for_repo,select,,List self-hosted runners for a repository +actions.yaml,/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format},actions/download-artifact,actions/download_artifact,get,,actions,actions,skip_this_resource,download_artifact,exec,,Download an artifact +actions.yaml,/repos/{owner}/{repo}/actions/jobs/{job_id}/logs,actions/download-job-logs-for-workflow-run,actions/download_job_logs_for_workflow_run,get,,actions,actions,skip_this_resource,download_job_logs_for_workflow_run,exec,,Download job logs for a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs,actions/download-workflow-run-attempt-logs,actions/download_workflow_run_attempt_logs,get,,actions,actions,skip_this_resource,download_workflow_run_attempt_logs,exec,,Download workflow run attempt logs +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/logs,actions/download-workflow-run-logs,actions/download_workflow_run_logs,get,,actions,actions,skip_this_resource,download_workflow_run_logs,exec,,Download workflow run logs +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/variables/{name},actions/delete-environment-variable,actions/delete_environment_variable,delete,,actions,actions,variables,delete_environment_variable,delete,,Delete an environment variable +actions.yaml,/orgs/{org}/actions/variables/{name},actions/delete-org-variable,actions/delete_org_variable,delete,,actions,actions,variables,delete_org_variable,delete,,Delete an organization variable +actions.yaml,/repos/{owner}/{repo}/actions/variables/{name},actions/delete-repo-variable,actions/delete_repo_variable,delete,,actions,actions,variables,delete_repo_variable,delete,,Delete a repository variable +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/variables/{name},actions/get-environment-variable,actions/get_environment_variable,get,actions-variable,actions,actions,variables,get_environment_variable,select,,Get an environment variable +actions.yaml,/orgs/{org}/actions/variables/{name},actions/get-org-variable,actions/get_org_variable,get,organization-actions-variable,actions,actions,variables,get_org_variable,select,,Get an organization variable +actions.yaml,/repos/{owner}/{repo}/actions/variables/{name},actions/get-repo-variable,actions/get_repo_variable,get,actions-variable,actions,actions,variables,get_repo_variable,select,,Get a repository variable +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/variables,actions/list-environment-variables,actions/list_environment_variables,get,,actions,actions,variables,list_environment_variables,select,,List environment variables +actions.yaml,/orgs/{org}/actions/variables,actions/list-org-variables,actions/list_org_variables,get,,actions,actions,variables,list_org_variables,select,,List organization variables +actions.yaml,/repos/{owner}/{repo}/actions/variables,actions/list-repo-variables,actions/list_repo_variables,get,,actions,actions,variables,list_repo_variables,select,,List repository variables +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/variables/{name},actions/update-environment-variable,actions/update_environment_variable,patch,,actions,actions,variables,update_environment_variable,update,,Update an environment variable +actions.yaml,/orgs/{org}/actions/variables/{name},actions/update-org-variable,actions/update_org_variable,patch,,actions,actions,variables,update_org_variable,update,,Update an organization variable +actions.yaml,/repos/{owner}/{repo}/actions/variables/{name},actions/update-repo-variable,actions/update_repo_variable,patch,,actions,actions,variables,update_repo_variable,update,,Update a repository variable +actions.yaml,/repos/{owner}/{repo}/environments/{environment_name}/variables,actions/create-environment-variable,actions/create_environment_variable,post,empty-object,actions,actions,variables,create_environment_variable,insert,,Create an environment variable +actions.yaml,/orgs/{org}/actions/variables,actions/create-org-variable,actions/create_org_variable,post,empty-object,actions,actions,variables,create_org_variable,insert,,Create an organization variable +actions.yaml,/repos/{owner}/{repo}/actions/variables,actions/create-repo-variable,actions/create_repo_variable,post,empty-object,actions,actions,variables,create_repo_variable,insert,,Create a repository variable +actions.yaml,/repos/{owner}/{repo}/actions/permissions/access,actions/get-workflow-access-to-repository,actions/get_workflow_access_to_repository,get,actions-workflow-access-to-repository,actions,actions,workflow_access,get_workflow_access_to_repository,select,,Get the level of access for workflows outside of the repository +actions.yaml,/repos/{owner}/{repo}/actions/permissions/access,actions/set-workflow-access-to-repository,actions/set_workflow_access_to_repository,put,,actions,actions,workflow_access,set_workflow_access_to_repository,replace,,Set the level of access for workflows outside of the repository +actions.yaml,/repos/{owner}/{repo}/actions/jobs/{job_id},actions/get-job-for-workflow-run,actions/get_job_for_workflow_run,get,job,actions,actions,workflow_jobs,get_job_for_workflow_run,select,,Get a job for a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/jobs,actions/list-jobs-for-workflow-run,actions/list_jobs_for_workflow_run,get,,actions,actions,workflow_jobs,list_jobs_for_workflow_run,select,,List jobs for a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs,actions/list-jobs-for-workflow-run-attempt,actions/list_jobs_for_workflow_run_attempt,get,,actions,actions,workflow_jobs,list_jobs_for_workflow_run_attempt,select,,List jobs for a workflow run attempt +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/logs,actions/delete-workflow-run-logs,actions/delete_workflow_run_logs,delete,,actions,actions,workflow_run_logs,delete_workflow_run_logs,delete,,Delete workflow run logs +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/approvals,actions/get-reviews-for-run,actions/get_reviews_for_run,get,environment-approvals,actions,actions,workflow_run_reviews,get_reviews_for_run,select,,Get the review history for a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/timing,actions/get-workflow-run-usage,actions/get_workflow_run_usage,get,workflow-run-usage,actions,actions,workflow_run_usage,get_workflow_run_usage,select,,Get workflow run usage +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id},actions/delete-workflow-run,actions/delete_workflow_run,delete,,actions,actions,workflow_runs,delete_workflow_run,delete,,Delete a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id},actions/get-workflow-run,actions/get_workflow_run,get,workflow-run,actions,actions,workflow_runs,get_workflow_run,select,,Get a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number},actions/get-workflow-run-attempt,actions/get_workflow_run_attempt,get,workflow-run,actions,actions,workflow_runs,get_workflow_run_attempt,select,,Get a workflow run attempt +actions.yaml,/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs,actions/list-workflow-runs,actions/list_workflow_runs,get,,actions,actions,workflow_runs,list_workflow_runs,select,,List workflow runs for a workflow +actions.yaml,/repos/{owner}/{repo}/actions/runs,actions/list-workflow-runs-for-repo,actions/list_workflow_runs_for_repo,get,,actions,actions,workflow_runs,list_workflow_runs_for_repo,select,$.workflow_runs,List workflow runs for a repository +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/approve,actions/approve-workflow-run,actions/approve_workflow_run,post,empty-object,actions,actions,workflow_runs,approve_workflow_run,exec,,Approve a workflow run for a fork pull request +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/cancel,actions/cancel-workflow-run,actions/cancel_workflow_run,post,empty-object,actions,actions,workflow_runs,cancel_workflow_run,exec,,Cancel a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel,actions/force-cancel-workflow-run,actions/force_cancel_workflow_run,post,,actions,actions,workflow_runs,force_cancel_workflow_run,insert,,Force cancel a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun,actions/re-run-job-for-workflow-run,actions/re_run_job_for_workflow_run,post,empty-object,actions,actions,workflow_runs,re_run_job_for_workflow_run,exec,,Re-run a job from a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/rerun,actions/re-run-workflow,actions/re_run_workflow,post,empty-object,actions,actions,workflow_runs,re_run_workflow,exec,,Re-run a workflow +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs,actions/re-run-workflow-failed-jobs,actions/re_run_workflow_failed_jobs,post,empty-object,actions,actions,workflow_runs,re_run_workflow_failed_jobs,exec,,Re-run failed jobs from a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule,actions/review-custom-gates-for-run,actions/review_custom_gates_for_run,post,,actions,actions,workflow_runs,review_custom_gates_for_run,exec,,Review custom deployment protection rules for a workflow run +actions.yaml,/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing,actions/get-workflow-usage,actions/get_workflow_usage,get,workflow-usage,actions,actions,workflow_usage,get_workflow_usage,select,$.billable,Get workflow usage +actions.yaml,/repos/{owner}/{repo}/actions/workflows/{workflow_id},actions/get-workflow,actions/get_workflow,get,workflow,actions,actions,workflows,get_workflow,select,,Get a workflow +actions.yaml,/repos/{owner}/{repo}/actions/workflows,actions/list-repo-workflows,actions/list_repo_workflows,get,,actions,actions,workflows,list_repo_workflows,select,,List repository workflows +actions.yaml,/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches,actions/create-workflow-dispatch,actions/create_workflow_dispatch,post,,actions,actions,workflows,create_workflow_dispatch,insert,,Create a workflow dispatch event +actions.yaml,/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable,actions/disable-workflow,actions/disable_workflow,put,,actions,actions,workflows,disable_workflow,exec,,Disable a workflow +actions.yaml,/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable,actions/enable-workflow,actions/enable_workflow,put,,actions,actions,workflows,enable_workflow,exec,,Enable a workflow +activity.yaml,/users/{username}/events,activity/list-events-for-authenticated-user,activity/list_events_for_authenticated_user,get,event,activity,activity,events,list_events_for_authenticated_user,select,,List events for the authenticated user +activity.yaml,/users/{username}/events/orgs/{org},activity/list-org-events-for-authenticated-user,activity/list_org_events_for_authenticated_user,get,event,activity,activity,events,list_org_events_for_authenticated_user,select,,List organization events for the authenticated user +activity.yaml,/repos/{owner}/{repo}/events,activity/list-repo-events,activity/list_repo_events,get,event,activity,activity,events,list_repo_events,select,,List repository events +activity.yaml,/feeds,activity/get-feeds,activity/get_feeds,get,feed,activity,activity,feeds,get_feeds,select,,Get feeds +activity.yaml,/notifications/threads/{thread_id},activity/mark-thread-as-done,activity/mark_thread_as_done,delete,,activity,activity,notifications,mark_thread_as_done,delete,,Mark a thread as done +activity.yaml,/notifications/threads/{thread_id},activity/get-thread,activity/get_thread,get,thread,activity,activity,notifications,get_thread,select,,Get a thread +activity.yaml,/notifications,activity/list-notifications-for-authenticated-user,activity/list_notifications_for_authenticated_user,get,thread,activity,activity,notifications,list_notifications_for_authenticated_user,select,,List notifications for the authenticated user +activity.yaml,/repos/{owner}/{repo}/notifications,activity/list-repo-notifications-for-authenticated-user,activity/list_repo_notifications_for_authenticated_user,get,thread,activity,activity,notifications,list_repo_notifications_for_authenticated_user,select,,List repository notifications for the authenticated user +activity.yaml,/notifications/threads/{thread_id},activity/mark-thread-as-read,activity/mark_thread_as_read,patch,,activity,activity,notifications,mark_thread_as_read,update,,Mark a thread as read +activity.yaml,/notifications,activity/mark-notifications-as-read,activity/mark_notifications_as_read,put,,activity,activity,notifications,mark_notifications_as_read,exec,,Mark notifications as read +activity.yaml,/repos/{owner}/{repo}/notifications,activity/mark-repo-notifications-as-read,activity/mark_repo_notifications_as_read,put,,activity,activity,notifications,mark_repo_notifications_as_read,exec,,Mark repository notifications as read +activity.yaml,/notifications/threads/{thread_id}/subscription,activity/delete-thread-subscription,activity/delete_thread_subscription,delete,,activity,activity,notifications_thread_subscriptions,delete_thread_subscription,delete,,Delete a thread subscription +activity.yaml,/notifications/threads/{thread_id}/subscription,activity/get-thread-subscription-for-authenticated-user,activity/get_thread_subscription_for_authenticated_user,get,thread-subscription,activity,activity,notifications_thread_subscriptions,get_thread_subscription_for_authenticated_user,select,,Get a thread subscription for the authenticated user +activity.yaml,/notifications/threads/{thread_id}/subscription,activity/set-thread-subscription,activity/set_thread_subscription,put,thread-subscription,activity,activity,notifications_thread_subscriptions,set_thread_subscription,replace,,Set a thread subscription +activity.yaml,/events,activity/list-public-events,activity/list_public_events,get,event,activity,activity,public_events,list_public_events,select,,List public events +activity.yaml,/networks/{owner}/{repo}/events,activity/list-public-events-for-repo-network,activity/list_public_events_for_repo_network,get,event,activity,activity,public_events,list_public_events_for_repo_network,select,,List public events for a network of repositories +activity.yaml,/users/{username}/events/public,activity/list-public-events-for-user,activity/list_public_events_for_user,get,event,activity,activity,public_events,list_public_events_for_user,select,,List public events for a user +activity.yaml,/orgs/{org}/events,activity/list-public-org-events,activity/list_public_org_events,get,event,activity,activity,public_events,list_public_org_events,select,,List public organization events +activity.yaml,/users/{username}/received_events,activity/list-received-events-for-user,activity/list_received_events_for_user,get,event,activity,activity,received_events,list_received_events_for_user,select,,List events received by the authenticated user +activity.yaml,/users/{username}/received_events/public,activity/list-received-public-events-for-user,activity/list_received_public_events_for_user,get,event,activity,activity,received_public_events,list_received_public_events_for_user,select,,List public events received by a user +activity.yaml,/repos/{owner}/{repo}/stargazers,activity/list-stargazers-for-repo,activity/list_stargazers_for_repo,get,simple-user,activity,activity,repo_stargazers,list_stargazers_for_repo,select,,List stargazers +activity.yaml,/repos/{owner}/{repo}/subscription,activity/delete-repo-subscription,activity/delete_repo_subscription,delete,,activity,activity,repo_subscriptions,delete_repo_subscription,delete,,Delete a repository subscription +activity.yaml,/repos/{owner}/{repo}/subscription,activity/get-repo-subscription,activity/get_repo_subscription,get,repository-subscription,activity,activity,repo_subscriptions,get_repo_subscription,select,,Get a repository subscription +activity.yaml,/repos/{owner}/{repo}/subscription,activity/set-repo-subscription,activity/set_repo_subscription,put,repository-subscription,activity,activity,repo_subscriptions,set_repo_subscription,replace,,Set a repository subscription +activity.yaml,/repos/{owner}/{repo}/subscribers,activity/list-watchers-for-repo,activity/list_watchers_for_repo,get,simple-user,activity,activity,repo_watchers,list_watchers_for_repo,select,,List watchers +activity.yaml,/user/starred/{owner}/{repo},activity/unstar-repo-for-authenticated-user,activity/unstar_repo_for_authenticated_user,delete,,activity,activity,starring,unstar_repo_for_authenticated_user,exec,,Unstar a repository for the authenticated user +activity.yaml,/user/starred/{owner}/{repo},activity/check-repo-is-starred-by-authenticated-user,activity/check_repo_is_starred_by_authenticated_user,get,,activity,activity,starring,check_repo_is_starred_by_authenticated_user,exec,,Check if a repository is starred by the authenticated user +activity.yaml,/user/starred,activity/list-repos-starred-by-authenticated-user,activity/list_repos_starred_by_authenticated_user,get,repository,activity,activity,starring,list_repos_starred_by_authenticated_user,select,,List repositories starred by the authenticated user +activity.yaml,/users/{username}/starred,activity/list-repos-starred-by-user,activity/list_repos_starred_by_user,get,starred-repository,activity,activity,starring,list_repos_starred_by_user,select,,List repositories starred by a user +activity.yaml,/user/starred/{owner}/{repo},activity/star-repo-for-authenticated-user,activity/star_repo_for_authenticated_user,put,,activity,activity,starring,star_repo_for_authenticated_user,exec,,Star a repository for the authenticated user +activity.yaml,/users/{username}/subscriptions,activity/list-repos-watched-by-user,activity/list_repos_watched_by_user,get,minimal-repository,activity,activity,watching,list_repos_watched_by_user,select,,List repositories watched by a user +activity.yaml,/user/subscriptions,activity/list-watched-repos-for-authenticated-user,activity/list_watched_repos_for_authenticated_user,get,minimal-repository,activity,activity,watching,list_watched_repos_for_authenticated_user,select,,List repositories watched by the authenticated user +agent_tasks.yaml,/agents/repos/{owner}/{repo}/tasks/{task_id},agent-tasks/get-task-by-repo-and-id,agent_tasks/get_task_by_repo_and_id,get,,agent-tasks,agent_tasks,repo_tasks,get_task_by_repo_and_id,select,$.sessions,Get a task by repo +agent_tasks.yaml,/agents/repos/{owner}/{repo}/tasks,agent-tasks/list-tasks-for-repo,agent_tasks/list_tasks_for_repo,get,,agent-tasks,agent_tasks,repo_tasks,list_tasks_for_repo,select,,List tasks for repository +agent_tasks.yaml,/agents/repos/{owner}/{repo}/tasks,agent-tasks/create-task,agent_tasks/create_task,post,,agent-tasks,agent_tasks,repo_tasks,create_task,insert,,Create a task +agent_tasks.yaml,/agents/tasks/{task_id},agent-tasks/get-task-by-id,agent_tasks/get_task_by_id,get,,agent-tasks,agent_tasks,tasks,get_task_by_id,select,$.sessions,Get a task by ID +agent_tasks.yaml,/agents/tasks,agent-tasks/list-tasks,agent_tasks/list_tasks,get,,agent-tasks,agent_tasks,tasks,list_tasks,select,,List tasks +apps.yaml,/app/installations/{installation_id},apps/delete-installation,apps/delete_installation,delete,,apps,apps,apps,delete_installation,delete,,Delete an installation for the authenticated app +apps.yaml,/app/installations/{installation_id}/suspended,apps/unsuspend-installation,apps/unsuspend_installation,delete,,apps,apps,apps,unsuspend_installation,exec,,Unsuspend an app installation +apps.yaml,/app/installations/{installation_id},apps/get-installation,apps/get_installation,get,installation,apps,apps,apps,get_installation,select,,Get an installation for the authenticated app +apps.yaml,/orgs/{org}/installation,apps/get-org-installation,apps/get_org_installation,get,installation,apps,apps,apps,get_org_installation,select,,Get an organization installation for the authenticated app +apps.yaml,/repos/{owner}/{repo}/installation,apps/get-repo-installation,apps/get_repo_installation,get,installation,apps,apps,apps,get_repo_installation,select,,Get a repository installation for the authenticated app +apps.yaml,/users/{username}/installation,apps/get-user-installation,apps/get_user_installation,get,installation,apps,apps,apps,get_user_installation,select,,Get a user installation for the authenticated app +apps.yaml,/app/installations,apps/list-installations,apps/list_installations,get,installation,apps,apps,apps,list_installations,select,,List installations for the authenticated app +apps.yaml,/app-manifests/{code}/conversions,apps/create-from-manifest,apps/create_from_manifest,post,,apps,apps,apps,create_from_manifest,insert,,Create a GitHub App from a manifest +apps.yaml,/app/installations/{installation_id}/access_tokens,apps/create-installation-access-token,apps/create_installation_access_token,post,installation-token,apps,apps,apps,create_installation_access_token,insert,,Create an installation access token for an app +apps.yaml,/applications/{client_id}/token/scoped,apps/scope-token,apps/scope_token,post,authorization,apps,apps,apps,scope_token,exec,,Create a scoped access token +apps.yaml,/app/installations/{installation_id}/suspended,apps/suspend-installation,apps/suspend_installation,put,,apps,apps,apps,suspend_installation,exec,,Suspend an app installation +apps.yaml,/user/installations/{installation_id}/repositories/{repository_id},apps/remove-repo-from-installation-for-authenticated-user,apps/remove_repo_from_installation_for_authenticated_user,delete,,apps,apps,installation_repos,remove_repo_from_installation_for_authenticated_user,delete,,Remove a repository from an app installation +apps.yaml,/user/installations/{installation_id}/repositories,apps/list-installation-repos-for-authenticated-user,apps/list_installation_repos_for_authenticated_user,get,,apps,apps,installation_repos,list_installation_repos_for_authenticated_user,select,,List repositories accessible to the user access token +apps.yaml,/installation/repositories,apps/list-repos-accessible-to-installation,apps/list_repos_accessible_to_installation,get,,apps,apps,installation_repos,list_repos_accessible_to_installation,select,,List repositories accessible to the app installation +apps.yaml,/user/installations/{installation_id}/repositories/{repository_id},apps/add-repo-to-installation-for-authenticated-user,apps/add_repo_to_installation_for_authenticated_user,put,,apps,apps,installation_repos,add_repo_to_installation_for_authenticated_user,insert,,Add a repository to an app installation +apps.yaml,/installation/token,apps/revoke-installation-access-token,apps/revoke_installation_access_token,delete,,apps,apps,installations,revoke_installation_access_token,delete,,Revoke an installation access token +apps.yaml,/user/installations,apps/list-installations-for-authenticated-user,apps/list_installations_for_authenticated_user,get,,apps,apps,installations,list_installations_for_authenticated_user,select,,List app installations accessible to the user access token +apps.yaml,/app/installation-requests,apps/list-installation-requests-for-authenticated-app,apps/list_installation_requests_for_authenticated_app,get,integration-installation-request,apps,apps,integration_installation_requests,list_installation_requests_for_authenticated_app,select,,List installation requests for the authenticated app +apps.yaml,/app,apps/get-authenticated,apps/get_authenticated,get,integration,apps,apps,integrations,get_authenticated,select,,Get the authenticated app +apps.yaml,/apps/{app_slug},apps/get-by-slug,apps/get_by_slug,get,integration,apps,apps,integrations,get_by_slug,select,,Get an app +apps.yaml,/marketplace_listing/plans,apps/list-plans,apps/list_plans,get,marketplace-listing-plan,apps,apps,marketplace_listings,list_plans,select,,List plans +apps.yaml,/marketplace_listing/stubbed/plans,apps/list-plans-stubbed,apps/list_plans_stubbed,get,marketplace-listing-plan,apps,apps,marketplace_listings_stubbed,list_plans_stubbed,select,,List plans (stubbed) +apps.yaml,/marketplace_listing/accounts/{account_id},apps/get-subscription-plan-for-account,apps/get_subscription_plan_for_account,get,marketplace-purchase,apps,apps,marketplace_subs,get_subscription_plan_for_account,select,,Get a subscription plan for an account +apps.yaml,/marketplace_listing/plans/{plan_id}/accounts,apps/list-accounts-for-plan,apps/list_accounts_for_plan,get,marketplace-purchase,apps,apps,marketplace_subs,list_accounts_for_plan,select,,List accounts for a plan +apps.yaml,/marketplace_listing/stubbed/accounts/{account_id},apps/get-subscription-plan-for-account-stubbed,apps/get_subscription_plan_for_account_stubbed,get,marketplace-purchase,apps,apps,marketplace_subs_stubbed,get_subscription_plan_for_account_stubbed,select,,Get a subscription plan for an account (stubbed) +apps.yaml,/marketplace_listing/stubbed/plans/{plan_id}/accounts,apps/list-accounts-for-plan-stubbed,apps/list_accounts_for_plan_stubbed,get,marketplace-purchase,apps,apps,marketplace_subs_stubbed,list_accounts_for_plan_stubbed,select,,List accounts for a plan (stubbed) +apps.yaml,/user/marketplace_purchases,apps/list-subscriptions-for-authenticated-user,apps/list_subscriptions_for_authenticated_user,get,user-marketplace-purchase,apps,apps,marketplace_users_subs,list_subscriptions_for_authenticated_user,select,,List subscriptions for the authenticated user +apps.yaml,/user/marketplace_purchases/stubbed,apps/list-subscriptions-for-authenticated-user-stubbed,apps/list_subscriptions_for_authenticated_user_stubbed,get,user-marketplace-purchase,apps,apps,marketplace_users_subs_stubbed,list_subscriptions_for_authenticated_user_stubbed,select,,List subscriptions for the authenticated user (stubbed) +apps.yaml,/applications/{client_id}/token,apps/delete-token,apps/delete_token,delete,,apps,apps,oauth_applications,delete_token,delete,,Delete an app token +apps.yaml,/applications/{client_id}/token,apps/reset-token,apps/reset_token,patch,authorization,apps,apps,oauth_applications,reset_token,exec,,Reset a token +apps.yaml,/applications/{client_id}/token,apps/check-token,apps/check_token,post,authorization,apps,apps,oauth_applications,check_token,exec,,Check a token +apps.yaml,/applications/{client_id}/grant,apps/delete-authorization,apps/delete_authorization,delete,,apps,apps,oauth_grants,delete_authorization,delete,,Delete an app authorization +apps.yaml,/app/hook/config,apps/get-webhook-config-for-app,apps/get_webhook_config_for_app,get,webhook-config,apps,apps,webhook_config,get_webhook_config_for_app,select,,Get a webhook configuration for an app +apps.yaml,/app/hook/config,apps/update-webhook-config-for-app,apps/update_webhook_config_for_app,patch,webhook-config,apps,apps,webhook_config,update_webhook_config_for_app,update,,Update a webhook configuration for an app +apps.yaml,/app/hook/deliveries,apps/list-webhook-deliveries,apps/list_webhook_deliveries,get,hook-delivery-item,apps,apps,webhook_deliveries,list_webhook_deliveries,select,,List deliveries for an app webhook +apps.yaml,/app/hook/deliveries/{delivery_id},apps/get-webhook-delivery,apps/get_webhook_delivery,get,hook-delivery,apps,apps,webhook_delivery,get_webhook_delivery,select,,Get a delivery for an app webhook +apps.yaml,/app/hook/deliveries/{delivery_id}/attempts,apps/redeliver-webhook-delivery,apps/redeliver_webhook_delivery,post,,apps,apps,webhook_delivery,redeliver_webhook_delivery,exec,,Redeliver a delivery for an app webhook +billing.yaml,/orgs/{org}/settings/billing/actions,billing/get-github-actions-billing-org,billing/get_github_actions_billing_org,get,actions-billing-usage,billing,billing,actions_billing_usage,get_github_actions_billing_org,select,,Get GitHub Actions billing for an organization +billing.yaml,/users/{username}/settings/billing/actions,billing/get-github-actions-billing-user,billing/get_github_actions_billing_user,get,actions-billing-usage,billing,billing,actions_billing_usage,get_github_actions_billing_user,select,,Get GitHub Actions billing for a user +billing.yaml,/orgs/{org}/settings/billing/shared-storage,billing/get-shared-storage-billing-org,billing/get_shared_storage_billing_org,get,combined-billing-usage,billing,billing,combined_billing_usage,get_shared_storage_billing_org,select,,Get shared storage billing for an organization +billing.yaml,/users/{username}/settings/billing/shared-storage,billing/get-shared-storage-billing-user,billing/get_shared_storage_billing_user,get,combined-billing-usage,billing,billing,combined_billing_usage,get_shared_storage_billing_user,select,,Get shared storage billing for a user +billing.yaml,/organizations/{org}/settings/billing/budgets/{budget_id},billing/delete-budget-org,billing/delete_budget_org,delete,,billing,billing,org_budgets,delete_budget_org,delete,,Delete a budget for an organization +billing.yaml,/organizations/{org}/settings/billing/budgets,billing/get-all-budgets-org,billing/get_all_budgets_org,get,,billing,billing,org_budgets,get_all_budgets_org,select,,Get all budgets for an organization +billing.yaml,/organizations/{org}/settings/billing/budgets/{budget_id},billing/get-budget-org,billing/get_budget_org,get,,billing,billing,org_budgets,get_budget_org,select,,Get a budget by ID for an organization +billing.yaml,/organizations/{org}/settings/billing/budgets/{budget_id},billing/update-budget-org,billing/update_budget_org,patch,,billing,billing,org_budgets,update_budget_org,update,,Update a budget for an organization +billing.yaml,/organizations/{org}/settings/billing/premium_request/usage,billing/get-github-billing-premium-request-usage-report-org,billing/get_github_billing_premium_request_usage_report_org,get,,billing,billing,org_premium_request_usage,get_github_billing_premium_request_usage_report_org,select,,Get billing premium request usage report for an organization +billing.yaml,/organizations/{org}/settings/billing/usage,billing/get-github-billing-usage-report-org,billing/get_github_billing_usage_report_org,get,,billing,billing,org_usage,get_github_billing_usage_report_org,select,$.usageItems,Get billing usage report for an organization +billing.yaml,/organizations/{org}/settings/billing/usage/summary,billing/get-github-billing-usage-summary-report-org,billing/get_github_billing_usage_summary_report_org,get,,billing,billing,org_usage_summary,get_github_billing_usage_summary_report_org,select,,Get billing usage summary for an organization +billing.yaml,/orgs/{org}/settings/billing/packages,billing/get-github-packages-billing-org,billing/get_github_packages_billing_org,get,packages-billing-usage,billing,billing,packages_billing_usage,get_github_packages_billing_org,select,,Get GitHub Packages billing for an organization +billing.yaml,/users/{username}/settings/billing/packages,billing/get-github-packages-billing-user,billing/get_github_packages_billing_user,get,packages-billing-usage,billing,billing,packages_billing_usage,get_github_packages_billing_user,select,,Get GitHub Packages billing for a user +billing.yaml,/users/{username}/settings/billing/premium_request/usage,billing/get-github-billing-premium-request-usage-report-user,billing/get_github_billing_premium_request_usage_report_user,get,,billing,billing,premium_request_usage,get_github_billing_premium_request_usage_report_user,select,,Get billing premium request usage report for a user +billing.yaml,/users/{username}/settings/billing/usage,billing/get-github-billing-usage-report-user,billing/get_github_billing_usage_report_user,get,,billing,billing,usage,get_github_billing_usage_report_user,select,$.usageItems,Get billing usage report for a user +billing.yaml,/users/{username}/settings/billing/usage/summary,billing/get-github-billing-usage-summary-report-user,billing/get_github_billing_usage_summary_report_user,get,,billing,billing,usage_summary,get_github_billing_usage_summary_report_user,select,,Get billing usage summary for a user +campaigns.yaml,/orgs/{org}/campaigns/{campaign_number},campaigns/delete-campaign,campaigns/delete_campaign,delete,,campaigns,campaigns,org_campaigns,delete_campaign,delete,,Delete a campaign for an organization +campaigns.yaml,/orgs/{org}/campaigns/{campaign_number},campaigns/get-campaign-summary,campaigns/get_campaign_summary,get,,campaigns,campaigns,org_campaigns,get_campaign_summary,select,,Get a campaign for an organization +campaigns.yaml,/orgs/{org}/campaigns,campaigns/list-org-campaigns,campaigns/list_org_campaigns,get,,campaigns,campaigns,org_campaigns,list_org_campaigns,select,,List campaigns for an organization +campaigns.yaml,/orgs/{org}/campaigns/{campaign_number},campaigns/update-campaign,campaigns/update_campaign,patch,,campaigns,campaigns,org_campaigns,update_campaign,update,,Update a campaign +campaigns.yaml,/orgs/{org}/campaigns,campaigns/create-campaign,campaigns/create_campaign,post,,campaigns,campaigns,org_campaigns,create_campaign,insert,,Create a campaign for an organization +checks.yaml,/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations,checks/list-annotations,checks/list_annotations,get,check-annotation,checks,checks,annotations,list_annotations,select,,List check run annotations +checks.yaml,/repos/{owner}/{repo}/check-runs/{check_run_id},checks/get,checks/get,get,check-run,checks,checks,runs,get,select,,Get a check run +checks.yaml,/repos/{owner}/{repo}/commits/{ref}/check-runs,checks/list-for-ref,checks/list_for_ref,get,,checks,checks,runs,list_for_ref,select,,List check runs for a Git reference +checks.yaml,/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs,checks/list-for-suite,checks/list_for_suite,get,,checks,checks,runs,list_for_suite,select,,List check runs in a check suite +checks.yaml,/repos/{owner}/{repo}/check-runs/{check_run_id},checks/update,checks/update,patch,check-run,checks,checks,runs,update,update,,Update a check run +checks.yaml,/repos/{owner}/{repo}/check-runs,checks/create,checks/create,post,check-run,checks,checks,runs,create,insert,,Create a check run +checks.yaml,/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest,checks/rerequest-run,checks/rerequest_run,post,empty-object,checks,checks,runs,rerequest_run,exec,,Rerequest a check run +checks.yaml,/repos/{owner}/{repo}/check-suites/{check_suite_id},checks/get-suite,checks/get_suite,get,check-suite,checks,checks,suites,get_suite,select,,Get a check suite +checks.yaml,/repos/{owner}/{repo}/commits/{ref}/check-suites,checks/list-suites-for-ref,checks/list_suites_for_ref,get,,checks,checks,suites,list_suites_for_ref,select,,List check suites for a Git reference +checks.yaml,/repos/{owner}/{repo}/check-suites/preferences,checks/set-suites-preferences,checks/set_suites_preferences,patch,check-suite-preference,checks,checks,suites,set_suites_preferences,update,,Update repository preferences for check suites +checks.yaml,/repos/{owner}/{repo}/check-suites,checks/create-suite,checks/create_suite,post,check-suite,checks,checks,suites,create_suite,insert,,Create a check suite +checks.yaml,/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest,checks/rerequest-suite,checks/rerequest_suite,post,empty-object,checks,checks,suites,rerequest_suite,exec,,Rerequest a check suite +classroom.yaml,/assignments/{assignment_id}/accepted_assignments,classroom/list-accepted-assignments-for-an-assignment,classroom/list_accepted_assignments_for_an_assignment,get,,classroom,classroom,assignment_accepted_assignments,list_accepted_assignments_for_an_assignment,select,,List accepted assignments for an assignment +classroom.yaml,/assignments/{assignment_id}/grades,classroom/get-assignment-grades,classroom/get_assignment_grades,get,,classroom,classroom,assignment_grades,get_assignment_grades,select,,Get assignment grades +classroom.yaml,/assignments/{assignment_id},classroom/get-an-assignment,classroom/get_an_assignment,get,,classroom,classroom,assignments,get_an_assignment,select,,Get an assignment +classroom.yaml,/classrooms/{classroom_id}/assignments,classroom/list-assignments-for-a-classroom,classroom/list_assignments_for_a_classroom,get,,classroom,classroom,classroom_assignments,list_assignments_for_a_classroom,select,,List assignments for a classroom +classroom.yaml,/classrooms/{classroom_id},classroom/get-a-classroom,classroom/get_a_classroom,get,,classroom,classroom,classrooms,get_a_classroom,select,,Get a classroom +classroom.yaml,/classrooms,classroom/list-classrooms,classroom/list_classrooms,get,,classroom,classroom,classrooms,list_classrooms,select,,List classrooms +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix,code-scanning/get-autofix,code_scanning/get_autofix,get,,code-scanning,code_scanning,alert_autofixes,get_autofix,select,,Get the status of an autofix for a code scanning alert +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits,code-scanning/commit-autofix,code_scanning/commit_autofix,post,,code-scanning,code_scanning,alert_autofixes,commit_autofix,exec,,Commit an autofix for a code scanning alert +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix,code-scanning/create-autofix,code_scanning/create_autofix,post,,code-scanning,code_scanning,alert_autofixes,create_autofix,insert,,Create an autofix for a code scanning alert +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances,code-scanning/list-alert-instances,code_scanning/list_alert_instances,get,code-scanning-alert-instance,code-scanning,code_scanning,alert_instances,list_alert_instances,select,,List instances of a code scanning alert +code_scanning.yaml,/orgs/{org}/code-scanning/alerts,code-scanning/list-alerts-for-org,code_scanning/list_alerts_for_org,get,code-scanning-organization-alert-items,code-scanning,code_scanning,alert_items,list_alerts_for_org,select,,List code scanning alerts for an organization +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts,code-scanning/list-alerts-for-repo,code_scanning/list_alerts_for_repo,get,code-scanning-alert-items,code-scanning,code_scanning,alert_items,list_alerts_for_repo,select,,List code scanning alerts for a repository +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts/{alert_number},code-scanning/get-alert,code_scanning/get_alert,get,code-scanning-alert,code-scanning,code_scanning,alerts,get_alert,select,,Get a code scanning alert +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/alerts/{alert_number},code-scanning/update-alert,code_scanning/update_alert,patch,code-scanning-alert,code-scanning,code_scanning,alerts,update_alert,update,,Update a code scanning alert +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id},code-scanning/delete-analysis,code_scanning/delete_analysis,delete,code-scanning-analysis-deletion,code-scanning,code_scanning,analysis,delete_analysis,delete,,Delete a code scanning analysis from a repository +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id},code-scanning/get-analysis,code_scanning/get_analysis,get,code-scanning-analysis,code-scanning,code_scanning,analysis,get_analysis,select,,Get a code scanning analysis for a repository +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/analyses,code-scanning/list-recent-analyses,code_scanning/list_recent_analyses,get,code-scanning-analysis,code-scanning,code_scanning,analysis,list_recent_analyses,select,,List code scanning analyses for a repository +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/codeql/databases/{language},code-scanning/delete-codeql-database,code_scanning/delete_codeql_database,delete,,code-scanning,code_scanning,codeql_databases,delete_codeql_database,delete,,Delete a CodeQL database +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/codeql/databases/{language},code-scanning/get-codeql-database,code_scanning/get_codeql_database,get,code-scanning-codeql-database,code-scanning,code_scanning,codeql_databases,get_codeql_database,select,,Get a CodeQL database for a repository +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/codeql/databases,code-scanning/list-codeql-databases,code_scanning/list_codeql_databases,get,code-scanning-codeql-database,code-scanning,code_scanning,codeql_databases,list_codeql_databases,select,,List CodeQL databases for a repository +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id},code-scanning/get-variant-analysis,code_scanning/get_variant_analysis,get,,code-scanning,code_scanning,codeql_variant_analyses,get_variant_analysis,select,,Get the summary of a CodeQL variant analysis +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses,code-scanning/create-variant-analysis,code_scanning/create_variant_analysis,post,,code-scanning,code_scanning,codeql_variant_analyses,create_variant_analysis,insert,,Create a CodeQL variant analysis +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name},code-scanning/get-variant-analysis-repo-task,code_scanning/get_variant_analysis_repo_task,get,,code-scanning,code_scanning,codeql_variant_analysis_repo_tasks,get_variant_analysis_repo_task,select,,Get the analysis status of a repository in a CodeQL variant analysis +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/default-setup,code-scanning/get-default-setup,code_scanning/get_default_setup,get,code-scanning-default-setup,code-scanning,code_scanning,default_setup,get_default_setup,select,,Get a code scanning default setup configuration +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/default-setup,code-scanning/update-default-setup,code_scanning/update_default_setup,patch,empty-object,code-scanning,code_scanning,default_setup,update_default_setup,update,,Update a code scanning default setup configuration +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id},code-scanning/get-sarif,code_scanning/get_sarif,get,code-scanning-sarifs-status,code-scanning,code_scanning,sarifs,get_sarif,select,,Get information about a SARIF upload +code_scanning.yaml,/repos/{owner}/{repo}/code-scanning/sarifs,code-scanning/upload-sarif,code_scanning/upload_sarif,post,code-scanning-sarifs-receipt,code-scanning,code_scanning,sarifs,upload_sarif,update,,Upload an analysis as SARIF data +code_security.yaml,/orgs/{org}/code-security/configurations/{configuration_id}/repositories,code-security/get-repositories-for-configuration,code_security/get_repositories_for_configuration,get,,code-security,code_security,code_security_configuration_repos,get_repositories_for_configuration,select,,Get repositories associated with a code security configuration +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories,code-security/get-repositories-for-enterprise-configuration,code_security/get_repositories_for_enterprise_configuration,get,,code-security,code_security,code_security_configuration_repos,get_repositories_for_enterprise_configuration,select,,Get repositories associated with an enterprise code security configuration +code_security.yaml,/orgs/{org}/code-security/configurations/{configuration_id},code-security/delete-configuration,code_security/delete_configuration,delete,,code-security,code_security,code_security_configurations,delete_configuration,delete,,Delete a code security configuration +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/{configuration_id},code-security/delete-configuration-for-enterprise,code_security/delete_configuration_for_enterprise,delete,,code-security,code_security,code_security_configurations,delete_configuration_for_enterprise,delete,,Delete a code security configuration for an enterprise +code_security.yaml,/orgs/{org}/code-security/configurations/detach,code-security/detach-configuration,code_security/detach_configuration,delete,,code-security,code_security,code_security_configurations,detach_configuration,delete,,Detach configurations from repositories +code_security.yaml,/orgs/{org}/code-security/configurations/{configuration_id},code-security/get-configuration,code_security/get_configuration,get,,code-security,code_security,code_security_configurations,get_configuration,select,,Get a code security configuration +code_security.yaml,/enterprises/{enterprise}/code-security/configurations,code-security/get-configurations-for-enterprise,code_security/get_configurations_for_enterprise,get,,code-security,code_security,code_security_configurations,get_configurations_for_enterprise,select,,Get code security configurations for an enterprise +code_security.yaml,/orgs/{org}/code-security/configurations,code-security/get-configurations-for-org,code_security/get_configurations_for_org,get,,code-security,code_security,code_security_configurations,get_configurations_for_org,select,,Get code security configurations for an organization +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/{configuration_id},code-security/get-single-configuration-for-enterprise,code_security/get_single_configuration_for_enterprise,get,,code-security,code_security,code_security_configurations,get_single_configuration_for_enterprise,select,,Retrieve a code security configuration of an enterprise +code_security.yaml,/orgs/{org}/code-security/configurations/{configuration_id},code-security/update-configuration,code_security/update_configuration,patch,,code-security,code_security,code_security_configurations,update_configuration,update,,Update a code security configuration +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/{configuration_id},code-security/update-enterprise-configuration,code_security/update_enterprise_configuration,patch,,code-security,code_security,code_security_configurations,update_enterprise_configuration,update,,Update a custom code security configuration for an enterprise +code_security.yaml,/orgs/{org}/code-security/configurations/{configuration_id}/attach,code-security/attach-configuration,code_security/attach_configuration,post,,code-security,code_security,code_security_configurations,attach_configuration,insert,,Attach a configuration to repositories +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach,code-security/attach-enterprise-configuration,code_security/attach_enterprise_configuration,post,,code-security,code_security,code_security_configurations,attach_enterprise_configuration,insert,,Attach an enterprise configuration to repositories +code_security.yaml,/orgs/{org}/code-security/configurations,code-security/create-configuration,code_security/create_configuration,post,,code-security,code_security,code_security_configurations,create_configuration,insert,,Create a code security configuration +code_security.yaml,/enterprises/{enterprise}/code-security/configurations,code-security/create-configuration-for-enterprise,code_security/create_configuration_for_enterprise,post,,code-security,code_security,code_security_configurations,create_configuration_for_enterprise,insert,,Create a code security configuration for an enterprise +code_security.yaml,/orgs/{org}/code-security/configurations/{configuration_id}/defaults,code-security/set-configuration-as-default,code_security/set_configuration_as_default,put,,code-security,code_security,code_security_configurations,set_configuration_as_default,replace,,Set a code security configuration as a default for an organization +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults,code-security/set-configuration-as-default-for-enterprise,code_security/set_configuration_as_default_for_enterprise,put,,code-security,code_security,code_security_configurations,set_configuration_as_default_for_enterprise,replace,,Set a code security configuration as a default for an enterprise +code_security.yaml,/orgs/{org}/code-security/configurations/defaults,code-security/get-default-configurations,code_security/get_default_configurations,get,,code-security,code_security,code_security_default_configurations,get_default_configurations,select,,Get default code security configurations +code_security.yaml,/enterprises/{enterprise}/code-security/configurations/defaults,code-security/get-default-configurations-for-enterprise,code_security/get_default_configurations_for_enterprise,get,,code-security,code_security,code_security_default_configurations,get_default_configurations_for_enterprise,select,,Get default code security configurations for an enterprise +code_security.yaml,/repos/{owner}/{repo}/code-security-configuration,code-security/get-configuration-for-repository,code_security/get_configuration_for_repository,get,,code-security,code_security,repo_code_security_configuration,get_configuration_for_repository,select,,Get the code security configuration associated with a repository +codes_of_conduct.yaml,/codes_of_conduct,codes-of-conduct/get-all-codes-of-conduct,codes_of_conduct/get_all_codes_of_conduct,get,code-of-conduct,codes-of-conduct,codes_of_conduct,codes_of_conduct,get_all_codes_of_conduct,select,,Get all codes of conduct +codes_of_conduct.yaml,/codes_of_conduct/{key},codes-of-conduct/get-conduct-code,codes_of_conduct/get_conduct_code,get,code-of-conduct,codes-of-conduct,codes_of_conduct,codes_of_conduct,get_conduct_code,select,,Get a code of conduct +codespaces.yaml,/user/codespaces/{codespace_name}/exports/{export_id},codespaces/get-export-details-for-authenticated-user,codespaces/get_export_details_for_authenticated_user,get,codespace-export-details,codespaces,codespaces,codespace_export_details,get_export_details_for_authenticated_user,select,,Get details about a codespace export +codespaces.yaml,/user/codespaces/{codespace_name},codespaces/delete-for-authenticated-user,codespaces/delete_for_authenticated_user,delete,,codespaces,codespaces,codespaces,delete_for_authenticated_user,delete,,Delete a codespace for the authenticated user +codespaces.yaml,/user/codespaces/{codespace_name},codespaces/get-for-authenticated-user,codespaces/get_for_authenticated_user,get,codespace,codespaces,codespaces,codespaces,get_for_authenticated_user,select,,Get a codespace for the authenticated user +codespaces.yaml,/user/codespaces,codespaces/list-for-authenticated-user,codespaces/list_for_authenticated_user,get,,codespaces,codespaces,codespaces,list_for_authenticated_user,select,,List codespaces for the authenticated user +codespaces.yaml,/repos/{owner}/{repo}/codespaces,codespaces/list-in-repository-for-authenticated-user,codespaces/list_in_repository_for_authenticated_user,get,,codespaces,codespaces,codespaces,list_in_repository_for_authenticated_user,select,,List codespaces in a repository for the authenticated user +codespaces.yaml,/repos/{owner}/{repo}/codespaces/new,codespaces/pre-flight-with-repo-for-authenticated-user,codespaces/pre_flight_with_repo_for_authenticated_user,get,,codespaces,codespaces,codespaces,pre_flight_with_repo_for_authenticated_user,exec,,Get default attributes for a codespace +codespaces.yaml,/user/codespaces/{codespace_name},codespaces/update-for-authenticated-user,codespaces/update_for_authenticated_user,patch,codespace,codespaces,codespaces,codespaces,update_for_authenticated_user,update,,Update a codespace for the authenticated user +codespaces.yaml,/user/codespaces,codespaces/create-for-authenticated-user,codespaces/create_for_authenticated_user,post,codespace,codespaces,codespaces,codespaces,create_for_authenticated_user,insert,,Create a codespace for the authenticated user +codespaces.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/codespaces,codespaces/create-with-pr-for-authenticated-user,codespaces/create_with_pr_for_authenticated_user,post,codespace,codespaces,codespaces,codespaces,create_with_pr_for_authenticated_user,insert,,Create a codespace from a pull request +codespaces.yaml,/repos/{owner}/{repo}/codespaces,codespaces/create-with-repo-for-authenticated-user,codespaces/create_with_repo_for_authenticated_user,post,codespace,codespaces,codespaces,codespaces,create_with_repo_for_authenticated_user,insert,,Create a codespace in a repository +codespaces.yaml,/user/codespaces/{codespace_name}/exports,codespaces/export-for-authenticated-user,codespaces/export_for_authenticated_user,post,codespace-export-details,codespaces,codespaces,codespaces,export_for_authenticated_user,exec,,Export a codespace for the authenticated user +codespaces.yaml,/user/codespaces/{codespace_name}/publish,codespaces/publish-for-authenticated-user,codespaces/publish_for_authenticated_user,post,codespace-with-full-repository,codespaces,codespaces,codespaces,publish_for_authenticated_user,exec,,Create a repository from an unpublished codespace +codespaces.yaml,/user/codespaces/{codespace_name}/start,codespaces/start-for-authenticated-user,codespaces/start_for_authenticated_user,post,codespace,codespaces,codespaces,codespaces,start_for_authenticated_user,exec,,Start a codespace for the authenticated user +codespaces.yaml,/user/codespaces/{codespace_name}/stop,codespaces/stop-for-authenticated-user,codespaces/stop_for_authenticated_user,post,codespace,codespaces,codespaces,codespaces,stop_for_authenticated_user,exec,,Stop a codespace for the authenticated user +codespaces.yaml,/repos/{owner}/{repo}/codespaces/permissions_check,codespaces/check-permissions-for-devcontainer,codespaces/check_permissions_for_devcontainer,get,,codespaces,codespaces,devcontainer_permissions,check_permissions_for_devcontainer,select,,Check if permissions defined by a devcontainer have been accepted by the authenticated user +codespaces.yaml,/repos/{owner}/{repo}/codespaces/devcontainers,codespaces/list-devcontainers-in-repository-for-authenticated-user,codespaces/list_devcontainers_in_repository_for_authenticated_user,get,,codespaces,codespaces,devcontainers,list_devcontainers_in_repository_for_authenticated_user,select,,List devcontainer configurations in a repository for the authenticated user +codespaces.yaml,/user/codespaces/{codespace_name}/machines,codespaces/codespace-machines-for-authenticated-user,codespaces/codespace_machines_for_authenticated_user,get,,codespaces,codespaces,machines,codespace_machines_for_authenticated_user,select,,List machine types for a codespace +codespaces.yaml,/repos/{owner}/{repo}/codespaces/machines,codespaces/repo-machines-for-authenticated-user,codespaces/repo_machines_for_authenticated_user,get,,codespaces,codespaces,machines,repo_machines_for_authenticated_user,select,,List available machine types for a repository +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id},codespaces/remove-selected-repo-from-org-secret,codespaces/remove_selected_repo_from_org_secret,delete,,codespaces,codespaces,org_secrets_repos,remove_selected_repo_from_org_secret,delete,,Remove selected repository from an organization secret +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name}/repositories,codespaces/list-selected-repos-for-org-secret,codespaces/list_selected_repos_for_org_secret,get,,codespaces,codespaces,org_secrets_repos,list_selected_repos_for_org_secret,select,,List selected repositories for an organization secret +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id},codespaces/add-selected-repo-to-org-secret,codespaces/add_selected_repo_to_org_secret,put,,codespaces,codespaces,org_secrets_repos,add_selected_repo_to_org_secret,insert,,Add selected repository to an organization secret +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name}/repositories,codespaces/set-selected-repos-for-org-secret,codespaces/set_selected_repos_for_org_secret,put,,codespaces,codespaces,org_secrets_repos,set_selected_repos_for_org_secret,replace,,Set selected repositories for an organization secret +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name},codespaces/delete-org-secret,codespaces/delete_org_secret,delete,,codespaces,codespaces,organization_secrets,delete_org_secret,delete,,Delete an organization secret +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name},codespaces/get-org-secret,codespaces/get_org_secret,get,codespaces-org-secret,codespaces,codespaces,organization_secrets,get_org_secret,select,,Get an organization secret +codespaces.yaml,/orgs/{org}/codespaces/secrets,codespaces/list-org-secrets,codespaces/list_org_secrets,get,,codespaces,codespaces,organization_secrets,list_org_secrets,select,,List organization secrets +codespaces.yaml,/orgs/{org}/codespaces/secrets/{secret_name},codespaces/create-or-update-org-secret,codespaces/create_or_update_org_secret,put,empty-object,codespaces,codespaces,organization_secrets,create_or_update_org_secret,insert,,Create or update an organization secret +codespaces.yaml,/orgs/{org}/codespaces/access/selected_users,codespaces/delete-codespaces-access-users,codespaces/delete_codespaces_access_users,delete,,codespaces,codespaces,organizations,delete_codespaces_access_users,delete,,Remove users from Codespaces access for an organization +codespaces.yaml,/orgs/{org}/members/{username}/codespaces/{codespace_name},codespaces/delete-from-organization,codespaces/delete_from_organization,delete,,codespaces,codespaces,organizations,delete_from_organization,delete,,Delete a codespace from the organization +codespaces.yaml,/orgs/{org}/members/{username}/codespaces,codespaces/get-codespaces-for-user-in-org,codespaces/get_codespaces_for_user_in_org,get,,codespaces,codespaces,organizations,get_codespaces_for_user_in_org,select,,List codespaces for a user in organization +codespaces.yaml,/orgs/{org}/codespaces,codespaces/list-in-organization,codespaces/list_in_organization,get,,codespaces,codespaces,organizations,list_in_organization,select,,List codespaces for the organization +codespaces.yaml,/orgs/{org}/codespaces/access/selected_users,codespaces/set-codespaces-access-users,codespaces/set_codespaces_access_users,post,,codespaces,codespaces,organizations,set_codespaces_access_users,exec,,Add users to Codespaces access for an organization +codespaces.yaml,/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop,codespaces/stop-in-organization,codespaces/stop_in_organization,post,codespace,codespaces,codespaces,organizations,stop_in_organization,exec,,Stop a codespace for an organization user +codespaces.yaml,/orgs/{org}/codespaces/access,codespaces/set-codespaces-access,codespaces/set_codespaces_access,put,,codespaces,codespaces,organizations,set_codespaces_access,replace,,Manage access control for organization codespaces +codespaces.yaml,/orgs/{org}/codespaces/secrets/public-key,codespaces/get-org-public-key,codespaces/get_org_public_key,get,codespaces-public-key,codespaces,codespaces,public_keys,get_org_public_key,select,,Get an organization public key +codespaces.yaml,/repos/{owner}/{repo}/codespaces/secrets/public-key,codespaces/get-repo-public-key,codespaces/get_repo_public_key,get,codespaces-public-key,codespaces,codespaces,public_keys,get_repo_public_key,select,,Get a repository public key +codespaces.yaml,/repos/{owner}/{repo}/codespaces/secrets/{secret_name},codespaces/delete-repo-secret,codespaces/delete_repo_secret,delete,,codespaces,codespaces,repository_secrets,delete_repo_secret,delete,,Delete a repository secret +codespaces.yaml,/repos/{owner}/{repo}/codespaces/secrets/{secret_name},codespaces/get-repo-secret,codespaces/get_repo_secret,get,repo-codespaces-secret,codespaces,codespaces,repository_secrets,get_repo_secret,select,,Get a repository secret +codespaces.yaml,/repos/{owner}/{repo}/codespaces/secrets,codespaces/list-repo-secrets,codespaces/list_repo_secrets,get,,codespaces,codespaces,repository_secrets,list_repo_secrets,select,,List repository secrets +codespaces.yaml,/repos/{owner}/{repo}/codespaces/secrets/{secret_name},codespaces/create-or-update-repo-secret,codespaces/create_or_update_repo_secret,put,empty-object,codespaces,codespaces,repository_secrets,create_or_update_repo_secret,insert,,Create or update a repository secret +codespaces.yaml,/user/codespaces/secrets/{secret_name},codespaces/delete-secret-for-authenticated-user,codespaces/delete_secret_for_authenticated_user,delete,,codespaces,codespaces,secrets,delete_secret_for_authenticated_user,delete,,Delete a secret for the authenticated user +codespaces.yaml,/user/codespaces/secrets/{secret_name},codespaces/get-secret-for-authenticated-user,codespaces/get_secret_for_authenticated_user,get,codespaces-secret,codespaces,codespaces,secrets,get_secret_for_authenticated_user,select,,Get a secret for the authenticated user +codespaces.yaml,/user/codespaces/secrets,codespaces/list-secrets-for-authenticated-user,codespaces/list_secrets_for_authenticated_user,get,,codespaces,codespaces,secrets,list_secrets_for_authenticated_user,select,,List secrets for the authenticated user +codespaces.yaml,/user/codespaces/secrets/{secret_name},codespaces/create-or-update-secret-for-authenticated-user,codespaces/create_or_update_secret_for_authenticated_user,put,empty-object,codespaces,codespaces,secrets,create_or_update_secret_for_authenticated_user,insert,,Create or update a secret for the authenticated user +codespaces.yaml,/user/codespaces/secrets/public-key,codespaces/get-public-key-for-authenticated-user,codespaces/get_public_key_for_authenticated_user,get,codespaces-user-public-key,codespaces,codespaces,user_public_keys,get_public_key_for_authenticated_user,select,,Get public key for the authenticated user +codespaces.yaml,/user/codespaces/secrets/{secret_name}/repositories/{repository_id},codespaces/remove-repository-for-secret-for-authenticated-user,codespaces/remove_repository_for_secret_for_authenticated_user,delete,,codespaces,codespaces,user_secrets,remove_repository_for_secret_for_authenticated_user,delete,,Remove a selected repository from a user secret +codespaces.yaml,/user/codespaces/secrets/{secret_name}/repositories,codespaces/list-repositories-for-secret-for-authenticated-user,codespaces/list_repositories_for_secret_for_authenticated_user,get,,codespaces,codespaces,user_secrets,list_repositories_for_secret_for_authenticated_user,select,,List selected repositories for a user secret +codespaces.yaml,/user/codespaces/secrets/{secret_name}/repositories/{repository_id},codespaces/add-repository-for-secret-for-authenticated-user,codespaces/add_repository_for_secret_for_authenticated_user,put,,codespaces,codespaces,user_secrets,add_repository_for_secret_for_authenticated_user,insert,,Add a selected repository to a user secret +codespaces.yaml,/user/codespaces/secrets/{secret_name}/repositories,codespaces/set-repositories-for-secret-for-authenticated-user,codespaces/set_repositories_for_secret_for_authenticated_user,put,,codespaces,codespaces,user_secrets,set_repositories_for_secret_for_authenticated_user,replace,,Set selected repositories for a user secret +copilot.yaml,/orgs/{org}/team/{team_slug}/copilot/metrics,copilot/copilot-metrics-for-team,copilot/copilot_metrics_for_team,get,,copilot,copilot,copilot_metrics,copilot_metrics_for_team,select,,Get Copilot metrics for a team +copilot.yaml,/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day,copilot/copilot-enterprise-one-day-usage-metrics,copilot/copilot_enterprise_one_day_usage_metrics,get,,copilot,copilot,copilot_one_day_usage_metrics,copilot_enterprise_one_day_usage_metrics,select,,Get Copilot enterprise usage metrics for a specific day +copilot.yaml,/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest,copilot/copilot-enterprise-usage-metrics,copilot/copilot_enterprise_usage_metrics,get,,copilot,copilot,copilot_usage_metrics,copilot_enterprise_usage_metrics,select,,Get Copilot enterprise usage metrics +copilot.yaml,/enterprises/{enterprise}/copilot/metrics/reports/users-1-day,copilot/copilot-users-one-day-usage-metrics,copilot/copilot_users_one_day_usage_metrics,get,,copilot,copilot,copilot_user_one_day_usage_metrics,copilot_users_one_day_usage_metrics,select,,Get Copilot users usage metrics for a specific day +copilot.yaml,/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest,copilot/copilot-users-usage-metrics,copilot/copilot_users_usage_metrics,get,,copilot,copilot,copilot_user_usage_metrics,copilot_users_usage_metrics,select,,Get Copilot users usage metrics +copilot.yaml,/orgs/{org}/copilot/coding-agent/permissions,copilot/get-copilot-coding-agent-permissions-organization,copilot/get_copilot_coding_agent_permissions_organization,get,,copilot,copilot,org_coding_agent_permissions,get_copilot_coding_agent_permissions_organization,select,,Get Copilot coding agent permissions for an organization +copilot.yaml,/orgs/{org}/copilot/coding-agent/permissions,copilot/set-copilot-coding-agent-permissions-organization,copilot/set_copilot_coding_agent_permissions_organization,put,,copilot,copilot,org_coding_agent_permissions,set_copilot_coding_agent_permissions_organization,replace,,Set Copilot coding agent permissions for an organization +copilot.yaml,/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id},copilot/disable-copilot-coding-agent-for-repository-in-organization,copilot/disable_copilot_coding_agent_for_repository_in_organization,delete,,copilot,copilot,org_coding_agent_repos,disable_copilot_coding_agent_for_repository_in_organization,delete,,Disable a repository for Copilot coding agent in an organization +copilot.yaml,/orgs/{org}/copilot/coding-agent/permissions/repositories,copilot/list-copilot-coding-agent-selected-repositories-for-organization,copilot/list_copilot_coding_agent_selected_repositories_for_organization,get,,copilot,copilot,org_coding_agent_repos,list_copilot_coding_agent_selected_repositories_for_organization,select,,List repositories enabled for Copilot coding agent in an organization +copilot.yaml,/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id},copilot/enable-copilot-coding-agent-for-repository-in-organization,copilot/enable_copilot_coding_agent_for_repository_in_organization,put,,copilot,copilot,org_coding_agent_repos,enable_copilot_coding_agent_for_repository_in_organization,replace,,Enable a repository for Copilot coding agent in an organization +copilot.yaml,/orgs/{org}/copilot/coding-agent/permissions/repositories,copilot/set-copilot-coding-agent-selected-repositories-for-organization,copilot/set_copilot_coding_agent_selected_repositories_for_organization,put,,copilot,copilot,org_coding_agent_repos,set_copilot_coding_agent_selected_repositories_for_organization,replace,,Set selected repositories for Copilot coding agent in an organization +copilot.yaml,/orgs/{org}/copilot/content_exclusion,copilot/copilot-content-exclusion-for-organization,copilot/copilot_content_exclusion_for_organization,get,,copilot,copilot,org_content_exclusion,copilot_content_exclusion_for_organization,exec,,Get Copilot content exclusion rules for an organization +copilot.yaml,/orgs/{org}/copilot/content_exclusion,copilot/set-copilot-content-exclusion-for-organization,copilot/set_copilot_content_exclusion_for_organization,put,,copilot,copilot,org_content_exclusion,set_copilot_content_exclusion_for_organization,replace,,Set Copilot content exclusion rules for an organization +copilot.yaml,/orgs/{org}/copilot/metrics,copilot/copilot-metrics-for-organization,copilot/copilot_metrics_for_organization,get,,copilot,copilot,org_copilot_metrics,copilot_metrics_for_organization,select,,Get Copilot metrics for an organization +copilot.yaml,/orgs/{org}/copilot/metrics/reports/organization-1-day,copilot/copilot-organization-one-day-usage-metrics,copilot/copilot_organization_one_day_usage_metrics,get,,copilot,copilot,org_copilot_one_day_usage_metrics,copilot_organization_one_day_usage_metrics,select,,Get Copilot organization usage metrics for a specific day +copilot.yaml,/orgs/{org}/copilot/billing/selected_teams,copilot/add-copilot-seats-for-teams,copilot/add_copilot_seats_for_teams,post,,copilot,copilot,org_copilot_seats_teams,add_copilot_seats_for_teams,insert,,Add teams to the Copilot subscription for an organization +copilot.yaml,/orgs/{org}/copilot/billing/selected_users,copilot/add-copilot-seats-for-users,copilot/add_copilot_seats_for_users,post,,copilot,copilot,org_copilot_seats_users,add_copilot_seats_for_users,insert,,Add users to the Copilot subscription for an organization +copilot.yaml,/orgs/{org}/copilot/metrics/reports/organization-28-day/latest,copilot/copilot-organization-usage-metrics,copilot/copilot_organization_usage_metrics,get,,copilot,copilot,org_copilot_usage_metrics,copilot_organization_usage_metrics,select,,Get Copilot organization usage metrics +copilot.yaml,/orgs/{org}/copilot/metrics/reports/users-1-day,copilot/copilot-organization-users-one-day-usage-metrics,copilot/copilot_organization_users_one_day_usage_metrics,get,,copilot,copilot,org_copilot_user_one_day_usage_metrics,copilot_organization_users_one_day_usage_metrics,select,,Get Copilot organization users usage metrics for a specific day +copilot.yaml,/orgs/{org}/copilot/metrics/reports/users-28-day/latest,copilot/copilot-organization-users-usage-metrics,copilot/copilot_organization_users_usage_metrics,get,,copilot,copilot,org_copilot_user_usage_metrics,copilot_organization_users_usage_metrics,select,,Get Copilot organization users usage metrics +copilot.yaml,/orgs/{org}/copilot/billing,copilot/get-copilot-organization-details,copilot/get_copilot_organization_details,get,copilot-organization-details,copilot,copilot,org_details,get_copilot_organization_details,select,,Get Copilot for Business seat information and settings for an organization +copilot.yaml,/orgs/{org}/members/{username}/copilot,copilot/get-copilot-seat-details-for-user,copilot/get_copilot_seat_details_for_user,get,,copilot,copilot,org_member_copilot_seats,get_copilot_seat_details_for_user,select,,Get Copilot seat assignment details for a user +copilot.yaml,/orgs/{org}/copilot/billing/selected_teams,copilot/cancel-copilot-seat-assignment-for-teams,copilot/cancel_copilot_seat_assignment_for_teams,delete,,copilot,copilot,org_seats,cancel_copilot_seat_assignment_for_teams,exec,,Remove teams from the Copilot for Business subscription for an organization +copilot.yaml,/orgs/{org}/copilot/billing/seats,copilot/list-copilot-seats,copilot/list_copilot_seats,get,,copilot,copilot,org_seats,list_copilot_seats,select,,List all Copilot for Business seat assignments for an organization +copilot.yaml,/orgs/{org}/copilot/billing/selected_teams,copilot/add-copilot-for-business-seats-for-teams,copilot/add_copilot_for_business_seats_for_teams,post,,copilot,copilot,org_seats,add_copilot_for_business_seats_for_teams,insert,,Add teams to the Copilot for Business subscription for an organization +copilot.yaml,/orgs/{org}/copilot/billing/selected_users,copilot/cancel-copilot-seat-assignment-for-users,copilot/cancel_copilot_seat_assignment_for_users,delete,,copilot,copilot,user_seats,cancel_copilot_seat_assignment_for_users,exec,,Remove users from the Copilot for Business subscription for an organization +copilot.yaml,/orgs/{org}/members/{username}/copilot,copilot/get-copilot-seat-assignment-details-for-user,copilot/get_copilot_seat_assignment_details_for_user,get,copilot-seat-details,copilot,copilot,user_seats,get_copilot_seat_assignment_details_for_user,select,,Get Copilot for Business seat assignment details for a user +copilot.yaml,/orgs/{org}/copilot/billing/selected_users,copilot/add-copilot-for-business-seats-for-users,copilot/add_copilot_for_business_seats_for_users,post,,copilot,copilot,user_seats,add_copilot_for_business_seats_for_users,insert,,Add users to the Copilot for Business subscription for an organization +copilot.yaml,/enterprises/{enterprise}/copilot/policies/coding_agent/organizations,copilot/remove-organizations-from-enterprise-coding-agent-policy,copilot/remove_organizations_from_enterprise_coding_agent_policy,delete,,copilot,copilot,,copilot/remove_organizations_from_enterprise_coding_agent_policy,delete,,Remove organizations from the enterprise coding agent policy +copilot.yaml,/enterprises/{enterprise}/copilot/policies/coding_agent/organizations,copilot/add-organizations-to-enterprise-coding-agent-policy,copilot/add_organizations_to_enterprise_coding_agent_policy,post,,copilot,copilot,,copilot/add_organizations_to_enterprise_coding_agent_policy,insert,,Add organizations to the enterprise coding agent policy +copilot.yaml,/enterprises/{enterprise}/copilot/policies/coding_agent,copilot/set-enterprise-coding-agent-policy,copilot/set_enterprise_coding_agent_policy,put,,copilot,copilot,,copilot/set_enterprise_coding_agent_policy,replace,,Set the coding agent policy for an enterprise +credentials.yaml,/credentials/revoke,credentials/revoke,credentials/revoke,post,,credentials,credentials,credentials,revoke,exec,,Revoke a list of credentials +dependabot.yaml,/repos/{owner}/{repo}/dependabot/alerts/{alert_number},dependabot/get-alert,dependabot/get_alert,get,dependabot-alert,dependabot,dependabot,alerts,get_alert,select,,Get a Dependabot alert +dependabot.yaml,/enterprises/{enterprise}/dependabot/alerts,dependabot/list-alerts-for-enterprise,dependabot/list_alerts_for_enterprise,get,dependabot-alert-with-repository,dependabot,dependabot,alerts,list_alerts_for_enterprise,select,,List Dependabot alerts for an enterprise +dependabot.yaml,/orgs/{org}/dependabot/alerts,dependabot/list-alerts-for-org,dependabot/list_alerts_for_org,get,dependabot-alert-with-repository,dependabot,dependabot,alerts,list_alerts_for_org,select,,List Dependabot alerts for an organization +dependabot.yaml,/repos/{owner}/{repo}/dependabot/alerts,dependabot/list-alerts-for-repo,dependabot/list_alerts_for_repo,get,dependabot-alert,dependabot,dependabot,alerts,list_alerts_for_repo,select,,List Dependabot alerts for a repository +dependabot.yaml,/repos/{owner}/{repo}/dependabot/alerts/{alert_number},dependabot/update-alert,dependabot/update_alert,patch,dependabot-alert,dependabot,dependabot,alerts,update_alert,update,,Update a Dependabot alert +dependabot.yaml,/organizations/{org}/dependabot/repository-access,dependabot/repository-access-for-org,dependabot/repository_access_for_org,get,,dependabot,dependabot,org_dependabot_repository_access,repository_access_for_org,select,,Lists the repositories Dependabot can access in an organization +dependabot.yaml,/organizations/{org}/dependabot/repository-access,dependabot/update-repository-access-for-org,dependabot/update_repository_access_for_org,patch,,dependabot,dependabot,org_dependabot_repository_access,update_repository_access_for_org,update,,Updates Dependabot's repository access list for an organization +dependabot.yaml,/organizations/{org}/dependabot/repository-access/default-level,dependabot/set-repository-access-default-level,dependabot/set_repository_access_default_level,put,,dependabot,dependabot,org_dependabot_repository_access,set_repository_access_default_level,replace,,Set the default repository access level for Dependabot +dependabot.yaml,/orgs/{org}/dependabot/secrets/public-key,dependabot/get-org-public-key,dependabot/get_org_public_key,get,dependabot-public-key,dependabot,dependabot,public_keys,get_org_public_key,select,,Get an organization public key +dependabot.yaml,/repos/{owner}/{repo}/dependabot/secrets/public-key,dependabot/get-repo-public-key,dependabot/get_repo_public_key,get,dependabot-public-key,dependabot,dependabot,public_keys,get_repo_public_key,select,,Get a repository public key +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id},dependabot/remove-selected-repo-from-org-secret,dependabot/remove_selected_repo_from_org_secret,delete,,dependabot,dependabot,repos_for_secret,remove_selected_repo_from_org_secret,delete,,Remove selected repository from an organization secret +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name}/repositories,dependabot/list-selected-repos-for-org-secret,dependabot/list_selected_repos_for_org_secret,get,,dependabot,dependabot,repos_for_secret,list_selected_repos_for_org_secret,select,,List selected repositories for an organization secret +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id},dependabot/add-selected-repo-to-org-secret,dependabot/add_selected_repo_to_org_secret,put,,dependabot,dependabot,repos_for_secret,add_selected_repo_to_org_secret,insert,,Add selected repository to an organization secret +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name}/repositories,dependabot/set-selected-repos-for-org-secret,dependabot/set_selected_repos_for_org_secret,put,,dependabot,dependabot,repos_for_secret,set_selected_repos_for_org_secret,replace,,Set selected repositories for an organization secret +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name},dependabot/delete-org-secret,dependabot/delete_org_secret,delete,,dependabot,dependabot,secrets,delete_org_secret,delete,,Delete an organization secret +dependabot.yaml,/repos/{owner}/{repo}/dependabot/secrets/{secret_name},dependabot/delete-repo-secret,dependabot/delete_repo_secret,delete,,dependabot,dependabot,secrets,delete_repo_secret,delete,,Delete a repository secret +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name},dependabot/get-org-secret,dependabot/get_org_secret,get,organization-dependabot-secret,dependabot,dependabot,secrets,get_org_secret,select,,Get an organization secret +dependabot.yaml,/repos/{owner}/{repo}/dependabot/secrets/{secret_name},dependabot/get-repo-secret,dependabot/get_repo_secret,get,dependabot-secret,dependabot,dependabot,secrets,get_repo_secret,select,,Get a repository secret +dependabot.yaml,/orgs/{org}/dependabot/secrets,dependabot/list-org-secrets,dependabot/list_org_secrets,get,,dependabot,dependabot,secrets,list_org_secrets,select,,List organization secrets +dependabot.yaml,/repos/{owner}/{repo}/dependabot/secrets,dependabot/list-repo-secrets,dependabot/list_repo_secrets,get,,dependabot,dependabot,secrets,list_repo_secrets,select,,List repository secrets +dependabot.yaml,/orgs/{org}/dependabot/secrets/{secret_name},dependabot/create-or-update-org-secret,dependabot/create_or_update_org_secret,put,empty-object,dependabot,dependabot,secrets,create_or_update_org_secret,insert,,Create or update an organization secret +dependabot.yaml,/repos/{owner}/{repo}/dependabot/secrets/{secret_name},dependabot/create-or-update-repo-secret,dependabot/create_or_update_repo_secret,put,empty-object,dependabot,dependabot,secrets,create_or_update_repo_secret,insert,,Create or update a repository secret +dependency_graph.yaml,/repos/{owner}/{repo}/dependency-graph/compare/{basehead},dependency-graph/diff-range,dependency_graph/diff_range,get,dependency-graph-diff,dependency-graph,dependency_graph,dependency_review,diff_range,select,,Get a diff of the dependencies between commits +dependency_graph.yaml,/repos/{owner}/{repo}/dependency-graph/snapshots,dependency-graph/create-repository-snapshot,dependency_graph/create_repository_snapshot,post,,dependency-graph,dependency_graph,dependency_submission,create_repository_snapshot,insert,,Create a snapshot of dependencies for a repository +dependency_graph.yaml,/repos/{owner}/{repo}/dependency-graph/sbom,dependency-graph/export-sbom,dependency_graph/export_sbom,get,dependency-graph-spdx-sbom,dependency-graph,dependency_graph,sboms,export_sbom,select,$.sbom,Export a software bill of materials (SBOM) for a repository. +dependency_graph.yaml,/repos/{owner}/{repo}/dependency-graph/sbom/fetch-report/{sbom_uuid},dependency-graph/fetch-sbom-report,dependency_graph/fetch_sbom_report,get,,dependency-graph,dependency_graph,,dependency_graph/fetch_sbom_report,select,,Fetch a software bill of materials (SBOM) for a repository. +dependency_graph.yaml,/repos/{owner}/{repo}/dependency-graph/sbom/generate-report,dependency-graph/generate-sbom-report,dependency_graph/generate_sbom_report,get,,dependency-graph,dependency_graph,,dependency_graph/generate_sbom_report,select,,Request generation of a software bill of materials (SBOM) for a repository. +emojis.yaml,/emojis,emojis/get,emojis/get,get,,emojis,emojis,emojis,get_emojis,exec,,Get emojis +enterprise_team_memberships.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/memberships/add,enterprise-team-memberships/bulk-add,enterprise_team_memberships/bulk_add,post,,enterprise-team-memberships,enterprise_team_memberships,enterprise_team_membership_bulk_additions,bulk_add,insert,,Bulk add team members +enterprise_team_memberships.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/memberships/remove,enterprise-team-memberships/bulk-remove,enterprise_team_memberships/bulk_remove,post,,enterprise-team-memberships,enterprise_team_memberships,enterprise_team_membership_bulk_removals,bulk_remove,insert,,Bulk remove team members +enterprise_team_memberships.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/memberships/{username},enterprise-team-memberships/remove,enterprise_team_memberships/remove,delete,,enterprise-team-memberships,enterprise_team_memberships,enterprise_team_memberships,remove,delete,,Remove team membership +enterprise_team_memberships.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/memberships/{username},enterprise-team-memberships/get,enterprise_team_memberships/get,get,,enterprise-team-memberships,enterprise_team_memberships,enterprise_team_memberships,get,select,,Get enterprise team membership +enterprise_team_memberships.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/memberships,enterprise-team-memberships/list,enterprise_team_memberships/list,get,,enterprise-team-memberships,enterprise_team_memberships,enterprise_team_memberships,list,select,,List members in an enterprise team +enterprise_team_memberships.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/memberships/{username},enterprise-team-memberships/add,enterprise_team_memberships/add,put,,enterprise-team-memberships,enterprise_team_memberships,enterprise_team_memberships,add,replace,,Add team member +enterprise_team_organizations.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/organizations/add,enterprise-team-organizations/bulk-add,enterprise_team_organizations/bulk_add,post,,enterprise-team-organizations,enterprise_team_organizations,enterprise_team_organization_bulk_additions,bulk_add,insert,,Add organization assignments +enterprise_team_organizations.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/organizations/remove,enterprise-team-organizations/bulk-remove,enterprise_team_organizations/bulk_remove,post,,enterprise-team-organizations,enterprise_team_organizations,enterprise_team_organization_bulk_removals,bulk_remove,insert,,Remove organization assignments +enterprise_team_organizations.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/organizations/{org},enterprise-team-organizations/delete,enterprise_team_organizations/delete,delete,,enterprise-team-organizations,enterprise_team_organizations,enterprise_team_organizations,delete,delete,,Delete an organization assignment +enterprise_team_organizations.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/organizations/{org},enterprise-team-organizations/get-assignment,enterprise_team_organizations/get_assignment,get,,enterprise-team-organizations,enterprise_team_organizations,enterprise_team_organizations,get_assignment,select,,Get organization assignment +enterprise_team_organizations.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/organizations,enterprise-team-organizations/get-assignments,enterprise_team_organizations/get_assignments,get,,enterprise-team-organizations,enterprise_team_organizations,enterprise_team_organizations,get_assignments,select,,Get organization assignments +enterprise_team_organizations.yaml,/enterprises/{enterprise}/teams/{enterprise_team}/organizations/{org},enterprise-team-organizations/add,enterprise_team_organizations/add,put,,enterprise-team-organizations,enterprise_team_organizations,enterprise_team_organizations,add,replace,,Add an organization assignment +enterprise_teams.yaml,/enterprises/{enterprise}/teams/{team_slug},enterprise-teams/delete,enterprise_teams/delete,delete,,enterprise-teams,enterprise_teams,enterprise_teams,delete,delete,,Delete an enterprise team +enterprise_teams.yaml,/enterprises/{enterprise}/teams/{team_slug},enterprise-teams/get,enterprise_teams/get,get,,enterprise-teams,enterprise_teams,enterprise_teams,get,select,,Get an enterprise team +enterprise_teams.yaml,/enterprises/{enterprise}/teams,enterprise-teams/list,enterprise_teams/list,get,,enterprise-teams,enterprise_teams,enterprise_teams,list,select,,List enterprise teams +enterprise_teams.yaml,/enterprises/{enterprise}/teams/{team_slug},enterprise-teams/update,enterprise_teams/update,patch,,enterprise-teams,enterprise_teams,enterprise_teams,update,update,,Update an enterprise team +enterprise_teams.yaml,/enterprises/{enterprise}/teams,enterprise-teams/create,enterprise_teams/create,post,,enterprise-teams,enterprise_teams,enterprise_teams,create,insert,,Create an enterprise team +gists.yaml,/gists/{gist_id}/comments/{comment_id},gists/delete-comment,gists/delete_comment,delete,,gists,gists,comments,delete_comment,delete,,Delete a gist comment +gists.yaml,/gists/{gist_id}/comments/{comment_id},gists/get-comment,gists/get_comment,get,gist-comment,gists,gists,comments,get_comment,select,,Get a gist comment +gists.yaml,/gists/{gist_id}/comments,gists/list-comments,gists/list_comments,get,gist-comment,gists,gists,comments,list_comments,select,,List gist comments +gists.yaml,/gists/{gist_id}/comments/{comment_id},gists/update-comment,gists/update_comment,patch,gist-comment,gists,gists,comments,update_comment,update,,Update a gist comment +gists.yaml,/gists/{gist_id}/comments,gists/create-comment,gists/create_comment,post,gist-comment,gists,gists,comments,create_comment,insert,,Create a gist comment +gists.yaml,/gists/{gist_id}/commits,gists/list-commits,gists/list_commits,get,gist-commit,gists,gists,commits,list_commits,select,,List gist commits +gists.yaml,/gists/{gist_id}/forks,gists/list-forks,gists/list_forks,get,gist-simple,gists,gists,forks,list_forks,select,,List gist forks +gists.yaml,/gists/{gist_id},gists/delete,gists/delete,delete,,gists,gists,gists,delete,delete,,Delete a gist +gists.yaml,/gists/{gist_id}/star,gists/unstar,gists/unstar,delete,,gists,gists,gists,unstar,exec,,Unstar a gist +gists.yaml,/gists/{gist_id}/star,gists/check-is-starred,gists/check_is_starred,get,,gists,gists,gists,check_is_starred,exec,,Check if a gist is starred +gists.yaml,/gists/{gist_id},gists/get,gists/get,get,gist-simple,gists,gists,gists,get,select,,Get a gist +gists.yaml,/gists,gists/list,gists/list,get,base-gist,gists,gists,gists,list,select,,List gists for the authenticated user +gists.yaml,/users/{username}/gists,gists/list-for-user,gists/list_for_user,get,base-gist,gists,gists,gists,list_for_user,select,,List gists for a user +gists.yaml,/gists/{gist_id},gists/update,gists/update,patch,gist-simple,gists,gists,gists,update,update,,Update a gist +gists.yaml,/gists,gists/create,gists/create,post,gist-simple,gists,gists,gists,create,insert,,Create a gist +gists.yaml,/gists/{gist_id}/forks,gists/fork,gists/fork,post,base-gist,gists,gists,gists,fork,insert,,Fork a gist +gists.yaml,/gists/{gist_id}/star,gists/star,gists/star,put,,gists,gists,gists,star,exec,,Star a gist +gists.yaml,/gists/public,gists/list-public,gists/list_public,get,base-gist,gists,gists,public_gists,list_public,select,,List public gists +gists.yaml,/gists/{gist_id}/{sha},gists/get-revision,gists/get_revision,get,gist-simple,gists,gists,revisions,get_revision,select,,Get a gist revision +gists.yaml,/gists/starred,gists/list-starred,gists/list_starred,get,base-gist,gists,gists,starred_gists,list_starred,select,,List starred gists +git.yaml,/repos/{owner}/{repo}/git/blobs/{file_sha},git/get-blob,git/get_blob,get,blob,git,git,blobs,get_blob,select,,Get a blob +git.yaml,/repos/{owner}/{repo}/git/blobs,git/create-blob,git/create_blob,post,short-blob,git,git,blobs,create_blob,insert,,Create a blob +git.yaml,/repos/{owner}/{repo}/git/commits/{commit_sha},git/get-commit,git/get_commit,get,git-commit,git,git,commits,get_commit,select,,Get a commit object +git.yaml,/repos/{owner}/{repo}/git/commits,git/create-commit,git/create_commit,post,git-commit,git,git,commits,create_commit,insert,,Create a commit +git.yaml,/repos/{owner}/{repo}/git/ref/{ref},git/get-ref,git/get_ref,get,git-ref,git,git,ref,get_ref,select,,Get a reference +git.yaml,/repos/{owner}/{repo}/git/refs/{ref},git/delete-ref,git/delete_ref,delete,,git,git,refs,delete_ref,delete,,Delete a reference +git.yaml,/repos/{owner}/{repo}/git/matching-refs/{ref},git/list-matching-refs,git/list_matching_refs,get,git-ref,git,git,refs,list_matching_refs,select,,List matching references +git.yaml,/repos/{owner}/{repo}/git/refs/{ref},git/update-ref,git/update_ref,patch,git-ref,git,git,refs,update_ref,update,,Update a reference +git.yaml,/repos/{owner}/{repo}/git/refs,git/create-ref,git/create_ref,post,git-ref,git,git,refs,create_ref,insert,,Create a reference +git.yaml,/repos/{owner}/{repo}/git/tags/{tag_sha},git/get-tag,git/get_tag,get,git-tag,git,git,tags,get_tag,select,,Get a tag +git.yaml,/repos/{owner}/{repo}/git/tags,git/create-tag,git/create_tag,post,git-tag,git,git,tags,create_tag,insert,,Create a tag object +git.yaml,/repos/{owner}/{repo}/git/trees/{tree_sha},git/get-tree,git/get_tree,get,git-tree,git,git,trees,get_tree,select,,Get a tree +git.yaml,/repos/{owner}/{repo}/git/trees,git/create-tree,git/create_tree,post,git-tree,git,git,trees,create_tree,insert,,Create a tree +gitignore.yaml,/gitignore/templates,gitignore/get-all-templates,gitignore/get_all_templates,get,,gitignore,gitignore,gitignore,get_all_templates,select,,Get all gitignore templates +gitignore.yaml,/gitignore/templates/{name},gitignore/get-template,gitignore/get_template,get,gitignore-template,gitignore,gitignore,gitignore,get_template,select,,Get a gitignore template +hosted_compute.yaml,/orgs/{org}/settings/network-configurations/{network_configuration_id},hosted-compute/delete-network-configuration-from-org,hosted_compute/delete_network_configuration_from_org,delete,,hosted-compute,hosted_compute,org_network_configurations,delete_network_configuration_from_org,delete,,Delete a hosted compute network configuration from an organization +hosted_compute.yaml,/orgs/{org}/settings/network-configurations/{network_configuration_id},hosted-compute/get-network-configuration-for-org,hosted_compute/get_network_configuration_for_org,get,,hosted-compute,hosted_compute,org_network_configurations,get_network_configuration_for_org,select,,Get a hosted compute network configuration for an organization +hosted_compute.yaml,/orgs/{org}/settings/network-configurations,hosted-compute/list-network-configurations-for-org,hosted_compute/list_network_configurations_for_org,get,,hosted-compute,hosted_compute,org_network_configurations,list_network_configurations_for_org,select,,List hosted compute network configurations for an organization +hosted_compute.yaml,/orgs/{org}/settings/network-configurations/{network_configuration_id},hosted-compute/update-network-configuration-for-org,hosted_compute/update_network_configuration_for_org,patch,,hosted-compute,hosted_compute,org_network_configurations,update_network_configuration_for_org,update,,Update a hosted compute network configuration for an organization +hosted_compute.yaml,/orgs/{org}/settings/network-configurations,hosted-compute/create-network-configuration-for-org,hosted_compute/create_network_configuration_for_org,post,,hosted-compute,hosted_compute,org_network_configurations,create_network_configuration_for_org,insert,,Create a hosted compute network configuration for an organization +hosted_compute.yaml,/orgs/{org}/settings/network-settings/{network_settings_id},hosted-compute/get-network-settings-for-org,hosted_compute/get_network_settings_for_org,get,,hosted-compute,hosted_compute,org_network_settings,get_network_settings_for_org,select,,Get a hosted compute network settings resource for an organization +interactions.yaml,/orgs/{org}/interaction-limits,interactions/remove-restrictions-for-org,interactions/remove_restrictions_for_org,delete,,interactions,interactions,orgs,remove_restrictions_for_org,delete,,Remove interaction restrictions for an organization +interactions.yaml,/orgs/{org}/interaction-limits,interactions/get-restrictions-for-org,interactions/get_restrictions_for_org,get,interaction-limit-response,interactions,interactions,orgs,get_restrictions_for_org,select,,Get interaction restrictions for an organization +interactions.yaml,/orgs/{org}/interaction-limits,interactions/set-restrictions-for-org,interactions/set_restrictions_for_org,put,interaction-limit-response,interactions,interactions,orgs,set_restrictions_for_org,replace,,Set interaction restrictions for an organization +interactions.yaml,/repos/{owner}/{repo}/interaction-limits,interactions/remove-restrictions-for-repo,interactions/remove_restrictions_for_repo,delete,,interactions,interactions,repos,remove_restrictions_for_repo,delete,,Remove interaction restrictions for a repository +interactions.yaml,/repos/{owner}/{repo}/interaction-limits,interactions/get-restrictions-for-repo,interactions/get_restrictions_for_repo,get,interaction-limit-response,interactions,interactions,repos,get_restrictions_for_repo,select,,Get interaction restrictions for a repository +interactions.yaml,/repos/{owner}/{repo}/interaction-limits,interactions/set-restrictions-for-repo,interactions/set_restrictions_for_repo,put,interaction-limit-response,interactions,interactions,repos,set_restrictions_for_repo,replace,,Set interaction restrictions for a repository +interactions.yaml,/user/interaction-limits,interactions/remove-restrictions-for-authenticated-user,interactions/remove_restrictions_for_authenticated_user,delete,,interactions,interactions,user,remove_restrictions_for_authenticated_user,delete,,Remove interaction restrictions from your public repositories +interactions.yaml,/user/interaction-limits,interactions/get-restrictions-for-authenticated-user,interactions/get_restrictions_for_authenticated_user,get,interaction-limit-response,interactions,interactions,user,get_restrictions_for_authenticated_user,select,,Get interaction restrictions for your public repositories +interactions.yaml,/user/interaction-limits,interactions/set-restrictions-for-authenticated-user,interactions/set_restrictions_for_authenticated_user,put,interaction-limit-response,interactions,interactions,user,set_restrictions_for_authenticated_user,replace,,Set interaction restrictions for your public repositories +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/assignees,issues/remove-assignees,issues/remove_assignees,delete,issue,issues,issues,assignees,remove_assignees,delete,,Remove assignees from an issue +issues.yaml,/repos/{owner}/{repo}/assignees/{assignee},issues/check-user-can-be-assigned,issues/check_user_can_be_assigned,get,,issues,issues,assignees,check_user_can_be_assigned,exec,,Check if a user can be assigned +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee},issues/check-user-can-be-assigned-to-issue,issues/check_user_can_be_assigned_to_issue,get,,issues,issues,assignees,check_user_can_be_assigned_to_issue,exec,,Check if a user can be assigned to a issue +issues.yaml,/repos/{owner}/{repo}/assignees,issues/list-assignees,issues/list_assignees,get,simple-user,issues,issues,assignees,list_assignees,select,,List assignees +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/assignees,issues/add-assignees,issues/add_assignees,post,issue,issues,issues,assignees,add_assignees,insert,,Add assignees to an issue +issues.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id},issues/delete-comment,issues/delete_comment,delete,,issues,issues,comments,delete_comment,delete,,Delete an issue comment +issues.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id},issues/get-comment,issues/get_comment,get,issue-comment,issues,issues,comments,get_comment,select,,Get an issue comment +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/comments,issues/list-comments,issues/list_comments,get,issue-comment,issues,issues,comments,list_comments,select,,List issue comments +issues.yaml,/repos/{owner}/{repo}/issues/comments,issues/list-comments-for-repo,issues/list_comments_for_repo,get,issue-comment,issues,issues,comments,list_comments_for_repo,select,,List issue comments for a repository +issues.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id},issues/update-comment,issues/update_comment,patch,issue-comment,issues,issues,comments,update_comment,update,,Update an issue comment +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/comments,issues/create-comment,issues/create_comment,post,issue-comment,issues,issues,comments,create_comment,insert,,Create an issue comment +issues.yaml,/repos/{owner}/{repo}/issues/events/{event_id},issues/get-event,issues/get_event,get,issue-event,issues,issues,events,get_event,select,,Get an issue event +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/events,issues/list-events,issues/list_events,get,issue-event-for-issue,issues,issues,events,list_events,select,,List issue events +issues.yaml,/repos/{owner}/{repo}/issues/events,issues/list-events-for-repo,issues/list_events_for_repo,get,issue-event,issues,issues,events,list_events_for_repo,select,,List issue events for a repository +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id},issues/remove-dependency-blocked-by,issues/remove_dependency_blocked_by,delete,,issues,issues,issue_blocked_by_dependencies,remove_dependency_blocked_by,delete,,Remove dependency an issue is blocked by +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by,issues/list-dependencies-blocked-by,issues/list_dependencies_blocked_by,get,,issues,issues,issue_blocked_by_dependencies,list_dependencies_blocked_by,select,,List dependencies an issue is blocked by +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by,issues/add-blocked-by-dependency,issues/add_blocked_by_dependency,post,,issues,issues,issue_blocked_by_dependencies,add_blocked_by_dependency,insert,,Add a dependency an issue is blocked by +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking,issues/list-dependencies-blocking,issues/list_dependencies_blocking,get,,issues,issues,issue_blocking_dependencies,list_dependencies_blocking,select,,List dependencies an issue is blocking +issues.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id}/pin,issues/unpin-comment,issues/unpin_comment,delete,,issues,issues,issue_comment_pins,unpin_comment,delete,,Unpin an issue comment +issues.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id}/pin,issues/pin-comment,issues/pin_comment,put,,issues,issues,issue_comment_pins,pin_comment,replace,,Pin an issue comment +issues.yaml,/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id},issues/delete-issue-field-value,issues/delete_issue_field_value,delete,,issues,issues,issue_field_values,delete_issue_field_value,delete,,Delete an issue field value from an issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values,issues/list-issue-field-values-for-issue,issues/list_issue_field_values_for_issue,get,,issues,issues,issue_field_values,list_issue_field_values_for_issue,select,,List issue field values for an issue +issues.yaml,/repositories/{repository_id}/issues/{issue_number}/issue-field-values,issues/add-issue-field-values,issues/add_issue_field_values,post,,issues,issues,issue_field_values,add_issue_field_values,insert,,Add issue field values to an issue +issues.yaml,/repositories/{repository_id}/issues/{issue_number}/issue-field-values,issues/set-issue-field-values,issues/set_issue_field_values,put,,issues,issues,issue_field_values,set_issue_field_values,replace,,Set issue field values for an issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/parent,issues/get-parent,issues/get_parent,get,,issues,issues,issue_parent,get_parent,select,,Get parent issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/sub_issue,issues/remove-sub-issue,issues/remove_sub_issue,delete,,issues,issues,issue_sub_issues,remove_sub_issue,delete,,Remove sub-issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/sub_issues,issues/list-sub-issues,issues/list_sub_issues,get,,issues,issues,issue_sub_issues,list_sub_issues,select,,List sub-issues +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority,issues/reprioritize-sub-issue,issues/reprioritize_sub_issue,patch,,issues,issues,issue_sub_issues,reprioritize_sub_issue,update,,Reprioritize sub-issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/sub_issues,issues/add-sub-issue,issues/add_sub_issue,post,,issues,issues,issue_sub_issues,add_sub_issue,insert,,Add sub-issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/lock,issues/unlock,issues/unlock,delete,,issues,issues,issues,unlock,exec,,Unlock an issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number},issues/get,issues/get,get,issue,issues,issues,issues,get,select,,Get an issue +issues.yaml,/issues,issues/list,issues/list,get,issue,issues,issues,issues,list,select,,List issues assigned to the authenticated user +issues.yaml,/orgs/{org}/issues,issues/list-for-org,issues/list_for_org,get,issue,issues,issues,issues,list_for_org,select,,List organization issues assigned to the authenticated user +issues.yaml,/repos/{owner}/{repo}/issues,issues/list-for-repo,issues/list_for_repo,get,issue,issues,issues,issues,list_for_repo,select,,List repository issues +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number},issues/update,issues/update,patch,issue,issues,issues,issues,update,update,,Update an issue +issues.yaml,/repos/{owner}/{repo}/issues,issues/create,issues/create,post,issue,issues,issues,issues,create,insert,,Create an issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/lock,issues/lock,issues/lock,put,,issues,issues,issues,lock,exec,,Lock an issue +issues.yaml,/repos/{owner}/{repo}/labels/{name},issues/delete-label,issues/delete_label,delete,,issues,issues,labels,delete_label,delete,,Delete a label +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/labels,issues/remove-all-labels,issues/remove_all_labels,delete,,issues,issues,labels,remove_all_labels,delete,,Remove all labels from an issue +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/labels/{name},issues/remove-label,issues/remove_label,delete,label,issues,issues,labels,remove_label,delete,,Remove a label from an issue +issues.yaml,/repos/{owner}/{repo}/labels/{name},issues/get-label,issues/get_label,get,label,issues,issues,labels,get_label,select,,Get a label +issues.yaml,/repos/{owner}/{repo}/milestones/{milestone_number}/labels,issues/list-labels-for-milestone,issues/list_labels_for_milestone,get,label,issues,issues,labels,list_labels_for_milestone,select,,List labels for issues in a milestone +issues.yaml,/repos/{owner}/{repo}/labels,issues/list-labels-for-repo,issues/list_labels_for_repo,get,label,issues,issues,labels,list_labels_for_repo,select,,List labels for a repository +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/labels,issues/list-labels-on-issue,issues/list_labels_on_issue,get,label,issues,issues,labels,list_labels_on_issue,select,,List labels for an issue +issues.yaml,/repos/{owner}/{repo}/labels/{name},issues/update-label,issues/update_label,patch,label,issues,issues,labels,update_label,update,,Update a label +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/labels,issues/add-labels,issues/add_labels,post,label,issues,issues,labels,add_labels,insert,,Add labels to an issue +issues.yaml,/repos/{owner}/{repo}/labels,issues/create-label,issues/create_label,post,label,issues,issues,labels,create_label,insert,,Create a label +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/labels,issues/set-labels,issues/set_labels,put,label,issues,issues,labels,set_labels,replace,,Set labels for an issue +issues.yaml,/repos/{owner}/{repo}/milestones/{milestone_number},issues/delete-milestone,issues/delete_milestone,delete,,issues,issues,milestones,delete_milestone,delete,,Delete a milestone +issues.yaml,/repos/{owner}/{repo}/milestones/{milestone_number},issues/get-milestone,issues/get_milestone,get,milestone,issues,issues,milestones,get_milestone,select,,Get a milestone +issues.yaml,/repos/{owner}/{repo}/milestones,issues/list-milestones,issues/list_milestones,get,milestone,issues,issues,milestones,list_milestones,select,,List milestones +issues.yaml,/repos/{owner}/{repo}/milestones/{milestone_number},issues/update-milestone,issues/update_milestone,patch,milestone,issues,issues,milestones,update_milestone,update,,Update a milestone +issues.yaml,/repos/{owner}/{repo}/milestones,issues/create-milestone,issues/create_milestone,post,milestone,issues,issues,milestones,create_milestone,insert,,Create a milestone +issues.yaml,/repos/{owner}/{repo}/issues/{issue_number}/timeline,issues/list-events-for-timeline,issues/list_events_for_timeline,get,timeline-issue-events,issues,issues,timeline,list_events_for_timeline,select,,List timeline events for an issue +issues.yaml,/user/issues,issues/list-for-authenticated-user,issues/list_for_authenticated_user,get,issue,issues,issues,user_issues,list_for_authenticated_user,select,,List user account issues assigned to the authenticated user +licenses.yaml,/licenses/{license},licenses/get,licenses/get,get,license,licenses,licenses,licenses,get,select,,Get a license +licenses.yaml,/licenses,licenses/get-all-commonly-used,licenses/get_all_commonly_used,get,license-simple,licenses,licenses,licenses,get_all_commonly_used,select,,Get all commonly used licenses +licenses.yaml,/repos/{owner}/{repo}/license,licenses/get-for-repo,licenses/get_for_repo,get,license-content,licenses,licenses,licenses,get_for_repo,select,,Get the license for a repository +markdown.yaml,/markdown,markdown/render,markdown/render,post,,markdown,markdown,rendered_markdown,render,insert,,Render a Markdown document +markdown.yaml,/markdown/raw,markdown/render-raw,markdown/render_raw,post,,markdown,markdown,rendered_markdown_raw,render_raw,insert,,Render a Markdown document in raw mode +meta.yaml,/meta,meta/get,meta/get,get,,meta,meta,meta,get,select,,Get GitHub meta information +meta.yaml,/octocat,meta/get-octocat,meta/get_octocat,get,,meta,meta,octocat,get_octocat,exec,,Get Octocat +meta.yaml,/,meta/root,meta/root,get,,meta,meta,root,root,select,,GitHub API Root +meta.yaml,/versions,meta/get-all-versions,meta/get_all_versions,get,,meta,meta,versions,get_all_versions,select,,Get all API versions +meta.yaml,/zen,meta/get-zen,meta/get_zen,get,,meta,meta,zen,get_zen,exec,,Get the Zen of GitHub +migrations.yaml,/repos/{owner}/{repo}/import/authors,migrations/get-commit-authors,migrations/get_commit_authors,get,porter-author,migrations,migrations,commit_authors,get_commit_authors,select,,Get commit authors +migrations.yaml,/repos/{owner}/{repo}/import/authors/{author_id},migrations/map-commit-author,migrations/map_commit_author,patch,porter-author,migrations,migrations,commit_authors,map_commit_author,update,,Map a commit author +migrations.yaml,/repos/{owner}/{repo}/import/large_files,migrations/get-large-files,migrations/get_large_files,get,porter-large-file,migrations,migrations,lfs,get_large_files,select,,Get large files +migrations.yaml,/repos/{owner}/{repo}/import/lfs,migrations/set-lfs-preference,migrations/set_lfs_preference,patch,import,migrations,migrations,lfs,set_lfs_preference,update,,Update Git LFS preference +migrations.yaml,/user/migrations/{migration_id},migrations/get-status-for-authenticated-user,migrations/get_status_for_authenticated_user,get,migration,migrations,migrations,migrations,get_status_for_authenticated_user,select,,Get a user migration status +migrations.yaml,/orgs/{org}/migrations/{migration_id},migrations/get-status-for-org,migrations/get_status_for_org,get,migration,migrations,migrations,migrations,get_status_for_org,select,,Get an organization migration status +migrations.yaml,/user/migrations,migrations/list-for-authenticated-user,migrations/list_for_authenticated_user,get,migration,migrations,migrations,migrations,list_for_authenticated_user,select,,List user migrations +migrations.yaml,/orgs/{org}/migrations,migrations/list-for-org,migrations/list_for_org,get,migration,migrations,migrations,migrations,list_for_org,select,,List organization migrations +migrations.yaml,/user/migrations,migrations/start-for-authenticated-user,migrations/start_for_authenticated_user,post,migration,migrations,migrations,migrations,start_for_authenticated_user,exec,,Start a user migration +migrations.yaml,/orgs/{org}/migrations,migrations/start-for-org,migrations/start_for_org,post,migration,migrations,migrations,migrations,start_for_org,exec,,Start an organization migration +migrations.yaml,/orgs/{org}/migrations/{migration_id}/archive,migrations/delete-archive-for-org,migrations/delete_archive_for_org,delete,,migrations,migrations,orgs,delete_archive_for_org,delete,,Delete an organization migration archive +migrations.yaml,/user/migrations/{migration_id}/repos/{repo_name}/lock,migrations/unlock-repo-for-authenticated-user,migrations/unlock_repo_for_authenticated_user,delete,,migrations,migrations,repos,unlock_repo_for_authenticated_user,delete,,Unlock a user repository +migrations.yaml,/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock,migrations/unlock-repo-for-org,migrations/unlock_repo_for_org,delete,,migrations,migrations,repos,unlock_repo_for_org,delete,,Unlock an organization repository +migrations.yaml,/user/migrations/{migration_id}/repositories,migrations/list-repos-for-authenticated-user,migrations/list_repos_for_authenticated_user,get,minimal-repository,migrations,migrations,repos,list_repos_for_authenticated_user,select,,List repositories for a user migration +migrations.yaml,/orgs/{org}/migrations/{migration_id}/repositories,migrations/list-repos-for-org,migrations/list_repos_for_org,get,minimal-repository,migrations,migrations,repos,list_repos_for_org,select,,List repositories in an organization migration +migrations.yaml,/orgs/{org}/migrations/{migration_id}/archive,migrations/download-archive-for-org,migrations/download_archive_for_org,get,,migrations,migrations,skip_this_resource,migrations/download_archive_for_org,exec,,Download an organization migration archive +migrations.yaml,/user/migrations/{migration_id}/archive,migrations/get-archive-for-authenticated-user,migrations/get_archive_for_authenticated_user,get,,migrations,migrations,skip_this_resource,migrations/get_archive_for_authenticated_user,exec,,Download a user migration archive +migrations.yaml,/repos/{owner}/{repo}/import,migrations/cancel-import,migrations/cancel_import,delete,,migrations,migrations,source_imports,cancel_import,exec,,Cancel an import +migrations.yaml,/repos/{owner}/{repo}/import,migrations/get-import-status,migrations/get_import_status,get,import,migrations,migrations,source_imports,get_import_status,select,,Get an import status +migrations.yaml,/repos/{owner}/{repo}/import,migrations/update-import,migrations/update_import,patch,import,migrations,migrations,source_imports,update_import,update,,Update an import +migrations.yaml,/repos/{owner}/{repo}/import,migrations/start-import,migrations/start_import,put,import,migrations,migrations,source_imports,start_import,exec,,Start an import +migrations.yaml,/user/migrations/{migration_id}/archive,migrations/delete-archive-for-authenticated-user,migrations/delete_archive_for_authenticated_user,delete,,migrations,migrations,users,delete_archive_for_authenticated_user,delete,,Delete a user migration archive +oidc.yaml,/orgs/{org}/actions/oidc/customization/sub,oidc/get-oidc-custom-sub-template-for-org,oidc/get_oidc_custom_sub_template_for_org,get,oidc-custom-sub,oidc,oidc,oidc,get_oidc_custom_sub_template_for_org,select,$.include_claim_keys,Get the customization template for an OIDC subject claim for an organization +oidc.yaml,/orgs/{org}/actions/oidc/customization/sub,oidc/update-oidc-custom-sub-template-for-org,oidc/update_oidc_custom_sub_template_for_org,put,empty-object,oidc,oidc,oidc,update_oidc_custom_sub_template_for_org,replace,,Set the customization template for an OIDC subject claim for an organization +oidc.yaml,/enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name},oidc/delete-oidc-custom-property-inclusion-for-enterprise,oidc/delete_oidc_custom_property_inclusion_for_enterprise,delete,,oidc,oidc,oidc_custom_property_inclusions,delete_oidc_custom_property_inclusion_for_enterprise,delete,,Delete an OIDC custom property inclusion for an enterprise +oidc.yaml,/enterprises/{enterprise}/actions/oidc/customization/properties/repo,oidc/list-oidc-custom-property-inclusions-for-enterprise,oidc/list_oidc_custom_property_inclusions_for_enterprise,get,,oidc,oidc,oidc_custom_property_inclusions,list_oidc_custom_property_inclusions_for_enterprise,select,,List OIDC custom property inclusions for an enterprise +oidc.yaml,/enterprises/{enterprise}/actions/oidc/customization/properties/repo,oidc/create-oidc-custom-property-inclusion-for-enterprise,oidc/create_oidc_custom_property_inclusion_for_enterprise,post,,oidc,oidc,oidc_custom_property_inclusions,create_oidc_custom_property_inclusion_for_enterprise,insert,,Create an OIDC custom property inclusion for an enterprise +oidc.yaml,/orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name},oidc/delete-oidc-custom-property-inclusion-for-org,oidc/delete_oidc_custom_property_inclusion_for_org,delete,,oidc,oidc,org_oidc_custom_property_inclusions,delete_oidc_custom_property_inclusion_for_org,delete,,Delete an OIDC custom property inclusion for an organization +oidc.yaml,/orgs/{org}/actions/oidc/customization/properties/repo,oidc/list-oidc-custom-property-inclusions-for-org,oidc/list_oidc_custom_property_inclusions_for_org,get,,oidc,oidc,org_oidc_custom_property_inclusions,list_oidc_custom_property_inclusions_for_org,select,,List OIDC custom property inclusions for an organization +oidc.yaml,/orgs/{org}/actions/oidc/customization/properties/repo,oidc/create-oidc-custom-property-inclusion-for-org,oidc/create_oidc_custom_property_inclusion_for_org,post,,oidc,oidc,org_oidc_custom_property_inclusions,create_oidc_custom_property_inclusion_for_org,insert,,Create an OIDC custom property inclusion for an organization +orgs.yaml,/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id},api-insights/get-route-stats-by-actor,api_insights/get_route_stats_by_actor,get,,orgs,orgs,api_insights_route_stats,get_route_stats_by_actor,select,,Get route stats by actor +orgs.yaml,/orgs/{org}/insights/api/subject-stats,api-insights/get-subject-stats,api_insights/get_subject_stats,get,,orgs,orgs,api_insights_subject_stats,get_subject_stats,select,,Get subject stats +orgs.yaml,/orgs/{org}/insights/api/summary-stats,api-insights/get-summary-stats,api_insights/get_summary_stats,get,,orgs,orgs,api_insights_summary_stats,get_summary_stats,select,,Get summary stats +orgs.yaml,/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id},api-insights/get-summary-stats-by-actor,api_insights/get_summary_stats_by_actor,get,,orgs,orgs,api_insights_summary_stats,get_summary_stats_by_actor,select,,Get summary stats by actor +orgs.yaml,/orgs/{org}/insights/api/summary-stats/users/{user_id},api-insights/get-summary-stats-by-user,api_insights/get_summary_stats_by_user,get,,orgs,orgs,api_insights_summary_stats,get_summary_stats_by_user,select,,Get summary stats by user +orgs.yaml,/orgs/{org}/insights/api/time-stats,api-insights/get-time-stats,api_insights/get_time_stats,get,,orgs,orgs,api_insights_time_stats,get_time_stats,select,,Get time stats +orgs.yaml,/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id},api-insights/get-time-stats-by-actor,api_insights/get_time_stats_by_actor,get,,orgs,orgs,api_insights_time_stats,get_time_stats_by_actor,select,,Get time stats by actor +orgs.yaml,/orgs/{org}/insights/api/time-stats/users/{user_id},api-insights/get-time-stats-by-user,api_insights/get_time_stats_by_user,get,,orgs,orgs,api_insights_time_stats,get_time_stats_by_user,select,,Get time stats by user +orgs.yaml,/orgs/{org}/insights/api/user-stats/{user_id},api-insights/get-user-stats,api_insights/get_user_stats,get,,orgs,orgs,api_insights_user_stats,get_user_stats,select,,Get user stats +orgs.yaml,/orgs/{org}/installations,orgs/list-app-installations,orgs/list_app_installations,get,,orgs,orgs,app_installations,list_app_installations,select,,List app installations for an organization +orgs.yaml,/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records,orgs/list-artifact-deployment-records,orgs/list_artifact_deployment_records,get,,orgs,orgs,artifact_deployment_records,list_artifact_deployment_records,select,,List artifact deployment records +orgs.yaml,/orgs/{org}/artifacts/metadata/deployment-record,orgs/create-artifact-deployment-record,orgs/create_artifact_deployment_record,post,,orgs,orgs,artifact_deployment_records,create_artifact_deployment_record,insert,,Create an artifact deployment record +orgs.yaml,/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster},orgs/set-cluster-deployment-records,orgs/set_cluster_deployment_records,post,,orgs,orgs,artifact_deployment_records,set_cluster_deployment_records,insert,,Set cluster deployment records +orgs.yaml,/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records,orgs/list-artifact-storage-records,orgs/list_artifact_storage_records,get,,orgs,orgs,artifact_storage_records,list_artifact_storage_records,select,,List artifact storage records +orgs.yaml,/orgs/{org}/artifacts/metadata/storage-record,orgs/create-artifact-storage-record,orgs/create_artifact_storage_record,post,,orgs,orgs,artifact_storage_records,create_artifact_storage_record,insert,,Create artifact metadata storage record +orgs.yaml,/orgs/{org}/attestations/repositories,orgs/list-attestation-repositories,orgs/list_attestation_repositories,get,,orgs,orgs,attestation_repositories,list_attestation_repositories,select,,List attestation repositories +orgs.yaml,/orgs/{org}/attestations/{attestation_id},orgs/delete-attestations-by-id,orgs/delete_attestations_by_id,delete,,orgs,orgs,attestations,delete_attestations_by_id,delete,,Delete attestations by ID +orgs.yaml,/orgs/{org}/attestations/digest/{subject_digest},orgs/delete-attestations-by-subject-digest,orgs/delete_attestations_by_subject_digest,delete,,orgs,orgs,attestations,delete_attestations_by_subject_digest,delete,,Delete attestations by subject digest +orgs.yaml,/orgs/{org}/attestations/{subject_digest},orgs/list-attestations,orgs/list_attestations,get,,orgs,orgs,attestations,list_attestations,select,$.attestations,List attestations +orgs.yaml,/orgs/{org}/attestations/delete-request,orgs/delete-attestations-bulk,orgs/delete_attestations_bulk,post,,orgs,orgs,attestations,delete_attestations_bulk,exec,,Delete attestations in bulk +orgs.yaml,/orgs/{org}/attestations/bulk-list,orgs/list-attestations-bulk,orgs/list_attestations_bulk,post,,orgs,orgs,attestations,list_attestations_bulk,exec,,List attestations by bulk subject digests +orgs.yaml,/orgs/{org}/blocks/{username},orgs/unblock-user,orgs/unblock_user,delete,,orgs,orgs,blocking,unblock_user,exec,,Unblock a user from an organization +orgs.yaml,/orgs/{org}/blocks/{username},orgs/check-blocked-user,orgs/check_blocked_user,get,,orgs,orgs,blocking,check_blocked_user,exec,,Check if a user is blocked by an organization +orgs.yaml,/orgs/{org}/blocks,orgs/list-blocked-users,orgs/list_blocked_users,get,simple-user,orgs,orgs,blocking,list_blocked_users,select,,List users blocked by an organization +orgs.yaml,/orgs/{org}/blocks/{username},orgs/block-user,orgs/block_user,put,,orgs,orgs,blocking,block_user,exec,,Block a user from an organization +orgs.yaml,/orgs/{org}/properties/schema/{custom_property_name},orgs/custom-properties-for-repos-delete-organization-definition,orgs/custom_properties_for_repos_delete_organization_definition,delete,,orgs,orgs,custom_properties,custom_properties_for_repos_delete_organization_definition,delete,,Remove a custom property for an organization +orgs.yaml,/orgs/{org}/properties/schema/{custom_property_name},orgs/custom-properties-for-repos-get-organization-definition,orgs/custom_properties_for_repos_get_organization_definition,get,,orgs,orgs,custom_properties,custom_properties_for_repos_get_organization_definition,select,,Get a custom property for an organization +orgs.yaml,/orgs/{org}/properties/schema,orgs/custom-properties-for-repos-get-organization-definitions,orgs/custom_properties_for_repos_get_organization_definitions,get,,orgs,orgs,custom_properties,custom_properties_for_repos_get_organization_definitions,select,,Get all custom properties for an organization +orgs.yaml,/orgs/{org}/properties/schema,orgs/custom-properties-for-repos-create-or-update-organization-definitions,orgs/custom_properties_for_repos_create_or_update_organization_definitions,patch,,orgs,orgs,custom_properties,custom_properties_for_repos_create_or_update_organization_definitions,update,,Create or update custom properties for an organization +orgs.yaml,/orgs/{org}/properties/schema/{custom_property_name},orgs/custom-properties-for-repos-create-or-update-organization-definition,orgs/custom_properties_for_repos_create_or_update_organization_definition,put,,orgs,orgs,custom_properties,custom_properties_for_repos_create_or_update_organization_definition,replace,,Create or update a custom property for an organization +orgs.yaml,/orgs/{org}/properties/values,orgs/custom-properties-for-repos-get-organization-values,orgs/custom_properties_for_repos_get_organization_values,get,,orgs,orgs,custom_property_values,custom_properties_for_repos_get_organization_values,select,,List custom property values for organization repositories +orgs.yaml,/orgs/{org}/properties/values,orgs/custom-properties-for-repos-create-or-update-organization-values,orgs/custom_properties_for_repos_create_or_update_organization_values,patch,,orgs,orgs,custom_property_values,custom_properties_for_repos_create_or_update_organization_values,update,,Create or update custom property values for organization repositories +orgs.yaml,/orgs/{org}/failed_invitations,orgs/list-failed-invitations,orgs/list_failed_invitations,get,organization-invitation,orgs,orgs,failed_invitations,list_failed_invitations,select,,List failed organization invitations +orgs.yaml,/orgs/{org}/settings/immutable-releases/repositories/{repository_id},orgs/disable-selected-repository-immutable-releases-organization,orgs/disable_selected_repository_immutable_releases_organization,delete,,orgs,orgs,immutable_releases_repos,disable_selected_repository_immutable_releases_organization,delete,,Disable a selected repository for immutable releases in an organization +orgs.yaml,/orgs/{org}/settings/immutable-releases/repositories,orgs/get-immutable-releases-settings-repositories,orgs/get_immutable_releases_settings_repositories,get,,orgs,orgs,immutable_releases_repos,get_immutable_releases_settings_repositories,select,,List selected repositories for immutable releases enforcement +orgs.yaml,/orgs/{org}/settings/immutable-releases/repositories/{repository_id},orgs/enable-selected-repository-immutable-releases-organization,orgs/enable_selected_repository_immutable_releases_organization,put,,orgs,orgs,immutable_releases_repos,enable_selected_repository_immutable_releases_organization,replace,,Enable a selected repository for immutable releases in an organization +orgs.yaml,/orgs/{org}/settings/immutable-releases/repositories,orgs/set-immutable-releases-settings-repositories,orgs/set_immutable_releases_settings_repositories,put,,orgs,orgs,immutable_releases_repos,set_immutable_releases_settings_repositories,replace,,Set selected repositories for immutable releases enforcement +orgs.yaml,/orgs/{org}/settings/immutable-releases,orgs/get-immutable-releases-settings,orgs/get_immutable_releases_settings,get,,orgs,orgs,immutable_releases_settings,get_immutable_releases_settings,select,,Get immutable releases settings for an organization +orgs.yaml,/orgs/{org}/settings/immutable-releases,orgs/set-immutable-releases-settings,orgs/set_immutable_releases_settings,put,,orgs,orgs,immutable_releases_settings,set_immutable_releases_settings,replace,,Set immutable releases settings for an organization +orgs.yaml,/orgs/{org}/invitations/{invitation_id}/teams,orgs/list-invitation-teams,orgs/list_invitation_teams,get,team,orgs,orgs,invitation_teams,list_invitation_teams,select,,List organization invitation teams +orgs.yaml,/orgs/{org}/invitations/{invitation_id},orgs/cancel-invitation,orgs/cancel_invitation,delete,,orgs,orgs,invitations,cancel_invitation,delete,,Cancel an organization invitation +orgs.yaml,/orgs/{org}/invitations,orgs/list-pending-invitations,orgs/list_pending_invitations,get,organization-invitation,orgs,orgs,invitations,list_pending_invitations,select,,List pending organization invitations +orgs.yaml,/orgs/{org}/invitations,orgs/create-invitation,orgs/create_invitation,post,organization-invitation,orgs,orgs,invitations,create_invitation,insert,,Create an organization invitation +orgs.yaml,/orgs/{org}/issue-fields/{issue_field_id},orgs/delete-issue-field,orgs/delete_issue_field,delete,,orgs,orgs,issue_fields,delete_issue_field,delete,,Delete issue field for an organization +orgs.yaml,/orgs/{org}/issue-fields,orgs/list-issue-fields,orgs/list_issue_fields,get,,orgs,orgs,issue_fields,list_issue_fields,select,,List issue fields for an organization +orgs.yaml,/orgs/{org}/issue-fields/{issue_field_id},orgs/update-issue-field,orgs/update_issue_field,patch,,orgs,orgs,issue_fields,update_issue_field,update,,Update issue field for an organization +orgs.yaml,/orgs/{org}/issue-fields,orgs/create-issue-field,orgs/create_issue_field,post,,orgs,orgs,issue_fields,create_issue_field,insert,,Create issue field for an organization +orgs.yaml,/orgs/{org}/issue-types/{issue_type_id},orgs/delete-issue-type,orgs/delete_issue_type,delete,,orgs,orgs,issue_types,delete_issue_type,delete,,Delete issue type for an organization +orgs.yaml,/orgs/{org}/issue-types,orgs/list-issue-types,orgs/list_issue_types,get,,orgs,orgs,issue_types,list_issue_types,select,,List issue types for an organization +orgs.yaml,/orgs/{org}/issue-types,orgs/create-issue-type,orgs/create_issue_type,post,,orgs,orgs,issue_types,create_issue_type,insert,,Create issue type for an organization +orgs.yaml,/orgs/{org}/issue-types/{issue_type_id},orgs/update-issue-type,orgs/update_issue_type,put,,orgs,orgs,issue_types,update_issue_type,replace,,Update issue type for an organization +orgs.yaml,/orgs/{org}/members/{username},orgs/remove-member,orgs/remove_member,delete,,orgs,orgs,members,remove_member,delete,,Remove an organization member +orgs.yaml,/orgs/{org}/members,orgs/list-members,orgs/list_members,get,simple-user,orgs,orgs,members,list_members,select,,List organization members +orgs.yaml,/orgs/{org}/memberships/{username},orgs/remove-membership-for-user,orgs/remove_membership_for_user,delete,,orgs,orgs,memberships,remove_membership_for_user,delete,,Remove organization membership for a user +orgs.yaml,/orgs/{org}/members/{username},orgs/check-membership-for-user,orgs/check_membership_for_user,get,,orgs,orgs,memberships,check_membership_for_user,exec,,Check organization membership for a user +orgs.yaml,/user/memberships/orgs/{org},orgs/get-membership-for-authenticated-user,orgs/get_membership_for_authenticated_user,get,org-membership,orgs,orgs,memberships,get_membership_for_authenticated_user,select,,Get an organization membership for the authenticated user +orgs.yaml,/orgs/{org}/memberships/{username},orgs/get-membership-for-user,orgs/get_membership_for_user,get,org-membership,orgs,orgs,memberships,get_membership_for_user,select,,Get organization membership for a user +orgs.yaml,/user/memberships/orgs,orgs/list-memberships-for-authenticated-user,orgs/list_memberships_for_authenticated_user,get,org-membership,orgs,orgs,memberships,list_memberships_for_authenticated_user,select,,List organization memberships for the authenticated user +orgs.yaml,/user/memberships/orgs/{org},orgs/update-membership-for-authenticated-user,orgs/update_membership_for_authenticated_user,patch,org-membership,orgs,orgs,memberships,update_membership_for_authenticated_user,update,,Update an organization membership for the authenticated user +orgs.yaml,/orgs/{org}/memberships/{username},orgs/set-membership-for-user,orgs/set_membership_for_user,put,org-membership,orgs,orgs,memberships,set_membership_for_user,replace,,Set organization membership for a user +orgs.yaml,/orgs/{org},orgs/delete,orgs/delete,delete,,orgs,orgs,orgs,delete,delete,,Delete an organization +orgs.yaml,/orgs/{org},orgs/get,orgs/get,get,organization-full,orgs,orgs,orgs,get,select,,Get an organization +orgs.yaml,/organizations,orgs/list,orgs/list,get,organization-simple,orgs,orgs,orgs,list,select,,List organizations +orgs.yaml,/users/{username}/orgs,orgs/list-for-user,orgs/list_for_user,get,organization-simple,orgs,orgs,orgs,list_for_user,select,,List organizations for a user +orgs.yaml,/orgs/{org},orgs/update,orgs/update,patch,organization-full,orgs,orgs,orgs,update,update,,Update an organization +orgs.yaml,/orgs/{org}/{security_product}/{enablement},orgs/enable-or-disable-security-product-on-all-org-repos,orgs/enable_or_disable_security_product_on_all_org_repos,post,,orgs,orgs,orgs,enable_or_disable_security_product_on_all_org_repos,exec,,Enable or disable a security feature for an organization +orgs.yaml,/user/orgs,orgs/list-for-authenticated-user,orgs/list_for_authenticated_user,get,organization-simple,orgs,orgs,orgs_for_user,list_for_authenticated_user,select,,List organizations for the authenticated user +orgs.yaml,/orgs/{org}/outside_collaborators/{username},orgs/remove-outside-collaborator,orgs/remove_outside_collaborator,delete,,orgs,orgs,outside_collaborators,remove_outside_collaborator,delete,,Remove outside collaborator from an organization +orgs.yaml,/orgs/{org}/outside_collaborators,orgs/list-outside-collaborators,orgs/list_outside_collaborators,get,simple-user,orgs,orgs,outside_collaborators,list_outside_collaborators,select,,List outside collaborators for an organization +orgs.yaml,/orgs/{org}/outside_collaborators/{username},orgs/convert-member-to-outside-collaborator,orgs/convert_member_to_outside_collaborator,put,,orgs,orgs,outside_collaborators,convert_member_to_outside_collaborator,exec,,Convert an organization member to outside collaborator +orgs.yaml,/orgs/{org}/personal-access-token-requests,orgs/list-pat-grant-requests,orgs/list_pat_grant_requests,get,organization-programmatic-access-grant-request,orgs,orgs,pat_grant_requests,list_pat_grant_requests,select,,List requests to access organization resources with fine-grained personal access tokens +orgs.yaml,/orgs/{org}/personal-access-token-requests/{pat_request_id},orgs/review-pat-grant-request,orgs/review_pat_grant_request,post,,orgs,orgs,pat_grant_requests,review_pat_grant_request,exec,,Review a request to access organization resources with a fine-grained personal access token +orgs.yaml,/orgs/{org}/personal-access-token-requests,orgs/review-pat-grant-requests-in-bulk,orgs/review_pat_grant_requests_in_bulk,post,,orgs,orgs,pat_grant_requests,review_pat_grant_requests_in_bulk,exec,,Review requests to access organization resources with fine-grained personal access tokens +orgs.yaml,/orgs/{org}/personal-access-tokens,orgs/list-pat-grants,orgs/list_pat_grants,get,organization-programmatic-access-grant,orgs,orgs,pat_grants,list_pat_grants,select,,List fine-grained personal access tokens with access to organization resources +orgs.yaml,/orgs/{org}/personal-access-tokens/{pat_id},orgs/update-pat-access,orgs/update_pat_access,post,,orgs,orgs,pat_grants,update_pat_access,exec,,Update the access a fine-grained personal access token has to organization resources +orgs.yaml,/orgs/{org}/personal-access-tokens,orgs/update-pat-accesses,orgs/update_pat_accesses,post,,orgs,orgs,pat_grants,update_pat_accesses,exec,,Update the access to organization resources via fine-grained personal access tokens +orgs.yaml,/orgs/{org}/public_members/{username},orgs/remove-public-membership-for-authenticated-user,orgs/remove_public_membership_for_authenticated_user,delete,,orgs,orgs,public_members,remove_public_membership_for_authenticated_user,delete,,Remove public organization membership for the authenticated user +orgs.yaml,/orgs/{org}/public_members/{username},orgs/check-public-membership-for-user,orgs/check_public_membership_for_user,get,,orgs,orgs,public_members,check_public_membership_for_user,exec,,Check public organization membership for a user +orgs.yaml,/orgs/{org}/public_members,orgs/list-public-members,orgs/list_public_members,get,simple-user,orgs,orgs,public_members,list_public_members,select,,List public organization members +orgs.yaml,/orgs/{org}/public_members/{username},orgs/set-public-membership-for-authenticated-user,orgs/set_public_membership_for_authenticated_user,put,,orgs,orgs,public_members,set_public_membership_for_authenticated_user,replace,,Set public organization membership for the authenticated user +orgs.yaml,/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories,orgs/list-pat-grant-request-repositories,orgs/list_pat_grant_request_repositories,get,minimal-repository,orgs,orgs,repos_for_pat_grant_requests,list_pat_grant_request_repositories,select,,List repositories requested to be accessed by a fine-grained personal access token +orgs.yaml,/orgs/{org}/personal-access-tokens/{pat_id}/repositories,orgs/list-pat-grant-repositories,orgs/list_pat_grant_repositories,get,minimal-repository,orgs,orgs,repos_for_pat_grants,list_pat_grant_repositories,select,,List repositories a fine-grained personal access token has access to +orgs.yaml,/orgs/{org}/organization-roles/teams/{team_slug},orgs/revoke-all-org-roles-team,orgs/revoke_all_org_roles_team,delete,,orgs,orgs,role_team_assignments,revoke_all_org_roles_team,delete,,Remove all organization roles for a team +orgs.yaml,/orgs/{org}/organization-roles/teams/{team_slug}/{role_id},orgs/revoke-org-role-team,orgs/revoke_org_role_team,delete,,orgs,orgs,role_team_assignments,revoke_org_role_team,delete,,Remove an organization role from a team +orgs.yaml,/orgs/{org}/organization-roles/{role_id}/teams,orgs/list-org-role-teams,orgs/list_org_role_teams,get,,orgs,orgs,role_team_assignments,list_org_role_teams,select,,List teams that are assigned to an organization role +orgs.yaml,/orgs/{org}/organization-roles/teams/{team_slug}/{role_id},orgs/assign-team-to-org-role,orgs/assign_team_to_org_role,put,,orgs,orgs,role_team_assignments,assign_team_to_org_role,replace,,Assign an organization role to a team +orgs.yaml,/orgs/{org}/organization-roles/users/{username},orgs/revoke-all-org-roles-user,orgs/revoke_all_org_roles_user,delete,,orgs,orgs,role_user_assignments,revoke_all_org_roles_user,delete,,Remove all organization roles for a user +orgs.yaml,/orgs/{org}/organization-roles/users/{username}/{role_id},orgs/revoke-org-role-user,orgs/revoke_org_role_user,delete,,orgs,orgs,role_user_assignments,revoke_org_role_user,delete,,Remove an organization role from a user +orgs.yaml,/orgs/{org}/organization-roles/{role_id}/users,orgs/list-org-role-users,orgs/list_org_role_users,get,,orgs,orgs,role_user_assignments,list_org_role_users,select,,List users that are assigned to an organization role +orgs.yaml,/orgs/{org}/organization-roles/users/{username}/{role_id},orgs/assign-user-to-org-role,orgs/assign_user_to_org_role,put,,orgs,orgs,role_user_assignments,assign_user_to_org_role,replace,,Assign an organization role to a user +orgs.yaml,/orgs/{org}/organization-roles/{role_id},orgs/get-org-role,orgs/get_org_role,get,,orgs,orgs,roles,get_org_role,select,,Get an organization role +orgs.yaml,/orgs/{org}/organization-roles,orgs/list-org-roles,orgs/list_org_roles,get,,orgs,orgs,roles,list_org_roles,select,,Get all organization roles for an organization +orgs.yaml,/orgs/{org}/rulesets/{ruleset_id}/history,orgs/get-org-ruleset-history,orgs/get_org_ruleset_history,get,,orgs,orgs,ruleset_history,get_org_ruleset_history,select,,Get organization ruleset history +orgs.yaml,/orgs/{org}/rulesets/{ruleset_id}/history/{version_id},orgs/get-org-ruleset-version,orgs/get_org_ruleset_version,get,,orgs,orgs,ruleset_history,get_org_ruleset_version,select,,Get organization ruleset version +orgs.yaml,/orgs/{org}/security-managers/teams/{team_slug},orgs/remove-security-manager-team,orgs/remove_security_manager_team,delete,,orgs,orgs,security_managers,remove_security_manager_team,delete,,Remove a security manager team +orgs.yaml,/orgs/{org}/security-managers,orgs/list-security-manager-teams,orgs/list_security_manager_teams,get,team-simple,orgs,orgs,security_managers,list_security_manager_teams,select,,List security manager teams +orgs.yaml,/orgs/{org}/security-managers/teams/{team_slug},orgs/add-security-manager-team,orgs/add_security_manager_team,put,,orgs,orgs,security_managers,add_security_manager_team,insert,,Add a security manager team +orgs.yaml,/orgs/{org}/hooks/{hook_id}/config,orgs/get-webhook-config-for-org,orgs/get_webhook_config_for_org,get,webhook-config,orgs,orgs,webhook_config,get_webhook_config_for_org,select,,Get a webhook configuration for an organization +orgs.yaml,/orgs/{org}/hooks/{hook_id}/config,orgs/update-webhook-config-for-org,orgs/update_webhook_config_for_org,patch,webhook-config,orgs,orgs,webhook_config,update_webhook_config_for_org,update,,Update a webhook configuration for an organization +orgs.yaml,/orgs/{org}/hooks/{hook_id}/deliveries,orgs/list-webhook-deliveries,orgs/list_webhook_deliveries,get,hook-delivery-item,orgs,orgs,webhook_deliveries,list_webhook_deliveries,select,,List deliveries for an organization webhook +orgs.yaml,/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id},orgs/get-webhook-delivery,orgs/get_webhook_delivery,get,hook-delivery,orgs,orgs,webhook_delivery,get_webhook_delivery,select,,Get a webhook delivery for an organization webhook +orgs.yaml,/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts,orgs/redeliver-webhook-delivery,orgs/redeliver_webhook_delivery,post,,orgs,orgs,webhook_delivery,redeliver_webhook_delivery,exec,,Redeliver a delivery for an organization webhook +orgs.yaml,/orgs/{org}/hooks/{hook_id},orgs/delete-webhook,orgs/delete_webhook,delete,,orgs,orgs,webhooks,delete_webhook,delete,,Delete an organization webhook +orgs.yaml,/orgs/{org}/hooks/{hook_id},orgs/get-webhook,orgs/get_webhook,get,org-hook,orgs,orgs,webhooks,get_webhook,select,,Get an organization webhook +orgs.yaml,/orgs/{org}/hooks,orgs/list-webhooks,orgs/list_webhooks,get,org-hook,orgs,orgs,webhooks,list_webhooks,select,,List organization webhooks +orgs.yaml,/orgs/{org}/hooks/{hook_id},orgs/update-webhook,orgs/update_webhook,patch,org-hook,orgs,orgs,webhooks,update_webhook,update,,Update an organization webhook +orgs.yaml,/orgs/{org}/hooks,orgs/create-webhook,orgs/create_webhook,post,org-hook,orgs,orgs,webhooks,create_webhook,insert,,Create an organization webhook +orgs.yaml,/orgs/{org}/hooks/{hook_id}/pings,orgs/ping-webhook,orgs/ping_webhook,post,,orgs,orgs,webhooks,ping_webhook,exec,,Ping an organization webhook +packages.yaml,/user/docker/conflicts,packages/list-docker-migration-conflicting-packages-for-authenticated-user,packages/list_docker_migration_conflicting_packages_for_authenticated_user,get,package,packages,packages,docker_migration_packages,list_docker_migration_conflicting_packages_for_authenticated_user,select,,Get list of conflicting packages during Docker migration for authenticated-user +packages.yaml,/orgs/{org}/docker/conflicts,packages/list-docker-migration-conflicting-packages-for-organization,packages/list_docker_migration_conflicting_packages_for_organization,get,package,packages,packages,docker_migration_packages,list_docker_migration_conflicting_packages_for_organization,select,,Get list of conflicting packages during Docker migration for organization +packages.yaml,/users/{username}/docker/conflicts,packages/list-docker-migration-conflicting-packages-for-user,packages/list_docker_migration_conflicting_packages_for_user,get,package,packages,packages,docker_migration_packages,list_docker_migration_conflicting_packages_for_user,select,,Get list of conflicting packages during Docker migration for user +packages.yaml,/user/packages/{package_type}/{package_name}/versions/{package_version_id},packages/delete-package-version-for-authenticated-user,packages/delete_package_version_for_authenticated_user,delete,,packages,packages,package_versions,delete_package_version_for_authenticated_user,delete,,Delete a package version for the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id},packages/delete-package-version-for-org,packages/delete_package_version_for_org,delete,,packages,packages,package_versions,delete_package_version_for_org,delete,,Delete package version for an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id},packages/delete-package-version-for-user,packages/delete_package_version_for_user,delete,,packages,packages,package_versions,delete_package_version_for_user,delete,,Delete package version for a user +packages.yaml,/user/packages/{package_type}/{package_name}/versions,packages/get-all-package-versions-for-package-owned-by-authenticated-user,packages/get_all_package_versions_for_package_owned_by_authenticated_user,get,package-version,packages,packages,package_versions,get_all_package_versions_for_package_owned_by_authenticated_user,select,,List package versions for a package owned by the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name}/versions,packages/get-all-package-versions-for-package-owned-by-org,packages/get_all_package_versions_for_package_owned_by_org,get,package-version,packages,packages,package_versions,get_all_package_versions_for_package_owned_by_org,select,,List package versions for a package owned by an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name}/versions,packages/get-all-package-versions-for-package-owned-by-user,packages/get_all_package_versions_for_package_owned_by_user,get,package-version,packages,packages,package_versions,get_all_package_versions_for_package_owned_by_user,select,,List package versions for a package owned by a user +packages.yaml,/user/packages/{package_type}/{package_name}/versions/{package_version_id},packages/get-package-version-for-authenticated-user,packages/get_package_version_for_authenticated_user,get,package-version,packages,packages,package_versions,get_package_version_for_authenticated_user,select,,Get a package version for the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id},packages/get-package-version-for-organization,packages/get_package_version_for_organization,get,package-version,packages,packages,package_versions,get_package_version_for_organization,select,,Get a package version for an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id},packages/get-package-version-for-user,packages/get_package_version_for_user,get,package-version,packages,packages,package_versions,get_package_version_for_user,select,,Get a package version for a user +packages.yaml,/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore,packages/restore-package-version-for-authenticated-user,packages/restore_package_version_for_authenticated_user,post,,packages,packages,package_versions,restore_package_version_for_authenticated_user,exec,,Restore a package version for the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore,packages/restore-package-version-for-org,packages/restore_package_version_for_org,post,,packages,packages,package_versions,restore_package_version_for_org,exec,,Restore package version for an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore,packages/restore-package-version-for-user,packages/restore_package_version_for_user,post,,packages,packages,package_versions,restore_package_version_for_user,exec,,Restore package version for a user +packages.yaml,/user/packages/{package_type}/{package_name},packages/delete-package-for-authenticated-user,packages/delete_package_for_authenticated_user,delete,,packages,packages,packages,delete_package_for_authenticated_user,delete,,Delete a package for the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name},packages/delete-package-for-org,packages/delete_package_for_org,delete,,packages,packages,packages,delete_package_for_org,delete,,Delete a package for an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name},packages/delete-package-for-user,packages/delete_package_for_user,delete,,packages,packages,packages,delete_package_for_user,delete,,Delete a package for a user +packages.yaml,/user/packages/{package_type}/{package_name},packages/get-package-for-authenticated-user,packages/get_package_for_authenticated_user,get,package,packages,packages,packages,get_package_for_authenticated_user,select,,Get a package for the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name},packages/get-package-for-organization,packages/get_package_for_organization,get,package,packages,packages,packages,get_package_for_organization,select,,Get a package for an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name},packages/get-package-for-user,packages/get_package_for_user,get,package,packages,packages,packages,get_package_for_user,select,,Get a package for a user +packages.yaml,/user/packages,packages/list-packages-for-authenticated-user,packages/list_packages_for_authenticated_user,get,package,packages,packages,packages,list_packages_for_authenticated_user,select,,List packages for the authenticated user's namespace +packages.yaml,/orgs/{org}/packages,packages/list-packages-for-organization,packages/list_packages_for_organization,get,package,packages,packages,packages,list_packages_for_organization,select,,List packages for an organization +packages.yaml,/users/{username}/packages,packages/list-packages-for-user,packages/list_packages_for_user,get,package,packages,packages,packages,list_packages_for_user,select,,List packages for a user +packages.yaml,/user/packages/{package_type}/{package_name}/restore,packages/restore-package-for-authenticated-user,packages/restore_package_for_authenticated_user,post,,packages,packages,packages,restore_package_for_authenticated_user,exec,,Restore a package for the authenticated user +packages.yaml,/orgs/{org}/packages/{package_type}/{package_name}/restore,packages/restore-package-for-org,packages/restore_package_for_org,post,,packages,packages,packages,restore_package_for_org,exec,,Restore a package for an organization +packages.yaml,/users/{username}/packages/{package_type}/{package_name}/restore,packages/restore-package-for-user,packages/restore_package_for_user,post,,packages,packages,packages,restore_package_for_user,exec,,Restore a package for a user +private_registries.yaml,/orgs/{org}/private-registries/{secret_name},private-registries/delete-org-private-registry,private_registries/delete_org_private_registry,delete,,private-registries,private_registries,private_registries,delete_org_private_registry,delete,,Delete a private registry for an organization +private_registries.yaml,/orgs/{org}/private-registries/{secret_name},private-registries/get-org-private-registry,private_registries/get_org_private_registry,get,,private-registries,private_registries,private_registries,get_org_private_registry,select,,Get a private registry for an organization +private_registries.yaml,/orgs/{org}/private-registries,private-registries/list-org-private-registries,private_registries/list_org_private_registries,get,,private-registries,private_registries,private_registries,list_org_private_registries,select,,List private registries for an organization +private_registries.yaml,/orgs/{org}/private-registries/{secret_name},private-registries/update-org-private-registry,private_registries/update_org_private_registry,patch,,private-registries,private_registries,private_registries,update_org_private_registry,update,,Update a private registry for an organization +private_registries.yaml,/orgs/{org}/private-registries,private-registries/create-org-private-registry,private_registries/create_org_private_registry,post,,private-registries,private_registries,private_registries,create_org_private_registry,insert,,Create a private registry for an organization +private_registries.yaml,/orgs/{org}/private-registries/public-key,private-registries/get-org-public-key,private_registries/get_org_public_key,get,,private-registries,private_registries,private_registry_public_key,get_org_public_key,select,,Get private registries public key for an organization +projects.yaml,/projects/columns/cards/{card_id},projects/delete-card,projects/delete_card,delete,,projects,projects,cards,delete_card,delete,,Delete a project card +projects.yaml,/projects/columns/cards/{card_id},projects/get-card,projects/get_card,get,project-card,projects,projects,cards,get_card,select,,Get a project card +projects.yaml,/projects/columns/{column_id}/cards,projects/list-cards,projects/list_cards,get,project-card,projects,projects,cards,list_cards,select,,List project cards +projects.yaml,/projects/columns/cards/{card_id},projects/update-card,projects/update_card,patch,project-card,projects,projects,cards,update_card,update,,Update an existing project card +projects.yaml,/projects/columns/{column_id}/cards,projects/create-card,projects/create_card,post,project-card,projects,projects,cards,create_card,insert,,Create a project card +projects.yaml,/projects/columns/cards/{card_id}/moves,projects/move-card,projects/move_card,post,,projects,projects,cards,move_card,exec,,Move a project card +projects.yaml,/projects/{project_id}/collaborators/{username},projects/remove-collaborator,projects/remove_collaborator,delete,,projects,projects,collaborators,remove_collaborator,delete,,Remove user as a collaborator +projects.yaml,/projects/{project_id}/collaborators/{username}/permission,projects/get-permission-for-user,projects/get_permission_for_user,get,project-collaborator-permission,projects,projects,collaborators,get_permission_for_user,select,,Get project permission for a user +projects.yaml,/projects/{project_id}/collaborators,projects/list-collaborators,projects/list_collaborators,get,simple-user,projects,projects,collaborators,list_collaborators,select,,List project collaborators +projects.yaml,/projects/{project_id}/collaborators/{username},projects/add-collaborator,projects/add_collaborator,put,,projects,projects,collaborators,add_collaborator,insert,,Add project collaborator +projects.yaml,/projects/columns/{column_id},projects/delete-column,projects/delete_column,delete,,projects,projects,columns,delete_column,delete,,Delete a project column +projects.yaml,/projects/columns/{column_id},projects/get-column,projects/get_column,get,project-column,projects,projects,columns,get_column,select,,Get a project column +projects.yaml,/projects/{project_id}/columns,projects/list-columns,projects/list_columns,get,project-column,projects,projects,columns,list_columns,select,,List project columns +projects.yaml,/projects/columns/{column_id},projects/update-column,projects/update_column,patch,project-column,projects,projects,columns,update_column,update,,Update an existing project column +projects.yaml,/projects/{project_id}/columns,projects/create-column,projects/create_column,post,project-column,projects,projects,columns,create_column,insert,,Create a project column +projects.yaml,/projects/columns/{column_id}/moves,projects/move-column,projects/move_column,post,,projects,projects,columns,move_column,exec,,Move a project column +projects.yaml,/orgs/{org}/projectsV2/{project_number}/drafts,projects/create-draft-item-for-org,projects/create_draft_item_for_org,post,,projects,projects,project_draft_items,create_draft_item_for_org,insert,,Create draft item for organization owned project +projects.yaml,/orgs/{org}/projectsV2/{project_number}/fields/{field_id},projects/get-field-for-org,projects/get_field_for_org,get,,projects,projects,project_fields,get_field_for_org,select,,Get project field for organization +projects.yaml,/users/{username}/projectsV2/{project_number}/fields/{field_id},projects/get-field-for-user,projects/get_field_for_user,get,,projects,projects,project_fields,get_field_for_user,select,,Get project field for user +projects.yaml,/orgs/{org}/projectsV2/{project_number}/fields,projects/list-fields-for-org,projects/list_fields_for_org,get,,projects,projects,project_fields,list_fields_for_org,select,,List project fields for organization +projects.yaml,/users/{username}/projectsV2/{project_number}/fields,projects/list-fields-for-user,projects/list_fields_for_user,get,,projects,projects,project_fields,list_fields_for_user,select,,List project fields for user +projects.yaml,/orgs/{org}/projectsV2/{project_number}/fields,projects/add-field-for-org,projects/add_field_for_org,post,,projects,projects,project_fields,add_field_for_org,insert,,Add a field to an organization-owned project. +projects.yaml,/users/{username}/projectsV2/{project_number}/fields,projects/add-field-for-user,projects/add_field_for_user,post,,projects,projects,project_fields,add_field_for_user,insert,,Add field to user owned project +projects.yaml,/orgs/{org}/projectsV2/{project_number}/items/{item_id},projects/delete-item-for-org,projects/delete_item_for_org,delete,,projects,projects,project_items,delete_item_for_org,delete,,Delete project item for organization +projects.yaml,/users/{username}/projectsV2/{project_number}/items/{item_id},projects/delete-item-for-user,projects/delete_item_for_user,delete,,projects,projects,project_items,delete_item_for_user,delete,,Delete project item for user +projects.yaml,/orgs/{org}/projectsV2/{project_number}/items/{item_id},projects/get-org-item,projects/get_org_item,get,,projects,projects,project_items,get_org_item,select,,Get an item for an organization owned project +projects.yaml,/users/{username}/projectsV2/{project_number}/items/{item_id},projects/get-user-item,projects/get_user_item,get,,projects,projects,project_items,get_user_item,select,,Get an item for a user owned project +projects.yaml,/orgs/{org}/projectsV2/{project_number}/items,projects/list-items-for-org,projects/list_items_for_org,get,,projects,projects,project_items,list_items_for_org,select,,List items for an organization owned project +projects.yaml,/users/{username}/projectsV2/{project_number}/items,projects/list-items-for-user,projects/list_items_for_user,get,,projects,projects,project_items,list_items_for_user,select,,List items for a user owned project +projects.yaml,/orgs/{org}/projectsV2/{project_number}/items/{item_id},projects/update-item-for-org,projects/update_item_for_org,patch,,projects,projects,project_items,update_item_for_org,update,,Update project item for organization +projects.yaml,/users/{username}/projectsV2/{project_number}/items/{item_id},projects/update-item-for-user,projects/update_item_for_user,patch,,projects,projects,project_items,update_item_for_user,update,,Update project item for user +projects.yaml,/orgs/{org}/projectsV2/{project_number}/items,projects/add-item-for-org,projects/add_item_for_org,post,,projects,projects,project_items,add_item_for_org,insert,,Add item to organization owned project +projects.yaml,/users/{username}/projectsV2/{project_number}/items,projects/add-item-for-user,projects/add_item_for_user,post,,projects,projects,project_items,add_item_for_user,insert,,Add item to user owned project +projects.yaml,/user/{user_id}/projectsV2/{project_number}/drafts,projects/create-draft-item-for-authenticated-user,projects/create_draft_item_for_authenticated_user,post,,projects,projects,project_items,create_draft_item_for_authenticated_user,insert,,Create draft item for user owned project +projects.yaml,/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items,projects/list-view-items-for-org,projects/list_view_items_for_org,get,,projects,projects,project_view_items,list_view_items_for_org,select,,List items for an organization project view +projects.yaml,/users/{username}/projectsV2/{project_number}/views/{view_number}/items,projects/list-view-items-for-user,projects/list_view_items_for_user,get,,projects,projects,project_view_items,list_view_items_for_user,select,,List items for a user project view +projects.yaml,/orgs/{org}/projectsV2/{project_number}/views,projects/create-view-for-org,projects/create_view_for_org,post,,projects,projects,project_views,create_view_for_org,insert,,Create a view for an organization-owned project +projects.yaml,/users/{user_id}/projectsV2/{project_number}/views,projects/create-view-for-user,projects/create_view_for_user,post,,projects,projects,project_views,create_view_for_user,insert,,Create a view for a user-owned project +projects.yaml,/projects/{project_id},projects/delete,projects/delete,delete,,projects,projects,projects,delete,delete,,Delete a project +projects.yaml,/projects/{project_id},projects/get,projects/get,get,project,projects,projects,projects,get,select,,Get a project +projects.yaml,/orgs/{org}/projectsV2/{project_number},projects/get-for-org,projects/get_for_org,get,,projects,projects,projects,get_for_org,select,,Get project for organization +projects.yaml,/users/{username}/projectsV2/{project_number},projects/get-for-user,projects/get_for_user,get,,projects,projects,projects,get_for_user,select,,Get project for user +projects.yaml,/orgs/{org}/projectsV2,projects/list-for-org,projects/list_for_org,get,project,projects,projects,projects,list_for_org,select,,List organization projects +projects.yaml,/repos/{owner}/{repo}/projects,projects/list-for-repo,projects/list_for_repo,get,project,projects,projects,projects,list_for_repo,select,,List repository projects +projects.yaml,/users/{username}/projectsV2,projects/list-for-user,projects/list_for_user,get,project,projects,projects,projects,list_for_user,select,,List user projects +projects.yaml,/projects/{project_id},projects/update,projects/update,patch,project,projects,projects,projects,update,update,,Update a project +projects.yaml,/user/projects,projects/create-for-authenticated-user,projects/create_for_authenticated_user,post,project,projects,projects,projects,create_for_authenticated_user,insert,,Create a user project +projects.yaml,/orgs/{org}/projects,projects/create-for-org,projects/create_for_org,post,project,projects,projects,projects,create_for_org,insert,,Create an organization project +projects.yaml,/repos/{owner}/{repo}/projects,projects/create-for-repo,projects/create_for_repo,post,project,projects,projects,projects,create_for_repo,insert,,Create a repository project +pulls.yaml,/repos/{owner}/{repo}/pulls/comments/{comment_id},pulls/delete-review-comment,pulls/delete_review_comment,delete,,pulls,pulls,comments,delete_review_comment,delete,,Delete a review comment for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/comments/{comment_id},pulls/get-review-comment,pulls/get_review_comment,get,pull-request-review-comment,pulls,pulls,comments,get_review_comment,select,,Get a review comment for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/comments,pulls/list-review-comments,pulls/list_review_comments,get,pull-request-review-comment,pulls,pulls,comments,list_review_comments,select,,List review comments on a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/comments,pulls/list-review-comments-for-repo,pulls/list_review_comments_for_repo,get,pull-request-review-comment,pulls,pulls,comments,list_review_comments_for_repo,select,,List review comments in a repository +pulls.yaml,/repos/{owner}/{repo}/pulls/comments/{comment_id},pulls/update-review-comment,pulls/update_review_comment,patch,pull-request-review-comment,pulls,pulls,comments,update_review_comment,update,,Update a review comment for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies,pulls/create-reply-for-review-comment,pulls/create_reply_for_review_comment,post,pull-request-review-comment,pulls,pulls,comments,create_reply_for_review_comment,insert,,Create a reply for a review comment +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/comments,pulls/create-review-comment,pulls/create_review_comment,post,pull-request-review-comment,pulls,pulls,comments,create_review_comment,insert,,Create a review comment for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments,pulls/list-comments-for-review,pulls/list_comments_for_review,get,review-comment,pulls,pulls,comments_for_review,list_comments_for_review,select,,List comments for a pull request review +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/commits,pulls/list-commits,pulls/list_commits,get,commit,pulls,pulls,commits,list_commits,select,,List commits on a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/files,pulls/list-files,pulls/list_files,get,diff-entry,pulls,pulls,files,list_files,select,,List pull requests files +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/merge,pulls/check-if-merged,pulls/check_if_merged,get,,pulls,pulls,pull_request,check_if_merged,exec,,Check if a pull request has been merged +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number},pulls/get,pulls/get,get,pull-request,pulls,pulls,pull_request,get,select,,Get a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number},pulls/update,pulls/update,patch,pull-request,pulls,pulls,pull_request,update,update,,Update a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls,pulls/create,pulls/create,post,pull-request,pulls,pulls,pull_request,create,insert,,Create a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/merge,pulls/merge,pulls/merge,put,pull-request-merge-result,pulls,pulls,pull_request,merge,exec,,Merge a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/update-branch,pulls/update-branch,pulls/update_branch,put,,pulls,pulls,pull_request,update_branch,exec,,Update a pull request branch +pulls.yaml,/repos/{owner}/{repo}/pulls,pulls/list,pulls/list,get,pull-request-simple,pulls,pulls,pull_requests,list,select,,List pull requests +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers,pulls/remove-requested-reviewers,pulls/remove_requested_reviewers,delete,pull-request-simple,pulls,pulls,review_requests,remove_requested_reviewers,delete,,Remove requested reviewers from a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers,pulls/list-requested-reviewers,pulls/list_requested_reviewers,get,pull-request-review-request,pulls,pulls,review_requests,list_requested_reviewers,select,,Get all requested reviewers for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers,pulls/request-reviewers,pulls/request_reviewers,post,pull-request-simple,pulls,pulls,review_requests,request_reviewers,insert,,Request reviewers for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id},pulls/delete-pending-review,pulls/delete_pending_review,delete,pull-request-review,pulls,pulls,reviews,delete_pending_review,delete,,Delete a pending review for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id},pulls/get-review,pulls/get_review,get,pull-request-review,pulls,pulls,reviews,get_review,select,,Get a review for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews,pulls/list-reviews,pulls/list_reviews,get,pull-request-review,pulls,pulls,reviews,list_reviews,select,,List reviews for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews,pulls/create-review,pulls/create_review,post,pull-request-review,pulls,pulls,reviews,create_review,insert,,Create a review for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events,pulls/submit-review,pulls/submit_review,post,pull-request-review,pulls,pulls,reviews,submit_review,exec,,Submit a review for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals,pulls/dismiss-review,pulls/dismiss_review,put,pull-request-review,pulls,pulls,reviews,dismiss_review,exec,,Dismiss a review for a pull request +pulls.yaml,/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id},pulls/update-review,pulls/update_review,put,pull-request-review,pulls,pulls,reviews,update_review,replace,,Update a review for a pull request +rate_limit.yaml,/rate_limit,rate-limit/get,rate_limit/get,get,rate-limit-overview,rate-limit,rate_limit,rate_limit,get,select,,Get rate limit status for the authenticated user +reactions.yaml,/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id},reactions/delete-for-commit-comment,reactions/delete_for_commit_comment,delete,,reactions,reactions,commit_comments,delete_for_commit_comment,delete,,Delete a commit comment reaction +reactions.yaml,/repos/{owner}/{repo}/comments/{comment_id}/reactions,reactions/list-for-commit-comment,reactions/list_for_commit_comment,get,reaction,reactions,reactions,commit_comments,list_for_commit_comment,select,,List reactions for a commit comment +reactions.yaml,/repos/{owner}/{repo}/comments/{comment_id}/reactions,reactions/create-for-commit-comment,reactions/create_for_commit_comment,post,reaction,reactions,reactions,commit_comments,create_for_commit_comment,insert,,Create reaction for a commit comment +reactions.yaml,/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id},reactions/delete-for-issue,reactions/delete_for_issue,delete,,reactions,reactions,issue_comments,delete_for_issue,delete,,Delete an issue reaction +reactions.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id},reactions/delete-for-issue-comment,reactions/delete_for_issue_comment,delete,,reactions,reactions,issue_comments,delete_for_issue_comment,delete,,Delete an issue comment reaction +reactions.yaml,/repos/{owner}/{repo}/issues/{issue_number}/reactions,reactions/list-for-issue,reactions/list_for_issue,get,reaction,reactions,reactions,issue_comments,list_for_issue,select,,List reactions for an issue +reactions.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions,reactions/list-for-issue-comment,reactions/list_for_issue_comment,get,reaction,reactions,reactions,issue_comments,list_for_issue_comment,select,,List reactions for an issue comment +reactions.yaml,/repos/{owner}/{repo}/issues/{issue_number}/reactions,reactions/create-for-issue,reactions/create_for_issue,post,reaction,reactions,reactions,issue_comments,create_for_issue,insert,,Create reaction for an issue +reactions.yaml,/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions,reactions/create-for-issue-comment,reactions/create_for_issue_comment,post,reaction,reactions,reactions,issue_comments,create_for_issue_comment,insert,,Create reaction for an issue comment +reactions.yaml,/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id},reactions/delete-for-pull-request-comment,reactions/delete_for_pull_request_comment,delete,,reactions,reactions,pr_comments,delete_for_pull_request_comment,delete,,Delete a pull request comment reaction +reactions.yaml,/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions,reactions/list-for-pull-request-review-comment,reactions/list_for_pull_request_review_comment,get,reaction,reactions,reactions,pr_comments,list_for_pull_request_review_comment,select,,List reactions for a pull request review comment +reactions.yaml,/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions,reactions/create-for-pull-request-review-comment,reactions/create_for_pull_request_review_comment,post,reaction,reactions,reactions,pr_comments,create_for_pull_request_review_comment,insert,,Create reaction for a pull request review comment +reactions.yaml,/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id},reactions/delete-for-release,reactions/delete_for_release,delete,,reactions,reactions,release_comments,delete_for_release,delete,,Delete a release reaction +reactions.yaml,/repos/{owner}/{repo}/releases/{release_id}/reactions,reactions/list-for-release,reactions/list_for_release,get,reaction,reactions,reactions,release_comments,list_for_release,select,,List reactions for a release +reactions.yaml,/repos/{owner}/{repo}/releases/{release_id}/reactions,reactions/create-for-release,reactions/create_for_release,post,reaction,reactions,reactions,release_comments,create_for_release,insert,,Create reaction for a release +reactions.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id},reactions/delete-for-team-discussion,reactions/delete_for_team_discussion,delete,,reactions,reactions,team_discussions,delete_for_team_discussion,delete,,Delete team discussion reaction +reactions.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id},reactions/delete-for-team-discussion-comment,reactions/delete_for_team_discussion_comment,delete,,reactions,reactions,team_discussions,delete_for_team_discussion_comment,delete,,Delete team discussion comment reaction +reactions.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions,reactions/list-for-team-discussion-comment-in-org,reactions/list_for_team_discussion_comment_in_org,get,reaction,reactions,reactions,team_discussions,list_for_team_discussion_comment_in_org,select,,List reactions for a team discussion comment +reactions.yaml,/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions,reactions/list-for-team-discussion-comment-legacy,reactions/list_for_team_discussion_comment_legacy,get,reaction,reactions,reactions,team_discussions,list_for_team_discussion_comment_legacy,select,,List reactions for a team discussion comment (Legacy) +reactions.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions,reactions/list-for-team-discussion-in-org,reactions/list_for_team_discussion_in_org,get,reaction,reactions,reactions,team_discussions,list_for_team_discussion_in_org,select,,List reactions for a team discussion +reactions.yaml,/teams/{team_id}/discussions/{discussion_number}/reactions,reactions/list-for-team-discussion-legacy,reactions/list_for_team_discussion_legacy,get,reaction,reactions,reactions,team_discussions,list_for_team_discussion_legacy,select,,List reactions for a team discussion (Legacy) +reactions.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions,reactions/create-for-team-discussion-comment-in-org,reactions/create_for_team_discussion_comment_in_org,post,reaction,reactions,reactions,team_discussions,create_for_team_discussion_comment_in_org,insert,,Create reaction for a team discussion comment +reactions.yaml,/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions,reactions/create-for-team-discussion-comment-legacy,reactions/create_for_team_discussion_comment_legacy,post,reaction,reactions,reactions,team_discussions,create_for_team_discussion_comment_legacy,insert,,Create reaction for a team discussion comment (Legacy) +reactions.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions,reactions/create-for-team-discussion-in-org,reactions/create_for_team_discussion_in_org,post,reaction,reactions,reactions,team_discussions,create_for_team_discussion_in_org,insert,,Create reaction for a team discussion +reactions.yaml,/teams/{team_id}/discussions/{discussion_number}/reactions,reactions/create-for-team-discussion-legacy,reactions/create_for_team_discussion_legacy,post,reaction,reactions,reactions,team_discussions,create_for_team_discussion_legacy,insert,,Create reaction for a team discussion (Legacy) +repos.yaml,/repos/{owner}/{repo}/activity,repos/list-activities,repos/list_activities,get,activity,repos,repos,activities,list_activities,select,,List repository activities +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins,repos/delete-admin-branch-protection,repos/delete_admin_branch_protection,delete,,repos,repos,admin_branch_protection,delete_admin_branch_protection,delete,,Delete admin branch protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins,repos/get-admin-branch-protection,repos/get_admin_branch_protection,get,protected-branch-admin-enforced,repos,repos,admin_branch_protection,get_admin_branch_protection,select,,Get admin branch protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins,repos/set-admin-branch-protection,repos/set_admin_branch_protection,post,protected-branch-admin-enforced,repos,repos,admin_branch_protection,set_admin_branch_protection,replace,,Set admin branch protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps,repos/remove-app-access-restrictions,repos/remove_app_access_restrictions,delete,integration,repos,repos,app_access_restrictions,remove_app_access_restrictions,delete,,Remove app access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps,repos/get-apps-with-access-to-protected-branch,repos/get_apps_with_access_to_protected_branch,get,integration,repos,repos,app_access_restrictions,get_apps_with_access_to_protected_branch,select,,Get apps with access to the protected branch +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps,repos/add-app-access-restrictions,repos/add_app_access_restrictions,post,integration,repos,repos,app_access_restrictions,add_app_access_restrictions,insert,,Add app access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps,repos/set-app-access-restrictions,repos/set_app_access_restrictions,put,integration,repos,repos,app_access_restrictions,set_app_access_restrictions,replace,,Set app access restrictions +repos.yaml,/repos/{owner}/{repo}/releases/assets/{asset_id},repos/delete-release-asset,repos/delete_release_asset,delete,,repos,repos,assets,delete_release_asset,delete,,Delete a release asset +repos.yaml,/repos/{owner}/{repo}/releases/assets/{asset_id},repos/get-release-asset,repos/get_release_asset,get,release-asset,repos,repos,assets,get_release_asset,select,,Get a release asset +repos.yaml,/repos/{owner}/{repo}/releases/{release_id}/assets,repos/list-release-assets,repos/list_release_assets,get,release-asset,repos,repos,assets,list_release_assets,select,,List release assets +repos.yaml,/repos/{owner}/{repo}/releases/assets/{asset_id},repos/update-release-asset,repos/update_release_asset,patch,release-asset,repos,repos,assets,update_release_asset,update,,Update a release asset +repos.yaml,/repos/{owner}/{repo}/releases/{release_id}/assets,repos/upload-release-asset,repos/upload_release_asset,post,release-asset,repos,repos,assets,upload_release_asset,insert,,Upload a release asset +repos.yaml,/repos/{owner}/{repo}/attestations/{subject_digest},repos/list-attestations,repos/list_attestations,get,,repos,repos,attestations,list_attestations,select,$.attestations,List attestations +repos.yaml,/repos/{owner}/{repo}/attestations,repos/create-attestation,repos/create_attestation,post,,repos,repos,attestations,create_attestation,insert,,Create an attestation +repos.yaml,/repos/{owner}/{repo}/autolinks/{autolink_id},repos/delete-autolink,repos/delete_autolink,delete,,repos,repos,autolinks,delete_autolink,delete,,Delete an autolink reference from a repository +repos.yaml,/repos/{owner}/{repo}/autolinks/{autolink_id},repos/get-autolink,repos/get_autolink,get,autolink,repos,repos,autolinks,get_autolink,select,,Get an autolink reference of a repository +repos.yaml,/repos/{owner}/{repo}/autolinks,repos/list-autolinks,repos/list_autolinks,get,autolink,repos,repos,autolinks,list_autolinks,select,,List all autolinks of a repository +repos.yaml,/repos/{owner}/{repo}/autolinks,repos/create-autolink,repos/create_autolink,post,autolink,repos,repos,autolinks,create_autolink,insert,,Create an autolink reference for a repository +repos.yaml,/repos/{owner}/{repo}/branches/{branch},repos/get-branch,repos/get_branch,get,branch-with-protection,repos,repos,branch,get_branch,select,,Get a branch +repos.yaml,/repos/{owner}/{repo}/merges,repos/merge,repos/merge,post,commit,repos,repos,branch,merge,exec,,Merge a branch +repos.yaml,/repos/{owner}/{repo}/merge-upstream,repos/merge-upstream,repos/merge_upstream,post,merged-upstream,repos,repos,branch,merge_upstream,exec,,Sync a fork branch with the upstream repository +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/rename,repos/rename-branch,repos/rename_branch,post,branch-with-protection,repos,repos,branch,rename_branch,exec,,Rename a branch +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id},repos/delete-deployment-branch-policy,repos/delete_deployment_branch_policy,delete,,repos,repos,branch_policies,delete_deployment_branch_policy,delete,,Delete a deployment branch policy +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id},repos/get-deployment-branch-policy,repos/get_deployment_branch_policy,get,deployment-branch-policy,repos,repos,branch_policies,get_deployment_branch_policy,select,,Get a deployment branch policy +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies,repos/list-deployment-branch-policies,repos/list_deployment_branch_policies,get,,repos,repos,branch_policies,list_deployment_branch_policies,select,,List deployment branch policies +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies,repos/create-deployment-branch-policy,repos/create_deployment_branch_policy,post,deployment-branch-policy,repos,repos,branch_policies,create_deployment_branch_policy,insert,,Create a deployment branch policy +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id},repos/update-deployment-branch-policy,repos/update_deployment_branch_policy,put,deployment-branch-policy,repos,repos,branch_policies,update_deployment_branch_policy,replace,,Update a deployment branch policy +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection,repos/delete-branch-protection,repos/delete_branch_protection,delete,,repos,repos,branch_protection,delete_branch_protection,delete,,Delete branch protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection,repos/get-branch-protection,repos/get_branch_protection,get,branch-protection,repos,repos,branch_protection,get_branch_protection,select,,Get branch protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection,repos/update-branch-protection,repos/update_branch_protection,put,protected-branch,repos,repos,branch_protection,update_branch_protection,replace,,Update branch protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions,repos/delete-access-restrictions,repos/delete_access_restrictions,delete,,repos,repos,branch_restrictions,delete_access_restrictions,delete,,Delete access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions,repos/get-access-restrictions,repos/get_access_restrictions,get,branch-restriction-policy,repos,repos,branch_restrictions,get_access_restrictions,select,,Get access restrictions +repos.yaml,/repos/{owner}/{repo}/branches,repos/list-branches,repos/list_branches,get,short-branch,repos,repos,branches,list_branches,select,,List branches +repos.yaml,/repos/{owner}/{repo}/traffic/clones,repos/get-clones,repos/get_clones,get,clone-traffic,repos,repos,clone_traffic,get_clones,select,,Get repository clones +repos.yaml,/repos/{owner}/{repo}/codeowners/errors,repos/codeowners-errors,repos/codeowners_errors,get,codeowners-errors,repos,repos,codeowners,codeowners_errors,select,$.errors,List CODEOWNERS errors +repos.yaml,/repos/{owner}/{repo}/collaborators/{username}/permission,repos/get-collaborator-permission-level,repos/get_collaborator_permission_level,get,repository-collaborator-permission,repos,repos,collaborator_permissions,get_collaborator_permission_level,select,,Get repository permissions for a user +repos.yaml,/repos/{owner}/{repo}/collaborators/{username},repos/remove-collaborator,repos/remove_collaborator,delete,,repos,repos,collaborators,remove_collaborator,delete,,Remove a repository collaborator +repos.yaml,/repos/{owner}/{repo}/collaborators/{username},repos/check-collaborator,repos/check_collaborator,get,,repos,repos,collaborators,check_collaborator,exec,,Check if a user is a repository collaborator +repos.yaml,/repos/{owner}/{repo}/collaborators,repos/list-collaborators,repos/list_collaborators,get,collaborator,repos,repos,collaborators,list_collaborators,select,,List repository collaborators +repos.yaml,/repos/{owner}/{repo}/collaborators/{username},repos/add-collaborator,repos/add_collaborator,put,repository-invitation,repos,repos,collaborators,add_collaborator,insert,,Add a repository collaborator +repos.yaml,/repos/{owner}/{repo}/comments/{comment_id},repos/delete-commit-comment,repos/delete_commit_comment,delete,,repos,repos,comments,delete_commit_comment,delete,,Delete a commit comment +repos.yaml,/repos/{owner}/{repo}/comments/{comment_id},repos/get-commit-comment,repos/get_commit_comment,get,commit-comment,repos,repos,comments,get_commit_comment,select,,Get a commit comment +repos.yaml,/repos/{owner}/{repo}/commits/{commit_sha}/comments,repos/list-comments-for-commit,repos/list_comments_for_commit,get,commit-comment,repos,repos,comments,list_comments_for_commit,select,,List commit comments +repos.yaml,/repos/{owner}/{repo}/comments,repos/list-commit-comments-for-repo,repos/list_commit_comments_for_repo,get,commit-comment,repos,repos,comments,list_commit_comments_for_repo,select,,List commit comments for a repository +repos.yaml,/repos/{owner}/{repo}/comments/{comment_id},repos/update-commit-comment,repos/update_commit_comment,patch,commit-comment,repos,repos,comments,update_commit_comment,update,,Update a commit comment +repos.yaml,/repos/{owner}/{repo}/commits/{commit_sha}/comments,repos/create-commit-comment,repos/create_commit_comment,post,commit-comment,repos,repos,comments,create_commit_comment,insert,,Create a commit comment +repos.yaml,/repos/{owner}/{repo}/commits/{commit_sha}/pulls,repos/list-pull-requests-associated-with-commit,repos/list_pull_requests_associated_with_commit,get,pull-request-simple,repos,repos,commit_pr_branches,list_pull_requests_associated_with_commit,select,,List pull requests associated with a commit +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures,repos/delete-commit-signature-protection,repos/delete_commit_signature_protection,delete,,repos,repos,commit_signature_protection,delete_commit_signature_protection,delete,,Delete commit signature protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures,repos/get-commit-signature-protection,repos/get_commit_signature_protection,get,protected-branch-admin-enforced,repos,repos,commit_signature_protection,get_commit_signature_protection,select,,Get commit signature protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures,repos/create-commit-signature-protection,repos/create_commit_signature_protection,post,protected-branch-admin-enforced,repos,repos,commit_signature_protection,create_commit_signature_protection,insert,,Create commit signature protection +repos.yaml,/repos/{owner}/{repo}/compare/{basehead},repos/compare-commits,repos/compare_commits,get,commit-comparison,repos,repos,commits,compare_commits,select,,Compare two commits +repos.yaml,/repos/{owner}/{repo}/commits/{ref},repos/get-commit,repos/get_commit,get,commit,repos,repos,commits,get_commit,select,,Get a commit +repos.yaml,/repos/{owner}/{repo}/commits,repos/list-commits,repos/list_commits,get,commit,repos,repos,commits,list_commits,select,,List commits +repos.yaml,/repos/{owner}/{repo}/community/profile,repos/get-community-profile-metrics,repos/get_community_profile_metrics,get,community-profile,repos,repos,community,get_community_profile_metrics,select,,Get community profile metrics +repos.yaml,/repos/{owner}/{repo}/traffic/popular/paths,repos/get-top-paths,repos/get_top_paths,get,content-traffic,repos,repos,content_traffic,get_top_paths,select,,Get top referral paths +repos.yaml,/repos/{owner}/{repo}/contents/{path},repos/get-content,repos/get_content,get,,repos,repos,content_tree,get_content,select,,Get repository content +repos.yaml,/repos/{owner}/{repo}/contents/{path},repos/delete-file,repos/delete_file,delete,file-commit,repos,repos,contents,delete_file,delete,,Delete a file +repos.yaml,/repos/{owner}/{repo}/readme,repos/get-readme,repos/get_readme,get,content-file,repos,repos,contents,get_readme,select,,Get a repository README +repos.yaml,/repos/{owner}/{repo}/readme/{dir},repos/get-readme-in-directory,repos/get_readme_in_directory,get,content-file,repos,repos,contents,get_readme_in_directory,select,,Get a repository README for a directory +repos.yaml,/repos/{owner}/{repo}/contents/{path},repos/create-or-update-file-contents,repos/create_or_update_file_contents,put,file-commit,repos,repos,contents,create_or_update_file_contents,insert,,Create or update file contents +repos.yaml,/repos/{owner}/{repo}/contributors,repos/list-contributors,repos/list_contributors,get,contributor,repos,repos,contributors,list_contributors,select,,List repository contributors +repos.yaml,/repos/{owner}/{repo}/properties/values,repos/custom-properties-for-repos-get-repository-values,repos/custom_properties_for_repos_get_repository_values,get,,repos,repos,custom_property_values,custom_properties_for_repos_get_repository_values,select,,Get all custom property values for a repository +repos.yaml,/repos/{owner}/{repo}/properties/values,repos/custom-properties-for-repos-create-or-update-repository-values,repos/custom_properties_for_repos_create_or_update_repository_values,patch,,repos,repos,custom_property_values,custom_properties_for_repos_create_or_update_repository_values,update,,Create or update custom property values for a repository +repos.yaml,/repos/{owner}/{repo}/keys/{key_id},repos/delete-deploy-key,repos/delete_deploy_key,delete,,repos,repos,deploy_keys,delete_deploy_key,delete,,Delete a deploy key +repos.yaml,/repos/{owner}/{repo}/keys/{key_id},repos/get-deploy-key,repos/get_deploy_key,get,deploy-key,repos,repos,deploy_keys,get_deploy_key,select,,Get a deploy key +repos.yaml,/repos/{owner}/{repo}/keys,repos/list-deploy-keys,repos/list_deploy_keys,get,deploy-key,repos,repos,deploy_keys,list_deploy_keys,select,,List deploy keys +repos.yaml,/repos/{owner}/{repo}/keys,repos/create-deploy-key,repos/create_deploy_key,post,deploy-key,repos,repos,deploy_keys,create_deploy_key,insert,,Create a deploy key +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps,repos/list-custom-deployment-rule-integrations,repos/list_custom_deployment_rule_integrations,get,,repos,repos,deployment_rule_integrations,list_custom_deployment_rule_integrations,select,,List custom deployment rule integrations available for an environment +repos.yaml,/repos/{owner}/{repo}/deployments/{deployment_id},repos/delete-deployment,repos/delete_deployment,delete,,repos,repos,deployments,delete_deployment,delete,,Delete a deployment +repos.yaml,/repos/{owner}/{repo}/deployments/{deployment_id},repos/get-deployment,repos/get_deployment,get,deployment,repos,repos,deployments,get_deployment,select,,Get a deployment +repos.yaml,/repos/{owner}/{repo}/deployments,repos/list-deployments,repos/list_deployments,get,deployment,repos,repos,deployments,list_deployments,select,,List deployments +repos.yaml,/repos/{owner}/{repo}/deployments,repos/create-deployment,repos/create_deployment,post,deployment,repos,repos,deployments,create_deployment,insert,,Create a deployment +repos.yaml,/repos/{owner}/{repo},repos/get,repos/get,get,full-repository,repos,repos,details,get,select,,Get a repository +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name},repos/delete-an-environment,repos/delete_an_environment,delete,,repos,repos,environments,delete_an_environment,delete,,Delete an environment +repos.yaml,/repos/{owner}/{repo}/environments,repos/get-all-environments,repos/get_all_environments,get,,repos,repos,environments,get_all_environments,select,,List environments +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name},repos/get-environment,repos/get_environment,get,environment,repos,repos,environments,get_environment,select,,Get an environment +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name},repos/create-or-update-environment,repos/create_or_update_environment,put,environment,repos,repos,environments,create_or_update_environment,insert,,Create or update an environment +repos.yaml,/repos/{owner}/{repo}/forks,repos/list-forks,repos/list_forks,get,minimal-repository,repos,repos,forks,list_forks,select,,List forks +repos.yaml,/repos/{owner}/{repo}/forks,repos/create-fork,repos/create_fork,post,full-repository,repos,repos,forks,create_fork,insert,,Create a fork +repos.yaml,/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head,repos/list-branches-for-head-commit,repos/list_branches_for_head_commit,get,branch-short,repos,repos,head_commit_branches,list_branches_for_head_commit,select,,List branches for HEAD commit +repos.yaml,/user/repository_invitations/{invitation_id},repos/decline-invitation-for-authenticated-user,repos/decline_invitation_for_authenticated_user,delete,,repos,repos,invitations,decline_invitation_for_authenticated_user,exec,,Decline a repository invitation +repos.yaml,/repos/{owner}/{repo}/invitations/{invitation_id},repos/delete-invitation,repos/delete_invitation,delete,,repos,repos,invitations,delete_invitation,delete,,Delete a repository invitation +repos.yaml,/repos/{owner}/{repo}/invitations,repos/list-invitations,repos/list_invitations,get,repository-invitation,repos,repos,invitations,list_invitations,select,,List repository invitations +repos.yaml,/user/repository_invitations,repos/list-invitations-for-authenticated-user,repos/list_invitations_for_authenticated_user,get,repository-invitation,repos,repos,invitations,list_invitations_for_authenticated_user,select,,List repository invitations for the authenticated user +repos.yaml,/user/repository_invitations/{invitation_id},repos/accept-invitation-for-authenticated-user,repos/accept_invitation_for_authenticated_user,patch,,repos,repos,invitations,accept_invitation_for_authenticated_user,exec,,Accept a repository invitation +repos.yaml,/repos/{owner}/{repo}/invitations/{invitation_id},repos/update-invitation,repos/update_invitation,patch,repository-invitation,repos,repos,invitations,update_invitation,update,,Update a repository invitation +repos.yaml,/repos/{owner}/{repo}/pages/builds/latest,repos/get-latest-pages-build,repos/get_latest_pages_build,get,page-build,repos,repos,page_build_latest,get_latest_pages_build,select,,Get latest Pages build +repos.yaml,/repos/{owner}/{repo}/pages/builds/{build_id},repos/get-pages-build,repos/get_pages_build,get,page-build,repos,repos,page_builds,get_pages_build,select,,Get GitHub Pages build +repos.yaml,/repos/{owner}/{repo}/pages/builds,repos/list-pages-builds,repos/list_pages_builds,get,page-build,repos,repos,page_builds,list_pages_builds,select,,List GitHub Pages builds +repos.yaml,/repos/{owner}/{repo}/pages/deployments,repos/create-pages-deployment,repos/create_pages_deployment,post,page-deployment,repos,repos,page_builds,create_pages_deployment,insert,,Create a GitHub Pages deployment +repos.yaml,/repos/{owner}/{repo}/pages/builds,repos/request-pages-build,repos/request_pages_build,post,page-build-status,repos,repos,page_builds,request_pages_build,exec,,Request a GitHub Pages build +repos.yaml,/repos/{owner}/{repo}/pages,repos/delete-pages-site,repos/delete_pages_site,delete,,repos,repos,pages,delete_pages_site,delete,,Delete a GitHub Pages site +repos.yaml,/repos/{owner}/{repo}/pages,repos/get-pages,repos/get_pages,get,page,repos,repos,pages,get_pages,select,,Get a GitHub Pages site +repos.yaml,/repos/{owner}/{repo}/pages,repos/create-pages-site,repos/create_pages_site,post,page,repos,repos,pages,create_pages_site,insert,,Create a GitHub Pages site +repos.yaml,/repos/{owner}/{repo}/pages,repos/update-information-about-pages-site,repos/update_information_about_pages_site,put,,repos,repos,pages,update_information_about_pages_site,replace,,Update information about a GitHub Pages site +repos.yaml,/repos/{owner}/{repo}/pages/health,repos/get-pages-health-check,repos/get_pages_health_check,get,pages-health-check,repos,repos,pages_health_check,get_pages_health_check,select,,Get a DNS health check for GitHub Pages +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews,repos/delete-pull-request-review-protection,repos/delete_pull_request_review_protection,delete,,repos,repos,pr_review_protection,delete_pull_request_review_protection,delete,,Delete pull request review protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews,repos/get-pull-request-review-protection,repos/get_pull_request_review_protection,get,protected-branch-pull-request-review,repos,repos,pr_review_protection,get_pull_request_review_protection,select,,Get pull request review protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews,repos/update-pull-request-review-protection,repos/update_pull_request_review_protection,patch,protected-branch-pull-request-review,repos,repos,pr_review_protection,update_pull_request_review_protection,update,,Update pull request review protection +repos.yaml,/repos/{owner}/{repo}/private-vulnerability-reporting,repos/disable-private-vulnerability-reporting,repos/disable_private_vulnerability_reporting,delete,,repos,repos,private_vulnerability_reporting,disable_private_vulnerability_reporting,exec,,Disable private vulnerability reporting for a repository +repos.yaml,/repos/{owner}/{repo}/private-vulnerability-reporting,repos/check-private-vulnerability-reporting,repos/check_private_vulnerability_reporting,get,,repos,repos,private_vulnerability_reporting,check_private_vulnerability_reporting,select,,Check if private vulnerability reporting is enabled for a repository +repos.yaml,/repos/{owner}/{repo}/private-vulnerability-reporting,repos/enable-private-vulnerability-reporting,repos/enable_private_vulnerability_reporting,put,,repos,repos,private_vulnerability_reporting,enable_private_vulnerability_reporting,exec,,Enable private vulnerability reporting for a repository +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id},repos/disable-deployment-protection-rule,repos/disable_deployment_protection_rule,delete,,repos,repos,protection_rules,disable_deployment_protection_rule,delete,,Disable a custom protection rule for an environment +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules,repos/get-all-deployment-protection-rules,repos/get_all_deployment_protection_rules,get,,repos,repos,protection_rules,get_all_deployment_protection_rules,select,,Get all deployment protection rules for an environment +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id},repos/get-custom-deployment-protection-rule,repos/get_custom_deployment_protection_rule,get,deployment-protection-rule,repos,repos,protection_rules,get_custom_deployment_protection_rule,select,,Get a custom deployment protection rule +repos.yaml,/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules,repos/create-deployment-protection-rule,repos/create_deployment_protection_rule,post,deployment-protection-rule,repos,repos,protection_rules,create_deployment_protection_rule,insert,,Create a custom deployment protection rule on an environment +repos.yaml,/repos/{owner}/{repo}/traffic/popular/referrers,repos/get-top-referrers,repos/get_top_referrers,get,referrer-traffic,repos,repos,referrer_traffic,get_top_referrers,select,,Get top referral sources +repos.yaml,/repos/{owner}/{repo}/releases/{release_id},repos/delete-release,repos/delete_release,delete,,repos,repos,releases,delete_release,delete,,Delete a release +repos.yaml,/repos/{owner}/{repo}/releases/{release_id},repos/get-release,repos/get_release,get,release,repos,repos,releases,get_release,select,,Get a release +repos.yaml,/repos/{owner}/{repo}/releases/tags/{tag},repos/get-release-by-tag,repos/get_release_by_tag,get,release,repos,repos,releases,get_release_by_tag,select,,Get a release by tag name +repos.yaml,/repos/{owner}/{repo}/releases,repos/list-releases,repos/list_releases,get,release,repos,repos,releases,list_releases,select,,List releases +repos.yaml,/repos/{owner}/{repo}/releases/{release_id},repos/update-release,repos/update_release,patch,release,repos,repos,releases,update_release,update,,Update a release +repos.yaml,/repos/{owner}/{repo}/releases,repos/create-release,repos/create_release,post,release,repos,repos,releases,create_release,insert,,Create a release +repos.yaml,/repos/{owner}/{repo}/releases/generate-notes,repos/generate-release-notes,repos/generate_release_notes,post,release-notes-content,repos,repos,releases,generate_release_notes,exec,,Generate release notes content for a release +repos.yaml,/repos/{owner}/{repo}/releases/latest,repos/get-latest-release,repos/get_latest_release,get,release,repos,repos,releases_latest,get_latest_release,select,,Get the latest release +repos.yaml,/repos/{owner}/{repo}/immutable-releases,repos/disable-immutable-releases,repos/disable_immutable_releases,delete,,repos,repos,repo_immutable_releases,disable_immutable_releases,delete,,Disable immutable releases +repos.yaml,/repos/{owner}/{repo}/immutable-releases,repos/check-immutable-releases,repos/check_immutable_releases,get,,repos,repos,repo_immutable_releases,check_immutable_releases,select,,Check if immutable releases are enabled for a repository +repos.yaml,/repos/{owner}/{repo}/immutable-releases,repos/enable-immutable-releases,repos/enable_immutable_releases,put,,repos,repos,repo_immutable_releases,enable_immutable_releases,replace,,Enable immutable releases +repos.yaml,/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id},repos/get-pages-deployment,repos/get_pages_deployment,get,,repos,repos,repo_pages_deployments,get_pages_deployment,select,,Get the status of a GitHub Pages deployment +repos.yaml,/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel,repos/cancel-pages-deployment,repos/cancel_pages_deployment,post,,repos,repos,repo_pages_deployments,cancel_pages_deployment,insert,,Cancel a GitHub Pages deployment +repos.yaml,/repos/{owner}/{repo},repos/delete,repos/delete,delete,,repos,repos,repos,delete,delete,,Delete a repository +repos.yaml,/orgs/{org}/repos,repos/list-for-org,repos/list_for_org,get,minimal-repository,repos,repos,repos,list_for_org,select,,List organization repositories +repos.yaml,/users/{username}/repos,repos/list-for-user,repos/list_for_user,get,minimal-repository,repos,repos,repos,list_for_user,select,,List repositories for a user +repos.yaml,/repos/{owner}/{repo}/languages,repos/list-languages,repos/list_languages,get,language,repos,repos,repos,list_languages,exec,,List repository languages +repos.yaml,/repositories,repos/list-public,repos/list_public,get,minimal-repository,repos,repos,repos,list_public,select,,List public repositories +repos.yaml,/repos/{owner}/{repo},repos/update,repos/update,patch,full-repository,repos,repos,repos,update,update,,Update a repository +repos.yaml,/orgs/{org}/repos,repos/create-in-org,repos/create_in_org,post,repository,repos,repos,repos,create_in_org,insert,,Create an organization repository +repos.yaml,/repos/{template_owner}/{template_repo}/generate,repos/create-using-template,repos/create_using_template,post,repository,repos,repos,repos,create_using_template,insert,,Create a repository using a template +repos.yaml,/repos/{owner}/{repo}/transfer,repos/transfer,repos/transfer,post,minimal-repository,repos,repos,repos,transfer,exec,,Transfer a repository +repos.yaml,/user/repos,repos/list-for-authenticated-user,repos/list_for_authenticated_user,get,repository,repos,repos,repos_for_auth_user,list_for_authenticated_user,select,,List repositories for the authenticated user +repos.yaml,/user/repos,repos/create-for-authenticated-user,repos/create_for_authenticated_user,post,repository,repos,repos,repos_for_auth_user,create_for_authenticated_user,insert,,Create a repository for the authenticated user +repos.yaml,/repos/{owner}/{repo}/dispatches,repos/create-dispatch-event,repos/create_dispatch_event,post,,repos,repos,repository_dispatches,create_dispatch_event,insert,,Create a repository dispatch event +repos.yaml,/orgs/{org}/rulesets/rule-suites/{rule_suite_id},repos/get-org-rule-suite,repos/get_org_rule_suite,get,,repos,repos,rule_suites,get_org_rule_suite,select,,Get an organization rule suite +repos.yaml,/orgs/{org}/rulesets/rule-suites,repos/get-org-rule-suites,repos/get_org_rule_suites,get,,repos,repos,rule_suites,get_org_rule_suites,select,,List organization rule suites +repos.yaml,/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id},repos/get-repo-rule-suite,repos/get_repo_rule_suite,get,,repos,repos,rule_suites,get_repo_rule_suite,select,,Get a repository rule suite +repos.yaml,/repos/{owner}/{repo}/rulesets/rule-suites,repos/get-repo-rule-suites,repos/get_repo_rule_suites,get,,repos,repos,rule_suites,get_repo_rule_suites,select,,List repository rule suites +repos.yaml,/orgs/{org}/rulesets/{ruleset_id},repos/delete-org-ruleset,repos/delete_org_ruleset,delete,,repos,repos,rules,delete_org_ruleset,delete,,Delete an organization repository ruleset +repos.yaml,/repos/{owner}/{repo}/rulesets/{ruleset_id},repos/delete-repo-ruleset,repos/delete_repo_ruleset,delete,,repos,repos,rules,delete_repo_ruleset,delete,,Delete a repository ruleset +repos.yaml,/repos/{owner}/{repo}/rules/branches/{branch},repos/get-branch-rules,repos/get_branch_rules,get,repository-rule-detailed,repos,repos,rules,get_branch_rules,select,,Get rules for a branch +repos.yaml,/orgs/{org}/rulesets/{ruleset_id},repos/get-org-ruleset,repos/get_org_ruleset,get,repository-ruleset,repos,repos,rules,get_org_ruleset,select,,Get an organization repository ruleset +repos.yaml,/orgs/{org}/rulesets,repos/get-org-rulesets,repos/get_org_rulesets,get,repository-ruleset,repos,repos,rules,get_org_rulesets,select,,Get all organization repository rulesets +repos.yaml,/repos/{owner}/{repo}/rulesets/{ruleset_id},repos/get-repo-ruleset,repos/get_repo_ruleset,get,repository-ruleset,repos,repos,rules,get_repo_ruleset,select,,Get a repository ruleset +repos.yaml,/repos/{owner}/{repo}/rulesets,repos/get-repo-rulesets,repos/get_repo_rulesets,get,repository-ruleset,repos,repos,rules,get_repo_rulesets,select,,Get all repository rulesets +repos.yaml,/orgs/{org}/rulesets,repos/create-org-ruleset,repos/create_org_ruleset,post,repository-ruleset,repos,repos,rules,create_org_ruleset,insert,,Create an organization repository ruleset +repos.yaml,/repos/{owner}/{repo}/rulesets,repos/create-repo-ruleset,repos/create_repo_ruleset,post,repository-ruleset,repos,repos,rules,create_repo_ruleset,insert,,Create a repository ruleset +repos.yaml,/orgs/{org}/rulesets/{ruleset_id},repos/update-org-ruleset,repos/update_org_ruleset,put,repository-ruleset,repos,repos,rules,update_org_ruleset,replace,,Update an organization repository ruleset +repos.yaml,/repos/{owner}/{repo}/rulesets/{ruleset_id},repos/update-repo-ruleset,repos/update_repo_ruleset,put,repository-ruleset,repos,repos,rules,update_repo_ruleset,replace,,Update a repository ruleset +repos.yaml,/repos/{owner}/{repo}/rulesets/{ruleset_id}/history,repos/get-repo-ruleset-history,repos/get_repo_ruleset_history,get,,repos,repos,ruleset_history,get_repo_ruleset_history,select,,Get repository ruleset history +repos.yaml,/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id},repos/get-repo-ruleset-version,repos/get_repo_ruleset_version,get,,repos,repos,ruleset_history,get_repo_ruleset_version,select,$.state,Get repository ruleset version +repos.yaml,/repos/{owner}/{repo}/automated-security-fixes,repos/disable-automated-security-fixes,repos/disable_automated_security_fixes,delete,,repos,repos,security_fixes,disable_automated_security_fixes,exec,,Disable automated security fixes +repos.yaml,/repos/{owner}/{repo}/automated-security-fixes,repos/check-automated-security-fixes,repos/check_automated_security_fixes,get,check-automated-security-fixes,repos,repos,security_fixes,check_automated_security_fixes,select,,Check if automated security fixes are enabled for a repository +repos.yaml,/repos/{owner}/{repo}/automated-security-fixes,repos/enable-automated-security-fixes,repos/enable_automated_security_fixes,put,,repos,repos,security_fixes,enable_automated_security_fixes,exec,,Enable automated security fixes +repos.yaml,/repos/{owner}/{repo}/tarball/{ref},repos/download-tarball-archive,repos/download_tarball_archive,get,,repos,repos,skip_this_resource,repos/download_tarball_archive,exec,,Download a repository archive (tar) +repos.yaml,/repos/{owner}/{repo}/zipball/{ref},repos/download-zipball-archive,repos/download_zipball_archive,get,,repos,repos,skip_this_resource,repos/download_zipball_archive,exec,,Download a repository archive (zip) +repos.yaml,/repos/{owner}/{repo}/stats/code_frequency,repos/get-code-frequency-stats,repos/get_code_frequency_stats,get,code-frequency-stat,repos,repos,stats_code_frequency,get_code_frequency_stats,select,,Get the weekly commit activity +repos.yaml,/repos/{owner}/{repo}/stats/commit_activity,repos/get-commit-activity-stats,repos/get_commit_activity_stats,get,commit-activity,repos,repos,stats_commit_activity,get_commit_activity_stats,select,,Get the last year of commit activity +repos.yaml,/repos/{owner}/{repo}/stats/contributors,repos/get-contributors-stats,repos/get_contributors_stats,get,contributor-activity,repos,repos,stats_contributors,get_contributors_stats,select,,Get all contributor commit activity +repos.yaml,/repos/{owner}/{repo}/stats/participation,repos/get-participation-stats,repos/get_participation_stats,get,participation-stats,repos,repos,stats_participation,get_participation_stats,select,,Get the weekly commit count +repos.yaml,/repos/{owner}/{repo}/stats/punch_card,repos/get-punch-card-stats,repos/get_punch_card_stats,get,code-frequency-stat,repos,repos,stats_punch_cards,get_punch_card_stats,select,,Get the hourly commit count for each day +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts,repos/remove-status-check-contexts,repos/remove_status_check_contexts,delete,,repos,repos,status_check_contexts,remove_status_check_contexts,delete,,Remove status check contexts +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts,repos/get-all-status-check-contexts,repos/get_all_status_check_contexts,get,,repos,repos,status_check_contexts,get_all_status_check_contexts,select,,Get all status check contexts +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts,repos/add-status-check-contexts,repos/add_status_check_contexts,post,,repos,repos,status_check_contexts,add_status_check_contexts,insert,,Add status check contexts +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts,repos/set-status-check-contexts,repos/set_status_check_contexts,put,,repos,repos,status_check_contexts,set_status_check_contexts,replace,,Set status check contexts +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks,repos/remove-status-check-protection,repos/remove_status_check_protection,delete,,repos,repos,status_check_protection,remove_status_check_protection,delete,,Remove status check protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks,repos/get-status-checks-protection,repos/get_status_checks_protection,get,status-check-policy,repos,repos,status_check_protection,get_status_checks_protection,select,,Get status checks protection +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks,repos/update-status-check-protection,repos/update_status_check_protection,patch,status-check-policy,repos,repos,status_check_protection,update_status_check_protection,update,,Update status check protection +repos.yaml,/repos/{owner}/{repo}/commits/{ref}/status,repos/get-combined-status-for-ref,repos/get_combined_status_for_ref,get,combined-commit-status,repos,repos,status_combined,get_combined_status_for_ref,select,,Get the combined status for a specific reference +repos.yaml,/repos/{owner}/{repo}/commits/{ref}/statuses,repos/list-commit-statuses-for-ref,repos/list_commit_statuses_for_ref,get,status,repos,repos,status_commits,list_commit_statuses_for_ref,select,,List commit statuses for a reference +repos.yaml,/repos/{owner}/{repo}/statuses/{sha},repos/create-commit-status,repos/create_commit_status,post,status,repos,repos,status_commits,create_commit_status,insert,,Create a commit status +repos.yaml,/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id},repos/get-deployment-status,repos/get_deployment_status,get,deployment-status,repos,repos,status_deployments,get_deployment_status,select,,Get a deployment status +repos.yaml,/repos/{owner}/{repo}/deployments/{deployment_id}/statuses,repos/list-deployment-statuses,repos/list_deployment_statuses,get,deployment-status,repos,repos,status_deployments,list_deployment_statuses,select,,List deployment statuses +repos.yaml,/repos/{owner}/{repo}/deployments/{deployment_id}/statuses,repos/create-deployment-status,repos/create_deployment_status,post,deployment-status,repos,repos,status_deployments,create_deployment_status,insert,,Create a deployment status +repos.yaml,/repos/{owner}/{repo}/tags/protection/{tag_protection_id},repos/delete-tag-protection,repos/delete_tag_protection,delete,,repos,repos,tag_protection,delete_tag_protection,delete,,Delete a tag protection state for a repository +repos.yaml,/repos/{owner}/{repo}/tags/protection,repos/list-tag-protection,repos/list_tag_protection,get,tag-protection,repos,repos,tag_protection,list_tag_protection,select,,List tag protection states for a repository +repos.yaml,/repos/{owner}/{repo}/tags/protection,repos/create-tag-protection,repos/create_tag_protection,post,tag-protection,repos,repos,tag_protection,create_tag_protection,insert,,Create a tag protection state for a repository +repos.yaml,/repos/{owner}/{repo}/tags,repos/list-tags,repos/list_tags,get,tag,repos,repos,tags,list_tags,select,,List repository tags +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams,repos/remove-team-access-restrictions,repos/remove_team_access_restrictions,delete,team,repos,repos,team_access_restrictions,remove_team_access_restrictions,delete,,Remove team access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams,repos/get-teams-with-access-to-protected-branch,repos/get_teams_with_access_to_protected_branch,get,team,repos,repos,team_access_restrictions,get_teams_with_access_to_protected_branch,select,,Get teams with access to the protected branch +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams,repos/add-team-access-restrictions,repos/add_team_access_restrictions,post,team,repos,repos,team_access_restrictions,add_team_access_restrictions,insert,,Add team access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams,repos/set-team-access-restrictions,repos/set_team_access_restrictions,put,team,repos,repos,team_access_restrictions,set_team_access_restrictions,replace,,Set team access restrictions +repos.yaml,/repos/{owner}/{repo}/teams,repos/list-teams,repos/list_teams,get,team,repos,repos,teams,list_teams,select,,List repository teams +repos.yaml,/repos/{owner}/{repo}/topics,repos/get-all-topics,repos/get_all_topics,get,topic,repos,repos,topics,get_all_topics,select,$.names,Get all repository topics +repos.yaml,/repos/{owner}/{repo}/topics,repos/replace-all-topics,repos/replace_all_topics,put,topic,repos,repos,topics,replace_all_topics,replace,,Replace all repository topics +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users,repos/remove-user-access-restrictions,repos/remove_user_access_restrictions,delete,simple-user,repos,repos,user_access_restrictions,remove_user_access_restrictions,delete,,Remove user access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users,repos/get-users-with-access-to-protected-branch,repos/get_users_with_access_to_protected_branch,get,simple-user,repos,repos,user_access_restrictions,get_users_with_access_to_protected_branch,select,,Get users with access to the protected branch +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users,repos/add-user-access-restrictions,repos/add_user_access_restrictions,post,simple-user,repos,repos,user_access_restrictions,add_user_access_restrictions,insert,,Add user access restrictions +repos.yaml,/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users,repos/set-user-access-restrictions,repos/set_user_access_restrictions,put,simple-user,repos,repos,user_access_restrictions,set_user_access_restrictions,replace,,Set user access restrictions +repos.yaml,/repos/{owner}/{repo}/traffic/views,repos/get-views,repos/get_views,get,view-traffic,repos,repos,view_traffic,get_views,select,,Get page views +repos.yaml,/repos/{owner}/{repo}/vulnerability-alerts,repos/disable-vulnerability-alerts,repos/disable_vulnerability_alerts,delete,,repos,repos,vulnerability_alerts,disable_vulnerability_alerts,exec,,Disable vulnerability alerts +repos.yaml,/repos/{owner}/{repo}/vulnerability-alerts,repos/check-vulnerability-alerts,repos/check_vulnerability_alerts,get,,repos,repos,vulnerability_alerts,check_vulnerability_alerts,exec,,Check if vulnerability alerts are enabled for a repository +repos.yaml,/repos/{owner}/{repo}/vulnerability-alerts,repos/enable-vulnerability-alerts,repos/enable_vulnerability_alerts,put,,repos,repos,vulnerability_alerts,enable_vulnerability_alerts,exec,,Enable vulnerability alerts +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/config,repos/get-webhook-config-for-repo,repos/get_webhook_config_for_repo,get,webhook-config,repos,repos,webhook_config,get_webhook_config_for_repo,select,,Get a webhook configuration for a repository +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/config,repos/update-webhook-config-for-repo,repos/update_webhook_config_for_repo,patch,webhook-config,repos,repos,webhook_config,update_webhook_config_for_repo,update,,Update a webhook configuration for a repository +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/deliveries,repos/list-webhook-deliveries,repos/list_webhook_deliveries,get,hook-delivery-item,repos,repos,webhook_deliveries,list_webhook_deliveries,select,,List deliveries for a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id},repos/get-webhook-delivery,repos/get_webhook_delivery,get,hook-delivery,repos,repos,webhook_delivery,get_webhook_delivery,select,,Get a delivery for a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts,repos/redeliver-webhook-delivery,repos/redeliver_webhook_delivery,post,,repos,repos,webhook_delivery,redeliver_webhook_delivery,exec,,Redeliver a delivery for a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id},repos/delete-webhook,repos/delete_webhook,delete,,repos,repos,webhooks,delete_webhook,delete,,Delete a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id},repos/get-webhook,repos/get_webhook,get,hook,repos,repos,webhooks,get_webhook,select,,Get a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks,repos/list-webhooks,repos/list_webhooks,get,hook,repos,repos,webhooks,list_webhooks,select,,List repository webhooks +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id},repos/update-webhook,repos/update_webhook,patch,hook,repos,repos,webhooks,update_webhook,update,,Update a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks,repos/create-webhook,repos/create_webhook,post,hook,repos,repos,webhooks,create_webhook,insert,,Create a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/pings,repos/ping-webhook,repos/ping_webhook,post,,repos,repos,webhooks,ping_webhook,exec,,Ping a repository webhook +repos.yaml,/repos/{owner}/{repo}/hooks/{hook_id}/tests,repos/test-push-webhook,repos/test_push_webhook,post,,repos,repos,webhooks,test_push_webhook,exec,,Test the push repository webhook +search.yaml,/search/code,search/code,search/code,get,,search,search,code,code,select,,Search code +search.yaml,/search/commits,search/commits,search/commits,get,,search,search,commits,commits,select,,Search commits +search.yaml,/search/issues,search/issues-and-pull-requests,search/issues_and_pull_requests,get,,search,search,issues_and_pull_requests,issues_and_pull_requests,select,,Search issues and pull requests +search.yaml,/search/labels,search/labels,search/labels,get,,search,search,labels,labels,select,,Search labels +search.yaml,/search/repositories,search/repos,search/repos,get,,search,search,repos,repos,select,,Search repositories +search.yaml,/search/topics,search/topics,search/topics,get,,search,search,topics,topics,select,,Search topics +search.yaml,/search/users,search/users,search/users,get,,search,search,users,users,select,,Search users +secret_scanning.yaml,/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number},secret-scanning/get-alert,secret_scanning/get_alert,get,secret-scanning-alert,secret-scanning,secret_scanning,alerts,get_alert,select,,Get a secret scanning alert +secret_scanning.yaml,/enterprises/{enterprise}/secret-scanning/alerts,secret-scanning/list-alerts-for-enterprise,secret_scanning/list_alerts_for_enterprise,get,organization-secret-scanning-alert,secret-scanning,secret_scanning,alerts,list_alerts_for_enterprise,select,,List secret scanning alerts for an enterprise +secret_scanning.yaml,/orgs/{org}/secret-scanning/alerts,secret-scanning/list-alerts-for-org,secret_scanning/list_alerts_for_org,get,organization-secret-scanning-alert,secret-scanning,secret_scanning,alerts,list_alerts_for_org,select,,List secret scanning alerts for an organization +secret_scanning.yaml,/repos/{owner}/{repo}/secret-scanning/alerts,secret-scanning/list-alerts-for-repo,secret_scanning/list_alerts_for_repo,get,secret-scanning-alert,secret-scanning,secret_scanning,alerts,list_alerts_for_repo,select,,List secret scanning alerts for a repository +secret_scanning.yaml,/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number},secret-scanning/update-alert,secret_scanning/update_alert,patch,secret-scanning-alert,secret-scanning,secret_scanning,alerts,update_alert,update,,Update a secret scanning alert +secret_scanning.yaml,/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations,secret-scanning/list-locations-for-alert,secret_scanning/list_locations_for_alert,get,secret-scanning-location,secret-scanning,secret_scanning,locations,list_locations_for_alert,select,,List locations for a secret scanning alert +secret_scanning.yaml,/orgs/{org}/secret-scanning/pattern-configurations,secret-scanning/list-org-pattern-configs,secret_scanning/list_org_pattern_configs,get,,secret-scanning,secret_scanning,org_secret_scanning_pattern_configurations,list_org_pattern_configs,select,,List organization pattern configurations +secret_scanning.yaml,/orgs/{org}/secret-scanning/pattern-configurations,secret-scanning/update-org-pattern-configs,secret_scanning/update_org_pattern_configs,patch,,secret-scanning,secret_scanning,org_secret_scanning_pattern_configurations,update_org_pattern_configs,update,,Update organization pattern configurations +secret_scanning.yaml,/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses,secret-scanning/create-push-protection-bypass,secret_scanning/create_push_protection_bypass,post,,secret-scanning,secret_scanning,repo_push_protection_bypasses,create_push_protection_bypass,insert,,Create a push protection bypass +secret_scanning.yaml,/repos/{owner}/{repo}/secret-scanning/scan-history,secret-scanning/get-scan-history,secret_scanning/get_scan_history,get,,secret-scanning,secret_scanning,repo_secret_scan_history,get_scan_history,select,,Get secret scanning scan history for a repository +security_advisories.yaml,/advisories/{ghsa_id},security-advisories/get-global-advisory,security_advisories/get_global_advisory,get,global-advisory,security-advisories,security_advisories,global_advisories,get_global_advisory,select,,Get a global security advisory +security_advisories.yaml,/advisories,security-advisories/list-global-advisories,security_advisories/list_global_advisories,get,global-advisory,security-advisories,security_advisories,global_advisories,list_global_advisories,select,,List global security advisories +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories/reports,security-advisories/create-private-vulnerability-report,security_advisories/create_private_vulnerability_report,post,repository-advisory,security-advisories,security_advisories,private_vulnerability_reports,create_private_vulnerability_report,insert,,Privately report a security vulnerability +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories/{ghsa_id},security-advisories/get-repository-advisory,security_advisories/get_repository_advisory,get,repository-advisory,security-advisories,security_advisories,repository_advisories,get_repository_advisory,select,,Get a repository security advisory +security_advisories.yaml,/orgs/{org}/security-advisories,security-advisories/list-org-repository-advisories,security_advisories/list_org_repository_advisories,get,repository-advisory,security-advisories,security_advisories,repository_advisories,list_org_repository_advisories,select,,List repository security advisories for an organization +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories,security-advisories/list-repository-advisories,security_advisories/list_repository_advisories,get,repository-advisory,security-advisories,security_advisories,repository_advisories,list_repository_advisories,select,,List repository security advisories +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories/{ghsa_id},security-advisories/update-repository-advisory,security_advisories/update_repository_advisory,patch,repository-advisory,security-advisories,security_advisories,repository_advisories,update_repository_advisory,update,,Update a repository security advisory +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories,security-advisories/create-repository-advisory,security_advisories/create_repository_advisory,post,repository-advisory,security-advisories,security_advisories,repository_advisories,create_repository_advisory,insert,,Create a repository security advisory +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve,security-advisories/create-repository-advisory-cve-request,security_advisories/create_repository_advisory_cve_request,post,,security-advisories,security_advisories,repository_advisories,create_repository_advisory_cve_request,insert,,Request a CVE for a repository security advisory +security_advisories.yaml,/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks,security-advisories/create-fork,security_advisories/create_fork,post,,security-advisories,security_advisories,security_advisory_forks,create_fork,insert,,Create a temporary private fork +teams.yaml,/orgs/{org}/teams/{team_slug}/teams,teams/list-child-in-org,teams/list_child_in_org,get,team,teams,teams,child_teams,list_child_in_org,select,,List child teams +teams.yaml,/teams/{team_id}/teams,teams/list-child-legacy,teams/list_child_legacy,get,team,teams,teams,child_teams,list_child_legacy,select,,List child teams (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug},teams/get-by-name,teams/get_by_name,get,team-full,teams,teams,details,get_by_name,select,,Get a team by name +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number},teams/delete-discussion-comment-in-org,teams/delete_discussion_comment_in_org,delete,,teams,teams,discussion_comments,delete_discussion_comment_in_org,delete,,Delete a discussion comment +teams.yaml,/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number},teams/delete-discussion-comment-legacy,teams/delete_discussion_comment_legacy,delete,,teams,teams,discussion_comments,delete_discussion_comment_legacy,delete,,Delete a discussion comment (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number},teams/get-discussion-comment-in-org,teams/get_discussion_comment_in_org,get,team-discussion-comment,teams,teams,discussion_comments,get_discussion_comment_in_org,select,,Get a discussion comment +teams.yaml,/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number},teams/get-discussion-comment-legacy,teams/get_discussion_comment_legacy,get,team-discussion-comment,teams,teams,discussion_comments,get_discussion_comment_legacy,select,,Get a discussion comment (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments,teams/list-discussion-comments-in-org,teams/list_discussion_comments_in_org,get,team-discussion-comment,teams,teams,discussion_comments,list_discussion_comments_in_org,select,,List discussion comments +teams.yaml,/teams/{team_id}/discussions/{discussion_number}/comments,teams/list-discussion-comments-legacy,teams/list_discussion_comments_legacy,get,team-discussion-comment,teams,teams,discussion_comments,list_discussion_comments_legacy,select,,List discussion comments (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number},teams/update-discussion-comment-in-org,teams/update_discussion_comment_in_org,patch,team-discussion-comment,teams,teams,discussion_comments,update_discussion_comment_in_org,update,,Update a discussion comment +teams.yaml,/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number},teams/update-discussion-comment-legacy,teams/update_discussion_comment_legacy,patch,team-discussion-comment,teams,teams,discussion_comments,update_discussion_comment_legacy,update,,Update a discussion comment (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments,teams/create-discussion-comment-in-org,teams/create_discussion_comment_in_org,post,team-discussion-comment,teams,teams,discussion_comments,create_discussion_comment_in_org,insert,,Create a discussion comment +teams.yaml,/teams/{team_id}/discussions/{discussion_number}/comments,teams/create-discussion-comment-legacy,teams/create_discussion_comment_legacy,post,team-discussion-comment,teams,teams,discussion_comments,create_discussion_comment_legacy,insert,,Create a discussion comment (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number},teams/delete-discussion-in-org,teams/delete_discussion_in_org,delete,,teams,teams,discussions,delete_discussion_in_org,delete,,Delete a discussion +teams.yaml,/teams/{team_id}/discussions/{discussion_number},teams/delete-discussion-legacy,teams/delete_discussion_legacy,delete,,teams,teams,discussions,delete_discussion_legacy,delete,,Delete a discussion (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number},teams/get-discussion-in-org,teams/get_discussion_in_org,get,team-discussion,teams,teams,discussions,get_discussion_in_org,select,,Get a discussion +teams.yaml,/teams/{team_id}/discussions/{discussion_number},teams/get-discussion-legacy,teams/get_discussion_legacy,get,team-discussion,teams,teams,discussions,get_discussion_legacy,select,,Get a discussion (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions,teams/list-discussions-in-org,teams/list_discussions_in_org,get,team-discussion,teams,teams,discussions,list_discussions_in_org,select,,List discussions +teams.yaml,/teams/{team_id}/discussions,teams/list-discussions-legacy,teams/list_discussions_legacy,get,team-discussion,teams,teams,discussions,list_discussions_legacy,select,,List discussions (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions/{discussion_number},teams/update-discussion-in-org,teams/update_discussion_in_org,patch,team-discussion,teams,teams,discussions,update_discussion_in_org,update,,Update a discussion +teams.yaml,/teams/{team_id}/discussions/{discussion_number},teams/update-discussion-legacy,teams/update_discussion_legacy,patch,team-discussion,teams,teams,discussions,update_discussion_legacy,update,,Update a discussion (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/discussions,teams/create-discussion-in-org,teams/create_discussion_in_org,post,team-discussion,teams,teams,discussions,create_discussion_in_org,insert,,Create a discussion +teams.yaml,/teams/{team_id}/discussions,teams/create-discussion-legacy,teams/create_discussion_legacy,post,team-discussion,teams,teams,discussions,create_discussion_legacy,insert,,Create a discussion (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/invitations,teams/list-pending-invitations-in-org,teams/list_pending_invitations_in_org,get,organization-invitation,teams,teams,invitations,list_pending_invitations_in_org,select,,List pending team invitations +teams.yaml,/teams/{team_id}/invitations,teams/list-pending-invitations-legacy,teams/list_pending_invitations_legacy,get,organization-invitation,teams,teams,invitations,list_pending_invitations_legacy,select,,List pending team invitations (Legacy) +teams.yaml,/teams/{team_id}/members/{username},teams/remove-member-legacy,teams/remove_member_legacy,delete,,teams,teams,members,remove_member_legacy,delete,,Remove team member (Legacy) +teams.yaml,/teams/{team_id}/members/{username},teams/get-member-legacy,teams/get_member_legacy,get,,teams,teams,members,get_member_legacy,select,,Get team member (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/members,teams/list-members-in-org,teams/list_members_in_org,get,simple-user,teams,teams,members,list_members_in_org,select,,List team members +teams.yaml,/teams/{team_id}/members,teams/list-members-legacy,teams/list_members_legacy,get,simple-user,teams,teams,members,list_members_legacy,select,,List team members (Legacy) +teams.yaml,/teams/{team_id}/members/{username},teams/add-member-legacy,teams/add_member_legacy,put,,teams,teams,members,add_member_legacy,replace,,Add team member (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/memberships/{username},teams/remove-membership-for-user-in-org,teams/remove_membership_for_user_in_org,delete,,teams,teams,membership,remove_membership_for_user_in_org,delete,,Remove team membership for a user +teams.yaml,/teams/{team_id}/memberships/{username},teams/remove-membership-for-user-legacy,teams/remove_membership_for_user_legacy,delete,,teams,teams,membership,remove_membership_for_user_legacy,delete,,Remove team membership for a user (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/memberships/{username},teams/get-membership-for-user-in-org,teams/get_membership_for_user_in_org,get,team-membership,teams,teams,membership,get_membership_for_user_in_org,select,,Get team membership for a user +teams.yaml,/teams/{team_id}/memberships/{username},teams/get-membership-for-user-legacy,teams/get_membership_for_user_legacy,get,team-membership,teams,teams,membership,get_membership_for_user_legacy,select,,Get team membership for a user (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/memberships/{username},teams/add-or-update-membership-for-user-in-org,teams/add_or_update_membership_for_user_in_org,put,team-membership,teams,teams,membership,add_or_update_membership_for_user_in_org,replace,,Add or update team membership for a user +teams.yaml,/teams/{team_id}/memberships/{username},teams/add-or-update-membership-for-user-legacy,teams/add_or_update_membership_for_user_legacy,put,team-membership,teams,teams,membership,add_or_update_membership_for_user_legacy,replace,,Add or update team membership for a user (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo},teams/check-permissions-for-repo-in-org,teams/check_permissions_for_repo_in_org,get,team-repository,teams,teams,permissions,check_permissions_for_repo_in_org,select,,Check team permissions for a repository +teams.yaml,/teams/{team_id}/repos/{owner}/{repo},teams/check-permissions-for-repo-legacy,teams/check_permissions_for_repo_legacy,get,team-repository,teams,teams,permissions,check_permissions_for_repo_legacy,select,,Check team permissions for a repository (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo},teams/add-or-update-repo-permissions-in-org,teams/add_or_update_repo_permissions_in_org,put,,teams,teams,permissions,add_or_update_repo_permissions_in_org,replace,,Add or update team repository permissions +teams.yaml,/teams/{team_id}/repos/{owner}/{repo},teams/add-or-update-repo-permissions-legacy,teams/add_or_update_repo_permissions_legacy,put,,teams,teams,permissions,add_or_update_repo_permissions_legacy,replace,,Add or update team repository permissions (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/projects/{project_id},teams/check-permissions-for-project-in-org,teams/check_permissions_for_project_in_org,get,team-project,teams,teams,project_permissions,check_permissions_for_project_in_org,select,,Check team permissions for a project +teams.yaml,/teams/{team_id}/projects/{project_id},teams/check-permissions-for-project-legacy,teams/check_permissions_for_project_legacy,get,team-project,teams,teams,project_permissions,check_permissions_for_project_legacy,select,,Check team permissions for a project (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/projects/{project_id},teams/add-or-update-project-permissions-in-org,teams/add_or_update_project_permissions_in_org,put,,teams,teams,project_permissions,add_or_update_project_permissions_in_org,replace,,Add or update team project permissions +teams.yaml,/teams/{team_id}/projects/{project_id},teams/add-or-update-project-permissions-legacy,teams/add_or_update_project_permissions_legacy,put,,teams,teams,project_permissions,add_or_update_project_permissions_legacy,replace,,Add or update team project permissions (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/projects/{project_id},teams/remove-project-in-org,teams/remove_project_in_org,delete,,teams,teams,projects,remove_project_in_org,delete,,Remove a project from a team +teams.yaml,/teams/{team_id}/projects/{project_id},teams/remove-project-legacy,teams/remove_project_legacy,delete,,teams,teams,projects,remove_project_legacy,delete,,Remove a project from a team (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/projects,teams/list-projects-in-org,teams/list_projects_in_org,get,team-project,teams,teams,projects,list_projects_in_org,select,,List team projects +teams.yaml,/teams/{team_id}/projects,teams/list-projects-legacy,teams/list_projects_legacy,get,team-project,teams,teams,projects,list_projects_legacy,select,,List team projects (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo},teams/remove-repo-in-org,teams/remove_repo_in_org,delete,,teams,teams,repos,remove_repo_in_org,delete,,Remove a repository from a team +teams.yaml,/teams/{team_id}/repos/{owner}/{repo},teams/remove-repo-legacy,teams/remove_repo_legacy,delete,,teams,teams,repos,remove_repo_legacy,delete,,Remove a repository from a team (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug}/repos,teams/list-repos-in-org,teams/list_repos_in_org,get,minimal-repository,teams,teams,repos,list_repos_in_org,select,,List team repositories +teams.yaml,/teams/{team_id}/repos,teams/list-repos-legacy,teams/list_repos_legacy,get,minimal-repository,teams,teams,repos,list_repos_legacy,select,,List team repositories (Legacy) +teams.yaml,/orgs/{org}/teams/{team_slug},teams/delete-in-org,teams/delete_in_org,delete,,teams,teams,teams,delete_in_org,delete,,Delete a team +teams.yaml,/teams/{team_id},teams/delete-legacy,teams/delete_legacy,delete,,teams,teams,teams,delete_legacy,delete,,Delete a team (Legacy) +teams.yaml,/teams/{team_id},teams/get-legacy,teams/get_legacy,get,team-full,teams,teams,teams,get_legacy,select,,Get a team (Legacy) +teams.yaml,/orgs/{org}/teams,teams/list,teams/list,get,team,teams,teams,teams,list,select,,List teams +teams.yaml,/orgs/{org}/teams/{team_slug},teams/update-in-org,teams/update_in_org,patch,team-full,teams,teams,teams,update_in_org,update,,Update a team +teams.yaml,/teams/{team_id},teams/update-legacy,teams/update_legacy,patch,team-full,teams,teams,teams,update_legacy,update,,Update a team (Legacy) +teams.yaml,/orgs/{org}/teams,teams/create,teams/create,post,team-full,teams,teams,teams,create,insert,,Create a team +teams.yaml,/user/teams,teams/list-for-authenticated-user,teams/list_for_authenticated_user,get,team-full,teams,teams,teams_for_auth_user,list_for_authenticated_user,select,,List teams for the authenticated user +users.yaml,/users/{username}/attestations/{attestation_id},users/delete-attestations-by-id,users/delete_attestations_by_id,delete,,users,users,attestations,delete_attestations_by_id,delete,,Delete attestations by ID +users.yaml,/users/{username}/attestations/digest/{subject_digest},users/delete-attestations-by-subject-digest,users/delete_attestations_by_subject_digest,delete,,users,users,attestations,delete_attestations_by_subject_digest,delete,,Delete attestations by subject digest +users.yaml,/users/{username}/attestations/{subject_digest},users/list-attestations,users/list_attestations,get,,users,users,attestations,list_attestations,select,$.attestations,List attestations +users.yaml,/users/{username}/attestations/delete-request,users/delete-attestations-bulk,users/delete_attestations_bulk,post,,users,users,attestations_bulk_deletes,delete_attestations_bulk,exec,,Delete attestations in bulk +users.yaml,/users/{username}/attestations/bulk-list,users/list-attestations-bulk,users/list_attestations_bulk,post,,users,users,attestations_bulk_list,list_attestations_bulk,insert,,List attestations by bulk subject digests +users.yaml,/user/blocks/{username},users/unblock,users/unblock,delete,,users,users,blocking,unblock,exec,,Unblock a user +users.yaml,/user/blocks/{username},users/check-blocked,users/check_blocked,get,,users,users,blocking,check_blocked,exec,,Check if a user is blocked by the authenticated user +users.yaml,/user/blocks,users/list-blocked-by-authenticated-user,users/list_blocked_by_authenticated_user,get,simple-user,users,users,blocking,list_blocked_by_authenticated_user,select,,List users blocked by the authenticated user +users.yaml,/user/blocks/{username},users/block,users/block,put,,users,users,blocking,block,exec,,Block a user +users.yaml,/user/emails,users/delete-email-for-authenticated-user,users/delete_email_for_authenticated_user,delete,,users,users,emails,delete_email_for_authenticated_user,delete,,Delete an email address for the authenticated user +users.yaml,/user/emails,users/list-emails-for-authenticated-user,users/list_emails_for_authenticated_user,get,email,users,users,emails,list_emails_for_authenticated_user,select,,List email addresses for the authenticated user +users.yaml,/user/email/visibility,users/set-primary-email-visibility-for-authenticated-user,users/set_primary_email_visibility_for_authenticated_user,patch,email,users,users,emails,set_primary_email_visibility_for_authenticated_user,update,,Set primary email visibility for the authenticated user +users.yaml,/user/emails,users/add-email-for-authenticated-user,users/add_email_for_authenticated_user,post,email,users,users,emails,add_email_for_authenticated_user,insert,,Add an email address for the authenticated user +users.yaml,/user/followers,users/list-followers-for-authenticated-user,users/list_followers_for_authenticated_user,get,simple-user,users,users,followers,list_followers_for_authenticated_user,select,,List followers of the authenticated user +users.yaml,/users/{username}/followers,users/list-followers-for-user,users/list_followers_for_user,get,simple-user,users,users,followers,list_followers_for_user,select,,List followers of a user +users.yaml,/user/following/{username},users/unfollow,users/unfollow,delete,,users,users,following,unfollow,exec,,Unfollow a user +users.yaml,/users/{username}/following/{target_user},users/check-following-for-user,users/check_following_for_user,get,,users,users,following,check_following_for_user,exec,,Check if a user follows another user +users.yaml,/user/following/{username},users/check-person-is-followed-by-authenticated,users/check_person_is_followed_by_authenticated,get,,users,users,following,check_person_is_followed_by_authenticated,exec,,Check if a person is followed by the authenticated user +users.yaml,/user/following,users/list-followed-by-authenticated-user,users/list_followed_by_authenticated_user,get,simple-user,users,users,following,list_followed_by_authenticated_user,select,,List the people the authenticated user follows +users.yaml,/users/{username}/following,users/list-following-for-user,users/list_following_for_user,get,simple-user,users,users,following,list_following_for_user,select,,List the people a user follows +users.yaml,/user/following/{username},users/follow,users/follow,put,,users,users,following,follow,exec,,Follow a user +users.yaml,/user/gpg_keys/{gpg_key_id},users/delete-gpg-key-for-authenticated-user,users/delete_gpg_key_for_authenticated_user,delete,,users,users,gpg_keys,delete_gpg_key_for_authenticated_user,delete,,Delete a GPG key for the authenticated user +users.yaml,/user/gpg_keys/{gpg_key_id},users/get-gpg-key-for-authenticated-user,users/get_gpg_key_for_authenticated_user,get,gpg-key,users,users,gpg_keys,get_gpg_key_for_authenticated_user,select,,Get a GPG key for the authenticated user +users.yaml,/user/gpg_keys,users/list-gpg-keys-for-authenticated-user,users/list_gpg_keys_for_authenticated_user,get,gpg-key,users,users,gpg_keys,list_gpg_keys_for_authenticated_user,select,,List GPG keys for the authenticated user +users.yaml,/users/{username}/gpg_keys,users/list-gpg-keys-for-user,users/list_gpg_keys_for_user,get,gpg-key,users,users,gpg_keys,list_gpg_keys_for_user,select,,List GPG keys for a user +users.yaml,/user/gpg_keys,users/create-gpg-key-for-authenticated-user,users/create_gpg_key_for_authenticated_user,post,gpg-key,users,users,gpg_keys,create_gpg_key_for_authenticated_user,insert,,Create a GPG key for the authenticated user +users.yaml,/users/{username}/hovercard,users/get-context-for-user,users/get_context_for_user,get,hovercard,users,users,hovercard,get_context_for_user,select,$.contexts,Get contextual information for a user +users.yaml,/user/keys/{key_id},users/delete-public-ssh-key-for-authenticated-user,users/delete_public_ssh_key_for_authenticated_user,delete,,users,users,keys,delete_public_ssh_key_for_authenticated_user,delete,,Delete a public SSH key for the authenticated user +users.yaml,/user/keys/{key_id},users/get-public-ssh-key-for-authenticated-user,users/get_public_ssh_key_for_authenticated_user,get,key,users,users,keys,get_public_ssh_key_for_authenticated_user,select,,Get a public SSH key for the authenticated user +users.yaml,/users/{username}/keys,users/list-public-keys-for-user,users/list_public_keys_for_user,get,key-simple,users,users,keys,list_public_keys_for_user,select,,List public keys for a user +users.yaml,/user/keys,users/list-public-ssh-keys-for-authenticated-user,users/list_public_ssh_keys_for_authenticated_user,get,key,users,users,keys,list_public_ssh_keys_for_authenticated_user,select,,List public SSH keys for the authenticated user +users.yaml,/user/keys,users/create-public-ssh-key-for-authenticated-user,users/create_public_ssh_key_for_authenticated_user,post,key,users,users,keys,create_public_ssh_key_for_authenticated_user,insert,,Create a public SSH key for the authenticated user +users.yaml,/user/public_emails,users/list-public-emails-for-authenticated-user,users/list_public_emails_for_authenticated_user,get,email,users,users,public_emails,list_public_emails_for_authenticated_user,select,,List public email addresses for the authenticated user +users.yaml,/users,users/list,users/list,get,simple-user,users,users,public_users,list,select,,List users +users.yaml,/user/social_accounts,users/delete-social-account-for-authenticated-user,users/delete_social_account_for_authenticated_user,delete,,users,users,social_accounts,delete_social_account_for_authenticated_user,delete,,Delete social accounts for the authenticated user +users.yaml,/user/social_accounts,users/list-social-accounts-for-authenticated-user,users/list_social_accounts_for_authenticated_user,get,social-account,users,users,social_accounts,list_social_accounts_for_authenticated_user,select,,List social accounts for the authenticated user +users.yaml,/users/{username}/social_accounts,users/list-social-accounts-for-user,users/list_social_accounts_for_user,get,social-account,users,users,social_accounts,list_social_accounts_for_user,select,,List social accounts for a user +users.yaml,/user/social_accounts,users/add-social-account-for-authenticated-user,users/add_social_account_for_authenticated_user,post,social-account,users,users,social_accounts,add_social_account_for_authenticated_user,insert,,Add social accounts for the authenticated user +users.yaml,/user/ssh_signing_keys/{ssh_signing_key_id},users/delete-ssh-signing-key-for-authenticated-user,users/delete_ssh_signing_key_for_authenticated_user,delete,,users,users,ssh_signing_keys,delete_ssh_signing_key_for_authenticated_user,delete,,Delete an SSH signing key for the authenticated user +users.yaml,/user/ssh_signing_keys/{ssh_signing_key_id},users/get-ssh-signing-key-for-authenticated-user,users/get_ssh_signing_key_for_authenticated_user,get,ssh-signing-key,users,users,ssh_signing_keys,get_ssh_signing_key_for_authenticated_user,select,,Get an SSH signing key for the authenticated user +users.yaml,/user/ssh_signing_keys,users/list-ssh-signing-keys-for-authenticated-user,users/list_ssh_signing_keys_for_authenticated_user,get,ssh-signing-key,users,users,ssh_signing_keys,list_ssh_signing_keys_for_authenticated_user,select,,List SSH signing keys for the authenticated user +users.yaml,/users/{username}/ssh_signing_keys,users/list-ssh-signing-keys-for-user,users/list_ssh_signing_keys_for_user,get,ssh-signing-key,users,users,ssh_signing_keys,list_ssh_signing_keys_for_user,select,,List SSH signing keys for a user +users.yaml,/user/ssh_signing_keys,users/create-ssh-signing-key-for-authenticated-user,users/create_ssh_signing_key_for_authenticated_user,post,ssh-signing-key,users,users,ssh_signing_keys,create_ssh_signing_key_for_authenticated_user,insert,,Create a SSH signing key for the authenticated user +users.yaml,/user,users/get-authenticated,users/get_authenticated,get,,users,users,users,get_authenticated,select,,Get the authenticated user +users.yaml,/user/{account_id},users/get-by-id,users/get_by_id,get,,users,users,users,get_by_id,select,,Get a user using their ID +users.yaml,/users/{username},users/get-by-username,users/get_by_username,get,,users,users,users,get_by_username,select,,Get a user +users.yaml,/user,users/update-authenticated,users/update_authenticated,patch,private-user,users,users,users,update_authenticated,update,,Update the authenticated user diff --git a/provider-dev/docgen/provider-data/headerContent1.txt b/provider-dev/docgen/provider-data/headerContent1.txt index 8e95862..e100ddc 100644 --- a/provider-dev/docgen/provider-data/headerContent1.txt +++ b/provider-dev/docgen/provider-data/headerContent1.txt @@ -1,19 +1,19 @@ --- -title: REPLACEME +title: github hide_title: false hide_table_of_contents: false keywords: - - REPLACEME + - github - stackql - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage REPLACEME resources using SQL +description: Query, deploy and manage GitHub resources using SQL custom_edit_url: null -image: /img/stackql-REPLACEME-provider-featured-image.png +image: /img/stackql-github-provider-featured-image.png id: 'provider-intro' --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; -REPLACEME with description for the provider. \ No newline at end of file +Web-based version-control and collaboration. \ No newline at end of file diff --git a/provider-dev/docgen/provider-data/headerContent2.txt b/provider-dev/docgen/provider-data/headerContent2.txt index 0eeb8c1..ec6649a 100644 --- a/provider-dev/docgen/provider-data/headerContent2.txt +++ b/provider-dev/docgen/provider-data/headerContent2.txt @@ -4,10 +4,10 @@ See also: ## Installation -To pull the latest version of the `REPLACEME` provider, run the following command: +To pull the latest version of the `github` provider, run the following command: ```bash -REGISTRY PULL REPLACEME; +REGISTRY PULL github; ``` > To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). @@ -15,7 +15,8 @@ REGISTRY PULL REPLACEME; The following system environment variables are used for authentication by default: -- - REPLACEME API token (see - GitHub username (login) +- - GitHub Personal Access Token (see Creating a personal access token) These variables are sourced at runtime (from the local machine or as CI variables/secrets). @@ -27,7 +28,7 @@ To use different environment variables (instead of the defaults), use the `--aut ```bash -AUTH='{ "REPLACEME": { "type": "bearer", "credentialsenvvar": "REPLACEME" }}' +AUTH='{ "github": { "type": "basic", "username_var": "YOUR_GITHUB_USERNAME_VAR", "password_var": "YOUR_GITHUB_PASSWORD_VAR" }}' stackql shell --auth="${AUTH}" ``` @@ -35,7 +36,7 @@ or using PowerShell: ```powershell -$Auth = "{ 'REPLACEME': { 'type': 'bearer', 'credentialsenvvar': 'REPLACEME' }}" +$Auth = "{ 'github': { 'type': 'basic', 'username_var': 'YOUR_GITHUB_USERNAME_VAR', 'password_var': 'YOUR_GITHUB_PASSWORD_VAR' }}" stackql.exe shell --auth=$Auth ``` diff --git a/provider-dev/downloaded/api.github.com.json b/provider-dev/downloaded/api.github.com.json new file mode 100644 index 0000000..73609fb --- /dev/null +++ b/provider-dev/downloaded/api.github.com.json @@ -0,0 +1,325558 @@ +{ + "openapi": "3.0.3", + "info": { + "version": "1.1.4", + "title": "GitHub v3 REST API", + "description": "GitHub's v3 REST API.", + "license": { + "name": "MIT", + "url": "https://spdx.org/licenses/MIT" + }, + "termsOfService": "https://docs.github.com/articles/github-terms-of-service", + "contact": { + "name": "Support", + "url": "https://support.github.com/contact?tags=dotcom-rest-api" + }, + "x-github-plan": "api.github.com" + }, + "tags": [ + { + "name": "actions", + "description": "Endpoints to manage GitHub Actions using the REST API." + }, + { + "name": "activity", + "description": "Activity APIs provide access to notifications, subscriptions, and timelines." + }, + { + "name": "apps", + "description": "Information for integrations and installations." + }, + { + "name": "billing", + "description": "Monitor charges and usage from Actions and Packages." + }, + { + "name": "checks", + "description": "Rich interactions with checks run by your integrations." + }, + { + "name": "code-scanning", + "description": "Retrieve code scanning alerts from a repository." + }, + { + "name": "codes-of-conduct", + "description": "Insight into codes of conduct for your communities." + }, + { + "name": "emojis", + "description": "List emojis available to use on GitHub." + }, + { + "name": "dependabot", + "description": "Endpoints to manage Dependabot." + }, + { + "name": "dependency-graph", + "description": "Endpoints to access Dependency Graph features." + }, + { + "name": "gists", + "description": "View, modify your gists." + }, + { + "name": "git", + "description": "Raw Git functionality." + }, + { + "name": "gitignore", + "description": "View gitignore templates" + }, + { + "name": "issues", + "description": "Interact with GitHub Issues." + }, + { + "name": "licenses", + "description": "View various OSS licenses." + }, + { + "name": "markdown", + "description": "Render GitHub flavored Markdown" + }, + { + "name": "merge-queue", + "description": "Interact with GitHub Merge Queues." + }, + { + "name": "meta", + "description": "Endpoints that give information about the API." + }, + { + "name": "migrations", + "description": "Move projects to or from GitHub." + }, + { + "name": "oidc", + "description": "Endpoints to manage GitHub OIDC configuration using the REST API." + }, + { + "name": "orgs", + "description": "Interact with organizations." + }, + { + "name": "packages", + "description": "Manage packages for authenticated users and organizations." + }, + { + "name": "pulls", + "description": "Interact with GitHub Pull Requests." + }, + { + "name": "rate-limit", + "description": "Check your current rate limit status." + }, + { + "name": "reactions", + "description": "Interact with reactions to various GitHub entities." + }, + { + "name": "repos", + "description": "Interact with GitHub Repos." + }, + { + "name": "search", + "description": "Search for specific items on GitHub." + }, + { + "name": "secret-scanning", + "description": "Retrieve secret scanning alerts from a repository." + }, + { + "name": "teams", + "description": "Interact with GitHub Teams." + }, + { + "name": "users", + "description": "Interact with and view information about users and also current user." + }, + { + "name": "codespaces", + "description": "Endpoints to manage Codespaces using the REST API." + }, + { + "name": "copilot", + "description": "Endpoints to manage Copilot using the REST API." + }, + { + "name": "security-advisories", + "description": "Manage security advisories." + }, + { + "name": "interactions", + "description": "Owner or admin management of users interactions." + }, + { + "name": "classroom", + "description": "Interact with GitHub Classroom." + }, + { + "name": "desktop", + "description": "Desktop specific endpoints." + }, + { + "name": "enterprise-teams", + "description": "Endpoints to manage GitHub Enterprise Teams." + }, + { + "name": "enterprise-team-memberships", + "description": "Endpoints to manage GitHub Enterprise Team memberships." + }, + { + "name": "enterprise-team-organizations", + "description": "Endpoints to manage GitHub Enterprise Team organization assignments." + }, + { + "name": "code-security", + "description": "Endpoints to manage Code security using the REST API." + }, + { + "name": "private-registries", + "description": "Manage private registry configurations." + }, + { + "name": "hosted-compute", + "description": "Manage hosted compute networking resources." + }, + { + "name": "credentials", + "description": "Revoke compromised or leaked GitHub credentials." + }, + { + "name": "campaigns", + "description": "Endpoints to manage campaigns via the REST API." + }, + { + "name": "projects", + "description": "Endpoints to manage Projects using the REST API." + }, + { + "name": "agent-tasks", + "description": "Endpoints to manage and interact with agent tasks." + } + ], + "servers": [ + { + "url": "https://api.github.com" + } + ], + "externalDocs": { + "description": "GitHub v3 REST API", + "url": "https://docs.github.com/rest/" + }, + "paths": { + "/": { + "get": { + "summary": "GitHub API Root", + "description": "Get Hypermedia links to resources accessible in GitHub's REST API", + "tags": [ + "meta" + ], + "operationId": "meta/root", + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/root" + }, + "examples": { + "default": { + "$ref": "#/components/examples/root" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "meta", + "subcategory": "meta" + }, + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta/meta#github-api-root" + } + } + }, + "/advisories": { + "get": { + "summary": "List global security advisories", + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/list-global-advisories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories" + }, + "parameters": [ + { + "name": "ghsa_id", + "in": "query", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "type", + "in": "query", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", + "schema": { + "type": "string", + "enum": [ + "reviewed", + "malware", + "unreviewed" + ], + "default": "reviewed" + } + }, + { + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ecosystem", + "in": "query", + "description": "If specified, only advisories for these ecosystems will be returned.", + "schema": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + } + }, + { + "name": "severity", + "in": "query", + "description": "If specified, only advisories with these severities will be returned.", + "schema": { + "type": "string", + "enum": [ + "unknown", + "low", + "medium", + "high", + "critical" + ] + } + }, + { + "name": "cwes", + "in": "query", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "is_withdrawn", + "in": "query", + "description": "Whether to only return advisories that have been withdrawn.", + "schema": { + "type": "boolean" + } + }, + { + "name": "affects", + "in": "query", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 1000, + "items": { + "type": "string" + } + } + ] + } + }, + { + "name": "published", + "in": "query", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "updated", + "in": "query", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "schema": { + "type": "string" + } + }, + { + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentage", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being exploited.", + "schema": { + "type": "string" + } + }, + { + "name": "epss_percentile", + "in": "query", + "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "updated", + "published", + "epss_percentage", + "epss_percentile" + ], + "default": "published" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/global-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory-items" + } + } + } + } + }, + "429": { + "description": "Too many requests", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/advisories/{ghsa_id}": { + "get": { + "summary": "Get a global security advisory", + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-global-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/global-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/global-advisory" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "global-advisories" + } + } + }, + "/agents/repos/{owner}/{repo}/tasks": { + "get": { + "summary": "List tasks for repository", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for a specific repository\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"prev\" (when current page > 1),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + }, + "post": { + "summary": "Create a task", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new task for a repository.\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/create-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "prompt" + ], + "properties": { + "prompt": { + "type": "string", + "description": "The user's prompt for the agent" + }, + "model": { + "type": "string", + "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`" + }, + "create_pull_request": { + "type": "boolean", + "description": "Whether to create a PR.", + "default": false + }, + "base_ref": { + "type": "string", + "description": "Base ref for new branch/PR" + } + } + }, + "examples": { + "default": { + "value": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Task created successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + } + } + } + } + } + }, + "400": { + "description": "Problems parsing JSON", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/repos/{owner}/{repo}/tasks/{task_id}": { + "get": { + "summary": "Get a task by repo", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID scoped to an owner/repo path\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-repo-and-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive." + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive." + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks": { + "get": { + "summary": "List tasks", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a list of tasks for the authenticated user\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/list-tasks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100)." + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be `updated_at` or `created_at`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ] + }, + "description": "The direction to sort results. Can be `asc` or `desc`." + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`." + }, + { + "name": "is_archived", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "description": "Only show tasks updated at or after this time (ISO 8601 timestamp)" + } + ], + "responses": { + "200": { + "description": "Tasks retrieved successfully", + "headers": { + "Link": { + "description": "Pagination links. Contains rel=\"first\" (always),\nrel=\"next\" (when more pages exist), and rel=\"last\" (when on the final page).\n", + "schema": { + "type": "string" + }, + "example": "; rel=\"next\", ; rel=\"first\"" + } + }, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + }, + "examples": { + "default": { + "value": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Bad request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/agents/tasks/{task_id}": { + "get": { + "summary": "Get a task by ID", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReturns a task by ID with its associated sessions\n", + "tags": [ + "agent-tasks" + ], + "operationId": "agent-tasks/get-task-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "agent-tasks", + "subcategory": "agent-tasks" + }, + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task." + } + ], + "responses": { + "200": { + "description": "Task retrieved successfully", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Problems parsing request", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "401": { + "description": "Authentication required", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "403": { + "description": "Insufficient permissions", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "Structured error response following GitHub REST API conventions.\nFor 422 Unprocessable Entity the errors array contains validation\ndetails; for other error status codes only message and\ndocumentation_url are returned.", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string", + "description": "Summary message (e.g. \"Validation Failed\", \"Not Found\")" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "description": "A single validation error", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "missing", + "missing_field", + "invalid", + "already_exists", + "unprocessable", + "custom" + ], + "description": "Machine-readable error code" + }, + "message": { + "type": "string", + "description": "Human-readable message (populated when code is \"custom\")" + } + } + }, + "description": "List of validation errors (present only for 422 responses)" + }, + "documentation_url": { + "type": "string", + "description": "URL to relevant API documentation" + } + } + } + } + } + } + } + } + }, + "/app": { + "get": { + "summary": "Get the authenticated app", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-the-authenticated-app" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/integration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/app-manifests/{code}/conversions": { + "post": { + "summary": "Create a GitHub App from a manifest", + "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", + "tags": [ + "apps" + ], + "operationId": "apps/create-from-manifest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest" + }, + "parameters": [ + { + "name": "code", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/integration" + }, + { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "webhook_secret": { + "type": "string", + "nullable": true + }, + "pem": { + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret", + "webhook_secret", + "pem" + ], + "additionalProperties": true + } + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-from-manifest" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/app/hook/config": { + "get": { + "summary": "Get a webhook configuration for an app", + "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-webhook-config-for-app", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app" + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/webhook-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a webhook configuration for an app", + "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/update-webhook-config-for-app", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app" + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/webhook-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "webhooks" + } + } + }, + "/app/hook/deliveries": { + "get": { + "summary": "List deliveries for an app webhook", + "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/cursor" + }, + { + "$ref": "#/components/parameters/webhook-delivery-status" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/hook-delivery-item" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "webhooks" + } + } + }, + "/app/hook/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for an app webhook", + "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/delivery-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hook-delivery" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "webhooks" + } + } + }, + "/app/hook/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an app webhook", + "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/delivery-id" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "webhooks" + } + } + }, + "/app/installation-requests": { + "get": { + "summary": "List installation requests for the authenticated app", + "description": "Lists all the pending installation requests for the authenticated GitHub App.", + "tags": [ + "apps" + ], + "operationId": "apps/list-installation-requests-for-authenticated-app", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "List of integration installation requests", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration-installation-request" + } + }, + "examples": { + "exampleKey1": { + "$ref": "#/components/examples/integration-installation-request-paginated" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/app/installations": { + "get": { + "summary": "List installations for the authenticated app", + "description": "The permissions the installation has are included under the `permissions` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/list-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "name": "outdated", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The permissions the installation has are included under the `permissions` key.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/installation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-installation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/app/installations/{installation_id}": { + "get": { + "summary": "Get an installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-installation" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "apps" + } + }, + "delete": { + "summary": "Delete an installation for the authenticated app", + "description": "Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/delete-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_delete_installation_success_status", + "patch": { + "responses": { + "202": { + "description": "Response" + }, + "204": null + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/app/installations/{installation_id}/access_tokens": { + "post": { + "summary": "Create an installation access token for an app", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/create-installation-access-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repositories": { + "description": "List of repository names that the token should have access to", + "type": "array", + "items": { + "type": "string", + "example": "rails" + } + }, + "repository_ids": { + "description": "List of repository IDs that the token should have access to", + "example": [ + 1 + ], + "type": "array", + "items": { + "type": "integer" + } + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + } + } + }, + "examples": { + "default": { + "value": { + "repositories": [ + "Hello-World" + ], + "permissions": { + "issues": "write", + "contents": "read" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation-token" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/app/installations/{installation_id}/suspended": { + "put": { + "summary": "Suspend an app installation", + "description": "Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/suspend-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#suspend-an-app-installation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + }, + "delete": { + "summary": "Unsuspend an app installation", + "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/unsuspend-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/applications/{client_id}/grant": { + "delete": { + "summary": "Delete an app authorization", + "description": "OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "operationId": "apps/delete-authorization", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/client-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "description": "The OAuth access token used to authenticate to the GitHub API." + } + }, + "required": [ + "access_token" + ] + }, + "examples": { + "default": { + "value": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "oauth-applications" + } + } + }, + "/applications/{client_id}/token": { + "post": { + "summary": "Check a token", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.", + "tags": [ + "apps" + ], + "operationId": "apps/check-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/oauth-applications#check-a-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/client-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "access_token": { + "description": "The access_token of the OAuth or GitHub application.", + "type": "string" + } + }, + "required": [ + "access_token" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authorization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-with-user" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "oauth-applications" + } + }, + "patch": { + "summary": "Reset a token", + "description": "OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.", + "tags": [ + "apps" + ], + "operationId": "apps/reset-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/oauth-applications#reset-a-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/client-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "access_token": { + "description": "The access_token of the OAuth or GitHub application.", + "type": "string" + } + }, + "required": [ + "access_token" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authorization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authorization-with-user" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "oauth-applications" + } + }, + "delete": { + "summary": "Delete an app token", + "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.", + "tags": [ + "apps" + ], + "operationId": "apps/delete-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/client-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "description": "The OAuth access token used to authenticate to the GitHub API." + } + }, + "required": [ + "access_token" + ] + }, + "examples": { + "default": { + "value": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "oauth-applications" + } + } + }, + "/applications/{client_id}/token/scoped": { + "post": { + "summary": "Create a scoped access token", + "description": "Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify\nwhich repositories the token can access and which permissions are granted to the\ntoken.\n\nInvalid tokens will return `404 NOT FOUND`.", + "tags": [ + "apps" + ], + "operationId": "apps/scope-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#create-a-scoped-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/client-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "access_token": { + "type": "string", + "description": "The access token used to authenticate to the GitHub API.", + "example": "e72e16c7e42f292c6912e7710c838347ae178b4a" + }, + "target": { + "description": "The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.", + "type": "string", + "example": "octocat" + }, + "target_id": { + "description": "The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.", + "example": 1, + "type": "integer" + }, + "repositories": { + "description": "The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified.", + "type": "array", + "items": { + "type": "string", + "example": "rails" + } + }, + "repository_ids": { + "description": "The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.", + "example": [ + 1 + ], + "type": "array", + "items": { + "type": "integer" + } + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + } + }, + "required": [ + "access_token" + ] + }, + "examples": { + "default": { + "value": { + "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a", + "target": "octocat", + "permissions": { + "metadata": "read", + "issues": "write", + "contents": "read" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authorization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scope-token" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/apps/{app_slug}": { + "get": { + "summary": "Get an app", + "description": "> [!NOTE]\n> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).", + "tags": [ + "apps" + ], + "operationId": "apps/get-by-slug", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-an-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/app-slug" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/integration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/assignments/{assignment_id}": { + "get": { + "summary": "Get an assignment", + "description": "Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "tags": [ + "classroom" + ], + "operationId": "classroom/get-an-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/classroom/classroom#get-an-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/assignment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/classroom-assignment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/classroom-assignment" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "classroom", + "subcategory": "classroom" + } + } + }, + "/assignments/{assignment_id}/accepted_assignments": { + "get": { + "summary": "List accepted assignments for an assignment", + "description": "Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "tags": [ + "classroom" + ], + "operationId": "classroom/list-accepted-assignments-for-an-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/assignment-id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/classroom-accepted-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/classroom-accepted-assignment" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "classroom", + "subcategory": "classroom" + } + } + }, + "/assignments/{assignment_id}/grades": { + "get": { + "summary": "Get assignment grades", + "description": "Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.", + "tags": [ + "classroom" + ], + "operationId": "classroom/get-assignment-grades", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/classroom/classroom#get-assignment-grades" + }, + "parameters": [ + { + "$ref": "#/components/parameters/assignment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/classroom-assignment-grade" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/classroom-assignment-grades" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "classroom", + "subcategory": "classroom" + } + } + }, + "/classrooms": { + "get": { + "summary": "List classrooms", + "description": "Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.", + "tags": [ + "classroom" + ], + "operationId": "classroom/list-classrooms", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/classroom/classroom#list-classrooms" + }, + "parameters": [ + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-classroom" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-classroom" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "classroom", + "subcategory": "classroom" + } + } + }, + "/classrooms/{classroom_id}": { + "get": { + "summary": "Get a classroom", + "description": "Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.", + "tags": [ + "classroom" + ], + "operationId": "classroom/get-a-classroom", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/classroom/classroom#get-a-classroom" + }, + "parameters": [ + { + "$ref": "#/components/parameters/classroom-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/classroom" + }, + "examples": { + "default": { + "$ref": "#/components/examples/classroom" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "classroom", + "subcategory": "classroom" + } + } + }, + "/classrooms/{classroom_id}/assignments": { + "get": { + "summary": "List assignments for a classroom", + "description": "Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.", + "tags": [ + "classroom" + ], + "operationId": "classroom/list-assignments-for-a-classroom", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom" + }, + "parameters": [ + { + "$ref": "#/components/parameters/classroom-id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-classroom-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-classroom-assignment" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "classroom", + "subcategory": "classroom" + } + } + }, + "/codes_of_conduct": { + "get": { + "summary": "Get all codes of conduct", + "description": "Returns array of all GitHub's codes of conduct.", + "tags": [ + "codes-of-conduct" + ], + "operationId": "codes-of-conduct/get-all-codes-of-conduct", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-of-conduct" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-of-conduct-simple-items" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codes-of-conduct", + "subcategory": "codes-of-conduct" + } + } + }, + "/codes_of_conduct/{key}": { + "get": { + "summary": "Get a code of conduct", + "description": "Returns information about the specified GitHub code of conduct.", + "tags": [ + "codes-of-conduct" + ], + "operationId": "codes-of-conduct/get-conduct-code", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct" + }, + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-of-conduct" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-of-conduct" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codes-of-conduct", + "subcategory": "codes-of-conduct" + } + } + }, + "/credentials/revoke": { + "post": { + "summary": "Revoke a list of credentials", + "description": "Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.\n\nThis endpoint currently accepts the following credential types:\n- Personal access tokens (classic) (`ghp_`)\n- Fine-grained personal access tokens (`github_pat_`)\n- OAuth app access tokens (`gho_`)\n- User-to-server tokens from GitHub Apps (`ghu_`)\n- Refresh tokens from GitHub Apps (`ghr_`)\n\n\nRevoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.\nGitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.\n\nTo prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.\n\n> [!NOTE]\n> Any authenticated requests will return a 403.", + "tags": [ + "credentials" + ], + "operationId": "credentials/revoke", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials" + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "credentials": { + "type": "array", + "description": "A list of credentials to be revoked, up to 1000 per request.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 1000 + } + }, + "required": [ + "credentials" + ] + }, + "examples": { + "default": { + "value": { + "credentials": [ + "ghp_1234567890abcdef1234567890abcdef12345678", + "github_pat_0A1B2C3D4E5F6G7H8I9J0K_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456", + "gho_1234567890abcdef1234567890abcdef12345678", + "ghu_1234567890abcdef1234567890abcdef12345678", + "ghr_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab" + ] + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "credentials", + "subcategory": "revoke" + } + } + }, + "/emojis": { + "get": { + "summary": "Get emojis", + "description": "Lists all the emojis available to use on GitHub.", + "operationId": "emojis/get", + "tags": [ + "emojis" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/emojis/emojis#get-emojis" + }, + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/emojis-get" + } + } + } + }, + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "emojis", + "subcategory": "emojis" + } + } + }, + "/enterprises/{enterprise}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an enterprise", + "description": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an enterprise", + "description": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an enterprise", + "description": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an enterprise", + "description": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/actions/oidc/customization/properties/repo": { + "get": { + "summary": "List OIDC custom property inclusions for an enterprise", + "description": "Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/list-oidc-custom-property-inclusions-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "A JSON array of OIDC custom property inclusions", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/oidc-custom-property-inclusion" + } + }, + "examples": { + "default": { + "value": [ + { + "custom_property_name": "environment", + "inclusion_source": "enterprise" + }, + { + "custom_property_name": "team", + "inclusion_source": "enterprise" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "oidc" + } + }, + "post": { + "summary": "Create an OIDC custom property inclusion for an enterprise", + "description": "Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/create-oidc-custom-property-inclusion-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oidc-custom-property-inclusion-input" + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-property-inclusion" + } + } + } + } + }, + "responses": { + "201": { + "description": "OIDC custom property inclusion created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oidc-custom-property-inclusion" + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-property-inclusion" + } + } + } + } + }, + "400": { + "description": "Invalid input" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "description": "Property inclusion already exists" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}": { + "delete": { + "summary": "Delete an OIDC custom property inclusion for an enterprise", + "description": "Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/delete-oidc-custom-property-inclusion-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "custom_property_name", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the custom property to remove from OIDC token inclusion" + } + ], + "responses": { + "204": { + "description": "OIDC custom property inclusion deleted" + }, + "400": { + "description": "Invalid input" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Property inclusion not found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an enterprise", + "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "per_page", + "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "post": { + "summary": "Create a code security configuration for an enterprise", + "description": "Creates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ], + "default": "disabled" + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_options": { + "$ref": "#/components/schemas/code-scanning-options" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "High rish settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations for an enterprise", + "description": "Lists the default code security configurations for an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-default-configurations" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Retrieve a code security configuration of an enterprise", + "description": "Gets a code security configuration available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-single-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a custom code security configuration for an enterprise", + "description": "Updates a code security configuration in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique across the enterprise." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "code_scanning_options": { + "$ref": "#/components/schemas/code-scanning-options" + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-enterprise recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + }, + "delete": { + "summary": "Delete a code security configuration for an enterprise", + "description": "Deletes a code security configuration from an enterprise.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach an enterprise configuration to repositories", + "description": "Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to.", + "enum": [ + "all", + "all_without_configurations" + ] + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "all" + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an enterprise", + "description": "Sets a code security configuration as a default to be applied to new repositories in your enterprise.\n\nThis configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.\n\nThe authenticated user must be an administrator for the enterprise to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with an enterprise code security configuration", + "description": "Lists the repositories associated with an enterprise code security configuration in an organization.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-enterprise-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration-repositories" + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": { + "get": { + "summary": "Get Copilot enterprise usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": { + "get": { + "summary": "Get Copilot enterprise usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/enterprises/{enterprise}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for an enterprise", + "description": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\n\nThe authenticated user must be a member of the enterprise to use this endpoint.\n\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-classifications" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-states" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" + }, + { + "$ref": "#/components/parameters/dependabot-alert-scope" + }, + { + "$ref": "#/components/parameters/dependabot-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dependabot-alert-with-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-alerts-for-organization" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/enterprises/{enterprise}/teams": { + "get": { + "summary": "List enterprise teams", + "description": "List all teams in the enterprise for the authenticated user", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/enterprise-team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-teams-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-teams" + } + }, + "post": { + "summary": "Create an enterprise team", + "description": "To create an enterprise team, the authenticated user must be an owner of the enterprise.", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "nullable": true, + "type": "string", + "description": "A description of the team." + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be set.\n", + "enum": [ + "all", + "disabled" + ], + "default": "disabled" + }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, + "group_id": { + "nullable": true, + "type": "string", + "description": "The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise)." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Justice League", + "description": "A great team.", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/enterprise-team" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-teams-item" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-teams" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + "get": { + "summary": "List members in an enterprise team", + "description": "Lists all team members in an enterprise team.", + "tags": [ + "enterprise-team-memberships" + ], + "operationId": "enterprise-team-memberships/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-members" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + "post": { + "summary": "Bulk add team members", + "description": "Add multiple team members to an enterprise team.", + "tags": [ + "enterprise-team-memberships" + ], + "operationId": "enterprise-team-memberships/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "usernames" + ], + "properties": { + "usernames": { + "type": "array", + "description": "The GitHub user handles to add to the team.", + "items": { + "type": "string", + "description": "The handle for the GitHub user account." + } + } + } + }, + "examples": { + "default": { + "value": { + "usernames": [ + "monalisa", + "octocat" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully added team members.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-members" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + "post": { + "summary": "Bulk remove team members", + "description": "Remove multiple team members from an enterprise team.", + "tags": [ + "enterprise-team-memberships" + ], + "operationId": "enterprise-team-memberships/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "usernames" + ], + "properties": { + "usernames": { + "type": "array", + "description": "The GitHub user handles to be removed from the team.", + "items": { + "type": "string", + "description": "The handle for the GitHub user account." + } + } + } + }, + "examples": { + "default": { + "value": { + "usernames": [ + "monalisa", + "octocat" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully removed team members.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-members" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + "get": { + "summary": "Get enterprise team membership", + "description": "Returns whether the user is a member of the enterprise team.", + "tags": [ + "enterprise-team-memberships" + ], + "operationId": "enterprise-team-memberships/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "User is a member of the enterprise team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/simple-user" + }, + "examples": { + "exampleKey1": { + "$ref": "#/components/examples/simple-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-members" + } + }, + "put": { + "summary": "Add team member", + "description": "Add a team member to an enterprise team.", + "tags": [ + "enterprise-team-memberships" + ], + "operationId": "enterprise-team-memberships/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "201": { + "description": "Successfully added team member", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/simple-user" + }, + "examples": { + "exampleKey1": { + "$ref": "#/components/examples/simple-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-members" + } + }, + "delete": { + "summary": "Remove team membership", + "description": "Remove membership of a specific user from a particular team in an enterprise.", + "tags": [ + "enterprise-team-memberships" + ], + "operationId": "enterprise-team-memberships/remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-members" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + "get": { + "summary": "Get organization assignments", + "description": "Get all organizations assigned to an enterprise team", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "An array of organizations the team is assigned to", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + "post": { + "summary": "Add organization assignments", + "description": "Assign an enterprise team to multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to assign the team to.", + "items": { + "type": "string", + "description": "Organization slug to assign the team to" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully assigned the enterprise team to organizations.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + "post": { + "summary": "Remove organization assignments", + "description": "Unassign an enterprise team from multiple organizations.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/bulk-remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "organization_slugs" + ], + "properties": { + "organization_slugs": { + "type": "array", + "description": "Organization slug to unassign the team from.", + "items": { + "type": "string", + "description": "Organization slug to unassign the team from" + } + } + } + }, + "examples": { + "default": { + "value": { + "organization_slugs": [ + "github" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from organizations." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + "get": { + "summary": "Get organization assignment", + "description": "Check if an enterprise team is assigned to an organization", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/get-assignment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "The team is assigned to the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + }, + "404": { + "description": "The team is not assigned to the organization" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "put": { + "summary": "Add an organization assignment", + "description": "Assign an enterprise team to an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/add", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Successfully assigned the enterprise team to the organization.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + }, + "delete": { + "summary": "Delete an organization assignment", + "description": "Unassign an enterprise team from an organization.", + "tags": [ + "enterprise-team-organizations" + ], + "operationId": "enterprise-team-organizations/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Successfully unassigned the enterprise team from the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-team-organizations" + } + } + }, + "/enterprises/{enterprise}/teams/{team_slug}": { + "get": { + "summary": "Get an enterprise team", + "description": "Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the \"ent:\" prefix. For example, \"My TEam NΓ€me\" would become `ent:my-team-name`.", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/enterprise-team" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-teams-item" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-teams" + } + }, + "patch": { + "summary": "Update an enterprise team", + "description": "To edit a team, the authenticated user must be an enterprise owner.", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string", + "description": "A new name for the team." + }, + "description": { + "nullable": true, + "type": "string", + "description": "A new description for the team." + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field is no longer supported.\nWhether the enterprise team should be reflected in each organization.\nThis value cannot be changed.\n", + "enum": [ + "all", + "disabled" + ], + "default": "disabled" + }, + "organization_selection_type": { + "type": "string", + "description": "Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.\n`disabled`: The team is not assigned to any organizations. This is the default when you create a new team.\n`selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).\n`all`: The team is assigned to all current and future organizations in the enterprise.\n", + "enum": [ + "disabled", + "selected", + "all" + ], + "default": "disabled" + }, + "group_id": { + "nullable": true, + "type": "string", + "description": "The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group." + } + } + }, + "examples": { + "default": { + "value": { + "name": "Justice League", + "description": "A great team.", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/enterprise-team" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-teams-item" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-teams" + } + }, + "delete": { + "summary": "Delete an enterprise team", + "description": "To delete an enterprise team, the authenticated user must be an enterprise owner.\n\nIf you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.", + "tags": [ + "enterprise-teams" + ], + "operationId": "enterprise-teams/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "enterprise-teams", + "subcategory": "enterprise-teams" + } + } + }, + "/events": { + "get": { + "summary": "List public events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-events" + }, + "parameters": [ + { + "$ref": "#/components/parameters/public-events-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-events-items" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/feeds": { + "get": { + "summary": "Get feeds", + "description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n> [!NOTE]\n> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "tags": [ + "activity" + ], + "operationId": "activity/get-feeds", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/feeds#get-feeds" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/feed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/feed" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "feeds" + } + } + }, + "/gists": { + "get": { + "summary": "List gists for the authenticated user", + "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", + "tags": [ + "gists" + ], + "operationId": "gists/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/base-gist" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-gist-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + }, + "post": { + "summary": "Create a gist", + "description": "Allows you to add a new gist with one or more files.\n\n> [!NOTE]\n> Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "operationId": "gists/create", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#create-a-gist" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "Description of the gist", + "example": "Example Ruby script", + "type": "string" + }, + "files": { + "description": "Names and content for the files that make up the gist", + "example": { + "hello.rb": { + "content": "puts \"Hello, World!\"" + } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "content": { + "description": "Content of the file", + "readOnly": false, + "type": "string" + } + }, + "required": [ + "content" + ] + } + }, + "public": { + "oneOf": [ + { + "description": "Flag indicating whether the gist is public", + "example": true, + "type": "boolean", + "default": false + }, + { + "type": "string", + "example": "true", + "default": "false", + "enum": [ + "true", + "false" + ] + } + ] + } + }, + "required": [ + "files" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Creating a gist", + "value": { + "description": "Example of a gist", + "public": false, + "files": { + "README.md": { + "content": "Hello World" + } + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/public": { + "get": { + "summary": "List public gists", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "tags": [ + "gists" + ], + "operationId": "gists/list-public", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#list-public-gists" + }, + "parameters": [ + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/base-gist" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-gist-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/starred": { + "get": { + "summary": "List starred gists", + "description": "List the authenticated user's starred gists:", + "tags": [ + "gists" + ], + "operationId": "gists/list-starred", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#list-starred-gists" + }, + "parameters": [ + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/base-gist" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-gist-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/{gist_id}": { + "get": { + "summary": "Get a gist", + "description": "Gets a specified gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#get-a-gist" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden_gist" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + }, + "patch": { + "summary": "Update a gist", + "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.\n\nAt least one of `description` or `files` is required.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#update-a-gist" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "The description of the gist.", + "example": "Example Ruby script", + "type": "string" + }, + "files": { + "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be\ndeleted if the specified object does not contain at least one of `content` or `filename`.", + "example": { + "hello.rb": { + "content": "blah", + "filename": "goodbye.rb" + } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "The new content of the file.", + "type": "string" + }, + "filename": { + "description": "The new filename for the file.", + "type": "string", + "nullable": true + } + } + } + } + }, + "type": "object", + "nullable": true + }, + "examples": { + "updateGist": { + "summary": "Updating a gist", + "value": { + "description": "An updated gist description", + "files": { + "README.md": { + "content": "Hello World from GitHub" + } + } + } + }, + "deleteFile": { + "summary": "Deleting a gist file", + "value": { + "files": { + "hello.py": null + } + } + }, + "renameFile": { + "summary": "Renaming a gist file", + "value": { + "files": { + "hello.py": { + "filename": "goodbye.py" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-simple" + }, + "examples": { + "updateGist": { + "$ref": "#/components/examples/gist" + }, + "deleteFile": { + "$ref": "#/components/examples/delete-gist-file" + }, + "renameFile": { + "$ref": "#/components/examples/rename-gist-file" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + }, + "delete": { + "summary": "Delete a gist", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#delete-a-gist" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/{gist_id}/comments": { + "get": { + "summary": "List gist comments", + "description": "Lists the comments on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/comments#list-gist-comments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "comments" + } + }, + "post": { + "summary": "Create a gist comment", + "description": "Creates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/create-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/comments#create-a-gist-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + } + }, + "type": "object", + "required": [ + "body" + ] + }, + "examples": { + "default": { + "summary": "Creating a comment in a gist", + "value": { + "body": "This is a comment to a gist" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "comments" + } + } + }, + "/gists/{gist_id}/comments/{comment_id}": { + "get": { + "summary": "Get a gist comment", + "description": "Gets a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/get-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/comments#get-a-gist-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-comment" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden_gist" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "comments" + } + }, + "patch": { + "summary": "Update a gist comment", + "description": "Updates a comment on a gist.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/update-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/comments#update-a-gist-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + } + }, + "type": "object", + "required": [ + "body" + ] + }, + "examples": { + "default": { + "summary": "Updating a comment in a gist", + "value": { + "body": "This is an update to a comment in a gist" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-comment" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Delete a gist comment", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/delete-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/comments#delete-a-gist-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "comments" + } + } + }, + "/gists/{gist_id}/commits": { + "get": { + "summary": "List gist commits", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/list-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#list-gist-commits" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-commit" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-commit-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/{gist_id}/forks": { + "get": { + "summary": "List gist forks", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/list-forks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#list-gist-forks" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist-fork-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + }, + "post": { + "summary": "Fork a gist", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/fork", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#fork-a-gist" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/base-gist" + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-gist" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/{gist_id}/star": { + "get": { + "summary": "Check if a gist is starred", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/check-is-starred", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "responses": { + "204": { + "description": "Response if gist is starred" + }, + "404": { + "description": "Not Found if gist is not starred", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + }, + "put": { + "summary": "Star a gist", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "gists" + ], + "operationId": "gists/star", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#star-a-gist" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + }, + "delete": { + "summary": "Unstar a gist", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/unstar", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#unstar-a-gist" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gists/{gist_id}/{sha}": { + "get": { + "summary": "Get a gist revision", + "description": "Gets a specified gist revision.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.", + "tags": [ + "gists" + ], + "operationId": "gists/get-revision", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#get-a-gist-revision" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gist-id" + }, + { + "name": "sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gist-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gist" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/gitignore/templates": { + "get": { + "summary": "Get all gitignore templates", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "operationId": "gitignore/get-all-templates", + "tags": [ + "gitignore" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "default": { + "value": [ + "Actionscript", + "Android", + "AppceleratorTitanium", + "Autotools", + "Bancha", + "C", + "C++" + ] + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "gitignore", + "subcategory": "gitignore" + } + } + }, + "/gitignore/templates/{name}": { + "get": { + "summary": "Get a gitignore template", + "description": "Get the content of a gitignore template.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.", + "operationId": "gitignore/get-template", + "tags": [ + "gitignore" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template" + }, + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gitignore-template" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gitignore-template" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "gitignore", + "subcategory": "gitignore" + } + } + }, + "/installation/repositories": { + "get": { + "summary": "List repositories accessible to the app installation", + "description": "List repositories that an app installation can access.", + "tags": [ + "apps" + ], + "operationId": "apps/list-repos-accessible-to-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/repository" + } + ] + } + }, + "repository_selection": { + "type": "string", + "example": "selected" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated-2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations" + } + } + }, + "/installation/token": { + "delete": { + "summary": "Revoke an installation access token", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)\" endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/revoke-installation-access-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token" + }, + "parameters": [], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "apps", + "subcategory": "installations" + } + } + }, + "/issues": { + "get": { + "summary": "List issues assigned to the authenticated user", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "filter", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], + "default": "assigned" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "$ref": "#/components/parameters/labels" + }, + { + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "name": "collab", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "orgs", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "owned", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "pulls", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-with-repo-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "issues", + "subcategory": "issues" + } + } + }, + "/licenses": { + "get": { + "summary": "Get all commonly used licenses", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "tags": [ + "licenses" + ], + "operationId": "licenses/get-all-commonly-used", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses" + }, + "parameters": [ + { + "name": "featured", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/license-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/license-simple-items" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "licenses", + "subcategory": "licenses" + } + } + }, + "/licenses/{license}": { + "get": { + "summary": "Get a license", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "tags": [ + "licenses" + ], + "operationId": "licenses/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/licenses/licenses#get-a-license" + }, + "parameters": [ + { + "name": "license", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/license" + }, + "examples": { + "default": { + "$ref": "#/components/examples/license" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "licenses", + "subcategory": "licenses" + } + } + }, + "/markdown": { + "post": { + "summary": "Render a Markdown document", + "description": "Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`.", + "operationId": "markdown/render", + "tags": [ + "markdown" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "text": { + "description": "The Markdown text to render in HTML.", + "type": "string" + }, + "mode": { + "description": "The rendering mode.", + "enum": [ + "markdown", + "gfm" + ], + "default": "markdown", + "example": "markdown", + "type": "string" + }, + "context": { + "description": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", + "type": "string" + } + }, + "required": [ + "text" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Rendering markdown", + "value": { + "text": "Hello **world**" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "headers": { + "Content-Type": { + "$ref": "#/components/headers/content-type" + }, + "Content-Length": { + "example": "279", + "schema": { + "type": "string" + } + }, + "X-CommonMarker-Version": { + "$ref": "#/components/headers/x-common-marker-version" + } + }, + "content": { + "text/html": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "

Hello world

" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "markdown", + "subcategory": "markdown" + } + } + }, + "/markdown/raw": { + "post": { + "summary": "Render a Markdown document in raw mode", + "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", + "operationId": "markdown/render-raw", + "tags": [ + "markdown" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode" + }, + "parameters": [], + "requestBody": { + "required": false, + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "value": { + "text": "Hello **world**" + } + } + } + }, + "text/x-markdown": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "summary": "Rendering markdown", + "value": { + "text": "Hello **world**" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "headers": { + "X-CommonMarker-Version": { + "$ref": "#/components/headers/x-common-marker-version" + } + }, + "content": { + "text/html": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "

Hello world

" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "markdown", + "subcategory": "markdown" + } + } + }, + "/marketplace_listing/accounts/{account_id}": { + "get": { + "summary": "Get a subscription plan for an account", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-subscription-plan-for-account", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace-purchase" + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase" + } + } + } + } + }, + "404": { + "description": "Not Found when the account has not purchased the listing", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/marketplace_listing/plans": { + "get": { + "summary": "List plans", + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/list-plans", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#list-plans" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-listing-plan-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/marketplace_listing/plans/{plan_id}/accounts": { + "get": { + "summary": "List accounts for a plan", + "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/list-accounts-for-plan", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan" + }, + "parameters": [ + { + "$ref": "#/components/parameters/plan-id" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "name": "direction", + "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/marketplace_listing/stubbed/accounts/{account_id}": { + "get": { + "summary": "Get a subscription plan for an account (stubbed)", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-subscription-plan-for-account-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/marketplace-purchase" + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase" + } + } + } + } + }, + "404": { + "description": "Not Found when the account has not purchased the listing" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/marketplace_listing/stubbed/plans": { + "get": { + "summary": "List plans (stubbed)", + "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/list-plans-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#list-plans-stubbed" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-listing-plan-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + "get": { + "summary": "List accounts for a plan (stubbed)", + "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/list-accounts-for-plan-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed" + }, + "parameters": [ + { + "$ref": "#/components/parameters/plan-id" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "name": "direction", + "description": "To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/marketplace-purchase-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/meta": { + "get": { + "summary": "Get GitHub meta information", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n> [!NOTE]\n> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", + "tags": [ + "meta" + ], + "operationId": "meta/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta/meta#get-apiname-meta-information" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-overview" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-overview" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "meta", + "subcategory": "meta" + } + } + }, + "/networks/{owner}/{repo}/events": { + "get": { + "summary": "List public events for a network of repositories", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-events-for-repo-network", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repo-events-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/notifications": { + "get": { + "summary": "List notifications for the authenticated user", + "description": "List all notifications for the current user, sorted by most recently updated.", + "tags": [ + "activity" + ], + "operationId": "activity/list-notifications-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/all" + }, + { + "$ref": "#/components/parameters/participating" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/before" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of results per page (max 50). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/thread" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + }, + "put": { + "summary": "Mark notifications as read", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-notifications-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#mark-notifications-as-read" + }, + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "last_read_at": { + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "type": "string", + "format": "date-time" + }, + "read": { + "description": "Whether the notification has been read.", + "type": "boolean" + } + } + }, + "examples": { + "default": { + "value": { + "last_read_at": "2022-06-10T00:00:00Z", + "read": true + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/notifications-mark-read" + } + } + } + } + }, + "205": { + "description": "Reset Content" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + } + }, + "/notifications/threads/{thread_id}": { + "get": { + "summary": "Get a thread", + "description": "Gets information about a notification thread.", + "tags": [ + "activity" + ], + "operationId": "activity/get-thread", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#get-a-thread" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/thread" + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + }, + "patch": { + "summary": "Mark a thread as read", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-thread-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "205": { + "description": "Reset Content" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + }, + "delete": { + "summary": "Mark a thread as done", + "description": "Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-thread-as-done", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "204": { + "description": "No content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + } + }, + "/notifications/threads/{thread_id}/subscription": { + "get": { + "summary": "Get a thread subscription for the authenticated user", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "tags": [ + "activity" + ], + "operationId": "activity/get-thread-subscription-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/thread-subscription" + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread-subscription" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + }, + "put": { + "summary": "Set a thread subscription", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.", + "tags": [ + "activity" + ], + "operationId": "activity/set-thread-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#set-a-thread-subscription" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "ignored": { + "description": "Whether to block all notifications from a thread.", + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "examples": { + "default": { + "value": { + "ignored": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/thread-subscription" + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread-subscription" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + }, + "delete": { + "summary": "Delete a thread subscription", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "tags": [ + "activity" + ], + "operationId": "activity/delete-thread-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription" + }, + "parameters": [ + { + "$ref": "#/components/parameters/thread-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + } + }, + "/octocat": { + "get": { + "summary": "Get Octocat", + "description": "Get the octocat as ASCII art", + "tags": [ + "meta" + ], + "operationId": "meta/get-octocat", + "parameters": [ + { + "name": "s", + "in": "query", + "description": "The words to show in Octocat's speech bubble", + "schema": { + "type": "string" + }, + "required": false + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/octocat-stream": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "$ref": "#/components/examples/octocat" + } + } + } + } + } + }, + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta/meta#get-octocat" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "meta", + "subcategory": "meta" + } + } + }, + "/organizations": { + "get": { + "summary": "List organizations", + "description": "Lists all organizations, in the order that they were created.\n\n> [!NOTE]\n> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-organizations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/since-org" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/organizations/{org}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an organization", + "description": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an organization", + "description": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/organizations/{org}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an organization", + "description": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an organization", + "description": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/organizations/{org}/dependabot/repository-access": { + "get": { + "summary": "Lists the repositories Dependabot can access in an organization", + "description": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "page", + "in": "query", + "description": "The page number of results to fetch.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "default": 1 + } + }, + { + "name": "per_page", + "in": "query", + "description": "Number of results per page.", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-repository-access-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-repository-access-details" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + }, + "patch": { + "summary": "Updates Dependabot's repository access list for an organization", + "description": "Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.\n\n> [!NOTE]\n> This operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.\n\n**Example request body:**\n```json\n{\n \"repository_ids_to_add\": [123, 456],\n \"repository_ids_to_remove\": [789]\n}\n```", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-repository-access-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_ids_to_add": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to add." + }, + "repository_ids_to_remove": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of repository IDs to remove." + } + }, + "example": { + "repository_ids_to_add": [ + 123, + 456 + ], + "repository_ids_to_remove": [ + 789 + ] + } + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status." + }, + "add-example": { + "summary": "Add repositories", + "value": { + "repository_ids_to_add": [ + 123, + 456 + ] + } + }, + "remove-example": { + "summary": "Remove repositories", + "value": { + "repository_ids_to_remove": [ + 789 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/organizations/{org}/dependabot/repository-access/default-level": { + "put": { + "summary": "Set the default repository access level for Dependabot", + "description": "Sets the default level of repository access Dependabot will have while performing an update. Available values are:\n- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.\n- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.\n\nUnauthorized users will not see the existence of this endpoint.\n\nThis operation supports both server-to-server and user-to-server access.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-repository-access-default-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal" + } + }, + "required": [ + "default_level" + ] + }, + "examples": { + "204": { + "summary": "Example with a 'succeeded' status.", + "value": { + "default_level": "public" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "repository-access" + } + } + }, + "/organizations/{org}/settings/billing/budgets": { + "get": { + "summary": "Get all budgets for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.", + "tags": [ + "billing" + ], + "operationId": "billing/get-all-budgets-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "page", + "description": "The page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 10).", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/get_all_budgets" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "budgets" + } + } + }, + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + "get": { + "summary": "Get a budget by ID for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a budget by ID. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/get-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "budgets" + } + }, + "patch": { + "summary": "Update a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nUpdates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/update-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + }, + "examples": { + "update-budget": { + "summary": "Update budget example", + "value": { + "prevent_further_usage": false, + "budget_amount": 10, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Budget updated successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "example": "Budget successfully updated." + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded" + }, + "budget_alerting": { + "type": "object", + "required": [ + "will_alert", + "alert_recipients" + ], + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget" + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts" + } + } + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "default": "" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or SKU that will be covered in the budget" + } + } + } + } + }, + "examples": { + "update-budget": { + "$ref": "#/components/examples/update-budget" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + }, + "feature-not-enabled": { + "value": { + "message": "Not Found", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to update budget.", + "documentation_url": "https://docs.github.com/rest/billing/budgets#update-a-budget" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "billing", + "subcategory": "budgets" + } + }, + "delete": { + "summary": "Delete a budget for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nDeletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.", + "tags": [ + "billing" + ], + "operationId": "billing/delete-budget-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/budget" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/delete-budget" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "budgets" + } + } + }, + "/organizations/{org}/settings/billing/premium_request/usage": { + "get": { + "summary": "Get billing premium request usage report for an organization", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-premium-request-usage-report-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month-default" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-user" + }, + { + "$ref": "#/components/parameters/billing-usage-report-model" + }, + { + "$ref": "#/components/parameters/billing-usage-report-product" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_premium_request_usage_report_org" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "usage" + } + } + }, + "/organizations/{org}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for an organization", + "description": "Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see \"[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform).\"", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-report-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_report_org" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "usage" + } + } + }, + "/organizations/{org}/settings/billing/usage/summary": { + "get": { + "summary": "Get billing usage summary for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-summary-report-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month-default" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-repository" + }, + { + "$ref": "#/components/parameters/billing-usage-report-product" + }, + { + "$ref": "#/components/parameters/billing-usage-report-sku" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_summary_report_org" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "usage" + } + } + }, + "/orgs/{org}": { + "get": { + "summary": "Get an organization", + "description": "Gets information about an organization.\n\nWhen the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nTo see the full details about an organization, the authenticated user must be an organization owner.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.\n\nTo see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#get-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-full" + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/organization-full" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "patch": { + "summary": "Update an organization", + "description": "> [!WARNING]\n> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\n> [!WARNING]\n> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).\n\nUpdates the organization's profile and member privileges.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#update-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billing_email": { + "type": "string", + "description": "Billing email address. This address is not publicized." + }, + "company": { + "type": "string", + "description": "The company name." + }, + "email": { + "type": "string", + "description": "The publicly visible email address." + }, + "twitter_username": { + "type": "string", + "description": "The Twitter username of the company." + }, + "location": { + "type": "string", + "description": "The location." + }, + "name": { + "type": "string", + "description": "The shorthand name of the company." + }, + "description": { + "type": "string", + "description": "The description of the company. The maximum size is 160 characters." + }, + "has_organization_projects": { + "type": "boolean", + "description": "Whether an organization can use organization projects." + }, + "has_repository_projects": { + "type": "boolean", + "description": "Whether repositories that belong to the organization can use repository projects." + }, + "default_repository_permission": { + "type": "string", + "description": "Default permission level members have for organization repositories.", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read" + }, + "members_can_create_repositories": { + "type": "boolean", + "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "default": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation." + }, + "members_allowed_repository_creation_type": { + "type": "string", + "description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "enum": [ + "all", + "private", + "none" + ] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "default": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "description": "Whether organization members can fork private organization repositories.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.", + "default": false + }, + "blog": { + "type": "string", + "example": "\"http://github.blog\"" + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret." + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + } + } + }, + "examples": { + "default": { + "value": { + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-full" + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/validation-error-simple" + } + ] + } + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_secret_scanning_custom_link_enablement_field", + "patch": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "secret_scanning_push_protection_custom_link_enabled": null + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + }, + "delete": { + "summary": "Delete an organization", + "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", + "operationId": "orgs/delete", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#delete-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_delete_organization_trade_compliance_respose_status", + "patch": { + "responses": { + "451": { + "$ref": "#/components/responses/validation_failed" + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for an organization", + "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-usage-org-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-usage-org-enterprise" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/cache/usage-by-repository": { + "get": { + "summary": "List repositories with GitHub Actions cache usage for an organization", + "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nOAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage-by-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repository_cache_usages" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repository_cache_usages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-cache-usage-by-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-actions-cache-usage-by-repo" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/orgs/{org}/actions/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners for an organization", + "description": "Lists all GitHub-hosted runners configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-hosted-runners-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "post": { + "summary": "Create a GitHub-hosted runner for an organization", + "description": "Creates a GitHub-hosted runner for an organization.\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/create-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "image": { + "description": "The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the runner image.", + "type": "string" + }, + "source": { + "description": "The source of the runner image.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, + "version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true + } + } + }, + "size": { + "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" + }, + "image_gen": { + "description": "Whether this runner should be used to generate custom images.", + "type": "boolean", + "default": false + } + }, + "required": [ + "name", + "image", + "size", + "runner_group_id" + ] + }, + "examples": { + "default": { + "value": { + "name": "My Hosted runner", + "image": { + "id": "ubuntu-latest", + "source": "github" + }, + "runner_group_id": 1, + "size": "4-core", + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom": { + "get": { + "summary": "List custom images for an organization", + "description": "List custom images for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-images-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + "get": { + "summary": "Get a custom image definition for GitHub Actions Hosted Runners", + "description": "Get a custom image definition for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a custom image from the organization", + "description": "Delete a custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + "get": { + "summary": "List image versions of a custom image for an organization", + "description": "List image versions of a custom image for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-custom-image-versions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "image_versions" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "image_versions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + "get": { + "summary": "Get an image version of a custom image for GitHub Actions Hosted Runners", + "description": "Get an image version of a custom image for GitHub Actions Hosted Runners.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-image-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete an image version of custom image from the organization", + "description": "Delete an image version of custom image from the organization.\n\nOAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-custom-image-version-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/actions-custom-image-definition-id" + }, + { + "$ref": "#/components/parameters/actions-custom-image-version" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + "get": { + "summary": "Get GitHub-owned images for GitHub-hosted runners in an organization", + "description": "Get the list of GitHub-owned images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-github-owned-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-curated-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/images/partner": { + "get": { + "summary": "Get partner images for GitHub-hosted runners in an organization", + "description": "Get the list of partner images available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-partner-images-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "images" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-curated-image" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/limits": { + "get": { + "summary": "Get limits on GitHub-hosted runners for an organization", + "description": "Get the GitHub-hosted runners limits for an organization.", + "operationId": "actions/get-hosted-runners-limits-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner-limits" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-limits-default" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + "get": { + "summary": "Get GitHub-hosted runners machine specs for an organization", + "description": "Get the list of machine specs available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-machine-specs-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "machine_specs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "machine_specs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-machine-spec" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/platforms": { + "get": { + "summary": "Get platforms for GitHub-hosted runners in an organization", + "description": "Get the list of platforms available for GitHub-hosted runners for an organization.", + "operationId": "actions/get-hosted-runners-platforms-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "platforms" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "platforms": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "platforms": [ + "linux-x64", + "win-x64" + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + "get": { + "summary": "Get a GitHub-hosted runner for an organization", + "description": "Gets a GitHub-hosted runner configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hosted-runner-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "patch": { + "summary": "Update a GitHub-hosted runner for an organization", + "description": "Updates a GitHub-hosted runner for an organization.\nOAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.", + "operationId": "actions/update-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hosted-runner-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "runner_group_id": { + "description": "The existing runner group to add this runner to.", + "type": "integer" + }, + "maximum_runners": { + "description": "The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost.", + "type": "integer" + }, + "enable_static_ip": { + "description": "Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits`", + "type": "boolean" + }, + "size": { + "description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`", + "type": "string" + }, + "image_id": { + "description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.", + "type": "string" + }, + "image_version": { + "description": "The version of the runner image to deploy. This is relevant only for runners using custom images.", + "type": "string", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "name": "My larger runner", + "runner_group_id": 1, + "maximum_runners": 50, + "enable_static_ip": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "hosted-runners" + } + }, + "delete": { + "summary": "Delete a GitHub-hosted runner for an organization", + "description": "Deletes a GitHub-hosted runner for an organization.", + "operationId": "actions/delete-hosted-runner-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hosted-runner-id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-hosted-runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "hosted-runners" + } + } + }, + "/orgs/{org}/actions/oidc/customization/properties/repo": { + "get": { + "summary": "List OIDC custom property inclusions for an organization", + "description": "Lists the repository custom properties that are included in the OIDC token for repository actions in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/list-oidc-custom-property-inclusions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "A JSON array of OIDC custom property inclusions", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/oidc-custom-property-inclusion" + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment" + }, + { + "property_name": "team" + } + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "oidc" + } + }, + "post": { + "summary": "Create an OIDC custom property inclusion for an organization", + "description": "Adds a repository custom property to be included in the OIDC token for repository actions in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/create-oidc-custom-property-inclusion-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oidc-custom-property-inclusion-input" + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-property-inclusion" + } + } + } + } + }, + "responses": { + "201": { + "description": "OIDC custom property inclusion created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oidc-custom-property-inclusion" + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-property-inclusion" + } + } + } + } + }, + "400": { + "description": "Invalid input" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "description": "Property inclusion already exists" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}": { + "delete": { + "summary": "Delete an OIDC custom property inclusion for an organization", + "description": "Removes a repository custom property from being included in the OIDC token for repository actions in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/delete-oidc-custom-property-inclusion-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "custom_property_name", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the custom property to remove from OIDC token inclusion" + } + ], + "responses": { + "204": { + "description": "OIDC custom property inclusion deleted" + }, + "400": { + "description": "Invalid input" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "description": "Property inclusion not found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/orgs/{org}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for an organization", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/get-oidc-custom-sub-template-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "A JSON serialized template for OIDC subject claim customization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oidc-custom-sub" + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-sub" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "oidc" + } + }, + "put": { + "summary": "Set the customization template for an OIDC subject claim for an organization", + "description": "Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "oidc" + ], + "operationId": "oidc/update-oidc-custom-sub-template-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "type": "object", + "properties": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-sub" + } + } + } + } + }, + "responses": { + "201": { + "description": "Empty response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/orgs/{org}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-organization-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-organization-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "$ref": "#/components/schemas/enabled-repositories" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "sha_pinning_required": { + "$ref": "#/components/schemas/sha-pinning-required" + } + }, + "required": [ + "enabled_repositories" + ] + }, + "examples": { + "default": { + "value": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "sha_pinning_required": true + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for an organization", + "description": "Gets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for an organization", + "description": "Sets artifact and log retention settings for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "application/json": { + "value": { + "days": 100 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for an organization", + "description": "Gets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for an organization", + "description": "Sets the fork PR contributor approval policy for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for an organization", + "description": "Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for an organization", + "description": "Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "403": { + "description": "Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions and reusable workflows for an organization", + "description": "Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions and reusable workflows for an organization", + "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners": { + "get": { + "summary": "Get self-hosted runners settings for an organization", + "description": "Gets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/get-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/self-hosted-runners-settings" + }, + "examples": { + "response": { + "summary": "Example response", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set self-hosted runners settings for an organization", + "description": "Sets the settings for self-hosted runners for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used in the organization", + "enum": [ + "all", + "selected", + "none" + ] + } + } + }, + "examples": { + "application/json": { + "value": { + "enabled_repositories": "all" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + "get": { + "summary": "List repositories allowed to use self-hosted runners in an organization", + "description": "Lists repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/list-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set repositories allowed to use self-hosted runners in an organization", + "description": "Sets repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/set-selected-repositories-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "selected_repository_ids" + ], + "properties": { + "selected_repository_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "IDs of repositories that can use repository-level self-hosted runners" + } + } + }, + "examples": { + "application/json": { + "value": { + "selected_repository_ids": [ + 1, + 2, + 3 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to the list of repositories allowed to use self-hosted runners in an organization", + "description": "Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/enable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Remove a repository from the list of repositories allowed to use self-hosted runners in an organization", + "description": "Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the \"Actions policies\" fine-grained permission to use this endpoint.", + "operationId": "actions/disable-selected-repository-self-hosted-runners-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for an organization", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-get-default-workflow-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-default-workflow-permissions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set default workflow permissions for an organization", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Success response" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-default-workflow-permissions" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an organization", + "description": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runner-groups-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/visible-to-repository" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-groups-org" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-groups-org" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an organization", + "description": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/get-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group-item" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an organization", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ] + }, + "allows_public_repositories": { + "description": "Whether the runner group can be used by `public` repositories.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner-groups-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + "get": { + "summary": "List GitHub-hosted runners in a group for an organization", + "description": "Lists the GitHub-hosted runners in an organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-github-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-hosted-runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-hosted-runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + "get": { + "summary": "List repository access to a self-hosted runner group in an organization", + "description": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-paginated" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "put": { + "summary": "Set repository access for a self-hosted runner group in an organization", + "description": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + "put": { + "summary": "Add repository access to a self-hosted runner group in an organization", + "description": "Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Remove repository access to a self-hosted runner group in an organization", + "description": "Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-repo-access-to-self-hosted-runner-group-in-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an organization", + "description": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/list-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "put": { + "summary": "Set self-hosted runners in a group for an organization", + "description": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/set-self-hosted-runners-in-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "runners" + ] + }, + "examples": { + "default": { + "value": { + "runners": [ + 9, + 2 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an organization", + "description": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/add-self-hosted-runner-to-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an organization", + "description": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "actions/remove-self-hosted-runner-from-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-group-id" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an organization", + "description": "Lists all self-hosted runners configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization" + }, + "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for an organization", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-runner-applications-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-application" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-application-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for an organization", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the organization.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the new runner." + }, + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." + }, + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "$ref": "#/components/responses/actions_runner_jitconfig" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for an organization", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-registration-token-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for an organization", + "description": "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\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-remove-token-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an organization", + "description": "Gets a specific self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/get-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for an organization", + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-labels-for-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "post": { + "summary": "Add custom labels to a self-hosted runner for an organization", + "description": "Adds custom labels to a self-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "labels" + ], + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "description": "The names of the custom labels to add to the runner.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "labels": [ + "gpu", + "accelerated" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for an organization", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "labels" + ], + "properties": { + "labels": { + "type": "array", + "minItems": 0, + "maxItems": 100, + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "labels": [ + "gpu", + "accelerated" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "delete": { + "summary": "Remove all custom labels from a self-hosted runner for an organization", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels_readonly" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + "delete": { + "summary": "Remove a custom label from a self-hosted runner for an organization", + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/runner-id" + }, + { + "$ref": "#/components/parameters/runner-label-name" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-organization-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read secrets\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "encrypted_value", + "key_id", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-paginated" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. For more information about setting the visibility, see [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/actions/variables": { + "get": { + "summary": "List organization variables", + "description": "Lists all organization variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-organization-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "post": { + "summary": "Create an organization variable", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#create-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "name", + "value", + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a variable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}": { + "get": { + "summary": "Get an organization variable", + "description": "Gets a specific variable in an organization.\n\nThe authenticated user must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#get-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "patch": { + "summary": "Update an organization variable", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/update-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#update-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + }, + "visibility": { + "type": "string", + "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete an organization variable", + "description": "Deletes an organization variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories": { + "get": { + "summary": "List selected repositories for an organization variable", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-paginated" + } + } + } + } + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "put": { + "summary": "Set selected repositories for an organization variable", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "The IDs of the repositories that can access the organization variable.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization variable", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Remove selected repository from an organization variable", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response when the visibility of the variable is not set to `selected`" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/orgs/{org}/artifacts/metadata/deployment-record": { + "post": { + "summary": "Create an artifact deployment record", + "description": "Create or update deployment records for an artifact associated\nwith an organization.\nThis endpoint allows you to record information about a specific\nartifact, such as its name, digest, environments, cluster, and\ndeployment.\nThe deployment name has to be uniqe within a cluster (i.e a\ncombination of logical, physical environment and cluster) as it\nidentifies unique deployment.\nMultiple requests for the same combination of logical, physical\nenvironment, cluster and deployment name will only create one\nrecord, successive request will update the existing record.\nThis allows for a stable tracking of a deployment where the actual\ndeployed artifact can change over time.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-artifact-deployment-record", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact.", + "minLength": 1, + "maxLength": 256, + "example": "libfoo" + }, + "digest": { + "type": "string", + "description": "The hex encoded digest of the artifact.", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version.", + "minLength": 1, + "maxLength": 100, + "x-multi-segment": true, + "example": "1.2.3" + }, + "status": { + "type": "string", + "description": "The status of the artifact. Can be either deployed or decommissioned.", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "cluster": { + "type": "string", + "description": "The deployment cluster.", + "maxLength": 128 + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n", + "maxLength": 256 + }, + "tags": { + "type": "object", + "description": "The tags associated with the deployment.", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 5 + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "example": "my-github-repo" + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the created or updated record in the response body.\n" + } + }, + "required": [ + "name", + "digest", + "status", + "logical_environment", + "deployment_name" + ] + }, + "examples": { + "default": { + "value": { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "status": "deployed", + "logical_environment": "prod", + "physical_environment": "pacific-east", + "cluster": "moda-1", + "deployment_name": "deployment-pod", + "tags": { + "data-access": "sensitive" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Artifact deployment record stored successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + "post": { + "summary": "Set cluster deployment records", + "description": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-cluster-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "cluster", + "in": "path", + "description": "The cluster name.", + "required": true, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "^[a-zA-Z0-9._-]+$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "logical_environment": { + "type": "string", + "description": "The stage of the deployment.", + "minLength": 1, + "maxLength": 128 + }, + "physical_environment": { + "type": "string", + "description": "The physical region of the deployment.", + "maxLength": 128 + }, + "deployments": { + "type": "array", + "description": "The list of deployments to record.", + "maxItems": 1000, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.\n", + "minLength": 1, + "maxLength": 256 + }, + "digest": { + "type": "string", + "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.\n", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n", + "maxLength": 100, + "x-multi-segment": true, + "example": "1.2.3" + }, + "status": { + "type": "string", + "description": "The deployment status of the artifact.", + "default": "deployed", + "enum": [ + "deployed", + "decommissioned" + ] + }, + "deployment_name": { + "type": "string", + "description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a record set, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\nThe deployment_name must be unique across all entries in the deployments array.\n", + "minLength": 1, + "maxLength": 256 + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "example": "my-github-repo" + }, + "tags": { + "type": "object", + "description": "Key-value pairs to tag the deployment record.", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + } + }, + "required": [ + "name", + "deployment_name", + "digest" + ] + } + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the set records in the response body\n" + } + }, + "required": [ + "logical_environment", + "deployments" + ] + }, + "examples": { + "default": { + "value": { + "logical_environment": "prod", + "physical_environment": "pacific-east", + "deployments": [ + { + "name": "awesome-image", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "version": "2.1.0", + "status": "deployed", + "deployment_name": "deployment-pod", + "tags": { + "runtime-risk": "sensitive-data" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Deployment records created or updated successfully.\n", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records created", + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "insufficient_repo_permissions": { + "value": { + "message": { + "cause": "artifact metadata write permission required on one or more repositories", + "repositories": [ + 123, + 345 + ] + } + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/metadata/storage-record": { + "post": { + "summary": "Create artifact metadata storage record", + "description": "Create metadata storage records for artifacts associated with an organization.\nThis endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and\nassociated with a repository owned by the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-artifact-storage-record", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the artifact.", + "example": "libfoo", + "minLength": 1, + "maxLength": 256 + }, + "digest": { + "type": "string", + "description": "The digest of the artifact (algorithm:hex-encoded-digest).", + "example": "sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0...", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "version": { + "type": "string", + "description": "The artifact version.", + "minLength": 1, + "maxLength": 100, + "x-multi-segment": true, + "example": "1.2.3" + }, + "artifact_url": { + "type": "string", + "format": "uri", + "pattern": "^https://", + "description": "The URL where the artifact is stored.", + "example": "https://reg.example.com/artifactory/bar/libfoo-1.2.3" + }, + "path": { + "type": "string", + "format": "uri", + "description": "The path of the artifact.", + "example": "com/github/bar/libfoo-1.2.3" + }, + "registry_url": { + "type": "string", + "format": "uri", + "pattern": "^https://", + "description": "The base URL of the artifact registry.", + "example": "https://reg.example.com/artifactory/", + "minLength": 1 + }, + "repository": { + "type": "string", + "description": "The repository name within the registry.", + "example": "bar" + }, + "status": { + "type": "string", + "description": "The status of the artifact (e.g., active, inactive).", + "example": "active", + "enum": [ + "active", + "eol", + "deleted" + ], + "default": "active" + }, + "github_repository": { + "type": "string", + "description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[A-Za-z0-9.\\-_]+$", + "example": "my-github-repo" + }, + "return_records": { + "type": "boolean", + "default": true, + "description": "If true, the endpoint will return the created record in the response body.\n" + } + }, + "required": [ + "name", + "digest", + "registry_url" + ] + }, + "examples": { + "default": { + "value": { + "name": "libfoo", + "version": "1.2.3", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", + "registry_url": "https://reg.example.com/artifactory/", + "repository": "bar", + "status": "active" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Artifact metadata storage record stored successfully.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer", + "example": 1 + }, + "storage_records": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "digest": { + "type": "string" + }, + "artifact_url": { + "type": "string", + "nullable": true + }, + "registry_url": { + "type": "string" + }, + "repository": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + }, + "required": [ + "total_count" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "storage_records": [ + { + "name": "libfoo", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", + "registry_url": "https://reg.example.com/artifactory/", + "repository": "bar", + "status": "active", + "created_at": "2023-10-01T12:00:00Z", + "updated_at": "2023-10-01T12:00:00Z" + } + ] + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + "get": { + "summary": "List artifact deployment records", + "description": "List deployment records for an artifact metadata associated with an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-artifact-deployment-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/subject-digest" + } + ], + "responses": { + "200": { + "description": "Successful response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment records for this digest and organization", + "example": 3, + "type": "integer" + }, + "deployment_records": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact-deployment-record" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-deployment-record-list" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + "get": { + "summary": "List artifact storage records", + "description": "List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-artifact-storage-records", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "example": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "schema": { + "type": "string", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of storage records for this digest and organization", + "example": 3, + "type": "integer" + }, + "storage_records": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "digest": { + "type": "string" + }, + "artifact_url": { + "type": "string" + }, + "registry_url": { + "type": "string" + }, + "repository": { + "type": "string" + }, + "status": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "storage_records": [ + { + "name": "libfoo-1.2.3", + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "artifact_url": "https://reg.example.com/artifactory/bar/libfoo-1.2.3", + "registry_url": "https://reg.example.com/artifactory/", + "repository": "bar", + "status": "active", + "created_at": "2023-10-01T12:00:00Z", + "updated_at": "2023-10-01T12:00:00Z" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "artifact-metadata" + } + } + }, + "/orgs/{org}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/bulk-subject-digest-body" + }, + "withPredicateType": { + "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The bundle of the attestation." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." + }, + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." + }, + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations-bulk" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations_subject_digests": { + "additionalProperties": { + "items": { + "properties": { + "bundle": null + } + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by an org.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + } + } + }, + "/orgs/{org}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/attestations#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "nullable": true, + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations": { + "items": { + "properties": { + "bundle": null + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/blocks": { + "get": { + "summary": "List users blocked by an organization", + "description": "List the users blocked by an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-blocked-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/orgs/{org}/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by an organization", + "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-blocked-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "If the user is blocked" + }, + "404": { + "description": "If the user is not blocked", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + }, + "put": { + "summary": "Block a user from an organization", + "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "tags": [ + "orgs" + ], + "operationId": "orgs/block-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + }, + "delete": { + "summary": "Unblock a user from an organization", + "description": "Unblocks the given user on behalf of the specified organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/unblock-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "blocking" + } + } + }, + "/orgs/{org}/campaigns": { + "get": { + "summary": "List campaigns for an organization", + "description": "Lists campaigns in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/list-org-campaigns", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "state", + "description": "If specified, only campaigns with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/campaign-state" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "ends_at", + "published" + ], + "default": "created" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/campaign-summary" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/campaign-org-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "campaigns", + "subcategory": "campaigns" + } + }, + "post": { + "summary": "Create a campaign for an organization", + "description": "Create a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.\n\nFine-grained tokens must have the \"Code scanning alerts\" repository permissions (read) on all repositories included\nin the campaign.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/create-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the campaign", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "description": "A description for the campaign", + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The login of each manager", + "type": "string" + } + }, + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" + } + }, + "ends_at": { + "description": "The end date and time of the campaign. The date must be in the future.", + "type": "string", + "format": "date-time" + }, + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": "string", + "format": "uri", + "nullable": true + }, + "code_scanning_alerts": { + "description": "The code scanning alerts to include in this campaign", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "repository_id": { + "type": "integer", + "description": "The repository id" + }, + "alert_numbers": { + "type": "array", + "description": "The alert numbers", + "minItems": 1, + "items": { + "type": "integer" + } + } + }, + "required": [ + "repository_id", + "alert_numbers" + ] + }, + "nullable": true + }, + "generate_issues": { + "description": "If true, will automatically generate issues for the campaign. The default is false.", + "type": "boolean", + "default": false + } + }, + "required": [ + "name", + "description", + "ends_at" + ], + "oneOf": [ + { + "required": [ + "code_scanning_alerts" + ] + }, + { + "required": [ + "secret_scanning_alerts" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "name": "Critical CodeQL alerts", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + "octocat" + ], + "ends_at": "2024-03-14T00:00:00Z", + "code_scanning_alerts": [ + { + "repository_id": 1296269, + "alert_numbers": [ + 1, + 2 + ] + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/campaign-summary" + }, + "examples": { + "default": { + "$ref": "#/components/examples/campaign-summary" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "429": { + "description": "Too Many Requests" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "campaigns", + "subcategory": "campaigns" + } + } + }, + "/orgs/{org}/campaigns/{campaign_number}": { + "get": { + "summary": "Get a campaign for an organization", + "description": "Gets a campaign for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/get-campaign-summary", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/campaign-summary" + }, + "examples": { + "default": { + "$ref": "#/components/examples/campaign-summary" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "campaigns", + "subcategory": "campaigns" + } + }, + "patch": { + "summary": "Update a campaign", + "description": "Updates a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/update-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#update-a-campaign" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the campaign", + "type": "string", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "description": "A description for the campaign", + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "managers": { + "description": "The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied.", + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + } + }, + "team_managers": { + "description": "The slugs of the teams to set as the campaign managers.", + "type": "array", + "maxItems": 10, + "items": { + "description": "The slug of each team", + "type": "string" + } + }, + "ends_at": { + "description": "The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "contact_link": { + "description": "The contact link of the campaign. Must be a URI.", + "type": "string", + "format": "uri", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/campaign-state" + } + } + }, + "examples": { + "default": { + "value": { + "name": "Critical CodeQL alerts" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/campaign-summary" + }, + "examples": { + "default": { + "$ref": "#/components/examples/campaign-summary" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "campaigns", + "subcategory": "campaigns" + } + }, + "delete": { + "summary": "Delete a campaign for an organization", + "description": "Deletes a campaign in an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.", + "tags": [ + "campaigns" + ], + "operationId": "campaigns/delete-campaign", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "campaign_number", + "description": "The campaign number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Deletion successful" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "campaigns", + "subcategory": "campaigns" + } + } + }, + "/orgs/{org}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for an organization", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/tool-name" + }, + { + "$ref": "#/components/parameters/tool-guid" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-state-query" + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-severity" + } + }, + { + "name": "assignees", + "description": "Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-organization-alert-items" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-organization-alert-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/orgs/{org}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an organization", + "description": "Lists all code security configurations available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "target_type", + "in": "query", + "description": "The target type of the code security configuration", + "required": false, + "schema": { + "type": "string", + "enum": [ + "global", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "in": "query", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-list" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "post": { + "summary": "Create a code security configuration", + "description": "Creates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/create-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ], + "default": "disabled" + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "enabled" + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.", + "default": false + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_options": { + "$ref": "#/components/schemas/code-scanning-options" + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "not_set" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ], + "default": "enforced" + } + }, + "required": [ + "name", + "description" + ] + }, + "examples": { + "default": { + "summary": "Example for a code security configuration", + "value": { + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "secret_scanning": "enabled" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successfully created code security configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/defaults": { + "get": { + "summary": "Get default code security configurations", + "description": "Lists the default code security configurations for an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-default-configurations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-default-configurations" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-default-configurations" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/detach": { + "delete": { + "summary": "Detach configurations from repositories", + "description": "Detach code security configuration(s) from a set of repositories.\nRepositories will retain their settings but will no longer be associated with the configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/detach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to detach from configurations. Up to 250 IDs can be provided.", + "minItems": 1, + "maxItems": 250, + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + } + }, + "examples": { + "default": { + "summary": "Example for detaching repositories from configurations.", + "value": { + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}": { + "get": { + "summary": "Get a code security configuration", + "description": "Gets a code security configuration available in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "patch": { + "summary": "Update a code security configuration", + "description": "Updates a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/update-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "description": { + "type": "string", + "description": "A description of the code security configuration", + "maxLength": 255 + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.\n\n> [!WARNING]\n> `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.\n", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "code_security": { + "type": "string", + "description": "The enablement status of GitHub Code Security features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "$ref": "#/components/schemas/code-scanning-default-setup-options" + }, + "code_scanning_options": { + "$ref": "#/components/schemas/code-scanning-options" + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ], + "default": "disabled" + }, + "secret_protection": { + "type": "string", + "description": "The enablement status of GitHub Secret Protection features.", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example for updating a code security configuration", + "value": { + "name": "octo-org recommended settings v2", + "secret_scanning": "disabled", + "code_scanning_default_setup": "enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when a configuration is updated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-updated" + } + } + } + } + }, + "204": { + "description": "Response when no new updates are made" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + }, + "delete": { + "summary": "Delete a code security configuration", + "description": "Deletes the desired code security configuration from an organization.\nRepositories attached to the configuration will retain their settings but will no longer be associated with\nthe configuration.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/delete-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + "post": { + "summary": "Attach a configuration to repositories", + "description": "Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.\n\nIf insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/attach-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "scope": { + "type": "string", + "description": "The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`", + "enum": [ + "all", + "all_without_configurations", + "public", + "private_or_internal", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`.", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "scope" + ] + }, + "examples": { + "default": { + "summary": "Example for attaching a configuration to some repositories", + "value": { + "scope": "selected", + "selected_repository_ids": [ + 32, + 91 + ] + } + } + } + } + } + }, + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + "put": { + "summary": "Set a code security configuration as a default for an organization", + "description": "Sets a code security configuration as a default to be applied to new repositories in your organization.\n\nThis configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/set-configuration-as-default", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specify which types of repository this security configuration should be applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + } + } + }, + "examples": { + "default": { + "summary": "Set this configuration to be enabled by default on all new repositories.", + "value": { + "default_for_new_repos": "all" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Default successfully changed.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "default_for_new_repos": { + "type": "string", + "description": "Specifies which types of repository this security configuration is applied to by default.", + "enum": [ + "all", + "none", + "private_and_internal", + "public" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "examples": { + "default": { + "value": { + "default_for_new_repos": "all", + "configuration": { + "$ref": "#/components/examples/code-security-configuration" + } + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + "get": { + "summary": "Get repositories associated with a code security configuration", + "description": "Lists the repositories associated with a code security configuration in an organization.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-repositories-for-configuration", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/configuration-id" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "status", + "description": "A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.\n\nCan be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-security-configuration-repositories" + } + }, + "examples": { + "default": { + "summary": "Example of code security configuration repositories", + "value": [ + { + "status": "attached", + "repository": { + "$ref": "#/components/examples/simple-repository" + } + } + ] + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/orgs/{org}/codespaces": { + "get": { + "summary": "List codespaces for the organization", + "description": "Lists the codespaces associated to a specified organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "codespaces" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "codespaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespace" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-list" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/codespaces/access": { + "put": { + "summary": "Manage access control for organization codespaces", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/set-codespaces-access", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "visibility": { + "type": "string", + "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.", + "enum": [ + "disabled", + "selected_members", + "all_members", + "all_members_and_outside_collaborators" + ] + }, + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "visibility": "selected_members", + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response when successfully modifying permissions." + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/codespaces/access/selected_users": { + "post": { + "summary": "Add users to Codespaces access for an organization", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/set-codespaces-access-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "deprecated": true, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response when successfully modifying permissions." + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + }, + "delete": { + "summary": "Remove users from Codespaces access for an organization", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-codespaces-access-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization" + }, + "deprecated": true, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members and outside collaborators whose codespaces should not be billed to the organization.", + "items": { + "type": "string" + }, + "maxItems": 100 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "johnDoe", + "atomIO" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response when successfully modifying permissions." + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "400": { + "description": "Users are neither members nor collaborators of this organization." + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/codespaces/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespaces-org-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-codespaces-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets an organization development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-org-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-codespaces-secret" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "The ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes an organization development environment secret using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-paginated" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization development environment secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organization-secrets" + } + } + }, + "/orgs/{org}/copilot/billing": { + "get": { + "summary": "Get Copilot seat information and settings for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization).\"\n\nOnly organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/get-copilot-organization-details", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-organization-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-organization-details" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "There is a problem with your account's associated payment method." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/seats": { + "get": { + "summary": "List all Copilot seat assignments for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.\n\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-seats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 50 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_seats": { + "type": "integer", + "description": "Total number of Copilot seats for the organization currently being billed." + }, + "seats": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-seat-details" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-seats-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_teams": { + "post": { + "summary": "Add teams to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_teams": { + "type": "array", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_teams" + ] + }, + "examples": { + "default": { + "value": { + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for members of the specified team(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + }, + "delete": { + "summary": "Remove teams from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/cancel-copilot-seat-assignment-for-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_teams": { + "type": "array", + "description": "The names of teams from which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_teams" + ] + }, + "examples": { + "default": { + "value": { + "selected_teams": [ + "engteam1", + "engteam2", + "engteam3" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for members of the specified team(s).", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/billing/selected_users": { + "post": { + "summary": "Add users to the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPurchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization).\"\n\nOnly organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization).\"\nFor more information about setting a suggestion matching policy, see \"[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching).\"\n\nThe response contains the total number of new seats that were created and existing seats that were refreshed.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-copilot-seats-for-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats created for the specified user(s).", + "properties": { + "seats_created": { + "type": "integer" + } + }, + "required": [ + "seats_created" + ] + }, + "examples": { + "default": { + "value": { + "seats_created": 5 + } + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + }, + "delete": { + "summary": "Remove users from the Copilot subscription for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization).\"\n\nOnly organization owners can cancel Copilot seats for their organization members.\n\nThe response contains the total number of seats set to \"pending cancellation\".\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/cancel-copilot-seat-assignment-for-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_usernames": { + "type": "array", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "selected_usernames" + ] + }, + "examples": { + "default": { + "value": { + "selected_usernames": [ + "cooluser1", + "hacker2", + "octocat" + ] + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The total number of seats set to \"pending cancellation\" for the specified users.", + "properties": { + "seats_cancelled": { + "type": "integer" + } + }, + "required": [ + "seats_cancelled" + ] + }, + "examples": { + "default": { + "value": { + "seats_cancelled": 5 + } + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/copilot/coding-agent/permissions": { + "get": { + "summary": "Get Copilot coding agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about which repositories in an organization have been enabled\nor disabled for the Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/get-copilot-coding-agent-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`." + } + }, + "required": [ + "enabled_repositories" + ] + }, + "examples": { + "all_enabled": { + "summary": "All repositories enabled", + "value": { + "enabled_repositories": "all" + } + }, + "selected_enabled": { + "summary": "Selected repositories enabled", + "value": { + "enabled_repositories": "selected", + "selected_repositories_url": "https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories" + } + }, + "none_enabled": { + "summary": "No repositories enabled", + "value": { + "enabled_repositories": "none" + } + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + }, + "put": { + "summary": "Set Copilot coding agent permissions for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets the policy for which repositories in an organization can use Copilot coding agent.\n\nOrganization owners can configure whether Copilot coding agent is enabled for\nall repositories, selected repositories, or no repositories owned by the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/set-copilot-coding-agent-permissions-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`.", + "enum": [ + "all", + "selected", + "none" + ] + } + }, + "required": [ + "enabled_repositories" + ] + }, + "examples": { + "default": { + "value": { + "enabled_repositories": "selected" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/coding-agent/permissions/repositories": { + "get": { + "summary": "List repositories enabled for Copilot coding agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists the selected repositories that are enabled for Copilot coding agent in an organization.\n\nOrganization owners can use this endpoint when the coding agent repository policy\nis set to `selected` to see which repositories have been enabled.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/list-copilot-coding-agent-selected-repositories-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + }, + "required": [ + "total_count", + "repositories" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-paginated" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + }, + "put": { + "summary": "Set selected repositories for Copilot coding agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nReplaces the list of selected repositories that are enabled for Copilot coding\nagent in an organization. This method can only be called when the coding agent\nrepository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/set-copilot-coding-agent-selected-repositories-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for Copilot coding agent.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a repository for Copilot coding agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nAdds a repository to the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/enable-copilot-coding-agent-for-repository-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + }, + "delete": { + "summary": "Disable a repository for Copilot coding agent in an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemoves a repository from the list of selected repositories enabled for Copilot\ncoding agent in an organization. This method can only be called when the\ncoding agent repository policy is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/disable-copilot-coding-agent-for-repository-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/orgs/{org}/copilot/content_exclusion": { + "get": { + "summary": "Get Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can view details about Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.\n> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-organization-content-exclusion-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-organization-content-exclusion-details" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" + } + }, + "put": { + "summary": "Set Copilot content exclusion rules for an organization", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nSets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization).\"\n\nOrganization owners can set Copilot content exclusion rules for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.\n\n> [!CAUTION]\n> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.\n> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.", + "tags": [ + "copilot" + ], + "operationId": "copilot/set-copilot-content-exclusion-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "description": "The content exclusion rules to set", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "string", + "description": "The path to the file that will be excluded." + }, + { + "type": "object", + "properties": { + "ifAnyMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifAnyMatch" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "ifNoneMatch": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "ifNoneMatch" + ], + "additionalProperties": false + } + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of content exclusion paths", + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Content exclusion rules updated successfully." + } + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "413": { + "$ref": "#/components/responses/too_large" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": null, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-content-exclusion-management" + } + } + }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-1-day": { + "get": { + "summary": "Get Copilot organization usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": { + "get": { + "summary": "Get Copilot organization usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.\n\nThe report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-1-day": { + "get": { + "summary": "Get Copilot organization users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-one-day-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot organization users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-users-usage-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-28-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-28-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for an organization", + "description": "Lists Dependabot alerts for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-classifications" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-states" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry" + }, + { + "$ref": "#/components/parameters/dependabot-alert-org-scope-comma-separated-has" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-runtime-risk" + }, + { + "$ref": "#/components/parameters/dependabot-alert-scope" + }, + { + "$ref": "#/components/parameters/dependabot-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dependabot-alert-with-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-alerts-for-organization" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/orgs/{org}/dependabot/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-dependabot-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-dependabot-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}": { + "get": { + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-dependabot-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-dependabot-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "visibility": { + "type": "string", + "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "visibility" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_string_type_from_repo_id_param", + "patch": [ + { + "op": "replace", + "path": "/requestBody/content/application~1json/schema/properties/selected_repository_ids/items", + "value": { + "type": "integer" + } + } + ], + "version": "2026-03-10" + } + ] + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-paginated" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "409": { + "description": "Conflict when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" + }, + "409": { + "description": "Conflict when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for organization", + "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-org" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-organization-events" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "200-response": { + "$ref": "#/components/examples/public-org-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/orgs/{org}/failed_invitations": { + "get": { + "summary": "List failed organization invitations", + "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-failed-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/hooks": { + "get": { + "summary": "List organization webhooks", + "description": "List webhooks for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-hook" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-hook-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "post": { + "summary": "Create an organization webhook", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or\nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Must be passed as \"web\"." + }, + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + }, + "username": { + "type": "string", + "example": "\"kdaigle\"" + }, + "password": { + "type": "string", + "example": "\"password\"" + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + }, + "required": [ + "name", + "config" + ] + }, + "examples": { + "default": { + "value": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-hook" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/orgs/octocat/hooks/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-hook" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\".\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + }, + "name": { + "type": "string", + "example": "\"web\"" + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-hook-2" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "delete": { + "summary": "Delete an organization webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/config": { + "get": { + "summary": "Get a webhook configuration for an organization", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook-config-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/webhook-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a webhook configuration for an organization", + "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook).\"\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook-config-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "examples": { + "default": { + "summary": "Update an existing webhook", + "value": { + "url": "http://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0", + "secret": "********" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/webhook-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for an organization webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/cursor" + }, + { + "$ref": "#/components/parameters/webhook-delivery-status" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/hook-delivery-item" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a webhook delivery for an organization webhook", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + }, + { + "$ref": "#/components/parameters/delivery-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hook-delivery" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for an organization webhook", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + }, + { + "$ref": "#/components/parameters/delivery-id" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping an organization webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", + "tags": [ + "orgs" + ], + "operationId": "orgs/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get route stats by actor", + "description": "Get API request count statistics for an actor broken down by route within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-route-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-route-stats-sort" + }, + { + "$ref": "#/components/parameters/api-insights-api-route-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-route-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-route-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/subject-stats": { + "get": { + "summary": "Get subject stats", + "description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-subject-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-subject-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-sort" + }, + { + "$ref": "#/components/parameters/api-insights-subject-name-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-subject-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-subject-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats": { + "get": { + "summary": "Get summary stats", + "description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + "get": { + "summary": "Get summary stats by user", + "description": "Get overall statistics of API requests within the organization for a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get summary stats by actor", + "description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-summary-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-summary-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-summary-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats": { + "get": { + "summary": "Get time stats", + "description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + "get": { + "summary": "Get time stats by user", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + "get": { + "summary": "Get time stats by actor", + "description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-time-stats-by-actor", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-actor-type" + }, + { + "$ref": "#/components/parameters/api-insights-actor-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-timestamp-increment" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-time-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-time-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/insights/api/user-stats/{user_id}": { + "get": { + "summary": "Get user stats", + "description": "Get API usage statistics within an organization for a user broken down by the type of access.", + "tags": [ + "orgs" + ], + "operationId": "api-insights/get-user-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/api-insights#get-user-stats" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/api-insights-user-id" + }, + { + "$ref": "#/components/parameters/api-insights-min-timestamp" + }, + { + "$ref": "#/components/parameters/api-insights-max-timestamp" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/api-insights-sort" + }, + { + "$ref": "#/components/parameters/api-insights-actor-name-substring" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api-insights-user-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/api-insights-user-stats" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "api-insights" + } + } + }, + "/orgs/{org}/installation": { + "get": { + "summary": "Get an organization installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-org-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/orgs/{org}/installations": { + "get": { + "summary": "List app installations for an organization", + "description": "Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-app-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "installations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "installations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/installation" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for an organization", + "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", + "tags": [ + "interactions" + ], + "operationId": "interactions/get-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/interaction-limit-response" + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false + } + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-response" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + }, + "put": { + "summary": "Set interaction restrictions for an organization", + "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", + "tags": [ + "interactions" + ], + "operationId": "interactions/set-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit" + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "expiry": "one_month" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-response" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Remove interaction restrictions for an organization", + "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", + "tags": [ + "interactions" + ], + "operationId": "interactions/remove-restrictions-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/invitations": { + "get": { + "summary": "List pending organization invitations", + "description": "The return hash contains a `role` field which refers to the Organization\nInvitation role and will be one of the following values: `direct_member`, `admin`,\n`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub\nmember, the `login` field in the return hash will be `null`.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pending-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "role", + "description": "Filter invitations by their member role.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "direct_member", + "billing_manager", + "hiring_manager" + ], + "default": "all" + } + }, + { + "name": "invitation_source", + "description": "Filter invitations by their invitation source.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "member", + "scim" + ], + "default": "all" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "post": { + "summary": "Create an organization invitation", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "invitee_id": { + "type": "integer", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting." + }, + "email": { + "type": "string", + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user." + }, + "role": { + "type": "string", + "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.", + "enum": [ + "admin", + "direct_member", + "billing_manager", + "reinstate" + ], + "default": "direct_member" + }, + "team_ids": { + "type": "array", + "description": "Specify IDs for the teams you want to invite new members to.", + "items": { + "type": "integer" + } + } + } + }, + "examples": { + "default": { + "value": { + "email": "octocat@github.com", + "role": "direct_member", + "team_ids": [ + 12, + 26 + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-invitation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/invitations/{invitation_id}": { + "delete": { + "summary": "Cancel an organization invitation", + "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).", + "tags": [ + "orgs" + ], + "operationId": "orgs/cancel-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/invitation-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/invitations/{invitation_id}/teams": { + "get": { + "summary": "List organization invitation teams", + "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-invitation-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/invitation-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/issue-fields": { + "get": { + "summary": "List issue fields for an organization", + "description": "Lists all issue fields for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-issue-fields", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-fields" + } + }, + "post": { + "summary": "Create issue field for an organization", + "description": "Creates a new issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-issue-field", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-create-issue-field" + }, + "examples": { + "default": { + "value": { + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "name": "High", + "description": "High priority", + "color": "red" + }, + { + "name": "Medium", + "description": "Medium priority", + "color": "yellow" + }, + { + "name": "Low", + "description": "Low priority", + "color": "green" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-field" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-fields" + } + } + }, + "/orgs/{org}/issue-fields/{issue_field_id}": { + "patch": { + "summary": "Update issue field for an organization", + "description": "Updates an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-issue-field", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-update-issue-field" + }, + "examples": { + "default": { + "summary": "Update name and description", + "description": "Update the name and description of an issue field", + "value": { + "name": "Priority", + "description": "Level of importance for the issue" + } + }, + "update-single-select-options": { + "summary": "Update single select options", + "description": "Update the options for a single select issue field", + "value": { + "name": "Status", + "description": "Current status of the issue", + "options": [ + { + "name": "Backlog", + "description": "Items waiting to be prioritized", + "color": "gray", + "priority": 1 + }, + { + "name": "In Progress", + "description": "Currently being worked on", + "color": "blue", + "priority": 2 + }, + { + "name": "Done", + "description": "Completed work", + "color": "green", + "priority": 3 + } + ] + } + }, + "update-name-only": { + "summary": "Update name only", + "description": "Update only the name of an issue field", + "value": { + "name": "Updated Field Name" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-field" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-fields" + } + }, + "delete": { + "summary": "Delete issue field for an organization", + "description": "Deletes an issue field for an organization.\n\nYou can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-issue-field", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-fields" + } + } + }, + "/orgs/{org}/issue-types": { + "get": { + "summary": "List issue types for an organization", + "description": "Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-issue-types", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-type" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + }, + "post": { + "summary": "Create issue type for an organization", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-create-issue-type" + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-type" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + } + }, + "/orgs/{org}/issue-types/{issue_type_id}": { + "put": { + "summary": "Update issue type for an organization", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-type-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-update-issue-type" + }, + "examples": { + "default": { + "value": { + "name": "Epic", + "description": "An issue type for a multi-week tracking of work", + "is_enabled": true, + "color": "green" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-type" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + }, + "delete": { + "summary": "Delete issue type for an organization", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-issue-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/issue-type-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "issue-types" + } + } + }, + "/orgs/{org}/issues": { + "get": { + "summary": "List organization issues assigned to the authenticated user", + "description": "List issues in an organization assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "filter", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], + "default": "assigned" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "$ref": "#/components/parameters/labels" + }, + { + "name": "type", + "description": "Can be the name of an issue type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-with-repo-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "issues", + "subcategory": "issues" + } + } + }, + "/orgs/{org}/members": { + "get": { + "summary": "List organization members", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-members", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-organization-members" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "filter", + "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "2fa_insecure", + "all" + ], + "default": "all" + } + }, + { + "name": "role", + "description": "Filter members returned by their role.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/members/{username}": { + "get": { + "summary": "Check organization membership for a user", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response if requester is an organization member and user is a member" + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members/pezra", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found if requester is an organization member and user is not a member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove an organization member", + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-member", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-an-organization-member" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_remove_member_trade_compliance_response_status", + "patch": { + "responses": { + "451": { + "$ref": "#/components/responses/validation_failed" + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/members/{username}/codespaces": { + "get": { + "summary": "List codespaces for a user in organization", + "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-codespaces-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "codespaces" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "codespaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespace" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-list" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + "delete": { + "summary": "Delete a codespace from the organization", + "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-from-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + "post": { + "summary": "Stop a codespace for an organization user", + "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/stop-in-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "organizations" + } + } + }, + "/orgs/{org}/members/{username}/copilot": { + "get": { + "summary": "Get Copilot seat assignment details for a user", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.\n\nThe seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.\nFor more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).\n\nOnly organization owners can view Copilot seat assignment details for members of their organization.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/get-copilot-seat-details-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "The user's GitHub Copilot seat details, including usage.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-seat-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-seat-detail-active" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-user-management" + } + } + }, + "/orgs/{org}/memberships/{username}": { + "get": { + "summary": "Get organization membership for a user", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-membership" + }, + "examples": { + "response-if-user-has-an-active-admin-membership-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "put": { + "summary": "Set organization membership for a user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.", + "enum": [ + "admin", + "member" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Set an organization membership role for a user", + "value": { + "role": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-membership" + }, + "examples": { + "response-if-user-already-had-membership-with-organization": { + "$ref": "#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_update_user_membership_trade_compliance_response_status", + "patch": { + "responses": { + "451": { + "$ref": "#/components/responses/validation_failed" + } + } + }, + "version": "2026-03-10" + } + ] + }, + "delete": { + "summary": "Remove organization membership for a user", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.\n\n> [!NOTE]\n> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/migrations": { + "get": { + "summary": "List organization migrations", + "description": "Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).\n\nA list of `repositories` is only returned for export migrations.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#list-organization-migrations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/migration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-with-short-org-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + }, + "post": { + "summary": "Start an organization migration", + "description": "Initiates the generation of a migration archive.", + "tags": [ + "migrations" + ], + "operationId": "migrations/start-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#start-an-organization-migration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repositories": { + "type": "array", + "description": "A list of arrays indicating which repositories should be migrated.", + "items": { + "type": "string" + } + }, + "lock_repositories": { + "type": "boolean", + "example": true, + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "default": false + }, + "exclude_metadata": { + "type": "boolean", + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", + "default": false + }, + "exclude_git_data": { + "type": "boolean", + "description": "Indicates whether the repository git data should be excluded from the migration.", + "default": false + }, + "exclude_attachments": { + "type": "boolean", + "example": true, + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "default": false + }, + "exclude_releases": { + "type": "boolean", + "example": true, + "description": "Indicates whether releases should be excluded from the migration (to reduce migration archive file size).", + "default": false + }, + "exclude_owner_projects": { + "type": "boolean", + "example": true, + "description": "Indicates whether projects owned by the organization or users should be excluded. from the migration.", + "default": false + }, + "org_metadata_only": { + "type": "boolean", + "example": true, + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", + "default": false + }, + "exclude": { + "type": "array", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", + "items": { + "type": "string", + "enum": [ + "repositories" + ] + } + } + }, + "required": [ + "repositories" + ] + }, + "examples": { + "default": { + "value": { + "repositories": [ + "github/Hello-World" + ], + "lock_repositories": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/migration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-with-short-org-2" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}": { + "get": { + "summary": "Get an organization migration status", + "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-status-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/migration-id" + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/migration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-with-short-org" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/archive": { + "get": { + "summary": "Download an organization migration archive", + "description": "Fetches the URL to a migration archive.", + "tags": [ + "migrations" + ], + "operationId": "migrations/download-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/migration-id" + } + ], + "responses": { + "302": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Delete an organization migration archive", + "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", + "tags": [ + "migrations" + ], + "operationId": "migrations/delete-archive-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/migration-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + "delete": { + "summary": "Unlock an organization repository", + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", + "tags": [ + "migrations" + ], + "operationId": "migrations/unlock-repo-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/migration-id" + }, + { + "$ref": "#/components/parameters/repo-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/migrations/{migration_id}/repositories": { + "get": { + "summary": "List repositories in an organization migration", + "description": "List all the repositories for this organization migration.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-repos-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/migration-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "orgs" + }, + "x-github-breaking-changes": [ + { + "changeset": "restrict_repo_fields_in_migration_resource", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/simple-repository" + } + } + } + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "restrict_repo_fields_in_migration_resource", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "examples": null + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/organization-roles": { + "get": { + "summary": "Get all organization roles for an organization", + "description": "Lists the organization roles available in this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-roles", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response - list of organization roles", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of organization roles available to the organization." + }, + "roles": { + "type": "array", + "description": "The list of organization roles available to the organization.", + "items": { + "$ref": "#/components/schemas/organization-role" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-role-list" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}": { + "delete": { + "summary": "Remove all organization roles for a team", + "description": "Removes all assigned organization roles from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + "put": { + "summary": "Assign an organization role to a team", + "description": "Assigns an organization role to a team in an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-team-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, team or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled for the organization, or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + }, + "delete": { + "summary": "Remove an organization role from a team", + "description": "Removes an organization role from a team. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/users/{username}": { + "delete": { + "summary": "Remove all organization roles for a user", + "description": "Revokes all assigned organization roles from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-org-roles-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + "put": { + "summary": "Assign an organization role to a user", + "description": "Assigns an organization role to a member of an organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/assign-user-to-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Response if the organization, user or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + }, + "delete": { + "summary": "Remove an organization role from a user", + "description": "Remove an organization role from a user. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nThe authenticated user must be an administrator for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-org-role-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}": { + "get": { + "summary": "Get an organization role", + "description": "Gets an organization role that is available to this organization. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, the authenticated user must be one of:\n\n- An administrator for the organization.\n- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see \"[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-role" + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-role" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}/teams": { + "get": { + "summary": "List teams that are assigned to an organization role", + "description": "Lists the teams that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response - List of assigned teams", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of teams assigned to the organization role", + "items": { + "$ref": "#/components/schemas/team-role-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/organization-roles/{role_id}/users": { + "get": { + "summary": "List users that are assigned to an organization role", + "description": "Lists organization members that are assigned to an organization role. For more information on organization roles, see \"[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles).\"\n\nTo use this endpoint, you must be an administrator for the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-org-role-users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response - List of assigned users", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of users assigned to the organization role", + "items": { + "$ref": "#/components/schemas/user-role-assignment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Response if the organization or role does not exist." + }, + "422": { + "description": "Response if the organization roles feature is not enabled or validation failed." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "organization-roles" + } + } + }, + "/orgs/{org}/outside_collaborators": { + "get": { + "summary": "List outside collaborators for an organization", + "description": "List all users who are outside collaborators of an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-outside-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "filter", + "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "2fa_insecure", + "all" + ], + "default": "all" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "outside-collaborators" + } + } + }, + "/orgs/{org}/outside_collaborators/{username}": { + "put": { + "summary": "Convert an organization member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/convert-member-to-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "async": { + "type": "boolean", + "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", + "default": false + } + } + }, + "examples": { + "202": { + "summary": "Status code 202, asynchronous request", + "value": { + "async": true + } + }, + "204": { + "summary": "Status code 204, synchronous request", + "value": null + } + } + } + } + }, + "responses": { + "202": { + "description": "User is getting converted asynchronously", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "examples": { + "202": { + "value": null + } + } + } + } + }, + "204": { + "description": "User was converted" + }, + "403": { + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "outside-collaborators" + } + }, + "delete": { + "summary": "Remove outside collaborator from an organization", + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "description": "Unprocessable Entity if user is a member of the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-user-is-a-member-of-the-organization": { + "value": { + "message": "You cannot specify an organization member to remove as an outside collaborator.", + "documentation_url": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "outside-collaborators" + } + } + }, + "/orgs/{org}/packages": { + "get": { + "summary": "List packages for an organization", + "description": "Lists packages in an organization readable by the user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/list-packages-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization" + }, + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/package-visibility" + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-org" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "400": { + "$ref": "#/components/responses/package_es_list_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}": { + "get": { + "summary": "Get a package for an organization", + "description": "Gets a specific package in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-package-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/package" + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-org" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete a package for an organization", + "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + "post": { + "summary": "Restore a package for an organization", + "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + "get": { + "summary": "List package versions for a package owned by an organization", + "description": "Lists package versions for a package owned by an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package-version" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-versions-for-org" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + "get": { + "summary": "Get a package version for an organization", + "description": "Gets a specific package version in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-package-version-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/package-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-version-org" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete package version for an organization", + "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + "post": { + "summary": "Restore package version for an organization", + "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-version-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/orgs/{org}/personal-access-token-requests": { + "get": { + "summary": "List requests to access organization resources with fine-grained personal access tokens", + "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/personal-access-token-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/personal-access-token-owner" + }, + { + "$ref": "#/components/parameters/personal-access-token-repository" + }, + { + "$ref": "#/components/parameters/personal-access-token-permission" + }, + { + "$ref": "#/components/parameters/personal-access-token-before" + }, + { + "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" + } + ], + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-programmatic-access-grant-request" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-pat-grant-request-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + }, + "post": { + "summary": "Review requests to access organization resources with fine-grained personal access tokens", + "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/review-pat-grant-requests-in-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pat_request_ids": { + "type": "array", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values.", + "items": { + "type": "integer" + }, + "minItems": 1, + "maxItems": 100 + }, + "action": { + "type": "string", + "description": "Action to apply to the requests.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": "string", + "description": "Reason for approving or denying the requests. Max 1024 characters.", + "maxLength": 1024, + "nullable": true + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + } + } + } + } + } + }, + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "202": { + "$ref": "#/components/responses/accepted" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + "post": { + "summary": "Review a request to access organization resources with a fine-grained personal access token", + "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/review-pat-grant-request", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the request.", + "enum": [ + "approve", + "deny" + ] + }, + "reason": { + "type": "string", + "description": "Reason for approving or denying the request. Max 1024 characters.", + "maxLength": 1024, + "nullable": true + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of denying a request", + "value": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + } + } + } + } + } + }, + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "204": { + "$ref": "#/components/responses/no_content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + "get": { + "summary": "List repositories requested to be accessed by a fine-grained personal access token", + "description": "Lists the repositories a fine-grained personal access token request is requesting access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-request-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens": { + "get": { + "summary": "List fine-grained personal access tokens with access to organization resources", + "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grants", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/personal-access-token-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/personal-access-token-owner" + }, + { + "$ref": "#/components/parameters/personal-access-token-repository" + }, + { + "$ref": "#/components/parameters/personal-access-token-permission" + }, + { + "$ref": "#/components/parameters/personal-access-token-before" + }, + { + "$ref": "#/components/parameters/personal-access-token-after" + }, + { + "$ref": "#/components/parameters/personal-access-token-token-id" + } + ], + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-programmatic-access-grant" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-pat-grant-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + }, + "post": { + "summary": "Update the access to organization resources via fine-grained personal access tokens", + "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-accesses", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + }, + "pat_ids": { + "description": "The IDs of the fine-grained personal access tokens.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token." + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "action", + "pat_ids" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "202": { + "$ref": "#/components/responses/accepted" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}": { + "post": { + "summary": "Update the access a fine-grained personal access token has to organization resources", + "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-pat-access", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/fine-grained-personal-access-token-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "Action to apply to the fine-grained personal access token.", + "enum": [ + "revoke" + ] + } + }, + "required": [ + "action" + ] + }, + "examples": { + "204": { + "summary": "Example of revoking a fine-grained personal access token.", + "value": { + "action": "revoke" + } + } + } + } + } + }, + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + "get": { + "summary": "List repositories a fine-grained personal access token has access to", + "description": "Lists the repositories a fine-grained personal access token has access to.\n\nOnly GitHub Apps can use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-pat-grant-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "pat_id", + "in": "path", + "description": "Unique identifier of the fine-grained personal access token.", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "500": { + "$ref": "#/components/responses/internal_error" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "personal-access-tokens" + } + } + }, + "/orgs/{org}/private-registries": { + "get": { + "summary": "List private registries for an organization", + "description": "\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/list-org-private-registries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-private-registry-configuration" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configurations-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "post": { + "summary": "Create a private registry for an organization", + "description": "\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/create-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": "string", + "nullable": true + }, + "replaces_base": { + "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + }, + "auth_type": { + "description": "The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication.", + "type": "string", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog" + ] + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", + "type": "string" + } + }, + "required": [ + "registry_type", + "url", + "visibility" + ] + }, + "examples": { + "org-private-registry-with-private-visibility": { + "summary": "Example of a private registry configuration with private visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "replaces_base": true, + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "private" + } + }, + "org-private-registry-with-selected-visibility": { + "summary": "Example of a private registry configuration with selected visibility", + "value": { + "registry_type": "maven_repository", + "url": "https://maven.pkg.github.com/organization/", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + }, + "org-private-registry-with-oidc-azure": { + "summary": "Example of an OIDC private registry configuration using Azure", + "value": { + "registry_type": "docker_registry", + "url": "https://myregistry.azurecr.io", + "auth_type": "oidc_azure", + "visibility": "all", + "tenant_id": "12345678-1234-1234-1234-123456789012", + "client_id": "abcdef01-2345-6789-abcd-ef0123456789" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "The organization private registry configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration-with-selected-repositories" + }, + "examples": { + "org-private-registry-with-selected-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration" + }, + "org-private-registry-with-private-visibility": { + "$ref": "#/components/examples/org-private-registry-configuration-with-selected-repositories" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/public-key": { + "get": { + "summary": "Get private registries public key for an organization", + "description": "\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "example": "012345678912345678", + "type": "string" + }, + "key": { + "description": "The Base64 encoded public key.", + "example": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "type": "string" + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-registries-public-key" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/private-registries/{secret_name}": { + "get": { + "summary": "Get a private registry for an organization", + "description": "\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/get-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "The specified private registry configuration for the organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-private-registry-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-private-registry-configuration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "patch": { + "summary": "Update a private registry for an organization", + "description": "\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\nFor OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/update-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "registry_type": { + "description": "The registry type.", + "type": "string", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ] + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.", + "type": "string", + "nullable": true + }, + "replaces_base": { + "description": "Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "encrypted_value": { + "description": "The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "description": "The ID of the key you used to encrypt the secret.", + "type": "string" + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "type": "string", + "enum": [ + "all", + "private", + "selected" + ] + }, + "selected_repository_ids": { + "description": "An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.", + "type": "array", + "items": { + "type": "integer" + } + }, + "auth_type": { + "description": "The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.", + "type": "string", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog" + ] + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.", + "type": "string" + } + } + }, + "examples": { + "secret-based-update": { + "summary": "Update a secret-based private registry", + "value": { + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + }, + "oidc-azure-update": { + "summary": "Update an OIDC private registry (Azure)", + "value": { + "tenant_id": "12345678-1234-1234-1234-123456789012", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + }, + "delete": { + "summary": "Delete a private registry for an organization", + "description": "\nDelete a private registry configuration at the organization-level.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "private-registries" + ], + "operationId": "private-registries/delete-org-private-registry", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "private-registries", + "subcategory": "organization-configurations" + } + } + }, + "/orgs/{org}/projectsV2": { + "get": { + "summary": "List projects for organization", + "description": "List all projects owned by a specific organization accessible by the authenticated user.", + "tags": [ + "projects" + ], + "operationId": "projects/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#list-projects-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "q", + "description": "Limit results to projects of the specified type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}": { + "get": { + "summary": "Get project for organization", + "description": "Get a specific organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#get-project-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/drafts": { + "post": { + "summary": "Create draft item for organization owned project", + "description": "Create draft issue item for the specified organization owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/create-draft-item-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "description": "Details of the draft item to create in the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the draft issue item to create in the project." + }, + "body": { + "type": "string", + "description": "The body content of the draft issue item to create in the project." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "title": { + "summary": "Example with Sample Draft Issue Title", + "value": { + "title": "Sample Draft Issue Title" + } + }, + "body": { + "summary": "Example with Sample Draft Issue Title and Body", + "value": { + "title": "Sample Draft Issue Title", + "body": "This is the body content of the draft issue." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-simple" + }, + "examples": { + "draft_issue": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "drafts" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/fields": { + "get": { + "summary": "List project fields for organization", + "description": "List all fields for a specific organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/list-fields-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + }, + "post": { + "summary": "Add a field to an organization-owned project.", + "description": "Add a field to an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "issue_field_id": { + "type": "integer", + "description": "The ID of the IssueField to create the field for." + } + }, + "required": [ + "issue_field_id" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for adding a field to an organization-owned project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for organization", + "description": "Get a specific field for an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/field-id" + }, + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/items": { + "get": { + "summary": "List items for an organization owned project", + "description": "List all items for a specific organization-owned project accessible by the authenticated user.", + "tags": [ + "projects" + ], + "operationId": "projects/list-items-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "q", + "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "post": { + "summary": "Add item to organization owned project", + "description": "Add an issue or pull request item to the specified organization owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-item-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], + "oneOf": [ + { + "required": [ + "id" + ] + }, + { + "required": [ + "owner", + "repo", + "number" + ] + } + ] + }, + "examples": { + "issue_with_id": { + "summary": "Add an issue using its unique ID", + "value": { + "type": "Issue", + "id": 3 + } + }, + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", + "value": { + "type": "PullRequest", + "id": 3 + } + }, + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", + "value": { + "type": "Issue", + "owner": "octocat", + "repo": "hello-world", + "number": 42 + } + }, + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", + "value": { + "type": "PullRequest", + "owner": "octocat", + "repo": "hello-world", + "number": 123 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-simple" + }, + "examples": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + "get": { + "summary": "Get an item for an organization owned project", + "description": "Get a specific item from an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-org-item", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/item-id" + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "patch": { + "summary": "Update project item for organization", + "description": "Update a specific item in an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/update-item-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#update-project-item-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/item-id" + } + ], + "requestBody": { + "required": true, + "description": "Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "description": "A list of field updates to apply.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the project field to update." + }, + "value": { + "description": "The new value for the field:\n- For text, number, and date fields, provide the new value directly.\n- For single select and iteration fields, provide the ID of the option or iteration.\n- To clear the field, set this to null.", + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + } + }, + "required": [ + "id", + "value" + ] + } + } + }, + "required": [ + "fields" + ] + }, + "examples": { + "text_field": { + "summary": "Update a text field", + "value": { + "fields": [ + { + "id": 123, + "value": "Updated text value" + } + ] + } + }, + "number_field": { + "summary": "Update a number field", + "value": { + "fields": [ + { + "id": 456, + "value": 42.5 + } + ] + } + }, + "date_field": { + "summary": "Update a date field", + "value": { + "fields": [ + { + "id": 789, + "value": "2023-10-05" + } + ] + } + }, + "single_select_field": { + "summary": "Update a single select field", + "value": { + "fields": [ + { + "id": 789, + "value": "47fc9ee4" + } + ] + } + }, + "iteration_field": { + "summary": "Update an iteration field", + "value": { + "fields": [ + { + "id": 1011, + "value": "866ee5b8" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "delete": { + "summary": "Delete project item for organization", + "description": "Delete a specific item from an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/delete-item-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#delete-project-item-for-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/item-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/views": { + "post": { + "summary": "Create a view for an organization-owned project", + "description": "Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "tags": [ + "projects" + ], + "operationId": "projects/create-view-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the view.", + "example": "Sprint Board" + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ], + "example": "board" + }, + "filter": { + "type": "string", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "example": "is:issue is:open" + }, + "visible_fields": { + "type": "array", + "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", + "items": { + "type": "integer" + }, + "example": [ + 123, + 456, + 789 + ] + } + }, + "required": [ + "name", + "layout" + ], + "additionalProperties": false + }, + "examples": { + "table_view": { + "summary": "Create a table view", + "value": { + "name": "All Issues", + "layout": "table", + "filter": "is:issue", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "board_view": { + "summary": "Create a board view with filter", + "value": { + "name": "Sprint Board", + "layout": "board", + "filter": "is:issue is:open label:sprint", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "roadmap_view": { + "summary": "Create a roadmap view", + "value": { + "name": "Product Roadmap", + "layout": "roadmap" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for creating a view in an organization-owned project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-view" + }, + "examples": { + "table_view": { + "summary": "Response for creating a table view", + "value": { + "$ref": "#/components/examples/projects-v2-view" + } + }, + "board_view": { + "summary": "Response for creating a board view with filter", + "value": { + "$ref": "#/components/examples/projects-v2-view" + } + }, + "roadmap_view": { + "summary": "Response for creating a roadmap view", + "value": { + "$ref": "#/components/examples/projects-v2-view" + } + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "views" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + "get": { + "summary": "List items for an organization project view", + "description": "List items in an organization project with the saved view's filter applied.", + "tags": [ + "projects" + ], + "operationId": "projects/list-view-items-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/view-number" + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the\ntitle field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-get-organization-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom properties for an organization", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-definitions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "$ref": "#/components/schemas/custom-property" + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + } + }, + "/orgs/{org}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an organization", + "description": "Gets a custom property that is defined for an organization.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-get-organization-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an organization", + "description": "Creates a new or updates an existing custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n- An administrator for the organization.\n- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-delete-organization-definition", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + } + }, + "/orgs/{org}/properties/values": { + "get": { + "summary": "List custom property values for organization repositories", + "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-get-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "repository_query", + "description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-repo-custom-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-custom-property-values" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom property values for organization repositories", + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/custom-properties-for-repos-create-or-update-organization-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_names": { + "type": "array", + "description": "The names of repositories that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "repository_names", + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-update-custom-property-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-properties" + } + } + }, + "/orgs/{org}/public_members": { + "get": { + "summary": "List public organization members", + "description": "Members of an organization can choose to have their membership publicized or not.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-public-members", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-public-organization-members" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/public_members/{username}": { + "get": { + "summary": "Check public organization membership for a user", + "description": "Check if the provided user is a public member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-public-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response if user is a public member" + }, + "404": { + "description": "Not Found if user is not a public member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "put": { + "summary": "Set public organization membership for the authenticated user", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "orgs", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove public organization membership for the authenticated user", + "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/repos": { + "get": { + "summary": "List organization repositories", + "description": "Lists repositories for the specified organization.\n\n> [!NOTE]\n> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", + "tags": [ + "repos" + ], + "operationId": "repos/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "type", + "description": "Specifies the types of repositories you want returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member" + ], + "default": "all" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "post": { + "summary": "Create an organization repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#create-an-organization-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository.", + "enum": [ + "public", + "private" + ] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "team_id": { + "type": "integer", + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." + }, + "auto_init": { + "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", + "default": false + }, + "gitignore_template": { + "type": "string", + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." + }, + "license_template": { + "type": "string", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "allow_auto_merge": { + "type": "boolean", + "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", + "default": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**", + "default": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "custom_properties": { + "type": "object", + "description": "The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": false, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/full-repository" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_create_repo_trade_compliance_response_status", + "patch": { + "responses": { + "451": { + "$ref": "#/components/responses/validation_failed" + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/rulesets": { + "get": { + "summary": "Get all organization repository rulesets", + "description": "Get all the repository rulesets for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rulesets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/ruleset-targets" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + }, + "post": { + "summary": "Create an organization repository ruleset", + "description": "Create a repository ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/create-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/org-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/org-rules" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + } + }, + "/orgs/{org}/rulesets/rule-suites": { + "get": { + "summary": "List organization rule suites", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rule-suites", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$ref": "#/components/parameters/repository-name-in-query" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/actor-name-in-query" + }, + { + "$ref": "#/components/parameters/rule-suite-result" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suites" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" + } + } + }, + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + "get": { + "summary": "Get an organization rule suite", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rule-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/rule-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" + } + } + }, + "/orgs/{org}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get an organization repository ruleset", + "description": "Get a repository ruleset for an organization.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + }, + "put": { + "summary": "Update an organization repository ruleset", + "description": "Update a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/update-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/org-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/org-rules" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + }, + "delete": { + "summary": "Delete an organization repository ruleset", + "description": "Delete a ruleset for an organization.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-org-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + } + }, + "/orgs/{org}/rulesets/{ruleset_id}/history": { + "get": { + "summary": "Get organization ruleset history", + "description": "Get the history of an organization ruleset.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-ruleset-history", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ruleset-version" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/ruleset-history" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + } + } + }, + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + "get": { + "summary": "Get organization ruleset version", + "description": "Get a version of an organization ruleset.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-org-ruleset-version", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version_id", + "description": "The ID of the version", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ruleset-version-with-state" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-ruleset-version-with-state" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rules" + } + } + }, + "/orgs/{org}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for an organization", + "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-alerts-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-resolution" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-secret-scanning-alert-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + } + }, + "/orgs/{org}/secret-scanning/pattern-configurations": { + "get": { + "summary": "List organization pattern configurations", + "description": "Lists the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + } + }, + "patch": { + "summary": "Update organization pattern configurations", + "description": "Updates the secret scanning pattern configurations for an organization.\n\nPersonal access tokens (classic) need the `write:org` scope to use this endpoint.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/update-org-pattern-configs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "push-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_settings": { + "type": "array", + "description": "Pattern settings for provider patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + } + }, + "custom_pattern_settings": { + "type": "array", + "description": "Pattern settings for custom patterns.", + "items": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern to configure." + }, + "custom_pattern_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "push_protection_setting": { + "type": "string", + "description": "Push protection setting to set for the pattern.", + "enum": [ + "disabled", + "enabled" + ] + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_settings": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "push_protection_setting": "enabled" + } + ], + "custom_pattern_settings": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "push_protection_setting": "enabled" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pattern_config_version": { + "type": "string", + "description": "The updated pattern configuration version." + } + } + }, + "examples": { + "default": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + } + } + }, + "/orgs/{org}/security-advisories": { + "get": { + "summary": "List repository security advisories for an organization", + "description": "Lists repository security advisories for an organization.\n\nThe authenticated user must be an owner or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/list-org-repository-advisories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "published" + ], + "default": "created" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "per_page", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "state", + "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "triage", + "draft", + "published", + "closed" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-repository-advisories" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + } + }, + "/orgs/{org}/security-managers": { + "get": { + "summary": "List security manager teams", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-security-manager-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-simple-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/security-managers/teams/{team_slug}": { + "put": { + "summary": "Add a security manager team", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/add-security-manager-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove a security manager team", + "description": "> [!WARNING]\n> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the \"[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)\" endpoints instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-security-manager-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "security-managers", + "deprecationDate": "2024-12-01", + "removalDate": "2026-01-01" + }, + "deprecated": true + } + }, + "/orgs/{org}/settings/immutable-releases": { + "get": { + "summary": "Get immutable releases settings for an organization", + "description": "Gets the immutable releases policy for repositories in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-immutable-releases-settings", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Immutable releases settings response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/immutable-releases-organization-settings" + }, + "examples": { + "default": { + "value": { + "enforced_repositories": "all" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "put": { + "summary": "Set immutable releases settings for an organization", + "description": "Sets the immutable releases policy for repositories in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-immutable-releases-settings", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enforced_repositories": { + "type": "string", + "description": "The policy that controls how immutable releases are enforced in the organization.", + "enum": [ + "all", + "none", + "selected" + ], + "example": "all" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "enforced_repositories" + ] + }, + "examples": { + "default": { + "value": { + "enforced_repositories": "all" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/settings/immutable-releases/repositories": { + "get": { + "summary": "List selected repositories for immutable releases enforcement", + "description": "List all of the repositories that have been selected for immutable releases enforcement in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-immutable-releases-settings-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-paginated" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "put": { + "summary": "Set selected repositories for immutable releases enforcement", + "description": "Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-immutable-releases-settings-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for immutable releases in an organization", + "description": "Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "orgs/enable-selected-repository-immutable-releases-organization", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + }, + "delete": { + "summary": "Disable a selected repository for immutable releases in an organization", + "description": "Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "operationId": "orgs/disable-selected-repository-immutable-releases-organization", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/settings/network-configurations": { + "get": { + "summary": "List hosted compute network configurations for an organization", + "description": "Lists all hosted compute network configurations configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/list-network-configurations-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "network_configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "network_configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/network-configuration" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/network-configurations-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "post": { + "summary": "Create a hosted compute network configuration for an organization", + "description": "Creates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/create-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", + "type": "string", + "enum": [ + "none", + "actions" + ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 1, + "maxItems": 1, + "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." + } + }, + "required": [ + "name", + "network_settings_ids" + ] + }, + "examples": { + "default": { + "value": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/network-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/network-configuration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + "get": { + "summary": "Get a hosted compute network configuration for an organization", + "description": "Gets a hosted compute network configuration configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/get-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/network-configuration-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/network-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/network-configuration" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "patch": { + "summary": "Update a hosted compute network configuration for an organization", + "description": "Updates a hosted compute network configuration for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/update-network-configuration-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/network-configuration-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'.", + "type": "string" + }, + "compute_service": { + "description": "The hosted compute service to use for the network configuration.", + "type": "string", + "enum": [ + "none", + "actions" + ] + }, + "network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_settings_ids": { + "type": "array", + "minItems": 0, + "maxItems": 1, + "description": "A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list.", + "items": { + "type": "string" + } + }, + "failover_network_enabled": { + "type": "boolean", + "description": "Indicates whether the failover network resource is enabled." + } + } + }, + "examples": { + "default": { + "value": { + "name": "my-network-configuration", + "network_settings_ids": [ + "23456789ABDCEF1" + ], + "compute_service": "actions" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/network-configuration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/network-configuration" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + }, + "delete": { + "summary": "Delete a hosted compute network configuration from an organization", + "description": "Deletes a hosted compute network configuration from an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/delete-network-configuration-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/network-configuration-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + "get": { + "summary": "Get a hosted compute network settings resource for an organization", + "description": "Gets a hosted compute network settings resource configured for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.", + "tags": [ + "hosted-compute" + ], + "operationId": "hosted-compute/get-network-settings-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/network-settings-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/network-settings" + }, + "examples": { + "default": { + "$ref": "#/components/examples/network-settings" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "network-configurations" + } + } + }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, + "/orgs/{org}/teams": { + "get": { + "summary": "List teams", + "description": "Lists all teams in an organization that are visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/team-type" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "post": { + "summary": "Create a team", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "tags": [ + "teams" + ], + "operationId": "teams/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#create-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "maintainers": { + "type": "array", + "description": "List GitHub usernames for organization members who will become team maintainers.", + "items": { + "type": "string" + } + }, + "repo_names": { + "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "items": { + "type": "string" + } + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications. \nDefault: `notifications_enabled`", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "Justice League", + "description": "A great team", + "permission": "push", + "notification_setting": "notifications_enabled", + "privacy": "closed" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_team_permission", + "patch": { + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "permission": null + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/orgs/{org}/teams/{team_slug}": { + "get": { + "summary": "Get a team by name", + "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam NΓ€me\"` would become `my-team-name`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/get-by-name", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#get-a-team-by-name" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "patch": { + "summary": "Update a team", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/update-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#update-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + } + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when the updated information already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "delete": { + "summary": "Delete a team", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#delete-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/enterprise_team_unsupported" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/invitations": { + "get": { + "summary": "List pending team invitations", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-pending-invitations-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/enterprise_team_unsupported" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-team-members" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n> [!NOTE]\n> The response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-membership" + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" + } + } + } + } + }, + "404": { + "description": "if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Add or update team membership for an organization member", + "value": { + "role": "maintainer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-membership" + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "Forbidden if team synchronization is set up" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-repos-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\nIf the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": [ + "teams" + ], + "operationId": "teams/check-permissions-for-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Alternative response with repository permissions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-repository" + }, + "examples": { + "alternative-response-with-repository-permissions": { + "$ref": "#/components/examples/team-repository-alternative-response-with-repository-permissions" + } + } + } + } + }, + "204": { + "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header." + }, + "404": { + "description": "Not Found if team does not have permission for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-repo-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository." + } + } + }, + "examples": { + "default": { + "summary": "Adding a team to an organization repository with the write role", + "value": { + "permission": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + }, + "delete": { + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/teams/{team_slug}/teams": { + "get": { + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-child-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-child-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "if child teams exist", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "response-if-child-teams-exist": { + "$ref": "#/components/examples/team-items-response-if-child-teams-exist" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/orgs/{org}/{security_product}/{enablement}": { + "post": { + "summary": "Enable or disable a security feature for an organization", + "description": "> [!WARNING]\n> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).\n\nEnables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nThe authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/enable-or-disable-security-product-on-all-org-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/security-product" + }, + { + "$ref": "#/components/parameters/org-security-product-enablement" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "query_suite": { + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "type": "string", + "enum": [ + "default", + "extended" + ] + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "204": { + "description": "Action started" + }, + "422": { + "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "orgs", + "deprecationDate": "2024-07-22", + "removalDate": "2025-07-22" + }, + "deprecated": true + } + }, + "/rate_limit": { + "get": { + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "tags": [ + "rate-limit" + ], + "operationId": "rate-limit/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rate-limit-overview" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rate-limit-overview" + } + } + } + }, + "headers": { + "X-RateLimit-Limit": { + "$ref": "#/components/headers/x-rate-limit-limit" + }, + "X-RateLimit-Remaining": { + "$ref": "#/components/headers/x-rate-limit-remaining" + }, + "X-RateLimit-Reset": { + "$ref": "#/components/headers/x-rate-limit-reset" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", + "tags": [ + "repos" + ], + "operationId": "repos/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/full-repository-default-response" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "patch": { + "summary": "Update a repository", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#update-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "The visibility of the repository.", + "enum": [ + "public", + "private" + ] + }, + "security_and_analysis": { + "type": "object", + "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "nullable": true, + "properties": { + "advanced_security": { + "type": "object", + "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository.\nFor more information, see \"[About GitHub Advanced\nSecurity](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "code_security": { + "type": "object", + "description": "Use the `status` property to enable or disable GitHub Code Security for this repository.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see \"[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see \"[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning delegated bypass for this repository.", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass.\nThis object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`.\nYou can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request.", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass.\nIf you omit this field, the existing set of reviewers is unchanged.", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "default_branch": { + "type": "string", + "description": "Updates the default branch for this repository." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "allow_auto_merge": { + "type": "boolean", + "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", + "default": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "default": false + }, + "allow_update_branch": { + "type": "boolean", + "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", + "default": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "archived": { + "type": "boolean", + "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.", + "default": false + }, + "allow_forking": { + "type": "boolean", + "description": "Either `true` to allow private forks, or `false` to prevent private forks.", + "default": false + }, + "web_commit_signoff_required": { + "type": "boolean", + "description": "Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.", + "default": false + } + } + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": true, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/full-repository" + } + } + } + } + }, + "307": { + "$ref": "#/components/responses/temporary_redirect" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Delete a repository", + "description": "Deleting a repository requires admin access.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.\n\nOAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Organization members cannot delete repositories.", + "documentation_url": "https://docs.github.com/rest/repos/repos#delete-a-repository" + } + } + } + } + } + }, + "307": { + "$ref": "#/components/responses/temporary_redirect" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts": { + "get": { + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/artifact-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#get-an-artifact" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/artifact-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/artifact" + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + }, + "delete": { + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/artifact-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + "get": { + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#download-an-artifact" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/artifact-id" + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "$ref": "#/components/headers/location" + } + } + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for a repository", + "description": "Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for a repository", + "description": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for a repository", + "description": "Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for a repository", + "description": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/usage": { + "get": { + "summary": "Get GitHub Actions cache usage for a repository", + "description": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-usage-by-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/caches": { + "get": { + "summary": "List GitHub Actions caches for a repository", + "description": "Lists the GitHub Actions caches for a repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/actions-cache-git-ref-full" + }, + { + "$ref": "#/components/parameters/actions-cache-key" + }, + { + "$ref": "#/components/parameters/actions-cache-list-sort" + }, + { + "$ref": "#/components/parameters/direction" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "cache" + } + }, + "delete": { + "summary": "Delete GitHub Actions caches for a repository (using a cache key)", + "description": "Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-actions-cache-by-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/actions-cache-key-required" + }, + { + "$ref": "#/components/parameters/actions-cache-git-ref-full" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-list" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-list" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + "delete": { + "summary": "Delete a GitHub Actions cache for a repository (using a cache ID)", + "description": "Deletes a GitHub Actions cache for a repository, using a cache ID.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-actions-cache-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/cache-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + "get": { + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/job-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/job" + }, + "examples": { + "default": { + "$ref": "#/components/examples/job" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/job-id" + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + "post": { + "summary": "Re-run a job from a workflow run", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/job-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "enable_debug_logging": { + "type": "boolean", + "default": false, + "description": "Whether to enable debug logging for the re-run." + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + "get": { + "summary": "Get the customization template for an OIDC subject claim for a repository", + "description": "Gets the customization template for an OpenID Connect (OIDC) subject claim.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-custom-oidc-sub-claim-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Status response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/oidc-custom-sub-repo" + }, + "examples": { + "default": { + "$ref": "#/components/examples/oidc-custom-sub-repo" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + }, + "put": { + "summary": "Set the customization template for an OIDC subject claim for a repository", + "description": "Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-oidc-sub-claim-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Actions OIDC subject customization for a repository", + "description": "Actions OIDC subject customization for a repository", + "type": "object", + "required": [ + "use_default" + ], + "properties": { + "use_default": { + "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", + "type": "boolean" + }, + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "use_default": false, + "include_claim_keys": [ + "repo", + "context" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Empty response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "oidc" + } + } + }, + "/repos/{owner}/{repo}/actions/organization-secrets": { + "get": { + "summary": "List repository organization secrets", + "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-organization-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/organization-variables": { + "get": { + "summary": "List repository organization variables", + "description": "Lists all organization variables shared with a repository.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-organization-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-repository-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-repository-permissions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "$ref": "#/components/schemas/actions-enabled" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "sha_pinning_required": { + "$ref": "#/components/schemas/sha-pinning-required" + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "sha_pinning_required": true + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/access": { + "get": { + "summary": "Get the level of access for workflows outside of the repository", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-access-to-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-workflow-access-to-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-workflow-access-to-repository" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set the level of access for workflows outside of the repository", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-workflow-access-to-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-workflow-access-to-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-workflow-access-to-repository" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + "get": { + "summary": "Get artifact and log retention settings for a repository", + "description": "Gets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + }, + "examples": { + "default": { + "value": { + "days": 90, + "maximum_allowed_days": 365 + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set artifact and log retention settings for a repository", + "description": "Sets artifact and log retention settings for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-artifact-and-log-retention-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + }, + "examples": { + "default": { + "summary": "Set retention days", + "value": { + "days": 90 + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + "get": { + "summary": "Get fork PR contributor approval permissions for a repository", + "description": "Gets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set fork PR contributor approval permissions for a repository", + "description": "Sets the fork PR contributor approval policy for a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-fork-pr-contributor-approval-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + }, + "examples": { + "default": { + "summary": "Set approval policy to first time contributors", + "value": { + "approval_policy": "first_time_contributors" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + "get": { + "summary": "Get private repo fork PR workflow settings for a repository", + "description": "Gets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set private repo fork PR workflow settings for a repository", + "description": "Sets the settings for whether workflows from fork pull requests can run on a private repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-private-repo-fork-pr-workflows-settings-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response for successful settings update" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions and reusable workflows for a repository", + "description": "Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions and reusable workflows for a repository", + "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/selected-actions" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/selected-actions" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/workflow": { + "get": { + "summary": "Get default workflow permissions for a repository", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-github-actions-default-workflow-permissions-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-get-default-workflow-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-default-workflow-permissions" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set default workflow permissions for a repository", + "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-github-actions-default-workflow-permissions-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Success response" + }, + "409": { + "description": "Conflict response when changing a setting is prevented by the owning organization" + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-default-workflow-permissions" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/runners": { + "get": { + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository" + }, + "parameters": [ + { + "name": "name", + "description": "The name of a self-hosted runner.", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/downloads": { + "get": { + "summary": "List runner applications for a repository", + "description": "Lists binaries for the runner application that you can download and run.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-runner-applications-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-application" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-application-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + "post": { + "summary": "Create configuration for a just-in-time runner for a repository", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nThe authenticated user must have admin access to the repository.\n\nOAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/generate-runner-jitconfig-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name", + "runner_group_id", + "labels" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the new runner." + }, + "runner_group_id": { + "type": "integer", + "description": "The ID of the runner group to register the runner to." + }, + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "string" + }, + "description": "The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100." + }, + "work_folder": { + "type": "string", + "description": "The working directory to be used for job execution, relative to the runner install directory.", + "default": "_work" + } + } + }, + "examples": { + "default": { + "value": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + } + } + } + } + } + }, + "responses": { + "201": { + "$ref": "#/components/responses/actions_runner_jitconfig" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/registration-token": { + "post": { + "summary": "Create a registration token for a repository", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-registration-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/remove-token": { + "post": { + "summary": "Create a remove token for a repository", + "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.\n\nFor example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:\n\n```\n./config.sh remove --token TOKEN\n```\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-remove-token-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/authentication-token" + }, + "examples": { + "default": { + "$ref": "#/components/examples/authentication-token-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for a repository", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runner" + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "delete": { + "summary": "Delete a self-hosted runner from a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + "get": { + "summary": "List labels for a self-hosted runner for a repository", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-labels-for-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "post": { + "summary": "Add custom labels to a self-hosted runner for a repository", + "description": "Adds custom labels to a self-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the organization to use this endpoint.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-custom-labels-to-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "labels" + ], + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "description": "The names of the custom labels to add to the runner.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "labels": [ + "gpu", + "accelerated" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "put": { + "summary": "Set custom labels for a self-hosted runner for a repository", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-custom-labels-for-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "labels" + ], + "properties": { + "labels": { + "type": "array", + "minItems": 0, + "maxItems": 100, + "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "labels": [ + "gpu", + "accelerated" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + }, + "delete": { + "summary": "Remove all custom labels from a self-hosted runner for a repository", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels_readonly" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + "delete": { + "summary": "Remove a custom label from a self-hosted runner for a repository", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nAuthenticated users must have admin access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-custom-label-from-self-hosted-runner-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/runner-id" + }, + { + "$ref": "#/components/parameters/runner-label-name" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/actions_runner_labels" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runs": { + "get": { + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/actor" + }, + { + "$ref": "#/components/parameters/workflow-run-branch" + }, + { + "$ref": "#/components/parameters/event" + }, + { + "$ref": "#/components/parameters/workflow-run-status" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/created" + }, + { + "$ref": "#/components/parameters/exclude-pull-requests" + }, + { + "$ref": "#/components/parameters/workflow-run-check-suite-id" + }, + { + "$ref": "#/components/parameters/workflow-run-head-sha" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow-run" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + "get": { + "summary": "Get a workflow run", + "description": "Gets a specific workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/exclude-pull-requests" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-run" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "delete": { + "summary": "Delete a workflow run", + "description": "Deletes a specific workflow run.\n\nAnyone with write access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/delete-workflow-run", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + "get": { + "summary": "Get the review history for a workflow run", + "description": "Anyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-reviews-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/environment-approvals" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/environment-approvals-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + "post": { + "summary": "Approve a workflow run for a fork pull request", + "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/approve-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + "get": { + "summary": "List workflow run artifacts", + "description": "Lists artifacts for a workflow run.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-run-artifacts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/artifact-name" + }, + { + "$ref": "#/components/parameters/direction" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/artifact" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/artifact-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + "get": { + "summary": "Get a workflow run attempt", + "description": "Gets a specific workflow run attempt.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run-attempt", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/attempt-number" + }, + { + "$ref": "#/components/parameters/exclude-pull-requests" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-run" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + "get": { + "summary": "List jobs for a workflow run attempt", + "description": "Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run-attempt", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/attempt-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/job" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/job-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + "get": { + "summary": "Download workflow run attempt logs", + "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-workflow-run-attempt-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "$ref": "#/components/parameters/attempt-number" + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + "post": { + "summary": "Review custom deployment protection rules for a workflow run", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n> [!NOTE]\n> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/review-custom-gates-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/review-custom-gates-comment-required" + }, + { + "$ref": "#/components/schemas/review-custom-gates-state-required" + } + ] + }, + "examples": { + "default": { + "value": { + "environment_name": "prod-eus", + "state": "approved", + "comment": "All health checks passed." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + "post": { + "summary": "Force cancel a workflow run", + "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + "get": { + "summary": "List jobs for a workflow run", + "description": "Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/job" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/job-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + "get": { + "summary": "Download workflow run logs", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "delete": { + "summary": "Delete workflow run logs", + "description": "Deletes all logs for a workflow run.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + "get": { + "summary": "Get pending deployments for a workflow run", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pending-deployment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pending-deployment-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "post": { + "summary": "Review pending deployments for a workflow run", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/review-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "environment_ids": { + "type": "array", + "description": "The list of environment ids to approve or reject", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + } + }, + "state": { + "type": "string", + "description": "Whether to approve or reject deployment to the specified environments.", + "enum": [ + "approved", + "rejected" + ], + "example": "approved" + }, + "comment": { + "type": "string", + "description": "A comment to accompany the deployment review", + "example": "Ship it!" + } + }, + "required": [ + "environment_ids", + "state", + "comment" + ] + }, + "examples": { + "default": { + "value": { + "environment_ids": [ + 161171787 + ], + "state": "approved", + "comment": "Ship it!" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deployment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + "post": { + "summary": "Re-run a workflow", + "description": "Re-runs your workflow run using its `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "enable_debug_logging": { + "type": "boolean", + "default": false, + "description": "Whether to enable debug logging for the re-run." + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + "post": { + "summary": "Re-run failed jobs from a workflow run", + "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-workflow-failed-jobs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "enable_debug_logging": { + "type": "boolean", + "default": false, + "description": "Whether to enable debug logging for the re-run." + } + } + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + "get": { + "summary": "Get workflow run usage", + "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-run-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets": { + "get": { + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-repository-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets/public-key": { + "get": { + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-a-repository-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#delete-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/variables": { + "get": { + "summary": "List repository variables", + "description": "Lists all repository variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-repository-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "post": { + "summary": "Create a repository variable", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-repo-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#create-a-repository-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/actions/variables/{name}": { + "get": { + "summary": "Get a repository variable", + "description": "Gets a specific variable in a repository.\n\nThe authenticated user must have collaborator access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#get-a-repository-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "patch": { + "summary": "Update a repository variable", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/update-repo-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#update-a-repository-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete a repository variable", + "description": "Deletes a repository variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-repo-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#delete-a-repository-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows": { + "get": { + "summary": "List repository workflows", + "description": "Lists the workflows in a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-workflows", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflows#list-repository-workflows" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflows" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + "get": { + "summary": "Get a workflow", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow\nfile name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflows#get-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflows#disable-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + "post": { + "summary": "Create a workflow dispatch event", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "actions/create-workflow-dispatch", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "204": { + "description": "Empty response when `return_run_details` parameter is `false`." + }, + "200": { + "description": "Response including the workflow run ID and URLs when `return_run_details` parameter is `true`.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-dispatch-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-dispatch-response" + } + } + } + } + } + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The git reference for the workflow. The reference can be a branch or tag name." + }, + "inputs": { + "type": "object", + "description": "Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "additionalProperties": true, + "maxProperties": 25 + }, + "return_run_details": { + "type": "boolean", + "description": "Whether the response should include the workflow run ID and URLs." + } + }, + "required": [ + "ref" + ] + }, + "examples": { + "default": { + "value": { + "ref": "topic-branch", + "inputs": { + "name": "Mona the Octocat", + "home": "San Francisco, CA" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflows" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_workflow_dispatch_response_status", + "patch": [ + { + "op": "remove", + "path": "/responses/204" + }, + { + "op": "remove", + "path": "/requestBody/content/application~1json/schema/properties/return_run_details" + } + ], + "version": "2026-03-10" + } + ] + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + "put": { + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflows#enable-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + "get": { + "summary": "List workflow runs for a workflow", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + }, + { + "$ref": "#/components/parameters/actor" + }, + { + "$ref": "#/components/parameters/workflow-run-branch" + }, + { + "$ref": "#/components/parameters/event" + }, + { + "$ref": "#/components/parameters/workflow-run-status" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/created" + }, + { + "$ref": "#/components/parameters/exclude-pull-requests" + }, + { + "$ref": "#/components/parameters/workflow-run-check-suite-id" + }, + { + "$ref": "#/components/parameters/workflow-run-head-sha" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow-run" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-run-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + "get": { + "summary": "Get workflow usage", + "description": "> [!WARNING] \n> This endpoint is in the process of closing down. Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" for more information.\n\nGets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflows#get-workflow-usage" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/workflow-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-usage" + }, + "examples": { + "default": { + "$ref": "#/components/examples/workflow-usage" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/activity": { + "get": { + "summary": "List repository activities", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/list-activities", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repository-activities" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "ref", + "description": "The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "actor", + "description": "The GitHub username to use to filter by the actor who performed the activity.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "day", + "week", + "month", + "quarter", + "year" + ] + } + }, + { + "name": "activity_type", + "description": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "push", + "force_push", + "branch_creation", + "branch_deletion", + "pr_merge", + "merge_queue_merge" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/activity" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/activity-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/assignees": { + "get": { + "summary": "List assignees", + "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#list-assignees" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned", + "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": [ + "issues" + ], + "operationId": "issues/check-user-can-be-assigned", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned." + }, + "404": { + "description": "Otherwise a `404` status code is returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/attestations": { + "post": { + "summary": "Create an attestation", + "description": "Store an artifact attestation and associate it with a repository.\n\nThe authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.\n\nArtifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "repos" + ], + "operationId": "repos/create-attestation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/attestations#create-an-attestation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + } + }, + "required": [ + "bundle" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/attestation" + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the attestation." + } + } + }, + "examples": { + "default": { + "value": { + "id": 2 + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "attestations" + } + } + }, + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with a repository.\n\nThe authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "repos" + ], + "operationId": "repos/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/attestations#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "subject_digest", + "description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations": { + "items": { + "properties": { + "bundle": null + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/repos/{owner}/{repo}/autolinks": { + "get": { + "summary": "Get all autolinks of a repository", + "description": "Gets all autolinks that are configured for a repository.\n\nInformation about autolinks are only available to repository administrators.", + "tags": [ + "repos" + ], + "operationId": "repos/list-autolinks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/autolink" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/autolink-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "autolinks" + } + }, + "post": { + "summary": "Create an autolink reference for a repository", + "description": "Users with admin access to the repository can create an autolink.", + "tags": [ + "repos" + ], + "operationId": "repos/create-autolink", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key_prefix": { + "type": "string", + "description": "This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit." + }, + "url_template": { + "type": "string", + "description": "The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`." + }, + "is_alphanumeric": { + "type": "boolean", + "default": true, + "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters." + } + }, + "required": [ + "key_prefix", + "url_template" + ] + }, + "examples": { + "default": { + "value": { + "key_prefix": "TICKET-", + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autolink" + }, + "examples": { + "default": { + "$ref": "#/components/examples/autolink" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/autolinks/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "autolinks" + } + } + }, + "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + "get": { + "summary": "Get an autolink reference of a repository", + "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", + "tags": [ + "repos" + ], + "operationId": "repos/get-autolink", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/autolink-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/autolink" + }, + "examples": { + "default": { + "$ref": "#/components/examples/autolink" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "autolinks" + } + }, + "delete": { + "summary": "Delete an autolink reference from a repository", + "description": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-autolink", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/autolink-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "autolinks" + } + } + }, + "/repos/{owner}/{repo}/automated-security-fixes": { + "get": { + "summary": "Check if Dependabot security updates are enabled for a repository", + "description": "Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-automated-security-fixes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response if Dependabot is enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-automated-security-fixes" + }, + "examples": { + "default": { + "value": { + "enabled": true, + "paused": false + } + } + } + } + } + }, + "404": { + "description": "Not Found if Dependabot is not enabled for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable Dependabot security updates", + "description": "Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)\".", + "tags": [ + "repos" + ], + "operationId": "repos/enable-automated-security-fixes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable Dependabot security updates", + "description": "Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-automated-security-fixes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/branches": { + "get": { + "summary": "List branches", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/list-branches", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branches#list-branches" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "protected", + "description": "Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/short-branch" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/short-branch-with-protection-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branches" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}": { + "get": { + "summary": "Get a branch", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/get-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branches#get-a-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/branch-with-protection" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-get" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branches" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection": { + "get": { + "summary": "Get branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/get-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-branch-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/branch-protection" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-protection" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "put": { + "summary": "Update branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.\n\n> [!NOTE]\n> The list of users, apps, and teams in total is limited to 100 items.", + "tags": [ + "repos" + ], + "operationId": "repos/update-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#update-branch-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "required_status_checks": { + "type": "object", + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "nullable": true, + "properties": { + "strict": { + "type": "boolean", + "description": "Require branches to be up to date before merging." + }, + "contexts": { + "type": "array", + "deprecated": true, + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + } + } + } + } + }, + "required": [ + "strict", + "contexts" + ] + }, + "enforce_admins": { + "type": "boolean", + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", + "nullable": true + }, + "required_pull_request_reviews": { + "type": "object", + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", + "nullable": true, + "properties": { + "dismissal_restrictions": { + "type": "object", + "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "properties": { + "users": { + "type": "array", + "description": "The list of user `login`s with dismissal access", + "items": { + "type": "string" + } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s with dismissal access", + "items": { + "type": "string" + } + }, + "apps": { + "type": "array", + "description": "The list of app `slug`s with dismissal access", + "items": { + "type": "string" + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + }, + "require_code_owner_reviews": { + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them." + }, + "required_approving_review_count": { + "type": "integer", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.", + "default": false + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "type": "array", + "description": "The list of user `login`s allowed to bypass pull request requirements.", + "items": { + "type": "string" + } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "items": { + "type": "string" + } + }, + "apps": { + "type": "array", + "description": "The list of app `slug`s allowed to bypass pull request requirements.", + "items": { + "type": "string" + } + } + } + } + } + }, + "restrictions": { + "type": "object", + "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "nullable": true, + "properties": { + "users": { + "type": "array", + "description": "The list of user `login`s with push access", + "items": { + "type": "string" + } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s with push access", + "items": { + "type": "string" + } + }, + "apps": { + "type": "array", + "description": "The list of app `slug`s with push access", + "items": { + "type": "string" + } + } + }, + "required": [ + "users", + "teams" + ] + }, + "required_linear_history": { + "type": "boolean", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation." + }, + "allow_force_pushes": { + "type": "boolean", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "nullable": true + }, + "allow_deletions": { + "type": "boolean", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation." + }, + "block_creations": { + "type": "boolean", + "description": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`." + }, + "required_conversation_resolution": { + "type": "boolean", + "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`." + }, + "lock_branch": { + "type": "boolean", + "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.", + "default": false + }, + "allow_fork_syncing": { + "type": "boolean", + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.", + "default": false + } + }, + "required": [ + "required_status_checks", + "enforce_admins", + "required_pull_request_reviews", + "restrictions" + ] + }, + "examples": { + "default": { + "value": { + "required_status_checks": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + }, + "enforce_admins": true, + "required_pull_request_reviews": { + "dismissal_restrictions": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "require_last_push_approval": true, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ] + } + }, + "restrictions": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ], + "apps": [ + "super-ci" + ] + }, + "required_linear_history": true, + "allow_force_pushes": true, + "allow_deletions": true, + "block_creations": true, + "required_conversation_resolution": true, + "lock_branch": true, + "allow_fork_syncing": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-protection-update" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Delete branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#delete-branch-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + "get": { + "summary": "Get admin branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/get-admin-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "post": { + "summary": "Set admin branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "tags": [ + "repos" + ], + "operationId": "repos/set-admin-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Delete admin branch protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-admin-branch-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + "get": { + "summary": "Get pull request review protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pull-request-review-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-pull-request-review" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "patch": { + "summary": "Update pull request review protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n> [!NOTE]\n> Passing new arrays of `users` and `teams` replaces their previous values.", + "tags": [ + "repos" + ], + "operationId": "repos/update-pull-request-review-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dismissal_restrictions": { + "type": "object", + "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "properties": { + "users": { + "type": "array", + "description": "The list of user `login`s with dismissal access", + "items": { + "type": "string" + } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s with dismissal access", + "items": { + "type": "string" + } + }, + "apps": { + "type": "array", + "description": "The list of app `slug`s with dismissal access", + "items": { + "type": "string" + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit." + }, + "require_code_owner_reviews": { + "type": "boolean", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed." + }, + "required_approving_review_count": { + "type": "integer", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`", + "default": false + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "type": "array", + "description": "The list of user `login`s allowed to bypass pull request requirements.", + "items": { + "type": "string" + } + }, + "teams": { + "type": "array", + "description": "The list of team `slug`s allowed to bypass pull request requirements.", + "items": { + "type": "string" + } + }, + "apps": { + "type": "array", + "description": "The list of app `slug`s allowed to bypass pull request requirements.", + "items": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "dismissal_restrictions": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ], + "apps": [ + "octoapp" + ] + }, + "bypass_pull_request_allowances": { + "users": [ + "octocat" + ], + "teams": [ + "justice-league" + ], + "apps": [ + "octoapp" + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "require_last_push_approval": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-pull-request-review" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Delete pull request review protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-pull-request-review-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + "get": { + "summary": "Get commit signature protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n> [!NOTE]\n> You must enable branch protection to require signed commits.", + "tags": [ + "repos" + ], + "operationId": "repos/get-commit-signature-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "post": { + "summary": "Create commit signature protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "tags": [ + "repos" + ], + "operationId": "repos/create-commit-signature-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "examples": { + "default": { + "$ref": "#/components/examples/protected-branch-admin-enforced" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Delete commit signature protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-commit-signature-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + "get": { + "summary": "Get status checks protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/get-status-checks-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status-check-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/status-check-policy" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "patch": { + "summary": "Update status check protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "tags": [ + "repos" + ], + "operationId": "repos/update-status-check-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#update-status-check-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "strict": { + "type": "boolean", + "description": "Require branches to be up to date before merging." + }, + "contexts": { + "type": "array", + "deprecated": true, + "description": "**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "description": "The list of status checks to require in order to merge into this branch.", + "items": { + "type": "object", + "required": [ + "context" + ], + "properties": { + "context": { + "type": "string", + "description": "The name of the required check" + }, + "app_id": { + "type": "integer", + "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status." + } + } + } + } + } + }, + "examples": { + "default": { + "value": { + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status-check-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/status-check-policy" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Remove status check protection", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/remove-status-check-protection", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + "get": { + "summary": "Get all status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "default": { + "value": [ + "continuous-integration/travis-ci" + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "post": { + "summary": "Add status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/add-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "contexts": { + "type": "array", + "description": "The name of the status checks", + "items": { + "type": "string" + } + } + }, + "required": [ + "contexts" + ], + "example": { + "contexts": [ + "contexts" + ] + } + }, + { + "type": "array", + "description": "The name of the status checks", + "items": { + "type": "string" + } + } + ] + }, + "examples": { + "default": { + "summary": "Example adding status checks to a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "default": { + "value": [ + "continuous-integration/travis-ci", + "continuous-integration/jenkins" + ] + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "contexts", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "put": { + "summary": "Set status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/set-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "contexts": { + "type": "array", + "description": "The name of the status checks", + "items": { + "type": "string" + } + } + }, + "required": [ + "contexts" + ], + "example": { + "contexts": [ + "contexts" + ] + } + }, + { + "type": "array", + "description": "The name of the status checks", + "items": { + "type": "string" + } + } + ] + }, + "examples": { + "default": { + "summary": "Example updating status checks for a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/travis-ci" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "default": { + "value": [ + "continuous-integration/travis-ci" + ] + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "contexts", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Remove status check contexts", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "tags": [ + "repos" + ], + "operationId": "repos/remove-status-check-contexts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "contexts": { + "type": "array", + "description": "The name of the status checks", + "items": { + "type": "string" + } + } + }, + "required": [ + "contexts" + ], + "example": { + "contexts": [ + "contexts" + ] + } + }, + { + "type": "array", + "description": "The name of the status checks", + "items": { + "type": "string" + } + } + ] + }, + "examples": { + "default": { + "summary": "Example removing status checks from a branch protection rule", + "value": { + "contexts": [ + "continuous-integration/jenkins" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "default": { + "value": [ + "continuous-integration/travis-ci" + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "contexts", + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + "get": { + "summary": "Get access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n> [!NOTE]\n> Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "tags": [ + "repos" + ], + "operationId": "repos/get-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/branch-restriction-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-restriction-policy" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Delete access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + "get": { + "summary": "Get apps with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "tags": [ + "repos" + ], + "operationId": "repos/get-apps-with-access-to-protected-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "post": { + "summary": "Add app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "tags": [ + "repos" + ], + "operationId": "repos/add-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "apps", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "put": { + "summary": "Set app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "tags": [ + "repos" + ], + "operationId": "repos/set-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + "examples": { + "default": { + "value": { + "apps": [ + "octoapp" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "apps", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Remove app access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.", + "tags": [ + "repos" + ], + "operationId": "repos/remove-app-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apps": { + "type": "array", + "description": "The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.", + "items": { + "type": "string" + } + } + }, + "required": [ + "apps" + ], + "example": { + "apps": [ + "my-app" + ] + } + }, + "examples": { + "default": { + "value": { + "apps": [ + "my-app" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/integration-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "apps", + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + "get": { + "summary": "Get teams with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "tags": [ + "repos" + ], + "operationId": "repos/get-teams-with-access-to-protected-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "post": { + "summary": "Add team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.", + "tags": [ + "repos" + ], + "operationId": "repos/add-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "The slug values for teams", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "The slug values for teams", + "items": { + "type": "string" + } + } + ] + }, + "examples": { + "default": { + "summary": "Example adding a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "teams", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "put": { + "summary": "Set team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.", + "tags": [ + "repos" + ], + "operationId": "repos/set-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "The slug values for teams", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "justice-league" + ] + } + }, + { + "type": "array", + "description": "The slug values for teams", + "items": { + "type": "string" + } + } + ] + }, + "examples": { + "default": { + "summary": "Example replacing a team in a branch protection rule", + "value": { + "teams": [ + "justice-league" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "teams", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Remove team access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.", + "tags": [ + "repos" + ], + "operationId": "repos/remove-team-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "teams": { + "type": "array", + "description": "The slug values for teams", + "items": { + "type": "string" + } + } + }, + "required": [ + "teams" + ], + "example": { + "teams": [ + "my-team" + ] + } + }, + { + "type": "array", + "description": "The slug values for teams", + "items": { + "type": "string" + } + } + ] + }, + "examples": { + "default": { + "summary": "Example removing a team in a branch protection rule", + "value": { + "teams": [ + "octocats" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "teams", + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + "get": { + "summary": "Get users with access to the protected branch", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "tags": [ + "repos" + ], + "operationId": "repos/get-users-with-access-to-protected-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branch-protection" + } + }, + "post": { + "summary": "Add user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/add-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" + } + } + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } + }, + "examples": { + "default": { + "summary": "Example adding a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "users", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "put": { + "summary": "Set user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/set-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" + } + } + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } + }, + "examples": { + "default": { + "summary": "Example replacing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "users", + "category": "branches", + "subcategory": "branch-protection" + } + }, + "delete": { + "summary": "Remove user access restrictions", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "tags": [ + "repos" + ], + "operationId": "repos/remove-user-access-restrictions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "users": { + "type": "array", + "description": "The username for users", + "items": { + "type": "string" + } + } + }, + "required": [ + "users" + ], + "example": { + "users": [ + "mona" + ] + } + }, + "examples": { + "default": { + "summary": "Example removing a user in a branch protection rule", + "value": { + "users": [ + "octocat" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "requestBodyParameterName": "users", + "category": "branches", + "subcategory": "branch-protection" + } + } + }, + "/repos/{owner}/{repo}/branches/{branch}/rename": { + "post": { + "summary": "Rename a branch", + "description": "Renames a branch in a repository.\n\n> [!NOTE]\n> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.\n\nIn order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.", + "tags": [ + "repos" + ], + "operationId": "repos/rename-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branches#rename-a-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_name": { + "type": "string", + "description": "The new name of the branch." + } + }, + "required": [ + "new_name" + ] + }, + "examples": { + "default": { + "value": { + "new_name": "my_renamed_branch" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/branch-with-protection" + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-with-protection" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branches" + } + } + }, + "/repos/{owner}/{repo}/check-runs": { + "post": { + "summary": "Create a check run", + "description": "Creates a new check run for a specific commit in a repository.\n\nTo create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", + "tags": [ + "checks" + ], + "operationId": "checks/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#create-a-check-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." + }, + "head_sha": { + "type": "string", + "description": "The SHA of the commit." + }, + "details_url": { + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used." + }, + "external_id": { + "type": "string", + "description": "A reference for the run on the integrator's system." + }, + "status": { + "type": "string", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], + "default": "queued" + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "conclusion": { + "type": "string", + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", + "enum": [ + "action_required", + "cancelled", + "failure", + "neutral", + "success", + "skipped", + "stale", + "timed_out" + ] + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "output": { + "type": "object", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", + "properties": { + "title": { + "type": "string", + "description": "The title of the check run." + }, + "summary": { + "type": "string", + "maxLength": 65535, + "description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters." + }, + "text": { + "type": "string", + "maxLength": 65535, + "description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters." + }, + "annotations": { + "type": "array", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", + "maxItems": 50, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." + }, + "start_line": { + "type": "integer", + "description": "The start line of the annotation. Line numbers start at 1." + }, + "end_line": { + "type": "integer", + "description": "The end line of the annotation." + }, + "start_column": { + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1." + }, + "end_column": { + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." + }, + "annotation_level": { + "type": "string", + "description": "The level of the annotation.", + "enum": [ + "notice", + "warning", + "failure" + ] + }, + "message": { + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." + }, + "title": { + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." + }, + "raw_details": { + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." + } + }, + "required": [ + "path", + "start_line", + "end_line", + "annotation_level", + "message" + ] + } + }, + "images": { + "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI.", + "items": { + "type": "object", + "properties": { + "alt": { + "type": "string", + "description": "The alternative text for the image." + }, + "image_url": { + "type": "string", + "description": "The full URL of the image." + }, + "caption": { + "type": "string", + "description": "A short image description." + } + }, + "required": [ + "alt", + "image_url" + ] + } + } + }, + "required": [ + "title", + "summary" + ] + }, + "actions": { + "type": "array", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "maxItems": 3, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 20, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." + }, + "description": { + "type": "string", + "maxLength": 40, + "description": "A short explanation of what this action would do. The maximum size is 40 characters." + }, + "identifier": { + "type": "string", + "maxLength": 20, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." + } + }, + "required": [ + "label", + "description", + "identifier" + ] + } + } + }, + "required": [ + "name", + "head_sha" + ], + "discriminator": { + "propertyName": "status" + }, + "oneOf": [ + { + "properties": { + "status": { + "enum": [ + "completed" + ] + } + }, + "required": [ + "status", + "conclusion" + ], + "additionalProperties": true + }, + { + "properties": { + "status": { + "enum": [ + "queued", + "in_progress" + ] + } + }, + "additionalProperties": true + } + ] + }, + "examples": { + "example-of-in-progress-conclusion": { + "summary": "Example of an in_progress conclusion", + "value": { + "name": "mighty_readme", + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "status": "in_progress", + "external_id": "42", + "started_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "", + "text": "" + } + } + }, + "example-of-completed-conclusion": { + "summary": "Example of a completed conclusion", + "value": { + "name": "mighty_readme", + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "status": "completed", + "started_at": "2017-11-30T19:39:10Z", + "conclusion": "success", + "completed_at": "2017-11-30T19:49:10Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notices.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations": [ + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'banaas'.", + "raw_details": "Do you mean 'bananas' or 'banana'?", + "start_line": 2, + "end_line": 2 + }, + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'aples'", + "raw_details": "Do you mean 'apples' or 'Naples'", + "start_line": 4, + "end_line": 4 + } + ], + "images": [ + { + "alt": "Super bananas", + "image_url": "http://example.com/images/42" + } + ] + }, + "actions": [ + { + "label": "Fix", + "identifier": "fix_errors", + "description": "Allow us to fix these errors for you" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-run" + }, + "examples": { + "example-of-completed-conclusion": { + "$ref": "#/components/examples/check-run-example-of-completed-conclusion" + }, + "example-of-in-progress-conclusion": { + "$ref": "#/components/examples/check-run-example-of-in-progress-conclusion" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + "get": { + "summary": "Get a check run", + "description": "Gets a single check run using its `id`.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#get-a-check-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-run-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-run" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + }, + "patch": { + "summary": "Update a check run", + "description": "Updates a check run for a specific commit in a repository.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "tags": [ + "checks" + ], + "operationId": "checks/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#update-a-check-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-run-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the check. For example, \"code-coverage\"." + }, + "details_url": { + "type": "string", + "description": "The URL of the integrator's site that has the full details of the check." + }, + "external_id": { + "type": "string", + "description": "A reference for the run on the integrator's system." + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "status": { + "type": "string", + "description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ] + }, + "conclusion": { + "type": "string", + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", + "enum": [ + "action_required", + "cancelled", + "failure", + "neutral", + "success", + "skipped", + "stale", + "timed_out" + ] + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "output": { + "type": "object", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", + "properties": { + "title": { + "type": "string", + "description": "**Required**." + }, + "summary": { + "type": "string", + "description": "Can contain Markdown.", + "maxLength": 65535 + }, + "text": { + "type": "string", + "description": "Can contain Markdown.", + "maxLength": 65535 + }, + "annotations": { + "type": "array", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", + "maxItems": 50, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`." + }, + "start_line": { + "type": "integer", + "description": "The start line of the annotation. Line numbers start at 1." + }, + "end_line": { + "type": "integer", + "description": "The end line of the annotation." + }, + "start_column": { + "type": "integer", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1." + }, + "end_column": { + "type": "integer", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values." + }, + "annotation_level": { + "type": "string", + "description": "The level of the annotation.", + "enum": [ + "notice", + "warning", + "failure" + ] + }, + "message": { + "type": "string", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB." + }, + "title": { + "type": "string", + "description": "The title that represents the annotation. The maximum size is 255 characters." + }, + "raw_details": { + "type": "string", + "description": "Details about this annotation. The maximum size is 64 KB." + } + }, + "required": [ + "path", + "start_line", + "end_line", + "annotation_level", + "message" + ] + } + }, + "images": { + "type": "array", + "description": "Adds images to the output displayed in the GitHub pull request UI.", + "items": { + "type": "object", + "properties": { + "alt": { + "type": "string", + "description": "The alternative text for the image." + }, + "image_url": { + "type": "string", + "description": "The full URL of the image." + }, + "caption": { + "type": "string", + "description": "A short image description." + } + }, + "required": [ + "alt", + "image_url" + ] + } + } + }, + "required": [ + "summary" + ] + }, + "actions": { + "type": "array", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", + "maxItems": 3, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 20, + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters." + }, + "description": { + "type": "string", + "maxLength": 40, + "description": "A short explanation of what this action would do. The maximum size is 40 characters." + }, + "identifier": { + "type": "string", + "maxLength": 20, + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters." + } + }, + "required": [ + "label", + "description", + "identifier" + ] + } + } + }, + "anyOf": [ + { + "properties": { + "status": { + "enum": [ + "completed" + ] + } + }, + "required": [ + "conclusion" + ], + "additionalProperties": true + }, + { + "properties": { + "status": { + "enum": [ + "queued", + "in_progress" + ] + } + }, + "additionalProperties": true + } + ] + }, + "examples": { + "default": { + "value": { + "name": "mighty_readme", + "started_at": "2018-05-04T01:14:52Z", + "status": "completed", + "conclusion": "success", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notices.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations": [ + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'banaas'.", + "raw_details": "Do you mean 'bananas' or 'banana'?", + "start_line": 2, + "end_line": 2 + }, + { + "path": "README.md", + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'aples'", + "raw_details": "Do you mean 'apples' or 'Naples'", + "start_line": 4, + "end_line": 4 + } + ], + "images": [ + { + "alt": "Super bananas", + "image_url": "http://example.com/images/42" + } + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-run" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + "get": { + "summary": "List check run annotations", + "description": "Lists annotations for a check run using the annotation `id`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/list-annotations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#list-check-run-annotations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-run-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/check-annotation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-annotation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + "post": { + "summary": "Rerequest a check run", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", + "tags": [ + "checks" + ], + "operationId": "checks/rerequest-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#rerequest-a-check-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-run-id" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "403": { + "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "description": "Validation error if the check run is not rerequestable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/check-suites": { + "post": { + "summary": "Create a check suite", + "description": "Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)\".\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth apps and personal access tokens (classic) cannot use this endpoint.", + "tags": [ + "checks" + ], + "operationId": "checks/create-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/suites#create-a-check-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "head_sha": { + "type": "string", + "description": "The sha of the head commit." + } + }, + "required": [ + "head_sha" + ] + }, + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when the suite already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite" + } + } + } + } + }, + "201": { + "description": "Response when the suite was created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/check-suites/preferences": { + "patch": { + "summary": "Update repository preferences for check suites", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).\nYou must have admin permissions in the repository to set preferences for check suites.", + "tags": [ + "checks" + ], + "operationId": "checks/set-suites-preferences", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer", + "description": "The `id` of the GitHub App." + }, + "setting": { + "type": "boolean", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "default": true + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "auto_trigger_checks": [ + { + "app_id": 4, + "setting": false + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-suite-preference" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite-preference" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + "get": { + "summary": "Get a check suite", + "description": "Gets a single check suite using its `id`.\n\n> [!NOTE]\n> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/get-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/suites#get-a-check-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + "get": { + "summary": "List check runs in a check suite", + "description": "Lists check runs for a check suite using its `id`.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/list-for-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-suite-id" + }, + { + "$ref": "#/components/parameters/check-name" + }, + { + "$ref": "#/components/parameters/status" + }, + { + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "check_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "check_runs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/check-run" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + "post": { + "summary": "Rerequest a check suite", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.", + "tags": [ + "checks" + ], + "operationId": "checks/rerequest-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/suites#rerequest-a-check-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/check-suite-id" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for a repository", + "description": "Lists code scanning alerts.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/tool-name" + }, + { + "$ref": "#/components/parameters/tool-guid" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/git-ref" + }, + { + "$ref": "#/components/parameters/pr-alias" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + { + "name": "state", + "description": "If specified, only code scanning alerts with this state will be returned.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-state-query" + } + }, + { + "name": "severity", + "description": "If specified, only code scanning alerts with this severity will be returned.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-alert-severity" + } + }, + { + "name": "assignees", + "description": "Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.\n", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-alert-items" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert-items" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a code scanning alert", + "description": "Gets a single code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + }, + "patch": { + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert.\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "operationId": "code-scanning/update-alert", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/code-scanning-alert-set-state" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "create_request": { + "$ref": "#/components/schemas/code-scanning-alert-create-request" + }, + "assignees": { + "$ref": "#/components/schemas/code-scanning-alert-assignees" + } + }, + "anyOf": [ + { + "required": [ + "state" + ] + }, + { + "required": [ + "assignees" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "state": "dismissed", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "create_request": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert-dismissed" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + "get": { + "summary": "Get the status of an autofix for a code scanning alert", + "description": "Gets the status and description of an autofix for a code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + }, + "post": { + "summary": "Create an autofix for a code scanning alert", + "description": "Creates an autofix for a code scanning alert.\n\nIf a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.\n\nIf an autofix already exists for a given alert, then this endpoint will return a 200 OK response.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/create-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix" + } + } + } + } + }, + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-pending" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_autofix_create_forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + "post": { + "summary": "Commit an autofix for a code scanning alert", + "description": "Commits an autofix for a code scanning alert.\n\nIf an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/commit-autofix", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix-commits" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-commits" + } + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-autofix-commits-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-autofix-commits-response" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/code_scanning_bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unprocessable Entity" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + "get": { + "summary": "List instances of a code scanning alert", + "description": "Lists all instances of the specified code scanning alert.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alert-instances", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/git-ref" + }, + { + "$ref": "#/components/parameters/pr-alias" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-alert-instance-list" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-alert-instances" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses": { + "get": { + "summary": "List code scanning analyses for a repository", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\n> [!WARNING]\n> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "operationId": "code-scanning/list-recent-analyses", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/tool-name" + }, + { + "$ref": "#/components/parameters/tool-guid" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pr-alias" + }, + { + "name": "ref", + "in": "query", + "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-ref" + } + }, + { + "name": "sarif_id", + "in": "query", + "description": "Filter analyses belonging to the same SARIF upload.", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis-sarif-id" + } + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created" + ], + "default": "created" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-analysis" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-analysis-items" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + "get": { + "summary": "Get a code scanning analysis for a repository", + "description": "Gets a specified code scanning analysis for a repository.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "operationId": "code-scanning/get-analysis", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "analysis_id", + "in": "path", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis" + }, + "examples": { + "response": { + "$ref": "#/components/examples/code-scanning-analysis-default" + } + } + }, + "application/sarif+json": { + "schema": { + "type": "object", + "additionalProperties": true + }, + "examples": { + "response": { + "$ref": "#/components/examples/code-scanning-analysis-sarif" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/unprocessable_analysis" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "code-scanning", + "subcategory": "code-scanning" + } + }, + "delete": { + "summary": "Delete a code scanning analysis from a repository", + "description": "Deletes a specified code scanning analysis from a repository.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `category`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set:\n`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "operationId": "code-scanning/delete-analysis", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "analysis_id", + "in": "path", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "confirm_delete", + "in": "query", + "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", + "required": false, + "schema": { + "type": "string", + "nullable": true + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis-deletion" + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/code-scanning-analysis-deletion" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + "get": { + "summary": "List CodeQL databases for a repository", + "description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-codeql-databases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-scanning-codeql-database" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-codeql-databases" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + "get": { + "summary": "Get a CodeQL database for a repository", + "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "language", + "in": "path", + "description": "The language of the CodeQL database.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-codeql-database" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-codeql-database" + } + } + } + } + }, + "302": { + "$ref": "#/components/responses/found" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + } + }, + "delete": { + "summary": "Delete a CodeQL database", + "description": "Deletes a CodeQL database for a language in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/delete-codeql-database", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "language", + "in": "path", + "description": "The language of the CodeQL database.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + "post": { + "summary": "Create a CodeQL variant analysis", + "description": "Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.\n\nGet started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).\n\nUse the `owner` and `repo` parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/create-variant-analysis", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "language": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-language" + }, + "query_pack": { + "description": "A Base64-encoded tarball containing a CodeQL query and all its dependencies", + "type": "string" + }, + "repositories": { + "type": "array", + "description": "List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "items": { + "type": "string" + } + }, + "repository_lists": { + "description": "List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "repository_owners": { + "description": "List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required.", + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "language", + "query_pack" + ], + "oneOf": [ + { + "required": [ + "repositories" + ] + }, + { + "required": [ + "repository_lists" + ] + }, + { + "required": [ + "repository_owners" + ] + } + ] + }, + "examples": { + "repositories_parameter": { + "summary": "Using the \"repositories\" field. \"query_pack\" is abridged for brevity.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repositories": [ + "octocat/Hello-World", + "octocat/example" + ] + } + }, + "repository_owners": { + "summary": "Using the \"repository_owners\" field. \"query_pack\" is abridged.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repository_owners": [ + "octocat" + ] + } + }, + "repository_lists": { + "summary": "Using the \"repository_lists\" field. \"query_pack\" is abridged.", + "value": { + "language": "csharp", + "query_pack": "aGVsbG8=", + "repository_lists": [ + "top-100-csharp" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Variant analysis submitted for processing", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis" + }, + "examples": { + "repositories_parameter": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + }, + "repository_owners": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + }, + "repository_lists": { + "summary": "Response for a successful variant analysis submission", + "value": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Unable to process variant analysis submission", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + "get": { + "summary": "Get the summary of a CodeQL variant analysis", + "description": "Gets the summary of a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-variant-analysis", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "codeql_variant_analysis_id", + "in": "path", + "description": "The unique identifier of the variant analysis.", + "schema": { + "type": "integer" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-variant-analysis" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + "get": { + "summary": "Get the analysis status of a repository in a CodeQL variant analysis", + "description": "Gets the analysis status of a repository in a CodeQL variant analysis.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-variant-analysis-repo-task", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "name": "repo", + "in": "path", + "description": "The name of the controller repository.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "codeql_variant_analysis_id", + "in": "path", + "description": "The ID of the variant analysis.", + "schema": { + "type": "integer" + }, + "required": true + }, + { + "name": "repo_owner", + "in": "path", + "description": "The account owner of the variant analysis repository. The name is not case sensitive.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "repo_name", + "in": "path", + "description": "The name of the variant analysis repository.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repo-task" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-variant-analysis-repo-task" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/default-setup": { + "get": { + "summary": "Get a code scanning default setup configuration", + "description": "Gets a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-default-setup", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-default-setup" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-default-setup" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + }, + "patch": { + "summary": "Update a code scanning default setup configuration", + "description": "Updates a code scanning default setup configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/update-default-setup", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-default-setup-update" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-default-setup-update" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-default-setup-update-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-default-setup-update-response" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/code_scanning_conflict" + }, + "422": { + "$ref": "#/components/responses/code_scanning_invalid_state" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs": { + "post": { + "summary": "Upload an analysis as SARIF data", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it.", + "operationId": "code-scanning/upload-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" + }, + "ref": { + "$ref": "#/components/schemas/code-scanning-ref-full" + }, + "sarif": { + "$ref": "#/components/schemas/code-scanning-analysis-sarif-file" + }, + "checkout_uri": { + "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri" + }, + "started_at": { + "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "type": "string" + }, + "tool_name": { + "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "type": "string" + }, + "validate": { + "description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.", + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "commit_sha", + "ref", + "sarif" + ] + }, + "examples": { + "default": { + "value": { + "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da", + "ref": "refs/heads/master", + "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-sarifs-receipt" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-sarif-upload" + } + } + } + } + }, + "400": { + "description": "Bad Request if the sarif field is invalid" + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_write" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "413": { + "description": "Payload Too Large if the sarif field is too large" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + "get": { + "summary": "Get information about a SARIF upload", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository).\"\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.", + "operationId": "code-scanning/get-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-scanning-sarifs-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-sarif-upload-status" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/code_scanning_forbidden_read" + }, + "404": { + "description": "Not Found if the sarif id does not match any upload" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "code-scanning", + "subcategory": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-security-configuration": { + "get": { + "summary": "Get the code security configuration associated with a repository", + "description": "Get the code security configuration that manages a repository's code security settings.\n\nThe authenticated user must be an administrator or security manager for the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configuration-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/code-security-configuration-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-security-configuration-for-repository" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "code-security", + "subcategory": "configurations" + } + } + }, + "/repos/{owner}/{repo}/codeowners/errors": { + "get": { + "summary": "List CODEOWNERS errors", + "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", + "tags": [ + "repos" + ], + "operationId": "repos/codeowners-errors", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-codeowners-errors" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "description": "A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codeowners-errors" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codeowners-errors" + } + } + } + } + }, + "404": { + "description": "Resource not found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/codespaces": { + "get": { + "summary": "List codespaces in a repository for the authenticated user", + "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-in-repository-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "codespaces" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "codespaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespace" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-list-for-repository" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + }, + "post": { + "summary": "Create a codespace in a repository", + "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-with-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "ref": { + "description": "Git ref (typically a branch name) for this codespace", + "type": "string" + }, + "location": { + "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.", + "type": "string" + }, + "geo": { + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", + "type": "string", + "enum": [ + "EuropeWest", + "SoutheastAsia", + "UsEast", + "UsWest" + ] + }, + "client_ip": { + "description": "IP for location auto-detection when proxying a request", + "type": "string" + }, + "machine": { + "description": "Machine type to use for this codespace", + "type": "string" + }, + "devcontainer_path": { + "description": "Path to devcontainer.json config to use for this codespace", + "type": "string" + }, + "multi_repo_permissions_opt_out": { + "description": "Whether to authorize requested permissions from devcontainer.json", + "type": "boolean" + }, + "working_directory": { + "description": "Working directory for this codespace", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "Time in minutes before codespace stops from inactivity", + "type": "integer" + }, + "display_name": { + "description": "Display name for this codespace", + "type": "string" + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer" + } + } + }, + "examples": { + "default": { + "value": { + "ref": "main", + "machine": "standardLinux32gb" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when the codespace was successfully created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "202": { + "description": "Response when the codespace creation partially failed but is being retried in the background", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/repos/{owner}/{repo}/codespaces/devcontainers": { + "get": { + "summary": "List devcontainer configurations in a repository for the authenticated user", + "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-devcontainers-in-repository-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "devcontainers" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "devcontainers": { + "type": "array", + "items": { + "type": "object", + "required": [ + "path" + ], + "properties": { + "path": { + "type": "string" + }, + "name": { + "type": "string" + }, + "display_name": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-list-devcontainers-for-repository" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/repos/{owner}/{repo}/codespaces/machines": { + "get": { + "summary": "List available machine types for a repository", + "description": "List the machine types available for a given repository based on its configuration.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/repo-machines-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "location", + "description": "The location to check for available machines. Assigned by IP if not provided.", + "in": "query", + "schema": { + "type": "string", + "example": "WestUs2" + } + }, + { + "name": "client_ip", + "description": "IP for location auto-detection when proxying a request", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ref", + "description": "The branch or commit to check for prebuild availability and devcontainer restrictions.", + "in": "query", + "schema": { + "type": "string", + "example": "main" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "machines" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "machines": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespace-machine" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace-machines-list" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "machines" + } + } + }, + "/repos/{owner}/{repo}/codespaces/new": { + "get": { + "summary": "Get default attributes for a codespace", + "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/pre-flight-with-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "description": "The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.", + "in": "query", + "schema": { + "type": "string", + "example": "main" + } + }, + { + "name": "client_ip", + "description": "An alternative IP for default location auto-detection, such as when proxying a request.", + "in": "query", + "schema": { + "type": "string", + "example": "1.2.3.4" + } + } + ], + "responses": { + "200": { + "description": "Response when a user is able to create codespaces from the repository.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billable_owner": { + "$ref": "#/components/schemas/simple-user" + }, + "defaults": { + "type": "object", + "required": [ + "location", + "devcontainer_path" + ], + "properties": { + "location": { + "type": "string" + }, + "devcontainer_path": { + "type": "string", + "nullable": true + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-default-attributes-for-a-codespace" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/repos/{owner}/{repo}/codespaces/permissions_check": { + "get": { + "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user", + "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/check-permissions-for-devcontainer", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": "master" + } + }, + { + "name": "devcontainer_path", + "description": "Path to the devcontainer.json configuration to use for the permission check.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": ".devcontainer/example/devcontainer.json" + } + } + ], + "responses": { + "200": { + "description": "Response when the permission check is successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/repos/{owner}/{repo}/codespaces/secrets": { + "get": { + "summary": "List repository secrets", + "description": "Lists all development environment secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repo-codespaces-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-codespaces-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "repository-secrets" + } + } + }, + "/repos/{owner}/{repo}/codespaces/secrets/public-key": { + "get": { + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nIf the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "repository-secrets" + } + } + }, + "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get a repository secret", + "description": "Gets a single repository development environment secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repo-codespaces-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-codespaces-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "repository-secrets" + } + }, + "put": { + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "repository-secrets" + } + }, + "delete": { + "summary": "Delete a repository secret", + "description": "Deletes a development environment secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "repository-secrets" + } + } + }, + "/repos/{owner}/{repo}/collaborators": { + "get": { + "summary": "List repository collaborators", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\nThe `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/list-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "name": "permission", + "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/collaborator" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/collaborator-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "collaborators" + } + } + }, + "/repos/{owner}/{repo}/collaborators/{username}": { + "get": { + "summary": "Check if a user is a repository collaborator", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.\n\nThe authenticated user must have push access to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/check-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response if user is a collaborator" + }, + "404": { + "description": "Not Found if user is not a collaborator" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "collaborators" + } + }, + "put": { + "summary": "Add a repository collaborator", + "description": "Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)\" to learn more about these collaborator types.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\n\nAdding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)\" and \"[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)\" for organization settings.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).\n\nFor Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "tags": [ + "repos" + ], + "operationId": "repos/add-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.", + "default": "push" + } + } + }, + "examples": { + "new-invitation-is-created": { + "summary": "Add a collaborator with triage permissions", + "value": { + "permission": "triage" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when a new invitation is created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-invitation" + }, + "examples": { + "new-invitation-is-created": { + "$ref": "#/components/examples/repository-invitation-response-when-a-new-invitation-is-created" + } + } + } + } + }, + "204": { + "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator" + }, + "422": { + "description": "Response when:\n- validation failed, or the endpoint has been spammed\n- an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/validation-error" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove a repository collaborator", + "description": "Removes a collaborator from a repository.\n\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.\n\nThis endpoint also:\n- Cancels any outstanding invitations sent by the collaborator\n- Unassigns the user from any issues\n- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.\n- Unstars the repository\n- Updates access permissions to packages\n\nRemoving a user as a collaborator has the following effects on forks:\n - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.\n - If the user had their own fork of the repository, the fork will be deleted.\n - If the user still has read access to the repository, open pull requests by this user from a fork will be denied.\n\n> [!NOTE]\n> A user can still have access to the repository through organization permissions like base repository permissions.\n\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.\n\nFor more information on fork permissions, see \"[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)\".", + "tags": [ + "repos" + ], + "operationId": "repos/remove-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "No Content when collaborator was removed from the repository." + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "collaborators" + } + } + }, + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + "get": { + "summary": "Get repository permissions for a user", + "description": "Checks the repository permission and role of a collaborator.\n\nThe `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.\nThe `role_name` attribute provides the name of the assigned role, including custom roles. The\n`permission` can also be used to determine which base level of access the collaborator has to the repository.\n\nThe calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.\nThere is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.", + "tags": [ + "repos" + ], + "operationId": "repos/get-collaborator-permission-level", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "if user has admin permissions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-collaborator-permission" + }, + "examples": { + "response-if-user-has-admin-permissions": { + "$ref": "#/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "collaborators" + } + } + }, + "/repos/{owner}/{repo}/comments": { + "get": { + "summary": "List commit comments for a repository", + "description": "Lists the commit comments for a specified repository. Comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "repos" + ], + "operationId": "repos/list-commit-comments-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}": { + "get": { + "summary": "Get a commit comment", + "description": "Gets a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "repos" + ], + "operationId": "repos/get-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/comments#get-a-commit-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/commit-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "comments" + } + }, + "patch": { + "summary": "Update a commit comment", + "description": "Updates the contents of a specified commit comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "repos" + ], + "operationId": "repos/update-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/comments#update-a-commit-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment" + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Nice change" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/commit-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment-2" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Delete a commit comment", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/delete-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/comments#delete-a-commit-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for a commit comment", + "description": "List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reaction" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for a commit comment", + "description": "Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a commit comment reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + }, + { + "$ref": "#/components/parameters/reaction-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/commits": { + "get": { + "summary": "List commits", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "repos" + ], + "operationId": "repos/list-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/commits#list-commits" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "sha", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "path", + "description": "Only commits containing this file path will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "author", + "description": "GitHub username or email address to use to filter by commit author.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "committer", + "description": "GitHub username or email address to use to filter by commit committer.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "until", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + "get": { + "summary": "List branches for HEAD commit", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "tags": [ + "repos" + ], + "operationId": "repos/list-branches-for-head-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/commits#list-branches-for-head-commit" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-sha" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/branch-short" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/branch-short-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + "get": { + "summary": "List commit comments", + "description": "Lists the comments for a specified commit.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "repos" + ], + "operationId": "repos/list-comments-for-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/comments#list-commit-comments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-sha" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "comments" + } + }, + "post": { + "summary": "Create a commit comment", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "repos" + ], + "operationId": "repos/create-commit-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/comments#create-a-commit-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-sha" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment." + }, + "path": { + "type": "string", + "description": "Relative path of the file to comment on." + }, + "position": { + "type": "integer", + "description": "Line index in the diff to comment on." + }, + "line": { + "type": "integer", + "description": "**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/commit-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + "get": { + "summary": "List pull requests associated with a commit", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.", + "tags": [ + "repos" + ], + "operationId": "repos/list-pull-requests-associated-with-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-sha" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-simple-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/commits/{ref}": { + "get": { + "summary": "Get a commit", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n> [!NOTE]\n> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\" Pagination query parameters are not supported for these media types.\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.\n- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "repos" + ], + "operationId": "repos/get-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/commits#get-a-commit" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/commit-ref" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/commit" + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit" + } + } + }, + "application/vnd.github.diff": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "$ref": "#/components/examples/diff-media-type" + } + } + }, + "application/vnd.github.patch": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "$ref": "#/components/examples/patch-media-type" + } + } + }, + "application/vnd.github.sha": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "value": "ac3282a2725be3b1d4979169a7a311c89066af1c" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + "get": { + "summary": "List check runs for a Git reference", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/list-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-ref" + }, + { + "$ref": "#/components/parameters/check-name" + }, + { + "$ref": "#/components/parameters/status" + }, + { + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "check_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "check_runs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/check-run" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + "get": { + "summary": "List check suites for a Git reference", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.\n\n> [!NOTE]\n> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/list-suites-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-ref" + }, + { + "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "example": 1 + }, + { + "$ref": "#/components/parameters/check-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "check_suites" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "check_suites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/check-suite" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-suite-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/commits/{ref}/status": { + "get": { + "summary": "Get the combined status for a specific reference", + "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", + "tags": [ + "repos" + ], + "operationId": "repos/get-combined-status-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-ref" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/combined-commit-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/combined-commit-status" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "statuses" + } + } + }, + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + "get": { + "summary": "List commit statuses for a reference", + "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", + "tags": [ + "repos" + ], + "operationId": "repos/list-commit-statuses-for-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-ref" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/status" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/status-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "statuses" + } + } + }, + "/repos/{owner}/{repo}/community/profile": { + "get": { + "summary": "Get community profile metrics", + "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "tags": [ + "repos" + ], + "operationId": "repos/get-community-profile-metrics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/community#get-community-profile-metrics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/community-profile" + }, + "examples": { + "default": { + "$ref": "#/components/examples/community-profile" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "community" + } + } + }, + "/repos/{owner}/{repo}/compare/{basehead}": { + "get": { + "summary": "Compare two commits", + "description": "Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\nThis endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.diff`**: Returns the diff of the commit.\n- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.\n\nThe API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\nWhen calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:\n\n- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "repos" + ], + "operationId": "repos/compare-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/commits#compare-two-commits" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "basehead", + "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.", + "in": "path", + "required": true, + "x-multi-segment": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/commit-comparison" + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-comparison" + } + } + }, + "application/vnd.github.diff": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "$ref": "#/components/examples/diff-media-type" + } + } + }, + "application/vnd.github.patch": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "$ref": "#/components/examples/patch-media-type" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/contents/{path}": { + "get": { + "summary": "Get repository content", + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported.", + "tags": [ + "repos" + ], + "operationId": "repos/get-content", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#get-repository-content" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "path", + "description": "path parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "examples": { + "response-if-content-is-a-file-github-object": { + "summary": "Content is a file using the object media type" + }, + "response-if-content-is-a-directory-github-object": { + "summary": "Content is a directory using the object media type" + }, + "response-if-content-is-a-file": { + "summary": "Content is a file" + }, + "response-if-content-is-a-directory": { + "summary": "Content is a directory" + }, + "response-if-content-is-a-symlink": { + "summary": "Content is a symlink" + }, + "response-if-content-is-a-submodule": { + "summary": "Content is a submodule" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/vnd.github.object": { + "schema": { + "$ref": "#/components/schemas/content-tree" + }, + "examples": { + "response-if-content-is-a-file-github-object": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-file" + }, + "response-if-content-is-a-directory-github-object": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-directory-object" + } + } + }, + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/content-directory" + }, + { + "$ref": "#/components/schemas/content-file" + }, + { + "$ref": "#/components/schemas/content-symlink" + }, + { + "$ref": "#/components/schemas/content-submodule" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "array": "#/components/schemas/content-directory", + "file": "#/components/schemas/content-file", + "symlink": "#/components/schemas/content-symlink", + "submodule": "#/components/schemas/content-submodule" + } + } + }, + "examples": { + "response-if-content-is-a-file": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-file" + }, + "response-if-content-is-a-directory": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-directory" + }, + "response-if-content-is-a-symlink": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-symlink" + }, + "response-if-content-is-a-submodule": { + "$ref": "#/components/examples/content-file-response-if-content-is-a-submodule" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "302": { + "$ref": "#/components/responses/found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + }, + "x-github-breaking-changes": [ + { + "changeset": "return_submodule_type_for_submodules_in_directory_lists", + "patch": { + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.\n- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).\n- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.\n\nIf the content is a directory: The response will be an array of objects, one object for each item in the directory.\n\nIf the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.\n\nIf the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.\n\n**Notes**:\n\n- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\n- This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).\n- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n- If the requested file's size is:\n - 1 MB or smaller: All features of this endpoint are supported.\n - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty\nstring and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n - Greater than 100 MB: This endpoint is not supported." + }, + "version": "2026-03-10" + } + ] + }, + "put": { + "summary": "Create or update file contents", + "description": "Creates a new file or replaces an existing file in a repository.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-file-contents", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#create-or-update-file-contents" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "path", + "description": "path parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The commit message." + }, + "content": { + "type": "string", + "description": "The new file content, using Base64 encoding." + }, + "sha": { + "type": "string", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced." + }, + "branch": { + "type": "string", + "description": "The branch name. Default: the repository’s default branch." + }, + "committer": { + "type": "object", + "description": "The person that committed the file. Default: the authenticated user.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." + }, + "email": { + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted." + }, + "date": { + "type": "string", + "example": "\"2013-01-05T13:13:22+05:00\"" + } + }, + "required": [ + "name", + "email" + ] + }, + "author": { + "type": "object", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted." + }, + "email": { + "type": "string", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted." + }, + "date": { + "type": "string", + "example": "\"2013-01-15T17:13:22+05:00\"" + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "message", + "content" + ] + }, + "examples": { + "example-for-creating-a-file": { + "summary": "Example for creating a file", + "value": { + "message": "my commit message", + "committer": { + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "content": "bXkgbmV3IGZpbGUgY29udGVudHM=" + } + }, + "example-for-updating-a-file": { + "summary": "Example for updating a file", + "value": { + "message": "a new commit message", + "committer": { + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "content": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", + "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-commit" + }, + "examples": { + "example-for-updating-a-file": { + "$ref": "#/components/examples/file-commit-example-for-updating-a-file" + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-commit" + }, + "examples": { + "example-for-creating-a-file": { + "$ref": "#/components/examples/file-commit-example-for-creating-a-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/basic-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + } + }, + "delete": { + "summary": "Delete a file", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n> [!NOTE]\n> If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-file", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#delete-a-file" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "path", + "description": "path parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The commit message." + }, + "sha": { + "type": "string", + "description": "The blob SHA of the file being deleted." + }, + "branch": { + "type": "string", + "description": "The branch name. Default: the repository’s default branch" + }, + "committer": { + "type": "object", + "description": "object containing information about the committer.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + } + } + }, + "author": { + "type": "object", + "description": "object containing information about the author.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + } + } + } + }, + "required": [ + "message", + "sha" + ] + }, + "examples": { + "default": { + "value": { + "message": "my commit message", + "committer": { + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "sha": "329688480d39049927147c162b9d2deaf885005f" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-commit" + }, + "examples": { + "default": { + "$ref": "#/components/examples/file-commit" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/contributors": { + "get": { + "summary": "List repository contributors", + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "tags": [ + "repos" + ], + "operationId": "repos/list-contributors", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repository-contributors" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "If repository contains content", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/contributor" + } + }, + "examples": { + "response-if-repository-contains-content": { + "$ref": "#/components/examples/contributor-items-response-if-repository-contains-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "204": { + "description": "Response if repository is empty" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/dependabot/alerts": { + "get": { + "summary": "List Dependabot alerts for a repository", + "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-classifications" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-states" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" + }, + { + "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" + }, + { + "$ref": "#/components/parameters/dependabot-alert-scope" + }, + { + "$ref": "#/components/parameters/dependabot-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dependabot-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-alerts-for-repository" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + "get": { + "summary": "Get a Dependabot alert", + "description": "OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/dependabot-alert-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-alert-open" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "dependabot", + "subcategory": "alerts" + } + }, + "patch": { + "summary": "Update a Dependabot alert", + "description": "The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/update-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/dependabot-alert-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the Dependabot alert.\nA `dismissed_reason` must be provided when setting the state to `dismissed`.", + "enum": [ + "dismissed", + "open" + ] + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when `state` is `dismissed`.** A reason for dismissing the alert.", + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "An optional comment associated with dismissing the alert.", + "maxLength": 280 + }, + "assignees": { + "type": "array", + "description": "Usernames to assign to this Dependabot Alert.\nPass one or more user logins to _replace_ the set of assignees on this alert.\nSend an empty array (`[]`) to clear all assignees from the alert.", + "items": { + "type": "string" + } + } + }, + "anyOf": [ + { + "required": [ + "state" + ] + }, + { + "required": [ + "assignees" + ] + } + ], + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "state": "dismissed", + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-alert-dismissed" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "dependabot", + "subcategory": "alerts" + } + } + }, + "/repos/{owner}/{repo}/dependabot/secrets": { + "get": { + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#list-repository-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/dependabot-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + "get": { + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets. Anyone with read access\nto the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + "get": { + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependabot-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependabot-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "dependabot" + ], + "operationId": "dependabot/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependabot", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + "get": { + "summary": "Get a diff of the dependencies between commits", + "description": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.", + "tags": [ + "dependency-graph" + ], + "operationId": "dependency-graph/diff-range", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "basehead", + "description": "The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/manifest-path" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependency-graph-diff" + }, + "examples": { + "default": { + "$ref": "#/components/examples/diff-range-response" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/dependency_review_forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "dependency-graph", + "subcategory": "dependency-review" + } + } + }, + "/repos/{owner}/{repo}/dependency-graph/sbom": { + "get": { + "summary": "Export a software bill of materials (SBOM) for a repository.", + "description": "Exports the software bill of materials (SBOM) for a repository in SPDX JSON format.", + "tags": [ + "dependency-graph" + ], + "operationId": "dependency-graph/export-sbom", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dependency-graph-spdx-sbom" + }, + "examples": { + "default": { + "$ref": "#/components/examples/dependency-graph-export-sbom-response" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "dependency-graph", + "subcategory": "sboms" + } + } + }, + "/repos/{owner}/{repo}/dependency-graph/snapshots": { + "post": { + "summary": "Create a snapshot of dependencies for a repository", + "description": "Create a new snapshot of a repository's dependencies.\n\nThe authenticated user must have access to the repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "dependency-graph" + ], + "operationId": "dependency-graph/create-repository-snapshot", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/snapshot" + }, + "examples": { + "example-of-a-dependency-submission": { + "$ref": "#/components/examples/dependency-graph-create-snapshot-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "id", + "created_at", + "result", + "message" + ], + "properties": { + "id": { + "type": "integer", + "description": "ID of the created snapshot." + }, + "created_at": { + "type": "string", + "description": "The time at which the snapshot was created." + }, + "result": { + "type": "string", + "description": "Either \"SUCCESS\", \"ACCEPTED\", or \"INVALID\". \"SUCCESS\" indicates that the snapshot was successfully created and the repository's dependencies were updated. \"ACCEPTED\" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. \"INVALID\" indicates that the snapshot was malformed." + }, + "message": { + "type": "string", + "description": "A message providing further details about the result, such as why the dependencies were not updated." + } + } + }, + "examples": { + "example-of-a-dependency-submission": { + "$ref": "#/components/examples/dependency-graph-create-snapshot-success" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "dependency-graph", + "subcategory": "dependency-submission" + } + } + }, + "/repos/{owner}/{repo}/deployments": { + "get": { + "summary": "List deployments", + "description": "Simple filtering of deployments is available via query parameters:", + "tags": [ + "repos" + ], + "operationId": "repos/list-deployments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/deployments#list-deployments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "sha", + "description": "The SHA recorded at creation time.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "none" + } + }, + { + "name": "ref", + "description": "The name of the ref. This can be a branch, tag, or SHA.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "none" + } + }, + { + "name": "task", + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "none" + } + }, + { + "name": "environment", + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "none", + "nullable": true + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deployment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "deployments" + } + }, + "post": { + "summary": "Create a deployment", + "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `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\nThe `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\nThe `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\nBy default, [commit statuses](https://docs.github.com/rest/commits/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\nThe `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\nThe `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\nMerged branch response:\n\nYou 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* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\nMerge conflict response:\n\nThis 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\nFailed commit status checks:\n\nThis 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`.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/deployments#create-a-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The ref to deploy. This can be a branch, tag, or SHA." + }, + "task": { + "type": "string", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "default": "deploy" + }, + "auto_merge": { + "type": "boolean", + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", + "default": true + }, + "required_contexts": { + "type": "array", + "description": "The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "items": { + "type": "string" + } + }, + "payload": { + "oneOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "string", + "description": "JSON payload with extra information about the deployment.", + "default": "" + } + ] + }, + "environment": { + "type": "string", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "default": "production" + }, + "description": { + "type": "string", + "description": "Short description of the deployment.", + "default": "", + "nullable": true + }, + "transient_environment": { + "type": "boolean", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", + "default": false + }, + "production_environment": { + "type": "boolean", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise." + } + }, + "required": [ + "ref" + ] + }, + "examples": { + "simple-example": { + "summary": "Simple example", + "value": { + "ref": "topic-branch", + "payload": "{ \"deploy\": \"migrate\" }", + "description": "Deploy request from hubot" + } + }, + "advanced-example": { + "summary": "Advanced example", + "value": { + "ref": "topic-branch", + "auto_merge": false, + "payload": "{ \"deploy\": \"migrate\" }", + "description": "Deploy request from hubot", + "required_contexts": [ + "ci/janky", + "security/brakeman" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment" + }, + "examples": { + "simple-example": { + "$ref": "#/components/examples/deployment-simple-example" + } + } + } + } + }, + "202": { + "description": "Merged branch response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "merged-branch-response": { + "value": { + "message": "Auto-merged master into topic-branch on deployment." + } + } + } + } + } + }, + "409": { + "description": "Conflict when there is a merge conflict or the commit's status checks failed" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "deployments" + } + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + "get": { + "summary": "Get a deployment", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/get-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/deployments#get-a-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/deployment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "deployments" + } + }, + "delete": { + "summary": "Delete a deployment", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/deployments#delete-a-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/deployment-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "deployments" + } + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + "get": { + "summary": "List deployment statuses", + "description": "Users with pull access can view deployment statuses for a deployment:", + "tags": [ + "repos" + ], + "operationId": "repos/list-deployment-statuses", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/statuses#list-deployment-statuses" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/deployment-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deployment-status" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-status-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "statuses" + } + }, + "post": { + "summary": "Create a deployment status", + "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deployment-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/statuses#create-a-deployment-status" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/deployment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", + "enum": [ + "error", + "failure", + "inactive", + "in_progress", + "queued", + "pending", + "success" + ] + }, + "target_url": { + "type": "string", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.\n\n> [!NOTE]\n> It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "default": "" + }, + "log_url": { + "type": "string", + "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", + "default": "" + }, + "description": { + "type": "string", + "description": "A short description of the status. The maximum description length is 140 characters.", + "default": "" + }, + "environment": { + "type": "string", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used." + }, + "environment_url": { + "type": "string", + "description": "Sets the URL for accessing your environment. Default: `\"\"`", + "default": "" + }, + "auto_inactive": { + "type": "boolean", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`" + } + }, + "required": [ + "state" + ] + }, + "examples": { + "default": { + "value": { + "environment": "production", + "state": "success", + "log_url": "https://example.com/deployment/42/output", + "description": "Deployment finished successfully." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-status" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "statuses" + } + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + "get": { + "summary": "Get a deployment status", + "description": "Users with pull access can view a deployment status for a deployment:", + "tags": [ + "repos" + ], + "operationId": "repos/get-deployment-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/statuses#get-a-deployment-status" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/deployment-id" + }, + { + "name": "status_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-status" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "statuses" + } + } + }, + "/repos/{owner}/{repo}/dispatches": { + "post": { + "summary": "Create a repository dispatch event", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-dispatch-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "event_type" + ], + "properties": { + "event_type": { + "type": "string", + "description": "A custom webhook event name. Must be 100 characters or fewer.", + "minLength": 1, + "maxLength": 100 + }, + "client_payload": { + "type": "object", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.", + "additionalProperties": true, + "maxProperties": 10 + } + } + }, + "examples": { + "default": { + "value": { + "event_type": "on-demand-test", + "client_payload": { + "unit": false, + "integration": true + } + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/environments": { + "get": { + "summary": "List environments", + "description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-environments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/environments#list-environments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of environments in this repository", + "example": 5, + "type": "integer" + }, + "environments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/environment" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/environments" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "environments" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}": { + "get": { + "summary": "Get an environment", + "description": "> [!NOTE]\n> To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/environments#get-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/environment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/environment" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "environments" + } + }, + "put": { + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n> [!NOTE]\n> To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n> [!NOTE]\n> To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/environments#create-or-update-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "wait_timer": { + "$ref": "#/components/schemas/wait-timer" + }, + "prevent_self_review": { + "$ref": "#/components/schemas/prevent-self-review" + }, + "reviewers": { + "type": "array", + "nullable": true, + "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/deployment-reviewer-type" + }, + "id": { + "type": "integer", + "description": "The id of the user or team who can review the deployment", + "example": 4532992 + } + } + } + }, + "deployment_branch_policy": { + "$ref": "#/components/schemas/deployment-branch-policy-settings" + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "wait_timer": 30, + "prevent_self_review": false, + "reviewers": [ + { + "type": "User", + "id": 1 + }, + { + "type": "Team", + "id": 1 + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/environment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/environment" + } + } + } + } + }, + "422": { + "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "environments" + } + }, + "delete": { + "summary": "Delete an environment", + "description": "OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-an-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/environments#delete-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "environments" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + "get": { + "summary": "List deployment branch policies", + "description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-deployment-branch-policies", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of deployment branch policies for the environment.", + "type": "integer", + "example": 2 + }, + "branch_policies": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deployment-branch-policy" + } + } + }, + "required": [ + "total_count", + "branch_policies" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-branch-policies-list" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "branch-policies" + } + }, + "post": { + "summary": "Create a deployment branch policy", + "description": "Creates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deployment-branch-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" + }, + "examples": { + "example-wildcard": { + "summary": "Example of a wildcard name pattern", + "value": { + "name": "release/*" + } + }, + "example-single-branch": { + "summary": "Example of a single branch name pattern", + "value": { + "name": "main", + "type": "branch" + } + }, + "example-single-tag": { + "summary": "Example of a single tag name pattern", + "value": { + "name": "v1", + "type": "tag" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-branch-policy" + }, + "examples": { + "example-wildcard": { + "$ref": "#/components/examples/deployment-branch-policy-wildcard" + }, + "example-single-branch": { + "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" + } + } + } + } + }, + "404": { + "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false" + }, + "303": { + "description": "Response if the same branch name pattern already exists" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "branch-policies" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + "get": { + "summary": "Get a deployment branch policy", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-deployment-branch-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/branch-policy-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-branch-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-branch-policy-wildcard" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "branch-policies" + } + }, + "put": { + "summary": "Update a deployment branch policy", + "description": "Updates a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update-deployment-branch-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/branch-policy-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + }, + "examples": { + "default": { + "value": { + "name": "release/*" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-branch-policy" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-branch-policy-wildcard" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "branch-policies" + } + }, + "delete": { + "summary": "Delete a deployment branch policy", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-deployment-branch-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/branch-policy-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "branch-policies" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + "get": { + "summary": "Get all deployment protection rules for an environment", + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-deployment-protection-rules", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + } + ], + "responses": { + "200": { + "description": "List of deployment protection rules", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of enabled custom deployment protection rules for this environment", + "type": "integer", + "example": 10 + }, + "custom_deployment_protection_rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deployment-protection-rule" + } + } + }, + "example": { + "$ref": "#/components/examples/deployment-protection-rules" + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "custom_deployment_protection_rules": [ + { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + }, + { + "id": 4, + "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", + "enabled": true, + "app": { + "id": 1, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + } + }, + "post": { + "summary": "Create a custom deployment protection rule on an environment", + "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deployment-protection-rule", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "integration_id": { + "type": "integer", + "description": "The ID of the custom app that will be enabled on the environment." + } + } + }, + "examples": { + "default": { + "value": { + "integration_id": 5 + } + } + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "The enabled custom deployment protection rule", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-protection-rule" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-protection-rule" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + "get": { + "summary": "List custom deployment rule integrations available for an environment", + "description": "Gets all custom deployment protection rule integrations that are available for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-custom-deployment-rule-integrations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "A list of custom deployment rule integrations available for this environment.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The total number of custom deployment protection rule integrations available for this environment.", + "type": "integer", + "example": 35 + }, + "available_custom_deployment_protection_rule_integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-deployment-rule-app" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-deployment-protection-rule-apps" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + "get": { + "summary": "Get a custom deployment protection rule", + "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-custom-deployment-protection-rule", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/protection-rule-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deployment-protection-rule" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deployment-protection-rule" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + } + }, + "delete": { + "summary": "Disable a custom protection rule for an environment", + "description": "Disables a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/disable-deployment-protection-rule", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/protection-rule-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deployments", + "subcategory": "protection-rules" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#list-environment-secrets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\n\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "description": "Gets a single environment secret without revealing its encrypted value.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + }, + "required": [ + "encrypted_value", + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an environment secret", + "description": "Deletes a secret in an environment using the secret name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Default response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + "get": { + "summary": "List environment variables", + "description": "Lists all environment variables.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-variables", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#list-environment-variables" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variables-per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "variables" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "variables": { + "type": "array", + "items": { + "$ref": "#/components/schemas/actions-variable" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variables-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "post": { + "summary": "Create an environment variable", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/create-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#create-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + }, + "required": [ + "name", + "value" + ] + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + "get": { + "summary": "Get an environment variable", + "description": "Gets a specific variable in an environment.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#get-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/environment-name" + }, + { + "$ref": "#/components/parameters/variable-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-variable" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-variable" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "patch": { + "summary": "Update an environment variable", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/update-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#update-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the variable." + }, + "value": { + "type": "string", + "description": "The value of the variable." + } + } + }, + "examples": { + "default": { + "value": { + "name": "USERNAME", + "value": "octocat" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + }, + "delete": { + "summary": "Delete an environment variable", + "description": "Deletes an environment variable using the variable name.\n\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.\n\nOAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-variable", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/variable-name" + }, + { + "$ref": "#/components/parameters/environment-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "variables" + } + } + }, + "/repos/{owner}/{repo}/events": { + "get": { + "summary": "List repository events", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-repo-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-repository-events" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "200-response": { + "$ref": "#/components/examples/repo-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/forks": { + "get": { + "summary": "List forks", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/list-forks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/forks#list-forks" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "sort", + "description": "The sort order. `stargazers` will sort by star count.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "newest", + "oldest", + "stargazers", + "watchers" + ], + "default": "newest" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items-2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "forks" + } + }, + "post": { + "summary": "Create a fork", + "description": "Create a fork for the authenticated user.\n\n> [!NOTE]\n> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n\n> [!NOTE]\n> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-fork", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/forks#create-a-fork" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "organization": { + "type": "string", + "description": "Optional parameter to specify the organization name if forking into an organization." + }, + "name": { + "type": "string", + "description": "When forking from an existing repository, a new name for the fork." + }, + "default_branch_only": { + "type": "boolean", + "description": "When forking from an existing repository, fork with only the default branch." + } + } + }, + "examples": { + "default": { + "value": { + "organization": "octocat", + "name": "Hello-World", + "default_branch_only": true + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/full-repository" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "forks" + } + } + }, + "/repos/{owner}/{repo}/git/blobs": { + "post": { + "summary": "Create a blob", + "description": "", + "tags": [ + "git" + ], + "operationId": "git/create-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/blobs#create-a-blob" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The new blob's content." + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "Content of the blob", + "encoding": "utf-8" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/short-blob" + }, + "examples": { + "default": { + "$ref": "#/components/examples/short-blob" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/validation-error" + }, + { + "$ref": "#/components/schemas/repository-rule-violation-error" + } + ] + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "blobs" + } + } + }, + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + "get": { + "summary": "Get a blob", + "description": "The `content` in the response will always be Base64 encoded.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw blob data.\n- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.\n\n**Note** This endpoint supports blobs up to 100 megabytes in size.", + "tags": [ + "git" + ], + "operationId": "git/get-blob", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/blobs#get-a-blob" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "file_sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/blob" + }, + "examples": { + "default": { + "$ref": "#/components/examples/blob" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "blobs" + } + } + }, + "/repos/{owner}/{repo}/git/commits": { + "post": { + "summary": "Create a commit", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/create-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/commits#create-a-commit" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The commit message" + }, + "tree": { + "type": "string", + "description": "The SHA of the tree object this commit points to" + }, + "parents": { + "type": "array", + "description": "The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "items": { + "type": "string" + } + }, + "author": { + "type": "object", + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "name", + "email" + ] + }, + "committer": { + "type": "object", + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author (or committer) of the commit" + }, + "email": { + "type": "string", + "description": "The email of the author (or committer) of the commit" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + } + }, + "signature": { + "type": "string", + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits." + } + }, + "required": [ + "message", + "tree" + ] + }, + "examples": { + "default": { + "value": { + "message": "my commit message", + "author": { + "name": "Mona Octocat", + "email": "octocat@github.com", + "date": "2008-07-09T16:13:30+12:00" + }, + "parents": [ + "7d1b31e74ee336d15cbd21741bc88a537ed063a0" + ], + "tree": "827efc6d56897b048c772eb4087f854f46256132", + "signature": "-----BEGIN PGP SIGNATURE-----\n\niQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv\n7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI\nDkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n\n2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA\nOQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k\nnrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU\n+NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB\njHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ\n3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+\nUpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr\nX11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp\neSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc=\n=5Io4\n-----END PGP SIGNATURE-----\n" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-commit" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-commit" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + "get": { + "summary": "Get a commit object", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/get-commit", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/commits#get-a-commit-object" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/commit-sha" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-commit" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-commit-2" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "commits" + } + } + }, + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + "get": { + "summary": "List matching references", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "tags": [ + "git" + ], + "operationId": "git/list-matching-refs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#list-matching-references" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref-only" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/git-ref" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-ref-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/ref/{ref}": { + "get": { + "summary": "Get a reference", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n> [!NOTE]\n> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", + "tags": [ + "git" + ], + "operationId": "git/get-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#get-a-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref-only" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-ref" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-ref" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/refs": { + "post": { + "summary": "Create a reference", + "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "tags": [ + "git" + ], + "operationId": "git/create-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#create-a-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected." + }, + "sha": { + "type": "string", + "description": "The SHA1 value for this reference." + } + }, + "required": [ + "ref", + "sha" + ] + }, + "examples": { + "default": { + "value": { + "ref": "refs/heads/featureA", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-ref" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-ref" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/refs/{ref}": { + "patch": { + "summary": "Update a reference", + "description": "Updates the provided reference to point to a new SHA. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "tags": [ + "git" + ], + "operationId": "git/update-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#update-a-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref-only" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "description": "The SHA1 value to set this reference to" + }, + "force": { + "type": "boolean", + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "default": false + } + }, + "required": [ + "sha" + ] + }, + "examples": { + "default": { + "value": { + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "force": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-ref" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-ref" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + }, + "delete": { + "summary": "Delete a reference", + "description": "Deletes the provided reference.", + "tags": [ + "git" + ], + "operationId": "git/delete-ref", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/refs#delete-a-reference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref-only" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "description": "Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed." + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "refs" + } + } + }, + "/repos/{owner}/{repo}/git/tags": { + "post": { + "summary": "Create a tag object", + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/create-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/tags#create-a-tag-object" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag": { + "type": "string", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\")." + }, + "message": { + "type": "string", + "description": "The tag message." + }, + "object": { + "type": "string", + "description": "The SHA of the git object this is tagging." + }, + "type": { + "type": "string", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "enum": [ + "commit", + "tree", + "blob" + ] + }, + "tagger": { + "type": "object", + "description": "An object with information about the individual creating the tag.", + "properties": { + "name": { + "type": "string", + "description": "The name of the author of the tag" + }, + "email": { + "type": "string", + "description": "The email of the author of the tag" + }, + "date": { + "type": "string", + "format": "date-time", + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "tag", + "message", + "object", + "type" + ] + }, + "examples": { + "default": { + "value": { + "tag": "v0.0.1", + "message": "initial version", + "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "type": "commit", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2011-06-17T14:53:35-07:00" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-tag" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-tag" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "tags" + } + } + }, + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "get": { + "summary": "Get a tag", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n| `verified_at` | `string` | The date the signature was verified by GitHub. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "tags": [ + "git" + ], + "operationId": "git/get-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/tags#get-a-tag" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "tag_sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-tag" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-tag" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "tags" + } + } + }, + "/repos/{owner}/{repo}/git/trees": { + "post": { + "summary": "Create a tree", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "tags": [ + "git" + ], + "operationId": "git/create-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/trees#create-a-tree" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tree": { + "type": "array", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file referenced in the tree." + }, + "mode": { + "type": "string", + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" + ] + }, + "type": { + "type": "string", + "description": "Either `blob`, `tree`, or `commit`.", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + "sha": { + "type": "string", + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "nullable": true + }, + "content": { + "type": "string", + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error." + } + } + } + }, + "base_tree": { + "type": "string", + "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit." + } + }, + "required": [ + "tree" + ] + }, + "examples": { + "default": { + "value": { + "base_tree": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "sha": "44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-tree" + }, + "examples": { + "default": { + "$ref": "#/components/examples/git-tree" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "trees" + } + } + }, + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + "get": { + "summary": "Get a tree", + "description": "Returns a single tree using the SHA1 value or ref name for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n> [!NOTE]\n> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "tags": [ + "git" + ], + "operationId": "git/get-tree", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/git/trees#get-a-tree" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "tree_sha", + "description": "The SHA1 value or ref (branch or tag) name of the tree.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "recursive", + "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/git-tree" + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/git-tree-default-response" + }, + "response-recursively-retrieving-a-tree": { + "$ref": "#/components/examples/git-tree-response-recursively-retrieving-a-tree" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "git", + "subcategory": "trees" + } + } + }, + "/repos/{owner}/{repo}/hooks": { + "get": { + "summary": "List repository webhooks", + "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", + "tags": [ + "repos" + ], + "operationId": "repos/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#list-repository-webhooks" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/hook" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "post": { + "summary": "Create a repository webhook", + "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", + "tags": [ + "repos" + ], + "operationId": "repos/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "name": { + "type": "string", + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`." + }, + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook.", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "https://example.com/webhook", + "content_type": "json", + "insecure_ssl": "0" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}": { + "get": { + "summary": "Get a repository webhook", + "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a repository webhook", + "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"", + "tags": [ + "repos" + ], + "operationId": "repos/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "$ref": "#/components/schemas/webhook-config" + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "add_events": { + "type": "array", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "items": { + "type": "string" + } + }, + "remove_events": { + "type": "array", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + } + }, + "examples": { + "default": { + "value": { + "active": true, + "add_events": [ + "pull_request" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hook" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "delete": { + "summary": "Delete a repository webhook", + "description": "Delete a webhook for an organization.\n\nThe authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + "get": { + "summary": "Get a webhook configuration for a repository", + "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/webhook-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + }, + "patch": { + "summary": "Update a webhook configuration for a repository", + "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook).\"\n\nOAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update-webhook-config-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "examples": { + "default": { + "summary": "Example of updating content type and URL", + "value": { + "content_type": "json", + "url": "https://example.com/webhook" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-config" + }, + "examples": { + "default": { + "$ref": "#/components/examples/webhook-config" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + "get": { + "summary": "List deliveries for a repository webhook", + "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-webhook-deliveries", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/cursor" + }, + { + "$ref": "#/components/parameters/webhook-delivery-status" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/hook-delivery-item" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + "get": { + "summary": "Get a delivery for a repository webhook", + "description": "Returns a delivery for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + }, + { + "$ref": "#/components/parameters/delivery-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hook-delivery" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hook-delivery" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + "post": { + "summary": "Redeliver a delivery for a repository webhook", + "description": "Redeliver a webhook delivery for a webhook configured in a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/redeliver-webhook-delivery", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + }, + { + "$ref": "#/components/parameters/delivery-id" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping a repository webhook", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "tags": [ + "repos" + ], + "operationId": "repos/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + "post": { + "summary": "Test the push repository webhook", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n> [!NOTE]\n> Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "tags": [ + "repos" + ], + "operationId": "repos/test-push-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/hook-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "webhooks" + } + } + }, + "/repos/{owner}/{repo}/immutable-releases": { + "get": { + "summary": "Check if immutable releases are enabled for a repository", + "description": "Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being\nenforced by the repository owner. The authenticated user must have admin read access to the repository.", + "tags": [ + "repos" + ], + "operationId": "repos/check-immutable-releases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response if immutable releases are enabled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/check-immutable-releases" + }, + "examples": { + "default": { + "value": { + "enabled": true, + "enforced_by_owner": false + } + } + } + } + } + }, + "404": { + "description": "Not Found if immutable releases are not enabled for the repository" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable immutable releases", + "description": "Enables immutable releases for a repository. The authenticated user must have admin access to the repository.", + "tags": [ + "repos" + ], + "operationId": "repos/enable-immutable-releases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#enable-immutable-releases" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable immutable releases", + "description": "Disables immutable releases for a repository. The authenticated user must have admin access to the repository.", + "tags": [ + "repos" + ], + "operationId": "repos/disable-immutable-releases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#disable-immutable-releases" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/import": { + "get": { + "summary": "Get an import status", + "description": "View the progress of an import.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-import-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#get-an-import-status" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/import" + }, + "examples": { + "default": { + "$ref": "#/components/examples/import" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "put": { + "summary": "Start an import", + "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/start-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#start-an-import" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vcs_url": { + "type": "string", + "description": "The URL of the originating repository." + }, + "vcs": { + "type": "string", + "description": "The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", + "enum": [ + "subversion", + "git", + "mercurial", + "tfvc" + ] + }, + "vcs_username": { + "type": "string", + "description": "If authentication is required, the username to provide to `vcs_url`." + }, + "vcs_password": { + "type": "string", + "description": "If authentication is required, the password to provide to `vcs_url`." + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported." + } + }, + "required": [ + "vcs_url" + ] + }, + "examples": { + "default": { + "value": { + "vcs": "subversion", + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "vcs_username": "octocat", + "vcs_password": "secret" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/import" + }, + "examples": { + "default": { + "$ref": "#/components/examples/import-2" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/spraints/socm/import", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "patch": { + "summary": "Update an import", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/update-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#update-an-import" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vcs_username": { + "type": "string", + "description": "The username to provide to the originating repository." + }, + "vcs_password": { + "type": "string", + "description": "The password to provide to the originating repository." + }, + "vcs": { + "type": "string", + "description": "The type of version control system you are migrating from.", + "enum": [ + "subversion", + "tfvc", + "git", + "mercurial" + ], + "example": "\"git\"" + }, + "tfvc_project": { + "type": "string", + "description": "For a tfvc import, the name of the project that is being imported.", + "example": "\"project1\"" + } + }, + "nullable": true + }, + "examples": { + "example-1": { + "summary": "Update authentication for an import", + "value": { + "vcs_username": "octocat", + "vcs_password": "secret" + } + }, + "example-2": { + "summary": "Updating the project choice", + "value": { + "vcs": "tfvc", + "tfvc_project": "project1", + "human_name": "project1 (tfs)" + } + }, + "example-3": { + "summary": "Restarting an import" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/import" + }, + "examples": { + "example-1": { + "$ref": "#/components/examples/import-example-1" + }, + "example-2": { + "$ref": "#/components/examples/import-example-2" + }, + "example-3": { + "$ref": "#/components/examples/import-response" + } + } + } + } + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + }, + "delete": { + "summary": "Cancel an import", + "description": "Stop an import for a repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/cancel-import", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#cancel-an-import" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/import/authors": { + "get": { + "summary": "Get commit authors", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-commit-authors", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#get-commit-authors" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/since-user" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/porter-author" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/porter-author-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/import/authors/{author_id}": { + "patch": { + "summary": "Map a commit author", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/map-commit-author", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#map-a-commit-author" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "author_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The new Git author email." + }, + "name": { + "type": "string", + "description": "The new Git author name." + } + }, + "additionalProperties": false + }, + "examples": { + "default": { + "value": { + "email": "hubot@github.com", + "name": "Hubot the Robot" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/porter-author" + }, + "examples": { + "default": { + "$ref": "#/components/examples/porter-author" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/import/large_files": { + "get": { + "summary": "Get large files", + "description": "List files larger than 100MB found during the import\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-large-files", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#get-large-files" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/porter-large-file" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/porter-large-file-items" + } + } + } + } + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/import/lfs": { + "patch": { + "summary": "Update Git LFS preference", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n> [!WARNING]\n> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", + "tags": [ + "migrations" + ], + "operationId": "migrations/set-lfs-preference", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "use_lfs": { + "type": "string", + "description": "Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.", + "enum": [ + "opt_in", + "opt_out" + ] + } + }, + "required": [ + "use_lfs" + ] + }, + "examples": { + "default": { + "value": { + "use_lfs": "opt_in" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/import" + }, + "examples": { + "default": { + "$ref": "#/components/examples/import" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/porter_maintenance" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "migrations", + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}/installation": { + "get": { + "summary": "Get a repository installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-repo-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/repos/{owner}/{repo}/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for a repository", + "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", + "tags": [ + "interactions" + ], + "operationId": "interactions/get-restrictions-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/interaction-limit-response" + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false + } + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "repos" + } + }, + "put": { + "summary": "Set interaction restrictions for a repository", + "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", + "tags": [ + "interactions" + ], + "operationId": "interactions/set-restrictions-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit" + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "limit": "collaborators_only", + "expiry": "one_day" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-2" + } + } + } + } + }, + "409": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Remove interaction restrictions for a repository", + "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", + "tags": [ + "interactions" + ], + "operationId": "interactions/remove-restrictions-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "interactions", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/invitations": { + "get": { + "summary": "List repository invitations", + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", + "tags": [ + "repos" + ], + "operationId": "repos/list-invitations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-invitation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + "patch": { + "summary": "Update a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/update-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/invitation-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permissions": { + "type": "string", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", + "enum": [ + "read", + "write", + "maintain", + "triage", + "admin" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example request body", + "value": { + "permissions": "write" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-invitation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-invitation" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "invitations" + } + }, + "delete": { + "summary": "Delete a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/delete-invitation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/invitation-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/repos/{owner}/{repo}/issues": { + "get": { + "summary": "List repository issues", + "description": "List issues in a repository. Only open issues will be listed.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#list-repository-issues" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "milestone", + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "type", + "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "creator", + "description": "The user that created the issue.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "mentioned", + "description": "A user that's mentioned in the issue.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/labels" + }, + { + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + }, + "post": { + "summary": "Create an issue", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#create-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue." + }, + "body": { + "type": "string", + "description": "The contents of the issue." + }, + "assignee": { + "type": "string", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_", + "nullable": true + }, + "milestone": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._" + } + ], + "nullable": true + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._", + "nullable": true, + "example": "Epic" + } + }, + "required": [ + "title" + ] + }, + "examples": { + "default": { + "value": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "labels": [ + "bug" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "assignee": null + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/repos/{owner}/{repo}/issues/comments": { + "get": { + "summary": "List issue comments for a repository", + "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-comments-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "name": "direction", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + "get": { + "summary": "Get an issue comment", + "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#get-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + }, + "patch": { + "summary": "Update an issue comment", + "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/update-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#update-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Me too" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Delete an issue comment", + "description": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", + "tags": [ + "issues" + ], + "operationId": "issues/delete-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + "put": { + "summary": "Pin an issue comment", + "description": "You can use the REST API to pin comments on issues.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/pin-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#pin-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment-pinned" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Unpin an issue comment", + "description": "You can use the REST API to unpin comments on issues.", + "tags": [ + "issues" + ], + "operationId": "issues/unpin-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#unpin-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for an issue comment", + "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reaction" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for an issue comment", + "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete an issue comment reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-issue-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + }, + { + "$ref": "#/components/parameters/reaction-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/events": { + "get": { + "summary": "List issue events for a repository", + "description": "Lists events for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-events-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-event-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "summary": "Get an issue event", + "description": "Gets a single event by the event id.", + "tags": [ + "issues" + ], + "operationId": "issues/get-event", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#get-an-issue-event" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "event_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-event" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-event" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "summary": "Get an issue", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#get-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "summary": "Issue", + "value": { + "$ref": "#/components/examples/issue" + } + }, + "pinned_comment": { + "summary": "Issue with pinned comment", + "value": { + "$ref": "#/components/examples/issue-with-pinned-comment" + } + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + }, + "patch": { + "summary": "Update an issue", + "description": "Issue owners and users with push access or Triage role can edit an issue.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#update-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "The title of the issue.", + "nullable": true + }, + "body": { + "type": "string", + "description": "The contents of the issue.", + "nullable": true + }, + "assignee": { + "type": "string", + "nullable": true, + "description": "Username to assign to this issue. **This field is closing down.**" + }, + "state": { + "type": "string", + "description": "The open or closed state of the issue.", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "enum": [ + "completed", + "not_planned", + "duplicate", + "reopened" + ], + "nullable": true, + "description": "The reason for the state change. Ignored unless `state` is changed.", + "example": "not_planned" + }, + "milestone": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer", + "description": "The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped." + } + ], + "nullable": true + }, + "labels": { + "type": "array", + "description": "Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + } + } + ] + } + }, + "assignees": { + "type": "array", + "description": "Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.", + "items": { + "type": "string" + } + }, + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "The value to set for the field" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + } + }, + "type": { + "type": "string", + "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.", + "nullable": true, + "example": "Epic" + } + } + }, + "examples": { + "default": { + "value": { + "title": "Found a bug", + "body": "I'm having a problem with this.", + "assignees": [ + "octocat" + ], + "milestone": 1, + "state": "open", + "labels": [ + "bug" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "assignee": null + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "summary": "Add assignees to an issue", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", + "tags": [ + "issues" + ], + "operationId": "issues/add-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + }, + "delete": { + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-assignees", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "assignees": { + "type": "array", + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "assignees": [ + "hubot", + "other_user" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + "get": { + "summary": "Check if a user can be assigned to a issue", + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "tags": [ + "issues" + ], + "operationId": "issues/check-user-can-be-assigned-to-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "assignee", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if `assignee` can be assigned to `issue_number`" + }, + "404": { + "description": "Response if `assignee` can not be assigned to `issue_number`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "assignees" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "summary": "List issue comments", + "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#list-issue-comments" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + }, + "post": { + "summary": "Create an issue comment", + "description": "You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/create-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/comments#create-an-issue-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The contents of the comment." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Me too" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + "get": { + "summary": "List dependencies an issue is blocked by", + "description": "You can use the REST API to list the dependencies an issue is blocked by.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + }, + "post": { + "summary": "Add a dependency an issue is blocked by", + "description": "You can use the REST API to add a 'blocked by' relationship to an issue.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/add-blocked-by-dependency", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_id": { + "type": "integer", + "description": "The id of the issue that blocks the current issue" + } + }, + "required": [ + "issue_id" + ] + }, + "examples": { + "default": { + "value": { + "issue_id": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by", + "schema": { + "type": "string" + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + "delete": { + "summary": "Remove dependency an issue is blocked by", + "description": "You can use the REST API to remove a dependency that an issue is blocked by.\n\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\nand [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-dependency-blocked-by", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "issue_id", + "in": "path", + "description": "The id of the blocking issue to remove as a dependency", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + "get": { + "summary": "List dependencies an issue is blocking", + "description": "You can use the REST API to list the dependencies an issue is blocking.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-dependencies-blocking", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-dependencies" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + "get": { + "summary": "List issue events", + "description": "Lists all events for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/events#list-issue-events" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-event-for-issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-event-for-issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "events" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values": { + "get": { + "summary": "List issue field values for an issue", + "description": "Lists all issue field values for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-issue-field-values-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "summary": "List labels for an issue", + "description": "Lists all labels for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-on-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "post": { + "summary": "Add labels to an issue", + "description": "Adds labels to an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/add-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use \"[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue).\"", + "items": { + "type": "string" + } + } + } + }, + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "examples": { + "default": { + "value": { + "labels": [ + "bug", + "enhancement" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-items" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "put": { + "summary": "Set labels for an issue", + "description": "Removes any previous labels and sets the new labels for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/set-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "description": "The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see \"[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue).\"", + "items": { + "type": "string" + } + } + } + }, + { + "type": "array", + "minItems": 1, + "items": { + "type": "string" + } + }, + { + "type": "object", + "properties": { + "labels": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + }, + "required": [ + "name" + ] + } + }, + { + "type": "string" + } + ] + }, + "examples": { + "default": { + "value": { + "labels": [ + "bug", + "enhancement" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-items" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "delete": { + "summary": "Remove all labels from an issue", + "description": "Removes all labels from an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-all-labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + "delete": { + "summary": "Remove a label from an issue", + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-items-2" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + "put": { + "summary": "Lock an issue", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "issues" + ], + "operationId": "issues/lock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#lock-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "lock_reason": { + "type": "string", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", + "enum": [ + "off-topic", + "too heated", + "resolved", + "spam" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of locking an issue as off-topic", + "value": { + "lock_reason": "off-topic" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + }, + "delete": { + "summary": "Unlock an issue", + "description": "Users with push access can unlock an issue's conversation.", + "tags": [ + "issues" + ], + "operationId": "issues/unlock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#unlock-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + "get": { + "summary": "Get parent issue", + "description": "You can use the REST API to get the parent issue of a sub-issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/get-parent", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/sub-issues#get-parent-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "301": { + "$ref": "#/components/responses/moved_permanently" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "sub-issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + "get": { + "summary": "List reactions for an issue", + "description": "List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reaction" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for an issue", + "description": "Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete an issue reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/reaction-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + "delete": { + "summary": "Remove sub-issue", + "description": "You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/remove-sub-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/sub-issues#remove-sub-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The id of the sub-issue to remove" + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 6 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue", + "schema": { + "type": "string" + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "sub-issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + "get": { + "summary": "List sub-issues", + "description": "You can use the REST API to list the sub-issues on an issue.\n\nThis endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\n\n- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-sub-issues", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/sub-issues#list-sub-issues" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "sub-issues" + } + }, + "post": { + "summary": "Add sub-issue", + "description": "You can use the REST API to add sub-issues to issues.\n\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/add-sub-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/sub-issues#add-sub-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue" + }, + "replace_parent": { + "type": "boolean", + "description": "Option that, when true, instructs the operation to replace the sub-issues current parent issue" + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 1 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "410": { + "$ref": "#/components/responses/gone" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "sub-issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + "patch": { + "summary": "Reprioritize sub-issue", + "description": "You can use the REST API to reprioritize a sub-issue to a different position in the parent list.", + "tags": [ + "issues" + ], + "operationId": "issues/reprioritize-sub-issue", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sub_issue_id": { + "type": "integer", + "description": "The id of the sub-issue to reprioritize" + }, + "after_id": { + "type": "integer", + "description": "The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified)." + }, + "before_id": { + "type": "integer", + "description": "The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified)." + } + }, + "required": [ + "sub_issue_id" + ] + }, + "examples": { + "default": { + "value": { + "sub_issue_id": 6, + "after_id": 5 + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issue" + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "sub-issues" + } + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + "get": { + "summary": "List timeline events for an issue", + "description": "List all timeline events for an issue.", + "tags": [ + "issues" + ], + "operationId": "issues/list-events-for-timeline", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/timeline-issue-events" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/timeline-issue-events" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "410": { + "$ref": "#/components/responses/gone" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "timeline" + } + } + }, + "/repos/{owner}/{repo}/keys": { + "get": { + "summary": "List deploy keys", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/list-deploy-keys", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/deploy-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + } + }, + "post": { + "summary": "Create a deploy key", + "description": "You can create a read-only deploy key.", + "tags": [ + "repos" + ], + "operationId": "repos/create-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A name for the key." + }, + "key": { + "type": "string", + "description": "The contents of the key." + }, + "read_only": { + "type": "boolean", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"" + } + }, + "required": [ + "key" + ] + }, + "examples": { + "default": { + "value": { + "title": "octocat@octomac", + "key": "ssh-rsa AAA...", + "read_only": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deploy-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + } + } + }, + "/repos/{owner}/{repo}/keys/{key_id}": { + "get": { + "summary": "Get a deploy key", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/get-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deploy-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/deploy-key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + } + }, + "delete": { + "summary": "Delete a deploy key", + "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-deploy-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "deploy-keys", + "subcategory": "deploy-keys" + } + } + }, + "/repos/{owner}/{repo}/labels": { + "get": { + "summary": "List labels for a repository", + "description": "Lists all labels for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "post": { + "summary": "Create a label", + "description": "Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).", + "tags": [ + "issues" + ], + "operationId": "issues/create-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#create-a-label" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"" + }, + "color": { + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." + }, + "description": { + "type": "string", + "description": "A short description of the label. Must be 100 characters or fewer." + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "bug", + "description": "Something isn't working", + "color": "f29513" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/label" + }, + "examples": { + "default": { + "$ref": "#/components/examples/label" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/labels/{name}": { + "get": { + "summary": "Get a label", + "description": "Gets a label using the given name.", + "tags": [ + "issues" + ], + "operationId": "issues/get-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#get-a-label" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/label" + }, + "examples": { + "default": { + "$ref": "#/components/examples/label" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "patch": { + "summary": "Update a label", + "description": "Updates a label using the given label name.", + "tags": [ + "issues" + ], + "operationId": "issues/update-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#update-a-label" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_name": { + "type": "string", + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"" + }, + "color": { + "type": "string", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." + }, + "description": { + "type": "string", + "description": "A short description of the label. Must be 100 characters or fewer." + } + } + }, + "examples": { + "default": { + "value": { + "new_name": "bug :bug:", + "description": "Small bug fix required", + "color": "b01f26" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/label" + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + }, + "delete": { + "summary": "Delete a label", + "description": "Deletes a label using the given label name.", + "tags": [ + "issues" + ], + "operationId": "issues/delete-label", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#delete-a-label" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/languages": { + "get": { + "summary": "List repository languages", + "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", + "tags": [ + "repos" + ], + "operationId": "repos/list-languages", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repository-languages" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/language" + }, + "examples": { + "default": { + "$ref": "#/components/examples/language" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/license": { + "get": { + "summary": "Get the license for a repository", + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.\n- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "tags": [ + "licenses" + ], + "operationId": "licenses/get-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/git-ref" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/license-content" + }, + "examples": { + "default": { + "$ref": "#/components/examples/license-content" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "licenses", + "subcategory": "licenses" + } + } + }, + "/repos/{owner}/{repo}/merge-upstream": { + "post": { + "summary": "Sync a fork branch with the upstream repository", + "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", + "tags": [ + "repos" + ], + "operationId": "repos/merge-upstream", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "branch": { + "type": "string", + "description": "The name of the branch which should be updated to match upstream." + } + }, + "required": [ + "branch" + ] + }, + "examples": { + "default": { + "value": { + "branch": "main" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "The branch has been successfully synced with the upstream repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/merged-upstream" + }, + "examples": { + "default": { + "$ref": "#/components/examples/merged-upstream" + } + } + } + } + }, + "409": { + "description": "The branch could not be synced because of a merge conflict" + }, + "422": { + "description": "The branch could not be synced for some other reason" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branches" + } + } + }, + "/repos/{owner}/{repo}/merges": { + "post": { + "summary": "Merge a branch", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/merge", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/branches/branches#merge-a-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "base": { + "type": "string", + "description": "The name of the base branch that the head will be merged into." + }, + "head": { + "type": "string", + "description": "The head to merge. This can be a branch name or a commit SHA1." + }, + "commit_message": { + "type": "string", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used." + } + }, + "required": [ + "base", + "head" + ] + }, + "examples": { + "default": { + "value": { + "base": "master", + "head": "cool_feature", + "commit_message": "Shipped cool_feature!" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successful Response (The resulting merge commit)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/commit" + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit" + } + } + } + } + }, + "204": { + "description": "Response when already merged" + }, + "404": { + "description": "Not Found when the base or head does not exist" + }, + "409": { + "description": "Conflict when there is a merge conflict" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "branches", + "subcategory": "branches" + } + } + }, + "/repos/{owner}/{repo}/milestones": { + "get": { + "summary": "List milestones", + "description": "Lists milestones for a repository.", + "tags": [ + "issues" + ], + "operationId": "issues/list-milestones", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/milestones#list-milestones" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "due_on", + "completeness" + ], + "default": "due_on" + } + }, + { + "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/milestone" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/milestone-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "milestones" + } + }, + "post": { + "summary": "Create a milestone", + "description": "Creates a milestone.", + "tags": [ + "issues" + ], + "operationId": "issues/create-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/milestones#create-a-milestone" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the milestone." + }, + "state": { + "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "description": { + "type": "string", + "description": "A description of the milestone." + }, + "due_on": { + "type": "string", + "format": "date-time", + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "default": { + "value": { + "title": "v1.0", + "state": "open", + "description": "Tracking milestone for version 1.0", + "due_on": "2012-10-09T23:39:01Z" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/milestone" + }, + "examples": { + "default": { + "$ref": "#/components/examples/milestone" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "milestones" + } + } + }, + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + "get": { + "summary": "Get a milestone", + "description": "Gets a milestone using the given milestone number.", + "tags": [ + "issues" + ], + "operationId": "issues/get-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/milestones#get-a-milestone" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/milestone-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/milestone" + }, + "examples": { + "default": { + "$ref": "#/components/examples/milestone" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "milestones" + } + }, + "patch": { + "summary": "Update a milestone", + "description": "", + "tags": [ + "issues" + ], + "operationId": "issues/update-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/milestones#update-a-milestone" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/milestone-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the milestone." + }, + "state": { + "type": "string", + "description": "The state of the milestone. Either `open` or `closed`.", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "description": { + "type": "string", + "description": "A description of the milestone." + }, + "due_on": { + "type": "string", + "format": "date-time", + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`." + } + } + }, + "examples": { + "default": { + "value": { + "title": "v1.0", + "state": "open", + "description": "Tracking milestone for version 1.0", + "due_on": "2012-10-09T23:39:01Z" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/milestone" + }, + "examples": { + "default": { + "$ref": "#/components/examples/milestone" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "milestones" + } + }, + "delete": { + "summary": "Delete a milestone", + "description": "Deletes a milestone using the given milestone number.", + "tags": [ + "issues" + ], + "operationId": "issues/delete-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/milestones#delete-a-milestone" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/milestone-number" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "milestones" + } + } + }, + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + "get": { + "summary": "List labels for issues in a milestone", + "description": "Lists labels for issues in a milestone.", + "tags": [ + "issues" + ], + "operationId": "issues/list-labels-for-milestone", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/milestone-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "labels" + } + } + }, + "/repos/{owner}/{repo}/notifications": { + "get": { + "summary": "List repository notifications for the authenticated user", + "description": "Lists all notifications for the current user in the specified repository.", + "tags": [ + "activity" + ], + "operationId": "activity/list-repo-notifications-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/all" + }, + { + "$ref": "#/components/parameters/participating" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/before" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/thread" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/thread-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + }, + "put": { + "summary": "Mark repository notifications as read", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-repo-notifications-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "last_read_at": { + "type": "string", + "format": "date-time", + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp." + } + } + }, + "examples": { + "default": { + "value": { + "last_read_at": "2019-01-01T00:00:00Z" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background." + } + } + } + } + } + }, + "205": { + "description": "Reset Content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "notifications" + } + } + }, + "/repos/{owner}/{repo}/pages": { + "get": { + "summary": "Get a GitHub Pages site", + "description": "Gets information about a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pages", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + }, + "examples": { + "default": { + "$ref": "#/components/examples/page" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + }, + "post": { + "summary": "Create a GitHub Pages site", + "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-pages-site", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The source branch and directory used to publish your Pages site.", + "nullable": true, + "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, + "source": { + "type": "object", + "description": "The source branch and directory used to publish your Pages site.", + "properties": { + "branch": { + "type": "string", + "description": "The repository branch used to publish your site's source files." + }, + "path": { + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", + "enum": [ + "/", + "/docs" + ], + "default": "/" + } + }, + "required": [ + "branch" + ] + } + }, + "anyOf": [ + { + "required": [ + "source" + ] + }, + { + "required": [ + "build_type" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "source": { + "branch": "main", + "path": "/docs" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page" + }, + "examples": { + "default": { + "$ref": "#/components/examples/page" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + }, + "put": { + "summary": "Update information about a GitHub Pages site", + "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update-information-about-pages-site", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cname": { + "type": "string", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site).\"", + "nullable": true + }, + "https_enforced": { + "type": "boolean", + "description": "Specify whether HTTPS should be enforced for the repository." + }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, + "source": { + "anyOf": [ + { + "type": "string", + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", + "enum": [ + "gh-pages", + "master", + "master /docs" + ] + }, + { + "type": "object", + "description": "Update the source for the repository. Must include the branch name and path.", + "properties": { + "branch": { + "type": "string", + "description": "The repository branch used to publish your site's source files." + }, + "path": { + "type": "string", + "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.", + "enum": [ + "/", + "/docs" + ] + } + }, + "required": [ + "branch", + "path" + ] + } + ] + } + }, + "anyOf": [ + { + "required": [ + "build_type" + ] + }, + { + "required": [ + "source" + ] + }, + { + "required": [ + "cname" + ] + }, + { + "required": [ + "public" + ] + }, + { + "required": [ + "https_enforced" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "cname": "octocatblog.com", + "source": { + "branch": "main", + "path": "/" + } + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + }, + "delete": { + "summary": "Delete a GitHub Pages site", + "description": "Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-pages-site", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/builds": { + "get": { + "summary": "List GitHub Pages builds", + "description": "Lists builts of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/list-pages-builds", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#list-apiname-pages-builds" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/page-build" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/page-build-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + }, + "post": { + "summary": "Request a GitHub Pages build", + "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", + "tags": [ + "repos" + ], + "operationId": "repos/request-pages-build", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-build-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/page-build-status" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/builds/latest": { + "get": { + "summary": "Get latest Pages build", + "description": "Gets information about the single most recent build of a GitHub Pages site.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-latest-pages-build", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#get-latest-pages-build" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-build" + }, + "examples": { + "default": { + "$ref": "#/components/examples/page-build" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + "get": { + "summary": "Get GitHub Pages build", + "description": "Gets information about a GitHub Pages build.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pages-build", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#get-apiname-pages-build" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "build_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-build" + }, + "examples": { + "default": { + "$ref": "#/components/examples/page-build" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/deployments": { + "post": { + "summary": "Create a GitHub Pages deployment", + "description": "Create a GitHub Pages deployment for a repository.\n\nThe authenticated user must have write permission to the repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The object used to create GitHub Pages deployment", + "properties": { + "artifact_id": { + "type": "number", + "description": "The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required." + }, + "artifact_url": { + "type": "string", + "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required." + }, + "environment": { + "type": "string", + "description": "The target environment for this GitHub Pages deployment.", + "default": "github-pages" + }, + "pages_build_version": { + "type": "string", + "description": "A unique string that represents the version of the build for this deployment.", + "default": "GITHUB_SHA" + }, + "oidc_token": { + "type": "string", + "description": "The OIDC token issued by GitHub Actions certifying the origin of the deployment." + } + }, + "required": [ + "pages_build_version", + "oidc_token" + ] + }, + "examples": { + "default": { + "value": { + "artifact_url": "https://downloadcontent/", + "environment": "github-pages", + "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251", + "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/page-deployment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/page-deployment" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + "get": { + "summary": "Get the status of a GitHub Pages deployment", + "description": "Gets the current status of a GitHub Pages deployment.\n\nThe authenticated user must have read permission for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pages-deployment-status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pages-deployment-status" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + "post": { + "summary": "Cancel a GitHub Pages deployment", + "description": "Cancels a GitHub Pages deployment.\n\nThe authenticated user must have write permissions for the GitHub Pages site.", + "tags": [ + "repos" + ], + "operationId": "repos/cancel-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pages-deployment-id" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/pages/health": { + "get": { + "summary": "Get a DNS health check for GitHub Pages", + "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nThe authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-pages-health-check", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pages-health-check" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pages-health-check" + } + } + } + } + }, + "202": { + "description": "Empty response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "400": { + "description": "Custom domains are not available for GitHub Pages" + }, + "422": { + "description": "There isn't a CNAME for this page" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pages", + "subcategory": "pages" + } + } + }, + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + "get": { + "summary": "Check if private vulnerability reporting is enabled for a repository", + "description": "Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Private vulnerability reporting status", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable private vulnerability reporting for a repository", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "tags": [ + "repos" + ], + "operationId": "repos/enable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "422": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable private vulnerability reporting for a repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-private-vulnerability-reporting", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "422": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/properties/values": { + "get": { + "summary": "Get all custom property values for a repository", + "description": "Gets all custom property values that are set for a repository.\nUsers with read access to the repository can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/custom-properties-for-repos-get-repository-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "Create new or update existing custom property values for a repository.\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/custom-properties-for-repos-create-or-update-repository-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } + } + }, + "/repos/{owner}/{repo}/pulls": { + "get": { + "summary": "List pull requests", + "description": "Lists pull requests in a specified repository.\n\nDraft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)\nin the GitHub Help documentation.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#list-pull-requests" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "head", + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "base", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "popularity", + "long-running" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-simple-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "post": { + "summary": "Create a pull request", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/create", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#create-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the new pull request. Required unless `issue` is specified." + }, + "head": { + "type": "string", + "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`." + }, + "head_repo": { + "type": "string", + "description": "The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.", + "format": "repo.nwo", + "example": "octo-org/octo-repo" + }, + "base": { + "type": "string", + "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository." + }, + "body": { + "type": "string", + "description": "The contents of the pull request." + }, + "maintainer_can_modify": { + "type": "boolean", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + }, + "draft": { + "type": "boolean", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more." + }, + "issue": { + "type": "integer", + "format": "int64", + "example": 1, + "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified." + } + }, + "required": [ + "head", + "base" + ] + }, + "examples": { + "default": { + "value": { + "title": "Amazing new feature", + "body": "Please pull these awesome changes in!", + "head": "octocat:new-feature", + "base": "master" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/comments": { + "get": { + "summary": "List review comments in a repository", + "description": "Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-review-comments-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } + }, + { + "name": "direction", + "description": "The direction to sort results. Ignored without `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + "get": { + "summary": "Get a review comment for a pull request", + "description": "Provides details for a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-2" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments" + } + }, + "patch": { + "summary": "Update a review comment for a pull request", + "description": "Edits the content of a specified review comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/update-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The text of the reply to the review comment." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "I like this too!" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-2" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments" + } + }, + "delete": { + "summary": "Delete a review comment for a pull request", + "description": "Deletes a review comment.", + "tags": [ + "pulls" + ], + "operationId": "pulls/delete-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + "get": { + "summary": "List reactions for a pull request review comment", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-pull-request-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reaction" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for a pull request review comment", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-pull-request-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a pull request comment reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-pull-request-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/comment-id" + }, + { + "$ref": "#/components/parameters/reaction-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}": { + "get": { + "summary": "Get a pull request", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.\n- **`application/vnd.github.diff`**: For more information, see \"[git-diff](https://git-scm.com/docs/git-diff)\" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#get-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "200": { + "description": "Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "406": { + "$ref": "#/components/responses/unacceptable" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "patch": { + "summary": "Update a pull request", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the pull request." + }, + "body": { + "type": "string", + "description": "The contents of the pull request." + }, + "state": { + "type": "string", + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": [ + "open", + "closed" + ] + }, + "base": { + "type": "string", + "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository." + }, + "maintainer_can_modify": { + "type": "boolean", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request." + } + } + }, + "examples": { + "default": { + "value": { + "title": "new title", + "body": "updated body", + "state": "open", + "base": "master" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + "post": { + "summary": "Create a codespace from a pull request", + "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-with-pr-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "location": { + "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.", + "type": "string" + }, + "geo": { + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", + "type": "string", + "enum": [ + "EuropeWest", + "SoutheastAsia", + "UsEast", + "UsWest" + ] + }, + "client_ip": { + "description": "IP for location auto-detection when proxying a request", + "type": "string" + }, + "machine": { + "description": "Machine type to use for this codespace", + "type": "string" + }, + "devcontainer_path": { + "description": "Path to devcontainer.json config to use for this codespace", + "type": "string" + }, + "multi_repo_permissions_opt_out": { + "description": "Whether to authorize requested permissions from devcontainer.json", + "type": "boolean" + }, + "working_directory": { + "description": "Working directory for this codespace", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "Time in minutes before codespace stops from inactivity", + "type": "integer" + }, + "display_name": { + "description": "Display name for this codespace", + "type": "string" + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer" + } + } + }, + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when the codespace was successfully created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "202": { + "description": "Response when the codespace creation partially failed but is being retried in the background", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + "get": { + "summary": "List review comments on a pull request", + "description": "Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-review-comments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "name": "direction", + "description": "The direction to sort results. Ignored without `sort` parameter.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments" + } + }, + "post": { + "summary": "Create a review comment for a pull request", + "description": "Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment).\"\n\nIf your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.\n\nThe `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/create-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The text of the review comment." + }, + "commit_id": { + "type": "string", + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`." + }, + "path": { + "type": "string", + "description": "The relative path to the file that necessitates a comment." + }, + "position": { + "type": "integer", + "description": "**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "deprecated": true, + "x-github": { + "deprecationDate": "2022-11-01" + } + }, + "side": { + "type": "string", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "line": { + "type": "integer", + "description": "**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to." + }, + "start_line": { + "type": "integer", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation." + }, + "start_side": { + "type": "string", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "enum": [ + "LEFT", + "RIGHT", + "side" + ] + }, + "in_reply_to": { + "type": "integer", + "example": 2, + "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored." + }, + "subject_type": { + "type": "string", + "description": "The level at which the comment is targeted.", + "enum": [ + "line", + "file" + ] + } + }, + "required": [ + "body", + "commit_id", + "path" + ] + }, + "examples": { + "example-for-a-multi-line-comment": { + "summary": "Example for a multi-line comment", + "value": { + "body": "Great stuff!", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "path": "file1.txt", + "start_line": 1, + "start_side": "RIGHT", + "line": 2, + "side": "RIGHT" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "example-for-a-multi-line-comment": { + "$ref": "#/components/examples/pull-request-review-comment-example-for-a-multi-line-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + "post": { + "summary": "Create a reply for a review comment", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/create-reply-for-review-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/comment-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The text of the review comment." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "Great stuff!" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-comment" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-comment" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "pulls", + "subcategory": "comments" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + "get": { + "summary": "List commits on a pull request", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)\nendpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + "get": { + "summary": "List pull requests files", + "description": "Lists the files in a specified pull request.\n\n> [!NOTE]\n> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-files", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#list-pull-requests-files" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/diff-entry" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/diff-entry-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + "get": { + "summary": "Check if a pull request has been merged", + "description": "Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.", + "tags": [ + "pulls" + ], + "operationId": "pulls/check-if-merged", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "204": { + "description": "Response if pull request has been merged" + }, + "404": { + "description": "Not Found if pull request has not been merged" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + }, + "put": { + "summary": "Merge a pull request", + "description": "Merges a pull request into the base branch.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "pulls" + ], + "operationId": "pulls/merge", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "commit_title": { + "type": "string", + "description": "Title for the automatic commit message." + }, + "commit_message": { + "type": "string", + "description": "Extra detail to append to automatic commit message." + }, + "sha": { + "type": "string", + "description": "SHA that pull request head must match to allow merge." + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + } + }, + "examples": { + "response-if-merge-was-successful": { + "value": { + "commit_title": "Expand enum", + "commit_message": "Add a new value to the merge_method enum" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "if merge was successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-merge-result" + }, + "examples": { + "response-if-merge-was-successful": { + "$ref": "#/components/examples/pull-request-merge-result-response-if-merge-was-successful" + } + } + } + } + }, + "405": { + "description": "Method Not Allowed if merge cannot be performed", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-merge-cannot-be-performed": { + "value": { + "message": "Pull Request is not mergeable" + } + } + } + } + } + }, + "409": { + "description": "Conflict if sha was provided and pull request head did not match", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-sha-was-provided-and-pull-request-head-did-not-match": { + "value": { + "message": "Head branch was modified. Review and try the merge again." + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + "get": { + "summary": "Get all requested reviewers for a pull request", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-requested-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review-request" + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-pull-request-review-request" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "review-requests" + } + }, + "post": { + "summary": "Request reviewers for a pull request", + "description": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "pulls" + ], + "operationId": "pulls/request-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "An array of user `login`s that will be requested.", + "items": { + "type": "string" + } + }, + "team_reviewers": { + "type": "array", + "description": "An array of team `slug`s that will be requested.", + "items": { + "type": "string" + } + } + }, + "anyOf": [ + { + "required": [ + "reviewers" + ] + }, + { + "required": [ + "team_reviewers" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "reviewers": [ + "octocat", + "hubot", + "other_user" + ], + "team_reviewers": [ + "justice-league" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-request" + } + } + } + } + }, + "422": { + "description": "Unprocessable Entity if user is not a collaborator" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "review-requests" + } + }, + "delete": { + "summary": "Remove requested reviewers from a pull request", + "description": "Removes review requests from a pull request for a given set of users and/or teams.", + "tags": [ + "pulls" + ], + "operationId": "pulls/remove-requested-reviewers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "An array of user `login`s that will be removed.", + "items": { + "type": "string" + } + }, + "team_reviewers": { + "type": "array", + "description": "An array of team `slug`s that will be removed.", + "items": { + "type": "string" + } + } + }, + "required": [ + "reviewers" + ] + }, + "examples": { + "default": { + "value": { + "reviewers": [ + "octocat", + "hubot", + "other_user" + ], + "team_reviewers": [ + "justice-league" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-simple" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-simple" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "review-requests" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + "get": { + "summary": "List reviews for a pull request", + "description": "Lists all reviews for a specified pull request. The list of reviews returns in chronological order.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-reviews", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "The list of reviews returns in chronological order.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + }, + "post": { + "summary": "Create a review for a pull request", + "description": "Creates a review on a specified pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\n\n> [!NOTE]\n> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/create-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_id": { + "type": "string", + "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value." + }, + "body": { + "type": "string", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review." + }, + "event": { + "type": "string", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", + "enum": [ + "APPROVE", + "REQUEST_CHANGES", + "COMMENT" + ] + }, + "comments": { + "type": "array", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The relative path to the file that necessitates a review comment." + }, + "position": { + "type": "integer", + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file." + }, + "body": { + "type": "string", + "description": "Text of the review comment." + }, + "line": { + "type": "integer", + "example": 28 + }, + "side": { + "type": "string", + "example": "RIGHT" + }, + "start_line": { + "type": "integer", + "example": 26 + }, + "start_side": { + "type": "string", + "example": "LEFT" + } + }, + "required": [ + "path", + "body" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "body": "This is close to perfect! Please address the suggested inline change.", + "event": "REQUEST_CHANGES", + "comments": [ + { + "path": "file.md", + "position": 6, + "body": "Please add more information here, and fix this typo." + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + "get": { + "summary": "Get a review for a pull request", + "description": "Retrieves a pull request review by its ID.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/get-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/review-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-4" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + }, + "put": { + "summary": "Update a review for a pull request", + "description": "Updates the contents of a specified review summary comment.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/update-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/review-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The body text of the pull request review." + } + }, + "required": [ + "body" + ] + }, + "examples": { + "default": { + "value": { + "body": "This is close to perfect! Please address the suggested inline change. And add more about this." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-5" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + }, + "delete": { + "summary": "Delete a pending review for a pull request", + "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/delete-pending-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/review-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + "get": { + "summary": "List comments for a pull request review", + "description": "Lists comments for a specific pull request review.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/list-comments-for-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/review-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/review-comment" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/review-comment-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + "put": { + "summary": "Dismiss a review for a pull request", + "description": "Dismisses a specified review on a pull request.\n\n> [!NOTE]\n> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/dismiss-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/review-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "The message for the pull request review dismissal" + }, + "event": { + "type": "string", + "example": "\"DISMISS\"", + "enum": [ + "DISMISS" + ] + } + }, + "required": [ + "message" + ] + }, + "examples": { + "default": { + "value": { + "message": "You are dismissed", + "event": "DISMISS" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-3" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + "post": { + "summary": "Submit a review for a pull request", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "pulls" + ], + "operationId": "pulls/submit-review", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + }, + { + "$ref": "#/components/parameters/review-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The body text of the pull request review" + }, + "event": { + "type": "string", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", + "enum": [ + "APPROVE", + "REQUEST_CHANGES", + "COMMENT" + ] + } + }, + "required": [ + "event" + ] + }, + "examples": { + "default": { + "value": { + "body": "Here is the body for the review.", + "event": "REQUEST_CHANGES" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pull-request-review" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pull-request-review-4" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "pulls", + "subcategory": "reviews" + } + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + "put": { + "summary": "Update a pull request branch", + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.", + "tags": [ + "pulls" + ], + "operationId": "pulls/update-branch", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/pull-number" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "expected_head_sha": { + "type": "string", + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref." + } + } + }, + "examples": { + "default": { + "value": { + "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Updating pull request branch.", + "url": "https://github.com/repos/octocat/Hello-World/pulls/53" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "pulls", + "subcategory": "pulls" + } + } + }, + "/repos/{owner}/{repo}/readme": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README for a directory", + "description": "Gets the README from a repository directory.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.\n- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-in-directory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/releases": { + "get": { + "summary": "List releases", + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "tags": [ + "repos" + ], + "operationId": "repos/list-releases", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#list-releases" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/release" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/release-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + }, + "post": { + "summary": "Create a release", + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "repos" + ], + "operationId": "repos/create-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#create-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "type": "string", + "description": "The name of the tag." + }, + "target_commitish": { + "type": "string", + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch." + }, + "name": { + "type": "string", + "description": "The name of the release." + }, + "body": { + "type": "string", + "description": "Text describing the contents of the tag." + }, + "draft": { + "type": "boolean", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "default": false + }, + "prerelease": { + "type": "boolean", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "default": false + }, + "discussion_category_name": { + "type": "string", + "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" + }, + "generate_release_notes": { + "type": "boolean", + "description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", + "default": false + }, + "make_latest": { + "type": "string", + "description": "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.", + "enum": [ + "true", + "false", + "legacy" + ], + "default": "true" + } + }, + "required": [ + "tag_name" + ] + }, + "examples": { + "default": { + "value": { + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false, + "generate_release_notes": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/releases/1", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Not Found if the discussion category name is invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + } + }, + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + "get": { + "summary": "Get a release asset", + "description": "To download the asset's binary content:\n\n- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.\n- Alternatively, set the `Accept` header of the request to \n [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). \n The API will either redirect the client to the location, or stream it directly if possible.\n API clients should handle both a `200` or `302` response.", + "tags": [ + "repos" + ], + "operationId": "repos/get-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/assets#get-a-release-asset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/asset-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release-asset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release-asset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "302": { + "$ref": "#/components/responses/found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "assets" + } + }, + "patch": { + "summary": "Update a release asset", + "description": "Users with push access to the repository can edit a release asset.", + "tags": [ + "repos" + ], + "operationId": "repos/update-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/assets#update-a-release-asset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/asset-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The file name of the asset." + }, + "label": { + "type": "string", + "description": "An alternate short description of the asset. Used in place of the filename." + }, + "state": { + "type": "string", + "example": "\"uploaded\"" + } + } + }, + "examples": { + "default": { + "value": { + "name": "foo-1.0.0-osx.zip", + "label": "Mac binary" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release-asset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release-asset" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "assets" + } + }, + "delete": { + "summary": "Delete a release asset", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/delete-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/assets#delete-a-release-asset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/asset-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "assets" + } + } + }, + "/repos/{owner}/{repo}/releases/generate-notes": { + "post": { + "summary": "Generate release notes content for a release", + "description": "Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "tags": [ + "repos" + ], + "operationId": "repos/generate-release-notes", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "type": "string", + "description": "The tag name for the release. This can be an existing tag or a new one." + }, + "target_commitish": { + "type": "string", + "description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists." + }, + "previous_tag_name": { + "type": "string", + "description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release." + }, + "configuration_file_path": { + "type": "string", + "description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used." + } + }, + "required": [ + "tag_name" + ] + }, + "examples": { + "default": { + "value": { + "tag_name": "v1.0.0", + "target_commitish": "main", + "previous_tag_name": "v0.9.2", + "configuration_file_path": ".github/custom_release_config.yml" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Name and body of generated release notes", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release-notes-content" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release-notes-content" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + } + }, + "/repos/{owner}/{repo}/releases/latest": { + "get": { + "summary": "Get the latest release", + "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", + "tags": [ + "repos" + ], + "operationId": "repos/get-latest-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#get-the-latest-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + } + }, + "/repos/{owner}/{repo}/releases/tags/{tag}": { + "get": { + "summary": "Get a release by tag name", + "description": "Get a published release with the specified tag.", + "tags": [ + "repos" + ], + "operationId": "repos/get-release-by-tag", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "tag", + "description": "tag parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + } + }, + "/repos/{owner}/{repo}/releases/{release_id}": { + "get": { + "summary": "Get a release", + "description": "Gets a public release with the specified release ID.\n\n> [!NOTE]\n> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#get-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + } + ], + "responses": { + "200": { + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release" + } + } + } + } + }, + "401": { + "description": "Unauthorized" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + }, + "patch": { + "summary": "Update a release", + "description": "Users with push access to the repository can edit a release.", + "tags": [ + "repos" + ], + "operationId": "repos/update-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#update-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "type": "string", + "description": "The name of the tag." + }, + "target_commitish": { + "type": "string", + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch." + }, + "name": { + "type": "string", + "description": "The name of the release." + }, + "body": { + "type": "string", + "description": "Text describing the contents of the tag." + }, + "draft": { + "type": "boolean", + "description": "`true` makes the release a draft, and `false` publishes the release." + }, + "prerelease": { + "type": "boolean", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release." + }, + "make_latest": { + "type": "string", + "description": "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.", + "enum": [ + "true", + "false", + "legacy" + ], + "default": "true" + }, + "discussion_category_name": { + "type": "string", + "description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"" + } + } + }, + "examples": { + "default": { + "value": { + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release" + }, + "examples": { + "default": { + "$ref": "#/components/examples/release" + } + } + } + } + }, + "404": { + "description": "Not Found if the discussion category name is invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + }, + "delete": { + "summary": "Delete a release", + "description": "Users with push access to the repository can delete a release.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/releases#delete-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "releases" + } + } + }, + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + "get": { + "summary": "List release assets", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/list-release-assets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/assets#list-release-assets" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/release-asset" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/release-asset-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "assets" + } + }, + "post": { + "summary": "Upload a release asset", + "description": "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). \n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", + "tags": [ + "repos" + ], + "operationId": "repos/upload-release-asset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/releases/assets#upload-a-release-asset" + }, + "servers": [ + { + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + }, + { + "name": "name", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "label", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary", + "description": "The raw file data" + }, + "examples": { + "default": { + "value": "@example.zip" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for successful upload", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/release-asset" + }, + "examples": { + "response-for-successful-upload": { + "$ref": "#/components/examples/release-asset-response-for-successful-upload" + } + } + } + } + }, + "422": { + "description": "Response if you upload an asset with the same filename as another uploaded asset" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "releases", + "subcategory": "assets" + } + } + }, + "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + "get": { + "summary": "List reactions for a release", + "description": "List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "laugh", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reaction" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + }, + "post": { + "summary": "Create reaction for a release", + "description": "Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release.", + "enum": [ + "+1", + "laugh", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "examples": { + "default": { + "value": { + "content": "heart" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Reaction exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "201": { + "description": "Reaction created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reaction" + }, + "examples": { + "default": { + "$ref": "#/components/examples/reaction" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a release reaction", + "description": "> [!NOTE]\n> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-release", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/release-id" + }, + { + "$ref": "#/components/parameters/reaction-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "reactions", + "subcategory": "reactions" + } + } + }, + "/repos/{owner}/{repo}/rules/branches/{branch}": { + "get": { + "summary": "Get rules for a branch", + "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.", + "tags": [ + "repos" + ], + "operationId": "repos/get-branch-rules", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#get-rules-for-a-branch" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/branch" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule-detailed" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-rule-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + } + } + }, + "/repos/{owner}/{repo}/rulesets": { + "get": { + "summary": "Get all repository rulesets", + "description": "Get all the rulesets for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rulesets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#get-all-repository-rulesets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + }, + { + "$ref": "#/components/parameters/ruleset-targets" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + }, + "post": { + "summary": "Create a repository ruleset", + "description": "Create a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#create-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + } + }, + "/repos/{owner}/{repo}/rulesets/rule-suites": { + "get": { + "summary": "List repository rule suites", + "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rule-suites", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/actor-name-in-query" + }, + { + "$ref": "#/components/parameters/rule-suite-result" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suites" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + } + } + }, + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + "get": { + "summary": "Get a repository rule suite", + "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rule-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/rule-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + } + } + }, + "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get a repository ruleset", + "description": "Get a ruleset for a repository.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#get-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "includes_parents", + "description": "Include rulesets configured at higher levels that apply to this repository", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": true + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + }, + "put": { + "summary": "Update a repository ruleset", + "description": "Update a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/update-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#update-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "branch", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + }, + "delete": { + "summary": "Delete a repository ruleset", + "description": "Delete a ruleset for a repository.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-repo-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + } + } + }, + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + "get": { + "summary": "Get repository ruleset history", + "description": "Get the history of a repository ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-ruleset-history", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#get-repository-ruleset-history" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ruleset-version" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/ruleset-history" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + } + } + }, + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + "get": { + "summary": "Get repository ruleset version", + "description": "Get a version of a repository ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-ruleset-version", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rules#get-repository-ruleset-version" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "version_id", + "description": "The ID of the version", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ruleset-version-with-state" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-ruleset-version-with-state" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rules" + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts": { + "get": { + "summary": "List secret scanning alerts for a repository", + "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-state" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-exclude-secret-types" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-exclude-providers" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-providers" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-resolution" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-sort" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-validity" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-alert" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-list" + } + } + } + } + }, + "404": { + "description": "Repository is public or secret scanning is disabled for the repository" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a secret scanning alert", + "description": "Gets a single secret scanning alert detected in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + }, + { + "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-open" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + }, + "patch": { + "summary": "Update a secret scanning alert", + "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "operationId": "secret-scanning/update-alert", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolution_comment": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" + } + }, + "anyOf": [ + { + "required": [ + "state" + ] + }, + { + "required": [ + "assignee" + ] + }, + { + "required": [ + "validity" + ] + } + ] + }, + "examples": { + "default": { + "value": { + "state": "resolved", + "resolution": "false_positive" + } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-alert" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-resolved" + } + } + } + } + }, + "400": { + "description": "Bad request, resolution comment is invalid or the resolution was not changed." + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "422": { + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + "get": { + "summary": "List locations for a secret scanning alert", + "description": "Lists all locations for a given secret scanning alert for an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/list-locations-for-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/alert-number" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "List of locations where the secret was detected", + "items": { + "$ref": "#/components/schemas/secret-scanning-location" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-location-list" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + "post": { + "summary": "Create a push protection bypass", + "description": "Creates a bypass for a previously push protected secret.\n\nThe authenticated user must be the original author of the committed secret.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "operationId": "secret-scanning/create-push-protection-bypass", + "tags": [ + "secret-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + } + }, + "required": [ + "reason", + "placeholder_id" + ] + }, + "examples": { + "default": { + "value": { + "reason": "will_fix_later", + "placeholder_id": "2k4dM4tseyC5lPIsjl5emX9sPNk" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-push-protection-bypass" + } + } + } + } + }, + "403": { + "description": "User does not have enough permissions to perform this action." + }, + "404": { + "description": "Placeholder ID not found, or push protection is disabled on this repository." + }, + "422": { + "description": "Bad request, input data missing or incorrect." + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + } + }, + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + "get": { + "summary": "Get secret scanning scan history for a repository", + "description": "Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.\n\n> [!NOTE]\n> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.", + "tags": [ + "secret-scanning" + ], + "operationId": "secret-scanning/get-scan-history", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "404": { + "description": "Repository does not have GitHub Advanced Security or secret scanning enabled" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/secret-scanning-scan-history" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-scan-history" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "secret-scanning", + "subcategory": "secret-scanning" + } + } + }, + "/repos/{owner}/{repo}/security-advisories": { + "get": { + "summary": "List repository security advisories", + "description": "Lists security advisories in a repository.\n\nThe authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/list-repository-advisories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "published" + ], + "default": "created" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "name": "per_page", + "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + { + "name": "state", + "description": "Filter by state of the repository advisories. Only advisories of this state will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "triage", + "draft", + "published", + "closed" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-advisory" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-repository-advisories" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + }, + "post": { + "summary": "Create a repository security advisory", + "description": "Creates a new repository security advisory.\n\nIn order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/create-repository-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-advisory-create" + }, + "examples": { + "default": { + "value": { + "summary": "A new important advisory", + "description": "A more in-depth description of what the problem is.", + "severity": "high", + "cve_id": null, + "vulnerabilities": [ + { + "package": { + "name": "a-package", + "ecosystem": "npm" + }, + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", + "vulnerable_functions": [ + "important_function" + ] + } + ], + "cwe_ids": [ + "CWE-1101", + "CWE-20" + ], + "credits": [ + { + "login": "monalisa", + "type": "reporter" + }, + { + "login": "octocat", + "type": "analyst" + } + ] + } + }, + "withVectorString": { + "value": { + "summary": "A new important advisory", + "description": "A more in-depth description of what the problem is.", + "cvss_vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L", + "cve_id": null, + "vulnerabilities": [ + { + "package": { + "name": "a-package", + "ecosystem": "npm" + }, + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", + "vulnerable_functions": [ + "important_function" + ] + } + ], + "cwe_ids": [ + "CWE-1101", + "CWE-20" + ], + "credits": [ + { + "login": "monalisa", + "type": "reporter" + }, + { + "login": "octocat", + "type": "analyst" + } + ] + } + }, + "minimal": { + "value": { + "summary": "A new important advisory", + "description": "A more in-depth description of what the problem is.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm" + } + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-advisory" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + } + }, + "/repos/{owner}/{repo}/security-advisories/reports": { + "post": { + "summary": "Privately report a security vulnerability", + "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/create-private-vulnerability-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/private-vulnerability-report-create" + }, + "examples": { + "default": { + "value": { + "summary": "A newly discovered vulnerability", + "description": "A more in-depth description of what the problem is.", + "severity": "high", + "vulnerabilities": [ + { + "package": { + "name": "a-package", + "ecosystem": "npm" + }, + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", + "vulnerable_functions": [ + "important_function" + ] + } + ], + "cwe_ids": [ + "CWE-123" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-advisory-pvr" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + } + }, + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { + "get": { + "summary": "Get a repository security advisory", + "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nAnyone can access any published security advisory on a public repository.\n\nThe authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a\ncollaborator on the security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/get-repository-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-advisory" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + }, + "patch": { + "summary": "Update a repository security advisory", + "description": "Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\n\nIn order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,\nor a collaborator on the repository security advisory.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/update-repository-advisory", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-advisory-update" + }, + "examples": { + "default": { + "summary": "Updating the severity and state.", + "value": { + "severity": "critical", + "state": "published" + } + }, + "add_credit": { + "summary": "To add a credit to an advisory, send the whole array of values.", + "value": { + "credits": [ + { + "login": "monauser", + "type": "remediation_developer" + } + ] + } + }, + "update_vvrs": { + "summary": "To add vulnerable versions, include existing versions in the array.", + "value": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ] + }, + "invalid_state_transition": { + "summary": "Example of an invalid state transition, from `published` to `draft`.", + "value": { + "state": "draft" + } + }, + "update_severity_with_cvss_set": { + "summary": "Severity cannot be updated when the CVSS is already set.", + "value": { + "severity": "low" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-advisory" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-advisory" + }, + "add_credit": { + "$ref": "#/components/examples/repository-advisory" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/validation-error" + }, + "examples": { + "invalid_state_transition": { + "value": { + "message": "Invalid state transition from `published` to `draft`." + } + }, + "update_severity_with_cvss_set": { + "value": { + "message": "Cannot update severity value when CVSS is set." + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + } + }, + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + "post": { + "summary": "Request a CVE for a repository security advisory", + "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nIn order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/create-repository-advisory-cve-request", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + } + }, + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + "post": { + "summary": "Create a temporary private fork", + "description": "Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.\n\n> [!NOTE]\n> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.", + "tags": [ + "security-advisories" + ], + "operationId": "security-advisories/create-fork", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ghsa_id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/full-repository" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "security-advisories", + "subcategory": "repository-advisories" + } + } + }, + "/repos/{owner}/{repo}/stargazers": { + "get": { + "summary": "List stargazers", + "description": "Lists the people that have starred the repository.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "tags": [ + "activity" + ], + "operationId": "activity/list-stargazers-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#list-stargazers" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/stargazer" + } + } + ] + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/simple-user-items-default-response" + }, + "alternative-response-with-star-creation-timestamps": { + "$ref": "#/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "starring" + } + } + }, + "/repos/{owner}/{repo}/stats/code_frequency": { + "get": { + "summary": "Get the weekly commit activity", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n> [!NOTE]\n> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.", + "tags": [ + "repos" + ], + "operationId": "repos/get-code-frequency-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-frequency-stat" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-frequency-stat-items" + } + } + } + } + }, + "202": { + "$ref": "#/components/responses/accepted" + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "422": { + "description": "Repository contains more than 10,000 commits" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "statistics" + } + } + }, + "/repos/{owner}/{repo}/stats/commit_activity": { + "get": { + "summary": "Get the last year of commit activity", + "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", + "tags": [ + "repos" + ], + "operationId": "repos/get-commit-activity-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit-activity" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-activity-items" + } + } + } + } + }, + "202": { + "$ref": "#/components/responses/accepted" + }, + "204": { + "$ref": "#/components/responses/no_content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "statistics" + } + } + }, + "/repos/{owner}/{repo}/stats/contributors": { + "get": { + "summary": "Get all contributor commit activity", + "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n> [!NOTE]\n> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.", + "tags": [ + "repos" + ], + "operationId": "repos/get-contributors-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/contributor-activity" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/contributor-activity-items" + } + } + } + } + }, + "202": { + "$ref": "#/components/responses/accepted" + }, + "204": { + "$ref": "#/components/responses/no_content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "statistics" + } + } + }, + "/repos/{owner}/{repo}/stats/participation": { + "get": { + "summary": "Get the weekly commit count", + "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.\n\nThe most recent week is seven days ago at UTC midnight to today at UTC midnight.", + "tags": [ + "repos" + ], + "operationId": "repos/get-participation-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "The array order is oldest week (index 0) to most recent week.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/participation-stats" + }, + "examples": { + "default": { + "$ref": "#/components/examples/participation-stats" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "statistics" + } + } + }, + "/repos/{owner}/{repo}/stats/punch_card": { + "get": { + "summary": "Get the hourly commit count for each day", + "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "tags": [ + "repos" + ], + "operationId": "repos/get-punch-card-stats", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-frequency-stat" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-frequency-stat-items-2" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "statistics" + } + } + }, + "/repos/{owner}/{repo}/statuses/{sha}": { + "post": { + "summary": "Create a commit status", + "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", + "tags": [ + "repos" + ], + "operationId": "repos/create-commit-status", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/commits/statuses#create-a-commit-status" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "sha", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the status.", + "enum": [ + "error", + "failure", + "pending", + "success" + ] + }, + "target_url": { + "type": "string", + "nullable": true, + "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`" + }, + "description": { + "type": "string", + "nullable": true, + "description": "A short description of the status." + }, + "context": { + "type": "string", + "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", + "default": "default" + } + }, + "required": [ + "state" + ] + }, + "examples": { + "default": { + "value": { + "state": "success", + "target_url": "https://example.com/build/status", + "description": "The build succeeded!", + "context": "continuous-integration/jenkins" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/status" + }, + "examples": { + "default": { + "$ref": "#/components/examples/status" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "commits", + "subcategory": "statuses" + } + } + }, + "/repos/{owner}/{repo}/subscribers": { + "get": { + "summary": "List watchers", + "description": "Lists the people watching the specified repository.", + "tags": [ + "activity" + ], + "operationId": "activity/list-watchers-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#list-watchers" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/repos/{owner}/{repo}/subscription": { + "get": { + "summary": "Get a repository subscription", + "description": "Gets information about whether the authenticated user is subscribed to the repository.", + "tags": [ + "activity" + ], + "operationId": "activity/get-repo-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#get-a-repository-subscription" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "if you subscribe to the repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-subscription" + }, + "examples": { + "response-if-you-subscribe-to-the-repository": { + "$ref": "#/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository" + } + } + } + } + }, + "404": { + "description": "Not Found if you don't subscribe to the repository" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + }, + "put": { + "summary": "Set a repository subscription", + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.", + "tags": [ + "activity" + ], + "operationId": "activity/set-repo-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#set-a-repository-subscription" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subscribed": { + "type": "boolean", + "description": "Determines if notifications should be received from this repository." + }, + "ignored": { + "type": "boolean", + "description": "Determines if all notifications should be blocked from this repository." + } + } + }, + "examples": { + "default": { + "value": { + "subscribed": true, + "ignored": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-subscription" + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-subscription" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + }, + "delete": { + "summary": "Delete a repository subscription", + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).", + "tags": [ + "activity" + ], + "operationId": "activity/delete-repo-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#delete-a-repository-subscription" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/repos/{owner}/{repo}/tags": { + "get": { + "summary": "List repository tags", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/list-tags", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repository-tags" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tag" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/tag-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/tarball/{ref}": { + "get": { + "summary": "Download a repository archive (tar)", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes.", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar" + }, + "operationId": "repos/download-tarball-archive", + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "in": "path", + "required": true, + "x-multi-segment": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{owner}/{repo}/teams": { + "get": { + "summary": "List repository teams", + "description": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/list-teams", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repository-teams" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/topics": { + "get": { + "summary": "Get all repository topics", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#get-all-repository-topics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/topic" + }, + "examples": { + "default": { + "$ref": "#/components/examples/topic" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Replace all repository topics", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/replace-all-topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#replace-all-repository-topics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "names": { + "type": "array", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase.", + "items": { + "type": "string" + } + } + }, + "required": [ + "names" + ] + }, + "examples": { + "default": { + "value": { + "names": [ + "octocat", + "atom", + "electron", + "api" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/topic" + }, + "examples": { + "default": { + "$ref": "#/components/examples/topic" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed_simple" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/traffic/clones": { + "get": { + "summary": "Get repository clones", + "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "tags": [ + "repos" + ], + "operationId": "repos/get-clones", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/traffic#get-repository-clones" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/clone-traffic" + }, + "examples": { + "default": { + "$ref": "#/components/examples/clone-traffic" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "traffic" + } + } + }, + "/repos/{owner}/{repo}/traffic/popular/paths": { + "get": { + "summary": "Get top referral paths", + "description": "Get the top 10 popular contents over the last 14 days.", + "tags": [ + "repos" + ], + "operationId": "repos/get-top-paths", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/traffic#get-top-referral-paths" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/content-traffic" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-traffic-items" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "traffic" + } + } + }, + "/repos/{owner}/{repo}/traffic/popular/referrers": { + "get": { + "summary": "Get top referral sources", + "description": "Get the top 10 referrers over the last 14 days.", + "tags": [ + "repos" + ], + "operationId": "repos/get-top-referrers", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/traffic#get-top-referral-sources" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/referrer-traffic" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/referrer-traffic-items" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "traffic" + } + } + }, + "/repos/{owner}/{repo}/traffic/views": { + "get": { + "summary": "Get page views", + "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "tags": [ + "repos" + ], + "operationId": "repos/get-views", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/metrics/traffic#get-page-views" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/per" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/view-traffic" + }, + "examples": { + "default": { + "$ref": "#/components/examples/view-traffic" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "metrics", + "subcategory": "traffic" + } + } + }, + "/repos/{owner}/{repo}/transfer": { + "post": { + "summary": "Transfer a repository", + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).", + "tags": [ + "repos" + ], + "operationId": "repos/transfer", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#transfer-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_owner": { + "type": "string", + "description": "The username or organization name the repository will be transferred to." + }, + "new_name": { + "type": "string", + "description": "The new name to be given to the repository." + }, + "team_ids": { + "type": "array", + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "new_owner" + ] + }, + "examples": { + "default": { + "value": { + "new_owner": "github", + "team_ids": [ + 12, + 345 + ], + "new_name": "octorepo" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/minimal-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/vulnerability-alerts": { + "get": { + "summary": "Check if vulnerability alerts are enabled for a repository", + "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "tags": [ + "repos" + ], + "operationId": "repos/check-vulnerability-alerts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response if repository is enabled with vulnerability alerts" + }, + "404": { + "description": "Not Found if repository is not enabled with vulnerability alerts" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "put": { + "summary": "Enable vulnerability alerts", + "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "tags": [ + "repos" + ], + "operationId": "repos/enable-vulnerability-alerts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + }, + "delete": { + "summary": "Disable vulnerability alerts", + "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", + "tags": [ + "repos" + ], + "operationId": "repos/disable-vulnerability-alerts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repos/{owner}/{repo}/zipball/{ref}": { + "get": { + "summary": "Download a repository archive (zip)", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n> [!NOTE]\n> For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip" + }, + "operationId": "repos/download-zipball-archive", + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "in": "path", + "required": true, + "x-multi-segment": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Response", + "headers": { + "Location": { + "example": "https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "contents" + } + } + }, + "/repos/{template_owner}/{template_repo}/generate": { + "post": { + "summary": "Create a repository using a template", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-using-template", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template" + }, + "parameters": [ + { + "name": "template_owner", + "description": "The account owner of the template repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "template_repo", + "description": "The name of the template repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "owner": { + "type": "string", + "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization." + }, + "name": { + "type": "string", + "description": "The name of the new repository." + }, + "description": { + "type": "string", + "description": "A short description of the new repository." + }, + "include_all_branches": { + "type": "boolean", + "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", + "default": false + }, + "private": { + "type": "boolean", + "description": "Either `true` to create a new private repository or `false` to create a new public one.", + "default": false + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "owner": "octocat", + "name": "Hello-World", + "description": "This is your first repository", + "include_all_branches": false, + "private": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/full-repository" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repositories": { + "get": { + "summary": "List public repositories", + "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", + "tags": [ + "repos" + ], + "operationId": "repos/list-public", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-public-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/since-repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/public-repository-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": { + "post": { + "summary": "Add issue field values to an issue", + "description": "Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nOnly users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/add-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/repository-id" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to add to this issue. Each field value must include the field ID and the value to set.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Add multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Add a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after adding the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + }, + "put": { + "summary": "Set issue field values for an issue", + "description": "Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.\n\nThis endpoint supports the following field data types:\n- **`text`**: String values for text fields\n- **`single_select`**: Option names for single-select fields (must match an existing option name)\n- **`number`**: Numeric values for number fields\n- **`date`**: ISO 8601 date strings for date fields\n\nThis operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.\n\nOnly users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/set-issue-field-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/repository-id" + }, + { + "$ref": "#/components/parameters/issue-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue_field_values": { + "type": "array", + "description": "An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced.", + "items": { + "type": "object", + "properties": { + "field_id": { + "type": "integer", + "description": "The ID of the issue field to set", + "example": 123 + }, + "value": { + "oneOf": [ + { + "type": "string", + "description": "The value to set for text, single_select, or date fields" + }, + { + "type": "number", + "description": "The value to set for number fields" + } + ], + "description": "The value to set for the field. The type depends on the field's data type:\n- For text fields: provide a string value\n- For single_select fields: provide the option name as a string (must match an existing option)\n- For number fields: provide a numeric value\n- For date fields: provide an ISO 8601 date string", + "example": "Critical" + } + }, + "required": [ + "field_id", + "value" + ], + "additionalProperties": false + }, + "maxItems": 25 + } + } + }, + "examples": { + "default": { + "summary": "Set multiple field values", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "Critical" + }, + { + "field_id": 456, + "value": 5 + }, + { + "field_id": 789, + "value": "2024-12-31" + } + ] + } + }, + "single-field": { + "summary": "Set a single field value", + "value": { + "issue_field_values": [ + { + "field_id": 123, + "value": "High Priority" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "description": "The current issue field values for this issue after setting the new values", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-field-value-items" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": { + "delete": { + "summary": "Delete an issue field value from an issue", + "description": "Remove a specific custom field value from an issue.\n\nOnly users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.\n\nIf the specified field does not have a value set on the issue, this operation will return a `404` error.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\"\nand \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"", + "tags": [ + "issues" + ], + "operationId": "issues/delete-issue-field-value", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue" + }, + "parameters": [ + { + "$ref": "#/components/parameters/repository-id" + }, + { + "$ref": "#/components/parameters/issue-number" + }, + { + "$ref": "#/components/parameters/issue-field-id" + } + ], + "responses": { + "204": { + "description": "Issue field value deleted successfully" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "triggersNotification": true, + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "issues", + "subcategory": "issue-field-values" + } + } + }, + "/search/code": { + "get": { + "summary": "Search code", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen 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](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis 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\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "tags": [ + "search" + ], + "operationId": "search/code", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-code" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "deprecated": true, + "description": "**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "indexed" + ] + } + }, + { + "name": "order", + "description": "**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/code-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-search-result-item-paginated" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/commits": { + "get": { + "summary": "Search commits", + "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", + "tags": [ + "search" + ], + "operationId": "search/commits", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-commits" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "author-date", + "committer-date" + ] + } + }, + { + "$ref": "#/components/parameters/order" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/commit-search-result-item-paginated" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/issues": { + "get": { + "summary": "Search issues and pull requests", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n> [!NOTE]\n> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "tags": [ + "search" + ], + "operationId": "search/issues-and-pull-requests", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-issues-and-pull-requests" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ] + } + }, + { + "$ref": "#/components/parameters/order" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/issues-advanced-search" + }, + { + "$ref": "#/components/parameters/search-type" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items", + "search_type" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-search-result-item" + } + }, + "search_type": { + "type": "string", + "description": "The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`.", + "enum": [ + "lexical", + "semantic", + "hybrid" + ] + }, + "lexical_fallback_reason": { + "type": "array", + "description": "When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.", + "items": { + "type": "string", + "enum": [ + "no_text_terms", + "quoted_text", + "non_issue_target", + "or_boolean_not_supported", + "no_accessible_repos", + "server_error", + "only_non_semantic_fields_requested" + ] + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-search-result-item-paginated" + }, + "lexical-fallback": { + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" + } + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/labels": { + "get": { + "summary": "Search labels", + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/labels", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-labels" + }, + "parameters": [ + { + "name": "repository_id", + "description": "The id of the repository.", + "in": "query", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ] + } + }, + { + "$ref": "#/components/parameters/order" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/label-search-result-item-paginated" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/repositories": { + "get": { + "summary": "Search repositories", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-repositories" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "help-wanted-issues", + "updated" + ] + } + }, + { + "$ref": "#/components/parameters/order" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repo-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-search-result-item-paginated" + } + } + } + } + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/topics": { + "get": { + "summary": "Search topics", + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See \"[Searching topics](https://docs.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "tags": [ + "search" + ], + "operationId": "search/topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-topics" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/topic-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/topic-search-result-item-paginated" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/search/users": { + "get": { + "summary": "Search users", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", + "tags": [ + "search" + ], + "operationId": "search/users", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/search/search#search-users" + }, + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "followers", + "repositories", + "joined" + ] + } + }, + { + "$ref": "#/components/parameters/order" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "incomplete_results", + "items" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "incomplete_results": { + "type": "boolean" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/user-search-result-item" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-search-result-item-paginated" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "search", + "subcategory": "search" + } + } + }, + "/teams/{team_id}": { + "get": { + "summary": "Get a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/get-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#get-a-team-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + }, + "patch": { + "summary": "Update a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n> [!NOTE]\n> With nested teams, the `privacy` for parent teams cannot be `secret`.", + "tags": [ + "teams" + ], + "operationId": "teams/update-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#update-a-team-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "notification_setting": { + "type": "string", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: \n * `notifications_enabled` - team members receive notifications when the team is @mentioned. \n * `notifications_disabled` - no one receives notifications.", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "permission": { + "type": "string", + "description": "**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + }, + "required": [ + "name" + ] + }, + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed", + "notification_setting": "notifications_enabled" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response when the updated information already exists", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-full" + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + }, + "delete": { + "summary": "Delete a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#delete-a-team-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + } + }, + "/teams/{team_id}/invitations": { + "get": { + "summary": "List pending team invitations (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-pending-invitations-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-invitation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + } + }, + "/teams/{team_id}/members": { + "get": { + "summary": "List team members (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#list-team-members-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "name": "role", + "description": "Filters members returned by their role in the team.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + } + }, + "/teams/{team_id}/members/{username}": { + "get": { + "summary": "Get team member (Legacy)", + "description": "The \"Get team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/get-member-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-member-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "if user is a member" + }, + "404": { + "description": "if user is not a member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + }, + "put": { + "summary": "Add team member (Legacy)", + "description": "The \"Add team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "teams" + ], + "operationId": "teams/add-member-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-team-member-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Not Found if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove team member (Legacy)", + "description": "The \"Remove team member\" endpoint (described below) is closing down.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "tags": [ + "teams" + ], + "operationId": "teams/remove-member-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#remove-team-member-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "description": "Not Found if team synchronization is setup" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + } + }, + "/teams/{team_id}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-membership" + }, + "examples": { + "response-if-user-is-a-team-maintainer": { + "$ref": "#/components/examples/team-membership-response-if-user-is-a-team-maintainer" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + }, + "put": { + "summary": "Add or update team membership for a user (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + }, + "examples": { + "default": { + "summary": "Assign the member role for a user in a team", + "value": { + "role": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-membership" + }, + "examples": { + "response-if-users-membership-with-team-is-now-pending": { + "$ref": "#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending" + } + } + } + } + }, + "403": { + "description": "Forbidden if team synchronization is set up" + }, + "422": { + "description": "Unprocessable Entity if you attempt to add an organization to a team" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove team membership for a user (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n> [!NOTE]\n> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "description": "if team synchronization is set up" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "members" + }, + "deprecated": true + } + }, + "/teams/{team_id}/repos": { + "get": { + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/list-repos-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + } + }, + "/teams/{team_id}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.\n\n> [!NOTE]\n> Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:", + "tags": [ + "teams" + ], + "operationId": "teams/check-permissions-for-repo-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Alternative response with extra repository information", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/team-repository" + }, + "examples": { + "alternative-response-with-extra-repository-information": { + "$ref": "#/components/examples/team-repository-alternative-response-with-extra-repository-information" + } + } + } + } + }, + "204": { + "description": "Response if repository is managed by this team" + }, + "404": { + "description": "Not Found if repository is not managed by this team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + }, + "put": { + "summary": "Add or update team repository permissions (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-repo-permissions-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "enum": [ + "pull", + "push", + "admin" + ] + } + } + }, + "examples": { + "default": { + "summary": "Example of setting permission to pull", + "value": { + "permission": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + }, + "delete": { + "summary": "Remove a repository from a team (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-repo-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + } + }, + "/teams/{team_id}/teams": { + "get": { + "summary": "List child teams (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.", + "tags": [ + "teams" + ], + "operationId": "teams/list-child-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-child-teams-legacy" + }, + "parameters": [ + { + "$ref": "#/components/parameters/team-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "if child teams exist", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "examples": { + "response-if-child-teams-exist": { + "$ref": "#/components/examples/team-items-response-if-child-teams-exist" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "removalDate": "2021-02-01", + "deprecationDate": "2020-01-21", + "category": "teams", + "subcategory": "teams" + }, + "deprecated": true + } + }, + "/user": { + "get": { + "summary": "Get the authenticated user", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.", + "tags": [ + "users" + ], + "operationId": "users/get-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-the-authenticated-user" + }, + "parameters": [], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "response-with-public-and-private-profile-information": { + "$ref": "#/components/examples/private-user-response-with-public-and-private-profile-information" + }, + "response-with-public-profile-information": { + "$ref": "#/components/examples/private-user-response-with-public-profile-information" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "users" + } + }, + "patch": { + "summary": "Update the authenticated user", + "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", + "tags": [ + "users" + ], + "operationId": "users/update-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#update-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The new name of the user.", + "type": "string", + "example": "Omar Jahandar" + }, + "email": { + "description": "The publicly visible email address of the user.", + "type": "string", + "example": "omar@example.com" + }, + "blog": { + "description": "The new blog URL of the user.", + "type": "string", + "example": "blog.example.com" + }, + "twitter_username": { + "description": "The new Twitter username of the user.", + "type": "string", + "example": "therealomarj", + "nullable": true + }, + "company": { + "description": "The new company of the user.", + "type": "string", + "example": "Acme corporation" + }, + "location": { + "description": "The new location of the user.", + "type": "string", + "example": "Berlin, Germany" + }, + "hireable": { + "description": "The new hiring availability of the user.", + "type": "boolean" + }, + "bio": { + "description": "The new short biography of the user.", + "type": "string" + } + } + }, + "examples": { + "default": { + "summary": "Example of updating blog and name", + "value": { + "blog": "https://github.com/blog", + "name": "monalisa octocat" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/private-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/private-user" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "users" + } + } + }, + "/user/blocks": { + "get": { + "summary": "List users blocked by the authenticated user", + "description": "List the users you've blocked on your personal account.", + "tags": [ + "users" + ], + "operationId": "users/list-blocked-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "blocking" + } + } + }, + "/user/blocks/{username}": { + "get": { + "summary": "Check if a user is blocked by the authenticated user", + "description": "Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.", + "tags": [ + "users" + ], + "operationId": "users/check-blocked", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "If the user is blocked" + }, + "404": { + "description": "If the user is not blocked", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "blocking" + } + }, + "put": { + "summary": "Block a user", + "description": "Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.", + "tags": [ + "users" + ], + "operationId": "users/block", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/blocking#block-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "blocking" + } + }, + "delete": { + "summary": "Unblock a user", + "description": "Unblocks the given user and returns a 204.", + "tags": [ + "users" + ], + "operationId": "users/unblock", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/blocking#unblock-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "blocking" + } + } + }, + "/user/codespaces": { + "get": { + "summary": "List codespaces for the authenticated user", + "description": "Lists the authenticated user's codespaces.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/repository-id-in-query" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "codespaces" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "codespaces": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespace" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-list" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + }, + "post": { + "summary": "Create a codespace for the authenticated user", + "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user" + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "required": [ + "repository_id" + ], + "properties": { + "repository_id": { + "description": "Repository id for this codespace", + "type": "integer" + }, + "ref": { + "description": "Git ref (typically a branch name) for this codespace", + "type": "string" + }, + "location": { + "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.", + "type": "string" + }, + "geo": { + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", + "type": "string", + "enum": [ + "EuropeWest", + "SoutheastAsia", + "UsEast", + "UsWest" + ] + }, + "client_ip": { + "description": "IP for location auto-detection when proxying a request", + "type": "string" + }, + "machine": { + "description": "Machine type to use for this codespace", + "type": "string" + }, + "devcontainer_path": { + "description": "Path to devcontainer.json config to use for this codespace", + "type": "string" + }, + "multi_repo_permissions_opt_out": { + "description": "Whether to authorize requested permissions from devcontainer.json", + "type": "boolean" + }, + "working_directory": { + "description": "Working directory for this codespace", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "Time in minutes before codespace stops from inactivity", + "type": "integer" + }, + "display_name": { + "description": "Display name for this codespace", + "type": "string" + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer" + } + } + }, + { + "type": "object", + "required": [ + "pull_request" + ], + "properties": { + "pull_request": { + "required": [ + "pull_request_number", + "repository_id" + ], + "description": "Pull request number for this codespace", + "type": "object", + "properties": { + "pull_request_number": { + "description": "Pull request number", + "type": "integer" + }, + "repository_id": { + "description": "Repository id for this codespace", + "type": "integer" + } + } + }, + "location": { + "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.", + "type": "string" + }, + "geo": { + "description": "The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.", + "type": "string", + "enum": [ + "EuropeWest", + "SoutheastAsia", + "UsEast", + "UsWest" + ] + }, + "machine": { + "description": "Machine type to use for this codespace", + "type": "string" + }, + "devcontainer_path": { + "description": "Path to devcontainer.json config to use for this codespace", + "type": "string" + }, + "working_directory": { + "description": "Working directory for this codespace", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "Time in minutes before codespace stops from inactivity", + "type": "integer" + } + } + } + ] + }, + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main", + "geo": "UsWest" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response when the codespace was successfully created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "202": { + "description": "Response when the codespace creation partially failed but is being retried in the background", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/codespaces/secrets": { + "get": { + "summary": "List secrets for the authenticated user", + "description": "Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-secrets-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespaces-secret" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repo-codespaces-secret-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + } + }, + "/user/codespaces/secrets/public-key": { + "get": { + "summary": "Get public key for the authenticated user", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-public-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user" + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-user-public-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-user-public-key" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + } + }, + "/user/codespaces/secrets/{secret_name}": { + "get": { + "summary": "Get a secret for the authenticated user", + "description": "Gets a development environment secret available to a user's codespaces without revealing its encrypted value.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-secret" + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-codespaces-secret" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update a secret for the authenticated user", + "description": "Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/create-or-update-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "required": [ + "key_id" + ] + }, + "examples": { + "default": { + "value": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "selected_repository_ids": [ + "1234567", + "2345678" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response after successfully creating a secret", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response after successfully updating a secret" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete a secret for the authenticated user", + "description": "Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + } + }, + "/user/codespaces/secrets/{secret_name}/repositories": { + "get": { + "summary": "List selected repositories for a user secret", + "description": "List the repositories that have been granted the ability to use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/list-repositories-for-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-paginated" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for a user secret", + "description": "Select the repositories that will use a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/set-repositories-for-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", + "items": { + "type": "integer" + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "examples": { + "default": { + "value": { + "selected_repository_ids": [ + "1296269", + "1296280" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when repositories were added to the selected list" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + } + }, + "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add a selected repository to a user secret", + "description": "Adds a repository to the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/add-repository-for-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was added to the selected list" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove a selected repository from a user secret", + "description": "Removes a repository from the selected repositories for a user's development environment secret.\n\nThe authenticated user must have Codespaces access to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/remove-repository-for-secret-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret" + }, + "parameters": [ + { + "$ref": "#/components/parameters/secret-name" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content when repository was removed from the selected list" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "secrets" + } + } + }, + "/user/codespaces/{codespace_name}": { + "get": { + "summary": "Get a codespace for the authenticated user", + "description": "Gets information about a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + }, + "patch": { + "summary": "Update a codespace for the authenticated user", + "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/update-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "machine": { + "description": "A valid machine to transition this codespace to.", + "type": "string" + }, + "display_name": { + "description": "Display name for this codespace", + "type": "string" + }, + "recent_folders": { + "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "machine": "standardLinux" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + }, + "delete": { + "summary": "Delete a codespace for the authenticated user", + "description": "Deletes a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/delete-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "202": { + "$ref": "#/components/responses/accepted" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/codespaces/{codespace_name}/exports": { + "post": { + "summary": "Export a codespace for the authenticated user", + "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/export-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace-export-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-export-details" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/codespaces/{codespace_name}/exports/{export_id}": { + "get": { + "summary": "Get details about a codespace export", + "description": "Gets information about an export of a codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/get-export-details-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + }, + { + "$ref": "#/components/parameters/export-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace-export-details" + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-export-details" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/codespaces/{codespace_name}/machines": { + "get": { + "summary": "List machine types for a codespace", + "description": "List the machine types a codespace can transition to use.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/codespace-machines-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "machines" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "machines": { + "type": "array", + "items": { + "$ref": "#/components/schemas/codespace-machine" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace-machines-list" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "machines" + } + } + }, + "/user/codespaces/{codespace_name}/publish": { + "post": { + "summary": "Create a repository from an unpublished codespace", + "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/publish-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "A name for the new repository.", + "type": "string" + }, + "private": { + "description": "Whether the new repository should be private.", + "type": "boolean", + "default": false + } + } + }, + "examples": { + "default": { + "value": { + "repository": "monalisa-octocat-hello-world-g4wpq6h95q", + "private": false + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace-with-full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace-with-full-repository" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/codespaces/{codespace_name}/start": { + "post": { + "summary": "Start a codespace for the authenticated user", + "description": "Starts a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/start-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "402": { + "description": "Payment required", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/codespaces/{codespace_name}/stop": { + "post": { + "summary": "Stop a codespace for the authenticated user", + "description": "Stops a user's codespace.\n\nOAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/stop-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/codespace-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespace" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespace" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "codespaces", + "subcategory": "codespaces" + } + } + }, + "/user/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for authenticated-user", + "description": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user" + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/email/visibility": { + "patch": { + "summary": "Set primary email visibility for the authenticated user", + "description": "Sets the visibility for your primary email addresses.", + "tags": [ + "users" + ], + "operationId": "users/set-primary-email-visibility-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "visibility": { + "description": "Denotes whether an email is publicly visible.", + "type": "string", + "enum": [ + "public", + "private" + ] + } + }, + "required": [ + "visibility" + ], + "type": "object" + }, + "examples": { + "default": { + "summary": "Example setting the primary email address to private", + "value": { + "visibility": "private" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/email" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/email-items-3" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "emails" + } + } + }, + "/user/emails": { + "get": { + "summary": "List email addresses for the authenticated user", + "description": "Lists all of your email addresses, and specifies which one is visible\nto the public.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/list-emails-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/email" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/email-items-2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "emails" + } + }, + "post": { + "summary": "Add an email address for the authenticated user", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/add-email-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "emails": { + "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "type": "array", + "items": { + "type": "string", + "example": "username@example.com" + }, + "minItems": 1, + "example": [] + } + }, + "required": [ + "emails" + ], + "example": { + "emails": [ + "octocat@github.com", + "mona@github.com" + ] + } + }, + { + "type": "array", + "items": { + "type": "string", + "example": "username@example.com" + }, + "minItems": 1 + }, + { + "type": "string" + } + ] + }, + "examples": { + "default": { + "summary": "Example adding multiple email addresses", + "value": { + "emails": [ + "octocat@github.com", + "mona@github.com", + "octocat@octocat.org" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/email" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/email-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "emails" + } + }, + "delete": { + "summary": "Delete an email address for the authenticated user", + "description": "OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-email-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "description": "Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", + "properties": { + "emails": { + "description": "Email addresses associated with the GitHub user account.", + "type": "array", + "items": { + "type": "string", + "example": "username@example.com" + }, + "minItems": 1 + } + }, + "example": { + "emails": [ + "octocat@github.com", + "mona@github.com" + ] + }, + "required": [ + "emails" + ] + }, + { + "type": "array", + "items": { + "type": "string", + "example": "username@example.com" + }, + "minItems": 1 + }, + { + "type": "string" + } + ] + }, + "examples": { + "default": { + "summary": "Example deleting multiple email accounts", + "value": { + "emails": [ + "octocat@github.com", + "mona@github.com" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "emails" + } + } + }, + "/user/followers": { + "get": { + "summary": "List followers of the authenticated user", + "description": "Lists the people following the authenticated user.", + "tags": [ + "users" + ], + "operationId": "users/list-followers-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "followers" + } + } + }, + "/user/following": { + "get": { + "summary": "List the people the authenticated user follows", + "description": "Lists the people who the authenticated user follows.", + "tags": [ + "users" + ], + "operationId": "users/list-followed-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "followers" + } + } + }, + "/user/following/{username}": { + "get": { + "summary": "Check if a person is followed by the authenticated user", + "description": "", + "tags": [ + "users" + ], + "operationId": "users/check-person-is-followed-by-authenticated", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "if the person is followed by the authenticated user" + }, + "404": { + "description": "if the person is not followed by the authenticated user", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "followers" + } + }, + "put": { + "summary": "Follow a user", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"\n\nOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/follow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#follow-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "followers" + } + }, + "delete": { + "summary": "Unfollow a user", + "description": "OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/unfollow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#unfollow-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "followers" + } + } + }, + "/user/gpg_keys": { + "get": { + "summary": "List GPG keys for the authenticated user", + "description": "Lists the current user's GPG keys.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/list-gpg-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/gpg-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gpg-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "gpg-keys" + } + }, + "post": { + "summary": "Create a GPG key for the authenticated user", + "description": "Adds a GPG key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.", + "operationId": "users/create-gpg-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "A descriptive name for the new key.", + "type": "string" + }, + "armored_public_key": { + "description": "A GPG key in ASCII-armored format.", + "type": "string" + } + }, + "type": "object", + "required": [ + "armored_public_key" + ] + }, + "examples": { + "default": { + "value": { + "name": "Octocat's GPG Key", + "armored_public_key": "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v1\n\nmQINBFnZ2ZIBEADQ2Z7Z7\n-----END PGP PUBLIC KEY BLOCK-----" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gpg-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gpg-key" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "gpg-keys" + } + } + }, + "/user/gpg_keys/{gpg_key_id}": { + "get": { + "summary": "Get a GPG key for the authenticated user", + "description": "View extended details for a single GPG key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/get-gpg-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gpg-key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/gpg-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/gpg-key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "gpg-keys" + } + }, + "delete": { + "summary": "Delete a GPG key for the authenticated user", + "description": "Removes a GPG key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-gpg-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/gpg-key-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "gpg-keys" + } + } + }, + "/user/installations": { + "get": { + "summary": "List app installations accessible to the user access token", + "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", + "tags": [ + "apps" + ], + "operationId": "apps/list-installations-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "You can find the permissions for the installation under the `permissions` key.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "installations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "installations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/installation" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-installation-for-auth-user-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations" + } + } + }, + "/user/installations/{installation_id}/repositories": { + "get": { + "summary": "List repositories accessible to the user access token", + "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", + "tags": [ + "apps" + ], + "operationId": "apps/list-installation-repos-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "The access the user has to each repository is included in the hash under the `permissions` key.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "repository_selection": { + "type": "string" + }, + "repositories": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/repository" + } + ] + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-paginated" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations" + } + } + }, + "/user/installations/{installation_id}/repositories/{repository_id}": { + "put": { + "summary": "Add a repository to an app installation", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nThis endpoint only works for PATs (classic) with the `repo` scope.", + "tags": [ + "apps" + ], + "operationId": "apps/add-repo-to-installation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations" + } + }, + "delete": { + "summary": "Remove a repository from an app installation", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.\n\nThis endpoint only works for PATs (classic) with the `repo` scope.", + "tags": [ + "apps" + ], + "operationId": "apps/remove-repo-from-installation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/installation-id" + }, + { + "$ref": "#/components/parameters/repository-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization." + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "installations" + } + } + }, + "/user/interaction-limits": { + "get": { + "summary": "Get interaction restrictions for your public repositories", + "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.", + "tags": [ + "interactions" + ], + "operationId": "interactions/get-restrictions-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories" + }, + "responses": { + "200": { + "description": "Default response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "$ref": "#/components/schemas/interaction-limit-response" + }, + { + "type": "object", + "properties": {}, + "additionalProperties": false + } + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-response" + } + } + } + } + }, + "204": { + "description": "Response when there are no restrictions" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "interactions", + "subcategory": "user" + } + }, + "put": { + "summary": "Set interaction restrictions for your public repositories", + "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.", + "tags": [ + "interactions" + ], + "operationId": "interactions/set-restrictions-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories" + }, + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit" + }, + "examples": { + "default": { + "value": { + "limit": "collaborators_only", + "expiry": "one_month" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interaction-limit-response" + }, + "examples": { + "default": { + "$ref": "#/components/examples/interaction-limit-user" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "interactions", + "subcategory": "user" + } + }, + "delete": { + "summary": "Remove interaction restrictions from your public repositories", + "description": "Removes any interaction restrictions from your public repositories.", + "tags": [ + "interactions" + ], + "operationId": "interactions/remove-restrictions-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories" + }, + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "interactions", + "subcategory": "user" + } + } + }, + "/user/issues": { + "get": { + "summary": "List user account issues assigned to the authenticated user", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n> [!NOTE]\n> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)\" endpoint.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "filter", + "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "repos", + "all" + ], + "default": "assigned" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "$ref": "#/components/parameters/labels" + }, + { + "name": "sort", + "description": "What to sort results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/issue-with-repo-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "issues", + "subcategory": "issues" + } + } + }, + "/user/keys": { + "get": { + "summary": "List public SSH keys for the authenticated user", + "description": "Lists the public SSH keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/list-public-ssh-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "keys" + } + }, + "post": { + "summary": "Create a public SSH key for the authenticated user", + "description": "Adds a public SSH key to the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint.", + "operationId": "users/create-public-ssh-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "example": "Personal MacBook Air" + }, + "key": { + "description": "The public SSH key to add to your GitHub account.", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/key" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "keys" + } + } + }, + "/user/keys/{key_id}": { + "get": { + "summary": "Get a public SSH key for the authenticated user", + "description": "View extended details for a single public SSH key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/get-public-ssh-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "keys" + } + }, + "delete": { + "summary": "Delete a public SSH key for the authenticated user", + "description": "Removes a public SSH key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-public-ssh-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/key-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "keys" + } + } + }, + "/user/marketplace_purchases": { + "get": { + "summary": "List subscriptions for the authenticated user", + "description": "Lists the active subscriptions for the authenticated user.", + "tags": [ + "apps" + ], + "operationId": "apps/list-subscriptions-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/user-marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-marketplace-purchase-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/user/marketplace_purchases/stubbed": { + "get": { + "summary": "List subscriptions for the authenticated user (stubbed)", + "description": "Lists the active subscriptions for the authenticated user.", + "tags": [ + "apps" + ], + "operationId": "apps/list-subscriptions-for-authenticated-user-stubbed", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/user-marketplace-purchase" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-marketplace-purchase-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "marketplace" + } + } + }, + "/user/memberships/orgs": { + "get": { + "summary": "List organization memberships for the authenticated user", + "description": "Lists all of the authenticated user's organization memberships.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-memberships-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "state", + "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-membership" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-membership-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/user/memberships/orgs/{org}": { + "get": { + "summary": "Get an organization membership for the authenticated user", + "description": "If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-membership" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-membership" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + }, + "patch": { + "summary": "Update an organization membership for the authenticated user", + "description": "Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", + "enum": [ + "active" + ] + } + }, + "required": [ + "state" + ] + }, + "examples": { + "default": { + "value": { + "state": "active" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-membership" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-membership-2" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "members" + } + } + }, + "/user/migrations": { + "get": { + "summary": "List user migrations", + "description": "Lists all migrations a user has started.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#list-user-migrations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/migration" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + } + }, + "post": { + "summary": "Start a user migration", + "description": "Initiates the generation of a user migration archive.", + "tags": [ + "migrations" + ], + "operationId": "migrations/start-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#start-a-user-migration" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "lock_repositories": { + "description": "Lock the repositories being migrated at the start of the migration", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_metadata": { + "description": "Indicates whether metadata should be excluded and only git source should be included for the migration.", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_git_data": { + "description": "Indicates whether the repository git data should be excluded from the migration.", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_attachments": { + "description": "Do not include attachments in the migration", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_releases": { + "description": "Do not include releases in the migration", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "exclude_owner_projects": { + "description": "Indicates whether projects owned by the organization or users should be excluded.", + "example": true, + "readOnly": false, + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean", + "example": true, + "description": "Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).", + "default": false + }, + "exclude": { + "description": "Exclude attributes from the API response to improve performance", + "example": [ + "repositories" + ], + "readOnly": false, + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + }, + "repositories": { + "type": "array", + "items": { + "description": "Repository path, owner and name", + "example": "acme/widgets", + "type": "string" + } + } + }, + "required": [ + "repositories" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "repositories": [ + "octocat/Hello-World" + ], + "lock_repositories": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/migration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration-2" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + } + } + }, + "/user/migrations/{migration_id}": { + "get": { + "summary": "Get a user migration status", + "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-status-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#get-a-user-migration-status" + }, + "parameters": [ + { + "$ref": "#/components/parameters/migration-id" + }, + { + "name": "exclude", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/migration" + }, + "examples": { + "default": { + "$ref": "#/components/examples/migration" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + } + } + }, + "/user/migrations/{migration_id}/archive": { + "get": { + "summary": "Download a user migration archive", + "description": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.", + "tags": [ + "migrations" + ], + "operationId": "migrations/get-archive-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#download-a-user-migration-archive" + }, + "parameters": [ + { + "$ref": "#/components/parameters/migration-id" + } + ], + "responses": { + "302": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + } + }, + "delete": { + "summary": "Delete a user migration archive", + "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", + "tags": [ + "migrations" + ], + "operationId": "migrations/delete-archive-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive" + }, + "parameters": [ + { + "$ref": "#/components/parameters/migration-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + } + } + }, + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + "delete": { + "summary": "Unlock a user repository", + "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", + "tags": [ + "migrations" + ], + "operationId": "migrations/unlock-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#unlock-a-user-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/migration-id" + }, + { + "$ref": "#/components/parameters/repo-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + } + } + }, + "/user/migrations/{migration_id}/repositories": { + "get": { + "summary": "List repositories for a user migration", + "description": "Lists all the repositories for this user migration.", + "tags": [ + "migrations" + ], + "operationId": "migrations/list-repos-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration" + }, + "parameters": [ + { + "$ref": "#/components/parameters/migration-id" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "migrations", + "subcategory": "users" + }, + "x-github-breaking-changes": [ + { + "changeset": "restrict_repo_fields_in_migration_resource", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/simple-repository" + } + } + } + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "restrict_repo_fields_in_migration_resource", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "examples": null + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/user/orgs": { + "get": { + "summary": "List organizations for the authenticated user", + "description": "List organizations for the authenticated user.\n\nFor OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.\n\n> [!NOTE]\n> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/user/packages": { + "get": { + "summary": "List packages for the authenticated user's namespace", + "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/list-packages-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace" + }, + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "$ref": "#/components/parameters/package-visibility" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-user" + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/package_es_list_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/packages/{package_type}/{package_name}": { + "get": { + "summary": "Get a package for the authenticated user", + "description": "Gets a specific package for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-package-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/package" + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete a package for the authenticated user", + "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/packages/{package_type}/{package_name}/restore": { + "post": { + "summary": "Restore a package for the authenticated user", + "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/packages/{package_type}/{package_name}/versions": { + "get": { + "summary": "List package versions for a package owned by the authenticated user", + "description": "Lists package versions for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package-version" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-versions-for-authenticated-user" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + "get": { + "summary": "Get a package version for the authenticated user", + "description": "Gets a specific package version for a package owned by the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-package-version-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/package-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-version-authenticated-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete a package version for the authenticated user", + "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nThe authenticated user must have admin permissions in the organization to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-version-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + "post": { + "summary": "Restore a package version for the authenticated user", + "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-version-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/user/public_emails": { + "get": { + "summary": "List public email addresses for the authenticated user", + "description": "Lists your publicly visible email address, which you can set with the\n[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)\nendpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/list-public-emails-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/email" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/email-items-2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "emails" + } + } + }, + "/user/repos": { + "get": { + "summary": "List repositories for the authenticated user", + "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.", + "tags": [ + "repos" + ], + "operationId": "repos/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "visibility", + "description": "Limit results to repositories with the specified visibility.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private" + ], + "default": "all" + } + }, + { + "name": "affiliation", + "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "owner,collaborator,organization_member" + } + }, + { + "name": "type", + "description": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "owner", + "public", + "private", + "member" + ], + "default": "all" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "full_name" + } + }, + { + "name": "direction", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/since-repo-date" + }, + { + "$ref": "#/components/parameters/before-repo-date" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-items-default-response" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "repos", + "subcategory": "repos" + } + }, + "post": { + "summary": "Create a repository for the authenticated user", + "description": "Creates a new repository for the authenticated user.\n\nOAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.", + "tags": [ + "repos" + ], + "operationId": "repos/create-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "description": { + "description": "A short description of the repository.", + "type": "string" + }, + "homepage": { + "description": "A URL with more information about the repository.", + "type": "string" + }, + "private": { + "description": "Whether the repository is private.", + "default": false, + "type": "boolean" + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "team_id": { + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", + "type": "integer" + }, + "auto_init": { + "description": "Whether the repository is initialized with a minimal README.", + "default": false, + "type": "boolean" + }, + "gitignore_template": { + "description": "The desired language or platform to apply to the .gitignore.", + "example": "Haskell", + "type": "string" + }, + "license_template": { + "description": "The license keyword of the open source license for this repository.", + "example": "mit", + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "Required when using `squash_merge_commit_message`.\n\nThe default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "Required when using `merge_commit_message`.\n\nThe default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + } + }, + "required": [ + "name" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "name": "Hello-World", + "description": "This is your first repo!", + "homepage": "https://github.com", + "private": false, + "is_template": true + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/full-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/full-repository" + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "400": { + "$ref": "#/components/responses/bad_request" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "repos", + "subcategory": "repos" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_create_repo_trade_compliance_response_status", + "patch": { + "responses": { + "451": { + "$ref": "#/components/responses/validation_failed" + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/user/repository_invitations": { + "get": { + "summary": "List repository invitations for the authenticated user", + "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", + "tags": [ + "repos" + ], + "operationId": "repos/list-invitations-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-invitation" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/repository-invitation-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/user/repository_invitations/{invitation_id}": { + "patch": { + "summary": "Accept a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/accept-invitation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/invitation-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + }, + "x-github-breaking-changes": [ + { + "changeset": "change_accept_repository_invitation_response_status", + "patch": { + "responses": { + "451": { + "$ref": "#/components/responses/validation_failed" + } + } + }, + "version": "2026-03-10" + } + ] + }, + "delete": { + "summary": "Decline a repository invitation", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/decline-invitation-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation" + }, + "parameters": [ + { + "$ref": "#/components/parameters/invitation-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "409": { + "$ref": "#/components/responses/conflict" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "collaborators", + "subcategory": "invitations" + } + } + }, + "/user/social_accounts": { + "get": { + "summary": "List social accounts for the authenticated user", + "description": "Lists all of your social accounts.", + "tags": [ + "users" + ], + "operationId": "users/list-social-accounts-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/social-account" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/social-account-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "social-accounts" + } + }, + "post": { + "summary": "Add social accounts for the authenticated user", + "description": "Add one or more social accounts to the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/add-social-account-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_urls": { + "description": "Full URLs for the social media profiles to add.", + "type": "array", + "items": { + "type": "string", + "example": "https://twitter.com/github" + }, + "example": [] + } + }, + "required": [ + "account_urls" + ], + "example": { + "account_urls": [ + "https://www.linkedin.com/company/github/", + "https://twitter.com/github" + ] + } + }, + "examples": { + "default": { + "summary": "Adding multiple social accounts", + "value": { + "account_urls": [ + "https://facebook.com/GitHub", + "https://www.youtube.com/@GitHub" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/social-account" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/social-account-items" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "social-accounts" + } + }, + "delete": { + "summary": "Delete social accounts for the authenticated user", + "description": "Deletes one or more social accounts from the authenticated user's profile.\n\nOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-social-account-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "account_urls": { + "description": "Full URLs for the social media profiles to delete.", + "type": "array", + "items": { + "type": "string", + "example": "https://twitter.com/github" + }, + "example": [] + } + }, + "required": [ + "account_urls" + ], + "example": { + "account_urls": [ + "https://www.linkedin.com/company/github/", + "https://twitter.com/github" + ] + } + }, + "examples": { + "default": { + "summary": "Deleting multiple social accounts", + "value": { + "account_urls": [ + "https://facebook.com/GitHub", + "https://www.youtube.com/@GitHub" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "social-accounts" + } + } + }, + "/user/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for the authenticated user", + "description": "Lists the SSH signing keys for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ssh-signing-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "post": { + "summary": "Create a SSH signing key for the authenticated user", + "description": "Creates an SSH signing key for the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.", + "operationId": "users/create-ssh-signing-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "example": "Personal MacBook Air" + }, + "key": { + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "examples": { + "default": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ssh-signing-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + "get": { + "summary": "Get an SSH signing key for the authenticated user", + "description": "Gets extended details for an SSH signing key.\n\nOAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/get-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ssh-signing-key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ssh-signing-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "delete": { + "summary": "Delete an SSH signing key for the authenticated user", + "description": "Deletes an SSH signing key from the authenticated user's GitHub account.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/delete-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ssh-signing-key-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/starred": { + "get": { + "summary": "List repositories starred by the authenticated user", + "description": "Lists repositories the authenticated user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "tags": [ + "activity" + ], + "operationId": "activity/list-repos-starred-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/sort-starred" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/repository-items-default-response" + } + } + }, + "application/vnd.github.v3.star+json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/starred-repository" + } + }, + "examples": { + "alternative-response-with-star-creation-timestamps": { + "$ref": "#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + } + }, + "/user/starred/{owner}/{repo}": { + "get": { + "summary": "Check if a repository is starred by the authenticated user", + "description": "Whether the authenticated user has starred the repository.", + "tags": [ + "activity" + ], + "operationId": "activity/check-repo-is-starred-by-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response if this repository is starred by you" + }, + "404": { + "description": "Not Found if this repository is not starred by you", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + }, + "put": { + "summary": "Star a repository for the authenticated user", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", + "tags": [ + "activity" + ], + "operationId": "activity/star-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + }, + "delete": { + "summary": "Unstar a repository for the authenticated user", + "description": "Unstar a repository that the authenticated user has previously starred.", + "tags": [ + "activity" + ], + "operationId": "activity/unstar-repo-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "starring" + } + } + }, + "/user/subscriptions": { + "get": { + "summary": "List repositories watched by the authenticated user", + "description": "Lists repositories the authenticated user is watching.", + "tags": [ + "activity" + ], + "operationId": "activity/list-watched-repos-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/user/teams": { + "get": { + "summary": "List teams for the authenticated user", + "description": "List all of the teams across all of the organizations to which the authenticated\nuser belongs.\n\nOAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.\n\nWhen using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.", + "tags": [ + "teams" + ], + "operationId": "teams/list-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-full" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/team-full-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "teams", + "subcategory": "teams" + } + } + }, + "/user/{account_id}": { + "get": { + "summary": "Get a user using their ID", + "description": "Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user-using-their-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/account-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/user/{user_id}/projectsV2/{project_number}/drafts": { + "post": { + "summary": "Create draft item for user owned project", + "description": "Create draft issue item for the specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/create-draft-item-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/user-id" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "description": "Details of the draft item to create in the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the draft issue item to create in the project." + }, + "body": { + "type": "string", + "description": "The body content of the draft issue item to create in the project." + } + }, + "required": [ + "title" + ] + }, + "examples": { + "title": { + "summary": "Example with Sample Draft Issue Title", + "value": { + "title": "Sample Draft Issue Title" + } + }, + "body": { + "summary": "Example with Sample Draft Issue Title and Body", + "value": { + "title": "Sample Draft Issue Title", + "body": "This is the body content of the draft issue." + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-simple" + }, + "examples": { + "draft_issue": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "drafts" + } + } + }, + "/users": { + "get": { + "summary": "List users", + "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", + "tags": [ + "users" + ], + "operationId": "users/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#list-users" + }, + "parameters": [ + { + "$ref": "#/components/parameters/since-user" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{user_id}/projectsV2/{project_number}/views": { + "post": { + "summary": "Create a view for a user-owned project", + "description": "Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.", + "tags": [ + "projects" + ], + "operationId": "projects/create-view-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/user-id" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the view.", + "example": "Sprint Board" + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ], + "example": "board" + }, + "filter": { + "type": "string", + "description": "The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "example": "is:issue is:open" + }, + "visible_fields": { + "type": "array", + "description": "`visible_fields` is not applicable to `roadmap` layout views.\nFor `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.", + "items": { + "type": "integer" + }, + "example": [ + 123, + 456, + 789 + ] + } + }, + "required": [ + "name", + "layout" + ], + "additionalProperties": false + }, + "examples": { + "table_view": { + "summary": "Create a table view", + "value": { + "name": "All Issues", + "layout": "table", + "filter": "is:issue", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "board_view": { + "summary": "Create a board view with filter", + "value": { + "name": "Sprint Board", + "layout": "board", + "filter": "is:issue is:open label:sprint", + "visible_fields": [ + 123, + 456, + 789 + ] + } + }, + "roadmap_view": { + "summary": "Create a roadmap view", + "value": { + "name": "Product Roadmap", + "layout": "roadmap" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response for creating a view in a user-owned project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-view" + }, + "examples": { + "table_view": { + "summary": "Response for creating a table view", + "value": { + "$ref": "#/components/examples/projects-v2-view" + } + }, + "board_view": { + "summary": "Response for creating a board view with filter", + "value": { + "$ref": "#/components/examples/projects-v2-view" + } + }, + "roadmap_view": { + "summary": "Response for creating a roadmap view", + "value": { + "$ref": "#/components/examples/projects-v2-view" + } + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "projects", + "subcategory": "views" + } + } + }, + "/users/{username}": { + "get": { + "summary": "Get a user", + "description": "Provides publicly available information about someone with a GitHub account.\n\nIf you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).", + "tags": [ + "users" + ], + "operationId": "users/get-by-username", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/private-user" + }, + { + "$ref": "#/components/schemas/public-user" + } + ], + "discriminator": { + "propertyName": "user_view_type", + "mapping": { + "public": "#/components/schemas/public-user", + "private": "#/components/schemas/private-user" + } + } + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/public-user-default-response" + }, + "response-with-git-hub-plan-information": { + "$ref": "#/components/examples/public-user-response-with-git-hub-plan-information" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{username}/attestations/bulk-list": { + "post": { + "summary": "List attestations by bulk subject digests", + "description": "List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests to fetch attestations for.", + "minItems": 1, + "maxItems": 1024 + }, + "predicate_type": { + "type": "string", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types." + } + }, + "required": [ + "subject_digests" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/bulk-subject-digest-body" + }, + "withPredicateType": { + "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations_subject_digests": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The bundle of the attestation." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + } + } + } + }, + "description": "Mapping of subject digest to bundles." + }, + "page_info": { + "type": "object", + "properties": { + "has_next": { + "type": "boolean", + "description": "Indicates whether there is a next page." + }, + "has_previous": { + "type": "boolean", + "description": "Indicates whether there is a previous page." + }, + "next": { + "type": "string", + "description": "The cursor to the next page." + }, + "previous": { + "type": "string", + "description": "The cursor to the previous page." + } + }, + "description": "Information about the current page." + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations-bulk" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations_subject_digests": { + "additionalProperties": { + "items": { + "properties": { + "bundle": null + } + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/users/{username}/attestations/delete-request": { + "post": { + "summary": "Delete attestations in bulk", + "description": "Delete artifact attestations in bulk by either subject digests or unique ID.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-bulk", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "oneOf": [ + { + "properties": { + "subject_digests": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subject digests associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "subject_digests" + ] + }, + { + "properties": { + "attestation_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "List of unique IDs associated with the artifact attestations to delete.", + "minItems": 1, + "maxItems": 1024 + } + }, + "required": [ + "attestation_ids" + ] + } + ], + "description": "The request body must include either `subject_digests` or `attestation_ids`, but not both." + }, + "examples": { + "by-subject-digests": { + "summary": "Delete by subject digests", + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "by-attestation-ids": { + "summary": "Delete by attestation IDs", + "value": { + "attestation_ids": [ + 111, + 222 + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/digest/{subject_digest}": { + "delete": { + "summary": "Delete attestations by subject digest", + "description": "Delete an artifact attestation by subject digest.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-subject-digest", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{attestation_id}": { + "delete": { + "summary": "Delete attestations by ID", + "description": "Delete an artifact attestation by unique ID that is associated with a repository owned by a user.", + "tags": [ + "users" + ], + "operationId": "users/delete-attestations-by-id", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#delete-attestations-by-id" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "attestation_id", + "description": "Attestation ID", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response" + }, + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + } + } + }, + "/users/{username}/attestations/{subject_digest}": { + "get": { + "summary": "List attestations", + "description": "List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.\n\nThe collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.\n\n**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).", + "tags": [ + "users" + ], + "operationId": "users/list-attestations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/attestations#list-attestations" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "name": "subject_digest", + "description": "Subject Digest", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attestations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bundle": { + "type": "object", + "properties": { + "mediaType": { + "type": "string" + }, + "verificationMaterial": { + "type": "object", + "properties": {}, + "additionalProperties": true + }, + "dsseEnvelope": { + "type": "object", + "properties": {}, + "additionalProperties": true + } + }, + "description": "The attestation's Sigstore Bundle.\nRefer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information." + }, + "repository_id": { + "type": "integer" + }, + "bundle_url": { + "type": "string" + }, + "initiator": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestations" + } + } + } + } + }, + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "attestations" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_bundle", + "patch": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "attestations": { + "items": { + "properties": { + "bundle": null + } + } + } + } + } + } + } + } + } + }, + "version": "2026-03-10" + } + ] + } + }, + "/users/{username}/docker/conflicts": { + "get": { + "summary": "Get list of conflicting packages during Docker migration for user", + "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.", + "tags": [ + "packages" + ], + "operationId": "packages/list-docker-migration-conflicting-packages-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/events": { + "get": { + "summary": "List events for the authenticated user", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-events-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/users/{username}/events/orgs/{org}": { + "get": { + "summary": "List organization events for the authenticated user", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-org-events-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-org-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "activity", + "subcategory": "events" + } + } + }, + "/users/{username}/events/public": { + "get": { + "summary": "List public events for a user", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-events-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-public-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/users/{username}/followers": { + "get": { + "summary": "List followers of a user", + "description": "Lists the people following the specified user.", + "tags": [ + "users" + ], + "operationId": "users/list-followers-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#list-followers-of-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "followers" + } + } + }, + "/users/{username}/following": { + "get": { + "summary": "List the people a user follows", + "description": "Lists the people who the specified user follows.", + "tags": [ + "users" + ], + "operationId": "users/list-following-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#list-the-people-a-user-follows" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/simple-user-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "followers" + } + } + }, + "/users/{username}/following/{target_user}": { + "get": { + "summary": "Check if a user follows another user", + "description": "", + "tags": [ + "users" + ], + "operationId": "users/check-following-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "target_user", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "if the user follows the target user" + }, + "404": { + "description": "if the user does not follow the target user" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "followers" + } + } + }, + "/users/{username}/gists": { + "get": { + "summary": "List gists for a user", + "description": "Lists public gists for the specified user:", + "tags": [ + "gists" + ], + "operationId": "gists/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/gists/gists#list-gists-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/since" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/base-gist" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/base-gist-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "gists", + "subcategory": "gists" + } + } + }, + "/users/{username}/gpg_keys": { + "get": { + "summary": "List GPG keys for a user", + "description": "Lists the GPG keys for a user. This information is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-gpg-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/gpg-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/gpg-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "gpg-keys" + } + } + }, + "/users/{username}/hovercard": { + "get": { + "summary": "Get contextual information for a user", + "description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.", + "tags": [ + "users" + ], + "operationId": "users/get-context-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/users#get-contextual-information-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "subject_type", + "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "organization", + "repository", + "issue", + "pull_request" + ] + } + }, + { + "name": "subject_id", + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hovercard" + }, + "examples": { + "default": { + "$ref": "#/components/examples/hovercard" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "users" + } + } + }, + "/users/{username}/installation": { + "get": { + "summary": "Get a user installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-user-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/installation" + }, + "examples": { + "default": { + "$ref": "#/components/examples/installation" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "apps", + "subcategory": "apps" + } + } + }, + "/users/{username}/keys": { + "get": { + "summary": "List public keys for a user", + "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-public-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/keys#list-public-keys-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/key-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/key-simple-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "keys" + } + } + }, + "/users/{username}/orgs": { + "get": { + "summary": "List organizations for a user", + "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-simple" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-simple-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/users/{username}/packages": { + "get": { + "summary": "List packages for a user", + "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/list-packages-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#list-packages-for-a-user" + }, + "parameters": [ + { + "name": "package_type", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + { + "$ref": "#/components/parameters/package-visibility" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/packages-for-user" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "400": { + "$ref": "#/components/responses/package_es_list_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/packages/{package_type}/{package_name}": { + "get": { + "summary": "Get a package for a user", + "description": "Gets a specific package metadata for a public package owned by a user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-package-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-a-package-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/package" + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete a package for a user", + "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/packages/{package_type}/{package_name}/restore": { + "post": { + "summary": "Restore a package for a user", + "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/packages/{package_type}/{package_name}/versions": { + "get": { + "summary": "List package versions for a package owned by a user", + "description": "Lists package versions for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-all-package-versions-for-package-owned-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/package-version" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-versions-for-user" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + "get": { + "summary": "Get a package version for a user", + "description": "Gets a specific package version for a public package owned by a specified user.\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/get-package-version-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/package-version-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/package-version" + }, + "examples": { + "default": { + "$ref": "#/components/examples/package-version-user" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + }, + "delete": { + "summary": "Delete package version for a user", + "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/delete-package-version-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + "post": { + "summary": "Restore package version for a user", + "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nIf the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"\n\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", + "tags": [ + "packages" + ], + "operationId": "packages/restore-package-version-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/package-type" + }, + { + "$ref": "#/components/parameters/package-name" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/package-version-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "packages", + "subcategory": "packages" + } + } + }, + "/users/{username}/projectsV2": { + "get": { + "summary": "List projects for user", + "description": "List all projects owned by a specific user accessible by the authenticated user.", + "tags": [ + "projects" + ], + "operationId": "projects/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#list-projects-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "q", + "description": "Limit results to projects of the specified type.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}": { + "get": { + "summary": "Get project for user", + "description": "Get a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields": { + "get": { + "summary": "List project fields for user", + "description": "List all fields for a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/list-fields-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/field-id" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-field" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/items": { + "get": { + "summary": "List items for a user owned project", + "description": "List all items for a specific user-owned project accessible by the authenticated user.", + "tags": [ + "projects" + ], + "operationId": "projects/list-items-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "q", + "description": "Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "post": { + "summary": "Add item to user owned project", + "description": "Add an issue or pull request item to the specified user owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-item-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#add-item-to-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "description": "Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number.", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The unique identifier of the issue or pull request to add to the project." + }, + "owner": { + "type": "string", + "description": "The repository owner login." + }, + "repo": { + "type": "string", + "description": "The repository name." + }, + "number": { + "type": "integer", + "description": "The issue or pull request number." + } + }, + "required": [ + "type" + ], + "oneOf": [ + { + "required": [ + "id" + ] + }, + { + "required": [ + "owner", + "repo", + "number" + ] + } + ] + }, + "examples": { + "issue_with_id": { + "summary": "Add an issue using its unique ID", + "value": { + "type": "Issue", + "id": 3 + } + }, + "pull_request_with_id": { + "summary": "Add a pull request using its unique ID", + "value": { + "type": "PullRequest", + "id": 3 + } + }, + "issue_with_nwo": { + "summary": "Add an issue using repository owner, name, and issue number", + "value": { + "type": "Issue", + "owner": "octocat", + "repo": "hello-world", + "number": 42 + } + }, + "pull_request_with_nwo": { + "summary": "Add a pull request using repository owner, name, and PR number", + "value": { + "type": "PullRequest", + "owner": "octocat", + "repo": "hello-world", + "number": 123 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-simple" + }, + "examples": { + "issue_with_id": { + "summary": "Response for adding an issue using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_id": { + "summary": "Response for adding a pull request using its unique ID", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "issue_with_nwo": { + "summary": "Response for adding an issue using repository owner, name, and issue number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + }, + "pull_request_with_nwo": { + "summary": "Response for adding a pull request using repository owner, name, and PR number", + "value": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + "get": { + "summary": "Get an item for a user owned project", + "description": "Get a specific item from a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-user-item", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/item-id" + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "patch": { + "summary": "Update project item for user", + "description": "Update a specific item in a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/update-item-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#update-project-item-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/item-id" + } + ], + "requestBody": { + "required": true, + "description": "Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "description": "A list of field updates to apply.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the project field to update." + }, + "value": { + "description": "The new value for the field:\n- For text, number, and date fields, provide the new value directly.\n- For single select and iteration fields, provide the ID of the option or iteration.\n- To clear the field, set this to null.", + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + } + }, + "required": [ + "id", + "value" + ] + } + } + }, + "required": [ + "fields" + ] + }, + "examples": { + "text_field": { + "summary": "Update a text field", + "value": { + "fields": [ + { + "id": 123, + "value": "Updated text value" + } + ] + } + }, + "number_field": { + "summary": "Update a number field", + "value": { + "fields": [ + { + "id": 456, + "value": 42.5 + } + ] + } + }, + "date_field": { + "summary": "Update a date field", + "value": { + "fields": [ + { + "id": 789, + "value": "2023-10-05" + } + ] + } + }, + "single_select_field": { + "summary": "Update a single select field", + "value": { + "fields": [ + { + "id": 789, + "value": "47fc9ee4" + } + ] + } + }, + "iteration_field": { + "summary": "Update an iteration field", + "value": { + "fields": [ + { + "id": 1011, + "value": "866ee5b8" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + }, + "examples": { + "text_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "delete": { + "summary": "Delete project item for user", + "description": "Delete a specific item from a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/delete-item-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#delete-project-item-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/item-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + "get": { + "summary": "List items for a user project view", + "description": "List items in a user project with the saved view's filter applied.", + "tags": [ + "projects" + ], + "operationId": "projects/list-view-items-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/view-number" + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the\ntitle field will be returned.\n\nExample: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "projects", + "subcategory": "items" + } + } + }, + "/users/{username}/received_events": { + "get": { + "summary": "List events received by the authenticated user", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-received-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-received-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/users/{username}/received_events/public": { + "get": { + "summary": "List public events received by a user", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", + "tags": [ + "activity" + ], + "operationId": "activity/list-received-public-events-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/event" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/user-received-public-events-items" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "events" + } + } + }, + "/users/{username}/repos": { + "get": { + "summary": "List repositories for a user", + "description": "Lists public repositories for the specified user.", + "tags": [ + "repos" + ], + "operationId": "repos/list-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/repos#list-repositories-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "name": "type", + "description": "Limit results to repositories of the specified type.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "owner", + "member" + ], + "default": "owner" + } + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "full_name" + } + }, + { + "name": "direction", + "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + } + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } + } + }, + "/users/{username}/settings/billing/premium_request/usage": { + "get": { + "summary": "Get billing premium request usage report for a user", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-premium-request-usage-report-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month-default" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-model" + }, + { + "$ref": "#/components/parameters/billing-usage-report-product" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_premium_request_usage_report_user" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "usage" + } + } + }, + "/users/{username}/settings/billing/usage": { + "get": { + "summary": "Get billing usage report for a user", + "description": "Gets a report of the total usage for a user.\n\n**Note:** This endpoint is only available to users with access to the enhanced billing platform.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-report-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_report_user" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "usage" + } + } + }, + "/users/{username}/settings/billing/usage/summary": { + "get": { + "summary": "Get billing usage summary for a user", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a summary report of usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", + "tags": [ + "billing" + ], + "operationId": "billing/get-github-billing-usage-summary-report-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/billing-usage-report-year" + }, + { + "$ref": "#/components/parameters/billing-usage-report-month-default" + }, + { + "$ref": "#/components/parameters/billing-usage-report-day" + }, + { + "$ref": "#/components/parameters/billing-usage-report-repository" + }, + { + "$ref": "#/components/parameters/billing-usage-report-product" + }, + { + "$ref": "#/components/parameters/billing-usage-report-sku" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/billing_usage_summary_report_user" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "billing", + "subcategory": "usage" + } + } + }, + "/users/{username}/social_accounts": { + "get": { + "summary": "List social accounts for a user", + "description": "Lists social media accounts for a user. This endpoint is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-social-accounts-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/social-account" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/social-account-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "social-accounts" + } + } + }, + "/users/{username}/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for a user", + "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ssh-signing-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/users/{username}/starred": { + "get": { + "summary": "List repositories starred by a user", + "description": "Lists repositories a user has starred.\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.", + "tags": [ + "activity" + ], + "operationId": "activity/list-repos-starred-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/sort-starred" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "anyOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/starred-repository" + } + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + } + ] + }, + "examples": { + "default-response": { + "$ref": "#/components/examples/repository-items-default-response" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "starring" + } + } + }, + "/users/{username}/subscriptions": { + "get": { + "summary": "List repositories watched by a user", + "description": "Lists repositories a user is watching.", + "tags": [ + "activity" + ], + "operationId": "activity/list-repos-watched-by-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/minimal-repository" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/minimal-repository-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "activity", + "subcategory": "watching" + } + } + }, + "/versions": { + "get": { + "summary": "Get all API versions", + "description": "Get all supported GitHub API versions.", + "tags": [ + "meta" + ], + "operationId": "meta/get-all-versions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta/meta#get-all-api-versions" + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "format": "date", + "example": "2021-01-01" + } + }, + "examples": { + "default": { + "value": [ + "2021-01-01", + "2021-06-01", + "2022-01-01" + ] + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "meta", + "subcategory": "meta" + } + } + }, + "/zen": { + "get": { + "summary": "Get the Zen of GitHub", + "description": "Get a random sentence from the Zen of GitHub", + "tags": [ + "meta" + ], + "operationId": "meta/get-zen", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/meta/meta#get-the-zen-of-github" + }, + "responses": { + "200": { + "description": "Response", + "content": { + "text/plain": { + "schema": { + "type": "string" + }, + "examples": { + "default": { + "summary": "Example response", + "value": "Responsive is better than fast" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "meta", + "subcategory": "meta" + } + } + } + }, + "x-webhooks": { + "branch-protection-configuration-disabled": { + "post": { + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "All branch protections were disabled for a repository.", + "operationId": "branch-protection-configuration/disabled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "branch_protection_configuration", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-configuration-disabled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-configuration-enabled": { + "post": { + "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "All branch protections were enabled for a repository.", + "operationId": "branch-protection-configuration/enabled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "branch_protection_configuration", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-configuration-enabled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_configuration", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-created": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was created.", + "operationId": "branch-protection-rule/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "branch_protection_rule", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-rule-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was deleted.", + "operationId": "branch-protection-rule/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "branch_protection_rule", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-rule-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "branch-protection-rule-edited": { + "post": { + "summary": "This event occurs when there is activity relating to branch protection rules. For more information, see \"[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "description": "A branch protection rule was edited.", + "operationId": "branch-protection-rule/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "branch_protection_rule", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-branch-protection-rule-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "branch_protection_rule", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run was completed, and a conclusion is available.", + "operationId": "check-run/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-completed-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-completed-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-created": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A new check run was created.", + "operationId": "check-run/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-created-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-requested-action": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see \"[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", + "operationId": "check-run/requested-action", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-requested-action-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-requested-action-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-run-rerequested": { + "post": { + "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.", + "operationId": "check-run/rerequested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-check-run-rerequested-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/check-run-rerequested-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "check_run", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "All check runs in a check suite have completed, and a conclusion is available.", + "operationId": "check-suite/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_suite", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-suite-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check_suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", + "operationId": "check-suite/requested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_suite", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-suite-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check_suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "check-suite-rerequested": { + "post": { + "summary": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", + "description": "Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", + "operationId": "check-suite/rerequested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "check_suite", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-check-suite-rerequested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "check_suite", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-appeared-in-branch": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.", + "operationId": "code-scanning-alert/appeared-in-branch", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-closed-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone closed a code scanning alert.", + "operationId": "code-scanning-alert/closed-by-user", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-created": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was created in a repository.", + "operationId": "code-scanning-alert/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-fixed": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A code scanning alert was fixed in a branch by a commit.", + "operationId": "code-scanning-alert/fixed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "A previously fixed code scanning alert reappeared in a branch.", + "operationId": "code-scanning-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-reopened-by-user": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "Someone reopened a code scanning alert.", + "operationId": "code-scanning-alert/reopened-by-user", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "code-scanning-alert-updated-assignment": { + "post": { + "summary": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)\" and \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts).\" For information about the API to manage code scanning, see \"[Code scanning](https://docs.github.com/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", + "description": "The assignees list of a code scanning alert has been updated.", + "operationId": "code-scanning-alert/updated-assignment", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "code_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "code_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "commit-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).\" For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/rest/commits/comments)\" in the REST API documentation.\n\nFor activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "Someone commented on a commit.", + "operationId": "commit-comment/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "commit_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-commit-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "commit_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "create": { + "post": { + "summary": "This event occurs when a Git branch or tag is created.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.", + "operationId": "create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#create" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "create", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-create" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "create", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "custom-property-created": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A new custom property was created.", + "operationId": "custom-property/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "custom_property", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, + "custom-property-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was deleted.", + "operationId": "custom-property/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "custom_property", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "custom_property", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, + "custom-property-updated": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was updated.", + "operationId": "custom-property/updated", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "custom_property", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, + "custom-property-values-updated": { + "post": { + "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "The custom property values of a repository were updated.", + "operationId": "custom-property-values/updated", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "custom_property_values", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-values-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom-property-values", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "delete": { + "post": { + "summary": "This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", + "operationId": "delete", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#delete" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "delete", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-delete" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "delete", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-assignees-changed": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "The assignees for a Dependabot alert were updated.", + "operationId": "dependabot-alert/assignees-changed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-assignees-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-auto-dismissed": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", + "operationId": "dependabot-alert/auto-dismissed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-auto-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", + "operationId": "dependabot-alert/auto-reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-created": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.", + "operationId": "dependabot-alert/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-dismissed": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A Dependabot alert was manually closed.", + "operationId": "dependabot-alert/dismissed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-fixed": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A manifest file change removed a vulnerability.", + "operationId": "dependabot-alert/fixed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-reintroduced": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.", + "operationId": "dependabot-alert/reintroduced", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "dependabot-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", + "description": "A Dependabot alert was manually reopened.", + "operationId": "dependabot-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "dependabot_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "dependabot_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deploy-key-created": { + "post": { + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was created.", + "operationId": "deploy-key/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deploy_key", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deploy-key-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deploy_key", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deploy-key-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deploy key was deleted.", + "operationId": "deploy-key/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deploy_key", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deploy-key-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deploy_key", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deployment-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment was created.", + "operationId": "deployment/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deployment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "deployment-protection-rule-requested": { + "post": { + "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment protection rule was requested for an environment.", + "operationId": "deployment-protection-rule/requested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deployment_protection_rule", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_protection_rule", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-review-approved": { + "post": { + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was approved.", + "operationId": "deployment-review/approved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deployment_review", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-review-approved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-review-rejected": { + "post": { + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was rejected.", + "operationId": "deployment-review/rejected", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deployment_review", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-review-rejected" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-review-requested": { + "post": { + "summary": "This event occurs when there is activity relating to deployment reviews. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", + "description": "A deployment review was requested.", + "operationId": "deployment-review/requested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deployment_review", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-review-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_review", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "deployment-status-created": { + "post": { + "summary": "This event occurs when there is activity relating to deployment statuses. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", + "description": "A new deployment status was created.", + "operationId": "deployment-status/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "deployment_status", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-deployment-status-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "deployment_status", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-answered": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was marked as the answer.", + "operationId": "discussion/answered", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-answered" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-category-changed": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The category of a discussion was changed.", + "operationId": "discussion/category-changed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-category-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-closed": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was closed.", + "operationId": "discussion/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussions", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was created.", + "operationId": "discussion-comment/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was deleted.", + "operationId": "discussion-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on a discussion was edited.", + "operationId": "discussion-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-comment-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-created": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was created.", + "operationId": "discussion/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was deleted.", + "operationId": "discussion/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "The title or body on a discussion was edited, or the category of the discussion was changed.", + "operationId": "discussion/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-labeled": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was added to a discussion.", + "operationId": "discussion/labeled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-labeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-locked": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was locked.", + "operationId": "discussion/locked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-locked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was pinned.", + "operationId": "discussion/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was reopened.", + "operationId": "discussion/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussions", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was transferred to another repository.", + "operationId": "discussion/transferred", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-transferred" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-unanswered": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A comment on the discussion was unmarked as the answer.", + "operationId": "discussion/unanswered", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-unanswered" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-unlabeled": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A label was removed from a discussion.", + "operationId": "discussion/unlabeled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-unlabeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-unlocked": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unlocked.", + "operationId": "discussion/unlocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-unlocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "discussion-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"[GitHub Discussions](https://docs.github.com/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", + "description": "A discussion was unpinned.", + "operationId": "discussion/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#discussion" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "discussion", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-discussion-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "discussion", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "fork": { + "post": { + "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/rest/repos/forks)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "fork", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#fork" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "fork", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-fork" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "fork", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "github-app-authorization-revoked": { + "post": { + "summary": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see \"[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user).\"", + "description": "Someone revoked their authorization of a GitHub App.", + "operationId": "github-app-authorization/revoked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#github_app_authorization" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "github_app_authorization", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-github-app-authorization-revoked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "github_app_authorization", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "gollum": { + "post": { + "summary": "This event occurs when someone creates or updates a wiki page. For more information, see \"[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "gollum", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#gollum" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "gollum", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-gollum" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "gollum", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "installation-created": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "Someone installed a GitHub App on a user or organization account.", + "operationId": "installation/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "Someone uninstalled a GitHub App from their user or organization account.", + "operationId": "installation/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-new-permissions-accepted": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "Someone granted new permissions to a GitHub App.", + "operationId": "installation/new-permissions-accepted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-new-permissions-accepted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-repositories-added": { + "post": { + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "A GitHub App installation was granted access to one or more repositories.", + "operationId": "installation-repositories/added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation_repositories", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-repositories-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation_repositories", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-repositories-removed": { + "post": { + "summary": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "Access to one or more repositories was revoked for a GitHub App installation.", + "operationId": "installation-repositories/removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation_repositories", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-repositories-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation_repositories", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-suspend": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "Someone blocked access by a GitHub App to their user or organization account.", + "operationId": "installation/suspend", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-suspend" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-target-renamed": { + "post": { + "summary": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "Somebody renamed the user or organization account that a GitHub App is installed on.", + "operationId": "installation-target/renamed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation_target" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation_target", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-target-renamed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation_target", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "installation-unsuspend": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps).\" For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/rest/apps)\" in the REST API documentation.", + "description": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.", + "operationId": "installation/unsuspend", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#installation" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "installation", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-installation-unsuspend" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "installation", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "issue-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was created.", + "operationId": "issue-comment/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was deleted.", + "operationId": "issue-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue or pull request was edited.", + "operationId": "issue-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was pinned.", + "operationId": "issue-comment/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-comment-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/rest/issues/comments)\" in the REST API documentation.\n\nFor activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see \"[Working with comments](https://docs.github.com/rest/guides/working-with-comments).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A comment on an issue was unpinned.", + "operationId": "issue-comment/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-dependencies-blocked-by-added": { + "post": { + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocked by another issue.", + "operationId": "issue-dependencies/blocked-by-added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_dependencies", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue-dependencies", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-dependencies-blocked-by-removed": { + "post": { + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "The blocked by relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocked-by-removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_dependencies", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue-dependencies", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-dependencies-blocking-added": { + "post": { + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "An issue was marked as blocking another issue.", + "operationId": "issue-dependencies/blocking-added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_dependencies", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue-dependencies", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issue-dependencies-blocking-removed": { + "post": { + "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "The blocking relationship between an issue and another issue was removed.", + "operationId": "issue-dependencies/blocking-removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issue_dependencies", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issue-dependencies", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was assigned to a user.", + "operationId": "issues/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-closed": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was closed.", + "operationId": "issues/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was deleted.", + "operationId": "issues/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-demilestoned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was removed from a milestone.", + "operationId": "issues/demilestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-demilestoned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-edited": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "The title or body on an issue was edited.", + "operationId": "issues/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-labeled": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was added to an issue.", + "operationId": "issues/labeled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-labeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-locked": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/locked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-locked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-milestoned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was added to a milestone.", + "operationId": "issues/milestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-milestoned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-opened": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was created. When a closed issue is reopened, the action will be `reopened` instead.", + "operationId": "issues/opened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-pinned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was pinned to a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/pinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-pinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A closed issue was reopened.", + "operationId": "issues/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was transferred to another repository. For more information, see \"[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", + "operationId": "issues/transferred", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-transferred" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-typed": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue type was added to an issue.", + "operationId": "issues/typed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-typed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-unassigned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A user was unassigned from an issue.", + "operationId": "issues/unassigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-unassigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-unlabeled": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "A label was removed from an issue.", + "operationId": "issues/unlabeled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-unlabeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-unlocked": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "Conversation on an issue was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "issues/unlocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-unlocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-unpinned": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue was unpinned from a repository. For more information, see \"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", + "operationId": "issues/unpinned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-unpinned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "issues-untyped": { + "post": { + "summary": "This event occurs when there is activity relating to an issue. For more information about issues, see \"[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues).\" For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", + "description": "An issue type was removed from an issue.", + "operationId": "issues/untyped", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-issues-untyped" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-created": { + "post": { + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was created.", + "operationId": "label/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "label", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-label-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "label", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label was deleted.", + "operationId": "label/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "label", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-label-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "label", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "label-edited": { + "post": { + "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels).\" For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/rest/issues/labels)\" in the REST API documentation.\n\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A label's name, description, or color was changed.", + "operationId": "label/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#label" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "label", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-label-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "label", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "marketplace-purchase-cancelled": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/cancelled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "marketplace_purchase", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-changed": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/changed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "marketplace_purchase", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-pending-change": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", + "operationId": "marketplace-purchase/pending-change", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "marketplace_purchase", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-pending-change-cancelled": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", + "operationId": "marketplace-purchase/pending-change-cancelled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "marketplace_purchase", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "marketplace-purchase-purchased": { + "post": { + "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)\" in the REST API documentation.", + "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", + "operationId": "marketplace-purchase/purchased", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "marketplace_purchase", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "marketplace_purchase", + "supported-webhook-types": [ + "marketplace" + ] + } + } + }, + "member-added": { + "post": { + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A GitHub user accepted an invitation to a repository.", + "operationId": "member/added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "member", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-member-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "member", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "member-edited": { + "post": { + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "Permissions were changed for a collaborator on a repository.", + "operationId": "member/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "member", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-member-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "member", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "member-removed": { + "post": { + "summary": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization).\" For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A collaborator was removed from a repository.", + "operationId": "member/removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#member" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "member", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-member-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "member", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "membership-added": { + "post": { + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was added to a team.", + "operationId": "membership/added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "membership", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-membership-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "membership", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "membership-removed": { + "post": { + "summary": "This event occurs when there is activity relating to team membership. For more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\" For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/rest/teams/members)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization member was removed from a team.", + "operationId": "membership/removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#membership" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "membership", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-membership-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "membership", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "merge-group-checks-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", + "operationId": "merge-group/checks-requested", + "tags": [ + "merge-queue" + ], + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "merge_group", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "merge_group", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "merge-group-destroyed": { + "post": { + "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", + "description": "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\nWhen 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.", + "operationId": "merge-group/destroyed", + "tags": [ + "merge-queue" + ], + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "merge_group", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-merge-group-destroyed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "merge_group", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "meta-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.", + "description": "The webhook was deleted.", + "operationId": "meta/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#meta" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "meta", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-meta-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "meta", + "supported-webhook-types": [ + "marketplace", + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-closed": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was closed.", + "operationId": "milestone/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-created": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-edited": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was edited.", + "operationId": "milestone/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-opened": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was opened.", + "operationId": "milestone/opened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "milestone", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-milestone-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "org-block-blocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "org_block", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-org-block-blocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "org_block", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "org-block-unblocked": { + "post": { + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "org_block", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-org-block-unblocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "org_block", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "organization-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "An organization was deleted.", + "operationId": "organization/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "organization", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-organization-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "organization", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "organization-member-added": { + "post": { + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "organization", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-organization-member-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "organization", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "organization-member-invited": { + "post": { + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "organization", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-organization-member-invited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "organization", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "organization-member-removed": { + "post": { + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "organization", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-organization-member-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "organization", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "organization-renamed": { + "post": { + "summary": "This event occurs when there is activity relating to an organization and its members. For more information, see \"[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "organization", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-organization-renamed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "organization", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "package-published": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A package was published to a registry.", + "operationId": "package/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "package", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-package-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "package", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "package-updated": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.", + "description": "A previously published package was updated.", + "operationId": "package/updated", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "package", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "package", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "page-build": { + "post": { + "summary": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).\" For information about the API to manage GitHub Pages, see \"[Pages](https://docs.github.com/rest/pages)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.", + "operationId": "page-build", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "page_build", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-page-build" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "page_build", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "personal-access-token-request-approved": { + "post": { + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was approved.", + "operationId": "personal-access-token-request/approved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "integration", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app", + "organization" + ] + } + } + }, + "personal-access-token-request-cancelled": { + "post": { + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was cancelled by the requester.", + "operationId": "personal-access-token-request/cancelled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "integration", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app", + "organization" + ] + } + } + }, + "personal-access-token-request-created": { + "post": { + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "integration", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app", + "organization" + ] + } + } + }, + "personal-access-token-request-denied": { + "post": { + "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "integration", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app", + "organization" + ] + } + } + }, + "ping": { + "post": { + "summary": "This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.", + "operationId": "ping", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "ping", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-ping" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-ping-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ping-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "ping", + "supported-webhook-types": [ + "repository", + "organization", + "app", + "business", + "marketplace" + ] + } + } + }, + "project-card-converted": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note in a project (classic) was converted to an issue.", + "operationId": "project-card/converted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_card", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-card-converted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-card-created": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card was added to a project (classic).", + "operationId": "project-card/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_card", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-card-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-card-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_card", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-card-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-card-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_card", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-card-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-card-moved": { + "post": { + "summary": "This event occurs when there is activity relating to a card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A card on a project (classic) was moved to another column or to another position in its column.", + "operationId": "project-card/moved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_card", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-card-moved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_card", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-closed": { + "post": { + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-column-created": { + "post": { + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was added to a project (classic).", + "operationId": "project-column/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_column", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-column-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_column", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-column-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was deleted from a project (classic).", + "operationId": "project-column/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_column", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-column-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_column", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-column-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_column", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-column-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_column", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-column-moved": { + "post": { + "summary": "This event occurs when there is activity relating to a column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project_column", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-column-moved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project_column", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-created": { + "post": { + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was created.", + "operationId": "project/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was deleted.", + "operationId": "project/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "project-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).\" For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-project-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "project", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "projects-v2-closed": { + "post": { + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was closed.", + "operationId": "projects-v2/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-created": { + "post": { + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was created.", + "operationId": "projects-v2/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-project-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-edited": { + "post": { + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-archived": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item on an organization project was archived. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/archived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-converted": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A draft issue in an organization project was converted to an issue.", + "operationId": "projects-v2-item/converted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-created": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-edited": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.", + "operationId": "projects-v2-item/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-reordered": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.", + "operationId": "projects-v2-item/reordered", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-item-restored": { + "post": { + "summary": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item).\n\nFor activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "An archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", + "operationId": "projects-v2-item/restored", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-item", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_item", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\" For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2).\n\nFor activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A project in the organization was reopened.", + "operationId": "projects-v2/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-status-update-created": { + "post": { + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was added to a project in the organization.", + "operationId": "projects-v2-status-update/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-status-update", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_status_update", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-status-update-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was removed from a project in the organization.", + "operationId": "projects-v2-status-update/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-status-update", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_status_update", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "projects-v2-status-update-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "project-v2-status-update", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "projects_v2_status_update", + "supported-webhook-types": [ + "organization" + ] + } + } + }, + "public": { + "post": { + "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "operationId": "public", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "public", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-public" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "public", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-assigned": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was assigned to a user.", + "operationId": "pull-request/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-auto-merge-disabled": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was disabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-disabled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-auto-merge-enabled": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", + "operationId": "pull-request/auto-merge-enabled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-closed": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.", + "operationId": "pull-request/closed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-converted-to-draft": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/converted-to-draft", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-demilestoned": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-dequeued": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was removed from the merge queue.", + "operationId": "pull-request/dequeued", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-dequeued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-edited": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.", + "operationId": "pull-request/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-enqueued": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-enqueued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-labeled": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was added to a pull request.", + "operationId": "pull-request/labeled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-labeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-locked": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-locked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-milestoned": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was added to a milestone.", + "operationId": "pull-request/milestoned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-milestoned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-opened": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request was created", + "operationId": "pull-request/opened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-opened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-ready-for-review": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A draft pull request was marked as ready for review. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request).\"", + "operationId": "pull-request/ready-for-review", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-reopened": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously closed pull request was reopened.", + "operationId": "pull-request/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-comment-created": { + "post": { + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was created.", + "operationId": "pull-request-review-comment/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-comment-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment on a pull request diff was deleted.", + "operationId": "pull-request-review-comment/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-comment-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).\" For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The content of a comment on a pull request diff was changed.", + "operationId": "pull-request-review-comment/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review_comment", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_comment", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-dismissed": { + "post": { + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was dismissed.", + "operationId": "pull-request-review/dismissed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "The body comment on a pull request review was edited.", + "operationId": "pull-request-review/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-request-removed": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A request for review by a person or team was removed from a pull request.", + "operationId": "pull-request/review-request-removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-requested": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Review by a person or team was requested for a pull request. For more information, see \"[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review).\"", + "operationId": "pull-request/review-requested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-submitted": { + "post": { + "summary": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/rest/pulls/reviews)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-thread-resolved": { + "post": { + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A comment thread on a pull request was marked as resolved.", + "operationId": "pull-request-review-thread/resolved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review_thread", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_thread", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-thread-unresolved": { + "post": { + "summary": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews).\" For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/rest/pulls/comments)\" in the REST API documentation.\n\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A previously resolved comment thread on a pull request was marked as unresolved.", + "operationId": "pull-request-review-thread/unresolved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request_review_thread", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request_review_thread", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-synchronize": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.", + "operationId": "pull-request/synchronize", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-synchronize" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-unassigned": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A user was unassigned from a pull request.", + "operationId": "pull-request/unassigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-unassigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-unlabeled": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "A label was removed from a pull request.", + "operationId": "pull-request/unlabeled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-unlocked": { + "post": { + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.", + "description": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "pull_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-pull-request-unlocked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "push": { + "post": { + "summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", + "operationId": "push", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "push", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-push" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "push", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "registry-package-published": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package was published to a registry.", + "operationId": "registry-package/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "registry_package", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-registry-package-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "registry_package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "registry-package-updated": { + "post": { + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages).\" For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> GitHub recommends that you use the newer `package` event instead.", + "description": "A package that was previously published to a registry was updated.", + "operationId": "registry-package/updated", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "registry_package", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-registry-package-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "registry_package", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-created": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A draft was saved, or a release or pre-release was published without previously being saved as a draft.", + "operationId": "release/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release, pre-release, or draft release was deleted.", + "operationId": "release/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-edited": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "The details of a release, pre-release, or draft release were edited. For more information, see \"[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-prereleased": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-prereleased" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-published": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-released": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-released" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-unpublished": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "release", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-unpublished" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-advisory-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-advisory-reported": { + "post": { + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-advisory-reported" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_advisory", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-archived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was archived.", + "operationId": "repository/archived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-archived" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-created": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was created.", + "operationId": "repository/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-dispatch-sample.collected": { + "post": { + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "repository-dispatch/sample.collected", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_dispatch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "repository-edited": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-import": { + "post": { + "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).", + "operationId": "repository-import", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_import", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-import" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_import", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "repository-privatized": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-privatized" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-publicized": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-publicized" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-renamed": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-renamed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-created": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_ruleset", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-ruleset-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_ruleset", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-ruleset-edited": { + "post": { + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_ruleset", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-transferred" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-unarchived" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-vulnerability-alert-create": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "repository-vulnerability-alert-dismiss": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "repository-vulnerability-alert-reopen": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "repository-vulnerability-alert-resolve": { + "post": { + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "repository_vulnerability_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-created": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-location-created": { + "post": { + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert_location", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "webhooks", + "subcategory": "secret_scanning_alert_location", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-publicly-leaked": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was detected in a public repo.", + "operationId": "secret-scanning-alert/publicly-leaked", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-reopened": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-resolved": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-unassigned": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was unassigned.", + "operationId": "secret-scanning-alert/unassigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-alert-validated": { + "post": { + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was validated.", + "operationId": "secret-scanning-alert/validated", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_alert", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "secret-scanning-scan-completed": { + "post": { + "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning scan was completed.", + "operationId": "secret-scanning-scan/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "secret_scanning_scan", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_scan", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "security-advisory-published": { + "post": { + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "security_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-security-advisory-published" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "security_advisory", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "security-advisory-updated": { + "post": { + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed.", + "operationId": "security-advisory/updated", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "security_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-security-advisory-updated" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "security_advisory", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "security-advisory-withdrawn": { + "post": { + "summary": "This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories).\" For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "security_advisory", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "security_advisory", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "security-and-analysis": { + "post": { + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "security_and_analysis", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-security-and-analysis" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "security_and_analysis", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sponsorship-cancelled": { + "post": { + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sponsorship", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "sponsorship-created": { + "post": { + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sponsorship", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "sponsorship-edited": { + "post": { + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sponsorship", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "sponsorship-pending-cancellation": { + "post": { + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sponsorship", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "sponsorship-pending-tier-change": { + "post": { + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sponsorship", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "sponsorship-tier-changed": { + "post": { + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sponsorship", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sponsorship", + "supported-webhook-types": [ + "sponsors_listing" + ] + } + } + }, + "star-created": { + "post": { + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "star", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-star-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "star", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "star-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#star" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "star", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-star-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "star", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "status": { + "post": { + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#status" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "status", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-status" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "status", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-parent-issue-added": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A parent issue was added to an issue.", + "operationId": "sub-issues/parent-issue-added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sub_issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-parent-issue-removed": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A parent issue was removed from an issue.", + "operationId": "sub-issues/parent-issue-removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sub_issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-sub-issue-added": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was added to an issue.", + "operationId": "sub-issues/sub-issue-added", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sub_issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "sub-issues-sub-issue-removed": { + "post": { + "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", + "description": "A sub-issue was removed from an issue.", + "operationId": "sub-issues/sub-issue-removed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "sub_issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "sub-issues", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "team-add": { + "post": { + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team_add" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "team_add", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-add" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team_add", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "team-added-to-repository": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "team", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-added-to-repository" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-created": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was created.", + "operationId": "team/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "team", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-created" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-deleted": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was deleted.", + "operationId": "team/deleted", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "team", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-edited": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "team", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-edited" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "team-removed-from-repository": { + "post": { + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#team" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "team", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-team-removed-from-repository" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "team", + "supported-webhook-types": [ + "organization", + "business", + "app" + ] + } + } + }, + "watch-started": { + "post": { + "summary": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions).\" For information about the APIs to manage watching, see \"[Watching](https://docs.github.com/rest/activity/watching)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone started watching the repository.", + "operationId": "watch/started", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#watch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "watch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-watch-started" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "watch", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-dispatch": { + "post": { + "summary": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "operationId": "workflow-dispatch", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_dispatch", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-dispatch" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "workflow-job-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.", + "operationId": "workflow-job/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run started processing on a runner.", + "operationId": "workflow-job/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-queued": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created.", + "operationId": "workflow-job/queued", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-queued" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-job-waiting": { + "post": { + "summary": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow).\" For information about the API to manage workflow jobs, see \"[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A job in a workflow run was created and is waiting for approvals.", + "operationId": "workflow-job/waiting", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_job", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-job-waiting" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_job", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-completed": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.", + "operationId": "workflow-run/completed", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-run-completed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-in-progress": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run started processing on a runner.", + "operationId": "workflow-run/in-progress", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-run-in-progress" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "workflow-run-requested": { + "post": { + "summary": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"[About workflows](https://docs.github.com/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.", + "description": "A workflow run was triggered.", + "operationId": "workflow-run/requested", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "workflow_run", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-workflow-run-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "workflow_run", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + } + }, + "components": { + "schemas": { + "root": { + "type": "object", + "properties": { + "current_user_url": { + "type": "string", + "format": "uri-template" + }, + "current_user_authorizations_html_url": { + "type": "string", + "format": "uri-template" + }, + "authorizations_url": { + "type": "string", + "format": "uri-template" + }, + "code_search_url": { + "type": "string", + "format": "uri-template" + }, + "commit_search_url": { + "type": "string", + "format": "uri-template" + }, + "emails_url": { + "type": "string", + "format": "uri-template" + }, + "emojis_url": { + "type": "string", + "format": "uri-template" + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "feeds_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri-template" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "hub_url": { + "type": "string", + "format": "uri-template", + "deprecated": true + }, + "issue_search_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "label_search_url": { + "type": "string", + "format": "uri-template" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "organization_url": { + "type": "string", + "format": "uri-template" + }, + "organization_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "organization_teams_url": { + "type": "string", + "format": "uri-template" + }, + "public_gists_url": { + "type": "string", + "format": "uri-template" + }, + "rate_limit_url": { + "type": "string", + "format": "uri-template" + }, + "repository_url": { + "type": "string", + "format": "uri-template" + }, + "repository_search_url": { + "type": "string", + "format": "uri-template" + }, + "current_user_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "starred_gists_url": { + "type": "string", + "format": "uri-template" + }, + "topic_search_url": { + "type": "string", + "format": "uri-template" + }, + "user_url": { + "type": "string", + "format": "uri-template" + }, + "user_organizations_url": { + "type": "string", + "format": "uri-template" + }, + "user_repositories_url": { + "type": "string", + "format": "uri-template" + }, + "user_search_url": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "current_user_url", + "current_user_authorizations_html_url", + "authorizations_url", + "code_search_url", + "commit_search_url", + "emails_url", + "emojis_url", + "events_url", + "feeds_url", + "followers_url", + "following_url", + "gists_url", + "issue_search_url", + "issues_url", + "keys_url", + "label_search_url", + "notifications_url", + "organization_url", + "organization_repositories_url", + "organization_teams_url", + "public_gists_url", + "rate_limit_url", + "repository_url", + "repository_search_url", + "current_user_repositories_url", + "starred_url", + "starred_gists_url", + "user_url", + "user_organizations_url", + "user_repositories_url", + "user_search_url" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_authorizations_url_from_api_root", + "patch": [ + { + "op": "remove", + "path": "/properties/authorizations_url" + }, + { + "op": "remove", + "path": "/required/2" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_hub_url_from_api_root", + "patch": { + "properties": { + "hub_url": null + } + }, + "version": "2026-03-10" + } + ] + }, + "security-advisory-ecosystems": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ] + }, + "vulnerability": { + "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "first_patched_version": { + "type": "string", + "description": "The package version that resolves the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected by the vulnerability.", + "nullable": true, + "readOnly": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "first_patched_version", + "vulnerable_functions" + ] + }, + "cvss-severities": { + "type": "object", + "nullable": true, + "properties": { + "cvss_v3": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 3 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 3 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_v4": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS 4 vector string.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS 4 score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + } + } + }, + "security-advisory-epss": { + "type": "object", + "nullable": true, + "readOnly": true, + "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", + "properties": { + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "percentile": { + "type": "number", + "minimum": 0, + "maximum": 100 + } + } + }, + "simple-user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "security-advisory-credit-types": { + "type": "string", + "description": "The type of credit the user is receiving.", + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ] + }, + "global-advisory": { + "description": "A GitHub Security Advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true, + "readOnly": true + }, + "url": { + "type": "string", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "repository_advisory_url": { + "type": "string", + "format": "uri", + "description": "The API URL for the repository advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "type": { + "type": "string", + "description": "The type of advisory.", + "readOnly": true, + "enum": [ + "reviewed", + "unreviewed", + "malware" + ] + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "enum": [ + "critical", + "high", + "medium", + "low", + "unknown" + ] + }, + "source_code_location": { + "type": "string", + "format": "uri", + "description": "The URL of the advisory's source code.", + "nullable": true + }, + "identifiers": { + "type": "array", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + } + }, + "references": { + "type": "array", + "nullable": true, + "items": { + "type": "string", + "description": "URLs with more information regarding the advisory." + } + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true + }, + "github_reviewed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "nvd_published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "vulnerabilities": { + "type": "array", + "description": "The products and respective version ranges affected by the advisory.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/vulnerability" + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "epss": { + "$ref": "#/components/schemas/security-advisory-epss" + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "credits": { + "type": "array", + "description": "The users who contributed to the advisory.", + "nullable": true, + "readOnly": true, + "items": { + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + }, + "required": [ + "user", + "type" + ] + } + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cvss", + "cwes", + "credits" + ], + "additionalProperties": false, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "repository_advisory_url", + "summary", + "description", + "type", + "severity", + "source_code_location", + "identifiers", + "references", + "published_at", + "updated_at", + "github_reviewed_at", + "nvd_published_at", + "withdrawn_at", + "vulnerabilities", + "cwes", + "credits" + ] + }, + "version": "2026-03-10" + } + ] + }, + "basic-error": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "validation-error-simple": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/enterprise" + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "webhook-config-url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "webhook-config-content-type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "webhook-config-secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "webhook-config-insecure-ssl": { + "oneOf": [ + { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + { + "type": "number" + } + ] + }, + "webhook-config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", + "type": "object", + "properties": { + "url": { + "$ref": "#/components/schemas/webhook-config-url" + }, + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + } + } + }, + "hook-delivery-item": { + "title": "Simple webhook delivery", + "description": "Delivery made by a webhook, without request and response information.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the webhook delivery.", + "type": "integer", + "format": "int64", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the webhook delivery occurred.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the webhook delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Describes the response returned after attempting the delivery.", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "format": "int64", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "format": "int64", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id" + ] + }, + "scim-error": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "validation-error": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + }, + "hook-delivery": { + "title": "Webhook delivery", + "description": "Delivery made by a webhook.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the delivery.", + "type": "integer", + "example": 42 + }, + "guid": { + "description": "Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).", + "type": "string", + "example": "58474f00-b361-11eb-836d-0e4f3503ccbe" + }, + "delivered_at": { + "description": "Time when the delivery was delivered.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z" + }, + "redelivery": { + "description": "Whether the delivery is a redelivery.", + "type": "boolean", + "example": false + }, + "duration": { + "description": "Time spent delivering.", + "type": "number", + "example": 0.03 + }, + "status": { + "description": "Description of the status of the attempted delivery", + "type": "string", + "example": "failed to connect" + }, + "status_code": { + "description": "Status code received when delivery was made.", + "type": "integer", + "example": 502 + }, + "event": { + "description": "The event that triggered the delivery.", + "type": "string", + "example": "issues" + }, + "action": { + "description": "The type of activity for the event that triggered the delivery.", + "type": "string", + "example": "opened", + "nullable": true + }, + "installation_id": { + "description": "The id of the GitHub App installation associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "repository_id": { + "description": "The id of the repository associated with this event.", + "type": "integer", + "example": 123, + "nullable": true + }, + "throttled_at": { + "description": "Time when the webhook delivery was throttled.", + "type": "string", + "format": "date-time", + "example": "2021-05-12T20:33:44Z", + "nullable": true + }, + "url": { + "description": "The URL target of the delivery.", + "type": "string", + "example": "https://www.example.com" + }, + "request": { + "type": "object", + "properties": { + "headers": { + "description": "The request headers sent with the webhook delivery.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The webhook payload.", + "type": "object", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] + }, + "response": { + "type": "object", + "properties": { + "headers": { + "description": "The response headers received when the delivery was made.", + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "payload": { + "description": "The response payload received.", + "type": "string", + "nullable": true, + "additionalProperties": true + } + }, + "required": [ + "headers", + "payload" + ] + } + }, + "required": [ + "id", + "guid", + "delivered_at", + "redelivery", + "duration", + "status", + "status_code", + "event", + "action", + "installation_id", + "repository_id", + "request", + "response" + ] + }, + "integration-installation-request": { + "title": "Integration Installation Request", + "description": "Request to install an integration on a target", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the request installation.", + "type": "integer", + "example": 42 + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "account": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/enterprise" + } + ] + }, + "requester": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-07-08T16:18:44-04:00" + } + }, + "required": [ + "id", + "account", + "requester", + "created_at" + ] + }, + "app-permissions": { + "title": "App Permissions", + "type": "object", + "description": "The permissions granted to the user access token.", + "properties": { + "actions": { + "type": "string", + "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "description": "The level of permission to create and retrieve the access token for repository attestations.", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "description": "The level of permission to grant the access token for checks on code.", + "enum": [ + "read", + "write" + ] + }, + "codespaces": { + "type": "string", + "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", + "enum": [ + "read", + "write" + ] + }, + "dependabot_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot secrets.", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "description": "The level of permission to grant the access token for deployments and deployment statuses.", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "description": "The level of permission to grant the access token for discussions and related comments and labels.", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "description": "The level of permission to grant the access token for managing repository environments.", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "description": "The level of permission to grant the access token to manage the merge queues for a repository.", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "description": "The level of permission to grant the access token for packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", + "enum": [ + "read", + "write" + ] + }, + "repository_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage repository secrets.", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "description": "The level of permission to grant the access token to manage just a single file.", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "description": "The level of permission to grant the access token for commit statuses.", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "description": "The level of permission to grant the access token to manage Dependabot alerts.", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", + "enum": [ + "write" + ] + }, + "custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "description": "The level of permission to grant the access token for organization teams and members.", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "description": "The level of permission to grant the access token to manage access to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom repository roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_org_roles": { + "type": "string", + "description": "The level of permission to grant the access token for custom organization roles management.", + "enum": [ + "read", + "write" + ] + }, + "organization_custom_properties": { + "type": "string", + "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_copilot_seat_management": { + "type": "string", + "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change.", + "enum": [ + "write" + ] + }, + "organization_copilot_agent_settings": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_announcement_banners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_events": { + "type": "string", + "description": "The level of permission to grant the access token to view events triggered by an activity in an organization.", + "enum": [ + "read" + ] + }, + "organization_hooks": { + "type": "string", + "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_tokens": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_personal_access_token_requests": { + "type": "string", + "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "description": "The level of permission to grant the access token for viewing an organization's plan.", + "enum": [ + "read" + ] + }, + "organization_projects": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available).", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_packages": { + "type": "string", + "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "description": "The level of permission to grant the access token to manage organization secrets.", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", + "enum": [ + "read", + "write" + ] + }, + "email_addresses": { + "type": "string", + "description": "The level of permission to grant the access token to manage the email addresses belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "followers": { + "type": "string", + "description": "The level of permission to grant the access token to manage the followers belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "git_ssh_keys": { + "type": "string", + "description": "The level of permission to grant the access token to manage git SSH keys.", + "enum": [ + "read", + "write" + ] + }, + "gpg_keys": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user.", + "enum": [ + "read", + "write" + ] + }, + "interaction_limits": { + "type": "string", + "description": "The level of permission to grant the access token to view and manage interaction limits on a repository.", + "enum": [ + "read", + "write" + ] + }, + "profile": { + "type": "string", + "description": "The level of permission to grant the access token to manage the profile settings belonging to a user.", + "enum": [ + "write" + ] + }, + "starring": { + "type": "string", + "description": "The level of permission to grant the access token to list and manage repositories a user is starring.", + "enum": [ + "read", + "write" + ] + }, + "enterprise_custom_properties_for_organizations": { + "type": "string", + "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", + "enum": [ + "read", + "write", + "admin" + ] + } + }, + "example": { + "contents": "read", + "issues": "read", + "deployments": "write", + "single_file": "read" + } + }, + "nullable-simple-user": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "installation": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/enterprise" + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/app/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { + "type": "integer", + "example": 1 + }, + "client_id": { + "type": "string", + "example": "Iv1.ab1112223334445c" + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "example": "Organization" + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at", + "suspended_by", + "suspended_at" + ] + }, + "nullable-license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ], + "nullable": true + }, + "repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "example": "all" + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "installation-token": { + "title": "Installation Token", + "description": "Authentication token for a GitHub App installed on a user or org.", + "type": "object", + "properties": { + "token": { + "type": "string" + }, + "expires_at": { + "type": "string" + }, + "permissions": { + "$ref": "#/components/schemas/app-permissions" + }, + "repository_selection": { + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "single_file": { + "type": "string", + "example": "README.md" + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + } + }, + "required": [ + "token", + "expires_at" + ] + }, + "nullable-scoped-installation": { + "title": "Scoped Installation", + "type": "object", + "properties": { + "permissions": { + "$ref": "#/components/schemas/app-permissions" + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "account": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "permissions", + "repository_selection", + "single_file_name", + "repositories_url", + "account" + ], + "nullable": true + }, + "authorization": { + "title": "Authorization", + "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string", + "format": "uri" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string", + "nullable": true + }, + "hashed_token": { + "type": "string", + "nullable": true + }, + "app": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "client_id", + "name", + "url" + ] + }, + "note": { + "type": "string", + "nullable": true + }, + "note_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "fingerprint": { + "type": "string", + "nullable": true + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "installation": { + "$ref": "#/components/schemas/nullable-scoped-installation" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "app", + "id", + "note", + "note_url", + "scopes", + "token", + "hashed_token", + "token_last_eight", + "fingerprint", + "url", + "created_at", + "updated_at", + "expires_at" + ] + }, + "simple-classroom-repository": { + "title": "Simple Classroom Repository", + "description": "A GitHub repository view for Classroom", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique name of the repository." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "default_branch": { + "type": "string", + "example": "main", + "description": "The default branch for the repository." + } + }, + "required": [ + "id", + "full_name", + "html_url", + "node_id", + "private", + "default_branch" + ] + }, + "simple-classroom-organization": { + "title": "Organization Simple for Classroom", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "login": { + "type": "string", + "example": "github" + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/github" + }, + "name": { + "type": "string", + "example": "Github - Code thigns happen here", + "nullable": true + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + } + }, + "required": [ + "id", + "login", + "node_id", + "html_url", + "name", + "avatar_url" + ] + }, + "classroom": { + "title": "Classroom", + "description": "A GitHub Classroom classroom", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the classroom.", + "example": 42, + "type": "integer" + }, + "name": { + "description": "The name of the classroom.", + "type": "string", + "example": "Programming Elixir" + }, + "archived": { + "description": "Whether classroom is archived.", + "type": "boolean", + "example": false + }, + "organization": { + "$ref": "#/components/schemas/simple-classroom-organization" + }, + "url": { + "description": "The URL of the classroom on GitHub Classroom.", + "type": "string", + "example": "https://classroom.github.com/classrooms/1-programming-elixir" + } + }, + "required": [ + "id", + "name", + "archived", + "organization", + "url" + ] + }, + "classroom-assignment": { + "title": "Classroom Assignment", + "description": "A GitHub Classroom assignment", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository.", + "type": "integer", + "example": 42 + }, + "public_repo": { + "description": "Whether an accepted assignment creates a public repository.", + "type": "boolean", + "example": true + }, + "title": { + "description": "Assignment title.", + "type": "string", + "example": "Intro to Binaries" + }, + "type": { + "description": "Whether it's a group assignment or individual assignment.", + "type": "string", + "example": "individual", + "enum": [ + "individual", + "group" + ] + }, + "invite_link": { + "description": "The link that a student can use to accept the assignment.", + "type": "string", + "example": "https://classroom.github.com/a/Lx7jiUgx" + }, + "invitations_enabled": { + "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", + "type": "boolean", + "example": true + }, + "slug": { + "description": "Sluggified name of the assignment.", + "type": "string", + "example": "intro-to-binaries" + }, + "students_are_repo_admins": { + "description": "Whether students are admins on created repository when a student accepts the assignment.", + "type": "boolean", + "example": true + }, + "feedback_pull_requests_enabled": { + "description": "Whether feedback pull request will be created when a student accepts the assignment.", + "type": "boolean", + "example": true + }, + "max_teams": { + "description": "The maximum allowable teams for the assignment.", + "nullable": true, + "type": "integer", + "example": 0 + }, + "max_members": { + "description": "The maximum allowable members per team.", + "nullable": true, + "type": "integer", + "example": 0 + }, + "editor": { + "description": "The selected editor for the assignment.", + "type": "string", + "example": "codespaces" + }, + "accepted": { + "description": "The number of students that have accepted the assignment.", + "type": "integer", + "example": 25 + }, + "submitted": { + "description": "The number of students that have submitted the assignment.", + "type": "integer", + "example": 10 + }, + "passing": { + "description": "The number of students that have passed the assignment.", + "type": "integer", + "example": 10 + }, + "language": { + "description": "The programming language used in the assignment.", + "type": "string", + "example": "elixir" + }, + "deadline": { + "description": "The time at which the assignment is due.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "starter_code_repository": { + "$ref": "#/components/schemas/simple-classroom-repository" + }, + "classroom": { + "$ref": "#/components/schemas/classroom" + } + }, + "required": [ + "id", + "public_repo", + "title", + "type", + "invite_link", + "invitations_enabled", + "slug", + "students_are_repo_admins", + "feedback_pull_requests_enabled", + "max_teams", + "max_members", + "editor", + "accepted", + "submitted", + "passing", + "language", + "deadline", + "starter_code_repository", + "classroom" + ] + }, + "simple-classroom-user": { + "title": "Simple Classroom User", + "description": "A GitHub user simplified for Classroom.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "login": { + "type": "string", + "example": "octocat" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + } + }, + "required": [ + "id", + "login", + "avatar_url", + "html_url" + ] + }, + "simple-classroom": { + "title": "Simple Classroom", + "description": "A GitHub Classroom classroom", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the classroom.", + "example": 42, + "type": "integer" + }, + "name": { + "description": "The name of the classroom.", + "type": "string", + "example": "Programming Elixir" + }, + "archived": { + "description": "Returns whether classroom is archived or not.", + "type": "boolean", + "example": false + }, + "url": { + "description": "The url of the classroom on GitHub Classroom.", + "type": "string", + "example": "https://classroom.github.com/classrooms/1-programming-elixir" + } + }, + "required": [ + "id", + "name", + "archived", + "url" + ] + }, + "simple-classroom-assignment": { + "title": "Simple Classroom Assignment", + "description": "A GitHub Classroom assignment", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository.", + "type": "integer", + "example": 42 + }, + "public_repo": { + "description": "Whether an accepted assignment creates a public repository.", + "type": "boolean", + "example": true + }, + "title": { + "description": "Assignment title.", + "type": "string", + "example": "Intro to Binaries" + }, + "type": { + "description": "Whether it's a Group Assignment or Individual Assignment.", + "type": "string", + "example": "individual", + "enum": [ + "individual", + "group" + ] + }, + "invite_link": { + "description": "The link that a student can use to accept the assignment.", + "type": "string", + "example": "https://classroom.github.com/a/Lx7jiUgx" + }, + "invitations_enabled": { + "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.", + "type": "boolean", + "example": true + }, + "slug": { + "description": "Sluggified name of the assignment.", + "type": "string", + "example": "intro-to-binaries" + }, + "students_are_repo_admins": { + "description": "Whether students are admins on created repository on accepted assignment.", + "type": "boolean", + "example": true + }, + "feedback_pull_requests_enabled": { + "description": "Whether feedback pull request will be created on assignment acceptance.", + "type": "boolean", + "example": true + }, + "max_teams": { + "description": "The maximum allowable teams for the assignment.", + "nullable": true, + "type": "integer", + "example": 0 + }, + "max_members": { + "description": "The maximum allowable members per team.", + "nullable": true, + "type": "integer", + "example": 0 + }, + "editor": { + "description": "The selected editor for the assignment.", + "type": "string", + "example": "codespaces" + }, + "accepted": { + "description": "The number of students that have accepted the assignment.", + "type": "integer", + "example": 25 + }, + "submitted": { + "description": "The number of students that have submitted the assignment.", + "type": "integer", + "example": 10 + }, + "passing": { + "description": "The number of students that have passed the assignment.", + "type": "integer", + "example": 10 + }, + "language": { + "description": "The programming language used in the assignment.", + "type": "string", + "example": "elixir" + }, + "deadline": { + "description": "The time at which the assignment is due.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "classroom": { + "$ref": "#/components/schemas/simple-classroom" + } + }, + "required": [ + "id", + "public_repo", + "title", + "type", + "invite_link", + "invitations_enabled", + "slug", + "students_are_repo_admins", + "feedback_pull_requests_enabled", + "editor", + "accepted", + "submitted", + "passing", + "language", + "deadline", + "classroom" + ] + }, + "classroom-accepted-assignment": { + "title": "Classroom Accepted Assignment", + "description": "A GitHub Classroom accepted assignment", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository.", + "type": "integer", + "example": 42 + }, + "submitted": { + "description": "Whether an accepted assignment has been submitted.", + "type": "boolean", + "example": true + }, + "passing": { + "description": "Whether a submission passed.", + "type": "boolean", + "example": true + }, + "commit_count": { + "description": "Count of student commits.", + "type": "integer", + "example": 5 + }, + "grade": { + "description": "Most recent grade.", + "type": "string", + "example": "10/10" + }, + "students": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-classroom-user" + } + }, + "repository": { + "$ref": "#/components/schemas/simple-classroom-repository" + }, + "assignment": { + "$ref": "#/components/schemas/simple-classroom-assignment" + } + }, + "required": [ + "id", + "submitted", + "passing", + "commit_count", + "grade", + "students", + "repository", + "assignment" + ] + }, + "classroom-assignment-grade": { + "title": "Classroom Assignment Grade", + "description": "Grade for a student or groups GitHub Classroom assignment", + "type": "object", + "properties": { + "assignment_name": { + "description": "Name of the assignment", + "type": "string" + }, + "assignment_url": { + "description": "URL of the assignment", + "type": "string" + }, + "starter_code_url": { + "description": "URL of the starter code for the assignment", + "type": "string" + }, + "github_username": { + "description": "GitHub username of the student", + "type": "string" + }, + "roster_identifier": { + "description": "Roster identifier of the student", + "type": "string" + }, + "student_repository_name": { + "description": "Name of the student's assignment repository", + "type": "string" + }, + "student_repository_url": { + "description": "URL of the student's assignment repository", + "type": "string" + }, + "submission_timestamp": { + "description": "Timestamp of the student's assignment submission", + "type": "string" + }, + "points_awarded": { + "description": "Number of points awarded to the student", + "type": "integer" + }, + "points_available": { + "description": "Number of points available for the assignment", + "type": "integer" + }, + "group_name": { + "description": "If a group assignment, name of the group the student is in", + "type": "string" + } + }, + "required": [ + "assignment_name", + "assignment_url", + "starter_code_url", + "github_username", + "roster_identifier", + "student_repository_name", + "student_repository_url", + "submission_timestamp", + "points_awarded", + "points_available" + ] + }, + "code-of-conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "contributor_covenant" + }, + "name": { + "type": "string", + "example": "Contributor Covenant" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/codes_of_conduct/contributor_covenant" + }, + "body": { + "type": "string", + "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "actions-cache-retention-limit-for-enterprise": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "example": 14 + } + } + }, + "actions-cache-storage-limit-for-enterprise": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "example": 10 + } + } + }, + "oidc-custom-property-inclusion": { + "title": "Actions OIDC Custom Property Inclusion", + "description": "An OIDC custom property inclusion for repository properties", + "type": "object", + "properties": { + "custom_property_name": { + "type": "string", + "description": "The name of the custom property that is included in the OIDC token" + }, + "inclusion_source": { + "type": "string", + "description": "Whether the inclusion was defined at the organization or enterprise level", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + } + }, + "required": [ + "custom_property_name", + "inclusion_source" + ] + }, + "oidc-custom-property-inclusion-input": { + "title": "Actions OIDC Custom Property Inclusion Input", + "description": "Input for creating an OIDC custom property inclusion", + "type": "object", + "properties": { + "custom_property_name": { + "type": "string", + "description": "The name of the custom property to include in the OIDC token" + } + }, + "required": [ + "custom_property_name" + ] + }, + "code-security-configuration": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_delegated_alert_dismissal": { + "type": "string", + "nullable": true, + "description": "The enablement status of Dependabot delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + }, + "security_configuration_id": { + "type": "integer", + "description": "The ID of the security configuration associated with this bypass reviewer" + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_extended_metadata": { + "type": "string", + "description": "The enablement status of secret scanning extended metadata", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "code-scanning-options": { + "type": "object", + "description": "Security Configuration feature options for code scanning", + "nullable": true, + "properties": { + "allow_advanced": { + "nullable": true, + "type": "boolean", + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code-scanning-default-setup-options": { + "type": "object", + "description": "Feature options for code scanning default setup", + "nullable": true, + "properties": { + "runner_type": { + "type": "string", + "enum": [ + "standard", + "labeled", + "not_set" + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "nullable": true, + "type": "string", + "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'." + } + } + }, + "code-security-default-configurations": { + "type": "array", + "description": "A list of default code security configurations", + "items": { + "type": "object", + "properties": { + "default_for_new_repos": { + "enum": [ + "public", + "private_and_internal", + "all" + ], + "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default" + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + } + }, + "simple-repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "code-security-configuration-repositories": { + "type": "object", + "description": "Repositories associated with a code security configuration and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + } + } + }, + "copilot-usage-metrics-1-day-report": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "copilot-usage-metrics-28-day-report": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] + }, + "alert-number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true + }, + "dependabot-alert-package": { + "type": "object", + "description": "Details for the vulnerable package.", + "readOnly": true, + "properties": { + "ecosystem": { + "type": "string", + "description": "The package's language or package management ecosystem.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "readOnly": true + } + }, + "required": [ + "ecosystem", + "name" + ], + "additionalProperties": false + }, + "dependabot-alert-security-vulnerability": { + "type": "object", + "description": "Details pertaining to one vulnerable version range for the advisory.", + "readOnly": true, + "properties": { + "package": { + "$ref": "#/components/schemas/dependabot-alert-package" + }, + "severity": { + "type": "string", + "description": "The severity of the vulnerability.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "Conditions that identify vulnerable versions of this vulnerability's package.", + "readOnly": true + }, + "first_patched_version": { + "type": "object", + "description": "Details pertaining to the package version that patches this vulnerability.", + "readOnly": true, + "nullable": true, + "properties": { + "identifier": { + "type": "string", + "description": "The package version that patches this vulnerability.", + "readOnly": true + } + }, + "required": [ + "identifier" + ], + "additionalProperties": false + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ], + "additionalProperties": false + }, + "dependabot-alert-security-advisory": { + "type": "object", + "description": "Details for the GitHub Security Advisory.", + "readOnly": true, + "properties": { + "ghsa_id": { + "type": "string", + "description": "The unique GitHub Security Advisory ID assigned to the advisory.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The unique CVE ID assigned to the advisory.", + "readOnly": true, + "nullable": true + }, + "summary": { + "type": "string", + "description": "A short, plain text summary of the advisory.", + "readOnly": true, + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A long-form Markdown-supported description of the advisory.", + "readOnly": true + }, + "vulnerabilities": { + "type": "array", + "description": "Vulnerable version range information for the advisory.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "readOnly": true, + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "classification": { + "type": "string", + "description": "The classification of the advisory.", + "readOnly": true, + "enum": [ + "general", + "malware" + ] + }, + "cvss": { + "type": "object", + "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.", + "readOnly": true, + "properties": { + "score": { + "type": "number", + "description": "The overall CVSS score of the advisory.", + "minimum": 0, + "maximum": 10, + "readOnly": true + }, + "vector_string": { + "type": "string", + "description": "The full CVSS vector string for the advisory.", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "score", + "vector_string" + ], + "additionalProperties": false + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "epss": { + "$ref": "#/components/schemas/security-advisory-epss" + }, + "cwes": { + "type": "array", + "description": "Details for the advisory pertaining to Common Weakness Enumeration.", + "readOnly": true, + "items": { + "type": "object", + "description": "A CWE weakness assigned to the advisory.", + "readOnly": true, + "properties": { + "cwe_id": { + "type": "string", + "description": "The unique CWE ID.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The short, plain text name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ], + "additionalProperties": false + } + }, + "identifiers": { + "type": "array", + "description": "Values that identify this advisory among security information sources.", + "readOnly": true, + "items": { + "type": "object", + "description": "An advisory identifier.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "description": "The type of advisory identifier.", + "readOnly": true, + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The value of the advisory identifer.", + "readOnly": true + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + } + }, + "references": { + "type": "array", + "description": "Links to additional advisory information.", + "readOnly": true, + "items": { + "type": "object", + "description": "A link to additional advisory information.", + "readOnly": true, + "properties": { + "url": { + "type": "string", + "description": "The URL of the reference.", + "format": "uri", + "readOnly": true + } + }, + "required": [ + "url" + ], + "additionalProperties": false + } + }, + "published_at": { + "type": "string", + "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "updated_at": { + "type": "string", + "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "withdrawn_at": { + "type": "string", + "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cvss", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ], + "additionalProperties": false, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "ghsa_id", + "cve_id", + "summary", + "description", + "vulnerabilities", + "severity", + "cwes", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "alert-url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "alert-html-url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true + }, + "alert-created-at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "alert-updated-at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "alert-dismissed-at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "alert-fixed-at": { + "type": "string", + "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "alert-auto-dismissed-at": { + "type": "string", + "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dependabot-alert-dismissal-request-simple": { + "title": "Dependabot alert dismissal request", + "description": "Information about an active dismissal request for this Dependabot alert.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the dismissal request." + }, + "status": { + "type": "string", + "description": "The current status of the dismissal request.", + "enum": [ + "pending", + "approved", + "rejected", + "cancelled" + ] + }, + "requester": { + "type": "object", + "description": "The user who requested the dismissal.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the user." + }, + "login": { + "type": "string", + "description": "The login name of the user." + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time when the dismissal request was created." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL to get more information about this dismissal request." + } + } + }, + "dependabot-alert-with-repository": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "$ref": "#/components/schemas/dependabot-alert-package" + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": "string", + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "nullable": true, + "enum": [ + "development", + "runtime" + ] + }, + "relationship": { + "type": "string", + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "nullable": true, + "enum": [ + "unknown", + "direct", + "transitive", + "inconclusive" + ] + } + } + }, + "security_advisory": { + "$ref": "#/components/schemas/dependabot-alert-security-advisory" + }, + "security_vulnerability": { + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" + }, + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" + }, + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "dismissed_reason": { + "type": "string", + "description": "The reason that the alert was dismissed.", + "nullable": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "An optional comment associated with the alert's dismissal.", + "nullable": true, + "maxLength": 280 + }, + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "auto_dismissed_at": { + "$ref": "#/components/schemas/alert-auto-dismissed-at" + }, + "dismissal_request": { + "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" + }, + "assignees": { + "type": "array", + "description": "The users assigned to this alert.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at", + "repository" + ], + "additionalProperties": false + }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "disabled | all" + }, + "organization_selection_type": { + "type": "string", + "example": "disabled | selected | all" + }, + "group_id": { + "nullable": true, + "type": "string", + "example": "62ab9291-fae2-468e-974b-7e45096d5021" + }, + "group_name": { + "nullable": true, + "type": "string", + "description": "Retired: this field will not be returned with GHEC enterprise teams.", + "example": "Justice League" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/dc/teams/justice-league" + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "name", + "html_url", + "slug", + "created_at", + "updated_at", + "group_id" + ] + }, + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "label": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the label.", + "type": "integer", + "format": "int64", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "description": "Optional description of the label, such as its purpose.", + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "description": "Whether this label comes by default in a new repository.", + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + }, + "discussion": { + "title": "Discussion", + "description": "A Discussion in a repository.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "answer_chosen_at": { + "type": "string", + "nullable": true + }, + "answer_chosen_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "answer_html_url": { + "type": "string", + "nullable": true + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "category": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "locked": { + "type": "boolean" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", + "enum": [ + "open", + "closed", + "locked", + "converting", + "transferring" + ] + }, + "state_reason": { + "description": "The reason for the current state", + "example": "resolved", + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "outdated", + "duplicate", + "reopened" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + } + }, + "required": [ + "repository_url", + "category", + "answer_html_url", + "answer_chosen_at", + "answer_chosen_by", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "state", + "state_reason", + "locked", + "comments", + "created_at", + "updated_at", + "active_lock_reason", + "body" + ] + }, + "nullable-milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "issue-type": { + "title": "Issue Type", + "description": "The type of issue.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue type." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue type." + }, + "name": { + "type": "string", + "description": "The name of the issue type." + }, + "description": { + "type": "string", + "description": "The description of the issue type.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the issue type.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue type created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue type last updated.", + "format": "date-time" + }, + "is_enabled": { + "type": "boolean", + "description": "The enabled state of the issue type." + } + }, + "required": [ + "id", + "node_id", + "name", + "description" + ] + }, + "nullable-integration": { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "owner": { + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/enterprise" + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", + "example": 5, + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ] + }, + "author-association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reaction-rollup": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "sub-issues-summary": { + "title": "Sub-issues Summary", + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "percent_completed": { + "type": "integer" + } + }, + "required": [ + "total", + "completed", + "percent_completed" + ] + }, + "nullable-pinned-issue-comment": { + "title": "Pinned Issue Comment", + "description": "Context around who pinned an issue comment and when it was pinned.", + "type": "object", + "properties": { + "pinned_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "pinned_by": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "pinned_at", + "pinned_by" + ], + "nullable": true + }, + "nullable-issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "issue-dependencies-summary": { + "title": "Issue Dependencies Summary", + "type": "object", + "properties": { + "blocked_by": { + "type": "integer" + }, + "blocking": { + "type": "integer" + }, + "total_blocked_by": { + "type": "integer" + }, + "total_blocking": { + "type": "integer" + } + }, + "required": [ + "blocked_by", + "blocking", + "total_blocked_by", + "total_blocking" + ] + }, + "issue-field-value": { + "title": "Issue Field Value", + "description": "A value assigned to an issue field", + "type": "object", + "properties": { + "issue_field_id": { + "description": "Unique identifier for the issue field.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "IFT_GDKND" + }, + "data_type": { + "description": "The data type of the issue field", + "type": "string", + "enum": [ + "text", + "single_select", + "number", + "date" + ], + "example": "text" + }, + "value": { + "description": "The value of the issue field", + "anyOf": [ + { + "type": "string", + "example": "Sample text" + }, + { + "type": "number", + "example": 42.5 + }, + { + "type": "integer", + "example": 1 + } + ], + "nullable": true + }, + "single_select_option": { + "description": "Details about the selected option (only present for single_select fields)", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the option.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "The name of the option", + "type": "string", + "example": "High" + }, + "color": { + "description": "The color of the option", + "type": "string", + "example": "red" + } + }, + "required": [ + "id", + "name", + "color" + ], + "nullable": true + } + }, + "required": [ + "issue_field_id", + "node_id", + "data_type", + "value" + ] + }, + "issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": "string", + "format": "uri", + "nullable": true + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "nullable": false + }, + "diff_url": { + "nullable": false + }, + "html_url": { + "nullable": false + }, + "patch_url": { + "nullable": false + }, + "url": { + "nullable": false + } + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "issue-comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "pull-request-minimal": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + }, + "release-asset": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "description": "The file name of the asset.", + "type": "string", + "example": "Team Environment" + }, + "label": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded", + "open" + ] + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "download_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "id", + "name", + "content_type", + "size", + "digest", + "state", + "url", + "node_id", + "download_count", + "label", + "uploader", + "browser_download_url", + "created_at", + "updated_at" + ] + }, + "release": { + "title": "Release", + "description": "A release.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "zipball_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "description": "The name of the tag.", + "example": "v1.0.0", + "type": "string" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "example": "master", + "type": "string" + }, + "name": { + "type": "string", + "nullable": true + }, + "body": { + "type": "string", + "nullable": true + }, + "draft": { + "description": "true to create a draft (unpublished) release, false to create a published one.", + "example": false, + "type": "boolean" + }, + "prerelease": { + "description": "Whether to identify the release as a prerelease or a full release.", + "example": false, + "type": "boolean" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "example": false, + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "published_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "author": { + "$ref": "#/components/schemas/simple-user" + }, + "assets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/release-asset" + } + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "mentions_count": { + "type": "integer" + }, + "discussion_url": { + "description": "The URL of the release discussion.", + "type": "string", + "format": "uri" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "assets_url", + "upload_url", + "tarball_url", + "zipball_url", + "created_at", + "published_at", + "draft", + "id", + "node_id", + "author", + "html_url", + "name", + "prerelease", + "tag_name", + "target_commitish", + "assets", + "url" + ] + }, + "event": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "nullable": true + }, + "actor": { + "$ref": "#/components/schemas/actor" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] + }, + "org": { + "$ref": "#/components/schemas/actor" + }, + "payload": { + "oneOf": [ + { + "$ref": "#/components/schemas/create-event" + }, + { + "$ref": "#/components/schemas/delete-event" + }, + { + "$ref": "#/components/schemas/discussion-event" + }, + { + "$ref": "#/components/schemas/issues-event" + }, + { + "$ref": "#/components/schemas/issue-comment-event" + }, + { + "$ref": "#/components/schemas/fork-event" + }, + { + "$ref": "#/components/schemas/gollum-event" + }, + { + "$ref": "#/components/schemas/member-event" + }, + { + "$ref": "#/components/schemas/public-event" + }, + { + "$ref": "#/components/schemas/push-event" + }, + { + "$ref": "#/components/schemas/pull-request-event" + }, + { + "$ref": "#/components/schemas/pull-request-review-comment-event" + }, + { + "$ref": "#/components/schemas/pull-request-review-event" + }, + { + "$ref": "#/components/schemas/commit-comment-event" + }, + { + "$ref": "#/components/schemas/release-event" + }, + { + "$ref": "#/components/schemas/watch-event" + } + ] + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] + }, + "link-with-type": { + "title": "Link With Type", + "description": "Hypermedia Link with Type", + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "href", + "type" + ] + }, + "feed": { + "title": "Feed", + "description": "Feed", + "type": "object", + "properties": { + "timeline_url": { + "type": "string", + "example": "https://github.com/timeline" + }, + "user_url": { + "type": "string", + "example": "https://github.com/{user}" + }, + "current_user_public_url": { + "type": "string", + "example": "https://github.com/octocat" + }, + "current_user_url": { + "type": "string", + "example": "https://github.com/octocat.private?token=abc123" + }, + "current_user_actor_url": { + "type": "string", + "example": "https://github.com/octocat.private.actor?token=abc123" + }, + "current_user_organization_url": { + "type": "string", + "example": "https://github.com/octocat-org" + }, + "current_user_organization_urls": { + "type": "array", + "example": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], + "items": { + "type": "string", + "format": "uri" + } + }, + "security_advisories_url": { + "type": "string", + "example": "https://github.com/security-advisories" + }, + "repository_discussions_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions", + "description": "A feed of discussions for a given repository." + }, + "repository_discussions_category_url": { + "type": "string", + "example": "https://github.com/{user}/{repo}/discussions/categories/{category}", + "description": "A feed of discussions for a given repository and category." + }, + "_links": { + "type": "object", + "properties": { + "timeline": { + "$ref": "#/components/schemas/link-with-type" + }, + "user": { + "$ref": "#/components/schemas/link-with-type" + }, + "security_advisories": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_public": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_actor": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_organization": { + "$ref": "#/components/schemas/link-with-type" + }, + "current_user_organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/link-with-type" + } + }, + "repository_discussions": { + "$ref": "#/components/schemas/link-with-type" + }, + "repository_discussions_category": { + "$ref": "#/components/schemas/link-with-type" + } + }, + "required": [ + "timeline", + "user" + ] + } + }, + "required": [ + "_links", + "timeline_url", + "user_url" + ] + }, + "base-gist": { + "title": "Base Gist", + "description": "Base Gist", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string", + "format": "uri" + }, + "git_push_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": {} + }, + "history": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "user": null + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "files", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_forks_history_from_base_gist", + "patch": [ + { + "op": "remove", + "path": "/properties/forks" + }, + { + "op": "remove", + "path": "/properties/history" + } + ], + "version": "2026-03-10" + } + ] + }, + "public-user": { + "title": "Public User", + "description": "Public User", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "company": { + "type": "string", + "nullable": true + }, + "blog": { + "type": "string", + "nullable": true + }, + "location": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "format": "email", + "nullable": true + }, + "notification_email": { + "type": "string", + "format": "email", + "nullable": true + }, + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { + "type": "string", + "nullable": true + }, + "twitter_username": { + "type": "string", + "nullable": true + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "private_gists": { + "type": "integer", + "example": 1 + }, + "total_private_repos": { + "type": "integer", + "example": 2 + }, + "owned_private_repos": { + "type": "integer", + "example": 2 + }, + "disk_usage": { + "type": "integer", + "example": 1 + }, + "collaborators": { + "type": "integer", + "example": 3 + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at" + ], + "additionalProperties": false + }, + "gist-history": { + "title": "Gist History", + "description": "Gist History", + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "version": { + "type": "string" + }, + "committed_at": { + "type": "string", + "format": "date-time" + }, + "change_status": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "gist-simple": { + "title": "Gist Simple", + "description": "Gist Simple", + "type": "object", + "properties": { + "forks": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/public-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "history": { + "deprecated": true, + "nullable": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/gist-history" + } + }, + "fork_of": { + "nullable": true, + "title": "Gist", + "description": "Gist", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string", + "format": "uri" + }, + "git_push_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "files": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": {} + }, + "history": { + "type": "array", + "items": {} + } + }, + "required": [ + "id", + "node_id", + "url", + "forks_url", + "commits_url", + "git_pull_url", + "git_push_url", + "html_url", + "comments_url", + "public", + "description", + "comments", + "user", + "files", + "created_at", + "updated_at" + ] + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "additionalProperties": { + "nullable": true, + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_enabled": { + "type": "boolean" + }, + "user": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "truncated": { + "type": "boolean" + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_forks_history_from_base_gist", + "patch": [ + { + "op": "remove", + "path": "/properties/forks" + }, + { + "op": "remove", + "path": "/properties/history" + } + ], + "version": "2026-03-10" + } + ] + }, + "gist-comment": { + "title": "Gist Comment", + "description": "A comment made to a gist.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOkdpc3RDb21tZW50MQ==" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1" + }, + "body": { + "description": "The comment text.", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-18T23:23:56Z" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "url", + "id", + "node_id", + "user", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "gist-commit": { + "title": "Gist Commit", + "description": "Gist Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "version": { + "type": "string", + "example": "57a7f021a713b1c5a6a199b54cc514735d2d462f" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "change_status": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + } + } + }, + "committed_at": { + "type": "string", + "format": "date-time", + "example": "2010-04-14T02:15:15Z" + } + }, + "required": [ + "url", + "user", + "version", + "committed_at", + "change_status" + ] + }, + "gitignore-template": { + "title": "Gitignore Template", + "description": "Gitignore Template", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "C" + }, + "source": { + "type": "string", + "example": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "required": [ + "name", + "source" + ] + }, + "license-simple": { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + }, + "license": { + "title": "License", + "description": "License", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "spdx_id": { + "type": "string", + "example": "MIT", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/licenses/mit", + "nullable": true + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "http://choosealicense.com/licenses/mit/" + }, + "description": { + "type": "string", + "example": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty." + }, + "implementation": { + "type": "string", + "example": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders." + }, + "permissions": { + "type": "array", + "example": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "items": { + "type": "string" + } + }, + "conditions": { + "type": "array", + "example": [ + "include-copyright" + ], + "items": { + "type": "string" + } + }, + "limitations": { + "type": "array", + "example": [ + "no-liability" + ], + "items": { + "type": "string" + } + }, + "body": { + "type": "string", + "example": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" + }, + "featured": { + "type": "boolean", + "example": true + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id", + "html_url", + "description", + "implementation", + "permissions", + "conditions", + "limitations", + "body", + "featured" + ] + }, + "marketplace-listing-plan": { + "title": "Marketplace Listing Plan", + "description": "Marketplace Listing Plan", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313" + }, + "accounts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/marketplace_listing/plans/1313/accounts" + }, + "id": { + "type": "integer", + "example": 1313 + }, + "number": { + "type": "integer", + "example": 3 + }, + "name": { + "type": "string", + "example": "Pro" + }, + "description": { + "type": "string", + "example": "A professional-grade CI solution" + }, + "monthly_price_in_cents": { + "type": "integer", + "example": 1099 + }, + "yearly_price_in_cents": { + "type": "integer", + "example": 11870 + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ], + "example": "FLAT_RATE" + }, + "has_free_trial": { + "type": "boolean", + "example": true + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string", + "example": "published" + }, + "bullets": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + }, + "required": [ + "url", + "accounts_url", + "id", + "number", + "name", + "description", + "has_free_trial", + "price_model", + "unit_name", + "monthly_price_in_cents", + "state", + "yearly_price_in_cents", + "bullets" + ] + }, + "marketplace-purchase": { + "title": "Marketplace Purchase", + "description": "Marketplace Purchase", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "organization_billing_email": { + "type": "string" + }, + "email": { + "type": "string", + "nullable": true + }, + "marketplace_pending_change": { + "type": "object", + "properties": { + "is_installed": { + "type": "boolean" + }, + "effective_date": { + "type": "string" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "id": { + "type": "integer" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "nullable": true + }, + "marketplace_purchase": { + "type": "object", + "properties": { + "billing_cycle": { + "type": "string" + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "is_installed": { + "type": "boolean" + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + } + } + }, + "required": [ + "url", + "id", + "type", + "login", + "marketplace_purchase" + ] + }, + "api-overview": { + "title": "Api Overview", + "description": "Api Overview", + "type": "object", + "properties": { + "verifiable_password_authentication": { + "type": "boolean", + "example": true + }, + "ssh_key_fingerprints": { + "type": "object", + "properties": { + "SHA256_RSA": { + "type": "string" + }, + "SHA256_DSA": { + "type": "string" + }, + "SHA256_ECDSA": { + "type": "string" + }, + "SHA256_ED25519": { + "type": "string" + } + } + }, + "ssh_keys": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" + ] + }, + "hooks": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "github_enterprise_importer": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "web": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "api": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "git": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "packages": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "pages": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "importer": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "actions_macos": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "codespaces": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "dependabot": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "copilot": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "192.0.2.1" + ] + }, + "domains": { + "type": "object", + "properties": { + "website": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "codespaces": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "copilot": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "packages": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "actions": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "actions_inbound": { + "type": "object", + "properties": { + "full_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + }, + "wildcard_domains": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + }, + "artifact_attestations": { + "type": "object", + "properties": { + "trust_domain": { + "type": "string", + "example": [ + "example" + ] + }, + "services": { + "type": "array", + "items": { + "type": "string", + "example": [ + "example.com" + ] + } + } + } + } + } + } + }, + "required": [ + "verifiable_password_authentication" + ] + }, + "security-and-analysis": { + "nullable": true, + "type": "object", + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + }, + "mode": { + "type": "string", + "description": "The bypass mode for the reviewer", + "enum": [ + "ALWAYS", + "EXEMPT" + ], + "default": "ALWAYS" + } + } + } + } + } + } + } + }, + "minimal-repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "$ref": "#/components/schemas/code-of-conduct" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + } + }, + "version": "2026-03-10" + } + ] + }, + "thread": { + "title": "Thread", + "description": "Thread", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "subject": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "latest_comment_url": { + "type": "string" + }, + "type": { + "type": "string" + } + }, + "required": [ + "title", + "url", + "latest_comment_url", + "type" + ] + }, + "reason": { + "type": "string" + }, + "unread": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "last_read_at": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string" + }, + "subscription_url": { + "type": "string", + "example": "https://api.github.com/notifications/threads/2/subscription" + } + }, + "required": [ + "id", + "unread", + "reason", + "updated_at", + "last_read_at", + "subject", + "repository", + "url", + "subscription_url" + ] + }, + "thread-subscription": { + "title": "Thread Subscription", + "description": "Thread Subscription", + "type": "object", + "properties": { + "subscribed": { + "type": "boolean", + "example": true + }, + "ignored": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-10-06T21:34:12Z", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/notifications/threads/1/subscription" + }, + "thread_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/notifications/threads/1" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/1" + } + }, + "required": [ + "created_at", + "ignored", + "reason", + "url", + "subscribed" + ] + }, + "actions-cache-retention-limit-for-organization": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "example": 14 + } + } + }, + "actions-cache-storage-limit-for-organization": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "example": 10 + } + } + }, + "nullable-simple-repository": { + "title": "Simple Repository", + "description": "A GitHub repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "description": "The GraphQL identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World", + "description": "The URL to view the repository on GitHub.com." + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true, + "description": "The repository description." + }, + "fork": { + "type": "boolean", + "description": "Whether the repository is a fork." + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World", + "description": "The URL to get more information about the repository from the GitHub API." + }, + "archive_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "description": "A template for the API URL to download the repository as an archive." + }, + "assignees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "description": "A template for the API URL to list the available assignees for issues in the repository." + }, + "blobs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git blob in the repository." + }, + "branches_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "description": "A template for the API URL to get information about branches in the repository." + }, + "collaborators_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "description": "A template for the API URL to get information about collaborators of the repository." + }, + "comments_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "description": "A template for the API URL to get information about comments on the repository." + }, + "commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "description": "A template for the API URL to get information about commits on the repository." + }, + "compare_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "description": "A template for the API URL to compare two commits or refs." + }, + "contents_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "description": "A template for the API URL to get the contents of the repository." + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contributors", + "description": "A template for the API URL to list the contributors to the repository." + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/deployments", + "description": "The API URL to list the deployments of the repository." + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/downloads", + "description": "The API URL to list the downloads on the repository." + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/events", + "description": "The API URL to list the events of the repository." + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/forks", + "description": "The API URL to list the forks of the repository." + }, + "git_commits_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "description": "A template for the API URL to get information about Git commits of the repository." + }, + "git_refs_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "description": "A template for the API URL to get information about Git refs of the repository." + }, + "git_tags_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "description": "A template for the API URL to get information about Git tags of the repository." + }, + "issue_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "description": "A template for the API URL to get information about issue comments on the repository." + }, + "issue_events_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "description": "A template for the API URL to get information about issue events on the repository." + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "description": "A template for the API URL to get information about issues on the repository." + }, + "keys_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "description": "A template for the API URL to get information about deploy keys on the repository." + }, + "labels_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "description": "A template for the API URL to get information about labels of the repository." + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/languages", + "description": "The API URL to get information about the languages of the repository." + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/merges", + "description": "The API URL to merge branches in the repository." + }, + "milestones_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "description": "A template for the API URL to get information about milestones of the repository." + }, + "notifications_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "description": "A template for the API URL to get information about notifications on the repository." + }, + "pulls_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "description": "A template for the API URL to get information about pull requests on the repository." + }, + "releases_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "description": "A template for the API URL to get information about releases on the repository." + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "description": "The API URL to list the stargazers on the repository." + }, + "statuses_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "description": "A template for the API URL to get information about statuses of a commit." + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "description": "The API URL to list the subscribers on the repository." + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/subscription", + "description": "The API URL to subscribe to notifications for this repository." + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tags", + "description": "The API URL to get information about tags on the repository." + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/teams", + "description": "The API URL to list the teams on the repository." + }, + "trees_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "description": "A template for the API URL to create or retrieve a raw Git tree of the repository." + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks", + "description": "The API URL to list the hooks on the repository." + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "nullable": true + }, + "dependabot-repository-access-details": { + "title": "Dependabot Repository Access Details", + "description": "Information about repositories that Dependabot is able to access in an organization", + "type": "object", + "properties": { + "default_level": { + "type": "string", + "description": "The default repository access level for Dependabot updates.", + "enum": [ + "public", + "internal" + ], + "example": "internal", + "nullable": true + }, + "accessible_repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/nullable-simple-repository" + } + } + }, + "additionalProperties": false + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "SkuPricing" + ] + }, + { + "type": "string", + "enum": [ + "ProductPricing" + ] + } + ] + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "The type of limit enforcement for the budget", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "octocat/hello-world" + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to." + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + }, + "required": [ + "will_alert", + "alert_recipients" + ] + } + }, + "required": [ + "id", + "budget_type", + "budget_product_sku", + "budget_scope", + "budget_amount", + "prevent_further_usage", + "budget_alerting" + ] + }, + "get_all_budgets": { + "type": "object", + "properties": { + "budgets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/budget" + }, + "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" + }, + "total_count": { + "type": "integer", + "description": "Total number of budgets matching the query" + } + }, + "required": [ + "budgets" + ] + }, + "get-budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "octocat/hello-world" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + }, + "required": [ + "id", + "budget_amount", + "prevent_further_usage", + "budget_product_sku", + "budget_type", + "budget_alerting", + "budget_scope", + "budget_entity_name" + ] + }, + "delete-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the deletion operation" + }, + "id": { + "type": "string", + "description": "The ID of the deleted budget" + } + }, + "required": [ + "message", + "id" + ] + }, + "billing-premium-request-usage-report-org": { + "type": "object", + "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "organization": { + "type": "string", + "description": "The unique identifier of the organization." + }, + "user": { + "type": "string", + "description": "The name of the user for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "model": { + "type": "string", + "description": "The model for the usage report." + }, + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "model": { + "type": "string", + "description": "Model name." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + } + }, + "required": [ + "product", + "sku", + "model", + "unitType", + "pricePerUnit", + "grossQuantity", + "grossAmount", + "discountQuantity", + "discountAmount", + "netQuantity", + "netAmount" + ] + } + } + }, + "required": [ + "timePeriod", + "organization", + "usageItems" + ] + }, + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, + "billing-usage-summary-report-org": { + "type": "object", + "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "organization": { + "type": "string", + "description": "The unique identifier of the organization." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + } + }, + "required": [ + "product", + "sku", + "unitType", + "pricePerUnit", + "grossQuantity", + "grossAmount", + "discountQuantity", + "discountAmount", + "netQuantity", + "netAmount" + ] + } + } + }, + "required": [ + "timePeriod", + "organization", + "usageItems" + ] + }, + "organization-full": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + }, + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true, + "description": "The number of collaborators on private repositories.\n\nThis field may be null if the number of private repositories is over 50,000." + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "default_repository_branch": { + "type": "string", + "example": "main", + "nullable": true, + "description": "The default branch for repositories created in this organization." + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_delete_repositories": { + "type": "boolean", + "example": true + }, + "members_can_change_repo_visibility": { + "type": "boolean", + "example": true + }, + "members_can_invite_outside_collaborators": { + "type": "boolean", + "example": true + }, + "members_can_delete_issues": { + "type": "boolean", + "example": true + }, + "display_commenter_full_name_setting_enabled": { + "type": "boolean", + "example": true + }, + "readers_can_create_discussions": { + "type": "boolean", + "example": true + }, + "members_can_create_teams": { + "type": "boolean", + "example": true + }, + "members_can_view_dependency_insights": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "advanced_security_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true + }, + "dependabot_alerts_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true + }, + "dependabot_security_updates_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true + }, + "dependency_graph_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true + }, + "secret_scanning_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true + }, + "secret_scanning_push_protection_enabled_for_new_repositories": { + "type": "boolean", + "example": false, + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "deprecated": true + }, + "secret_scanning_push_protection_custom_link_enabled": { + "type": "boolean", + "example": false, + "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection." + }, + "secret_scanning_push_protection_custom_link": { + "type": "string", + "example": "https://github.com/test-org/test-repo/blob/main/README.md", + "nullable": true, + "description": "An optional URL string to display to contributors who are blocked from pushing a secret." + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "deploy_keys_enabled_for_repositories": { + "type": "boolean", + "example": false, + "description": "Controls whether or not deploy keys may be added and used for repositories in the organization." + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_secret_scanning_custom_link_enablement_field", + "patch": [ + { + "op": "remove", + "path": "/properties/secret_scanning_push_protection_custom_link_enabled" + } + ], + "version": "2026-03-10" + } + ] + }, + "actions-cache-usage-org-enterprise": { + "type": "object", + "properties": { + "total_active_caches_count": { + "type": "integer", + "description": "The count of active caches across all repositories of an enterprise or an organization." + }, + "total_active_caches_size_in_bytes": { + "type": "integer", + "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization." + } + }, + "required": [ + "total_active_caches_count", + "total_active_caches_size_in_bytes" + ] + }, + "actions-cache-usage-by-repository": { + "title": "Actions Cache Usage by repository", + "description": "GitHub Actions Cache Usage by repository.", + "type": "object", + "properties": { + "full_name": { + "description": "The repository owner and name for the cache usage being shown.", + "type": "string", + "example": "octo-org/Hello-World" + }, + "active_caches_size_in_bytes": { + "description": "The sum of the size in bytes of all the active cache items in the repository.", + "type": "integer", + "example": 2322142 + }, + "active_caches_count": { + "description": "The number of active caches in the repository.", + "type": "integer", + "example": 3 + } + }, + "required": [ + "full_name", + "active_caches_size_in_bytes", + "active_caches_count" + ] + }, + "nullable-actions-hosted-runner-pool-image": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + }, + "version": { + "description": "The image version of the hosted runner pool.", + "type": "string", + "example": "latest" + } + }, + "required": [ + "id", + "size_gb", + "display_name", + "source" + ], + "nullable": true + }, + "actions-hosted-runner-machine-spec": { + "title": "Github-owned VM details.", + "description": "Provides details of a particular machine spec.", + "type": "object", + "properties": { + "id": { + "description": "The ID used for the `size` parameter when creating a new runner.", + "type": "string", + "example": "8-core" + }, + "cpu_cores": { + "description": "The number of cores.", + "type": "integer", + "example": 8 + }, + "memory_gb": { + "description": "The available RAM for the machine spec.", + "type": "integer", + "example": 32 + }, + "storage_gb": { + "description": "The available SSD storage for the machine spec.", + "type": "integer", + "example": 300 + } + }, + "required": [ + "id", + "cpu_cores", + "memory_gb", + "storage_gb" + ] + }, + "public-ip": { + "title": "Public IP for a GitHub-hosted larger runners.", + "description": "Provides details of Public IP for a GitHub-hosted larger runners", + "type": "object", + "properties": { + "enabled": { + "description": "Whether public IP is enabled.", + "type": "boolean", + "example": true + }, + "prefix": { + "description": "The prefix for the public IP.", + "type": "string", + "example": "20.80.208.150" + }, + "length": { + "description": "The length of the IP prefix.", + "type": "integer", + "example": 28 + } + } + }, + "actions-hosted-runner": { + "title": "GitHub-hosted hosted runner", + "description": "A Github-hosted hosted runner.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the hosted runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the hosted runner.", + "type": "string", + "example": "my-github-hosted-runner" + }, + "runner_group_id": { + "description": "The unique identifier of the group that the hosted runner belongs to.", + "type": "integer", + "example": 2 + }, + "image_details": { + "$ref": "#/components/schemas/nullable-actions-hosted-runner-pool-image" + }, + "machine_size_details": { + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "Ready", + "enum": [ + "Ready", + "Provisioning", + "Shutdown", + "Deleting", + "Stuck" + ] + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "maximum_runners": { + "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.", + "type": "integer", + "default": 10, + "example": 5 + }, + "public_ip_enabled": { + "description": "Whether public IP is enabled for the hosted runners.", + "type": "boolean", + "example": true + }, + "public_ips": { + "description": "The public IP ranges when public IP is enabled for the hosted runners.", + "type": "array", + "items": { + "$ref": "#/components/schemas/public-ip" + } + }, + "last_active_on": { + "description": "The time at which the runner was last used, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2022-10-09T23:39:01Z", + "nullable": true + }, + "image_gen": { + "type": "boolean", + "description": "Whether custom image generation is enabled for the hosted runners." + } + }, + "required": [ + "id", + "name", + "image_details", + "machine_size_details", + "status", + "public_ip_enabled", + "platform" + ] + }, + "actions-hosted-runner-custom-image": { + "title": "GitHub-hosted runner custom image details", + "description": "Provides details of a custom runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "integer", + "example": 1 + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "total_versions_size": { + "description": "Total size of all the image versions in GB.", + "type": "integer", + "example": 200 + }, + "name": { + "description": "Display name for this image.", + "type": "string", + "example": "CustomImage" + }, + "source": { + "description": "The image provider.", + "type": "string", + "example": "custom" + }, + "versions_count": { + "description": "The number of image versions associated with the image.", + "type": "integer", + "example": 4 + }, + "latest_version": { + "description": "The latest image version associated with the image.", + "type": "string", + "example": "1.3.0" + }, + "state": { + "description": "The number of image versions associated with the image.", + "type": "string", + "example": "Ready" + } + }, + "required": [ + "id", + "platform", + "name", + "source", + "versions_count", + "total_versions_size", + "latest_version", + "state" + ] + }, + "actions-hosted-runner-custom-image-version": { + "title": "GitHub-hosted runner custom image version details.", + "description": "Provides details of a hosted runner custom image version", + "type": "object", + "properties": { + "version": { + "description": "The version of image.", + "type": "string", + "example": "1.0.0" + }, + "state": { + "description": "The state of image version.", + "type": "string", + "example": "Ready" + }, + "size_gb": { + "description": "Image version size in GB.", + "type": "integer", + "example": 30 + }, + "created_on": { + "description": "The creation date time of the image version.", + "type": "string", + "example": "2024-11-09T23:39:01Z" + }, + "state_details": { + "description": "The image version status details.", + "type": "string", + "example": "None" + } + }, + "required": [ + "version", + "state", + "size_gb", + "created_on", + "state_details" + ] + }, + "actions-hosted-runner-curated-image": { + "title": "GitHub-hosted runner image details.", + "description": "Provides details of a hosted runner image", + "type": "object", + "properties": { + "id": { + "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner.", + "type": "string", + "example": "ubuntu-20.04" + }, + "platform": { + "description": "The operating system of the image.", + "type": "string", + "example": "linux-x64" + }, + "size_gb": { + "description": "Image size in GB.", + "type": "integer", + "example": 86 + }, + "display_name": { + "description": "Display name for this image.", + "type": "string", + "example": 20.04 + }, + "source": { + "description": "The image provider.", + "type": "string", + "enum": [ + "github", + "partner", + "custom" + ] + } + }, + "required": [ + "id", + "platform", + "size_gb", + "display_name", + "source" + ] + }, + "actions-hosted-runner-limits": { + "type": "object", + "properties": { + "public_ips": { + "title": "Static public IP Limits for GitHub-hosted Hosted Runners.", + "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners", + "type": "object", + "properties": { + "maximum": { + "type": "integer", + "description": "The maximum number of static public IP addresses that can be used for Hosted Runners.", + "example": 50 + }, + "current_usage": { + "type": "integer", + "description": "The current number of static public IP addresses in use by Hosted Runners.", + "example": 17 + } + }, + "required": [ + "maximum", + "current_usage" + ] + } + }, + "required": [ + "public_ips" + ] + }, + "oidc-custom-sub": { + "title": "Actions OIDC Subject customization", + "description": "Actions OIDC Subject customization", + "type": "object", + "properties": { + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "include_claim_keys" + ] + }, + "empty-object": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + }, + "enabled-repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed-actions": { + "type": "string", + "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected-actions-url": { + "type": "string", + "description": "The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`." + }, + "sha-pinning-required": { + "type": "boolean", + "description": "Whether actions must be pinned to a full-length commit SHA." + }, + "actions-organization-permissions": { + "type": "object", + "properties": { + "enabled_repositories": { + "$ref": "#/components/schemas/enabled-repositories" + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + }, + "sha_pinning_required": { + "$ref": "#/components/schemas/sha-pinning-required" + } + }, + "required": [ + "enabled_repositories" + ] + }, + "actions-artifact-and-log-retention-response": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days artifacts and logs are retained" + }, + "maximum_allowed_days": { + "type": "integer", + "description": "The maximum number of days that can be configured" + } + }, + "required": [ + "days", + "maximum_allowed_days" + ] + }, + "actions-artifact-and-log-retention": { + "type": "object", + "properties": { + "days": { + "type": "integer", + "description": "The number of days to retain artifacts and logs" + } + }, + "required": [ + "days" + ] + }, + "actions-fork-pr-contributor-approval": { + "type": "object", + "properties": { + "approval_policy": { + "type": "string", + "enum": [ + "first_time_contributors_new_to_github", + "first_time_contributors", + "all_external_contributors" + ], + "description": "The policy that controls when fork PR workflows require approval from a maintainer." + } + }, + "required": [ + "approval_policy" + ] + }, + "actions-fork-pr-workflows-private-repos": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests", + "send_write_tokens_to_workflows", + "send_secrets_and_variables", + "require_approval_for_fork_pr_workflows" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, + "actions-fork-pr-workflows-private-repos-request": { + "type": "object", + "required": [ + "run_workflows_from_fork_pull_requests" + ], + "properties": { + "run_workflows_from_fork_pull_requests": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories." + }, + "send_write_tokens_to_workflows": { + "type": "boolean", + "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request." + }, + "send_secrets_and_variables": { + "type": "boolean", + "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks." + }, + "require_approval_for_fork_pr_workflows": { + "type": "boolean", + "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run." + } + } + }, + "selected-actions": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\n\n> [!NOTE]\n> The `patterns_allowed` setting only applies to public repositories.", + "items": { + "type": "string" + } + } + } + }, + "self-hosted-runners-settings": { + "type": "object", + "required": [ + "enabled_repositories" + ], + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls whether self-hosted runners can be used by repositories in the organization", + "enum": [ + "all", + "selected", + "none" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The URL to the endpoint for managing selected repositories for self-hosted runners in the organization" + } + } + }, + "actions-default-workflow-permissions": { + "type": "string", + "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.", + "enum": [ + "read", + "write" + ] + }, + "actions-can-approve-pull-request-reviews": { + "type": "boolean", + "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk." + }, + "actions-get-default-workflow-permissions": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "$ref": "#/components/schemas/actions-default-workflow-permissions" + }, + "can_approve_pull_request_reviews": { + "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" + } + }, + "required": [ + "default_workflow_permissions", + "can_approve_pull_request_reviews" + ] + }, + "actions-set-default-workflow-permissions": { + "type": "object", + "properties": { + "default_workflow_permissions": { + "$ref": "#/components/schemas/actions-default-workflow-permissions" + }, + "can_approve_pull_request_reviews": { + "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews" + } + } + }, + "runner-groups-org": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "network_configuration_id": { + "description": "The identifier of a hosted compute network configuration.", + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "example": "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + }, + "runner-label": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + }, + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The ID of the runner.", + "type": "integer", + "example": 5 + }, + "runner_group_id": { + "description": "The ID of the runner group.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-label" + } + }, + "ephemeral": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "runner-application": { + "title": "Runner Application", + "description": "Runner Application", + "type": "object", + "properties": { + "os": { + "type": "string" + }, + "architecture": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "filename": { + "type": "string" + }, + "temp_download_token": { + "description": "A short lived bearer token used to download the runner, if needed.", + "type": "string" + }, + "sha256_checksum": { + "type": "string" + } + }, + "required": [ + "os", + "architecture", + "download_url", + "filename" + ] + }, + "authentication-token": { + "title": "Authentication Token", + "description": "Authentication Token", + "type": "object", + "properties": { + "token": { + "description": "The token used for authentication", + "type": "string", + "example": "v1.1f699f1069f60xxx" + }, + "expires_at": { + "description": "The time this token expires", + "type": "string", + "format": "date-time", + "example": "2016-07-11T22:14:10Z" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + } + }, + "repositories": { + "description": "The repositories this token has access to", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "single_file": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + } + }, + "required": [ + "token", + "expires_at" + ] + }, + "organization-actions-secret": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "actions-public-key": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "organization-actions-variable": { + "title": "Actions Variable for an Organization", + "description": "Organization variable for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "example": "USERNAME", + "type": "string" + }, + "value": { + "description": "The value of the variable.", + "example": "octocat", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "example": "2019-01-24T22:45:36.000Z", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a variable", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/variables/USERNAME/repositories" + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at", + "visibility" + ] + }, + "artifact-deployment-record": { + "title": "Artifact Deployment Record", + "description": "Artifact Metadata Deployment Record", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "digest": { + "type": "string" + }, + "logical_environment": { + "type": "string" + }, + "physical_environment": { + "type": "string" + }, + "cluster": { + "type": "string" + }, + "deployment_name": { + "type": "string" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "runtime_risks": { + "type": "array", + "description": "A list of runtime risks associated with the deployment.", + "maxItems": 4, + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "critical-resource", + "internet-exposed", + "lateral-movement", + "sensitive-data" + ] + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "attestation_id": { + "type": "integer", + "description": "The ID of the provenance attestation associated with the deployment record.", + "nullable": true + } + } + }, + "campaign-state": { + "title": "Campaign state", + "description": "Indicates whether a campaign is open or closed", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "campaign-alert-type": { + "title": "Campaign alert type", + "description": "Indicates the alert type of a campaign", + "type": "string", + "enum": [ + "code_scanning", + "secret_scanning" + ] + }, + "nullable-team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ], + "nullable": true + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent", + "type" + ] + }, + "campaign-summary": { + "title": "Campaign summary", + "description": "The campaign metadata and alert stats.", + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The number of the newly created campaign" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "name": { + "type": "string", + "description": "The campaign name" + }, + "description": { + "type": "string", + "description": "The campaign description" + }, + "managers": { + "description": "The campaign managers", + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "team_managers": { + "description": "The campaign team managers", + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "published_at": { + "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "ends_at": { + "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "closed_at": { + "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.", + "type": "string", + "format": "date-time", + "nullable": true + }, + "state": { + "$ref": "#/components/schemas/campaign-state" + }, + "contact_link": { + "description": "The contact link of the campaign.", + "type": "string", + "format": "uri", + "nullable": true + }, + "alert_stats": { + "type": "object", + "additionalProperties": false, + "properties": { + "open_count": { + "type": "integer", + "description": "The number of open alerts" + }, + "closed_count": { + "type": "integer", + "description": "The number of closed alerts" + }, + "in_progress_count": { + "type": "integer", + "description": "The number of in-progress alerts" + } + }, + "required": [ + "open_count", + "closed_count", + "in_progress_count" + ] + } + }, + "required": [ + "number", + "created_at", + "updated_at", + "description", + "managers", + "ends_at", + "state", + "contact_link" + ] + }, + "code-scanning-analysis-tool-name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "code-scanning-analysis-tool-guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + }, + "code-scanning-alert-state-query": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "closed", + "dismissed", + "fixed" + ] + }, + "code-scanning-alert-severity": { + "type": "string", + "description": "Severity of a code scanning alert.", + "enum": [ + "critical", + "high", + "medium", + "low", + "warning", + "note", + "error" + ] + }, + "alert-instances-url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true + }, + "code-scanning-alert-state": { + "type": "string", + "description": "State of a code scanning alert.", + "nullable": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "code-scanning-alert-dismissed-reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + "code-scanning-alert-dismissed-comment": { + "type": "string", + "description": "The dismissal comment associated with the dismissal of the alert.", + "nullable": true, + "maxLength": 280 + }, + "code-scanning-alert-rule-summary": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "security_severity_level": { + "nullable": true, + "type": "string", + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "code-scanning-analysis-tool-version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "code-scanning-analysis-tool": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" + }, + "version": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-version" + }, + "guid": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + } + } + }, + "code-scanning-ref": { + "type": "string", + "description": "The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,\n`refs/heads/` or simply ``." + }, + "code-scanning-analysis-analysis-key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "code-scanning-alert-environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code." + }, + "code-scanning-alert-location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "code-scanning-alert-classification": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + }, + "code-scanning-alert-instance": { + "type": "object", + "properties": { + "ref": { + "$ref": "#/components/schemas/code-scanning-ref" + }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + }, + "environment": { + "$ref": "#/components/schemas/code-scanning-alert-environment" + }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "markdown": { + "type": "string", + "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance." + } + } + }, + "location": { + "$ref": "#/components/schemas/code-scanning-alert-location" + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "$ref": "#/components/schemas/code-scanning-alert-classification" + } + } + } + }, + "code-scanning-organization-alert-items": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "instances_url": { + "$ref": "#/components/schemas/alert-instances-url" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" + }, + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "rule": { + "$ref": "#/components/schemas/code-scanning-alert-rule-summary" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis-tool" + }, + "most_recent_instance": { + "$ref": "#/components/schemas/code-scanning-alert-instance" + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "dismissal_approved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance", + "repository" + ] + }, + "nullable-codespace-machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ], + "nullable": true + }, + "codespace": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "billable_owner": { + "$ref": "#/components/schemas/simple-user" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "machine": { + "$ref": "#/components/schemas/nullable-codespace-machine" + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": "string", + "example": ".devcontainer/example/devcontainer.json", + "nullable": true + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": "string", + "format": "date-time", + "example": "2011-01-26T20:01:12Z", + "nullable": true + }, + "last_known_stop_notice": { + "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason.", + "type": "string", + "example": "you've used 100% of your spending limit for Codespaces", + "nullable": true + } + }, + "required": [ + "id", + "name", + "environment_id", + "owner", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" + ] + }, + "codespaces-org-secret": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "codespaces-public-key": { + "title": "CodespacesPublicKey", + "description": "The public key used for setting Codespaces secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "copilot-organization-seat-breakdown": { + "title": "Copilot Seat Breakdown", + "description": "The breakdown of Copilot Business seats for the organization.", + "type": "object", + "properties": { + "total": { + "type": "integer", + "description": "The total number of seats being billed for the organization as of the current billing cycle." + }, + "added_this_cycle": { + "type": "integer", + "description": "Seats added during the current billing cycle." + }, + "pending_cancellation": { + "type": "integer", + "description": "The number of seats that are pending cancellation at the end of the current billing cycle." + }, + "pending_invitation": { + "type": "integer", + "description": "The number of users who have been invited to receive a Copilot seat through this organization." + }, + "active_this_cycle": { + "type": "integer", + "description": "The number of seats that have used Copilot during the current billing cycle." + }, + "inactive_this_cycle": { + "type": "integer", + "description": "The number of seats that have not used Copilot during the current billing cycle." + } + } + }, + "copilot-organization-details": { + "title": "Copilot Organization Details", + "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.", + "type": "object", + "properties": { + "seat_breakdown": { + "$ref": "#/components/schemas/copilot-organization-seat-breakdown" + }, + "public_code_suggestions": { + "type": "string", + "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).", + "enum": [ + "allow", + "block", + "unconfigured" + ] + }, + "ide_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "platform_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "cli": { + "type": "string", + "description": "The organization policy for allowing or disallowing Copilot CLI.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, + "seat_management_setting": { + "type": "string", + "description": "The mode of assigning new seats.", + "enum": [ + "assign_all", + "assign_selected", + "disabled", + "unconfigured" + ] + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise" + ] + } + }, + "required": [ + "seat_breakdown", + "public_code_suggestions", + "seat_management_setting" + ], + "additionalProperties": true + }, + "nullable-organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ], + "nullable": true + }, + "copilot-seat-details": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "organization": { + "$ref": "#/components/schemas/nullable-organization-simple" + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" + } + ], + "nullable": true + }, + "pending_cancellation_date": { + "type": "string", + "format": "date", + "nullable": true, + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": "string", + "nullable": true, + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "last_authenticated_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "created_at" + ], + "additionalProperties": false + }, + "copilot-organization-content-exclusion-details": { + "title": "Copilot Organization Content Exclusion Details", + "description": "List all Copilot Content Exclusion rules for an organization.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "The path to the file that will be excluded." + } + } + }, + "copilot-ide-code-completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": "object", + "description": "Usage metrics for Copilot Chat in GitHub.com", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": "object", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": "string", + "nullable": true, + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, + "organization-dependabot-secret": { + "title": "Dependabot Secret for an Organization", + "description": "Secrets for GitHub Dependabot for an organization.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] + }, + "dependabot-public-key": { + "title": "DependabotPublicKey", + "description": "The public key used for setting Dependabot Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "nullable-minimal-repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "$ref": "#/components/schemas/code-of-conduct" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + } + }, + "version": "2026-03-10" + } + ], + "nullable": true + }, + "package": { + "title": "Package", + "description": "A software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the package.", + "type": "string", + "example": "super-linter" + }, + "package_type": { + "type": "string", + "example": "docker", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + }, + "url": { + "type": "string", + "example": "https://api.github.com/orgs/github/packages/container/super-linter" + }, + "html_url": { + "type": "string", + "example": "https://github.com/orgs/github/packages/container/package/super-linter" + }, + "version_count": { + "description": "The number of versions of the package.", + "type": "integer", + "example": 1 + }, + "visibility": { + "type": "string", + "example": "private", + "enum": [ + "private", + "public" + ] + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "repository": { + "$ref": "#/components/schemas/nullable-minimal-repository" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "package_type", + "visibility", + "url", + "html_url", + "version_count", + "created_at", + "updated_at" + ] + }, + "organization-invitation": { + "title": "Organization Invitation", + "description": "Organization Invitation", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "nullable": true + }, + "role": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "failed_at": { + "type": "string", + "nullable": true + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "inviter": { + "$ref": "#/components/schemas/simple-user" + }, + "team_count": { + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "\"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x\"" + }, + "invitation_teams_url": { + "type": "string", + "example": "\"https://api.github.com/organizations/16/invitations/1/teams\"" + }, + "invitation_source": { + "type": "string", + "example": "\"member\"" + } + }, + "required": [ + "id", + "login", + "email", + "role", + "created_at", + "inviter", + "team_count", + "invitation_teams_url", + "node_id" + ] + }, + "org-hook": { + "title": "Org Hook", + "description": "Org Hook", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/deliveries" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "api-insights-route-stats": { + "title": "Route Stats", + "description": "API Insights usage route stats for an actor", + "type": "array", + "items": { + "type": "object", + "properties": { + "http_method": { + "description": "The HTTP method", + "type": "string" + }, + "api_route": { + "description": "The API path's route template", + "type": "string" + }, + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "api-insights-subject-stats": { + "title": "Subject Stats", + "description": "API Insights usage subject stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "subject_type": { + "type": "string" + }, + "subject_name": { + "type": "string" + }, + "subject_id": { + "type": "integer", + "format": "int64" + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "api-insights-summary-stats": { + "title": "Summary Stats", + "description": "API Insights usage summary stats for an organization", + "type": "object", + "properties": { + "total_request_count": { + "description": "The total number of requests within the queried time period", + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "description": "The total number of requests that were rate limited within the queried time period", + "type": "integer", + "format": "int64" + } + } + }, + "api-insights-time-stats": { + "title": "Time Stats", + "description": "API Insights usage time stats for an organization", + "type": "array", + "items": { + "type": "object", + "properties": { + "timestamp": { + "type": "string" + }, + "total_request_count": { + "type": "integer", + "format": "int64" + }, + "rate_limited_request_count": { + "type": "integer", + "format": "int64" + } + } + } + }, + "api-insights-user-stats": { + "title": "User Stats", + "description": "API Insights usage stats for a user", + "type": "array", + "items": { + "type": "object", + "properties": { + "actor_type": { + "type": "string" + }, + "actor_name": { + "type": "string" + }, + "actor_id": { + "type": "integer", + "format": "int64" + }, + "integration_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "oauth_application_id": { + "type": "integer", + "format": "int64", + "nullable": true + }, + "total_request_count": { + "type": "integer" + }, + "rate_limited_request_count": { + "type": "integer" + }, + "last_rate_limited_timestamp": { + "type": "string", + "nullable": true + }, + "last_request_timestamp": { + "type": "string" + } + } + } + }, + "interaction-group": { + "type": "string", + "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.", + "example": "collaborators_only", + "enum": [ + "existing_users", + "contributors_only", + "collaborators_only" + ] + }, + "interaction-limit-response": { + "title": "Interaction Limits", + "description": "Interaction limit settings.", + "type": "object", + "properties": { + "limit": { + "$ref": "#/components/schemas/interaction-group" + }, + "origin": { + "type": "string", + "example": "repository" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "example": "2018-08-17T04:18:39Z" + } + }, + "required": [ + "limit", + "origin", + "expires_at" + ] + }, + "interaction-expiry": { + "type": "string", + "description": "The duration of the interaction restriction. Default: `one_day`.", + "example": "one_month", + "enum": [ + "one_day", + "three_days", + "one_week", + "one_month", + "six_months" + ] + }, + "interaction-limit": { + "title": "Interaction Restrictions", + "description": "Limit interactions to a specific type of user for a specified duration", + "type": "object", + "properties": { + "limit": { + "$ref": "#/components/schemas/interaction-group" + }, + "expiry": { + "$ref": "#/components/schemas/interaction-expiry" + } + }, + "required": [ + "limit" + ] + }, + "issue-field": { + "title": "Issue Field", + "description": "A custom attribute defined at the organization level for attaching structured data to issues.", + "type": "object", + "nullable": true, + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node identifier of the issue field." + }, + "name": { + "type": "string", + "description": "The name of the issue field." + }, + "description": { + "type": "string", + "description": "The description of the issue field.", + "nullable": true + }, + "data_type": { + "type": "string", + "description": "The data type of the issue field.", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + }, + "visibility": { + "type": "string", + "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues).", + "enum": [ + "organization_members_only", + "all" + ] + }, + "options": { + "description": "Available options for single select fields.", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The name of the option." + }, + "description": { + "type": "string", + "description": "The description of the option.", + "nullable": true + }, + "color": { + "type": "string", + "description": "The color of the option.", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + }, + "priority": { + "type": "integer", + "description": "The priority of the option for ordering.", + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the option was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the option was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "name" + ] + }, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "The time the issue field was created.", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "description": "The time the issue field was last updated.", + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "name", + "data_type" + ] + }, + "organization-create-issue-field": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue field.", + "type": "string" + }, + "description": { + "description": "Description of the issue field.", + "type": "string", + "nullable": true + }, + "data_type": { + "description": "The data type of the issue field.", + "type": "string", + "enum": [ + "text", + "date", + "single_select", + "number" + ] + }, + "visibility": { + "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to `organization_members_only`.", + "type": "string", + "enum": [ + "organization_members_only", + "all" + ] + }, + "options": { + "description": "Options for single select fields. Required when data_type is 'single_select'.", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "Name of the option.", + "type": "string" + }, + "description": { + "description": "Description of the option.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the option.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + "priority": { + "description": "Priority of the option for ordering.", + "type": "integer" + } + }, + "required": [ + "name", + "color", + "priority" + ] + }, + "nullable": true + } + }, + "required": [ + "name", + "data_type" + ] + }, + "organization-update-issue-field": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue field.", + "type": "string" + }, + "description": { + "description": "Description of the issue field.", + "type": "string", + "nullable": true + }, + "visibility": { + "description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled.", + "type": "string", + "enum": [ + "organization_members_only", + "all" + ] + }, + "options": { + "description": "Options for single select fields. Only applicable when updating single_select fields.", + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "description": "Name of the option.", + "type": "string" + }, + "description": { + "description": "Description of the option.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the option.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ] + }, + "priority": { + "description": "Priority of the option for ordering.", + "type": "integer" + } + }, + "required": [ + "name", + "color", + "priority" + ] + } + } + } + }, + "organization-create-issue-type": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "organization-update-issue-type": { + "type": "object", + "properties": { + "name": { + "description": "Name of the issue type.", + "type": "string" + }, + "is_enabled": { + "description": "Whether or not the issue type is enabled at the organization level.", + "type": "boolean" + }, + "description": { + "description": "Description of the issue type.", + "type": "string", + "nullable": true + }, + "color": { + "description": "Color for the issue type.", + "type": "string", + "enum": [ + "gray", + "blue", + "green", + "yellow", + "orange", + "red", + "pink", + "purple" + ], + "nullable": true + } + }, + "required": [ + "name", + "is_enabled" + ] + }, + "org-membership": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/memberships/defunkt" + }, + "state": { + "type": "string", + "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.", + "example": "active", + "enum": [ + "active", + "pending" + ] + }, + "role": { + "type": "string", + "description": "The user's membership type in the organization.", + "example": "admin", + "enum": [ + "admin", + "member", + "billing_manager" + ] + }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "example": true + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "example": [ + "ent:team-one", + "ent:team-two" + ] + }, + "organization_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + }, + "migration": { + "title": "Migration", + "description": "A migration.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 79 + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "guid": { + "type": "string", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516" + }, + "state": { + "type": "string", + "example": "pending" + }, + "lock_repositories": { + "type": "boolean", + "example": true + }, + "exclude_metadata": { + "type": "boolean" + }, + "exclude_git_data": { + "type": "boolean" + }, + "exclude_attachments": { + "type": "boolean" + }, + "exclude_releases": { + "type": "boolean" + }, + "exclude_owner_projects": { + "type": "boolean" + }, + "org_metadata_only": { + "type": "boolean" + }, + "repositories": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "$ref": "#/components/schemas/repository" + } + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octo-org/migrations/79" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2015-07-06T15:33:38-07:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2015-07-06T15:33:38-07:00" + }, + "node_id": { + "type": "string" + }, + "archive_url": { + "type": "string", + "format": "uri" + }, + "exclude": { + "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude parameter. The array can include any of: `\"repositories\"`.", + "type": "string" + } + } + }, + "required": [ + "id", + "node_id", + "owner", + "guid", + "state", + "lock_repositories", + "exclude_metadata", + "exclude_git_data", + "exclude_attachments", + "exclude_releases", + "exclude_owner_projects", + "org_metadata_only", + "repositories", + "url", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "restrict_repo_fields_in_migration_resource", + "patch": [ + { + "op": "replace", + "path": "/properties/repositories", + "value": { + "type": "array", + "description": "The repositories included in the migration. Only returned for export migrations.", + "items": { + "$ref": "#/components/schemas/simple-repository" + } + } + } + ], + "version": "2026-03-10" + } + ] + }, + "organization-role": { + "title": "Organization Role", + "description": "Organization roles", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the role.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the role.", + "type": "string" + }, + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": "string", + "nullable": true + }, + "base_role": { + "type": "string", + "nullable": true, + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain", + "admin" + ] + }, + "source": { + "type": "string", + "nullable": true, + "description": "Source answers the question, \"where did this role come from?\"", + "enum": [ + "Organization", + "Enterprise", + "Predefined" + ] + }, + "permissions": { + "description": "A list of permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "description": "The date and time the role was created.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time the role was last updated.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "name", + "permissions", + "organization", + "created_at", + "updated_at" + ] + }, + "team-role-assignment": { + "title": "A Role Assignment for a Team", + "description": "The Relationship a Team has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the team has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "parent" + ] + }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "example": "notifications_enabled" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type" + ] + }, + "user-role-assignment": { + "title": "A Role Assignment for a User", + "description": "The Relationship a User has with a role.", + "type": "object", + "properties": { + "assignment": { + "type": "string", + "description": "Determines if the user has a direct, indirect, or mixed relationship to a role", + "enum": [ + "direct", + "indirect", + "mixed" + ], + "example": "direct" + }, + "inherited_from": { + "description": "Team the user has gotten the role through", + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "package-version": { + "title": "Package Version", + "description": "A version of a software package", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the package version.", + "type": "integer", + "example": 1 + }, + "name": { + "description": "The name of the package version.", + "type": "string", + "example": "latest" + }, + "url": { + "type": "string", + "example": "https://api.github.com/orgs/github/packages/container/super-linter/versions/786068" + }, + "package_html_url": { + "type": "string", + "example": "https://github.com/orgs/github/packages/container/package/super-linter" + }, + "html_url": { + "type": "string", + "example": "https://github.com/orgs/github/packages/container/super-linter/786068" + }, + "license": { + "type": "string", + "example": "MIT" + }, + "description": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "metadata": { + "type": "object", + "title": "Package Version Metadata", + "properties": { + "package_type": { + "type": "string", + "example": "docker", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + }, + "container": { + "type": "object", + "title": "Container Metadata", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + }, + "docker": { + "type": "object", + "title": "Docker Metadata", + "properties": { + "tag": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "tags" + ] + } + }, + "required": [ + "package_type" + ] + } + }, + "required": [ + "id", + "name", + "url", + "package_html_url", + "created_at", + "updated_at" + ] + }, + "organization-programmatic-access-grant-request": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": "string", + "nullable": true, + "description": "Reason for requesting access." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + }, + "organization-programmatic-access-grant": { + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": "string", + "nullable": true, + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + }, + "org-private-registry-configuration": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ], + "type": "string" + }, + "auth_type": { + "description": "The authentication type for the private registry.", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog" + ], + "type": "string" + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "example": "monalisa", + "type": "string", + "nullable": true + }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "org-private-registry-configuration-with-selected-repositories": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "example": "MAVEN_REPOSITORY_SECRET", + "type": "string" + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository", + "nuget_feed", + "goproxy_server", + "npm_registry", + "rubygems_server", + "cargo_registry", + "composer_repository", + "docker_registry", + "git_source", + "helm_registry", + "hex_organization", + "hex_repository", + "pub_repository", + "python_index", + "terraform_registry" + ], + "type": "string" + }, + "auth_type": { + "description": "The authentication type for the private registry.", + "enum": [ + "token", + "username_password", + "oidc_azure", + "oidc_aws", + "oidc_jfrog" + ], + "type": "string" + }, + "url": { + "description": "The URL of the private registry.", + "type": "string", + "format": "uri" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "example": "monalisa", + "type": "string" + }, + "replaces_base": { + "description": "Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.", + "type": "boolean", + "default": false + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "tenant_id": { + "description": "The tenant ID of the Azure AD application.", + "type": "string" + }, + "client_id": { + "description": "The client ID of the Azure AD application.", + "type": "string" + }, + "aws_region": { + "description": "The AWS region.", + "type": "string" + }, + "account_id": { + "description": "The AWS account ID.", + "type": "string" + }, + "role_name": { + "description": "The AWS IAM role name.", + "type": "string" + }, + "domain": { + "description": "The CodeArtifact domain.", + "type": "string" + }, + "domain_owner": { + "description": "The CodeArtifact domain owner.", + "type": "string" + }, + "jfrog_oidc_provider_name": { + "description": "The JFrog OIDC provider name.", + "type": "string" + }, + "audience": { + "description": "The OIDC audience.", + "type": "string" + }, + "identity_mapping_name": { + "description": "The JFrog identity mapping name.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + }, + "nullable-projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the status update was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the status update was last updated." + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true, + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28", + "description": "The start date of the period covered by the update." + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28", + "description": "The target date associated with the update." + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ], + "nullable": true + }, + "projects-v2": { + "title": "Projects v2 Project", + "description": "A projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "title": { + "type": "string", + "description": "The project title." + }, + "description": { + "type": "string", + "nullable": true, + "description": "A short description of the project." + }, + "public": { + "type": "boolean", + "description": "Whether the project is visible to anyone with access to the owner." + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "nullable": true, + "description": "The time when the project was closed." + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the project was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the project was last updated." + }, + "number": { + "type": "integer", + "description": "The project number." + }, + "short_description": { + "type": "string", + "nullable": true, + "description": "A concise summary of the project." + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "nullable": true, + "description": "The time when the project was deleted." + }, + "deleted_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ], + "description": "The current state of the project." + }, + "latest_status_update": { + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + }, + "is_template": { + "type": "boolean", + "description": "Whether this project is a template" + } + }, + "required": [ + "id", + "node_id", + "owner", + "creator", + "title", + "description", + "public", + "closed_at", + "created_at", + "updated_at", + "number", + "short_description", + "deleted_at", + "deleted_by" + ] + }, + "link": { + "title": "Link", + "description": "Hypermedia Link", + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "auto-merge": { + "title": "Auto merge", + "description": "The status of auto merging a pull request.", + "type": "object", + "properties": { + "enabled_by": { + "$ref": "#/components/schemas/simple-user" + }, + "merge_method": { + "type": "string", + "description": "The merge method to use.", + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + "commit_title": { + "type": "string", + "description": "Title for the merge commit message." + }, + "commit_message": { + "type": "string", + "description": "Commit message for the merge commit." + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ], + "nullable": true + }, + "pull-request-simple": { + "title": "Pull Request Simple", + "description": "Pull Request Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOlB1bGxSZXF1ZXN0MQ==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347" + }, + "diff_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.diff" + }, + "patch_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "issue_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "commits_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "review_comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "number": { + "type": "integer", + "example": 1347 + }, + "state": { + "type": "string", + "example": "open" + }, + "locked": { + "type": "boolean", + "example": true + }, + "title": { + "type": "string", + "example": "new-feature" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body": { + "type": "string", + "example": "Please pull these awesome changes", + "nullable": true + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merged_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merge_commit_sha": { + "type": "string", + "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "nullable": true + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "requested_teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "$ref": "#/components/schemas/repository" + }, + "sha": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "$ref": "#/components/schemas/repository" + }, + "sha": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "_links": { + "type": "object", + "properties": { + "comments": { + "$ref": "#/components/schemas/link" + }, + "commits": { + "$ref": "#/components/schemas/link" + }, + "statuses": { + "$ref": "#/components/schemas/link" + }, + "html": { + "$ref": "#/components/schemas/link" + }, + "issue": { + "$ref": "#/components/schemas/link" + }, + "review_comments": { + "$ref": "#/components/schemas/link" + }, + "review_comment": { + "$ref": "#/components/schemas/link" + }, + "self": { + "$ref": "#/components/schemas/link" + } + }, + "required": [ + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" + ] + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "auto_merge": { + "$ref": "#/components/schemas/auto-merge" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "example": false, + "type": "boolean" + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": { + "properties": { + "merge_commit_sha": null + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge" + ] + }, + "version": "2026-03-10" + } + ] + }, + "projects-v2-draft-issue": { + "title": "Draft Issue", + "description": "A draft issue in a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The ID of the draft issue" + }, + "node_id": { + "type": "string", + "description": "The node ID of the draft issue" + }, + "title": { + "type": "string", + "description": "The title of the draft issue" + }, + "body": { + "type": "string", + "description": "The body content of the draft issue", + "nullable": true + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was created" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time the draft issue was last updated" + } + }, + "required": [ + "id", + "node_id", + "title", + "user", + "created_at", + "updated_at" + ] + }, + "projects-v2-item-content-type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", + "type": "string", + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" + ] + }, + "projects-v2-item-simple": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "content": { + "oneOf": [ + { + "$ref": "#/components/schemas/issue" + }, + { + "$ref": "#/components/schemas/pull-request-simple" + }, + { + "$ref": "#/components/schemas/projects-v2-draft-issue" + } + ], + "description": "The content represented by the item." + }, + "content_type": { + "$ref": "#/components/schemas/projects-v2-item-content-type" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the item was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the item was last updated." + }, + "archived_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "nullable": true, + "description": "The time when the item was archived." + }, + "project_url": { + "type": "string", + "format": "uri", + "description": "The URL of the project this item belongs to." + }, + "item_url": { + "type": "string", + "format": "uri", + "description": "The URL of the item in the project." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "projects-v2-single-select-options": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + }, + "projects-v2-iteration-settings": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + }, + "projects-v2-field": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "issue_field_id": { + "type": "integer", + "description": "The ID of the issue field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "example": "https://api.github.com/projects/1" + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "$ref": "#/components/schemas/projects-v2-single-select-options" + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-iteration-settings" + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the field was last updated." + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "projects-v2-field-single-select-option": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + }, + "additionalProperties": false + }, + "projects-v2-field-iteration-configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + }, + "projects-v2-item-with-content": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/monalisa/2/projectsV2/3", + "description": "The API URL of the project that contains this item." + }, + "content_type": { + "$ref": "#/components/schemas/projects-v2-item-content-type" + }, + "content": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "The content of the item, which varies by content type." + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the item was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the item was last updated." + }, + "archived_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "nullable": true, + "description": "The time when the item was archived." + }, + "item_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/monalisa/2/projectsV2/items/3", + "nullable": true, + "description": "The API URL of this item." + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." + } + }, + "required": [ + "id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "projects-v2-view": { + "title": "Projects v2 View", + "description": "A view inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the view." + }, + "number": { + "type": "integer", + "description": "The number of the view within the project." + }, + "name": { + "type": "string", + "description": "The name of the view." + }, + "layout": { + "type": "string", + "description": "The layout of the view.", + "enum": [ + "table", + "board", + "roadmap" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID of the view." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the view.", + "example": "https://api.github.com/orgs/octocat/projectsV2/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The web URL of the view.", + "example": "https://github.com/orgs/octocat/projects/1/views/1" + }, + "creator": { + "allOf": [ + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the view was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the view was last updated." + }, + "filter": { + "type": "string", + "nullable": true, + "description": "The filter query for the view.", + "example": "is:issue is:open" + }, + "visible_fields": { + "type": "array", + "description": "The list of field IDs that are visible in the view.", + "items": { + "type": "integer" + } + }, + "sort_by": { + "type": "array", + "description": "The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is \"asc\" or \"desc\".", + "items": { + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + }, + "group_by": { + "type": "array", + "description": "The list of field IDs used for horizontal grouping.", + "items": { + "type": "integer" + } + }, + "vertical_group_by": { + "type": "array", + "description": "The list of field IDs used for vertical grouping (board layout).", + "items": { + "type": "integer" + } + } + }, + "required": [ + "id", + "number", + "name", + "layout", + "node_id", + "project_url", + "html_url", + "creator", + "created_at", + "updated_at", + "visible_fields", + "sort_by", + "group_by", + "vertical_group_by" + ] + }, + "custom-property": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false", + "url" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + }, + "require_explicit_values": { + "type": "boolean", + "description": "Whether setting properties values is mandatory" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false", + "url" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" + }, + "require_explicit_values": { + "type": "boolean", + "description": "Whether setting properties values is mandatory" + } + }, + "required": [ + "value_type" + ] + }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "org-repo-custom-property-values": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "example": 1296269 + }, + "repository_name": { + "type": "string", + "example": "Hello-World" + }, + "repository_full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + }, + "nullable-repository": { + "title": "Repository", + "description": "A repository on GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true, + "deprecated": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "example": "all" + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + }, + "code_search_index_status": { + "type": "object", + "description": "The status of the code search index for this repository", + "properties": { + "lexical_search_ok": { + "type": "boolean" + }, + "lexical_commit_sha": { + "type": "string" + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ], + "nullable": true + }, + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" + }, + "key": { + "type": "string", + "example": "citizen_code_of_conduct" + }, + "name": { + "type": "string", + "example": "Citizen Code of Conduct" + }, + "html_url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + }, + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] + }, + "has_issues": { + "type": "boolean", + "example": true + }, + "has_projects": { + "type": "boolean", + "example": true + }, + "has_wiki": { + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "has_discussions": { + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ], + "example": "all" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "$ref": "#/components/schemas/nullable-repository" + }, + "temp_clone_token": { + "type": "string", + "nullable": true + }, + "allow_squash_merge": { + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "type": "boolean", + "example": true + }, + "allow_update_branch": { + "type": "boolean", + "example": true + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "example": false + }, + "squash_merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "example": "PR_TITLE", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "example": "PR_BODY", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_forking": { + "type": "boolean", + "example": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer", + "example": 42 + }, + "network_count": { + "type": "integer", + "example": 0 + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "parent": { + "$ref": "#/components/schemas/repository" + }, + "source": { + "$ref": "#/components/schemas/repository" + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "$ref": "#/components/schemas/code-of-conduct-simple" + }, + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + } + }, + "version": "2026-03-10" + } + ] + }, + "repository-rule-enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "repository-ruleset-bypass-actor": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": "integer", + "nullable": true, + "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey" + ], + "description": "The type of actor that can bypass a ruleset." + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", + "enum": [ + "always", + "pull_request", + "exempt" + ], + "default": "always" + } + } + }, + "repository-ruleset-conditions": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "repository-ruleset-conditions-repository-name-target": { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + "repository-ruleset-conditions-repository-id-target": { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + }, + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + "org-ruleset-conditions": { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] + } + ] + }, + "repository-rule-creation": { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + "repository-rule-update": { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + "repository-rule-deletion": { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + "repository-rule-required-deployments": { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + "repository-rule-required-signatures": { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + "repository-rule-params-reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "$ref": "#/components/schemas/repository-rule-params-reviewer" + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + }, + "repository-rule-pull-request": { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-required-reviewer-configuration" + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + "repository-rule-params-status-check-configuration": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + }, + "repository-rule-required-status-checks": { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + "repository-rule-non-fast-forward": { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + "repository-rule-commit-message-pattern": { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-commit-author-email-pattern": { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-committer-email-pattern": { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-branch-name-pattern": { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-tag-name-pattern": { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule appears when configuring it." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-file-path-restriction": { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + "repository-rule-max-file-path-length": { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + "repository-rule-file-extension-restriction": { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + "repository-rule-max-file-size": { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + "repository-rule-params-restricted-commits": { + "title": "RestrictedCommits", + "description": "Restricted commit", + "type": "object", + "properties": { + "oid": { + "type": "string", + "description": "Full or abbreviated commit hash to reject" + }, + "reason": { + "type": "string", + "description": "Reason for restriction" + } + }, + "required": [ + "oid" + ] + }, + "repository-rule-params-workflow-file-reference": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + }, + "repository-rule-workflows": { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + }, + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + "repository-rule-copilot-code-review": { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, + "repository-rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-file-path-restriction" + }, + { + "$ref": "#/components/schemas/repository-rule-max-file-path-length" + }, + { + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + }, + { + "$ref": "#/components/schemas/repository-rule-max-file-size" + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" + } + ] + }, + "repository-ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never", + "exempt" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": "object", + "nullable": true, + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "nullable": true, + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "org-rules": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-file-path-restriction" + }, + { + "$ref": "#/components/schemas/repository-rule-max-file-path-length" + }, + { + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + }, + { + "$ref": "#/components/schemas/repository-rule-max-file-size" + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" + } + ] + }, + "rule-suites": { + "title": "Rule Suites", + "description": "Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." + }, + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." + } + } + } + }, + "rule-suite-pull-request": { + "title": "Pull request rule suite metadata", + "description": "Metadata for a pull request rule evaluation result.", + "type": "object", + "properties": { + "pull_request": { + "type": "object", + "description": "The pull request associated with the rule evaluation.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the pull request." + }, + "number": { + "type": "integer", + "description": "The number of the pull request." + }, + "user": { + "type": "object", + "description": "The user who created the pull request.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the user." + }, + "login": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "type": { + "type": "string", + "description": "The type of the user." + } + } + }, + "reviews": { + "type": "array", + "description": "The reviews associated with the pull request.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the review." + }, + "user": { + "type": "object", + "description": "The user who submitted the review.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the user." + }, + "login": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "type": { + "type": "string", + "description": "The type of the user." + } + } + }, + "state": { + "type": "string", + "description": "The state of the review." + } + } + } + } + } + } + } + }, + "rule-suite-required-status-checks": { + "title": "Required status checks rule suite metadata", + "description": "Metadata for a required status checks rule evaluation result.", + "type": "object", + "properties": { + "checks": { + "type": "array", + "description": "The status checks associated with the rule evaluation.", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the status check." + }, + "context": { + "type": "string", + "description": "The context name of the status check." + }, + "state": { + "type": "string", + "description": "The state of the status check." + }, + "type": { + "type": "string", + "description": "The type of the status check." + }, + "app": { + "type": "object", + "nullable": true, + "description": "The GitHub App associated with the status check.", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the GitHub App." + }, + "slug": { + "type": "string", + "description": "The slug of the GitHub App." + }, + "name": { + "type": "string", + "description": "The name of the GitHub App." + } + } + } + } + } + } + } + }, + "rule-suite": { + "title": "Rule Suite", + "description": "Response", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." + }, + "actor_id": { + "type": "integer", + "description": "The number that identifies the user.", + "nullable": true + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account.", + "nullable": true + }, + "before_sha": { + "type": "string", + "description": "The previous commit SHA of the ref." + }, + "after_sha": { + "type": "string", + "description": "The new commit SHA of the ref." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": "string", + "nullable": true, + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run." + }, + "rule_evaluations": { + "type": "array", + "description": "Details on the evaluated rules.", + "items": { + "type": "object", + "properties": { + "rule_source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of rule source." + }, + "id": { + "type": "integer", + "nullable": true, + "description": "The ID of the rule source." + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of the rule source." + } + } + }, + "enforcement": { + "type": "string", + "enum": [ + "active", + "evaluate", + "deleted ruleset" + ], + "description": "The enforcement level of this rule source." + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the evaluation of the individual rule." + }, + "rule_type": { + "type": "string", + "description": "The type of rule." + }, + "details": { + "type": "string", + "nullable": true, + "description": "The detailed failure message for the rule. Null if the rule passed." + } + } + } + } + } + }, + "ruleset-version": { + "title": "Ruleset version", + "type": "object", + "description": "The historical version of a ruleset", + "required": [ + "version_id", + "actor", + "updated_at" + ], + "properties": { + "version_id": { + "type": "integer", + "description": "The ID of the previous version of the ruleset" + }, + "actor": { + "type": "object", + "description": "The actor who updated the ruleset", + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "ruleset-version-with-state": { + "allOf": [ + { + "$ref": "#/components/schemas/ruleset-version" + }, + { + "type": "object", + "required": [ + "state" + ], + "properties": { + "state": { + "type": "object", + "description": "The state of the ruleset version" + } + } + } + ] + }, + "nullable-alert-updated-at": { + "type": "string", + "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "secret-scanning-alert-state": { + "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", + "type": "string", + "enum": [ + "open", + "resolved" + ] + }, + "secret-scanning-alert-resolution": { + "type": "string", + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests" + ] + }, + "secret-scanning-location-commit": { + "description": "Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path in the repository", + "example": "/example/secrets.txt" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "blob_url": { + "type": "string", + "description": "The API URL to get the associated blob resource" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "commit_url": { + "type": "string", + "description": "The API URL to get the associated commit resource" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL to get the associated commit resource.", + "example": "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "blob_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-wiki-commit": { + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The file path of the wiki page", + "example": "/example/Home.md" + }, + "start_line": { + "type": "number", + "description": "Line number at which the secret starts in the file" + }, + "end_line": { + "type": "number", + "description": "Line number at which the secret ends in the file" + }, + "start_column": { + "type": "number", + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." + }, + "end_column": { + "type": "number", + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." + }, + "blob_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated blob", + "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b" + }, + "page_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki page", + "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_sha": { + "type": "string", + "description": "SHA-1 hash ID of the associated commit", + "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5" + }, + "commit_url": { + "type": "string", + "description": "The GitHub URL to get the associated wiki commit", + "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + "required": [ + "path", + "start_line", + "end_line", + "start_column", + "end_column", + "blob_sha", + "page_url", + "commit_sha", + "commit_url" + ] + }, + "secret-scanning-location-issue-title": { + "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.", + "type": "object", + "properties": { + "issue_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/issues/1" + } + }, + "required": [ + "issue_title_url" + ] + }, + "secret-scanning-location-issue-body": { + "description": "Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue.", + "type": "object", + "properties": { + "issue_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/issues/1" + } + }, + "required": [ + "issue_body_url" + ] + }, + "secret-scanning-location-issue-comment": { + "description": "Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.", + "type": "object", + "properties": { + "issue_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the issue comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the issue comment where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451" + } + }, + "required": [ + "issue_comment_url" + ] + }, + "secret-scanning-location-discussion-title": { + "description": "Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.", + "type": "object", + "properties": { + "discussion_title_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082" + } + }, + "required": [ + "discussion_title_url" + ] + }, + "secret-scanning-location-discussion-body": { + "description": "Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.", + "type": "object", + "properties": { + "discussion_body_url": { + "type": "string", + "format": "uri", + "description": "The URL to the discussion where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + "required": [ + "discussion_body_url" + ] + }, + "secret-scanning-location-discussion-comment": { + "description": "Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.", + "type": "object", + "properties": { + "discussion_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the discussion comment where the secret was detected.", + "example": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + "required": [ + "discussion_comment_url" + ] + }, + "secret-scanning-location-pull-request-title": { + "description": "Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.", + "type": "object", + "properties": { + "pull_request_title_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/pull/2846" + } + }, + "required": [ + "pull_request_title_url" + ] + }, + "secret-scanning-location-pull-request-body": { + "description": "Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.", + "type": "object", + "properties": { + "pull_request_body_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/pull/2846" + } + }, + "required": [ + "pull_request_body_url" + ] + }, + "secret-scanning-location-pull-request-comment": { + "description": "Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.", + "type": "object", + "properties": { + "pull_request_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request comment where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451" + } + }, + "required": [ + "pull_request_comment_url" + ] + }, + "secret-scanning-location-pull-request-review": { + "description": "Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.", + "type": "object", + "properties": { + "pull_request_review_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80" + } + }, + "required": [ + "pull_request_review_url" + ] + }, + "secret-scanning-location-pull-request-review-comment": { + "description": "Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request.", + "type": "object", + "properties": { + "pull_request_review_comment_url": { + "type": "string", + "format": "uri", + "description": "The API URL to get the pull request review comment where the secret was detected.", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The GitHub URL for the pull request review comment where the secret was detected.", + "example": "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" + } + }, + "required": [ + "pull_request_review_comment_url" + ] + }, + "nullable-secret-scanning-first-detected-location": { + "description": "Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + } + ], + "nullable": true + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": "string", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.", + "nullable": true + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "resolution_comment": { + "type": "string", + "description": "The comment that was optionally added when this alert was closed", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + } + } + }, + "secret-scanning-row-version": { + "type": "string", + "description": "The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.", + "nullable": true + }, + "secret-scanning-pattern-override": { + "type": "object", + "properties": { + "token_type": { + "type": "string", + "description": "The ID of the pattern." + }, + "custom_pattern_version": { + "type": "string", + "description": "The version of this pattern if it's a custom pattern.", + "nullable": true + }, + "slug": { + "type": "string", + "description": "The slug of the pattern." + }, + "display_name": { + "type": "string", + "description": "The user-friendly name for the pattern." + }, + "alert_total": { + "type": "integer", + "description": "The total number of alerts generated by this pattern." + }, + "alert_total_percentage": { + "type": "integer", + "description": "The percentage of all alerts that this pattern represents, rounded to the nearest integer." + }, + "false_positives": { + "type": "integer", + "description": "The number of false positive alerts generated by this pattern." + }, + "false_positive_rate": { + "type": "integer", + "description": "The percentage of alerts from this pattern that are false positives, rounded to the nearest integer." + }, + "bypass_rate": { + "type": "integer", + "description": "The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer." + }, + "default_setting": { + "type": "string", + "description": "The default push protection setting for this pattern.", + "enum": [ + "disabled", + "enabled" + ] + }, + "enterprise_setting": { + "type": "string", + "description": "The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.", + "enum": [ + "not-set", + "disabled", + "enabled" + ], + "nullable": true + }, + "setting": { + "type": "string", + "description": "The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.", + "enum": [ + "not-set", + "disabled", + "enabled" + ] + } + } + }, + "secret-scanning-pattern-configuration": { + "title": "Secret scanning pattern configuration", + "description": "A collection of secret scanning patterns and their settings related to push protection.", + "type": "object", + "properties": { + "pattern_config_version": { + "$ref": "#/components/schemas/secret-scanning-row-version" + }, + "provider_pattern_overrides": { + "type": "array", + "description": "Overrides for partner patterns.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + }, + "custom_pattern_overrides": { + "type": "array", + "description": "Overrides for custom patterns defined by the organization.", + "items": { + "$ref": "#/components/schemas/secret-scanning-pattern-override" + } + } + } + }, + "repository-advisory-vulnerability": { + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "nullable": true, + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package", + "vulnerable_version_range", + "patched_versions", + "vulnerable_functions" + ], + "additionalProperties": false + }, + "repository-advisory-credit": { + "description": "A credit given to a user for a repository security advisory.", + "type": "object", + "properties": { + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + }, + "state": { + "type": "string", + "description": "The state of the user's acceptance of the credit.", + "enum": [ + "accepted", + "declined", + "pending" + ] + } + }, + "required": [ + "user", + "type", + "state" + ], + "additionalProperties": false + }, + "repository-advisory": { + "description": "A repository security advisory.", + "type": "object", + "properties": { + "ghsa_id": { + "type": "string", + "description": "The GitHub Security Advisory ID.", + "readOnly": true + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "description": "The API URL for the advisory.", + "readOnly": true + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL for the advisory.", + "readOnly": true + }, + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory entails.", + "maxLength": 65535, + "nullable": true + }, + "severity": { + "type": "string", + "description": "The severity of the advisory.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "author": { + "readOnly": true, + "nullable": true, + "description": "The author of the advisory.", + "allOf": [ + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "publisher": { + "readOnly": true, + "nullable": true, + "description": "The publisher of the advisory.", + "allOf": [ + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of identifier.", + "enum": [ + "CVE", + "GHSA" + ] + }, + "value": { + "type": "string", + "description": "The identifier value." + } + }, + "required": [ + "type", + "value" + ] + }, + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "withdrawn", + "draft", + "triage" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was created, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "published_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was published, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "closed_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was closed, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "withdrawn_at": { + "type": "string", + "format": "date-time", + "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", + "readOnly": true, + "nullable": true + }, + "submission": { + "type": "object", + "nullable": true, + "readOnly": true, + "properties": { + "accepted": { + "type": "boolean", + "description": "Whether a private vulnerability report was accepted by the repository's administrators.", + "readOnly": true + } + }, + "required": [ + "accepted" + ] + }, + "vulnerabilities": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/repository-advisory-vulnerability" + } + }, + "cvss": { + "type": "object", + "nullable": true, + "properties": { + "vector_string": { + "type": "string", + "description": "The CVSS vector.", + "nullable": true + }, + "score": { + "type": "number", + "description": "The CVSS score.", + "minimum": 0, + "maximum": 10, + "nullable": true, + "readOnly": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string", + "description": "The Common Weakness Enumeration (CWE) identifier." + }, + "name": { + "type": "string", + "description": "The name of the CWE.", + "readOnly": true + } + }, + "required": [ + "cwe_id", + "name" + ] + }, + "readOnly": true + }, + "cwe_ids": { + "type": "array", + "description": "A list of only the CWE IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + } + } + }, + "credits_detailed": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/repository-advisory-credit" + }, + "readOnly": true + }, + "collaborating_users": { + "type": "array", + "description": "A list of users that collaborate on the advisory.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of teams that collaborate on the advisory.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/team" + } + }, + "private_fork": { + "readOnly": true, + "nullable": true, + "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", + "allOf": [ + { + "$ref": "#/components/schemas/simple-repository" + } + ] + } + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cvss", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ], + "additionalProperties": false, + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "ghsa_id", + "cve_id", + "url", + "html_url", + "summary", + "description", + "severity", + "author", + "publisher", + "identifiers", + "state", + "created_at", + "updated_at", + "published_at", + "closed_at", + "withdrawn_at", + "submission", + "vulnerabilities", + "cwes", + "cwe_ids", + "credits", + "credits_detailed", + "collaborating_users", + "collaborating_teams", + "private_fork" + ] + }, + "version": "2026-03-10" + } + ] + }, + "immutable-releases-organization-settings": { + "title": "Check immutable releases organization settings", + "description": "Check immutable releases settings for an organization.", + "type": "object", + "properties": { + "enforced_repositories": { + "type": "string", + "description": "The policy that controls how immutable releases are enforced in the organization.", + "enum": [ + "all", + "none", + "selected" + ], + "example": "all" + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`." + } + }, + "required": [ + "enforced_repositories" + ] + }, + "network-configuration": { + "title": "Hosted compute network configuration", + "description": "A hosted compute network configuration.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network configuration.", + "type": "string", + "example": "123ABC456DEF789" + }, + "name": { + "description": "The name of the network configuration.", + "type": "string", + "example": "my-network-configuration" + }, + "compute_service": { + "description": "The hosted compute service the network configuration supports.", + "type": "string", + "enum": [ + "none", + "actions", + "codespaces" + ] + }, + "network_settings_ids": { + "description": "The unique identifier of each network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "example": "123ABC456DEF789" + }, + "failover_network_settings_ids": { + "description": "The unique identifier of each failover network settings in the configuration.", + "type": "array", + "items": { + "type": "string" + }, + "example": "123ABC456DEF789" + }, + "failover_network_enabled": { + "description": "Indicates whether the failover network resource is enabled.", + "type": "boolean", + "example": true + }, + "created_on": { + "description": "The time at which the network configuration was created, in ISO 8601 format.", + "type": "string", + "format": "date-time", + "example": "2024-04-26T11:31:07Z", + "nullable": true + } + }, + "required": [ + "id", + "name", + "created_on" + ] + }, + "network-settings": { + "title": "Hosted compute network settings resource", + "description": "A hosted compute network settings resource.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the network settings resource.", + "type": "string", + "example": "220F78DACB92BBFBC5E6F22DE1CCF52309D" + }, + "network_configuration_id": { + "description": "The identifier of the network configuration that is using this settings resource.", + "type": "string", + "example": "934E208B3EE0BD60CF5F752C426BFB53562" + }, + "name": { + "description": "The name of the network settings resource.", + "type": "string", + "example": "my-network-settings" + }, + "subnet_id": { + "description": "The subnet this network settings resource is configured for.", + "type": "string", + "example": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + }, + "region": { + "description": "The location of the subnet this network settings resource is configured for.", + "type": "string", + "example": "eastus" + } + }, + "required": [ + "id", + "name", + "subnet_id", + "region" + ] + }, + "team-organization": { + "title": "Team Organization", + "description": "Team Organization", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + }, + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_public_pages": { + "type": "boolean", + "example": true + }, + "members_can_create_private_pages": { + "type": "boolean", + "example": true + }, + "members_can_fork_private_repositories": { + "type": "boolean", + "example": false, + "nullable": true + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "archived_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "ldap-dn": { + "type": "string", + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "example": "cn=Enterprise Ops,ou=teams,dc=github,dc=com" + }, + "team-full": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "example": "notifications_enabled" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "$ref": "#/components/schemas/nullable-team-simple" + }, + "members_count": { + "type": "integer", + "example": 3 + }, + "repos_count": { + "type": "integer", + "example": 10 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-14T16:53:42Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-08-17T12:37:15Z" + }, + "organization": { + "$ref": "#/components/schemas/team-organization" + }, + "ldap_dn": { + "$ref": "#/components/schemas/ldap-dn" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "type", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] + }, + "team-membership": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" + }, + "state": { + "description": "The state of the user's membership in the team.", + "type": "string", + "enum": [ + "active", + "pending" + ] + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "team-repository": { + "title": "Team Repository", + "description": "A team's access to a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "default": false, + "type": "boolean", + "example": false + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean", + "example": false + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_has_downloads", + "patch": { + "properties": { + "has_downloads": null + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ] + }, + "rate-limit": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "rate-limit-overview": { + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "core": { + "$ref": "#/components/schemas/rate-limit" + }, + "graphql": { + "$ref": "#/components/schemas/rate-limit" + }, + "search": { + "$ref": "#/components/schemas/rate-limit" + }, + "code_search": { + "$ref": "#/components/schemas/rate-limit" + }, + "source_import": { + "$ref": "#/components/schemas/rate-limit" + }, + "integration_manifest": { + "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_upload": { + "$ref": "#/components/schemas/rate-limit" + }, + "actions_runner_registration": { + "$ref": "#/components/schemas/rate-limit" + }, + "scim": { + "$ref": "#/components/schemas/rate-limit" + }, + "dependency_snapshots": { + "$ref": "#/components/schemas/rate-limit" + }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" + } + }, + "required": [ + "core", + "search" + ] + }, + "rate": { + "$ref": "#/components/schemas/rate-limit" + } + }, + "required": [ + "rate", + "resources" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_rate_limit_rate", + "patch": { + "properties": { + "rate": null + }, + "required": [ + "resources" + ] + }, + "version": "2026-03-10" + } + ] + }, + "artifact": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "digest": { + "type": "string", + "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.", + "nullable": true, + "example": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c" + }, + "workflow_run": { + "type": "object", + "nullable": true, + "properties": { + "id": { + "example": 10, + "type": "integer" + }, + "repository_id": { + "example": 42, + "type": "integer" + }, + "head_repository_id": { + "example": 42, + "type": "integer" + }, + "head_branch": { + "example": "main", + "type": "string" + }, + "head_sha": { + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + } + } + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + }, + "actions-cache-retention-limit-for-repository": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "example": 14 + } + } + }, + "actions-cache-storage-limit-for-repository": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "example": 10 + } + } + }, + "actions-cache-list": { + "title": "Repository actions caches", + "description": "Repository actions caches", + "type": "object", + "properties": { + "total_count": { + "description": "Total number of caches", + "type": "integer", + "example": 2 + }, + "actions_caches": { + "description": "Array of caches", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 2 + }, + "ref": { + "type": "string", + "example": "refs/heads/main" + }, + "key": { + "type": "string", + "example": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + }, + "version": { + "type": "string", + "example": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + }, + "last_accessed_at": { + "type": "string", + "format": "date-time", + "example": "2019-01-24T22:45:36.000Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-01-24T22:45:36.000Z" + }, + "size_in_bytes": { + "type": "integer", + "example": 1024 + } + } + } + } + }, + "required": [ + "total_count", + "actions_caches" + ] + }, + "job": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] + }, + "created_at": { + "description": "The time that the job created, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + }, + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.", + "example": [ + "self-hosted", + "foo", + "bar" + ] + }, + "runner_id": { + "type": "integer", + "nullable": true, + "example": 1, + "description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_name": { + "type": "string", + "nullable": true, + "example": "my runner", + "description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_group_id": { + "type": "integer", + "nullable": true, + "example": 2, + "description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "runner_group_name": { + "type": "string", + "nullable": true, + "example": "my runner group", + "description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)" + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true, + "example": "Build" + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true, + "example": "main" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "workflow_name", + "head_branch", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "created_at" + ] + }, + "oidc-custom-sub-repo": { + "title": "Actions OIDC subject customization for a repository", + "description": "Actions OIDC subject customization for a repository", + "type": "object", + "properties": { + "use_default": { + "description": "Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.", + "type": "boolean" + }, + "include_claim_keys": { + "description": "Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "use_default" + ] + }, + "actions-secret": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "actions-variable": { + "title": "Actions Variable", + "type": "object", + "properties": { + "name": { + "description": "The name of the variable.", + "example": "USERNAME", + "type": "string" + }, + "value": { + "description": "The value of the variable.", + "example": "octocat", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "example": "2019-01-24T22:45:36.000Z" + }, + "updated_at": { + "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time", + "example": "2019-01-24T22:45:36.000Z" + } + }, + "required": [ + "name", + "value", + "created_at", + "updated_at" + ] + }, + "actions-enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "actions-repository-permissions": { + "type": "object", + "properties": { + "enabled": { + "$ref": "#/components/schemas/actions-enabled" + }, + "allowed_actions": { + "$ref": "#/components/schemas/allowed-actions" + }, + "selected_actions_url": { + "$ref": "#/components/schemas/selected-actions-url" + }, + "sha_pinning_required": { + "$ref": "#/components/schemas/sha-pinning-required" + } + }, + "required": [ + "enabled" + ] + }, + "actions-workflow-access-to-repository": { + "type": "object", + "properties": { + "access_level": { + "type": "string", + "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.", + "enum": [ + "none", + "user", + "organization" + ] + } + }, + "required": [ + "access_level" + ] + }, + "referenced-workflow": { + "title": "Referenced workflow", + "description": "A workflow referenced/reused by the initial caller workflow", + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "ref": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + }, + "nullable-simple-commit": { + "title": "Simple Commit", + "description": "A commit.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd" + }, + "tree_id": { + "type": "string", + "description": "SHA for the commit's tree" + }, + "message": { + "description": "Message describing the purpose of the commit", + "example": "Fix #42", + "type": "string" + }, + "timestamp": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "author": { + "type": "object", + "description": "Information about the Git author", + "properties": { + "name": { + "description": "Name of the commit's author", + "example": "Monalisa Octocat", + "type": "string" + }, + "email": { + "description": "Git email address of the commit's author", + "example": "monalisa.octocat@example.com", + "type": "string", + "format": "email" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "description": "Information about the Git committer", + "properties": { + "name": { + "description": "Name of the commit's committer", + "example": "Monalisa Octocat", + "type": "string" + }, + "email": { + "description": "Git email address of the commit's committer", + "example": "monalisa.octocat@example.com", + "type": "string", + "format": "email" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ], + "nullable": true + }, + "workflow-run": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "nullable": true, + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "check_suite_id": { + "type": "integer", + "description": "The ID of the associated check suite.", + "example": 42 + }, + "check_suite_node_id": { + "type": "string", + "description": "The node ID of the associated check suite.", + "example": "MDEwOkNoZWNrU3VpdGU0Mg==" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the workflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "path": { + "description": "The full path of the workflow", + "example": "octocat/octo-repo/.github/workflows/ci.yml@main", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "run_attempt": { + "type": "integer", + "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.", + "example": 1 + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/referenced-workflow" + } + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.", + "type": "array", + "nullable": true, + "items": { + "$ref": "#/components/schemas/pull-request-minimal" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "triggering_actor": { + "$ref": "#/components/schemas/simple-user" + }, + "run_started_at": { + "type": "string", + "format": "date-time", + "description": "The start time of the latest run. Resets on re-run." + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "previous_attempt_url": { + "nullable": true, + "description": "The URL to the previous attempted run of this workflow, if one exists.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "$ref": "#/components/schemas/nullable-simple-commit" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "head_repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "head_repository_id": { + "type": "integer", + "example": 5 + }, + "display_title": { + "type": "string", + "example": "Simple Workflow", + "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "display_title", + "event", + "status", + "conclusion", + "head_sha", + "path", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + }, + "environment-approvals": { + "title": "Environment Approval", + "description": "An entry in the reviews log for environment deployments", + "type": "object", + "properties": { + "environments": { + "description": "The list of environments that were approved or rejected", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + } + } + } + }, + "state": { + "description": "Whether deployment to the environment(s) was approved or rejected or pending (with comments)", + "enum": [ + "approved", + "rejected", + "pending" + ], + "example": "approved", + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "comment": { + "type": "string", + "description": "The comment submitted with the deployment review", + "example": "Ship it!" + } + }, + "required": [ + "environments", + "state", + "user", + "comment" + ] + }, + "review-custom-gates-comment-required": { + "type": "object", + "properties": { + "environment_name": { + "type": "string", + "description": "The name of the environment to approve or reject." + }, + "comment": { + "type": "string", + "description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**" + } + }, + "required": [ + "environment_name", + "comment" + ] + }, + "review-custom-gates-state-required": { + "type": "object", + "properties": { + "environment_name": { + "type": "string", + "description": "The name of the environment to approve or reject." + }, + "state": { + "type": "string", + "description": "Whether to approve or reject deployment to the specified environments.", + "enum": [ + "approved", + "rejected" + ] + }, + "comment": { + "type": "string", + "description": "Optional comment to include with the review." + } + }, + "required": [ + "environment_name", + "state" + ] + }, + "deployment-reviewer-type": { + "type": "string", + "description": "The type of reviewer.", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "pending-deployment": { + "title": "Pending Deployment", + "description": "Details of a deployment that is waiting for protection rules to pass", + "type": "object", + "properties": { + "environment": { + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "type": "integer", + "format": "int64", + "example": 56780428 + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + } + } + }, + "wait_timer": { + "type": "integer", + "description": "The set duration of the wait timer", + "example": 30 + }, + "wait_timer_started_at": { + "description": "The time that the wait timer began.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string", + "nullable": true + }, + "current_user_can_approve": { + "description": "Whether the currently authenticated user can approve the deployment", + "type": "boolean", + "example": true + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/deployment-reviewer-type" + }, + "reviewer": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/team" + } + ] + } + } + } + } + }, + "required": [ + "environment", + "wait_timer", + "wait_timer_started_at", + "current_user_can_approve", + "reviewers" + ] + }, + "deployment": { + "title": "Deployment", + "description": "A request for a specific ref(branch,sha,tag) to be deployed", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "format": "int64", + "example": 42 + }, + "node_id": { + "type": "string", + "example": "MDEwOkRlcGxveW1lbnQx" + }, + "sha": { + "type": "string", + "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "ref": { + "description": "The ref to deploy. This can be a branch, tag, or sha.", + "example": "topic-branch", + "type": "string" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "payload": { + "oneOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "string" + } + ] + }, + "original_environment": { + "type": "string", + "example": "staging" + }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + } + }, + "required": [ + "id", + "node_id", + "sha", + "ref", + "task", + "environment", + "creator", + "payload", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "workflow-run-usage": { + "title": "Workflow Run Usage", + "description": "Workflow Run Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + }, + "job_runs": { + "type": "array", + "items": { + "type": "object", + "required": [ + "job_id", + "duration_ms" + ], + "properties": { + "job_id": { + "type": "integer" + }, + "duration_ms": { + "type": "integer" + } + } + } + } + } + }, + "MACOS": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + }, + "job_runs": { + "type": "array", + "items": { + "type": "object", + "required": [ + "job_id", + "duration_ms" + ], + "properties": { + "job_id": { + "type": "integer" + }, + "duration_ms": { + "type": "integer" + } + } + } + } + } + }, + "WINDOWS": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + }, + "job_runs": { + "type": "array", + "items": { + "type": "object", + "required": [ + "job_id", + "duration_ms" + ], + "properties": { + "job_id": { + "type": "integer" + }, + "duration_ms": { + "type": "integer" + } + } + } + } + } + } + } + }, + "run_duration_ms": { + "type": "integer" + } + }, + "required": [ + "billable" + ] + }, + "workflow": { + "title": "Workflow", + "description": "A GitHub Actions workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDg6V29ya2Zsb3cxMg==" + }, + "name": { + "type": "string", + "example": "CI" + }, + "path": { + "type": "string", + "example": "ruby.yaml" + }, + "state": { + "type": "string", + "example": "active", + "enum": [ + "active", + "deleted", + "disabled_fork", + "disabled_inactivity", + "disabled_manually" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" + }, + "badge_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + } + }, + "required": [ + "id", + "node_id", + "name", + "path", + "state", + "url", + "html_url", + "badge_url", + "created_at", + "updated_at" + ] + }, + "workflow-run-id": { + "title": "Workflow Run ID", + "description": "The ID of the workflow run.", + "type": "integer", + "format": "int64" + }, + "workflow-dispatch-response": { + "title": "Workflow Dispatch Response", + "description": "Response containing the workflow run ID and URLs.", + "type": "object", + "properties": { + "workflow_run_id": { + "$ref": "#/components/schemas/workflow-run-id" + }, + "run_url": { + "type": "string", + "format": "uri", + "description": "The URL to the workflow run." + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "workflow_run_id", + "run_url", + "html_url" + ] + }, + "workflow-usage": { + "title": "Workflow Usage", + "description": "Workflow Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + }, + "MACOS": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + }, + "WINDOWS": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + } + } + } + }, + "required": [ + "billable" + ] + }, + "activity": { + "title": "Activity", + "description": "Activity", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "before": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "description": "The SHA of the commit before the activity." + }, + "after": { + "type": "string", + "example": "827efc6d56897b048c772eb4087f854f46256132", + "description": "The SHA of the commit after the activity." + }, + "ref": { + "type": "string", + "example": "refs/heads/main", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "The time when the activity occurred." + }, + "activity_type": { + "type": "string", + "example": "force_push", + "enum": [ + "push", + "force_push", + "branch_deletion", + "branch_creation", + "pr_merge", + "merge_queue_merge" + ], + "description": "The type of the activity that was performed." + }, + "actor": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "id", + "node_id", + "before", + "after", + "ref", + "timestamp", + "activity_type", + "actor" + ] + }, + "autolink": { + "title": "Autolink reference", + "description": "An autolink reference.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3 + }, + "key_prefix": { + "description": "The prefix of a key that is linkified.", + "example": "TICKET-", + "type": "string" + }, + "url_template": { + "description": "A template for the target URL that is generated if a key was found.", + "example": "https://example.com/TICKET?query=", + "type": "string" + }, + "is_alphanumeric": { + "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.", + "example": true, + "type": "boolean" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "key_prefix", + "url_template", + "is_alphanumeric" + ] + }, + "check-automated-security-fixes": { + "title": "Check Dependabot security updates", + "description": "Check Dependabot security updates", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "example": true, + "description": "Whether Dependabot security updates are enabled for the repository." + }, + "paused": { + "type": "boolean", + "example": false, + "description": "Whether Dependabot security updates are paused for the repository." + } + }, + "required": [ + "enabled", + "paused" + ] + }, + "protected-branch-required-status-check": { + "title": "Protected Branch Required Status Check", + "description": "Protected Branch Required Status Check", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string" + }, + "app_id": { + "type": "integer", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string" + }, + "strict": { + "type": "boolean" + } + }, + "required": [ + "contexts", + "checks" + ] + }, + "protected-branch-admin-enforced": { + "title": "Protected Branch Admin Enforced", + "description": "Protected Branch Admin Enforced", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins" + }, + "enabled": { + "type": "boolean", + "example": true + } + }, + "required": [ + "url", + "enabled" + ] + }, + "protected-branch-pull-request-review": { + "title": "Protected Branch Pull Request Review", + "description": "Protected Branch Pull Request Review", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "users": { + "description": "The list of users with review dismissal access.", + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "teams": { + "description": "The list of teams with review dismissal access.", + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "apps": { + "description": "The list of apps with review dismissal access.", + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + }, + "url": { + "type": "string", + "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions\"" + }, + "users_url": { + "type": "string", + "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users\"" + }, + "teams_url": { + "type": "string", + "example": "\"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams\"" + } + } + }, + "bypass_pull_request_allowances": { + "type": "object", + "description": "Allow specific users, teams, or apps to bypass pull request requirements.", + "properties": { + "users": { + "description": "The list of users allowed to bypass pull request requirements.", + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "teams": { + "description": "The list of teams allowed to bypass pull request requirements.", + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "apps": { + "description": "The list of apps allowed to bypass pull request requirements.", + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean", + "example": true + }, + "require_code_owner_reviews": { + "type": "boolean", + "example": true + }, + "required_approving_review_count": { + "type": "integer", + "minimum": 0, + "maximum": 6, + "example": 2 + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", + "type": "boolean", + "example": true, + "default": false + } + }, + "required": [ + "dismiss_stale_reviews", + "require_code_owner_reviews" + ] + }, + "branch-restriction-policy": { + "title": "Branch Restriction Policy", + "description": "Branch Restriction Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "apps_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "apps": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "example": "\"\"" + }, + "html_url": { + "type": "string", + "example": "\"https://github.com/testorg-ea8ec76d71c3af4b\"" + }, + "followers_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\"" + }, + "following_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\"" + }, + "gists_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\"" + }, + "starred_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\"" + }, + "subscriptions_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\"" + }, + "organizations_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\"" + }, + "received_events_url": { + "type": "string", + "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\"" + }, + "type": { + "type": "string", + "example": "\"Organization\"" + }, + "site_admin": { + "type": "boolean", + "example": false + }, + "user_view_type": { + "type": "string", + "example": "public" + } + } + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "apps_url", + "users", + "teams", + "apps" + ] + }, + "branch-protection": { + "title": "Branch Protection", + "description": "Branch Protection", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "$ref": "#/components/schemas/protected-branch-required-status-check" + }, + "enforce_admins": { + "$ref": "#/components/schemas/protected-branch-admin-enforced" + }, + "required_pull_request_reviews": { + "$ref": "#/components/schemas/protected-branch-pull-request-review" + }, + "restrictions": { + "$ref": "#/components/schemas/branch-restriction-policy" + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "name": { + "type": "string", + "example": "\"branch/with/protection\"" + }, + "protection_url": { + "type": "string", + "example": "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\"" + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + }, + "enabled": { + "type": "boolean", + "example": true + } + }, + "required": [ + "url", + "enabled" + ] + }, + "lock_branch": { + "type": "object", + "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", + "properties": { + "enabled": { + "default": false, + "type": "boolean" + } + } + }, + "allow_fork_syncing": { + "type": "object", + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", + "properties": { + "enabled": { + "default": false, + "type": "boolean" + } + } + } + } + }, + "short-branch": { + "title": "Short Branch", + "description": "Short Branch", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "$ref": "#/components/schemas/branch-protection" + }, + "protection_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "commit", + "protected" + ] + }, + "nullable-git-user": { + "title": "Git User", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "\"Chris Wanstrath\"" + }, + "email": { + "type": "string", + "example": "\"chris@ozmm.org\"" + }, + "date": { + "type": "string", + "format": "date-time", + "example": "\"2007-10-29T02:42:39.000-07:00\"" + } + }, + "nullable": true + }, + "verification": { + "title": "Verification", + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "payload": { + "type": "string", + "nullable": true + }, + "signature": { + "type": "string", + "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "verified", + "reason", + "payload", + "signature", + "verified_at" + ] + }, + "diff-entry": { + "title": "Diff Entry", + "description": "Diff Entry", + "type": "object", + "properties": { + "sha": { + "type": "string", + "nullable": true, + "example": "bbcd538c8e72b8c175046e27cc8f907076331401" + }, + "filename": { + "type": "string", + "example": "file1.txt" + }, + "status": { + "type": "string", + "enum": [ + "added", + "removed", + "modified", + "renamed", + "copied", + "changed", + "unchanged" + ], + "example": "added" + }, + "additions": { + "type": "integer", + "example": 103 + }, + "deletions": { + "type": "integer", + "example": 21 + }, + "changes": { + "type": "integer", + "example": 124 + }, + "blob_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + }, + "raw_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt" + }, + "contents_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "patch": { + "type": "string", + "example": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + }, + "previous_filename": { + "type": "string", + "example": "file.txt" + } + }, + "required": [ + "additions", + "blob_url", + "changes", + "contents_url", + "deletions", + "filename", + "raw_url", + "sha", + "status" + ] + }, + "commit": { + "title": "Commit", + "description": "Commit", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "sha": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "node_id": { + "type": "string", + "example": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "author": { + "$ref": "#/components/schemas/nullable-git-user" + }, + "committer": { + "$ref": "#/components/schemas/nullable-git-user" + }, + "message": { + "type": "string", + "example": "Fix all the bugs" + }, + "comment_count": { + "type": "integer", + "example": 0 + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "example": "827efc6d56897b048c772eb4087f854f46256132" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132" + } + }, + "required": [ + "sha", + "url" + ] + }, + "verification": { + "$ref": "#/components/schemas/verification" + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] + }, + "committer": { + "nullable": true, + "oneOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/empty-object" + } + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "integer" + }, + "deletions": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/diff-entry" + } + } + }, + "required": [ + "url", + "sha", + "node_id", + "html_url", + "comments_url", + "commit", + "author", + "committer", + "parents" + ] + }, + "branch-with-protection": { + "title": "Branch With Protection", + "description": "Branch With Protection", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "$ref": "#/components/schemas/commit" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "html", + "self" + ] + }, + "protected": { + "type": "boolean" + }, + "protection": { + "$ref": "#/components/schemas/branch-protection" + }, + "protection_url": { + "type": "string", + "format": "uri" + }, + "pattern": { + "type": "string", + "example": "\"mas*\"" + }, + "required_approving_review_count": { + "type": "integer", + "example": 1 + } + }, + "required": [ + "name", + "commit", + "_links", + "protection", + "protected", + "protection_url" + ] + }, + "status-check-policy": { + "title": "Status Check Policy", + "description": "Status Check Policy", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks" + }, + "strict": { + "type": "boolean", + "example": true + }, + "contexts": { + "type": "array", + "example": [ + "continuous-integration/travis-ci" + ], + "items": { + "type": "string" + } + }, + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "context": { + "type": "string", + "example": "continuous-integration/travis-ci" + }, + "app_id": { + "type": "integer", + "nullable": true + } + }, + "required": [ + "context", + "app_id" + ] + } + }, + "contexts_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + } + }, + "required": [ + "url", + "contexts_url", + "strict", + "contexts", + "checks" + ] + }, + "protected-branch": { + "title": "Protected Branch", + "description": "Branch protections protect branches", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "required_status_checks": { + "$ref": "#/components/schemas/status-check-policy" + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it.", + "type": "boolean", + "default": false + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "users_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "apps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + } + }, + "required": [ + "url", + "users_url", + "teams_url", + "users", + "teams" + ] + }, + "bypass_pull_request_allowances": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + }, + "apps": { + "type": "array", + "items": { + "$ref": "#/components/schemas/integration" + } + } + }, + "required": [ + "users", + "teams" + ] + } + }, + "required": [ + "url" + ] + }, + "required_signatures": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures" + }, + "enabled": { + "type": "boolean", + "example": true + } + }, + "required": [ + "url", + "enabled" + ] + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "url", + "enabled" + ] + }, + "required_linear_history": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_force_pushes": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "allow_deletions": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "restrictions": { + "$ref": "#/components/schemas/branch-restriction-policy" + }, + "required_conversation_resolution": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "block_creations": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "enabled" + ] + }, + "lock_branch": { + "type": "object", + "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.", + "properties": { + "enabled": { + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false + }, + "allow_fork_syncing": { + "type": "object", + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.", + "properties": { + "enabled": { + "default": false, + "type": "boolean" + } + }, + "additionalProperties": false + } + }, + "required": [ + "url" + ] + }, + "deployment-simple": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOkRlcGxveW1lbnQx" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "original_environment": { + "type": "string", + "example": "staging" + }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "check-run": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "id": { + "description": "The id of the check.", + "example": 21, + "type": "integer", + "format": "int64" + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "external_id": { + "type": "string", + "example": "42", + "nullable": true + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "details_url": { + "type": "string", + "example": "https://example.com", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ] + }, + "conclusion": { + "type": "string", + "example": "neutral", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ], + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time", + "example": "2018-05-04T01:14:52Z", + "nullable": true + }, + "completed_at": { + "type": "string", + "format": "date-time", + "example": "2018-05-04T01:14:52Z", + "nullable": true + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "text": { + "type": "string", + "nullable": true + }, + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "name": { + "description": "The name of the check.", + "example": "test-coverage", + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ], + "nullable": true + }, + "app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "pull_requests": { + "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.", + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-minimal" + } + }, + "deployment": { + "$ref": "#/components/schemas/deployment-simple" + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "check-annotation": { + "title": "Check Annotation", + "description": "Check Annotation", + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "README.md" + }, + "start_line": { + "type": "integer", + "example": 2 + }, + "end_line": { + "type": "integer", + "example": 2 + }, + "start_column": { + "type": "integer", + "example": 5, + "nullable": true + }, + "end_column": { + "type": "integer", + "example": 10, + "nullable": true + }, + "annotation_level": { + "type": "string", + "example": "warning", + "nullable": true + }, + "title": { + "type": "string", + "example": "Spell Checker", + "nullable": true + }, + "message": { + "type": "string", + "example": "Check your spelling for 'banaas'.", + "nullable": true + }, + "raw_details": { + "type": "string", + "example": "Do you mean 'bananas' or 'banana'?", + "nullable": true + }, + "blob_href": { + "type": "string" + } + }, + "required": [ + "path", + "blob_href", + "start_line", + "end_line", + "start_column", + "end_column", + "annotation_level", + "title", + "message", + "raw_details" + ] + }, + "simple-commit": { + "title": "Simple Commit", + "description": "A commit.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd" + }, + "tree_id": { + "type": "string", + "description": "SHA for the commit's tree" + }, + "message": { + "description": "Message describing the purpose of the commit", + "example": "Fix #42", + "type": "string" + }, + "timestamp": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "author": { + "type": "object", + "description": "Information about the Git author", + "properties": { + "name": { + "description": "Name of the commit's author", + "example": "Monalisa Octocat", + "type": "string" + }, + "email": { + "description": "Git email address of the commit's author", + "example": "monalisa.octocat@example.com", + "type": "string", + "format": "email" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "description": "Information about the Git committer", + "properties": { + "name": { + "description": "Name of the commit's committer", + "example": "Monalisa Octocat", + "type": "string" + }, + "email": { + "description": "Git email address of the commit's committer", + "example": "monalisa.octocat@example.com", + "type": "string", + "format": "email" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "check-suite": { + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5, + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "example": "master", + "nullable": true + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "status": { + "type": "string", + "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.", + "example": "completed", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "requested", + "pending" + ], + "nullable": true + }, + "conclusion": { + "type": "string", + "example": "neutral", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "startup_failure", + "stale", + null + ], + "nullable": true + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/5", + "nullable": true + }, + "before": { + "type": "string", + "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "nullable": true + }, + "after": { + "type": "string", + "example": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-minimal" + }, + "nullable": true + }, + "app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "head_commit": { + "$ref": "#/components/schemas/simple-commit" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "check_runs_url": { + "type": "string" + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "status", + "conclusion", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", + "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", + "pull_requests" + ] + }, + "check-suite-preference": { + "title": "Check Suite Preference", + "description": "Check suite configuration preferences for a repository.", + "type": "object", + "required": [ + "preferences", + "repository" + ], + "properties": { + "preferences": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer" + }, + "setting": { + "type": "boolean" + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + } + } + }, + "code-scanning-alert-items": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "instances_url": { + "$ref": "#/components/schemas/alert-instances-url" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" + }, + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "rule": { + "$ref": "#/components/schemas/code-scanning-alert-rule-summary" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis-tool" + }, + "most_recent_instance": { + "$ref": "#/components/schemas/code-scanning-alert-instance" + }, + "dismissal_approved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + }, + "code-scanning-alert-rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "security_severity_level": { + "nullable": true, + "type": "string", + "description": "The security severity of the alert.", + "enum": [ + "low", + "medium", + "high", + "critical" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "A description of the rule used to detect the alert." + }, + "tags": { + "nullable": true, + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "nullable": true, + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + }, + "help_uri": { + "nullable": true, + "type": "string", + "description": "A link to the documentation for the rule used to detect the alert." + } + } + }, + "code-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "instances_url": { + "$ref": "#/components/schemas/alert-instances-url" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert-state" + }, + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" + }, + "dismissed_reason": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "rule": { + "$ref": "#/components/schemas/code-scanning-alert-rule" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis-tool" + }, + "most_recent_instance": { + "$ref": "#/components/schemas/code-scanning-alert-instance" + }, + "dismissal_approved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + }, + "code-scanning-alert-set-state": { + "description": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "type": "string", + "enum": [ + "open", + "dismissed" + ] + }, + "code-scanning-alert-create-request": { + "type": "boolean", + "description": "If `true`, attempt to create an alert dismissal request." + }, + "code-scanning-alert-assignees": { + "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert.", + "type": "array", + "items": { + "type": "string" + } + }, + "code-scanning-autofix-status": { + "type": "string", + "description": "The status of an autofix.", + "enum": [ + "pending", + "error", + "success", + "outdated" + ] + }, + "code-scanning-autofix-description": { + "type": "string", + "description": "The description of an autofix.", + "nullable": true + }, + "code-scanning-autofix-started-at": { + "type": "string", + "description": "The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "code-scanning-autofix": { + "type": "object", + "properties": { + "status": { + "$ref": "#/components/schemas/code-scanning-autofix-status" + }, + "description": { + "$ref": "#/components/schemas/code-scanning-autofix-description" + }, + "started_at": { + "$ref": "#/components/schemas/code-scanning-autofix-started-at" + } + }, + "required": [ + "status", + "description", + "started_at" + ] + }, + "code-scanning-autofix-commits": { + "description": "Commit an autofix for a code scanning alert", + "type": "object", + "properties": { + "target_ref": { + "description": "The Git reference of target branch for the commit. Branch needs to already exist. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "type": "string" + }, + "message": { + "description": "Commit message to be used.", + "type": "string" + } + }, + "nullable": true + }, + "code-scanning-autofix-commits-response": { + "type": "object", + "properties": { + "target_ref": { + "type": "string", + "description": "The Git reference of target branch for the commit. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation." + }, + "sha": { + "type": "string", + "description": "SHA of commit with autofix." + } + } + }, + "code-scanning-alert-instance-state": { + "type": "string", + "description": "State of a code scanning alert instance.", + "nullable": true, + "enum": [ + "open", + "fixed" + ] + }, + "code-scanning-alert-instance-list": { + "type": "object", + "properties": { + "ref": { + "$ref": "#/components/schemas/code-scanning-ref" + }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + }, + "environment": { + "$ref": "#/components/schemas/code-scanning-alert-environment" + }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, + "state": { + "$ref": "#/components/schemas/code-scanning-alert-instance-state" + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "$ref": "#/components/schemas/code-scanning-alert-location" + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "$ref": "#/components/schemas/code-scanning-alert-classification" + } + } + } + }, + "code-scanning-analysis-sarif-id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53" + }, + "code-scanning-analysis-commit-sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "code-scanning-analysis-environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "code-scanning-analysis-created-at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true + }, + "code-scanning-analysis-url": { + "type": "string", + "description": "The REST API URL of the analysis resource.", + "format": "uri", + "readOnly": true + }, + "code-scanning-analysis": { + "type": "object", + "properties": { + "ref": { + "$ref": "#/components/schemas/code-scanning-ref" + }, + "commit_sha": { + "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" + }, + "analysis_key": { + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + }, + "environment": { + "$ref": "#/components/schemas/code-scanning-analysis-environment" + }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, + "error": { + "type": "string", + "example": "error reading field xyz" + }, + "created_at": { + "$ref": "#/components/schemas/code-scanning-analysis-created-at" + }, + "results_count": { + "type": "integer", + "description": "The total number of results in the analysis." + }, + "rules_count": { + "type": "integer", + "description": "The total number of rules used in the analysis." + }, + "id": { + "type": "integer", + "description": "Unique identifier for this analysis." + }, + "url": { + "$ref": "#/components/schemas/code-scanning-analysis-url" + }, + "sarif_id": { + "$ref": "#/components/schemas/code-scanning-analysis-sarif-id" + }, + "tool": { + "$ref": "#/components/schemas/code-scanning-analysis-tool" + }, + "deletable": { + "type": "boolean" + }, + "warning": { + "type": "string", + "description": "Warning generated when processing the analysis", + "example": "123 results were ignored" + } + }, + "required": [ + "ref", + "commit_sha", + "analysis_key", + "environment", + "error", + "created_at", + "results_count", + "rules_count", + "id", + "url", + "sarif_id", + "tool", + "deletable", + "warning" + ] + }, + "code-scanning-analysis-deletion": { + "title": "Analysis deletion", + "description": "Successful deletion of a code scanning analysis", + "type": "object", + "properties": { + "next_analysis_url": { + "type": "string", + "description": "Next deletable analysis in chain, without last analysis deletion confirmation", + "format": "uri", + "readOnly": true, + "nullable": true + }, + "confirm_delete_url": { + "type": "string", + "description": "Next deletable analysis in chain, with last analysis deletion confirmation", + "format": "uri", + "readOnly": true, + "nullable": true + } + }, + "required": [ + "next_analysis_url", + "confirm_delete_url" + ] + }, + "code-scanning-codeql-database": { + "title": "CodeQL Database", + "description": "A CodeQL database.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the CodeQL database." + }, + "name": { + "type": "string", + "description": "The name of the CodeQL database." + }, + "language": { + "type": "string", + "description": "The language of the CodeQL database." + }, + "uploader": { + "$ref": "#/components/schemas/simple-user" + }, + "content_type": { + "type": "string", + "description": "The MIME type of the CodeQL database file." + }, + "size": { + "type": "integer", + "description": "The size of the CodeQL database file in bytes." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property." + }, + "commit_oid": { + "type": "string", + "description": "The commit SHA of the repository at the time the CodeQL database was created.", + "nullable": true + } + }, + "required": [ + "id", + "name", + "language", + "uploader", + "content_type", + "size", + "created_at", + "updated_at", + "url" + ] + }, + "code-scanning-variant-analysis-language": { + "type": "string", + "description": "The language targeted by the CodeQL query", + "enum": [ + "actions", + "cpp", + "csharp", + "go", + "java", + "javascript", + "python", + "ruby", + "rust", + "swift" + ] + }, + "code-scanning-variant-analysis-repository": { + "title": "Repository Identifier", + "description": "Repository Identifier", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269, + "description": "A unique identifier of the repository." + }, + "name": { + "type": "string", + "example": "Hello-World", + "description": "The name of the repository." + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World", + "description": "The full, globally unique, name of the repository." + }, + "private": { + "type": "boolean", + "description": "Whether the repository is private." + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + } + }, + "required": [ + "full_name", + "id", + "name", + "private", + "stargazers_count", + "updated_at" + ] + }, + "code-scanning-variant-analysis-status": { + "type": "string", + "description": "The new status of the CodeQL variant analysis repository task.", + "enum": [ + "pending", + "in_progress", + "succeeded", + "failed", + "canceled", + "timed_out" + ] + }, + "code-scanning-variant-analysis-skipped-repo-group": { + "type": "object", + "properties": { + "repository_count": { + "type": "integer", + "description": "The total number of repositories that were skipped for this reason.", + "example": 2 + }, + "repositories": { + "type": "array", + "description": "A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it.", + "items": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" + } + } + }, + "required": [ + "repository_count", + "repositories" + ] + }, + "code-scanning-variant-analysis": { + "title": "Variant Analysis", + "description": "A run of a CodeQL query against one or more repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the variant analysis." + }, + "controller_repo": { + "$ref": "#/components/schemas/simple-repository" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "query_language": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-language" + }, + "query_pack_url": { + "type": "string", + "description": "The download url for the query pack." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ." + }, + "completed_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "succeeded", + "failed", + "cancelled" + ] + }, + "actions_workflow_run_id": { + "type": "integer", + "description": "The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started." + }, + "failure_reason": { + "type": "string", + "enum": [ + "no_repos_queried", + "actions_workflow_run_failed", + "internal_error" + ], + "description": "The reason for a failure of the variant analysis. This is only available if the variant analysis has failed." + }, + "scanned_repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "repository": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-repository" + }, + "analysis_status": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-status" + }, + "result_count": { + "type": "integer", + "description": "The number of results in the case of a successful analysis. This is only available for successful analyses." + }, + "artifact_size_in_bytes": { + "type": "integer", + "description": "The size of the artifact. This is only available for successful analyses." + }, + "failure_message": { + "type": "string", + "description": "The reason of the failure of this repo task. This is only available if the repository task has failed." + } + }, + "required": [ + "repository", + "analysis_status" + ] + } + }, + "skipped_repositories": { + "type": "object", + "description": "Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis.", + "properties": { + "access_mismatch_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + }, + "not_found_repos": { + "type": "object", + "properties": { + "repository_count": { + "type": "integer", + "description": "The total number of repositories that were skipped for this reason.", + "example": 2 + }, + "repository_full_names": { + "type": "array", + "description": "A list of full repository names that were skipped. This list may not include all repositories that were skipped.", + "items": { + "type": "string" + } + } + }, + "required": [ + "repository_count", + "repository_full_names" + ] + }, + "no_codeql_db_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + }, + "over_limit_repos": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group" + } + }, + "required": [ + "access_mismatch_repos", + "not_found_repos", + "no_codeql_db_repos", + "over_limit_repos" + ] + } + }, + "required": [ + "id", + "controller_repo", + "actor", + "query_language", + "query_pack_url", + "status" + ] + }, + "code-scanning-variant-analysis-repo-task": { + "type": "object", + "properties": { + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "analysis_status": { + "$ref": "#/components/schemas/code-scanning-variant-analysis-status" + }, + "artifact_size_in_bytes": { + "type": "integer", + "description": "The size of the artifact. This is only available for successful analyses." + }, + "result_count": { + "type": "integer", + "description": "The number of results in the case of a successful analysis. This is only available for successful analyses." + }, + "failure_message": { + "type": "string", + "description": "The reason of the failure of this repo task. This is only available if the repository task has failed." + }, + "database_commit_sha": { + "type": "string", + "description": "The SHA of the commit the CodeQL database was built against. This is only available for successful analyses." + }, + "source_location_prefix": { + "type": "string", + "description": "The source location prefix to use. This is only available for successful analyses." + }, + "artifact_url": { + "type": "string", + "description": "The URL of the artifact. This is only available for successful analyses." + } + }, + "required": [ + "repository", + "analysis_status" + ] + }, + "code-scanning-default-setup": { + "description": "Configuration for code scanning default setup.", + "type": "object", + "properties": { + "state": { + "description": "Code scanning default setup has been configured or not.", + "type": "string", + "enum": [ + "configured", + "not-configured" + ] + }, + "languages": { + "description": "Languages to be analyzed.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "actions", + "c-cpp", + "csharp", + "go", + "java-kotlin", + "javascript-typescript", + "javascript", + "python", + "ruby", + "typescript", + "swift" + ] + } + }, + "runner_type": { + "description": "Runner type to be used.", + "nullable": true, + "type": "string", + "enum": [ + "standard", + "labeled" + ] + }, + "runner_label": { + "description": "Runner label to be used if the runner type is labeled.", + "nullable": true, + "type": "string", + "example": "code-scanning" + }, + "query_suite": { + "description": "CodeQL query suite to be used.", + "type": "string", + "enum": [ + "default", + "extended" + ] + }, + "threat_model": { + "description": "Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input.", + "type": "string", + "enum": [ + "remote", + "remote_and_local" + ] + }, + "updated_at": { + "description": "Timestamp of latest configuration update.", + "nullable": true, + "type": "string", + "format": "date-time", + "example": "2023-12-06T14:20:20.000Z" + }, + "schedule": { + "description": "The frequency of the periodic analysis.", + "nullable": true, + "type": "string", + "enum": [ + "weekly" + ] + } + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_single_js_ts", + "patch": { + "properties": { + "languages": { + "items": { + "enum": [ + "actions", + "c-cpp", + "csharp", + "go", + "java-kotlin", + "javascript-typescript", + "python", + "ruby", + "swift" + ] + } + } + } + }, + "version": "2026-03-10" + } + ] + }, + "code-scanning-default-setup-update": { + "description": "Configuration for code scanning default setup.", + "type": "object", + "properties": { + "state": { + "description": "The desired state of code scanning default setup.", + "type": "string", + "enum": [ + "configured", + "not-configured" + ] + }, + "runner_type": { + "description": "Runner type to be used.", + "type": "string", + "enum": [ + "standard", + "labeled" + ] + }, + "runner_label": { + "nullable": true, + "description": "Runner label to be used if the runner type is labeled.", + "type": "string", + "example": "code-scanning" + }, + "query_suite": { + "description": "CodeQL query suite to be used.", + "type": "string", + "enum": [ + "default", + "extended" + ] + }, + "threat_model": { + "description": "Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input.", + "type": "string", + "enum": [ + "remote", + "remote_and_local" + ] + }, + "languages": { + "description": "CodeQL languages to be analyzed.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "actions", + "c-cpp", + "csharp", + "go", + "java-kotlin", + "javascript-typescript", + "python", + "ruby", + "swift" + ] + } + } + }, + "additionalProperties": false + }, + "code-scanning-default-setup-update-response": { + "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object.", + "type": "object", + "properties": { + "run_id": { + "description": "ID of the corresponding run.", + "type": "integer" + }, + "run_url": { + "description": "URL of the corresponding run.", + "type": "string" + } + } + }, + "code-scanning-ref-full": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.", + "pattern": "^refs/(heads|tags|pull)/.*$", + "example": "refs/heads/main" + }, + "code-scanning-analysis-sarif-file": { + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"", + "type": "string" + }, + "code-scanning-sarifs-receipt": { + "type": "object", + "properties": { + "id": { + "$ref": "#/components/schemas/code-scanning-analysis-sarif-id" + }, + "url": { + "type": "string", + "description": "The REST API URL for checking the status of the upload.", + "format": "uri", + "readOnly": true + } + } + }, + "code-scanning-sarifs-status": { + "type": "object", + "properties": { + "processing_status": { + "type": "string", + "enum": [ + "pending", + "complete", + "failed" + ], + "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed." + }, + "analyses_url": { + "type": "string", + "description": "The REST API URL for getting the analyses associated with the upload.", + "format": "uri", + "readOnly": true, + "nullable": true + }, + "errors": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Any errors that ocurred during processing of the delivery.", + "readOnly": true, + "nullable": true + } + } + }, + "code-security-configuration-for-repository": { + "type": "object", + "description": "Code security configuration associated with a repository and attachment status", + "properties": { + "status": { + "type": "string", + "description": "The attachment status of the code security configuration on the repository.", + "enum": [ + "attached", + "attaching", + "detached", + "removed", + "enforced", + "failed", + "updating", + "removed_by_enterprise" + ] + }, + "configuration": { + "$ref": "#/components/schemas/code-security-configuration" + } + } + }, + "codeowners-errors": { + "title": "CODEOWNERS errors", + "description": "A list of errors found in a repo's CODEOWNERS file", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "line": { + "description": "The line number where this errors occurs.", + "type": "integer", + "example": 7 + }, + "column": { + "description": "The column number where this errors occurs.", + "type": "integer", + "example": 3 + }, + "source": { + "description": "The contents of the line where the error occurs.", + "type": "string", + "example": "* user" + }, + "kind": { + "description": "The type of error.", + "type": "string", + "example": "Invalid owner" + }, + "suggestion": { + "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.", + "type": "string", + "nullable": true, + "example": "The pattern `/` will never match anything, did you mean `*` instead?" + }, + "message": { + "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).", + "type": "string", + "example": "Invalid owner on line 7:\n\n * user\n ^" + }, + "path": { + "description": "The path of the file where the error occured.", + "type": "string", + "example": ".github/CODEOWNERS" + } + }, + "required": [ + "line", + "column", + "kind", + "message", + "path" + ] + } + } + }, + "required": [ + "errors" + ] + }, + "codespace-machine": { + "type": "object", + "title": "Codespace machine", + "description": "A description of the machine powering a codespace.", + "properties": { + "name": { + "type": "string", + "description": "The name of the machine.", + "example": "standardLinux" + }, + "display_name": { + "type": "string", + "description": "The display name of the machine includes cores, memory, and storage.", + "example": "4 cores, 16 GB RAM, 64 GB storage" + }, + "operating_system": { + "type": "string", + "description": "The operating system of the machine.", + "example": "linux" + }, + "storage_in_bytes": { + "type": "integer", + "description": "How much storage is available to the codespace.", + "example": 68719476736 + }, + "memory_in_bytes": { + "type": "integer", + "description": "How much memory is available to the codespace.", + "example": 17179869184 + }, + "cpus": { + "type": "integer", + "description": "How many cores are available to the codespace.", + "example": 4 + }, + "prebuild_availability": { + "type": "string", + "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status.", + "example": "ready", + "enum": [ + "none", + "ready", + "in_progress" + ], + "nullable": true + } + }, + "required": [ + "name", + "display_name", + "operating_system", + "storage_in_bytes", + "memory_in_bytes", + "cpus", + "prebuild_availability" + ] + }, + "codespaces-permissions-check-for-devcontainer": { + "title": "Codespaces Permissions Check", + "description": "Permission check result for a given devcontainer config.", + "type": "object", + "properties": { + "accepted": { + "description": "Whether the user has accepted the permissions defined by the devcontainer config", + "example": true, + "type": "boolean" + } + }, + "required": [ + "accepted" + ] + }, + "repo-codespaces-secret": { + "title": "Codespaces Secret", + "description": "Set repository secrets for GitHub Codespaces.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "collaborator": { + "title": "Collaborator", + "description": "Collaborator", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "role_name" + ] + }, + "repository-invitation": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository invitation.", + "example": 42, + "type": "integer", + "format": "int64" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "invitee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "inviter": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "permissions": { + "description": "The permission associated with the invitation.", + "example": "read", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "triage", + "maintain" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-06-13T14:52:50-05:00" + }, + "expired": { + "description": "Whether or not the invitation has expired", + "type": "boolean" + }, + "url": { + "description": "URL for the repository invitation", + "example": "https://api.github.com/user/repository-invitations/1", + "type": "string" + }, + "html_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World/invitations" + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "permissions", + "inviter", + "invitee", + "repository", + "url", + "html_url", + "created_at" + ] + }, + "nullable-collaborator": { + "title": "Collaborator", + "description": "Collaborator", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "email": { + "nullable": true, + "type": "string" + }, + "name": { + "nullable": true, + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "role_name" + ], + "nullable": true + }, + "repository-collaborator-permission": { + "title": "Repository Collaborator Permission", + "description": "Repository Collaborator Permission", + "type": "object", + "properties": { + "permission": { + "type": "string" + }, + "role_name": { + "type": "string", + "example": "admin" + }, + "user": { + "$ref": "#/components/schemas/nullable-collaborator" + } + }, + "required": [ + "permission", + "role_name", + "user" + ] + }, + "commit-comment": { + "title": "Commit Comment", + "description": "Commit Comment", + "type": "object", + "properties": { + "html_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": "string", + "nullable": true + }, + "position": { + "type": "integer", + "nullable": true + }, + "line": { + "type": "integer", + "nullable": true + }, + "commit_id": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "url", + "html_url", + "id", + "node_id", + "user", + "position", + "line", + "path", + "commit_id", + "body", + "author_association", + "created_at", + "updated_at" + ] + }, + "reaction": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "branch-short": { + "title": "Branch Short", + "description": "Branch Short", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "sha", + "url" + ] + }, + "protected": { + "type": "boolean" + } + }, + "required": [ + "name", + "commit", + "protected" + ] + }, + "simple-commit-status": { + "title": "Simple Commit Status", + "type": "object", + "properties": { + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "context": { + "type": "string" + }, + "target_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "required": { + "type": "boolean", + "nullable": true + }, + "avatar_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "description", + "id", + "node_id", + "state", + "context", + "target_url", + "avatar_url", + "url", + "created_at", + "updated_at" + ] + }, + "combined-commit-status": { + "title": "Combined Commit Status", + "description": "Combined Commit Status", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-commit-status" + } + }, + "sha": { + "type": "string" + }, + "total_count": { + "type": "integer" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "commit_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "state", + "sha", + "total_count", + "statuses", + "repository", + "commit_url", + "url" + ] + }, + "status": { + "title": "Status", + "description": "The status of a commit.", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "target_url": { + "type": "string", + "nullable": true + }, + "context": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "url", + "avatar_url", + "id", + "node_id", + "state", + "description", + "target_url", + "context", + "created_at", + "updated_at", + "creator" + ] + }, + "nullable-code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" + }, + "key": { + "type": "string", + "example": "citizen_code_of_conduct" + }, + "name": { + "type": "string", + "example": "Citizen Code of Conduct" + }, + "html_url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ], + "nullable": true + }, + "nullable-community-health-file": { + "title": "Community Health File", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url" + ], + "nullable": true + }, + "community-profile": { + "title": "Community Profile", + "description": "Community Profile", + "type": "object", + "properties": { + "health_percentage": { + "type": "integer", + "example": 100 + }, + "description": { + "type": "string", + "example": "My first repository on GitHub!", + "nullable": true + }, + "documentation": { + "type": "string", + "example": "example.com", + "nullable": true + }, + "files": { + "type": "object", + "properties": { + "code_of_conduct": { + "$ref": "#/components/schemas/nullable-code-of-conduct-simple" + }, + "code_of_conduct_file": { + "$ref": "#/components/schemas/nullable-community-health-file" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "contributing": { + "$ref": "#/components/schemas/nullable-community-health-file" + }, + "readme": { + "$ref": "#/components/schemas/nullable-community-health-file" + }, + "issue_template": { + "$ref": "#/components/schemas/nullable-community-health-file" + }, + "pull_request_template": { + "$ref": "#/components/schemas/nullable-community-health-file" + } + }, + "required": [ + "code_of_conduct", + "code_of_conduct_file", + "license", + "contributing", + "readme", + "issue_template", + "pull_request_template" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-02-28T19:09:29Z", + "nullable": true + }, + "content_reports_enabled": { + "type": "boolean", + "example": true + } + }, + "required": [ + "health_percentage", + "description", + "documentation", + "files", + "updated_at" + ] + }, + "commit-comparison": { + "title": "Commit Comparison", + "description": "Commit Comparison", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/master...topic" + }, + "permalink_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17" + }, + "diff_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/master...topic.diff" + }, + "patch_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/compare/master...topic.patch" + }, + "base_commit": { + "$ref": "#/components/schemas/commit" + }, + "merge_base_commit": { + "$ref": "#/components/schemas/commit" + }, + "status": { + "type": "string", + "enum": [ + "diverged", + "ahead", + "behind", + "identical" + ], + "example": "ahead" + }, + "ahead_by": { + "type": "integer", + "example": 4 + }, + "behind_by": { + "type": "integer", + "example": 5 + }, + "total_commits": { + "type": "integer", + "example": 6 + }, + "commits": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit" + } + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/diff-entry" + } + } + }, + "required": [ + "url", + "html_url", + "permalink_url", + "diff_url", + "patch_url", + "base_commit", + "merge_base_commit", + "status", + "ahead_by", + "behind_by", + "total_commits", + "commits" + ] + }, + "content-tree": { + "title": "Content Tree", + "description": "Content Tree", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "content": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "entries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url" + ] + } + }, + "encoding": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url" + ] + }, + "content-directory": { + "title": "Content Directory", + "description": "A list of directory items", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "dir", + "file", + "submodule", + "symlink" + ] + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url" + ] + } + }, + "content-file": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "file" + ] + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "content-symlink": { + "title": "Symlink Content", + "description": "An object describing a symlink", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "symlink" + ] + }, + "target": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "target" + ] + }, + "content-submodule": { + "title": "Submodule Content", + "description": "An object describing a submodule", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "submodule" + ] + }, + "submodule_git_url": { + "type": "string", + "format": "uri" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "submodule_git_url" + ] + }, + "file-commit": { + "title": "File Commit", + "description": "File Commit", + "type": "object", + "required": [ + "content", + "commit" + ], + "properties": { + "content": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "string" + }, + "git": { + "type": "string" + }, + "html": { + "type": "string" + } + } + } + }, + "nullable": true + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string", + "nullable": true + }, + "payload": { + "type": "string", + "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true + } + } + } + } + } + } + }, + "secret-scanning-push-protection-bypass-placeholder-id": { + "description": "The ID of the push protection bypass placeholder. This value is returned on any push protected routes.", + "type": "string" + }, + "repository-rule-violation-error": { + "description": "Repository rule violation was detected", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "secret_scanning": { + "type": "object", + "properties": { + "bypass_placeholders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "placeholder_id": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id" + }, + "token_type": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "contributor": { + "title": "Contributor", + "description": "Contributor", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "contributions": { + "type": "integer" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "contributions", + "type" + ] + }, + "dependabot-alert": { + "type": "object", + "description": "A Dependabot alert.", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "state": { + "type": "string", + "description": "The state of the Dependabot alert.", + "readOnly": true, + "enum": [ + "auto_dismissed", + "dismissed", + "fixed", + "open" + ] + }, + "dependency": { + "type": "object", + "description": "Details for the vulnerable dependency.", + "readOnly": true, + "properties": { + "package": { + "$ref": "#/components/schemas/dependabot-alert-package" + }, + "manifest_path": { + "type": "string", + "description": "The full path to the dependency manifest file, relative to the root of the repository.", + "readOnly": true + }, + "scope": { + "type": "string", + "description": "The execution scope of the vulnerable dependency.", + "readOnly": true, + "nullable": true, + "enum": [ + "development", + "runtime" + ] + }, + "relationship": { + "type": "string", + "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", + "readOnly": true, + "nullable": true, + "enum": [ + "unknown", + "direct", + "transitive", + "inconclusive" + ] + } + } + }, + "security_advisory": { + "$ref": "#/components/schemas/dependabot-alert-security-advisory" + }, + "security_vulnerability": { + "$ref": "#/components/schemas/dependabot-alert-security-vulnerability" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/alert-updated-at" + }, + "dismissed_at": { + "$ref": "#/components/schemas/alert-dismissed-at" + }, + "dismissed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "dismissed_reason": { + "type": "string", + "description": "The reason that the alert was dismissed.", + "nullable": true, + "enum": [ + "fix_started", + "inaccurate", + "no_bandwidth", + "not_used", + "tolerable_risk" + ] + }, + "dismissed_comment": { + "type": "string", + "description": "An optional comment associated with the alert's dismissal.", + "nullable": true, + "maxLength": 280 + }, + "fixed_at": { + "$ref": "#/components/schemas/alert-fixed-at" + }, + "auto_dismissed_at": { + "$ref": "#/components/schemas/alert-auto-dismissed-at" + }, + "dismissal_request": { + "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" + }, + "assignees": { + "type": "array", + "description": "The users assigned to this alert.", + "readOnly": true, + "items": { + "$ref": "#/components/schemas/simple-user" + } + } + }, + "required": [ + "number", + "state", + "dependency", + "security_advisory", + "security_vulnerability", + "url", + "html_url", + "created_at", + "updated_at", + "dismissed_at", + "dismissed_by", + "dismissed_reason", + "dismissed_comment", + "fixed_at" + ], + "additionalProperties": false + }, + "dependabot-secret": { + "title": "Dependabot Secret", + "description": "Set secrets for Dependabot.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "MY_ARTIFACTORY_PASSWORD", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "dependency-graph-diff": { + "title": "Dependency Graph Diff", + "description": "A diff of the dependencies between two commits.", + "type": "array", + "items": { + "type": "object", + "properties": { + "change_type": { + "type": "string", + "enum": [ + "added", + "removed" + ] + }, + "manifest": { + "type": "string", + "example": "path/to/package-lock.json" + }, + "ecosystem": { + "type": "string", + "example": "npm" + }, + "name": { + "type": "string", + "example": "@actions/core" + }, + "version": { + "type": "string", + "example": "1.0.0" + }, + "package_url": { + "type": "string", + "nullable": true, + "example": "pkg:/npm/%40actions/core@1.1.0" + }, + "license": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "source_repository_url": { + "type": "string", + "nullable": true, + "example": "https://github.com/github/actions" + }, + "vulnerabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "severity": { + "type": "string", + "example": "critical" + }, + "advisory_ghsa_id": { + "type": "string", + "example": "GHSA-rf4j-j272-fj86" + }, + "advisory_summary": { + "type": "string", + "example": "A summary of the advisory." + }, + "advisory_url": { + "type": "string", + "example": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + } + }, + "required": [ + "severity", + "advisory_ghsa_id", + "advisory_summary", + "advisory_url" + ] + } + }, + "scope": { + "description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.", + "type": "string", + "enum": [ + "unknown", + "runtime", + "development" + ] + } + }, + "required": [ + "change_type", + "manifest", + "ecosystem", + "name", + "version", + "package_url", + "license", + "source_repository_url", + "vulnerabilities", + "scope" + ] + } + }, + "dependency-graph-spdx-sbom": { + "title": "Dependency Graph SPDX SBOM", + "description": "A schema for the SPDX JSON format returned by the Dependency Graph.", + "type": "object", + "properties": { + "sbom": { + "type": "object", + "properties": { + "SPDXID": { + "type": "string", + "example": "SPDXRef-DOCUMENT", + "description": "The SPDX identifier for the SPDX document." + }, + "spdxVersion": { + "type": "string", + "example": "SPDX-2.3", + "description": "The version of the SPDX specification that this document conforms to." + }, + "comment": { + "type": "string", + "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/", + "description": "An optional comment about the SPDX document." + }, + "creationInfo": { + "type": "object", + "properties": { + "created": { + "type": "string", + "example": "2021-11-03T00:00:00Z", + "description": "The date and time the SPDX document was created." + }, + "creators": { + "type": "array", + "items": { + "type": "string", + "example": "GitHub" + }, + "description": "The tools that were used to generate the SPDX document." + } + }, + "required": [ + "created", + "creators" + ] + }, + "name": { + "type": "string", + "example": "github/github", + "description": "The name of the SPDX document." + }, + "dataLicense": { + "type": "string", + "example": "CC0-1.0", + "description": "The license under which the SPDX document is licensed." + }, + "documentNamespace": { + "type": "string", + "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", + "description": "The namespace for the SPDX document." + }, + "packages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "SPDXID": { + "type": "string", + "example": "SPDXRef-Package", + "description": "A unique SPDX identifier for the package." + }, + "name": { + "type": "string", + "example": "github/github", + "description": "The name of the package." + }, + "versionInfo": { + "type": "string", + "example": "1.0.0", + "description": "The version of the package. If the package does not have an exact version specified,\na version range is given." + }, + "downloadLocation": { + "type": "string", + "example": "NOASSERTION", + "description": "The location where the package can be downloaded,\nor NOASSERTION if this has not been determined." + }, + "filesAnalyzed": { + "type": "boolean", + "example": false, + "description": "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document." + }, + "licenseConcluded": { + "type": "string", + "example": "MIT", + "description": "The license of the package as determined while creating the SPDX document." + }, + "licenseDeclared": { + "type": "string", + "example": "NOASSERTION", + "description": "The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created." + }, + "supplier": { + "type": "string", + "example": "NOASSERTION", + "description": "The distribution source of this package, or NOASSERTION if this was not determined." + }, + "copyrightText": { + "type": "string", + "example": "Copyright (c) 1985 GitHub.com", + "description": "The copyright holders of the package, and any dates present with those notices, if available." + }, + "externalRefs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "referenceCategory": { + "type": "string", + "example": "PACKAGE-MANAGER", + "description": "The category of reference to an external resource this reference refers to." + }, + "referenceLocator": { + "type": "string", + "example": "pkg:gem/rails@6.0.1", + "description": "A locator for the particular external resource this reference refers to." + }, + "referenceType": { + "type": "string", + "example": "purl", + "description": "The category of reference to an external resource this reference refers to." + } + }, + "required": [ + "referenceCategory", + "referenceLocator", + "referenceType" + ] + } + } + } + }, + "required": [ + "SPDXID", + "name", + "versionInfo", + "downloadLocation", + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "example": "DEPENDS_ON", + "description": "The type of relationship between the two SPDX elements." + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" + ] + } + }, + "required": [ + "SPDXID", + "spdxVersion", + "creationInfo", + "name", + "dataLicense", + "documentNamespace", + "packages" + ] + } + }, + "required": [ + "sbom" + ] + }, + "metadata": { + "title": "metadata", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "type": "object", + "maxProperties": 8, + "additionalProperties": { + "nullable": true, + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + } + ] + } + }, + "dependency": { + "type": "object", + "properties": { + "package_url": { + "type": "string", + "description": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.", + "example": "pkg:/npm/%40actions/http-client@1.0.11", + "pattern": "^pkg" + }, + "metadata": { + "$ref": "#/components/schemas/metadata" + }, + "relationship": { + "type": "string", + "description": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.", + "example": "direct", + "enum": [ + "direct", + "indirect" + ] + }, + "scope": { + "type": "string", + "description": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.", + "example": "runtime", + "enum": [ + "runtime", + "development" + ] + }, + "dependencies": { + "type": "array", + "description": "Array of package-url (PURLs) of direct child dependencies.", + "example": "@actions/http-client", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "manifest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the manifest.", + "example": "package-lock.json" + }, + "file": { + "type": "object", + "properties": { + "source_location": { + "type": "string", + "description": "The path of the manifest file relative to the root of the Git repository.", + "example": "/src/build/package-lock.json" + } + }, + "additionalProperties": false + }, + "metadata": { + "$ref": "#/components/schemas/metadata" + }, + "resolved": { + "type": "object", + "description": "A collection of resolved package dependencies.", + "additionalProperties": { + "$ref": "#/components/schemas/dependency" + } + } + }, + "required": [ + "name" + ], + "additionalProperties": false + }, + "snapshot": { + "title": "snapshot", + "description": "Create a new snapshot of a repository's dependencies.", + "type": "object", + "properties": { + "version": { + "description": "The version of the repository snapshot submission.", + "type": "integer" + }, + "job": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The external ID of the job.", + "example": "5622a2b0-63f6-4732-8c34-a1ab27e102a11" + }, + "correlator": { + "type": "string", + "description": "Correlator provides a key that is used to group snapshots submitted over time. Only the \"latest\" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given \"wave\" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.", + "example": "yourworkflowname_yourjobname" + }, + "html_url": { + "type": "string", + "description": "The url for the job.", + "example": "http://example.com/build" + } + }, + "required": [ + "id", + "correlator" + ], + "additionalProperties": false + }, + "sha": { + "description": "The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.", + "type": "string", + "example": "ddc951f4b1293222421f2c8df679786153acf689", + "minLength": 40, + "maxLength": 40 + }, + "ref": { + "description": "The repository branch that triggered this snapshot.", + "type": "string", + "pattern": "^refs/", + "example": "refs/heads/main" + }, + "detector": { + "type": "object", + "description": "A description of the detector used.", + "properties": { + "name": { + "type": "string", + "description": "The name of the detector used.", + "example": "docker buildtime detector" + }, + "version": { + "type": "string", + "description": "The version of the detector used.", + "example": "1.0.0" + }, + "url": { + "type": "string", + "description": "The url of the detector used.", + "example": "http://example.com/docker-buildtimer-detector" + } + }, + "required": [ + "name", + "version", + "url" + ], + "additionalProperties": false + }, + "metadata": { + "$ref": "#/components/schemas/metadata" + }, + "manifests": { + "type": "object", + "description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.", + "additionalProperties": { + "$ref": "#/components/schemas/manifest" + } + }, + "scanned": { + "type": "string", + "format": "date-time", + "description": "The time at which the snapshot was scanned.", + "example": "2020-06-13T14:52:50-05:00" + } + }, + "required": [ + "detector", + "version", + "ref", + "sha", + "job", + "scanned" + ], + "additionalProperties": false + }, + "deployment-status": { + "title": "Deployment Status", + "description": "The status of a deployment.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDE2OkRlcGxveW1lbnRTdGF0dXMx" + }, + "state": { + "description": "The state of the status.", + "enum": [ + "error", + "failure", + "inactive", + "pending", + "success", + "queued", + "in_progress" + ], + "example": "success", + "type": "string" + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "description": { + "description": "A short description of the status.", + "default": "", + "type": "string", + "maxLength": 140, + "example": "Deployment finished successfully." + }, + "environment": { + "description": "The environment of the deployment that the status is for.", + "default": "", + "type": "string", + "example": "production" + }, + "target_url": { + "description": "Closing down notice: the URL to associate with this status.", + "default": "", + "type": "string", + "format": "uri", + "example": "https://example.com/deployment/42/output" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "deployment_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/42" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "environment_url": { + "description": "The URL for accessing your environment.", + "default": "", + "type": "string", + "format": "uri", + "example": "https://staging.example.com/" + }, + "log_url": { + "description": "The URL to associate with this status.", + "default": "", + "type": "string", + "format": "uri", + "example": "https://example.com/deployment/42/output" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + } + }, + "required": [ + "id", + "node_id", + "state", + "creator", + "description", + "deployment_url", + "target_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + }, + "wait-timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + }, + "deployment-branch-policy-settings": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + }, + "environment": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "description": "Built-in deployment protection rules for the environment.", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "$ref": "#/components/schemas/wait-timer" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "prevent_self_review": { + "type": "boolean", + "example": false, + "description": "Whether deployments to this environment can be approved by the user who created the deployment." + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/deployment-reviewer-type" + }, + "reviewer": { + "anyOf": [ + { + "$ref": "#/components/schemas/simple-user" + }, + { + "$ref": "#/components/schemas/team" + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "$ref": "#/components/schemas/deployment-branch-policy-settings" + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + }, + "prevent-self-review": { + "type": "boolean", + "example": false, + "description": "Whether or not a user who created the job is prevented from approving their own job." + }, + "deployment-branch-policy": { + "title": "Deployment branch policy", + "description": "Details of a deployment branch or tag policy.", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the branch or tag policy.", + "type": "integer", + "example": 361471 + }, + "node_id": { + "type": "string", + "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" + }, + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.", + "type": "string", + "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag.", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] + } + } + }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] + } + }, + "required": [ + "name" + ] + }, + "deployment-branch-policy-name-pattern": { + "title": "Deployment branch policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + } + }, + "required": [ + "name" + ] + }, + "custom-deployment-rule-app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515, + "description": "The unique identifier of the deployment protection rule integration." + }, + "slug": { + "type": "string", + "example": "my-custom-app", + "description": "The slugified name of the deployment protection rule integration." + }, + "integration_url": { + "type": "string", + "example": "https://api.github.com/apps/custom-app-slug", + "description": "The URL for the endpoint to get details about the app." + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=", + "description": "The node ID for the deployment protection rule integration." + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + }, + "deployment-protection-rule": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515, + "description": "The unique identifier for the deployment protection rule." + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=", + "description": "The node ID for the deployment protection rule." + }, + "enabled": { + "type": "boolean", + "example": true, + "description": "Whether the deployment protection rule is enabled for the environment." + }, + "app": { + "$ref": "#/components/schemas/custom-deployment-rule-app" + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + }, + "short-blob": { + "title": "Short Blob", + "description": "Short Blob", + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "url", + "sha" + ] + }, + "blob": { + "title": "Blob", + "description": "Blob", + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "size": { + "type": "integer", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "highlighted_content": { + "type": "string" + } + }, + "required": [ + "sha", + "url", + "node_id", + "size", + "content", + "encoding" + ] + }, + "git-commit": { + "title": "Git Commit", + "description": "Low-level Git commit operations within a repository", + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string", + "description": "Git email address of the user", + "example": "monalisa.octocat@example.com" + }, + "name": { + "description": "Name of the git user", + "example": "Monalisa Octocat", + "type": "string" + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string", + "description": "Git email address of the user", + "example": "monalisa.octocat@example.com" + }, + "name": { + "description": "Name of the git user", + "example": "Monalisa Octocat", + "type": "string" + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "example": "Fix #42", + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string", + "nullable": true + }, + "payload": { + "type": "string", + "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "git-ref": { + "title": "Git Reference", + "description": "Git references within a repository", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "description": "SHA for the reference", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string", + "minLength": 40, + "maxLength": 40 + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "type", + "sha", + "url" + ] + } + }, + "required": [ + "ref", + "node_id", + "url", + "object" + ] + }, + "git-tag": { + "title": "Git Tag", + "description": "Metadata for a Git tag", + "type": "object", + "properties": { + "node_id": { + "type": "string", + "example": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==" + }, + "tag": { + "description": "Name of the tag", + "example": "v0.0.1", + "type": "string" + }, + "sha": { + "type": "string", + "example": "940bd336248efae0f9ee5bc7b2d5c985887b16ac" + }, + "url": { + "description": "URL for the tag", + "example": "https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "type": "string", + "format": "uri" + }, + "message": { + "description": "Message describing the purpose of the tag", + "example": "Initial public release", + "type": "string" + }, + "tagger": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "date", + "email", + "name" + ] + }, + "object": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "type", + "url" + ] + }, + "verification": { + "$ref": "#/components/schemas/verification" + } + }, + "required": [ + "sha", + "url", + "node_id", + "tagger", + "object", + "tag", + "message" + ] + }, + "git-tree": { + "title": "Git Tree", + "description": "The hierarchy between files in a Git repository.", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "truncated": { + "type": "boolean" + }, + "tree": { + "description": "Objects specifying a tree structure", + "type": "array", + "items": { + "type": "object", + "required": [ + "path", + "mode", + "type", + "sha" + ], + "properties": { + "path": { + "type": "string", + "example": "test/file.rb" + }, + "mode": { + "type": "string", + "example": "040000" + }, + "type": { + "type": "string", + "example": "tree" + }, + "sha": { + "type": "string", + "example": "23f6827669e43831def8a7ad935069c8bd418261" + }, + "size": { + "type": "integer", + "example": 12 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261" + } + } + }, + "example": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + } + ] + } + }, + "required": [ + "sha", + "tree", + "truncated" + ] + }, + "hook-response": { + "title": "Hook Response", + "type": "object", + "properties": { + "code": { + "type": "integer", + "nullable": true + }, + "status": { + "type": "string", + "nullable": true + }, + "message": { + "type": "string", + "nullable": true + } + }, + "required": [ + "code", + "status", + "message" + ] + }, + "hook": { + "title": "Webhook", + "description": "Webhooks for repositories.", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the webhook.", + "example": 42, + "type": "integer" + }, + "name": { + "description": "The name of a valid service, use 'web' for a webhook.", + "example": "web", + "type": "string" + }, + "active": { + "description": "Determines whether the hook is actually triggered on pushes.", + "type": "boolean", + "example": true + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "push", + "pull_request" + ] + }, + "config": { + "$ref": "#/components/schemas/webhook-config" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1" + }, + "test_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/test" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/pings" + }, + "deliveries_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries" + }, + "last_response": { + "$ref": "#/components/schemas/hook-response" + } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at", + "last_response", + "test_url" + ] + }, + "check-immutable-releases": { + "title": "Check immutable releases", + "description": "Check immutable releases", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "example": true, + "description": "Whether immutable releases are enabled for the repository." + }, + "enforced_by_owner": { + "type": "boolean", + "example": false, + "description": "Whether immutable releases are enforced by the repository owner." + } + }, + "required": [ + "enabled", + "enforced_by_owner" + ] + }, + "import": { + "title": "Import", + "description": "A repository import from an external source.", + "type": "object", + "properties": { + "vcs": { + "type": "string", + "nullable": true + }, + "use_lfs": { + "type": "boolean" + }, + "vcs_url": { + "description": "The URL of the originating repository.", + "type": "string" + }, + "svc_root": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "auth", + "error", + "none", + "detecting", + "choose", + "auth_failed", + "importing", + "mapping", + "waiting_to_push", + "pushing", + "complete", + "setup", + "unknown", + "detection_found_multiple", + "detection_found_nothing", + "detection_needs_auth" + ] + }, + "status_text": { + "type": "string", + "nullable": true + }, + "failed_step": { + "type": "string", + "nullable": true + }, + "error_message": { + "type": "string", + "nullable": true + }, + "import_percent": { + "type": "integer", + "nullable": true + }, + "commit_count": { + "type": "integer", + "nullable": true + }, + "push_percent": { + "type": "integer", + "nullable": true + }, + "has_large_files": { + "type": "boolean" + }, + "large_files_size": { + "type": "integer" + }, + "large_files_count": { + "type": "integer" + }, + "project_choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vcs": { + "type": "string" + }, + "tfvc_project": { + "type": "string" + }, + "human_name": { + "type": "string" + } + } + } + }, + "message": { + "type": "string" + }, + "authors_count": { + "type": "integer", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "authors_url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "svn_root": { + "type": "string" + } + }, + "required": [ + "vcs", + "vcs_url", + "status", + "url", + "repository_url", + "html_url", + "authors_url" + ] + }, + "porter-author": { + "title": "Porter Author", + "description": "Porter Author", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "remote_id": { + "type": "string" + }, + "remote_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "import_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "remote_id", + "remote_name", + "email", + "name", + "url", + "import_url" + ] + }, + "porter-large-file": { + "title": "Porter Large File", + "description": "Porter Large File", + "type": "object", + "properties": { + "ref_name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "oid": { + "type": "string" + }, + "size": { + "type": "integer" + } + }, + "required": [ + "oid", + "path", + "ref_name", + "size" + ] + }, + "nullable-issue": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "state_reason": { + "description": "The reason for the current state", + "example": "not_planned", + "type": "string", + "nullable": true, + "enum": [ + "completed", + "reopened", + "not_planned", + "duplicate" + ] + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string", + "nullable": true + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], + "type": "array", + "items": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] + } + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "closed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "parent_issue_url": { + "description": "URL to get the parent issue of this issue, if it is a sub-issue", + "type": "string", + "format": "uri", + "nullable": true + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "nullable": false + }, + "diff_url": { + "nullable": false + }, + "html_url": { + "nullable": false + }, + "patch_url": { + "nullable": false + }, + "url": { + "nullable": false + } + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "created_at", + "updated_at" + ] + }, + "version": "2026-03-10" + } + ], + "nullable": true + }, + "issue-event-label": { + "title": "Issue Event Label", + "description": "Issue Event Label", + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "color" + ] + }, + "issue-event-dismissed-review": { + "title": "Issue Event Dismissed Review", + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "type": "string", + "nullable": true + }, + "dismissal_commit_id": { + "type": "string", + "nullable": true + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + }, + "issue-event-milestone": { + "title": "Issue Event Milestone", + "description": "Issue Event Milestone", + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + }, + "issue-event-project-card": { + "title": "Issue Event Project Card", + "description": "Issue Event Project Card", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "url", + "id", + "project_url", + "project_id", + "column_name" + ] + }, + "issue-event-rename": { + "title": "Issue Event Rename", + "description": "Issue Event Rename", + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + }, + "issue-event": { + "title": "Issue Event", + "description": "Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEwOklzc3VlRXZlbnQx" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/events/1" + }, + "actor": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "event": { + "type": "string", + "example": "closed" + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "commit_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue": { + "$ref": "#/components/schemas/nullable-issue" + }, + "label": { + "$ref": "#/components/schemas/issue-event-label" + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assigner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "review_requester": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "requested_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "requested_team": { + "$ref": "#/components/schemas/team" + }, + "dismissed_review": { + "$ref": "#/components/schemas/issue-event-dismissed-review" + }, + "milestone": { + "$ref": "#/components/schemas/issue-event-milestone" + }, + "project_card": { + "$ref": "#/components/schemas/issue-event-project-card" + }, + "rename": { + "$ref": "#/components/schemas/issue-event-rename" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "lock_reason": { + "type": "string", + "nullable": true + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at" + ] + }, + "labeled-issue-event": { + "title": "Labeled Issue Event", + "description": "Labeled Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "label": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "color": { + "type": "string" + } + }, + "required": [ + "name", + "color" + ] + } + }, + "required": [ + "label", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "unlabeled-issue-event": { + "title": "Unlabeled Issue Event", + "description": "Unlabeled Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "label": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "color": { + "type": "string" + } + }, + "required": [ + "name", + "color" + ] + } + }, + "required": [ + "label", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "assigned-issue-event": { + "title": "Assigned Issue Event", + "description": "Assigned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/integration" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "assigner": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app", + "assignee", + "assigner" + ] + }, + "unassigned-issue-event": { + "title": "Unassigned Issue Event", + "description": "Unassigned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "assigner": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app", + "assignee", + "assigner" + ] + }, + "milestoned-issue-event": { + "title": "Milestoned Issue Event", + "description": "Milestoned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "milestone": { + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + } + }, + "required": [ + "milestone", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "demilestoned-issue-event": { + "title": "Demilestoned Issue Event", + "description": "Demilestoned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "milestone": { + "type": "object", + "properties": { + "title": { + "type": "string" + } + }, + "required": [ + "title" + ] + } + }, + "required": [ + "milestone", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "renamed-issue-event": { + "title": "Renamed Issue Event", + "description": "Renamed Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "rename": { + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + }, + "required": [ + "from", + "to" + ] + } + }, + "required": [ + "rename", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "review-requested-issue-event": { + "title": "Review Requested Issue Event", + "description": "Review Requested Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "review_requester": { + "$ref": "#/components/schemas/simple-user" + }, + "requested_team": { + "$ref": "#/components/schemas/team" + }, + "requested_reviewer": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "review_requester", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "review-request-removed-issue-event": { + "title": "Review Request Removed Issue Event", + "description": "Review Request Removed Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "review_requester": { + "$ref": "#/components/schemas/simple-user" + }, + "requested_team": { + "$ref": "#/components/schemas/team" + }, + "requested_reviewer": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "review_requester", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "review-dismissed-issue-event": { + "title": "Review Dismissed Issue Event", + "description": "Review Dismissed Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "dismissed_review": { + "type": "object", + "properties": { + "state": { + "type": "string" + }, + "review_id": { + "type": "integer" + }, + "dismissal_message": { + "nullable": true, + "type": "string" + }, + "dismissal_commit_id": { + "type": "string" + } + }, + "required": [ + "state", + "review_id", + "dismissal_message" + ] + } + }, + "required": [ + "dismissed_review", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "locked-issue-event": { + "title": "Locked Issue Event", + "description": "Locked Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "lock_reason": { + "type": "string", + "example": "\"off-topic\"", + "nullable": true + } + }, + "required": [ + "lock_reason", + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "added-to-project-issue-event": { + "title": "Added to Project Issue Event", + "description": "Added to Project Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "moved-column-in-project-issue-event": { + "title": "Moved Column in Project Issue Event", + "description": "Moved Column in Project Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "removed-from-project-issue-event": { + "title": "Removed from Project Issue Event", + "description": "Removed from Project Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "converted-note-to-issue-issue-event": { + "title": "Converted Note to Issue Issue Event", + "description": "Converted Note to Issue Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/integration" + }, + "project_card": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "project_id": { + "type": "integer" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "column_name": { + "type": "string" + }, + "previous_column_name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "project_id", + "project_url", + "column_name" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "issue-event-for-issue": { + "title": "Issue Event for Issue", + "description": "Issue Event for Issue", + "anyOf": [ + { + "$ref": "#/components/schemas/labeled-issue-event" + }, + { + "$ref": "#/components/schemas/unlabeled-issue-event" + }, + { + "$ref": "#/components/schemas/assigned-issue-event" + }, + { + "$ref": "#/components/schemas/unassigned-issue-event" + }, + { + "$ref": "#/components/schemas/milestoned-issue-event" + }, + { + "$ref": "#/components/schemas/demilestoned-issue-event" + }, + { + "$ref": "#/components/schemas/renamed-issue-event" + }, + { + "$ref": "#/components/schemas/review-requested-issue-event" + }, + { + "$ref": "#/components/schemas/review-request-removed-issue-event" + }, + { + "$ref": "#/components/schemas/review-dismissed-issue-event" + }, + { + "$ref": "#/components/schemas/locked-issue-event" + }, + { + "$ref": "#/components/schemas/added-to-project-issue-event" + }, + { + "$ref": "#/components/schemas/moved-column-in-project-issue-event" + }, + { + "$ref": "#/components/schemas/removed-from-project-issue-event" + }, + { + "$ref": "#/components/schemas/converted-note-to-issue-issue-event" + } + ] + }, + "timeline-comment-event": { + "title": "Timeline Comment Event", + "description": "Timeline Comment Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "pin": { + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + } + }, + "required": [ + "event", + "actor", + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] + }, + "timeline-cross-referenced-event": { + "title": "Timeline Cross Referenced Event", + "description": "Timeline Cross Referenced Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "source": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + } + } + } + }, + "required": [ + "event", + "created_at", + "updated_at", + "source" + ] + }, + "timeline-committed-event": { + "title": "Timeline Committed Event", + "description": "Timeline Committed Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "author": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string", + "description": "Git email address of the user", + "example": "monalisa.octocat@example.com" + }, + "name": { + "description": "Name of the git user", + "example": "Monalisa Octocat", + "type": "string" + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "committer": { + "description": "Identifying information for the git-user", + "type": "object", + "properties": { + "date": { + "description": "Timestamp of the commit", + "example": "2014-08-09T08:02:04+12:00", + "format": "date-time", + "type": "string" + }, + "email": { + "type": "string", + "description": "Git email address of the user", + "example": "monalisa.octocat@example.com" + }, + "name": { + "description": "Name of the git user", + "example": "Monalisa Octocat", + "type": "string" + } + }, + "required": [ + "email", + "name", + "date" + ] + }, + "message": { + "description": "Message describing the purpose of the commit", + "example": "Fix #42", + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "description": "SHA for the commit", + "example": "7638417db6d59f3c431d3e1f261cc637155684cd", + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string", + "nullable": true + }, + "payload": { + "type": "string", + "nullable": true + }, + "verified_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "tree", + "message", + "parents", + "verification" + ] + }, + "timeline-reviewed-event": { + "title": "Timeline Reviewed Event", + "description": "Timeline Reviewed Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the review", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "body": { + "nullable": true, + "description": "The text of the review.", + "example": "This looks great.", + "type": "string" + }, + "state": { + "type": "string", + "example": "CHANGES_REQUESTED" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "submitted_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "commit_id": { + "description": "A commit SHA for the review.", + "example": "54bb654c9e6025347f57900a4a5c2313a96b8035", + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "event", + "id", + "node_id", + "user", + "body", + "state", + "commit_id", + "html_url", + "pull_request_url", + "_links", + "author_association" + ] + }, + "pull-request-review-comment": { + "title": "Pull Request Review Comment", + "description": "Pull Request Review Comments are comments on a portion of the Pull Request's diff.", + "type": "object", + "properties": { + "url": { + "description": "URL for the pull request review comment", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "type": "string" + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "format": "int64", + "example": 42, + "nullable": true + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string", + "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string", + "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "example": "config/database.yaml", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies. This field is closing down; use `line` instead.", + "example": 1, + "type": "integer" + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.", + "example": 4, + "type": "integer" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "type": "string" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "example": 8, + "type": "integer" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body": { + "description": "The text of the comment.", + "example": "We should probably include a check for null values here.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + } + }, + "required": [ + "href" + ] + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "start_line": { + "type": "integer", + "description": "The first line of the range for a multi-line comment.", + "example": 2, + "nullable": true + }, + "original_start_line": { + "type": "integer", + "description": "The first line of the range for a multi-line comment.", + "example": 2, + "nullable": true + }, + "start_side": { + "type": "string", + "description": "The side of the first line of the range for a multi-line comment.", + "enum": [ + "LEFT", + "RIGHT" + ], + "default": "RIGHT", + "nullable": true + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "side": { + "description": "The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment", + "enum": [ + "LEFT", + "RIGHT" + ], + "default": "RIGHT", + "type": "string" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "body_html": { + "type": "string", + "example": "\"

comment body

\"" + }, + "body_text": { + "type": "string", + "example": "\"comment body\"" + } + }, + "required": [ + "url", + "id", + "node_id", + "pull_request_review_id", + "diff_hunk", + "path", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links" + ] + }, + "timeline-line-commented-event": { + "title": "Timeline Line Commented Event", + "description": "Timeline Line Commented Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-review-comment" + } + } + } + }, + "timeline-commit-commented-event": { + "title": "Timeline Commit Commented Event", + "description": "Timeline Commit Commented Event", + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/commit-comment" + } + } + } + }, + "timeline-assigned-issue-event": { + "title": "Timeline Assigned Issue Event", + "description": "Timeline Assigned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app", + "assignee" + ] + }, + "timeline-unassigned-issue-event": { + "title": "Timeline Unassigned Issue Event", + "description": "Timeline Unassigned Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app", + "assignee" + ] + }, + "state-change-issue-event": { + "title": "State Change Issue Event", + "description": "State Change Issue Event", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "$ref": "#/components/schemas/simple-user" + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string", + "nullable": true + }, + "commit_url": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "state_reason": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "url", + "actor", + "event", + "commit_id", + "commit_url", + "created_at", + "performed_via_github_app" + ] + }, + "timeline-issue-events": { + "title": "Timeline Event", + "description": "Timeline Event", + "type": "object", + "anyOf": [ + { + "$ref": "#/components/schemas/labeled-issue-event" + }, + { + "$ref": "#/components/schemas/unlabeled-issue-event" + }, + { + "$ref": "#/components/schemas/milestoned-issue-event" + }, + { + "$ref": "#/components/schemas/demilestoned-issue-event" + }, + { + "$ref": "#/components/schemas/renamed-issue-event" + }, + { + "$ref": "#/components/schemas/review-requested-issue-event" + }, + { + "$ref": "#/components/schemas/review-request-removed-issue-event" + }, + { + "$ref": "#/components/schemas/review-dismissed-issue-event" + }, + { + "$ref": "#/components/schemas/locked-issue-event" + }, + { + "$ref": "#/components/schemas/added-to-project-issue-event" + }, + { + "$ref": "#/components/schemas/moved-column-in-project-issue-event" + }, + { + "$ref": "#/components/schemas/removed-from-project-issue-event" + }, + { + "$ref": "#/components/schemas/converted-note-to-issue-issue-event" + }, + { + "$ref": "#/components/schemas/timeline-comment-event" + }, + { + "$ref": "#/components/schemas/timeline-cross-referenced-event" + }, + { + "$ref": "#/components/schemas/timeline-committed-event" + }, + { + "$ref": "#/components/schemas/timeline-reviewed-event" + }, + { + "$ref": "#/components/schemas/timeline-line-commented-event" + }, + { + "$ref": "#/components/schemas/timeline-commit-commented-event" + }, + { + "$ref": "#/components/schemas/timeline-assigned-issue-event" + }, + { + "$ref": "#/components/schemas/timeline-unassigned-issue-event" + }, + { + "$ref": "#/components/schemas/state-change-issue-event" + } + ] + }, + "deploy-key": { + "title": "Deploy Key", + "description": "An SSH key granting access to a single repository.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "verified": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "read_only": { + "type": "boolean" + }, + "added_by": { + "type": "string", + "nullable": true + }, + "last_used": { + "nullable": true, + "type": "string", + "format": "date-time" + }, + "enabled": { + "type": "boolean" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, + "language": { + "title": "Language", + "description": "Language", + "type": "object", + "additionalProperties": { + "type": "integer" + } + }, + "license-content": { + "title": "License Content", + "description": "License Content", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "type": { + "type": "string" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding", + "license" + ] + }, + "merged-upstream": { + "title": "Merged upstream", + "description": "Results of a successful merge upstream request", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "merge_type": { + "type": "string", + "enum": [ + "merge", + "fast-forward", + "none" + ] + }, + "base_branch": { + "type": "string" + } + } + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + }, + "pages-source-hash": { + "title": "Pages Source Hash", + "type": "object", + "properties": { + "branch": { + "type": "string" + }, + "path": { + "type": "string" + } + }, + "required": [ + "branch", + "path" + ] + }, + "pages-https-certificate": { + "title": "Pages Https Certificate", + "type": "object", + "properties": { + "state": { + "type": "string", + "enum": [ + "new", + "authorization_created", + "authorization_pending", + "authorized", + "authorization_revoked", + "issued", + "uploaded", + "approved", + "errored", + "bad_authz", + "destroy_pending", + "dns_changed" + ], + "example": "approved" + }, + "description": { + "type": "string", + "example": "Certificate is approved" + }, + "domains": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of the domain set and its alternate name (if it is configured)", + "example": [ + "example.com", + "www.example.com" + ] + }, + "expires_at": { + "type": "string", + "format": "date" + } + }, + "required": [ + "state", + "description", + "domains" + ] + }, + "page": { + "title": "GitHub Pages", + "description": "The configuration for GitHub Pages for a repository.", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The API address for accessing this Page resource.", + "format": "uri", + "example": "https://api.github.com/repos/github/hello-world/pages" + }, + "status": { + "type": "string", + "description": "The status of the most recent build of the Page.", + "example": "built", + "enum": [ + "built", + "building", + "errored" + ], + "nullable": true + }, + "cname": { + "description": "The Pages site's custom domain", + "example": "example.com", + "type": "string", + "nullable": true + }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is verified", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, + "custom_404": { + "type": "boolean", + "description": "Whether the Page has a custom 404 page.", + "example": false, + "default": false + }, + "html_url": { + "type": "string", + "description": "The web address the Page can be accessed from.", + "format": "uri", + "example": "https://example.com" + }, + "build_type": { + "type": "string", + "description": "The process in which the Page will be built.", + "example": "legacy", + "nullable": true, + "enum": [ + "legacy", + "workflow" + ] + }, + "source": { + "$ref": "#/components/schemas/pages-source-hash" + }, + "public": { + "type": "boolean", + "description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.", + "example": true + }, + "https_certificate": { + "$ref": "#/components/schemas/pages-https-certificate" + }, + "https_enforced": { + "type": "boolean", + "description": "Whether https is enabled on the domain", + "example": true + } + }, + "required": [ + "url", + "status", + "cname", + "custom_404", + "public" + ] + }, + "page-build": { + "title": "Page Build", + "description": "Page Build", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "status": { + "type": "string" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + } + }, + "required": [ + "message" + ] + }, + "pusher": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "commit": { + "type": "string" + }, + "duration": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "url", + "status", + "error", + "pusher", + "commit", + "duration", + "created_at", + "updated_at" + ] + }, + "page-build-status": { + "title": "Page Build Status", + "description": "Page Build Status", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/github/hello-world/pages/builds/latest" + }, + "status": { + "type": "string", + "example": "queued" + } + }, + "required": [ + "url", + "status" + ] + }, + "page-deployment": { + "title": "GitHub Pages", + "description": "The GitHub Pages deployment status.", + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ], + "description": "The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit." + }, + "status_url": { + "type": "string", + "description": "The URI to monitor GitHub Pages deployment status.", + "format": "uri", + "example": "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251" + }, + "page_url": { + "type": "string", + "description": "The URI to the deployed GitHub Pages.", + "format": "uri", + "example": "hello-world.github.io" + }, + "preview_url": { + "type": "string", + "description": "The URI to the deployed GitHub Pages preview.", + "format": "uri", + "example": "monalisa-1231a2312sa32-23sda74.drafts.github.io" + } + }, + "required": [ + "id", + "status_url", + "page_url" + ] + }, + "pages-deployment-status": { + "title": "GitHub Pages deployment status", + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the deployment.", + "enum": [ + "deployment_in_progress", + "syncing_files", + "finished_file_sync", + "updating_pages", + "purging_cdn", + "deployment_cancelled", + "deployment_failed", + "deployment_content_failed", + "deployment_attempt_error", + "deployment_lost", + "succeed" + ] + } + } + }, + "pages-health-check": { + "title": "Pages Health Check Status", + "description": "Pages Health Check Status", + "type": "object", + "properties": { + "domain": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "nameservers": { + "type": "string" + }, + "dns_resolves": { + "type": "boolean" + }, + "is_proxied": { + "type": "boolean", + "nullable": true + }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { + "type": "boolean", + "nullable": true + }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { + "type": "boolean", + "nullable": true + }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { + "type": "boolean" + }, + "is_apex_domain": { + "type": "boolean" + }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { + "type": "boolean" + }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "responds_to_https": { + "type": "boolean" + }, + "enforces_https": { + "type": "boolean" + }, + "https_error": { + "type": "string", + "nullable": true + }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { + "type": "string", + "nullable": true + } + } + }, + "alt_domain": { + "type": "object", + "nullable": true, + "properties": { + "host": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "nameservers": { + "type": "string" + }, + "dns_resolves": { + "type": "boolean" + }, + "is_proxied": { + "type": "boolean", + "nullable": true + }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { + "type": "boolean", + "nullable": true + }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { + "type": "boolean", + "nullable": true + }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { + "type": "boolean" + }, + "is_apex_domain": { + "type": "boolean" + }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { + "type": "boolean" + }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "responds_to_https": { + "type": "boolean" + }, + "enforces_https": { + "type": "boolean" + }, + "https_error": { + "type": "string", + "nullable": true + }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { + "type": "string", + "nullable": true + } + } + } + } + }, + "pull-request": { + "type": "object", + "title": "Pull Request", + "description": "Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDExOlB1bGxSZXF1ZXN0MQ==" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347" + }, + "diff_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.diff" + }, + "patch_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "issue_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "commits_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "review_comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment_url": { + "type": "string", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "enum": [ + "open", + "closed" + ], + "example": "open", + "type": "string" + }, + "locked": { + "type": "boolean", + "example": true + }, + "title": { + "description": "The title of the pull request.", + "example": "Amazing new feature", + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + }, + "body": { + "type": "string", + "example": "Please pull these awesome changes", + "nullable": true + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "active_lock_reason": { + "type": "string", + "example": "too heated", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merged_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "merge_commit_sha": { + "type": "string", + "example": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "nullable": true + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "requested_teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team-simple" + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "$ref": "#/components/schemas/repository" + }, + "sha": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "$ref": "#/components/schemas/repository" + }, + "sha": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "label", + "ref", + "repo", + "sha", + "user" + ] + }, + "_links": { + "type": "object", + "properties": { + "comments": { + "$ref": "#/components/schemas/link" + }, + "commits": { + "$ref": "#/components/schemas/link" + }, + "statuses": { + "$ref": "#/components/schemas/link" + }, + "html": { + "$ref": "#/components/schemas/link" + }, + "issue": { + "$ref": "#/components/schemas/link" + }, + "review_comments": { + "$ref": "#/components/schemas/link" + }, + "review_comment": { + "$ref": "#/components/schemas/link" + }, + "self": { + "$ref": "#/components/schemas/link" + } + }, + "required": [ + "comments", + "commits", + "statuses", + "html", + "issue", + "review_comments", + "review_comment", + "self" + ] + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "auto_merge": { + "$ref": "#/components/schemas/auto-merge" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "example": false, + "type": "boolean" + }, + "merged": { + "type": "boolean" + }, + "mergeable": { + "type": "boolean", + "example": true, + "nullable": true + }, + "rebaseable": { + "type": "boolean", + "example": true, + "nullable": true + }, + "mergeable_state": { + "type": "string", + "example": "clean" + }, + "merged_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "comments": { + "type": "integer", + "example": 10 + }, + "review_comments": { + "type": "integer", + "example": 0 + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "example": true, + "type": "boolean" + }, + "commits": { + "type": "integer", + "example": 3 + }, + "additions": { + "type": "integer", + "example": 100 + }, + "deletions": { + "type": "integer", + "example": 3 + }, + "changed_files": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merge_commit_sha", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge", + "additions", + "changed_files", + "comments", + "commits", + "deletions", + "mergeable", + "mergeable_state", + "merged", + "maintainer_can_modify", + "merged_by", + "review_comments" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": { + "properties": { + "merge_commit_sha": null + }, + "required": [ + "_links", + "assignee", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge", + "additions", + "changed_files", + "comments", + "commits", + "deletions", + "mergeable", + "mergeable_state", + "merged", + "maintainer_can_modify", + "merged_by", + "review_comments" + ] + }, + "version": "2026-03-10" + }, + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null + }, + "required": [ + "_links", + "labels", + "base", + "body", + "closed_at", + "comments_url", + "commits_url", + "created_at", + "diff_url", + "head", + "html_url", + "id", + "node_id", + "issue_url", + "merged_at", + "milestone", + "number", + "patch_url", + "review_comment_url", + "review_comments_url", + "statuses_url", + "state", + "locked", + "title", + "updated_at", + "url", + "user", + "author_association", + "auto_merge", + "additions", + "changed_files", + "comments", + "commits", + "deletions", + "mergeable", + "mergeable_state", + "merged", + "maintainer_can_modify", + "merged_by", + "review_comments" + ] + }, + "version": "2026-03-10" + } + ] + }, + "pull-request-merge-result": { + "title": "Pull Request Merge Result", + "description": "Pull Request Merge Result", + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "message": { + "type": "string" + } + }, + "required": [ + "merged", + "message", + "sha" + ] + }, + "pull-request-review-request": { + "title": "Pull Request Review Request", + "description": "Pull Request Review Request", + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "teams": { + "type": "array", + "items": { + "$ref": "#/components/schemas/team" + } + } + }, + "required": [ + "users", + "teams" + ] + }, + "pull-request-review": { + "title": "Pull Request Review", + "description": "Pull Request Reviews are reviews on pull requests.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the review", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body": { + "description": "The text of the review.", + "example": "This looks great.", + "type": "string" + }, + "state": { + "type": "string", + "example": "CHANGES_REQUESTED" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "submitted_at": { + "type": "string", + "format": "date-time" + }, + "commit_id": { + "description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.", + "example": "54bb654c9e6025347f57900a4a5c2313a96b8035", + "type": "string", + "nullable": true + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + } + }, + "required": [ + "id", + "node_id", + "user", + "body", + "state", + "commit_id", + "html_url", + "pull_request_url", + "_links", + "author_association" + ] + }, + "review-comment": { + "title": "Legacy Review Comment", + "description": "Legacy Review Comment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "pull_request_review_id": { + "type": "integer", + "format": "int64", + "example": 42, + "nullable": true + }, + "id": { + "type": "integer", + "format": "int64", + "example": 10 + }, + "node_id": { + "type": "string", + "example": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw" + }, + "diff_hunk": { + "type": "string", + "example": "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + }, + "path": { + "type": "string", + "example": "file1.txt" + }, + "position": { + "type": "integer", + "example": 1, + "nullable": true + }, + "original_position": { + "type": "integer", + "example": 4 + }, + "commit_id": { + "type": "string", + "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "original_commit_id": { + "type": "string", + "example": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840" + }, + "in_reply_to_id": { + "type": "integer", + "example": 8 + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body": { + "type": "string", + "example": "Great stuff" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-14T16:00:49Z" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "$ref": "#/components/schemas/link" + }, + "html": { + "$ref": "#/components/schemas/link" + }, + "pull_request": { + "$ref": "#/components/schemas/link" + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "enum": [ + "LEFT", + "RIGHT" + ], + "default": "RIGHT", + "type": "string" + }, + "start_side": { + "type": "string", + "description": "The side of the first line of the range for a multi-line comment.", + "enum": [ + "LEFT", + "RIGHT" + ], + "default": "RIGHT", + "nullable": true + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "original_line": { + "description": "The original line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "example": 2, + "type": "integer" + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "example": 2, + "type": "integer", + "nullable": true + }, + "original_start_line": { + "description": "The original first line of the range for a multi-line comment.", + "example": 2, + "type": "integer", + "nullable": true + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "body", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "pull_request_review_id", + "html_url", + "pull_request_url", + "_links", + "author_association", + "created_at", + "updated_at" + ] + }, + "release-notes-content": { + "title": "Generated Release Notes Content", + "description": "Generated name and body describing a release", + "type": "object", + "properties": { + "name": { + "description": "The generated name of the release", + "type": "string", + "example": "Release v1.0.0 is now available!" + }, + "body": { + "description": "The generated body describing the contents of the release supporting markdown formatting", + "type": "string" + } + }, + "required": [ + "name", + "body" + ] + }, + "repository-rule-ruleset-info": { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + }, + "repository-rule-detailed": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule with ruleset details.", + "oneOf": [ + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-file-path-restriction" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-max-file-path-length" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-max-file-size" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] + } + ] + }, + "secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": "string", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.", + "nullable": true + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories under the same organization or enterprise.", + "nullable": true + }, + "is_base64_encoded": { + "type": "boolean", + "description": "A boolean value representing whether or not alert is base64 encoded", + "nullable": true + }, + "first_location_detected": { + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + }, + "has_more_locations": { + "type": "boolean", + "description": "A boolean value representing whether or not the token in the alert was detected in more than one location." + }, + "assigned_to": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + } + } + }, + "secret-scanning-alert-resolution-comment": { + "description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.", + "type": "string", + "nullable": true + }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": "string", + "nullable": true + }, + "secret-scanning-location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "example": "commit" + }, + "details": { + "oneOf": [ + { + "$ref": "#/components/schemas/secret-scanning-location-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + }, + { + "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + } + ] + } + } + }, + "secret-scanning-push-protection-bypass-reason": { + "description": "The reason for bypassing push protection.", + "type": "string", + "enum": [ + "false_positive", + "used_in_tests", + "will_fix_later" + ] + }, + "secret-scanning-push-protection-bypass": { + "type": "object", + "properties": { + "reason": { + "$ref": "#/components/schemas/secret-scanning-push-protection-bypass-reason" + }, + "expire_at": { + "type": "string", + "format": "date-time", + "description": "The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "token_type": { + "type": "string", + "description": "The token type this bypass is for." + } + } + }, + "secret-scanning-scan": { + "description": "Information on a single scan performed by secret scanning on the repository", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of scan" + }, + "status": { + "type": "string", + "description": "The state of the scan. Either \"completed\", \"running\", or \"pending\"" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time that the scan was completed. Empty if the scan is running", + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the scan was started. Empty if the scan is pending", + "nullable": true + } + } + }, + "secret-scanning-scan-history": { + "type": "object", + "properties": { + "incremental_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "pattern_update_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "backfill_scans": { + "type": "array", + "items": { + "$ref": "#/components/schemas/secret-scanning-scan" + } + }, + "custom_pattern_backfill_scans": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/secret-scanning-scan" + }, + { + "type": "object", + "properties": { + "pattern_name": { + "type": "string", + "description": "Name of the custom pattern for custom pattern scans" + }, + "pattern_scope": { + "type": "string", + "description": "Level at which the custom pattern is defined, one of \"repository\", \"organization\", or \"enterprise\"" + } + } + } + ] + } + } + } + }, + "repository-advisory-create": { + "type": "object", + "properties": { + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory impacts.", + "maxLength": 65535 + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true + }, + "vulnerabilities": { + "type": "array", + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package" + ], + "additionalProperties": false + } + }, + "cwe_ids": { + "type": "array", + "description": "A list of Common Weakness Enumeration (CWE) IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "description": "A list of users receiving credit for their participation in the security advisory.", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + }, + "required": [ + "login", + "type" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "cvss_vector_string": { + "type": "string", + "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.", + "nullable": true + }, + "start_private_fork": { + "type": "boolean", + "description": "Whether to create a temporary private fork of the repository to collaborate on a fix.", + "default": false + } + }, + "required": [ + "summary", + "description", + "vulnerabilities" + ], + "additionalProperties": false + }, + "private-vulnerability-report-create": { + "type": "object", + "properties": { + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory impacts.", + "maxLength": 65535 + }, + "vulnerabilities": { + "type": "array", + "description": "An array of products affected by the vulnerability detailed in a repository security advisory.", + "nullable": true, + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package" + ], + "additionalProperties": false + } + }, + "cwe_ids": { + "type": "array", + "description": "A list of Common Weakness Enumeration (CWE) IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "cvss_vector_string": { + "type": "string", + "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.", + "nullable": true + }, + "start_private_fork": { + "type": "boolean", + "description": "Whether to create a temporary private fork of the repository to collaborate on a fix.", + "default": false + } + }, + "required": [ + "summary", + "description" + ], + "additionalProperties": false + }, + "repository-advisory-update": { + "type": "object", + "properties": { + "summary": { + "type": "string", + "description": "A short summary of the advisory.", + "maxLength": 1024 + }, + "description": { + "type": "string", + "description": "A detailed description of what the advisory impacts.", + "maxLength": 65535 + }, + "cve_id": { + "type": "string", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "nullable": true + }, + "vulnerabilities": { + "type": "array", + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "items": { + "type": "object", + "properties": { + "package": { + "description": "The name of the package affected by the vulnerability.", + "type": "object", + "properties": { + "ecosystem": { + "$ref": "#/components/schemas/security-advisory-ecosystems" + }, + "name": { + "type": "string", + "description": "The unique package name within its ecosystem.", + "nullable": true + } + }, + "required": [ + "ecosystem" + ] + }, + "vulnerable_version_range": { + "type": "string", + "description": "The range of the package versions affected by the vulnerability.", + "nullable": true + }, + "patched_versions": { + "type": "string", + "description": "The package version(s) that resolve the vulnerability.", + "nullable": true + }, + "vulnerable_functions": { + "type": "array", + "description": "The functions in the package that are affected.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "package" + ], + "additionalProperties": false + } + }, + "cwe_ids": { + "type": "array", + "description": "A list of Common Weakness Enumeration (CWE) IDs.", + "nullable": true, + "items": { + "type": "string" + } + }, + "credits": { + "type": "array", + "description": "A list of users receiving credit for their participation in the security advisory.", + "nullable": true, + "items": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "The username of the user credited." + }, + "type": { + "$ref": "#/components/schemas/security-advisory-credit-types" + } + }, + "required": [ + "login", + "type" + ], + "additionalProperties": false + } + }, + "severity": { + "type": "string", + "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.", + "nullable": true, + "enum": [ + "critical", + "high", + "medium", + "low" + ] + }, + "cvss_vector_string": { + "type": "string", + "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.", + "nullable": true + }, + "state": { + "type": "string", + "description": "The state of the advisory.", + "enum": [ + "published", + "closed", + "draft" + ] + }, + "collaborating_users": { + "type": "array", + "description": "A list of usernames who have been granted write access to the advisory.", + "nullable": true, + "items": { + "type": "string" + } + }, + "collaborating_teams": { + "type": "array", + "description": "A list of team slugs which have been granted write access to the advisory.", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "stargazer": { + "title": "Stargazer", + "description": "Stargazer", + "type": "object", + "properties": { + "starred_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + } + }, + "required": [ + "starred_at", + "user" + ] + }, + "code-frequency-stat": { + "title": "Code Frequency Stat", + "description": "Code Frequency Stat", + "type": "array", + "items": { + "type": "integer" + } + }, + "commit-activity": { + "title": "Commit Activity", + "description": "Commit Activity", + "type": "object", + "properties": { + "days": { + "type": "array", + "example": [ + 0, + 3, + 26, + 20, + 39, + 1, + 0 + ], + "items": { + "type": "integer" + } + }, + "total": { + "type": "integer", + "example": 89 + }, + "week": { + "type": "integer", + "example": 1336280400 + } + }, + "required": [ + "days", + "total", + "week" + ] + }, + "contributor-activity": { + "title": "Contributor Activity", + "description": "Contributor Activity", + "type": "object", + "properties": { + "author": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "total": { + "type": "integer", + "example": 135 + }, + "weeks": { + "type": "array", + "example": [ + { + "w": "1367712000", + "a": 6898, + "d": 77, + "c": 10 + } + ], + "items": { + "type": "object", + "properties": { + "w": { + "type": "integer" + }, + "a": { + "type": "integer" + }, + "d": { + "type": "integer" + }, + "c": { + "type": "integer" + } + } + } + } + }, + "required": [ + "author", + "total", + "weeks" + ] + }, + "participation-stats": { + "title": "Participation Stats", + "type": "object", + "properties": { + "all": { + "type": "array", + "items": { + "type": "integer" + } + }, + "owner": { + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "all", + "owner" + ] + }, + "repository-subscription": { + "title": "Repository Invitation", + "description": "Repository invitations let you manage who you collaborate with.", + "type": "object", + "properties": { + "subscribed": { + "description": "Determines if notifications should be received from this repository.", + "type": "boolean", + "example": true + }, + "ignored": { + "description": "Determines if all notifications should be blocked from this repository.", + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-10-06T21:34:12Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/subscription" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + } + }, + "required": [ + "created_at", + "ignored", + "reason", + "subscribed", + "url", + "repository_url" + ] + }, + "tag": { + "title": "Tag", + "description": "Tag", + "type": "object", + "properties": { + "name": { + "type": "string", + "example": "v0.1" + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "zipball_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/zipball/v0.1" + }, + "tarball_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/tarball/v0.1" + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "name", + "node_id", + "commit", + "zipball_url", + "tarball_url" + ] + }, + "topic": { + "title": "Topic", + "description": "A topic aggregates entities that are related to a subject.", + "type": "object", + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "names" + ] + }, + "traffic": { + "title": "Traffic", + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time" + }, + "uniques": { + "type": "integer" + }, + "count": { + "type": "integer" + } + }, + "required": [ + "timestamp", + "uniques", + "count" + ] + }, + "clone-traffic": { + "title": "Clone Traffic", + "description": "Clone Traffic", + "type": "object", + "properties": { + "count": { + "type": "integer", + "example": 173 + }, + "uniques": { + "type": "integer", + "example": 128 + }, + "clones": { + "type": "array", + "items": { + "$ref": "#/components/schemas/traffic" + } + } + }, + "required": [ + "uniques", + "count", + "clones" + ] + }, + "content-traffic": { + "title": "Content Traffic", + "description": "Content Traffic", + "type": "object", + "properties": { + "path": { + "type": "string", + "example": "/github/hubot" + }, + "title": { + "type": "string", + "example": "github/hubot: A customizable life embetterment robot." + }, + "count": { + "type": "integer", + "example": 3542 + }, + "uniques": { + "type": "integer", + "example": 2225 + } + }, + "required": [ + "path", + "title", + "uniques", + "count" + ] + }, + "referrer-traffic": { + "title": "Referrer Traffic", + "description": "Referrer Traffic", + "type": "object", + "properties": { + "referrer": { + "type": "string", + "example": "Google" + }, + "count": { + "type": "integer", + "example": 4 + }, + "uniques": { + "type": "integer", + "example": 3 + } + }, + "required": [ + "referrer", + "uniques", + "count" + ] + }, + "view-traffic": { + "title": "View Traffic", + "description": "View Traffic", + "type": "object", + "properties": { + "count": { + "type": "integer", + "example": 14850 + }, + "uniques": { + "type": "integer", + "example": 3782 + }, + "views": { + "type": "array", + "items": { + "$ref": "#/components/schemas/traffic" + } + } + }, + "required": [ + "uniques", + "count", + "views" + ] + }, + "search-result-text-matches": { + "title": "Search Result Text Matches", + "type": "array", + "items": { + "type": "object", + "properties": { + "object_url": { + "type": "string" + }, + "object_type": { + "nullable": true, + "type": "string" + }, + "property": { + "type": "string" + }, + "fragment": { + "type": "string" + }, + "matches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "indices": { + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + } + }, + "code-search-result-item": { + "title": "Code Search Result Item", + "description": "Code Search Result Item", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "score": { + "type": "number" + }, + "file_size": { + "type": "integer" + }, + "language": { + "type": "string", + "nullable": true + }, + "last_modified_at": { + "type": "string", + "format": "date-time" + }, + "line_numbers": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "73..77", + "77..78" + ] + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + } + }, + "required": [ + "score", + "name", + "path", + "sha", + "git_url", + "html_url", + "url", + "repository" + ] + }, + "commit-search-result-item": { + "title": "Commit Search Result Item", + "description": "Commit Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commit": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "date": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "email", + "date" + ] + }, + "committer": { + "$ref": "#/components/schemas/nullable-git-user" + }, + "comment_count": { + "type": "integer" + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "verification": { + "$ref": "#/components/schemas/verification" + } + }, + "required": [ + "author", + "committer", + "comment_count", + "message", + "tree", + "url" + ] + }, + "author": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "committer": { + "$ref": "#/components/schemas/nullable-git-user" + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "score": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + } + }, + "required": [ + "sha", + "node_id", + "url", + "html_url", + "author", + "committer", + "parents", + "comments_url", + "commit", + "repository", + "score" + ] + }, + "issue-search-result-item": { + "title": "Issue Search Result Item", + "description": "Issue Search Result Item", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + }, + "nullable": true + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + } + } + } + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "type": "string" + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "milestone": { + "$ref": "#/components/schemas/nullable-milestone" + }, + "comments": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "body": { + "type": "string" + }, + "score": { + "type": "number" + }, + "author_association": { + "$ref": "#/components/schemas/author-association" + }, + "draft": { + "type": "boolean" + }, + "repository": { + "$ref": "#/components/schemas/repository" + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_singular_assignee_from_issues_and_pull_requests", + "patch": { + "properties": { + "assignee": null + }, + "required": [ + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at", + "score" + ] + }, + "version": "2026-03-10" + } + ] + }, + "label-search-result-item": { + "title": "Label Search Result Item", + "description": "Label Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "score": { + "type": "number" + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description", + "score" + ] + }, + "repo-search-result-item": { + "title": "Repo Search Result Item", + "description": "Repo Search Result Item", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "pushed_at": { + "type": "string", + "format": "date-time" + }, + "homepage": { + "type": "string", + "format": "uri", + "nullable": true + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "score": { + "type": "number" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "mirror_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_forking": { + "type": "boolean" + }, + "is_template": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "example": false + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "score" + ] + }, + "topic-search-result-item": { + "title": "Topic Search Result Item", + "description": "Topic Search Result Item", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "display_name": { + "type": "string", + "nullable": true + }, + "short_description": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "created_by": { + "type": "string", + "nullable": true + }, + "released": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "featured": { + "type": "boolean" + }, + "curated": { + "type": "boolean" + }, + "score": { + "type": "number" + }, + "repository_count": { + "type": "integer", + "nullable": true + }, + "logo_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "related": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "topic_id": { + "type": "integer" + }, + "relation_type": { + "type": "string" + } + } + } + } + } + }, + "aliases": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "topic_relation": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "topic_id": { + "type": "integer" + }, + "relation_type": { + "type": "string" + } + } + } + } + } + } + }, + "required": [ + "name", + "display_name", + "short_description", + "description", + "created_by", + "released", + "created_at", + "updated_at", + "featured", + "curated", + "score" + ] + }, + "user-search-result-item": { + "title": "User Search Result Item", + "description": "User Search Result Item", + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string", + "format": "uri" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "score": { + "type": "number" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "public_repos": { + "type": "integer" + }, + "public_gists": { + "type": "integer" + }, + "followers": { + "type": "integer" + }, + "following": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "nullable": true + }, + "bio": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "format": "email", + "nullable": true + }, + "location": { + "type": "string", + "nullable": true + }, + "site_admin": { + "type": "boolean" + }, + "hireable": { + "type": "boolean", + "nullable": true + }, + "text_matches": { + "$ref": "#/components/schemas/search-result-text-matches" + }, + "blog": { + "type": "string", + "nullable": true + }, + "company": { + "type": "string", + "nullable": true + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "score" + ] + }, + "private-user": { + "title": "Private User", + "description": "Private User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "user_view_type": { + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": "string", + "example": "monalisa octocat", + "nullable": true + }, + "company": { + "type": "string", + "example": "GitHub", + "nullable": true + }, + "blog": { + "type": "string", + "example": "https://github.com/blog", + "nullable": true + }, + "location": { + "type": "string", + "example": "San Francisco", + "nullable": true + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, + "notification_email": { + "type": "string", + "format": "email", + "example": "octocat@github.com", + "nullable": true + }, + "hireable": { + "type": "boolean", + "nullable": true + }, + "bio": { + "type": "string", + "example": "There once was...", + "nullable": true + }, + "twitter_username": { + "type": "string", + "example": "monalisa", + "nullable": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "private_gists": { + "type": "integer", + "example": 81 + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "disk_usage": { + "type": "integer", + "example": 10000 + }, + "collaborators": { + "type": "integer", + "example": 8 + }, + "two_factor_authentication": { + "type": "boolean", + "example": true + }, + "plan": { + "type": "object", + "properties": { + "collaborators": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + } + }, + "required": [ + "collaborators", + "name", + "space", + "private_repos" + ] + }, + "business_plus": { + "type": "boolean" + }, + "ldap_dn": { + "type": "string" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url", + "bio", + "blog", + "company", + "email", + "followers", + "following", + "hireable", + "location", + "name", + "public_gists", + "public_repos", + "created_at", + "updated_at", + "collaborators", + "disk_usage", + "owned_private_repos", + "private_gists", + "total_private_repos", + "two_factor_authentication" + ] + }, + "codespaces-secret": { + "title": "Codespaces Secret", + "description": "Secrets for a GitHub Codespace.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret", + "example": "SECRET_NAME", + "type": "string" + }, + "created_at": { + "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "updated_at": { + "description": "The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.", + "type": "string", + "format": "date-time" + }, + "visibility": { + "description": "The type of repositories in the organization that the secret is visible to", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { + "description": "The API URL at which the list of repositories this secret is visible to can be retrieved", + "type": "string", + "format": "uri", + "example": "https://api.github.com/user/secrets/SECRET_NAME/repositories" + } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility", + "selected_repositories_url" + ] + }, + "codespaces-user-public-key": { + "title": "CodespacesUserPublicKey", + "description": "The public key used for setting user Codespaces' Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "codespace-export-details": { + "type": "object", + "title": "Fetches information about an export of a codespace.", + "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest", + "properties": { + "state": { + "type": "string", + "description": "State of the latest export", + "nullable": true, + "example": "succeeded | failed | in_progress" + }, + "completed_at": { + "description": "Completion time of the last export operation", + "type": "string", + "format": "date-time", + "nullable": true, + "example": "2021-01-01T19:01:12Z" + }, + "branch": { + "type": "string", + "description": "Name of the exported branch", + "nullable": true, + "example": "codespace-monalisa-octocat-hello-world-g4wpq6h95q" + }, + "sha": { + "type": "string", + "description": "Git commit SHA of the exported branch", + "nullable": true, + "example": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2" + }, + "id": { + "type": "string", + "description": "Id for the export details", + "example": "latest" + }, + "export_url": { + "type": "string", + "description": "Url for fetching export details", + "example": "https://api.github.com/user/codespaces/:name/exports/latest" + }, + "html_url": { + "type": "string", + "nullable": true, + "description": "Web url for the exported branch", + "example": "https://github.com/octocat/hello-world/tree/:branch" + } + } + }, + "codespace-with-full-repository": { + "type": "object", + "title": "Codespace", + "description": "A codespace.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "name": { + "description": "Automatically generated name of this codespace.", + "type": "string", + "example": "monalisa-octocat-hello-world-g4wpq6h95q" + }, + "display_name": { + "description": "Display name for this codespace.", + "type": "string", + "example": "bookish space pancake", + "nullable": true + }, + "environment_id": { + "description": "UUID identifying this codespace's environment.", + "type": "string", + "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "nullable": true + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "billable_owner": { + "$ref": "#/components/schemas/simple-user" + }, + "repository": { + "$ref": "#/components/schemas/full-repository" + }, + "machine": { + "$ref": "#/components/schemas/nullable-codespace-machine" + }, + "devcontainer_path": { + "description": "Path to devcontainer.json from repo root used to create Codespace.", + "type": "string", + "example": ".devcontainer/example/devcontainer.json", + "nullable": true + }, + "prebuild": { + "description": "Whether the codespace was created from a prebuild.", + "type": "boolean", + "example": false, + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "last_used_at": { + "description": "Last known time this codespace was started.", + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "state": { + "description": "State of this codespace.", + "enum": [ + "Unknown", + "Created", + "Queued", + "Provisioning", + "Available", + "Awaiting", + "Unavailable", + "Deleted", + "Moved", + "Shutdown", + "Archived", + "Starting", + "ShuttingDown", + "Failed", + "Exporting", + "Updating", + "Rebuilding" + ], + "example": "Available", + "type": "string" + }, + "url": { + "description": "API URL for this codespace.", + "type": "string", + "format": "uri" + }, + "git_status": { + "description": "Details about the codespace's git repository.", + "type": "object", + "properties": { + "ahead": { + "description": "The number of commits the local repository is ahead of the remote.", + "type": "integer", + "example": 0 + }, + "behind": { + "description": "The number of commits the local repository is behind the remote.", + "type": "integer", + "example": 0 + }, + "has_unpushed_changes": { + "description": "Whether the local repository has unpushed changes.", + "type": "boolean" + }, + "has_uncommitted_changes": { + "description": "Whether the local repository has uncommitted changes.", + "type": "boolean" + }, + "ref": { + "description": "The current branch (or SHA if in detached HEAD state) of the local repository.", + "type": "string", + "example": "main" + } + } + }, + "location": { + "description": "The initally assigned location of a new codespace.", + "enum": [ + "EastUs", + "SouthEastAsia", + "WestEurope", + "WestUs2" + ], + "example": "WestUs2", + "type": "string" + }, + "idle_timeout_minutes": { + "description": "The number of minutes of inactivity after which this codespace will be automatically stopped.", + "type": "integer", + "example": 60, + "nullable": true + }, + "web_url": { + "description": "URL to access this codespace on the web.", + "type": "string", + "format": "uri" + }, + "machines_url": { + "description": "API URL to access available alternate machine types for this codespace.", + "type": "string", + "format": "uri" + }, + "start_url": { + "description": "API URL to start this codespace.", + "type": "string", + "format": "uri" + }, + "stop_url": { + "description": "API URL to stop this codespace.", + "type": "string", + "format": "uri" + }, + "publish_url": { + "description": "API URL to publish this codespace to a new repository.", + "type": "string", + "format": "uri", + "nullable": true + }, + "pulls_url": { + "description": "API URL for the Pull Request associated with this codespace, if any.", + "type": "string", + "format": "uri", + "nullable": true + }, + "recent_folders": { + "type": "array", + "items": { + "type": "string" + } + }, + "runtime_constraints": { + "type": "object", + "properties": { + "allowed_port_privacy_settings": { + "description": "The privacy settings a user can select from when forwarding a port.", + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + "pending_operation": { + "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.", + "type": "boolean", + "nullable": true + }, + "pending_operation_disabled_reason": { + "description": "Text to show user when codespace is disabled by a pending operation", + "type": "string", + "nullable": true + }, + "idle_timeout_notice": { + "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy", + "type": "string", + "nullable": true + }, + "retention_period_minutes": { + "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).", + "type": "integer", + "example": 60, + "nullable": true + }, + "retention_expires_at": { + "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"", + "type": "string", + "format": "date-time", + "example": "2011-01-26T20:01:12Z", + "nullable": true + } + }, + "required": [ + "id", + "name", + "environment_id", + "owner", + "billable_owner", + "repository", + "machine", + "prebuild", + "created_at", + "updated_at", + "last_used_at", + "state", + "url", + "git_status", + "location", + "idle_timeout_minutes", + "web_url", + "machines_url", + "start_url", + "stop_url", + "pulls_url", + "recent_folders" + ] + }, + "email": { + "title": "Email", + "description": "Email", + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "primary": { + "type": "boolean", + "example": true + }, + "verified": { + "type": "boolean", + "example": true + }, + "visibility": { + "type": "string", + "example": "public", + "nullable": true + } + }, + "required": [ + "email", + "primary", + "verified", + "visibility" + ] + }, + "gpg-key": { + "title": "GPG Key", + "description": "A unique encryption key", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "example": 3 + }, + "name": { + "type": "string", + "example": "Octocat's GPG Key", + "nullable": true + }, + "primary_key_id": { + "type": "integer", + "nullable": true + }, + "key_id": { + "type": "string", + "example": "3262EFF25BA0D270" + }, + "public_key": { + "type": "string", + "example": "xsBNBFayYZ..." + }, + "emails": { + "type": "array", + "example": [ + { + "email": "octocat@users.noreply.github.com", + "verified": true + } + ], + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } + }, + "subkeys": { + "type": "array", + "example": [ + { + "id": 4, + "primary_key_id": 3, + "key_id": "4A595D4C72EE49C7", + "public_key": "zsBNBFayYZ...", + "emails": [], + "can_sign": false, + "can_encrypt_comms": true, + "can_encrypt_storage": true, + "can_certify": false, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": null, + "revoked": false + } + ], + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "primary_key_id": { + "type": "integer" + }, + "key_id": { + "type": "string" + }, + "public_key": { + "type": "string" + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } + }, + "subkeys": { + "type": "array", + "items": {} + }, + "can_sign": { + "type": "boolean" + }, + "can_encrypt_comms": { + "type": "boolean" + }, + "can_encrypt_storage": { + "type": "boolean" + }, + "can_certify": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "expires_at": { + "type": "string", + "nullable": true + }, + "raw_key": { + "type": "string", + "nullable": true + }, + "revoked": { + "type": "boolean" + } + } + } + }, + "can_sign": { + "type": "boolean", + "example": true + }, + "can_encrypt_comms": { + "type": "boolean" + }, + "can_encrypt_storage": { + "type": "boolean" + }, + "can_certify": { + "type": "boolean", + "example": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-03-24T11:31:04-06:00" + }, + "expires_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "revoked": { + "type": "boolean", + "example": true + }, + "raw_key": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "primary_key_id", + "key_id", + "raw_key", + "public_key", + "created_at", + "expires_at", + "can_sign", + "can_encrypt_comms", + "can_encrypt_storage", + "can_certify", + "emails", + "subkeys", + "revoked" + ] + }, + "key": { + "title": "Key", + "description": "Key", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "verified": { + "type": "boolean" + }, + "read_only": { + "type": "boolean" + }, + "last_used": { + "nullable": true, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "url", + "title", + "created_at", + "verified", + "read_only" + ] + }, + "marketplace-account": { + "title": "Marketplace Account", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "login": { + "type": "string" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "organization_billing_email": { + "type": "string", + "nullable": true, + "format": "email" + } + }, + "required": [ + "url", + "id", + "type", + "login" + ] + }, + "user-marketplace-purchase": { + "title": "User Marketplace Purchase", + "description": "User Marketplace Purchase", + "type": "object", + "properties": { + "billing_cycle": { + "type": "string", + "example": "monthly" + }, + "next_billing_date": { + "type": "string", + "format": "date-time", + "example": "2017-11-11T00:00:00Z", + "nullable": true + }, + "unit_count": { + "type": "integer", + "nullable": true + }, + "on_free_trial": { + "type": "boolean", + "example": true + }, + "free_trial_ends_on": { + "type": "string", + "format": "date-time", + "example": "2017-11-11T00:00:00Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-11-02T01:12:12Z", + "nullable": true + }, + "account": { + "$ref": "#/components/schemas/marketplace-account" + }, + "plan": { + "$ref": "#/components/schemas/marketplace-listing-plan" + } + }, + "required": [ + "billing_cycle", + "next_billing_date", + "unit_count", + "updated_at", + "on_free_trial", + "free_trial_ends_on", + "account", + "plan" + ] + }, + "social-account": { + "title": "Social account", + "description": "Social media account", + "type": "object", + "properties": { + "provider": { + "type": "string", + "example": "linkedin" + }, + "url": { + "type": "string", + "example": "https://www.linkedin.com/company/github/" + } + }, + "required": [ + "provider", + "url" + ] + }, + "ssh-signing-key": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "starred-repository": { + "title": "Starred Repository", + "description": "Starred Repository", + "type": "object", + "properties": { + "starred_at": { + "type": "string", + "format": "date-time" + }, + "repo": { + "$ref": "#/components/schemas/repository" + } + }, + "required": [ + "starred_at", + "repo" + ] + }, + "hovercard": { + "title": "Hovercard", + "description": "Hovercard", + "type": "object", + "properties": { + "contexts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "octicon": { + "type": "string" + } + }, + "required": [ + "message", + "octicon" + ] + } + } + }, + "required": [ + "contexts" + ] + }, + "key-simple": { + "title": "Key Simple", + "description": "Key Simple", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "last_used": { + "nullable": true, + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id" + ] + }, + "billing-premium-request-usage-report-user": { + "type": "object", + "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "user": { + "type": "string", + "description": "The unique identifier of the user." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "model": { + "type": "string", + "description": "The model for the usage report." + }, + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "model": { + "type": "string", + "description": "Model name." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + } + }, + "required": [ + "product", + "sku", + "model", + "unitType", + "pricePerUnit", + "grossQuantity", + "grossAmount", + "discountQuantity", + "discountAmount", + "netQuantity", + "netAmount" + ] + } + } + }, + "required": [ + "timePeriod", + "user", + "usageItems" + ] + }, + "billing-usage-report-user": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount" + ] + } + } + } + }, + "billing-usage-summary-report-user": { + "type": "object", + "properties": { + "timePeriod": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "The year for the usage report." + }, + "month": { + "type": "integer", + "description": "The month for the usage report." + }, + "day": { + "type": "integer", + "description": "The day for the usage report." + } + }, + "required": [ + "year" + ] + }, + "user": { + "type": "string", + "description": "The unique identifier of the user." + }, + "repository": { + "type": "string", + "description": "The name of the repository for the usage report." + }, + "product": { + "type": "string", + "description": "The product for the usage report." + }, + "sku": { + "type": "string", + "description": "The SKU for the usage report." + }, + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossQuantity": { + "type": "number", + "description": "Gross quantity of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountQuantity": { + "type": "number", + "description": "Discount quantity of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netQuantity": { + "type": "number", + "description": "Net quantity of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + } + }, + "required": [ + "product", + "sku", + "unitType", + "pricePerUnit", + "grossQuantity", + "grossAmount", + "discountQuantity", + "discountAmount", + "netQuantity", + "netAmount" + ] + } + } + }, + "required": [ + "timePeriod", + "user", + "usageItems" + ] + }, + "enterprise-webhooks": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "simple-installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization-simple-webhooks": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "repository-webhooks": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ] + }, + "webhooks_rule": { + "title": "branch protection rule", + "description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "boolean" + }, + "allow_deletions_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "allow_force_pushes_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "authorized_actor_names": { + "type": "array", + "items": { + "type": "string" + } + }, + "authorized_actors_only": { + "type": "boolean" + }, + "authorized_dismissal_actors_only": { + "type": "boolean" + }, + "create_protected": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "ignore_approvals_from_contributors": { + "type": "boolean" + }, + "linear_history_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "lock_branch_enforcement_level": { + "description": "The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone.", + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "lock_allows_fork_sync": { + "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.", + "type": "boolean" + }, + "merge_queue_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "name": { + "type": "string" + }, + "pull_request_reviews_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "repository_id": { + "type": "integer" + }, + "require_code_owner_review": { + "type": "boolean" + }, + "require_last_push_approval": { + "description": "Whether the most recent push must be approved by someone other than the person who pushed it", + "type": "boolean" + }, + "required_approving_review_count": { + "type": "integer" + }, + "required_conversation_resolution_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_deployments_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "required_status_checks": { + "type": "array", + "items": { + "type": "string" + } + }, + "required_status_checks_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "signature_requirement_enforcement_level": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + }, + "strict_required_status_checks_policy": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "repository_id", + "name", + "created_at", + "updated_at", + "pull_request_reviews_enforcement_level", + "required_approving_review_count", + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "authorized_dismissal_actors_only", + "ignore_approvals_from_contributors", + "required_status_checks", + "required_status_checks_enforcement_level", + "strict_required_status_checks_policy", + "signature_requirement_enforcement_level", + "linear_history_requirement_enforcement_level", + "lock_branch_enforcement_level", + "admin_enforced", + "allow_force_pushes_enforcement_level", + "allow_deletions_enforcement_level", + "merge_queue_enforcement_level", + "required_deployments_enforcement_level", + "required_conversation_resolution_level", + "authorized_actors_only", + "authorized_actor_names" + ] + }, + "simple-check-suite": { + "description": "A suite of checks performed on the code of a given code change", + "type": "object", + "properties": { + "after": { + "example": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "type": "string", + "nullable": true + }, + "app": { + "$ref": "#/components/schemas/integration" + }, + "before": { + "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "type": "string", + "nullable": true + }, + "conclusion": { + "example": "neutral", + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required", + "stale", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "example": "master", + "type": "string", + "nullable": true + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "id": { + "example": 5, + "type": "integer" + }, + "node_id": { + "example": "MDEwOkNoZWNrU3VpdGU1", + "type": "string" + }, + "pull_requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-minimal" + } + }, + "repository": { + "$ref": "#/components/schemas/minimal-repository" + }, + "status": { + "example": "completed", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending", + "waiting" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "example": "https://api.github.com/repos/github/hello-world/check-suites/5", + "type": "string" + } + } + }, + "check-run-with-simple-check-suite": { + "title": "CheckRun", + "description": "A check performed on the code of a given code change", + "type": "object", + "properties": { + "app": { + "$ref": "#/components/schemas/integration" + }, + "check_suite": { + "$ref": "#/components/schemas/simple-check-suite" + }, + "completed_at": { + "example": "2018-05-04T01:14:52Z", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "conclusion": { + "example": "neutral", + "type": "string", + "nullable": true, + "enum": [ + "waiting", + "pending", + "startup_failure", + "stale", + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ] + }, + "deployment": { + "$ref": "#/components/schemas/deployment-simple" + }, + "details_url": { + "example": "https://example.com", + "type": "string" + }, + "external_id": { + "example": "42", + "type": "string" + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "html_url": { + "example": "https://github.com/github/hello-world/runs/4", + "type": "string" + }, + "id": { + "description": "The id of the check.", + "example": 21, + "type": "integer" + }, + "name": { + "description": "The name of the check.", + "example": "test-coverage", + "type": "string" + }, + "node_id": { + "example": "MDg6Q2hlY2tSdW40", + "type": "string" + }, + "output": { + "type": "object", + "properties": { + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": "string", + "nullable": true + }, + "text": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + } + }, + "required": [ + "title", + "summary", + "text", + "annotations_count", + "annotations_url" + ] + }, + "pull_requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request-minimal" + } + }, + "started_at": { + "example": "2018-05-04T01:14:52Z", + "type": "string", + "format": "date-time" + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "pending" + ] + }, + "url": { + "example": "https://api.github.com/repos/github/hello-world/check-runs/4", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + }, + "webhooks_code_scanning_commit_oid": { + "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.", + "type": "string" + }, + "webhooks_code_scanning_ref": { + "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.", + "type": "string" + }, + "webhooks_deploy_pusher_type": { + "description": "The pusher type for the event. Can be either `user` or a deploy key.", + "type": "string" + }, + "webhooks_ref_0": { + "description": "The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource.", + "type": "string" + }, + "webhooks_deploy_key": { + "description": "The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", + "type": "object", + "properties": { + "added_by": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "last_used": { + "type": "string", + "nullable": true + }, + "read_only": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "verified": { + "type": "boolean" + }, + "enabled": { + "type": "boolean" + } + }, + "required": [ + "id", + "key", + "url", + "title", + "verified", + "created_at", + "read_only" + ] + }, + "webhooks_workflow": { + "title": "Workflow", + "type": "object", + "nullable": true, + "properties": { + "badge_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "badge_url", + "created_at", + "html_url", + "id", + "name", + "node_id", + "path", + "state", + "updated_at", + "url" + ] + }, + "nullable-deployment": { + "title": "Deployment", + "description": "A request for a specific ref(branch,sha,tag) to be deployed", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "type": "integer", + "format": "int64", + "example": 42 + }, + "node_id": { + "type": "string", + "example": "MDEwOkRlcGxveW1lbnQx" + }, + "sha": { + "type": "string", + "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "ref": { + "description": "The ref to deploy. This can be a branch, tag, or sha.", + "example": "topic-branch", + "type": "string" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "payload": { + "oneOf": [ + { + "type": "object", + "additionalProperties": true + }, + { + "type": "string" + } + ] + }, + "original_environment": { + "type": "string", + "example": "staging" + }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "creator": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + } + }, + "required": [ + "id", + "node_id", + "sha", + "ref", + "task", + "environment", + "creator", + "payload", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ], + "nullable": true + }, + "webhooks_approver": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "webhooks_reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reviewer": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "type": { + "type": "string", + "enum": [ + "User" + ] + } + } + } + }, + "webhooks_workflow_job_run": { + "type": "object", + "properties": { + "conclusion": { + "nullable": true + }, + "created_at": { + "type": "string" + }, + "environment": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "nullable": true + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "status", + "conclusion", + "html_url", + "created_at", + "updated_at", + "environment" + ] + }, + "webhooks_user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "webhooks_answer": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "nullable": true + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body" + ] + }, + "webhooks_comment": { + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "type": "string" + }, + "child_comment_count": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "discussion_id": { + "type": "integer" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "parent_id": { + "type": "integer", + "nullable": true + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "parent_id", + "child_comment_count", + "repository_url", + "discussion_id", + "author_association", + "user", + "created_at", + "updated_at", + "body", + "reactions" + ] + }, + "webhooks_label": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + }, + "webhooks_repositories": { + "description": "An array of repository objects that the installation can access.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "webhooks_repositories_added": { + "description": "An array of repository objects, which were added to the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "webhooks_repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "webhooks_issue_comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/integration" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "pin": { + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "webhooks_changes": { + "description": "The changes to the comment.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "webhooks_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "webhooks_milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "webhooks_issue_2": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "webhooks_user_mannequin": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "webhooks_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "required": [ + "account", + "billing_cycle", + "free_trial_ends_on", + "next_billing_date", + "on_free_trial", + "plan", + "unit_count" + ], + "properties": { + "account": { + "type": "object", + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ], + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ], + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string", + "nullable": true + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + } + }, + "webhooks_previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "nullable": true + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, + "webhooks_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "notification_setting": { + "description": "Whether team members will receive notifications when their team is @mentioned", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "notification_setting", + "url", + "html_url", + "members_url", + "repositories_url", + "permission", + "type" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "notification_setting": { + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "name", + "id" + ] + }, + "merge-group": { + "type": "object", + "title": "Merge Group", + "description": "A group of pull requests that the merge queue has grouped together to be merged.", + "properties": { + "head_sha": { + "description": "The SHA of the merge group.", + "type": "string" + }, + "head_ref": { + "description": "The full ref of the merge group.", + "type": "string" + }, + "base_sha": { + "description": "The SHA of the merge group's parent commit.", + "type": "string" + }, + "base_ref": { + "description": "The full ref of the branch the merge group will be merged into.", + "type": "string" + }, + "head_commit": { + "$ref": "#/components/schemas/simple-commit" + } + }, + "required": [ + "head_sha", + "head_ref", + "base_sha", + "base_ref", + "head_commit" + ] + }, + "nullable-repository-webhooks": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer", + "format": "int64" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "organization": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "example": true + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "example": false + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "example": false + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": { + "properties": { + "use_squash_pr_title_as_default": null, + "template_repository": { + "properties": { + "use_squash_pr_title_as_default": null + } + } + } + }, + "version": "2026-03-10" + }, + { + "changeset": "deprecate_beta_media_type", + "patch": { + "properties": { + "master_branch": null + } + }, + "version": "2026-03-10" + } + ], + "nullable": true + }, + "webhooks_milestone_3": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "webhooks_membership": { + "title": "Membership", + "description": "The membership between the user and the organization. Not present when the action is `member_invited`.", + "type": "object", + "properties": { + "organization_url": { + "type": "string", + "format": "uri" + }, + "role": { + "type": "string" + }, + "direct_membership": { + "type": "boolean", + "description": "Whether the user has direct membership in the organization.", + "example": true + }, + "enterprise_teams_providing_indirect_membership": { + "type": "array", + "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", + "maxItems": 100, + "items": { + "type": "string" + }, + "example": [ + "ent:team-one", + "ent:team-two" + ] + }, + "state": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "state", + "role", + "organization_url", + "user" + ] + }, + "personal-access-token-request": { + "title": "Personal Access Token Request", + "description": "Details of a Personal Access Token Request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls." + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "permissions_added": { + "type": "object", + "description": "New requested permissions, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "permissions_upgraded": { + "type": "object", + "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "permissions_result": { + "type": "object", + "description": "Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "repository_selection": { + "type": "string", + "description": "Type of repository selection requested.", + "enum": [ + "none", + "all", + "subset" + ] + }, + "repository_count": { + "description": "The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`.", + "type": "integer", + "nullable": true + }, + "repositories": { + "type": "array", + "description": "An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`.", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + }, + "nullable": true + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_id": { + "type": "integer", + "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." + }, + "token_name": { + "type": "string", + "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": "string", + "description": "Date and time when the associated fine-grained personal access token expires.", + "nullable": true + }, + "token_last_used_at": { + "type": "string", + "description": "Date and time when the associated fine-grained personal access token was last used for authentication.", + "nullable": true + } + }, + "required": [ + "id", + "owner", + "permissions_added", + "permissions_upgraded", + "permissions_result", + "repository_selection", + "repository_count", + "repositories", + "created_at", + "token_id", + "token_name", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + }, + "webhooks_project_card": { + "title": "Project Card", + "type": "object", + "properties": { + "after_id": { + "type": "integer", + "nullable": true + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": "integer" + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": "string", + "nullable": true + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + "webhooks_project": { + "title": "Project", + "type": "object", + "properties": { + "body": { + "description": "Body of the project", + "type": "string", + "nullable": true + }, + "columns_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "description": "Name of the project", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "owner_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at" + ] + }, + "webhooks_project_column": { + "title": "Project Column", + "type": "object", + "properties": { + "after_id": { + "type": "integer", + "nullable": true + }, + "cards_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "id": { + "description": "The unique identifier of the project column", + "type": "integer" + }, + "name": { + "description": "Name of the project column", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "cards_url", + "id", + "node_id", + "name", + "created_at", + "updated_at" + ] + }, + "webhooks_project_changes": { + "type": "object", + "properties": { + "archived_at": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "to": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + } + } + }, + "projects-v2-item": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { + "type": "string", + "description": "The node ID of the project item." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that contains this item." + }, + "content_node_id": { + "type": "string", + "description": "The node ID of the content represented by this item." + }, + "content_type": { + "$ref": "#/components/schemas/projects-v2-item-content-type" + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the item was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the item was last updated." + }, + "archived_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "nullable": true, + "description": "The time when the item was archived." + } + }, + "required": [ + "id", + "content_node_id", + "content_type", + "created_at", + "updated_at", + "archived_at" + ] + }, + "projects-v2-single-select-option": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "nullable": true, + "description": "The color associated with the option." + }, + "description": { + "type": "string", + "nullable": true, + "description": "A short description of the option." + } + }, + "required": [ + "id", + "name" + ] + }, + "projects-v2-iteration-setting": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "title": { + "type": "string", + "description": "The iteration title." + }, + "title_html": { + "type": "string", + "description": "The iteration title, rendered as HTML." + }, + "duration": { + "type": "number", + "nullable": true, + "description": "The duration of the iteration in days." + }, + "start_date": { + "type": "string", + "nullable": true, + "description": "The start date of the iteration." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "title" + ] + }, + "projects-v2-status-update": { + "title": "Projects v2 Status Update", + "description": "An status update belonging to a project", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "The unique identifier of the status update." + }, + "node_id": { + "type": "string", + "description": "The node ID of the status update." + }, + "project_node_id": { + "type": "string", + "description": "The node ID of the project that this status update belongs to." + }, + "creator": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the status update was created." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2022-04-28T12:00:00Z", + "description": "The time when the status update was last updated." + }, + "status": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true, + "description": "The current status." + }, + "start_date": { + "type": "string", + "format": "date", + "example": "2022-04-28", + "description": "The start date of the period covered by the update." + }, + "target_date": { + "type": "string", + "format": "date", + "example": "2022-04-28", + "description": "The target date associated with the update." + }, + "body": { + "description": "Body of the status update", + "example": "The project is off to a great start!", + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "created_at", + "updated_at" + ] + }, + "webhooks_number": { + "description": "The pull request number.", + "type": "integer" + }, + "pull-request-webhook": { + "allOf": [ + { + "$ref": "#/components/schemas/pull-request" + }, + { + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_update_branch": { + "description": "Whether to allow updating the pull request's branch.", + "type": "boolean" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged.", + "type": "boolean", + "default": false + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**", + "type": "boolean", + "default": false + } + } + } + ] + }, + "webhooks_pull_request_5": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": { + "properties": { + "merge_commit_sha": null + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "version": "2026-03-10" + } + ] + }, + "webhooks_review_comment": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer" + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": "integer", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + }, + "webhooks_review": { + "description": "The review that was affected.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the review.", + "type": "string", + "nullable": true + }, + "commit_id": { + "description": "A commit SHA for the review.", + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the review", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string" + }, + "submitted_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "user", + "body", + "commit_id", + "submitted_at", + "state", + "html_url", + "pull_request_url", + "author_association", + "_links" + ] + }, + "webhooks_nullable_string": { + "type": "string", + "nullable": true + }, + "webhooks_release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "type": "object", + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ] + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "url", + "assets_url", + "upload_url", + "html_url", + "id", + "node_id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "immutable", + "created_at", + "published_at", + "assets", + "tarball_url", + "updated_at", + "zipball_url", + "body" + ] + }, + "webhooks_release_1": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "name", + "node_id", + "prerelease", + "immutable", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "content_type", + "size", + "digest", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean" + }, + "published_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "format": "uri" + } + } + }, + "webhooks_alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "auto_dismissed", + "open" + ] + } + } + }, + "secret-scanning-alert-resolution-webhook": { + "type": "string", + "description": "The reason for resolving the alert.", + "nullable": true, + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited" + ] + }, + "secret-scanning-alert-webhook": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "$ref": "#/components/schemas/nullable-alert-updated-at" + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" + }, + "resolved_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "resolved_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "resolution_comment": { + "type": "string", + "description": "An optional comment to resolve an alert.", + "nullable": true + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "provider": { + "type": "string", + "description": "The provider of the secret that was detected.", + "nullable": true + }, + "provider_slug": { + "type": "string", + "description": "The slug identifier for the provider of the secret that was detected.", + "nullable": true + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "push_protection_bypassed": { + "type": "boolean", + "description": "Whether push protection was bypassed for the detected secret.", + "nullable": true + }, + "push_protection_bypassed_by": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypassed_at": { + "type": "string", + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "push_protection_bypass_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "push_protection_bypass_request_reviewer_comment": { + "type": "string", + "description": "An optional comment when reviewing a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_comment": { + "type": "string", + "description": "An optional comment when requesting a push protection bypass.", + "nullable": true + }, + "push_protection_bypass_request_html_url": { + "type": "string", + "format": "uri", + "description": "The URL to a push protection bypass request.", + "nullable": true + }, + "publicly_leaked": { + "type": "boolean", + "description": "Whether the detected secret was publicly leaked.", + "nullable": true + }, + "multi_repo": { + "type": "boolean", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.", + "nullable": true + }, + "assigned_to": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "closure_request_comment": { + "type": "string", + "description": "An optional comment from the closure request author.", + "nullable": true + }, + "closure_request_reviewer_comment": { + "type": "string", + "description": "An optional comment from the closure request reviewer.", + "nullable": true + }, + "closure_request_reviewer": { + "$ref": "#/components/schemas/nullable-simple-user" + } + } + }, + "webhooks_security_advisory": { + "description": "The details of the security advisory, including summary, description, and severity.", + "type": "object", + "properties": { + "cvss": { + "type": "object", + "properties": { + "score": { + "type": "number" + }, + "vector_string": { + "type": "string", + "nullable": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "description": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "value", + "type" + ] + } + }, + "published_at": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url" + ] + } + }, + "severity": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "vulnerabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "first_patched_version": { + "type": "object", + "nullable": true, + "properties": { + "identifier": { + "type": "string" + } + }, + "required": [ + "identifier" + ] + }, + "package": { + "type": "object", + "properties": { + "ecosystem": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "severity": { + "type": "string" + }, + "vulnerable_version_range": { + "type": "string" + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ] + } + }, + "withdrawn_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "cvss", + "cwes", + "ghsa_id", + "summary", + "description", + "severity", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at", + "vulnerabilities" + ], + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": { + "properties": { + "cvss": null + }, + "required": [ + "cwes", + "ghsa_id", + "summary", + "description", + "severity", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at", + "vulnerabilities" + ] + }, + "version": "2026-03-10" + } + ] + }, + "webhooks_sponsorship": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "maintainer": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "node_id": { + "type": "string" + }, + "privacy_level": { + "type": "string" + }, + "sponsor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "sponsorable": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "tier": { + "title": "Sponsorship Tier", + "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "is_custom_ammount": { + "type": "boolean" + }, + "is_custom_amount": { + "type": "boolean" + }, + "is_one_time": { + "type": "boolean" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "monthly_price_in_dollars": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "created_at", + "description", + "monthly_price_in_cents", + "monthly_price_in_dollars", + "name", + "is_one_time" + ] + } + }, + "required": [ + "node_id", + "created_at", + "sponsorable", + "sponsor", + "privacy_level", + "tier" + ] + }, + "webhooks_effective_date": { + "description": "The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect.", + "type": "string" + }, + "webhooks_changes_8": { + "type": "object", + "properties": { + "tier": { + "type": "object", + "properties": { + "from": { + "title": "Sponsorship Tier", + "description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "is_custom_ammount": { + "type": "boolean" + }, + "is_custom_amount": { + "type": "boolean" + }, + "is_one_time": { + "type": "boolean" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "monthly_price_in_dollars": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "created_at", + "description", + "monthly_price_in_cents", + "monthly_price_in_dollars", + "name", + "is_one_time" + ] + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "tier" + ] + }, + "webhooks_team_1": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "notification_setting": { + "description": "Whether team members will receive notifications when their team is @mentioned", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "notification_setting", + "url", + "html_url", + "members_url", + "repositories_url", + "permission", + "type" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "notification_setting": { + "description": "Whether team members will receive notifications when their team is @mentioned", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + }, + "type": { + "description": "The ownership type of the team", + "type": "string", + "enum": [ + "enterprise", + "organization" + ] + }, + "organization_id": { + "type": "integer", + "description": "Unique identifier of the organization to which this team belongs", + "example": 37 + }, + "enterprise_id": { + "type": "integer", + "description": "Unique identifier of the enterprise to which this team belongs", + "example": 42 + } + }, + "required": [ + "name", + "id" + ] + }, + "webhook-branch-protection-configuration-disabled": { + "title": "branch protection configuration disabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "disabled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-branch-protection-configuration-enabled": { + "title": "branch protection configuration enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "enabled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-branch-protection-rule-created": { + "title": "branch protection rule created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "rule": { + "$ref": "#/components/schemas/webhooks_rule" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + }, + "webhook-branch-protection-rule-deleted": { + "title": "branch protection rule deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "rule": { + "$ref": "#/components/schemas/webhooks_rule" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + }, + "webhook-branch-protection-rule-edited": { + "title": "branch protection rule edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "If the action was `edited`, the changes to the rule.", + "type": "object", + "properties": { + "admin_enforced": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "authorized_actor_names": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "from" + ] + }, + "authorized_actors_only": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "authorized_dismissal_actors_only": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "linear_history_requirement_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "lock_branch_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "lock_allows_fork_sync": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "pull_request_reviews_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + }, + "require_last_push_approval": { + "type": "object", + "properties": { + "from": { + "type": "boolean", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "required_status_checks": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "from" + ] + }, + "required_status_checks_enforcement_level": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "off", + "non_admins", + "everyone" + ] + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "rule": { + "$ref": "#/components/schemas/webhooks_rule" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "rule", + "repository", + "sender" + ] + }, + "webhook-check-run-completed": { + "title": "Check Run Completed Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "check_run": { + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "check_run", + "repository", + "sender" + ] + }, + "webhook-check-run-completed-form-encoded": { + "title": "Check Run Completed Event", + "description": "The check_run.completed webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-check-run-created": { + "title": "Check Run Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "check_run": { + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "check_run", + "repository", + "sender" + ] + }, + "webhook-check-run-created-form-encoded": { + "title": "Check Run Created Event", + "description": "The check_run.created webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-check-run-requested-action": { + "title": "Check Run Requested Action Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested_action" + ] + }, + "check_run": { + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requested_action": { + "description": "The action requested by the user.", + "type": "object", + "properties": { + "identifier": { + "description": "The integrator reference of the action requested by the user.", + "type": "string" + } + } + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "check_run", + "repository", + "sender" + ] + }, + "webhook-check-run-requested-action-form-encoded": { + "title": "Check Run Requested Action Event", + "description": "The check_run.requested_action webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-check-run-rerequested": { + "title": "Check Run Re-Requested Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rerequested" + ] + }, + "check_run": { + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "check_run", + "repository", + "sender" + ] + }, + "webhook-check-run-rerequested-form-encoded": { + "title": "Check Run Re-Requested Event", + "description": "The check_run.rerequested webhook encoded with URL encoding", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-check-suite-completed": { + "title": "check_suite completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).", + "type": "object", + "properties": { + "after": { + "type": "string", + "nullable": true + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_group", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "projects_v2_item", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "client_id": { + "description": "The client ID of the GitHub app", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": "string", + "nullable": true + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": "string", + "nullable": true + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": "string", + "nullable": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null, + "pending" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "check_suite", + "repository", + "sender" + ] + }, + "webhook-check-suite-requested": { + "title": "check_suite requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).", + "type": "object", + "properties": { + "after": { + "type": "string", + "nullable": true + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "workflow_job", + "merge_queue_entry", + "security_and_analysis", + "secret_scanning_alert_location", + "projects_v2_item", + "merge_group", + "repository_import" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "client_id": { + "description": "Client ID of the GitHub app", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "copilot_requests": { + "type": "string", + "enum": [ + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "models": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": "string", + "nullable": true + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": "string", + "nullable": true + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": "string", + "nullable": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "check_suite", + "repository", + "sender" + ] + }, + "webhook-check-suite-rerequested": { + "title": "check_suite rerequested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rerequested" + ] + }, + "check_suite": { + "description": "The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite).", + "type": "object", + "properties": { + "after": { + "type": "string", + "nullable": true + }, + "app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "client_id": { + "description": "The Client ID for the GitHub app", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "attestations": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "copilot_requests": { + "type": "string", + "enum": [ + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "merge_queues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "models": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "before": { + "type": "string", + "nullable": true + }, + "check_runs_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "description": "The head branch name the changes are on.", + "type": "string", + "nullable": true + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "type": "string" + }, + "id": { + "type": "integer" + }, + "latest_check_runs_count": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_requests": { + "description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.", + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "rerequestable": { + "type": "boolean" + }, + "runs_rerequestable": { + "type": "boolean" + }, + "status": { + "description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.", + "type": "string", + "nullable": true, + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + null + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL that points to the check suite API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "head_sha", + "status", + "conclusion", + "url", + "before", + "after", + "pull_requests", + "app", + "created_at", + "updated_at", + "latest_check_runs_count", + "check_runs_url", + "head_commit" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "check_suite", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-appeared-in-branch": { + "title": "code_scanning_alert appeared_in_branch event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "appeared_in_branch" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-closed-by-user": { + "title": "code_scanning_alert closed_by_user event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed_by_user" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "dismissal_approved_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-created": { + "title": "code_scanning_alert created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "dismissed_by": { + "nullable": true + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "type": "string", + "nullable": true, + "enum": [ + "open", + "dismissed" + ] + }, + "tool": { + "type": "object", + "nullable": true, + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "updated_at": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "dismissal_approved_by": { + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-fixed": { + "title": "code_scanning_alert fixed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "fixed" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-reopened": { + "title": "code_scanning_alert reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true + }, + "dismissed_by": { + "type": "object", + "nullable": true + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "type": "string", + "nullable": true + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "instances_url": { + "type": "string" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "full_description": { + "type": "string" + }, + "help": { + "type": "string", + "nullable": true + }, + "help_uri": { + "description": "A link to the documentation for the rule used to detect the alert.", + "type": "string", + "nullable": true + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "name": { + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + }, + "tags": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "guid": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "updated_at": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "dismissal_approved_by": { + "nullable": true + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.", + "type": "string", + "nullable": true + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.", + "type": "string", + "nullable": true + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-reopened-by-user": { + "title": "code_scanning_alert reopened_by_user event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened_by_user" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "dismissed_by": { + "nullable": true + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "commit_oid": { + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "ref", + "commit_oid", + "repository", + "sender" + ] + }, + "webhook-code-scanning-alert-updated-assignment": { + "title": "code_scanning_alert updated_assignment event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated_assignment" + ] + }, + "alert": { + "description": "The code scanning alert involved in the event.", + "type": "object", + "properties": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "created_at": { + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`", + "type": "string", + "format": "date-time" + }, + "dismissed_at": { + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string", + "nullable": true, + "format": "date-time" + }, + "dismissed_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "dismissed_comment": { + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + }, + "dismissed_reason": { + "description": "The reason for dismissing or closing the alert.", + "type": "string", + "nullable": true, + "enum": [ + "false positive", + "won't fix", + "used in tests", + null + ] + }, + "fixed_at": { + "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "nullable": true + }, + "html_url": { + "description": "The GitHub URL of the alert resource.", + "type": "string", + "format": "uri" + }, + "most_recent_instance": { + "title": "Alert Instance", + "type": "object", + "nullable": true, + "properties": { + "analysis_key": { + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.", + "type": "string" + }, + "category": { + "description": "Identifies the configuration under which the analysis was executed.", + "type": "string" + }, + "classifications": { + "type": "array", + "items": { + "type": "string" + } + }, + "commit_sha": { + "type": "string" + }, + "environment": { + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.", + "type": "string" + }, + "location": { + "type": "object", + "properties": { + "end_column": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "path": { + "type": "string" + }, + "start_column": { + "type": "integer" + }, + "start_line": { + "type": "integer" + } + } + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "ref": { + "description": "The full Git reference, formatted as `refs/heads/`.", + "type": "string" + }, + "state": { + "description": "State of a code scanning alert.", + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + }, + "required": [ + "ref", + "analysis_key", + "environment", + "state" + ] + }, + "number": { + "description": "The code scanning alert number.", + "type": "integer" + }, + "rule": { + "type": "object", + "properties": { + "description": { + "description": "A short description of the rule used to detect the alert.", + "type": "string" + }, + "id": { + "description": "A unique identifier for the rule used to detect the alert.", + "type": "string" + }, + "severity": { + "description": "The severity of the alert.", + "type": "string", + "nullable": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + }, + "required": [ + "id", + "severity", + "description" + ] + }, + "state": { + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", + "nullable": true, + "type": "string", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "tool": { + "type": "object", + "properties": { + "name": { + "description": "The name of the tool used to generate the code scanning analysis alert.", + "type": "string" + }, + "version": { + "description": "The version of the tool used to detect the alert.", + "type": "string", + "nullable": true + } + }, + "required": [ + "name", + "version" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-commit-comment-created": { + "title": "commit_comment created event", + "type": "object", + "properties": { + "action": { + "description": "The action performed. Can be `created`.", + "type": "string", + "enum": [ + "created" + ] + }, + "comment": { + "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the commit comment.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "node_id": { + "description": "The node ID of the commit comment.", + "type": "string" + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string", + "nullable": true + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": "integer", + "nullable": true + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "id", + "node_id", + "user", + "position", + "line", + "path", + "commit_id", + "created_at", + "updated_at", + "author_association", + "body" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "comment", + "repository", + "sender" + ] + }, + "webhook-create": { + "title": "create event", + "type": "object", + "properties": { + "description": { + "description": "The repository's current description.", + "type": "string", + "nullable": true + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "master_branch": { + "description": "The name of the repository's default branch (usually `main`).", + "type": "string" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pusher_type": { + "$ref": "#/components/schemas/webhooks_deploy_pusher_type" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_ref_0" + }, + "ref_type": { + "description": "The type of Git ref object created in the repository.", + "type": "string", + "enum": [ + "tag", + "branch" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "ref", + "ref_type", + "master_branch", + "description", + "pusher_type", + "repository", + "sender" + ] + }, + "webhook-custom-property-created": { + "title": "custom property created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, + "webhook-custom-property-deleted": { + "title": "custom property deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "definition": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property that was deleted." + } + }, + "required": [ + "property_name" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, + "webhook-custom-property-promoted-to-enterprise": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, + "webhook-custom-property-updated": { + "title": "custom property updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, + "webhook-custom-property-values-updated": { + "title": "Custom property values updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "new_property_values": { + "type": "array", + "description": "The new custom property values for the repository.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "old_property_values": { + "type": "array", + "description": "The old custom property values for the repository.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "action", + "repository", + "organization", + "new_property_values", + "old_property_values" + ] + }, + "webhook-delete": { + "title": "delete event", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pusher_type": { + "$ref": "#/components/schemas/webhooks_deploy_pusher_type" + }, + "ref": { + "$ref": "#/components/schemas/webhooks_ref_0" + }, + "ref_type": { + "description": "The type of Git ref object deleted in the repository.", + "type": "string", + "enum": [ + "tag", + "branch" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "ref", + "ref_type", + "pusher_type", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-assignees-changed": { + "title": "Dependabot alert assignees changed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assignees_changed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-auto-dismissed": { + "title": "Dependabot alert auto-dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_dismissed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-auto-reopened": { + "title": "Dependabot alert auto-reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_reopened" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-created": { + "title": "Dependabot alert created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-dismissed": { + "title": "Dependabot alert dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "dismissed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-fixed": { + "title": "Dependabot alert fixed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "fixed" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-reintroduced": { + "title": "Dependabot alert reintroduced event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reintroduced" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-dependabot-alert-reopened": { + "title": "Dependabot alert reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "alert": { + "$ref": "#/components/schemas/dependabot-alert" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-deploy-key-created": { + "title": "deploy_key created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "key": { + "$ref": "#/components/schemas/webhooks_deploy_key" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "key", + "repository", + "sender" + ] + }, + "webhook-deploy-key-deleted": { + "title": "deploy_key deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "key": { + "$ref": "#/components/schemas/webhooks_deploy_key" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "key", + "repository", + "sender" + ] + }, + "webhook-deployment-created": { + "title": "deployment created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "deployment": { + "title": "Deployment", + "description": "The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "environment": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "original_environment": { + "type": "string" + }, + "payload": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "workflow_job", + "pull_request_review_thread", + "merge_queue_entry", + "secret_scanning_alert_location", + "merge_group" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow": { + "$ref": "#/components/schemas/webhooks_workflow" + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { + "nullable": true + }, + "head_repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "deployment", + "workflow", + "workflow_run", + "repository", + "sender" + ] + }, + "webhook-deployment-protection-rule-requested": { + "title": "deployment protection rule requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "environment": { + "description": "The name of the environment that has the deployment protection rule.", + "type": "string" + }, + "event": { + "description": "The event that triggered the deployment protection rule.", + "type": "string" + }, + "sha": { + "description": "The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created.", + "type": "string" + }, + "ref": { + "description": "The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created.", + "type": "string" + }, + "deployment_callback_url": { + "description": "The URL to review the deployment protection rule.", + "type": "string", + "format": "uri" + }, + "deployment": { + "$ref": "#/components/schemas/nullable-deployment" + }, + "pull_requests": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pull-request" + } + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + } + }, + "webhook-deployment-review-approved": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "approved" + ] + }, + "approver": { + "$ref": "#/components/schemas/webhooks_approver" + }, + "comment": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "reviewers": { + "$ref": "#/components/schemas/webhooks_reviewers" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "since": { + "type": "string" + }, + "workflow_job_run": { + "$ref": "#/components/schemas/webhooks_workflow_job_run" + }, + "workflow_job_runs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conclusion": { + "nullable": true + }, + "created_at": { + "type": "string" + }, + "environment": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { + "type": "object", + "nullable": true + }, + "head_repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": "string", + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "workflow_run", + "since", + "repository", + "organization", + "sender" + ] + }, + "webhook-deployment-review-rejected": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "rejected" + ] + }, + "approver": { + "$ref": "#/components/schemas/webhooks_approver" + }, + "comment": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "reviewers": { + "$ref": "#/components/schemas/webhooks_reviewers" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "since": { + "type": "string" + }, + "workflow_job_run": { + "$ref": "#/components/schemas/webhooks_workflow_job_run" + }, + "workflow_job_runs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conclusion": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "environment": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { + "type": "object", + "nullable": true + }, + "head_repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": "string", + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + }, + "display_title": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "workflow_run", + "since", + "repository", + "organization", + "sender" + ] + }, + "webhook-deployment-review-requested": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "environment": { + "type": "string" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requestor": { + "$ref": "#/components/schemas/webhooks_user" + }, + "reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reviewer": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "type": { + "type": "string", + "enum": [ + "User", + "Team" + ] + } + } + } + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "since": { + "type": "string" + }, + "workflow_job_run": { + "type": "object", + "properties": { + "conclusion": { + "nullable": true + }, + "created_at": { + "type": "string" + }, + "environment": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "status", + "conclusion", + "html_url", + "created_at", + "updated_at", + "environment" + ] + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { + "type": "object", + "nullable": true + }, + "head_repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": "string", + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + }, + "display_title": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "workflow_run", + "since", + "workflow_job_run", + "environment", + "reviewers", + "requestor", + "repository", + "organization", + "sender" + ] + }, + "webhook-deployment-status-created": { + "title": "deployment_status created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "check_run": { + "type": "object", + "nullable": true, + "properties": { + "completed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "conclusion": { + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + "skipped", + null + ] + }, + "details_url": { + "type": "string", + "format": "uri" + }, + "external_id": { + "type": "string" + }, + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "The id of the check.", + "type": "integer" + }, + "name": { + "description": "The name of the check run.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting", + "pending" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_sha", + "external_id", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at" + ] + }, + "deployment": { + "title": "Deployment", + "description": "The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "environment": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "original_environment": { + "type": "string" + }, + "payload": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "merge_queue_entry", + "workflow_job", + "pull_request_review_thread", + "secret_scanning_alert_location", + "merge_group" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "production_environment": { + "type": "boolean" + }, + "ref": { + "type": "string" + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "task": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "sha", + "ref", + "task", + "payload", + "original_environment", + "environment", + "description", + "creator", + "created_at", + "updated_at", + "statuses_url", + "repository_url" + ] + }, + "deployment_status": { + "description": "The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses).", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "deployment_url": { + "type": "string", + "format": "uri" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string" + }, + "environment": { + "type": "string" + }, + "environment_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "log_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "merge_queue_entry", + "workflow_job", + "merge_group", + "secret_scanning_alert_location" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", + "type": "string" + }, + "target_url": { + "description": "The optional link added to the status.", + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "node_id", + "state", + "creator", + "description", + "environment", + "target_url", + "created_at", + "updated_at", + "deployment_url", + "repository_url" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow": { + "$ref": "#/components/schemas/webhooks_workflow" + }, + "workflow_run": { + "title": "Deployment Workflow Run", + "type": "object", + "nullable": true, + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "artifacts_url": { + "type": "string" + }, + "cancel_url": { + "type": "string" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "display_title": { + "type": "string" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string" + }, + "head_commit": { + "nullable": true + }, + "head_repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string" + }, + "logs_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Check Run Pull Request", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "type": "object", + "properties": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "nullable": true + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "rerun_url": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "waiting", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "node_id", + "head_branch", + "head_sha", + "run_number", + "event", + "status", + "conclusion", + "workflow_id", + "check_suite_id", + "check_suite_node_id", + "url", + "html_url", + "path", + "pull_requests", + "created_at", + "updated_at", + "actor", + "triggering_actor", + "run_attempt", + "run_started_at", + "display_title" + ] + } + }, + "required": [ + "action", + "deployment_status", + "deployment", + "repository", + "sender" + ] + }, + "webhook-discussion-answered": { + "title": "discussion answered event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "answered" + ] + }, + "answer": { + "$ref": "#/components/schemas/webhooks_answer" + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "answer", + "repository", + "sender" + ] + }, + "webhook-discussion-category-changed": { + "title": "discussion category changed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "category_changed" + ] + }, + "changes": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "description": { + "type": "string" + }, + "emoji": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_answerable": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "repository_id": { + "type": "integer" + }, + "slug": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "repository_id", + "emoji", + "name", + "description", + "created_at", + "updated_at", + "slug", + "is_answerable" + ] + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "category" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-closed": { + "title": "discussion closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-comment-created": { + "title": "discussion_comment created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_comment" + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "comment", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-comment-deleted": { + "title": "discussion_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_comment" + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "comment", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-comment-edited": { + "title": "discussion_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "body" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_comment" + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "comment", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-created": { + "title": "discussion created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-deleted": { + "title": "discussion deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-edited": { + "title": "discussion edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-labeled": { + "title": "discussion labeled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "labeled" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "label", + "repository", + "sender" + ] + }, + "webhook-discussion-locked": { + "title": "discussion locked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "locked" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-pinned": { + "title": "discussion pinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pinned" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-reopened": { + "title": "discussion reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-transferred": { + "title": "discussion transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "new_discussion": { + "$ref": "#/components/schemas/discussion" + }, + "new_repository": { + "$ref": "#/components/schemas/repository-webhooks" + } + }, + "required": [ + "new_discussion", + "new_repository" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-unanswered": { + "title": "discussion unanswered event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unanswered" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "old_answer": { + "$ref": "#/components/schemas/webhooks_answer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "old_answer", + "repository" + ] + }, + "webhook-discussion-unlabeled": { + "title": "discussion unlabeled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlabeled" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "label", + "repository", + "sender" + ] + }, + "webhook-discussion-unlocked": { + "title": "discussion unlocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-discussion-unpinned": { + "title": "discussion unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "discussion", + "repository", + "sender" + ] + }, + "webhook-fork": { + "title": "fork event", + "description": "A user forks a repository.", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "forkee": { + "description": "The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource.", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + { + "type": "object", + "properties": { + "allow_forking": { + "type": "boolean" + }, + "archive_url": { + "type": "string" + }, + "archived": { + "type": "boolean" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "default_branch": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "type": "boolean" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "fork": { + "type": "boolean", + "enum": [ + true + ] + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "has_downloads": { + "type": "boolean" + }, + "has_issues": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "language": { + "nullable": true + }, + "languages_url": { + "type": "string" + }, + "license": { + "type": "object", + "nullable": true + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "mirror_url": { + "nullable": true + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "private": { + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "topics": { + "type": "array", + "items": { + "nullable": true + } + }, + "trees_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + } + } + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "forkee", + "repository", + "sender" + ] + }, + "webhook-github-app-authorization-revoked": { + "title": "github_app_authorization revoked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "revoked" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "sender" + ] + }, + "webhook-gollum": { + "title": "gollum event", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pages": { + "description": "The pages that were updated.", + "type": "array", + "items": { + "type": "object", + "properties": { + "action": { + "description": "The action that was performed on the page. Can be `created` or `edited`.", + "type": "string", + "enum": [ + "created", + "edited" + ] + }, + "html_url": { + "description": "Points to the HTML wiki page.", + "type": "string", + "format": "uri" + }, + "page_name": { + "description": "The name of the page.", + "type": "string" + }, + "sha": { + "description": "The latest commit SHA of the page.", + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "title": { + "description": "The current page title.", + "type": "string" + } + }, + "required": [ + "page_name", + "title", + "summary", + "action", + "sha", + "html_url" + ] + } + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "pages", + "repository", + "sender" + ] + }, + "webhook-installation-created": { + "title": "installation created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories": { + "$ref": "#/components/schemas/webhooks_repositories" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requester": { + "$ref": "#/components/schemas/webhooks_user" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "sender" + ] + }, + "webhook-installation-deleted": { + "title": "installation deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories": { + "$ref": "#/components/schemas/webhooks_repositories" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requester": { + "nullable": true + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "sender" + ] + }, + "webhook-installation-new-permissions-accepted": { + "title": "installation new_permissions_accepted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "new_permissions_accepted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories": { + "$ref": "#/components/schemas/webhooks_repositories" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requester": { + "nullable": true + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "sender" + ] + }, + "webhook-installation-repositories-added": { + "title": "installation_repositories added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "added" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories_added": { + "$ref": "#/components/schemas/webhooks_repositories_added" + }, + "repositories_removed": { + "description": "An array of repository objects, which were removed from the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + } + } + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_selection": { + "$ref": "#/components/schemas/webhooks_repository_selection" + }, + "requester": { + "$ref": "#/components/schemas/webhooks_user" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "repository_selection", + "repositories_added", + "repositories_removed", + "requester", + "sender" + ] + }, + "webhook-installation-repositories-removed": { + "title": "installation_repositories removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories_added": { + "$ref": "#/components/schemas/webhooks_repositories_added" + }, + "repositories_removed": { + "description": "An array of repository objects, which were removed from the installation.", + "type": "array", + "items": { + "type": "object", + "properties": { + "full_name": { + "type": "string" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private" + ] + } + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_selection": { + "$ref": "#/components/schemas/webhooks_repository_selection" + }, + "requester": { + "$ref": "#/components/schemas/webhooks_user" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "repository_selection", + "repositories_added", + "repositories_removed", + "requester", + "sender" + ] + }, + "webhook-installation-suspend": { + "title": "installation suspend event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "suspend" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories": { + "$ref": "#/components/schemas/webhooks_repositories" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requester": { + "nullable": true + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "sender" + ] + }, + "webhook-installation-target-renamed": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "archived_at": { + "type": "string", + "nullable": true + }, + "avatar_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "nullable": true + }, + "events_url": { + "type": "string" + }, + "followers": { + "type": "integer" + }, + "followers_url": { + "type": "string" + }, + "following": { + "type": "integer" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "hooks_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "is_verified": { + "type": "boolean" + }, + "issues_url": { + "type": "string" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "public_gists": { + "type": "integer" + }, + "public_members_url": { + "type": "string" + }, + "public_repos": { + "type": "integer" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "slug": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "website_url": { + "nullable": true + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "avatar_url", + "html_url" + ] + }, + "action": { + "type": "string", + "enum": [ + "renamed" + ] + }, + "changes": { + "type": "object", + "properties": { + "login": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "slug": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "target_type": { + "type": "string" + } + }, + "required": [ + "action", + "target_type", + "account", + "changes", + "installation" + ] + }, + "webhook-installation-unsuspend": { + "title": "installation unsuspend event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unsuspend" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repositories": { + "$ref": "#/components/schemas/webhooks_repositories" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requester": { + "nullable": true + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "installation", + "sender" + ] + }, + "webhook-issue-comment-created": { + "title": "issue_comment created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "comment": { + "title": "issue comment", + "description": "The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.", + "type": "object", + "properties": { + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue comment", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the issue comment", + "type": "integer", + "format": "int64" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "performed_via_github_app": { + "$ref": "#/components/schemas/nullable-integration" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue comment", + "type": "string", + "format": "uri" + }, + "pin": { + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "html_url", + "issue_url", + "id", + "node_id", + "user", + "created_at", + "updated_at", + "author_association", + "performed_via_github_app", + "body", + "reactions" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-comment-deleted": { + "title": "issue_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-comment-edited": { + "title": "issue_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "$ref": "#/components/schemas/webhooks_changes" + }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-comment-pinned": { + "title": "issue_comment pinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pinned" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-comment-unpinned": { + "title": "issue_comment unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_issue_comment" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "team_discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "labels", + "state", + "locked", + "assignee" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "comment", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-added": { + "title": "blocked by issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocked-by-removed": { + "title": "blocked by issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked_by_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocking_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-added": { + "title": "blocking issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_added" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issue-dependencies-blocking-removed": { + "title": "blocking issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocking_removed" + ] + }, + "blocked_issue_id": { + "description": "The ID of the blocked issue.", + "type": "number" + }, + "blocked_issue": { + "$ref": "#/components/schemas/issue" + }, + "blocked_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "blocking_issue_id": { + "description": "The ID of the blocking issue.", + "type": "number" + }, + "blocking_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "repository", + "sender" + ] + }, + "webhook-issues-assigned": { + "title": "issues assigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-closed": { + "title": "issues closed event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "allOf": [ + { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "reminder", + "pull_request_review_thread" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + { + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "assignee": { + "type": "object", + "nullable": true + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "author_association": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "labels_url": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "type": "object", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "type": "object", + "nullable": true + }, + "reactions": { + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string" + } + } + }, + "repository_url": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "closed", + "open" + ] + }, + "timeline_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "required": [ + "state", + "closed_at" + ] + } + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-deleted": { + "title": "issues deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-demilestoned": { + "title": "issues demilestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "demilestoned" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + } + } + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-edited": { + "title": "issues edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the issue.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-labeled": { + "title": "issues labeled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "labeled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-locked": { + "title": "issues locked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "locked" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "locked", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean", + "enum": [ + true + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder", + "security_and_analysis" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-milestoned": { + "title": "issues milestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "milestoned" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + } + } + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "milestone", + "repository", + "sender" + ] + }, + "webhook-issues-opened": { + "title": "issues opened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "opened" + ] + }, + "changes": { + "type": "object", + "properties": { + "old_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "nullable": true, + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "type": { + "$ref": "#/components/schemas/issue-type" + } + }, + "required": [ + "id", + "number" + ] + }, + "old_repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + } + }, + "required": [ + "old_issue", + "old_repository" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "security_and_analysis", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-pinned": { + "title": "issues pinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pinned" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue_2" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-reopened": { + "title": "issues reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "state", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run", + "pull_request_review_thread", + "reminder" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "type": { + "$ref": "#/components/schemas/issue-type" + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-transferred": { + "title": "issues transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "new_issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean" + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "repository_url", + "labels_url", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "number", + "title", + "user", + "assignees", + "milestone", + "comments", + "created_at", + "updated_at", + "closed_at", + "author_association", + "active_lock_reason", + "body", + "reactions" + ] + }, + "new_repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + } + }, + "required": [ + "new_issue", + "new_repository" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue_2" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-typed": { + "title": "issues typed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "typed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "type", + "repository", + "sender" + ] + }, + "webhook-issues-unassigned": { + "title": "issues unassigned event", + "type": "object", + "properties": { + "action": { + "description": "The action that was performed.", + "type": "string", + "enum": [ + "unassigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user_mannequin" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-unlabeled": { + "title": "issues unlabeled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlabeled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-unlocked": { + "title": "issues unlocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "title": "Issue", + "description": "The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.", + "type": "object", + "required": [ + "active_lock_reason", + "assignees", + "author_association", + "body", + "closed_at", + "comments", + "comments_url", + "created_at", + "events_url", + "html_url", + "id", + "labels_url", + "locked", + "milestone", + "node_id", + "number", + "reactions", + "repository_url", + "title", + "updated_at", + "url", + "user" + ], + "properties": { + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "Contents of the issue", + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "draft": { + "type": "boolean" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ], + "nullable": true, + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + } + } + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "locked": { + "type": "boolean", + "enum": [ + false + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ], + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "performed_via_github_app": { + "title": "App", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "nullable": true, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at" + ], + "properties": { + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "description": { + "type": "string", + "nullable": true + }, + "events": { + "description": "The list of events for the GitHub app", + "type": "array", + "items": { + "type": "string", + "enum": [ + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "content_reference", + "create", + "delete", + "deployment", + "deployment_review", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "milestone", + "organization", + "org_block", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "push", + "registry_package", + "release", + "repository", + "repository_dispatch", + "secret_scanning_alert", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_dispatch", + "workflow_run" + ] + } + }, + "external_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the GitHub app", + "type": "integer", + "nullable": true + }, + "name": { + "description": "The name of the GitHub app", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "actions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "checks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "content_references": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "contents": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "deployments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "discussions": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "emails": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "environments": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "issues": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "keys": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "members": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_administration": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_plan": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_self_hosted_runners": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "organization_user_blocking": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "packages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pages": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "pull_requests": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_hooks": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "repository_projects": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secret_scanning_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "secrets": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_events": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "security_scanning_alert": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "single_file": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "statuses": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "vulnerability_alerts": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, + "workflows": { + "type": "string", + "enum": [ + "read", + "write" + ] + } + } + }, + "slug": { + "description": "The slug name of the GitHub app", + "type": "string" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "diff_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "repository_url": { + "type": "string", + "format": "uri" + }, + "pinned_comment": { + "$ref": "#/components/schemas/nullable-issue-comment" + }, + "sub_issues_summary": { + "$ref": "#/components/schemas/sub-issues-summary" + }, + "issue_dependencies_summary": { + "$ref": "#/components/schemas/issue-dependencies-summary" + }, + "issue_field_values": { + "type": "array", + "items": { + "$ref": "#/components/schemas/issue-field-value" + } + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "state_reason": { + "type": "string", + "nullable": true + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "Title of the issue", + "type": "string" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the issue", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-unpinned": { + "title": "issues unpinned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpinned" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue_2" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "repository", + "sender" + ] + }, + "webhook-issues-untyped": { + "title": "issues untyped event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "untyped" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "issue": { + "$ref": "#/components/schemas/webhooks_issue" + }, + "type": { + "$ref": "#/components/schemas/issue-type" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "issue", + "type", + "repository", + "sender" + ] + }, + "webhook-label-created": { + "title": "label created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "label", + "repository" + ] + }, + "webhook-label-deleted": { + "title": "label deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "label", + "repository", + "sender" + ] + }, + "webhook-label-edited": { + "title": "label edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the label if the action was `edited`.", + "type": "object", + "properties": { + "color": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the color if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "description": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the description if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "label", + "repository", + "sender" + ] + }, + "webhook-marketplace-purchase-cancelled": { + "title": "marketplace_purchase cancelled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "effective_date": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_marketplace_purchase" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "previous_marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "effective_date", + "sender", + "marketplace_purchase" + ] + }, + "webhook-marketplace-purchase-changed": { + "title": "marketplace_purchase changed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "changed" + ] + }, + "effective_date": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_marketplace_purchase" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "on_free_trial": { + "type": "boolean", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "effective_date", + "sender", + "marketplace_purchase" + ] + }, + "webhook-marketplace-purchase-pending-change": { + "title": "marketplace_purchase pending_change event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pending_change" + ] + }, + "effective_date": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_marketplace_purchase" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "previous_marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ] + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "type": "string", + "nullable": true + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "yearly_price_in_cents": { + "type": "integer" + } + }, + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ] + }, + "unit_count": { + "type": "integer" + } + }, + "required": [ + "account", + "billing_cycle", + "unit_count", + "on_free_trial", + "free_trial_ends_on", + "plan" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "effective_date", + "sender", + "marketplace_purchase" + ] + }, + "webhook-marketplace-purchase-pending-change-cancelled": { + "title": "marketplace_purchase pending_change_cancelled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pending_change_cancelled" + ] + }, + "effective_date": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "marketplace_purchase": { + "title": "Marketplace Purchase", + "type": "object", + "required": [ + "account", + "billing_cycle", + "free_trial_ends_on", + "next_billing_date", + "on_free_trial", + "plan", + "unit_count" + ], + "properties": { + "account": { + "type": "object", + "required": [ + "type", + "id", + "node_id", + "login", + "organization_billing_email" + ], + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organization_billing_email": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string" + } + } + }, + "billing_cycle": { + "type": "string" + }, + "free_trial_ends_on": { + "nullable": true + }, + "next_billing_date": { + "type": "string", + "nullable": true + }, + "on_free_trial": { + "type": "boolean" + }, + "plan": { + "type": "object", + "required": [ + "id", + "name", + "description", + "monthly_price_in_cents", + "yearly_price_in_cents", + "price_model", + "has_free_trial", + "unit_name", + "bullets" + ], + "properties": { + "bullets": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string" + }, + "has_free_trial": { + "type": "boolean" + }, + "id": { + "type": "integer" + }, + "monthly_price_in_cents": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "price_model": { + "type": "string", + "enum": [ + "FREE", + "FLAT_RATE", + "PER_UNIT" + ] + }, + "unit_name": { + "type": "string", + "nullable": true + }, + "yearly_price_in_cents": { + "type": "integer" + } + } + }, + "unit_count": { + "type": "integer" + } + } + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "previous_marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "effective_date", + "sender", + "marketplace_purchase" + ] + }, + "webhook-marketplace-purchase-purchased": { + "title": "marketplace_purchase purchased event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "purchased" + ] + }, + "effective_date": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_marketplace_purchase" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "previous_marketplace_purchase": { + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "effective_date", + "sender", + "marketplace_purchase" + ] + }, + "webhook-member-added": { + "title": "member added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "added" + ] + }, + "changes": { + "type": "object", + "properties": { + "permission": { + "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.", + "type": "object", + "properties": { + "to": { + "type": "string", + "enum": [ + "write", + "admin", + "read" + ] + } + }, + "required": [ + "to" + ] + }, + "role_name": { + "description": "The role assigned to the collaborator.", + "type": "object", + "properties": { + "to": { + "type": "string" + } + }, + "required": [ + "to" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "member": { + "$ref": "#/components/schemas/webhooks_user" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "member", + "repository", + "sender" + ] + }, + "webhook-member-edited": { + "title": "member edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the collaborator permissions", + "type": "object", + "properties": { + "old_permission": { + "type": "object", + "properties": { + "from": { + "description": "The previous permissions of the collaborator if the action was edited.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "permission": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "member": { + "$ref": "#/components/schemas/webhooks_user" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "member", + "repository", + "sender" + ] + }, + "webhook-member-removed": { + "title": "member removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "member": { + "$ref": "#/components/schemas/webhooks_user" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "member", + "repository", + "sender" + ] + }, + "webhook-membership-added": { + "title": "membership added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "added" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "member": { + "$ref": "#/components/schemas/webhooks_user" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "scope": { + "description": "The scope of the membership. Currently, can only be `team`.", + "type": "string", + "enum": [ + "team" + ] + }, + "sender": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "team": { + "$ref": "#/components/schemas/webhooks_team" + } + }, + "required": [ + "action", + "scope", + "member", + "sender", + "team", + "organization" + ] + }, + "webhook-membership-removed": { + "title": "membership removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "member": { + "$ref": "#/components/schemas/webhooks_user" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "scope": { + "description": "The scope of the membership. Currently, can only be `team`.", + "type": "string", + "enum": [ + "team", + "organization" + ] + }, + "sender": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "team": { + "$ref": "#/components/schemas/webhooks_team" + } + }, + "required": [ + "action", + "scope", + "member", + "sender", + "team", + "organization" + ] + }, + "webhook-merge-group-checks-requested": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "checks_requested" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "merge_group": { + "$ref": "#/components/schemas/merge-group" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "merge_group" + ] + }, + "webhook-merge-group-destroyed": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "destroyed" + ] + }, + "reason": { + "type": "string", + "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" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "merge_group": { + "$ref": "#/components/schemas/merge-group" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "merge_group" + ] + }, + "webhook-meta-deleted": { + "title": "meta deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "hook": { + "description": "The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.", + "type": "object", + "properties": { + "active": { + "type": "boolean" + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "type": "string", + "enum": [ + "json", + "form" + ] + }, + "insecure_ssl": { + "type": "string" + }, + "secret": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "content_type", + "insecure_ssl", + "url" + ] + }, + "created_at": { + "type": "string" + }, + "events": { + "description": "", + "type": "array", + "items": { + "type": "string", + "enum": [ + "*", + "branch_protection_rule", + "check_run", + "check_suite", + "code_scanning_alert", + "commit_comment", + "create", + "delete", + "deployment", + "deployment_status", + "deploy_key", + "discussion", + "discussion_comment", + "fork", + "gollum", + "issues", + "issue_comment", + "label", + "member", + "membership", + "meta", + "milestone", + "organization", + "org_block", + "package", + "page_build", + "project", + "project_card", + "project_column", + "public", + "pull_request", + "pull_request_review", + "pull_request_review_comment", + "pull_request_review_thread", + "push", + "registry_package", + "release", + "repository", + "repository_import", + "repository_vulnerability_alert", + "secret_scanning_alert", + "secret_scanning_alert_location", + "security_and_analysis", + "star", + "status", + "team", + "team_add", + "watch", + "workflow_job", + "workflow_run", + "repository_dispatch", + "projects_v2_item" + ], + "minItems": 1 + } + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "type", + "id", + "name", + "active", + "events", + "config", + "updated_at", + "created_at" + ] + }, + "hook_id": { + "description": "The id of the modified webhook.", + "type": "integer" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/nullable-repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "hook_id", + "hook" + ] + }, + "webhook-milestone-closed": { + "title": "milestone closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "milestone", + "repository", + "sender" + ] + }, + "webhook-milestone-created": { + "title": "milestone created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone_3" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "milestone", + "repository", + "sender" + ] + }, + "webhook-milestone-deleted": { + "title": "milestone deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "milestone", + "repository", + "sender" + ] + }, + "webhook-milestone-edited": { + "title": "milestone edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the milestone if the action was `edited`.", + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the description if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "due_on": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the due date if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "milestone", + "repository", + "sender" + ] + }, + "webhook-milestone-opened": { + "title": "milestone opened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "opened" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "milestone": { + "$ref": "#/components/schemas/webhooks_milestone_3" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "milestone", + "repository", + "sender" + ] + }, + "webhook-org-block-blocked": { + "title": "org_block blocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "blocked" + ] + }, + "blocked_user": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "blocked_user", + "organization", + "sender" + ] + }, + "webhook-org-block-unblocked": { + "title": "org_block unblocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unblocked" + ] + }, + "blocked_user": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "blocked_user", + "organization", + "sender" + ] + }, + "webhook-organization-deleted": { + "title": "organization deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "membership": { + "$ref": "#/components/schemas/webhooks_membership" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "sender" + ] + }, + "webhook-organization-member-added": { + "title": "organization member_added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "member_added" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "membership": { + "$ref": "#/components/schemas/webhooks_membership" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "membership", + "organization", + "sender" + ] + }, + "webhook-organization-member-invited": { + "title": "organization member_invited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "member_invited" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "invitation": { + "description": "The invitation for the user or email if the action is `member_invited`.", + "type": "object", + "properties": { + "created_at": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true + }, + "failed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "failed_reason": { + "type": "string", + "nullable": true + }, + "id": { + "type": "number" + }, + "invitation_teams_url": { + "type": "string", + "format": "uri" + }, + "inviter": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "login": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "role": { + "type": "string" + }, + "team_count": { + "type": "number" + }, + "invitation_source": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "login", + "email", + "role", + "created_at", + "failed_at", + "failed_reason", + "inviter", + "team_count", + "invitation_teams_url" + ] + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "user": { + "$ref": "#/components/schemas/webhooks_user" + } + }, + "required": [ + "action", + "invitation", + "organization", + "sender" + ] + }, + "webhook-organization-member-removed": { + "title": "organization member_removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "member_removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "membership": { + "$ref": "#/components/schemas/webhooks_membership" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "membership", + "organization", + "sender" + ] + }, + "webhook-organization-renamed": { + "title": "organization renamed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "renamed" + ] + }, + "changes": { + "type": "object", + "properties": { + "login": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "membership": { + "$ref": "#/components/schemas/webhooks_membership" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "organization", + "sender" + ] + }, + "webhook-rubygems-metadata": { + "title": "Ruby Gems metadata", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "readme": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "version_info": { + "type": "object", + "properties": { + "version": { + "type": "string" + } + } + }, + "platform": { + "type": "string" + }, + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repo": { + "type": "string" + }, + "dependencies": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "commit_oid": { + "type": "string" + } + } + }, + "webhook-package-published": { + "title": "package published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "package": { + "description": "Information about the package.", + "type": "object", + "properties": { + "created_at": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": "object", + "nullable": true, + "properties": { + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "body_html": { + "type": "string" + }, + "container_metadata": { + "type": "object", + "nullable": true, + "properties": { + "labels": { + "type": "object", + "nullable": true + }, + "manifest": { + "type": "object", + "nullable": true + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": "object", + "nullable": true, + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "type": "object", + "nullable": true + }, + "bugs": { + "type": "object", + "nullable": true + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "type": "object", + "nullable": true + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "type": "object", + "nullable": true + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "object" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "object" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "type": "object", + "nullable": true + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "name": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "commit": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + ] + } + } + } + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "sha256": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhook-rubygems-metadata" + } + }, + "source_url": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "summary", + "name", + "description", + "html_url", + "metadata", + "package_files", + "installation_command" + ] + }, + "registry": { + "type": "object", + "nullable": true, + "properties": { + "about_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "vendor": { + "type": "string" + } + }, + "required": [ + "about_url", + "name", + "type", + "url", + "vendor" + ] + }, + "updated_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "package", + "sender" + ] + }, + "webhook-package-updated": { + "title": "package updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "package": { + "description": "Information about the package.", + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": "object", + "properties": { + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhook-rubygems-metadata" + } + }, + "source_url": { + "type": "string", + "format": "uri" + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "summary", + "name", + "description", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command" + ] + }, + "registry": { + "type": "object", + "nullable": true, + "properties": { + "about_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "vendor": { + "type": "string" + } + }, + "required": [ + "about_url", + "name", + "type", + "url", + "vendor" + ] + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "package", + "repository", + "sender" + ] + }, + "webhook-page-build": { + "title": "page_build event", + "type": "object", + "properties": { + "build": { + "description": "The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself.", + "type": "object", + "properties": { + "commit": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string" + }, + "duration": { + "type": "integer" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + } + }, + "required": [ + "message" + ] + }, + "pusher": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "status": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "status", + "error", + "pusher", + "commit", + "duration", + "created_at", + "updated_at" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "id": { + "type": "integer" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "id", + "build", + "repository", + "sender" + ] + }, + "webhook-personal-access-token-request-approved": { + "title": "personal_access_token_request approved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "approved" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender", + "installation" + ] + }, + "webhook-personal-access-token-request-cancelled": { + "title": "personal_access_token_request cancelled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender", + "installation" + ] + }, + "webhook-personal-access-token-request-created": { + "title": "personal_access_token_request created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender" + ] + }, + "webhook-personal-access-token-request-denied": { + "title": "personal_access_token_request denied event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "denied" + ] + }, + "personal_access_token_request": { + "$ref": "#/components/schemas/personal-access-token-request" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + } + }, + "required": [ + "action", + "personal_access_token_request", + "organization", + "sender", + "installation" + ] + }, + "webhook-ping": { + "type": "object", + "properties": { + "hook": { + "title": "Webhook", + "description": "The webhook that is being pinged", + "type": "object", + "properties": { + "active": { + "description": "Determines whether the hook is actually triggered for the events it subscribes to.", + "type": "boolean" + }, + "app_id": { + "description": "Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app.", + "type": "integer" + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "$ref": "#/components/schemas/webhook-config-content-type" + }, + "insecure_ssl": { + "$ref": "#/components/schemas/webhook-config-insecure-ssl" + }, + "secret": { + "$ref": "#/components/schemas/webhook-config-secret" + }, + "url": { + "$ref": "#/components/schemas/webhook-config-url" + } + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deliveries_url": { + "type": "string", + "format": "uri" + }, + "events": { + "description": "Determines what events the hook is triggered for. Default: ['push'].", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Unique identifier of the webhook.", + "type": "integer" + }, + "last_response": { + "$ref": "#/components/schemas/hook-response" + }, + "name": { + "description": "The type of webhook. The only valid value is 'web'.", + "type": "string", + "enum": [ + "web" + ] + }, + "ping_url": { + "type": "string", + "format": "uri" + }, + "test_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "type", + "name", + "active", + "events", + "config", + "created_at", + "updated_at" + ] + }, + "hook_id": { + "description": "The ID of the webhook that triggered the ping.", + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "zen": { + "description": "Random string of GitHub zen.", + "type": "string" + } + } + }, + "webhook-ping-form-encoded": { + "description": "The webhooks ping payload encoded with URL encoding.", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-project-card-converted": { + "title": "project_card converted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "converted" + ] + }, + "changes": { + "type": "object", + "properties": { + "note": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "note" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_card": { + "$ref": "#/components/schemas/webhooks_project_card" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "project_card", + "sender" + ] + }, + "webhook-project-card-created": { + "title": "project_card created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_card": { + "$ref": "#/components/schemas/webhooks_project_card" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project_card", + "sender" + ] + }, + "webhook-project-card-deleted": { + "title": "project_card deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_card": { + "title": "Project Card", + "type": "object", + "properties": { + "after_id": { + "type": "integer", + "nullable": true + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": "integer", + "nullable": true + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": "string", + "nullable": true + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + "repository": { + "$ref": "#/components/schemas/nullable-repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project_card", + "sender" + ] + }, + "webhook-project-card-edited": { + "title": "project_card edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "note": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "note" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_card": { + "$ref": "#/components/schemas/webhooks_project_card" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "project_card", + "sender" + ] + }, + "webhook-project-card-moved": { + "title": "project_card moved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "moved" + ] + }, + "changes": { + "type": "object", + "properties": { + "column_id": { + "type": "object", + "properties": { + "from": { + "type": "integer" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "column_id" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_card": { + "allOf": [ + { + "title": "Project Card", + "type": "object", + "properties": { + "after_id": { + "type": "integer", + "nullable": true + }, + "archived": { + "description": "Whether or not the card is archived", + "type": "boolean" + }, + "column_id": { + "type": "integer" + }, + "column_url": { + "type": "string", + "format": "uri" + }, + "content_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "id": { + "description": "The project card's ID", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": "string", + "nullable": true + }, + "project_url": { + "type": "string", + "format": "uri" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "project_url", + "column_url", + "column_id", + "id", + "node_id", + "note", + "archived", + "creator", + "created_at", + "updated_at" + ] + }, + { + "type": "object", + "properties": { + "after_id": { + "type": "number", + "nullable": true + }, + "archived": { + "type": "boolean" + }, + "column_id": { + "type": "integer" + }, + "column_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "creator": { + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": "string", + "nullable": true + }, + "project_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "after_id" + ] + } + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project_card", + "sender" + ] + }, + "webhook-project-closed": { + "title": "project closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project": { + "$ref": "#/components/schemas/webhooks_project" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project", + "sender" + ] + }, + "webhook-project-column-created": { + "title": "project_column created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_column": { + "$ref": "#/components/schemas/webhooks_project_column" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project_column" + ] + }, + "webhook-project-column-deleted": { + "title": "project_column deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_column": { + "$ref": "#/components/schemas/webhooks_project_column" + }, + "repository": { + "$ref": "#/components/schemas/nullable-repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project_column" + ] + }, + "webhook-project-column-edited": { + "title": "project_column edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_column": { + "$ref": "#/components/schemas/webhooks_project_column" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "project_column" + ] + }, + "webhook-project-column-moved": { + "title": "project_column moved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "moved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project_column": { + "$ref": "#/components/schemas/webhooks_project_column" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project_column", + "sender" + ] + }, + "webhook-project-created": { + "title": "project created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project": { + "$ref": "#/components/schemas/webhooks_project" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project", + "sender" + ] + }, + "webhook-project-deleted": { + "title": "project deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project": { + "$ref": "#/components/schemas/webhooks_project" + }, + "repository": { + "$ref": "#/components/schemas/nullable-repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project" + ] + }, + "webhook-project-edited": { + "title": "project edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the project if the action was `edited`.", + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The changes to the project if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project": { + "$ref": "#/components/schemas/webhooks_project" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project" + ] + }, + "webhook-project-reopened": { + "title": "project reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "project": { + "$ref": "#/components/schemas/webhooks_project" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "project", + "sender" + ] + }, + "webhook-projects-v2-project-closed": { + "title": "Projects v2 Project Closed Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2": { + "$ref": "#/components/schemas/projects-v2" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2", + "organization", + "sender" + ] + }, + "webhook-projects-v2-project-created": { + "description": "A project was created", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2": { + "$ref": "#/components/schemas/projects-v2" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2", + "organization", + "sender" + ] + }, + "webhook-projects-v2-project-deleted": { + "title": "Projects v2 Project Deleted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2": { + "$ref": "#/components/schemas/projects-v2" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2", + "organization", + "sender" + ] + }, + "webhook-projects-v2-project-edited": { + "title": "Projects v2 Project Edited Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + }, + "public": { + "type": "object", + "properties": { + "from": { + "type": "boolean" + }, + "to": { + "type": "boolean" + } + } + }, + "short_description": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + }, + "title": { + "type": "object", + "properties": { + "from": { + "type": "string" + }, + "to": { + "type": "string" + } + } + } + } + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2": { + "$ref": "#/components/schemas/projects-v2" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2", + "organization", + "sender", + "changes" + ] + }, + "webhook-projects-v2-item-archived": { + "title": "Projects v2 Item Archived Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "archived" + ] + }, + "changes": { + "$ref": "#/components/schemas/webhooks_project_changes" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + }, + "webhook-projects-v2-item-converted": { + "title": "Projects v2 Item Converted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "converted" + ] + }, + "changes": { + "type": "object", + "properties": { + "content_type": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string" + } + } + } + } + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + }, + "webhook-projects-v2-item-created": { + "title": "Projects v2 Item Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender" + ] + }, + "webhook-projects-v2-item-deleted": { + "title": "Projects v2 Item Deleted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender" + ] + }, + "webhook-projects-v2-item-edited": { + "title": "Projects v2 Item Edited Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.", + "oneOf": [ + { + "type": "object", + "properties": { + "field_value": { + "type": "object", + "properties": { + "field_node_id": { + "type": "string" + }, + "field_type": { + "type": "string" + }, + "field_name": { + "type": "string" + }, + "project_number": { + "type": "integer" + }, + "from": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] + }, + "to": { + "nullable": true, + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "$ref": "#/components/schemas/projects-v2-single-select-option" + }, + { + "$ref": "#/components/schemas/projects-v2-iteration-setting" + } + ] + } + } + } + }, + "required": [ + "field_value" + ] + }, + { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + } + }, + "required": [ + "body" + ] + } + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender" + ] + }, + "webhook-projects-v2-item-reordered": { + "title": "Projects v2 Item Reordered Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reordered" + ] + }, + "changes": { + "type": "object", + "properties": { + "previous_projects_v2_item_node_id": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + } + } + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + }, + "webhook-projects-v2-item-restored": { + "title": "Projects v2 Item Restored Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "restored" + ] + }, + "changes": { + "$ref": "#/components/schemas/webhooks_project_changes" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_item": { + "$ref": "#/components/schemas/projects-v2-item" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_item", + "organization", + "sender", + "changes" + ] + }, + "webhook-projects-v2-project-reopened": { + "title": "Projects v2 Project Reopened Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2": { + "$ref": "#/components/schemas/projects-v2" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-created": { + "title": "Projects v2 Status Update Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-deleted": { + "title": "Projects v2 Status Update Deleted Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-projects-v2-status-update-edited": { + "title": "Projects v2 Status Update Edited Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + }, + "to": { + "type": "string", + "nullable": true + } + } + }, + "status": { + "type": "object", + "properties": { + "from": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + }, + "to": { + "type": "string", + "enum": [ + "INACTIVE", + "ON_TRACK", + "AT_RISK", + "OFF_TRACK", + "COMPLETE" + ], + "nullable": true + } + } + }, + "start_date": { + "type": "object", + "properties": { + "from": { + "type": "string", + "format": "date", + "nullable": true + }, + "to": { + "type": "string", + "format": "date", + "nullable": true + } + } + }, + "target_date": { + "type": "object", + "properties": { + "from": { + "type": "string", + "format": "date", + "nullable": true + }, + "to": { + "type": "string", + "format": "date", + "nullable": true + } + } + } + } + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "projects_v2_status_update": { + "$ref": "#/components/schemas/projects-v2-status-update" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "projects_v2_status_update", + "organization", + "sender" + ] + }, + "webhook-public": { + "title": "public event", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "repository", + "sender" + ] + }, + "webhook-pull-request-assigned": { + "title": "pull_request assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "assignee", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-auto-merge-disabled": { + "title": "pull_request auto_merge_disabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_merge_disabled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "reason": { + "type": "string" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "reason", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-auto-merge-enabled": { + "title": "pull_request auto_merge_enabled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "auto_merge_enabled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "reason": { + "type": "string" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-closed": { + "title": "pull_request closed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "closed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-webhook" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-converted-to-draft": { + "title": "pull_request converted_to_draft event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "converted_to_draft" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-webhook" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-demilestoned": { + "title": "pull_request demilestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "demilestoned" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "milestone": { + "$ref": "#/components/schemas/milestone" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/webhooks_pull_request_5" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository" + ] + }, + "webhook-pull-request-dequeued": { + "title": "pull_request dequeued event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "dequeued" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "reason": { + "type": "string", + "enum": [ + "UNKNOWN_REMOVAL_REASON", + "MANUAL", + "MERGE", + "MERGE_CONFLICT", + "CI_FAILURE", + "CI_TIMEOUT", + "ALREADY_MERGED", + "QUEUE_CLEARED", + "ROLL_BACK", + "BRANCH_PROTECTIONS", + "GIT_TREE_INVALID", + "INVALID_MERGE_COMMIT" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender", + "reason" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-edited": { + "title": "pull_request edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the comment if the action was `edited`.", + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "sha": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "ref", + "sha" + ] + }, + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "title": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the title if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-webhook" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "number", + "pull_request", + "repository" + ] + }, + "webhook-pull-request-enqueued": { + "title": "pull_request enqueued event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "enqueued" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_discussions", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-labeled": { + "title": "pull_request labeled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "labeled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-locked": { + "title": "pull_request locked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "locked" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-milestoned": { + "title": "pull_request milestoned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "milestoned" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "milestone": { + "$ref": "#/components/schemas/milestone" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/webhooks_pull_request_5" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository" + ] + }, + "webhook-pull-request-opened": { + "title": "pull_request opened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "opened" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-webhook" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-ready-for-review": { + "title": "pull_request ready_for_review event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "ready_for_review" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-webhook" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-reopened": { + "title": "pull_request reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-webhook" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + "webhook-pull-request-review-comment-created": { + "title": "pull_request_review_comment created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "comment": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": "integer", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "comment", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-comment-deleted": { + "title": "pull_request_review_comment deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "comment": { + "$ref": "#/components/schemas/webhooks_review_comment" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "comment", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-comment-edited": { + "title": "pull_request_review_comment edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "$ref": "#/components/schemas/webhooks_changes" + }, + "comment": { + "$ref": "#/components/schemas/webhooks_review_comment" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "user_view_type": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "comment", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-dismissed": { + "title": "pull_request_review dismissed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "dismissed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "description": "The review that was affected.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the review.", + "type": "string", + "nullable": true + }, + "commit_id": { + "description": "A commit SHA for the review.", + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the review", + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "dismissed", + "approved", + "changes_requested" + ] + }, + "submitted_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "id", + "node_id", + "user", + "body", + "commit_id", + "submitted_at", + "state", + "html_url", + "pull_request_url", + "author_association", + "_links" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-edited": { + "title": "pull_request_review edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "review", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-request-removed": { + "title": "pull_request review_request_removed event", + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "review_request_removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title.", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requested_reviewer": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "requested_reviewer", + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "review_request_removed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "requested_team", + "action", + "number", + "pull_request", + "repository", + "sender" + ] + } + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/required/17" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-requested": { + "title": "pull_request review_requested event", + "oneOf": [ + { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "review_requested" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requested_reviewer": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "requested_reviewer", + "action", + "number", + "pull_request", + "repository", + "sender" + ] + }, + { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "review_requested" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "description": "The pull request number.", + "type": "integer" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "requested_team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "requested_team", + "action", + "number", + "pull_request", + "repository", + "sender" + ] + } + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/oneOf/0/properties/pull_request/required/17" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/oneOf/1/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-submitted": { + "title": "pull_request_review submitted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "submitted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "review": { + "$ref": "#/components/schemas/webhooks_review" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "review", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-thread-resolved": { + "title": "pull_request_review_thread resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": "integer", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "action", + "thread", + "pull_request", + "repository" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-review-thread-unresolved": { + "title": "pull_request_review_thread unresolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unresolved" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Simple Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string" + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "closed_at": { + "type": "string", + "nullable": true + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "draft", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "thread": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "title": "Pull Request Review Comment", + "description": "The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "commit_id": { + "description": "The SHA of the commit to which the comment applies.", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "diff_hunk": { + "description": "The diff of the line that the comment refers to.", + "type": "string" + }, + "html_url": { + "description": "HTML URL for the pull request review comment.", + "type": "string", + "format": "uri" + }, + "id": { + "description": "The ID of the pull request review comment.", + "type": "integer" + }, + "in_reply_to_id": { + "description": "The comment ID to reply to.", + "type": "integer" + }, + "line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer", + "nullable": true + }, + "node_id": { + "description": "The node ID of the pull request review comment.", + "type": "string" + }, + "original_commit_id": { + "description": "The SHA of the original commit to which the comment applies.", + "type": "string" + }, + "original_line": { + "description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment", + "type": "integer" + }, + "original_position": { + "description": "The index of the original line in the diff to which the comment applies.", + "type": "integer" + }, + "original_start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "path": { + "description": "The relative path of the file to which the comment applies.", + "type": "string" + }, + "position": { + "description": "The line index in the diff to which the comment applies.", + "type": "integer", + "nullable": true + }, + "pull_request_review_id": { + "description": "The ID of the pull request review to which the comment belongs.", + "type": "integer", + "nullable": true + }, + "pull_request_url": { + "description": "URL for the pull request that the review comment belongs to.", + "type": "string", + "format": "uri" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + }, + "side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "enum": [ + "LEFT", + "RIGHT" + ] + }, + "start_line": { + "description": "The first line of the range for a multi-line comment.", + "type": "integer", + "nullable": true + }, + "start_side": { + "description": "The side of the first line of the range for a multi-line comment.", + "type": "string", + "nullable": true, + "enum": [ + "LEFT", + "RIGHT", + null + ], + "default": "RIGHT" + }, + "subject_type": { + "description": "The level at which the comment is targeted, can be a diff line or a file.", + "type": "string", + "enum": [ + "line", + "file" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "description": "URL for the pull request review comment", + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "author_association", + "_links", + "start_line", + "original_start_line", + "original_line", + "line", + "start_side", + "side", + "reactions" + ] + } + }, + "node_id": { + "type": "string" + } + }, + "required": [ + "node_id", + "comments" + ] + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + } + }, + "required": [ + "action", + "thread", + "pull_request", + "repository" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-synchronize": { + "title": "pull_request synchronize event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "synchronize" + ] + }, + "after": { + "type": "string" + }, + "before": { + "type": "string" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit message title.", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "before", + "after", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-unassigned": { + "title": "pull_request unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "assignee": { + "$ref": "#/components/schemas/webhooks_user_mannequin" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-unlabeled": { + "title": "pull_request unlabeled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlabeled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "label": { + "$ref": "#/components/schemas/webhooks_label" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string", + "nullable": true + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string", + "nullable": true + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit message title.", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization", + "Mannequin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-pull-request-unlocked": { + "title": "pull_request unlocked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unlocked" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "number": { + "$ref": "#/components/schemas/webhooks_number" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pull_request": { + "title": "Pull Request", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "commits": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "issue": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comment": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "review_comments": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "statuses": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "issue", + "comments", + "review_comments", + "review_comment", + "commits", + "statuses" + ] + }, + "active_lock_reason": { + "type": "string", + "nullable": true, + "enum": [ + "resolved", + "off-topic", + "too heated", + "spam", + null + ] + }, + "additions": { + "type": "integer" + }, + "assignee": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "assignees": { + "type": "array", + "items": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "author_association": { + "title": "AuthorAssociation", + "description": "How the author is associated with the repository.", + "type": "string", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "auto_merge": { + "title": "PullRequestAutoMerge", + "description": "The status of auto merging a pull request.", + "type": "object", + "nullable": true, + "properties": { + "commit_message": { + "description": "Commit message for the merge commit.", + "type": "string", + "nullable": true + }, + "commit_title": { + "description": "Title for the merge commit message.", + "type": "string" + }, + "enabled_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "merge_method": { + "description": "The merge method to use.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "required": [ + "enabled_by", + "merge_method", + "commit_title", + "commit_message" + ] + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "body": { + "type": "string", + "nullable": true + }, + "changed_files": { + "type": "integer" + }, + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "comments": { + "type": "integer" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commits": { + "type": "integer" + }, + "commits_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "deletions": { + "type": "integer" + }, + "diff_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Indicates whether or not the pull request is a draft.", + "type": "boolean" + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "repo": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "nullable": true, + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merge_commit_message": { + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ] + }, + "merge_commit_title": { + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ] + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "squash_merge_commit_message": { + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ] + }, + "squash_merge_commit_title": { + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "use_squash_pr_title_as_default": { + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "type": "boolean", + "default": false + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sha": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "label", + "ref", + "sha", + "user", + "repo" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issue_url": { + "type": "string", + "format": "uri" + }, + "labels": { + "type": "array", + "items": { + "title": "Label", + "type": "object", + "properties": { + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "type": "string" + }, + "default": { + "type": "boolean" + }, + "description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "name": { + "description": "The name of the label.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the label", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "color", + "default", + "description" + ] + } + }, + "locked": { + "type": "boolean" + }, + "maintainer_can_modify": { + "description": "Indicates whether maintainers can modify the pull request.", + "type": "boolean" + }, + "merge_commit_sha": { + "type": "string", + "nullable": true + }, + "mergeable": { + "type": "boolean", + "nullable": true + }, + "mergeable_state": { + "type": "string" + }, + "merged": { + "type": "boolean", + "nullable": true + }, + "merged_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "merged_by": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "nullable": true, + "properties": { + "closed_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "closed_issues": { + "type": "integer" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "creator": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "description": { + "type": "string", + "nullable": true + }, + "due_on": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "labels_url", + "id", + "node_id", + "number", + "title", + "description", + "creator", + "open_issues", + "closed_issues", + "state", + "created_at", + "updated_at", + "due_on", + "closed_at" + ] + }, + "node_id": { + "type": "string" + }, + "number": { + "description": "Number uniquely identifying the pull request within its repository.", + "type": "integer" + }, + "patch_url": { + "type": "string", + "format": "uri" + }, + "rebaseable": { + "type": "boolean", + "nullable": true + }, + "requested_reviewers": { + "type": "array", + "items": { + "oneOf": [ + { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "deleted": { + "type": "boolean" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "parent": { + "type": "object", + "nullable": true, + "properties": { + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the team", + "type": "integer" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "Name of the team", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id", + "node_id", + "slug", + "description", + "privacy", + "url", + "html_url", + "members_url", + "repositories_url", + "permission" + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string" + }, + "privacy": { + "type": "string", + "enum": [ + "open", + "closed", + "secret" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "slug": { + "type": "string" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri" + } + }, + "required": [ + "name", + "id" + ] + } + }, + "review_comment_url": { + "type": "string", + "format": "uri-template" + }, + "review_comments": { + "type": "integer" + }, + "review_comments_url": { + "type": "string", + "format": "uri" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "statuses_url": { + "type": "string", + "format": "uri" + }, + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "url", + "id", + "node_id", + "html_url", + "diff_url", + "patch_url", + "issue_url", + "number", + "state", + "locked", + "title", + "user", + "body", + "created_at", + "updated_at", + "closed_at", + "merged_at", + "merge_commit_sha", + "assignee", + "assignees", + "requested_reviewers", + "requested_teams", + "labels", + "milestone", + "commits_url", + "review_comments_url", + "review_comment_url", + "comments_url", + "statuses_url", + "head", + "base", + "_links", + "author_association", + "auto_merge", + "active_lock_reason", + "draft" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "number", + "pull_request", + "repository", + "sender" + ], + "x-github-breaking-changes": [ + { + "changeset": "remove_use_squash_pr_title_as_default", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" + }, + { + "op": "remove", + "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_pull_request_merge_commit_sha", + "patch": [ + { + "op": "remove", + "path": "/properties/pull_request/properties/merge_commit_sha" + }, + { + "op": "remove", + "path": "/properties/pull_request/required/17" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-push": { + "title": "push event", + "type": "object", + "properties": { + "after": { + "description": "The SHA of the most recent commit on `ref` after the push.", + "type": "string" + }, + "base_ref": { + "$ref": "#/components/schemas/webhooks_nullable_string" + }, + "before": { + "description": "The SHA of the most recent commit on `ref` before the push.", + "type": "string" + }, + "commits": { + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", + "type": "array", + "items": { + "title": "Commit", + "type": "object", + "properties": { + "added": { + "description": "An array of files added in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + } + }, + "compare": { + "description": "URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit.", + "type": "string" + }, + "created": { + "description": "Whether this push created the `ref`.", + "type": "boolean" + }, + "deleted": { + "description": "Whether this push deleted the `ref`.", + "type": "boolean" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "forced": { + "description": "Whether this push was a force push of the `ref`.", + "type": "boolean" + }, + "head_commit": { + "title": "Commit", + "type": "object", + "nullable": true, + "properties": { + "added": { + "description": "An array of files added in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "distinct": { + "description": "Whether this commit is distinct from any that have been pushed before.", + "type": "boolean" + }, + "id": { + "type": "string" + }, + "message": { + "description": "The commit message.", + "type": "string" + }, + "modified": { + "description": "An array of files modified by the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "removed": { + "description": "An array of files removed in the commit.", + "type": "array", + "items": { + "type": "string" + } + }, + "timestamp": { + "description": "The ISO 8601 timestamp of the commit.", + "type": "string", + "format": "date-time" + }, + "tree_id": { + "type": "string" + }, + "url": { + "description": "URL that points to the commit API resource.", + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "tree_id", + "distinct", + "message", + "timestamp", + "url", + "author", + "committer" + ] + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "pusher": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ref": { + "description": "The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`.", + "type": "string" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "type": "boolean", + "default": false + }, + "has_pull_requests": { + "description": "Whether pull requests are enabled.", + "type": "boolean", + "default": true + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "has_discussions", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "ref", + "before", + "after", + "created", + "deleted", + "forced", + "base_ref", + "compare", + "commits", + "head_commit", + "repository", + "pusher" + ] + }, + "webhook-registry-package-published": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "registry_package": { + "type": "object", + "properties": { + "created_at": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": "object", + "nullable": true, + "properties": { + "author": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "body_html": { + "type": "string" + }, + "container_metadata": { + "type": "object", + "properties": { + "labels": { + "type": "object", + "nullable": true + }, + "manifest": { + "type": "object", + "nullable": true + }, + "tag": { + "type": "object", + "properties": { + "digest": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "npm_metadata": { + "type": "object", + "nullable": true, + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + }, + "npm_user": { + "type": "string" + }, + "author": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "bugs": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "dependencies": { + "type": "object" + }, + "dev_dependencies": { + "type": "object" + }, + "peer_dependencies": { + "type": "object" + }, + "optional_dependencies": { + "type": "object" + }, + "description": { + "type": "string" + }, + "dist": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "git_head": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "license": { + "type": "string" + }, + "main": { + "type": "string" + }, + "repository": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "scripts": { + "type": "object" + }, + "id": { + "type": "string" + }, + "node_version": { + "type": "string" + }, + "npm_version": { + "type": "string" + }, + "has_shrinkwrap": { + "type": "boolean" + }, + "maintainers": { + "type": "array", + "items": { + "type": "string" + } + }, + "contributors": { + "type": "array", + "items": { + "type": "string" + } + }, + "engines": { + "type": "object" + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "items": { + "type": "string" + } + }, + "bin": { + "type": "object" + }, + "man": { + "type": "object" + }, + "directories": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], + "nullable": true + }, + "os": { + "type": "array", + "items": { + "type": "string" + } + }, + "cpu": { + "type": "array", + "items": { + "type": "string" + } + }, + "readme": { + "type": "string" + }, + "installation_command": { + "type": "string" + }, + "release_id": { + "type": "integer" + }, + "commit_oid": { + "type": "string" + }, + "published_via_actions": { + "type": "boolean" + }, + "deleted_by_id": { + "type": "integer" + } + } + }, + "nuget_metadata": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "integer" + } + ], + "nullable": true + }, + "name": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "branch": { + "type": "string" + }, + "commit": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + ] + } + } + } + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "sha256": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "download_url", + "id", + "name", + "sha256", + "sha1", + "md5", + "content_type", + "state", + "size", + "created_at", + "updated_at" + ] + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + } + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string", + "nullable": true + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "rubygems_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhook-rubygems-metadata" + } + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "name", + "description", + "summary", + "html_url", + "metadata", + "package_files", + "installation_command", + "package_url" + ] + }, + "registry": { + "type": "object", + "nullable": true, + "properties": { + "about_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "vendor": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "registry_package", + "sender" + ] + }, + "webhook-registry-package-updated": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "registry_package": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "description": { + "nullable": true + }, + "ecosystem": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "package_type": { + "type": "string" + }, + "package_version": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "docker_metadata": { + "type": "array", + "items": { + "type": "object", + "nullable": true, + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "installation_command": { + "type": "string" + }, + "manifest": { + "type": "string" + }, + "metadata": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + }, + "name": { + "type": "string" + }, + "package_files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "md5": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "sha1": { + "type": "string", + "nullable": true + }, + "sha256": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "package_url": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "release": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "avatar_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + }, + "created_at": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "prerelease": { + "type": "boolean" + }, + "published_at": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "url", + "html_url", + "id", + "tag_name", + "target_commitish", + "name", + "draft", + "author", + "prerelease", + "created_at", + "published_at" + ] + }, + "rubygems_metadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhook-rubygems-metadata" + } + }, + "summary": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "target_oid": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "id", + "version", + "name", + "description", + "summary", + "body", + "body_html", + "html_url", + "target_commitish", + "target_oid", + "created_at", + "updated_at", + "metadata", + "package_files", + "author", + "installation_command", + "package_url" + ] + }, + "registry": { + "type": "object", + "nullable": true + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "namespace", + "description", + "ecosystem", + "package_type", + "html_url", + "created_at", + "updated_at", + "owner", + "package_version", + "registry" + ] + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "registry_package", + "sender" + ] + }, + "webhook-release-created": { + "title": "release created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "$ref": "#/components/schemas/webhooks_release" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "release", + "repository", + "sender" + ] + }, + "webhook-release-deleted": { + "title": "release deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "$ref": "#/components/schemas/webhooks_release" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "release", + "repository", + "sender" + ] + }, + "webhook-release-edited": { + "title": "release edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "body": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the body if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "tag_name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the tag_name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "make_latest": { + "type": "object", + "properties": { + "to": { + "description": "Whether this release was explicitly `edited` to be the latest.", + "type": "boolean" + } + }, + "required": [ + "to" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "$ref": "#/components/schemas/webhooks_release" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "release", + "repository" + ] + }, + "webhook-release-prereleased": { + "title": "release prereleased event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "prereleased" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "title": "Release", + "description": "The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.", + "type": "object", + "required": [ + "assets", + "assets_url", + "author", + "body", + "created_at", + "draft", + "html_url", + "id", + "immutable", + "name", + "node_id", + "prerelease", + "published_at", + "tag_name", + "tarball_url", + "target_commitish", + "updated_at", + "upload_url", + "url", + "zipball_url" + ], + "properties": { + "assets": { + "type": "array", + "items": { + "title": "Release Asset", + "description": "Data related to a release.", + "type": "object", + "required": [ + "url", + "browser_download_url", + "id", + "node_id", + "name", + "label", + "state", + "digest", + "content_type", + "size", + "download_count", + "created_at", + "updated_at" + ], + "nullable": true, + "properties": { + "browser_download_url": { + "type": "string", + "format": "uri" + }, + "content_type": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "download_count": { + "type": "integer" + }, + "id": { + "type": "integer" + }, + "label": { + "type": "string", + "nullable": true + }, + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "digest": { + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the release asset.", + "type": "string", + "enum": [ + "uploaded" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "uploader": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "assets_url": { + "type": "string", + "format": "uri" + }, + "author": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string", + "nullable": true + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "discussion_url": { + "type": "string", + "format": "uri" + }, + "draft": { + "description": "Whether the release is a draft or published", + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "immutable": { + "description": "Whether or not the release is immutable.", + "type": "boolean" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "prerelease": { + "description": "Whether the release is identified as a prerelease or a full release.", + "type": "boolean", + "enum": [ + true + ] + }, + "published_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ], + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "tarball_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "target_commitish": { + "description": "Specifies the commitish value that determines where the Git tag is created from.", + "type": "string" + }, + "upload_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "zipball_url": { + "type": "string", + "nullable": true, + "format": "uri" + } + } + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "release", + "repository" + ] + }, + "webhook-release-published": { + "title": "release published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "$ref": "#/components/schemas/webhooks_release_1" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "release", + "repository" + ] + }, + "webhook-release-released": { + "title": "release released event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "released" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "$ref": "#/components/schemas/webhooks_release" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "release", + "repository" + ] + }, + "webhook-release-unpublished": { + "title": "release unpublished event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unpublished" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "release": { + "$ref": "#/components/schemas/webhooks_release_1" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "release", + "repository" + ] + }, + "webhook-repository-advisory-published": { + "title": "Repository advisory published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_advisory": { + "$ref": "#/components/schemas/repository-advisory" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "repository_advisory" + ] + }, + "webhook-repository-advisory-reported": { + "title": "Repository advisory reported event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reported" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_advisory": { + "$ref": "#/components/schemas/repository-advisory" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "repository_advisory" + ] + }, + "webhook-repository-archived": { + "title": "repository archived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "archived" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-repository-created": { + "title": "repository created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-repository-deleted": { + "title": "repository deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-repository-dispatch-sample": { + "title": "repository_dispatch event", + "type": "object", + "properties": { + "action": { + "type": "string", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, + "branch": { + "type": "string" + }, + "client_payload": { + "type": "object", + "nullable": true, + "additionalProperties": true, + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "branch", + "client_payload", + "repository", + "sender", + "installation" + ] + }, + "webhook-repository-edited": { + "title": "repository edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "default_branch": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "description": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "homepage": { + "type": "object", + "properties": { + "from": { + "type": "string", + "nullable": true + } + }, + "required": [ + "from" + ] + }, + "topics": { + "type": "object", + "properties": { + "from": { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + } + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + }, + "webhook-repository-import": { + "title": "repository_import event", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "status": { + "type": "string", + "enum": [ + "success", + "cancelled", + "failure" + ] + } + }, + "required": [ + "status", + "repository", + "sender" + ] + }, + "webhook-repository-privatized": { + "title": "repository privatized event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "privatized" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-repository-publicized": { + "title": "repository publicized event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "publicized" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-repository-renamed": { + "title": "repository renamed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "renamed" + ] + }, + "changes": { + "type": "object", + "properties": { + "repository": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "repository" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + }, + "webhook-repository-ruleset-created": { + "title": "repository ruleset created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-ruleset-deleted": { + "title": "repository ruleset deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-ruleset-edited": { + "title": "repository ruleset edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "repository_ruleset": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "changes": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "enforcement": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "conditions": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + }, + "deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "condition": { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + "changes": { + "type": "object", + "properties": { + "condition_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "target": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "include": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "exclude": { + "type": "object", + "properties": { + "from": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "rules": { + "type": "object", + "properties": { + "added": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "deleted": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "$ref": "#/components/schemas/repository-rule" + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository_ruleset", + "sender" + ] + }, + "webhook-repository-transferred": { + "title": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "changes", + "repository", + "sender" + ] + }, + "webhook-repository-unarchived": { + "title": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-create": { + "title": "repository_vulnerability_alert create event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "create" + ] + }, + "alert": { + "$ref": "#/components/schemas/webhooks_alert" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-dismiss": { + "title": "repository_vulnerability_alert dismiss event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "dismiss" + ] + }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": "string", + "nullable": true + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-reopen": { + "title": "repository_vulnerability_alert reopen event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopen" + ] + }, + "alert": { + "$ref": "#/components/schemas/webhooks_alert" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-repository-vulnerability-alert-resolve": { + "title": "repository_vulnerability_alert resolve event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolve" + ] + }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "fixed", + "open" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-created": { + "title": "secret_scanning_alert created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-location-created": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "location": { + "$ref": "#/components/schemas/secret-scanning-location" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "location", + "alert", + "repository", + "sender" + ] + }, + "webhook-secret-scanning-alert-location-created-form-encoded": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" + ] + }, + "webhook-secret-scanning-alert-publicly-leaked": { + "title": "secret_scanning_alert publicly leaked event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "publicly_leaked" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-reopened": { + "title": "secret_scanning_alert reopened event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "reopened" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-resolved": { + "title": "secret_scanning_alert resolved event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "resolved" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-alert-validated": { + "title": "secret_scanning_alert validated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "validated" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, + "webhook-secret-scanning-scan-completed": { + "title": "secret_scanning_scan completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "type": { + "type": "string", + "description": "What type of scan was completed", + "enum": [ + "backfill", + "custom-pattern-backfill", + "pattern-version-backfill" + ] + }, + "source": { + "type": "string", + "description": "What type of content was scanned", + "enum": [ + "git", + "issues", + "pull-requests", + "discussions", + "wiki" + ] + }, + "started_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "secret_types": { + "type": "array", + "description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates", + "items": { + "type": "string" + }, + "nullable": true + }, + "custom_pattern_name": { + "type": "string", + "description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated", + "nullable": true + }, + "custom_pattern_scope": { + "type": "string", + "description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated", + "enum": [ + "repository", + "organization", + "enterprise" + ], + "nullable": true + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "source", + "type", + "started_at", + "completed_at" + ] + }, + "webhook-security-advisory-published": { + "title": "security_advisory published event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "published" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "security_advisory": { + "$ref": "#/components/schemas/webhooks_security_advisory" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "security_advisory" + ] + }, + "webhook-security-advisory-updated": { + "title": "security_advisory updated event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "updated" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "security_advisory": { + "$ref": "#/components/schemas/webhooks_security_advisory" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "security_advisory" + ] + }, + "webhook-security-advisory-withdrawn": { + "title": "security_advisory withdrawn event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "withdrawn" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "security_advisory": { + "description": "The details of the security advisory, including summary, description, and severity.", + "type": "object", + "properties": { + "cvss": { + "type": "object", + "properties": { + "score": { + "type": "number" + }, + "vector_string": { + "type": "string", + "nullable": true + } + }, + "required": [ + "vector_string", + "score" + ] + }, + "cvss_severities": { + "$ref": "#/components/schemas/cvss-severities" + }, + "cwes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cwe_id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "cwe_id", + "name" + ] + } + }, + "description": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "identifiers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "value", + "type" + ] + } + }, + "published_at": { + "type": "string" + }, + "references": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url" + ] + } + }, + "severity": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "vulnerabilities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "first_patched_version": { + "type": "object", + "nullable": true, + "properties": { + "identifier": { + "type": "string" + } + }, + "required": [ + "identifier" + ] + }, + "package": { + "type": "object", + "properties": { + "ecosystem": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "ecosystem", + "name" + ] + }, + "severity": { + "type": "string" + }, + "vulnerable_version_range": { + "type": "string" + } + }, + "required": [ + "package", + "severity", + "vulnerable_version_range", + "first_patched_version" + ] + } + }, + "withdrawn_at": { + "type": "string" + } + }, + "required": [ + "cvss", + "cwes", + "ghsa_id", + "summary", + "description", + "severity", + "identifiers", + "references", + "published_at", + "updated_at", + "withdrawn_at", + "vulnerabilities" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "security_advisory" + ], + "x-github-breaking-changes": [ + { + "changeset": "deprecate_cvss", + "patch": [ + { + "op": "remove", + "path": "/properties/security_advisory/properties/cvss" + }, + { + "op": "remove", + "path": "/properties/security_advisory/required/0" + } + ], + "version": "2026-03-10" + } + ] + }, + "webhook-security-and-analysis": { + "title": "security_and_analysis event", + "type": "object", + "properties": { + "changes": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + } + } + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/full-repository" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "changes", + "repository" + ] + }, + "webhook-sponsorship-cancelled": { + "title": "sponsorship cancelled event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "cancelled" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sponsorship": { + "$ref": "#/components/schemas/webhooks_sponsorship" + } + }, + "required": [ + "action", + "sponsorship", + "sender" + ] + }, + "webhook-sponsorship-created": { + "title": "sponsorship created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sponsorship": { + "$ref": "#/components/schemas/webhooks_sponsorship" + } + }, + "required": [ + "action", + "sponsorship", + "sender" + ] + }, + "webhook-sponsorship-edited": { + "title": "sponsorship edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "type": "object", + "properties": { + "privacy_level": { + "type": "object", + "properties": { + "from": { + "description": "The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy.", + "type": "string" + } + }, + "required": [ + "from" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sponsorship": { + "$ref": "#/components/schemas/webhooks_sponsorship" + } + }, + "required": [ + "action", + "changes", + "sponsorship", + "sender" + ] + }, + "webhook-sponsorship-pending-cancellation": { + "title": "sponsorship pending_cancellation event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pending_cancellation" + ] + }, + "effective_date": { + "$ref": "#/components/schemas/webhooks_effective_date" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sponsorship": { + "$ref": "#/components/schemas/webhooks_sponsorship" + } + }, + "required": [ + "action", + "sponsorship", + "sender" + ] + }, + "webhook-sponsorship-pending-tier-change": { + "title": "sponsorship pending_tier_change event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "pending_tier_change" + ] + }, + "changes": { + "$ref": "#/components/schemas/webhooks_changes_8" + }, + "effective_date": { + "$ref": "#/components/schemas/webhooks_effective_date" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sponsorship": { + "$ref": "#/components/schemas/webhooks_sponsorship" + } + }, + "required": [ + "action", + "changes", + "sponsorship", + "sender" + ] + }, + "webhook-sponsorship-tier-changed": { + "title": "sponsorship tier_changed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "tier_changed" + ] + }, + "changes": { + "$ref": "#/components/schemas/webhooks_changes_8" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sponsorship": { + "$ref": "#/components/schemas/webhooks_sponsorship" + } + }, + "required": [ + "action", + "changes", + "sponsorship", + "sender" + ] + }, + "webhook-star-created": { + "title": "star created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "starred_at": { + "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", + "type": "string", + "nullable": true + } + }, + "required": [ + "action", + "starred_at", + "repository", + "sender" + ] + }, + "webhook-star-deleted": { + "title": "star deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "starred_at": { + "description": "The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action.", + "nullable": true + } + }, + "required": [ + "action", + "starred_at", + "repository", + "sender" + ] + }, + "webhook-status": { + "title": "status event", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "branches": { + "description": "An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches.", + "type": "array", + "items": { + "type": "object", + "properties": { + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "name": { + "type": "string" + }, + "protected": { + "type": "boolean" + } + }, + "required": [ + "name", + "commit", + "protected" + ] + } + }, + "commit": { + "type": "object", + "properties": { + "author": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "commit": { + "type": "object", + "properties": { + "author": { + "allOf": [ + { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "date" + ] + } + ] + }, + "comment_count": { + "type": "integer" + }, + "committer": { + "allOf": [ + { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "email": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "date" + ] + } + ] + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "verification": { + "type": "object", + "properties": { + "payload": { + "type": "string", + "nullable": true + }, + "reason": { + "type": "string", + "enum": [ + "expired_key", + "not_signing_key", + "gpgverify_error", + "gpgverify_unavailable", + "unsigned", + "unknown_signature_type", + "no_user", + "unverified_email", + "bad_email", + "unknown_key", + "malformed_signature", + "invalid", + "valid", + "bad_cert", + "ocsp_pending" + ] + }, + "signature": { + "type": "string", + "nullable": true + }, + "verified": { + "type": "boolean" + }, + "verified_at": { + "type": "string", + "nullable": true + } + }, + "required": [ + "verified", + "reason", + "signature", + "payload", + "verified_at" + ] + } + }, + "required": [ + "author", + "committer", + "message", + "tree", + "url", + "comment_count", + "verification" + ] + }, + "committer": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "node_id": { + "type": "string" + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "html_url": { + "type": "string", + "format": "uri" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "url", + "html_url" + ] + } + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "sha", + "node_id", + "commit", + "url", + "html_url", + "comments_url", + "author", + "committer", + "parents" + ] + }, + "context": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "description": { + "description": "The optional human-readable description added to the status.", + "type": "string", + "nullable": true + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "id": { + "description": "The unique identifier of the status.", + "type": "integer" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "name": { + "type": "string" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "sha": { + "description": "The Commit SHA.", + "type": "string" + }, + "state": { + "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", + "type": "string", + "enum": [ + "pending", + "success", + "failure", + "error" + ] + }, + "target_url": { + "description": "The optional link added to the status.", + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "id", + "sha", + "name", + "target_url", + "context", + "description", + "state", + "commit", + "branches", + "created_at", + "updated_at", + "repository", + "sender" + ] + }, + "webhook-sub-issues-parent-issue-added": { + "title": "parent issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "parent_issue_added" + ] + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "parent_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "parent_issue_id", + "parent_issue", + "parent_issue_repo", + "sub_issue_id", + "sub_issue" + ] + }, + "webhook-sub-issues-parent-issue-removed": { + "title": "parent issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "parent_issue_removed" + ] + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "parent_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "parent_issue_id", + "parent_issue", + "parent_issue_repo", + "sub_issue_id", + "sub_issue" + ] + }, + "webhook-sub-issues-sub-issue-added": { + "title": "sub-issue added event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "sub_issue_added" + ] + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "sub_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "sub_issue_id", + "sub_issue", + "sub_issue_repo", + "parent_issue_id", + "parent_issue" + ] + }, + "webhook-sub-issues-sub-issue-removed": { + "title": "sub-issue removed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "sub_issue_removed" + ] + }, + "sub_issue_id": { + "description": "The ID of the sub-issue.", + "type": "number" + }, + "sub_issue": { + "$ref": "#/components/schemas/issue" + }, + "sub_issue_repo": { + "$ref": "#/components/schemas/repository" + }, + "parent_issue_id": { + "description": "The ID of the parent issue.", + "type": "number" + }, + "parent_issue": { + "$ref": "#/components/schemas/issue" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "sub_issue_id", + "sub_issue", + "sub_issue_repo", + "parent_issue_id", + "parent_issue" + ] + }, + "webhook-team-add": { + "title": "team_add event", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "team": { + "$ref": "#/components/schemas/webhooks_team_1" + } + }, + "required": [ + "team", + "repository", + "sender" + ] + }, + "webhook-team-added-to-repository": { + "title": "team added_to_repository event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "added_to_repository" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "team": { + "$ref": "#/components/schemas/webhooks_team_1" + } + }, + "required": [ + "action", + "team", + "organization" + ] + }, + "webhook-team-created": { + "title": "team created event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "team": { + "$ref": "#/components/schemas/webhooks_team_1" + } + }, + "required": [ + "action", + "team", + "organization", + "sender" + ] + }, + "webhook-team-deleted": { + "title": "team deleted event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "team": { + "$ref": "#/components/schemas/webhooks_team_1" + } + }, + "required": [ + "action", + "team", + "organization" + ] + }, + "webhook-team-edited": { + "title": "team edited event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "edited" + ] + }, + "changes": { + "description": "The changes to the team if the action was `edited`.", + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the description if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "name": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the name if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "privacy": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the team's privacy if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "notification_setting": { + "type": "object", + "properties": { + "from": { + "description": "The previous version of the team's notification setting if the action was `edited`.", + "type": "string" + } + }, + "required": [ + "from" + ] + }, + "repository": { + "type": "object", + "properties": { + "permissions": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "admin": { + "description": "The previous version of the team member's `admin` permission on a repository, if the action was `edited`.", + "type": "boolean" + }, + "pull": { + "description": "The previous version of the team member's `pull` permission on a repository, if the action was `edited`.", + "type": "boolean" + }, + "push": { + "description": "The previous version of the team member's `push` permission on a repository, if the action was `edited`.", + "type": "boolean" + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "permissions" + ] + } + } + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "team": { + "$ref": "#/components/schemas/webhooks_team_1" + } + }, + "required": [ + "action", + "changes", + "team", + "organization", + "sender" + ] + }, + "webhook-team-removed-from-repository": { + "title": "team removed_from_repository event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "removed_from_repository" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "allow_auto_merge": { + "description": "Whether to allow auto-merge for pull requests.", + "type": "boolean", + "default": false + }, + "allow_forking": { + "description": "Whether to allow private forks", + "type": "boolean" + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "type": "boolean", + "default": true + }, + "allow_update_branch": { + "type": "boolean" + }, + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "archived": { + "description": "Whether the repository is archived.", + "type": "boolean", + "default": false + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "clone_url": { + "type": "string", + "format": "uri" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "created_at": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string" + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "type": "boolean", + "default": false + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "disabled": { + "description": "Returns whether or not this repository is disabled.", + "type": "boolean" + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks": { + "type": "integer" + }, + "forks_count": { + "type": "integer" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "git_url": { + "type": "string", + "format": "uri" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "type": "boolean", + "default": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "type": "boolean", + "default": true + }, + "has_pages": { + "type": "boolean" + }, + "has_projects": { + "description": "Whether projects are enabled.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "type": "boolean", + "default": true + }, + "homepage": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64" + }, + "is_template": { + "type": "boolean" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "language": { + "type": "string", + "nullable": true + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "license": { + "title": "License", + "type": "object", + "nullable": true, + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "key", + "name", + "spdx_id", + "url", + "node_id" + ] + }, + "master_branch": { + "type": "string" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "mirror_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "open_issues": { + "type": "integer" + }, + "open_issues_count": { + "type": "integer" + }, + "organization": { + "type": "string" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + } + }, + "required": [ + "pull", + "push", + "admin" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "public": { + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "pushed_at": { + "nullable": true, + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string", + "format": "date-time" + } + ] + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "role_name": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "ssh_url": { + "type": "string" + }, + "stargazers": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "svn_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "visibility": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + }, + "watchers": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + } + }, + "required": [ + "id", + "node_id", + "name", + "full_name", + "private", + "owner", + "html_url", + "description", + "fork", + "url", + "forks_url", + "keys_url", + "collaborators_url", + "teams_url", + "hooks_url", + "issue_events_url", + "events_url", + "assignees_url", + "branches_url", + "tags_url", + "blobs_url", + "git_tags_url", + "git_refs_url", + "trees_url", + "statuses_url", + "languages_url", + "stargazers_url", + "contributors_url", + "subscribers_url", + "subscription_url", + "commits_url", + "git_commits_url", + "comments_url", + "issue_comment_url", + "contents_url", + "compare_url", + "merges_url", + "archive_url", + "downloads_url", + "issues_url", + "pulls_url", + "milestones_url", + "notifications_url", + "labels_url", + "releases_url", + "deployments_url", + "created_at", + "updated_at", + "pushed_at", + "git_url", + "ssh_url", + "clone_url", + "svn_url", + "homepage", + "size", + "stargazers_count", + "watchers_count", + "language", + "has_issues", + "has_projects", + "has_downloads", + "has_wiki", + "has_pages", + "forks_count", + "mirror_url", + "archived", + "open_issues_count", + "license", + "forks", + "open_issues", + "watchers", + "default_branch", + "topics", + "visibility" + ] + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "team": { + "$ref": "#/components/schemas/webhooks_team_1" + } + }, + "required": [ + "action", + "team", + "organization", + "sender" + ] + }, + "webhook-watch-started": { + "title": "watch started event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "started" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "repository", + "sender" + ] + }, + "webhook-workflow-dispatch": { + "title": "workflow_dispatch event", + "type": "object", + "properties": { + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "inputs": { + "type": "object", + "nullable": true, + "additionalProperties": true + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "ref": { + "type": "string" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow": { + "type": "string" + } + }, + "required": [ + "inputs", + "ref", + "repository", + "sender", + "workflow" + ] + }, + "webhook-workflow-job-completed": { + "title": "workflow_job completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow_job": { + "allOf": [ + { + "title": "Workflow Job", + "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.", + "type": "object", + "properties": { + "check_run_url": { + "type": "string", + "format": "uri" + }, + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + null, + "skipped", + "cancelled", + "action_required", + "neutral", + "timed_out" + ] + }, + "created_at": { + "description": "The time that the job created.", + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_id": { + "type": "number" + }, + "run_url": { + "type": "string", + "format": "uri" + }, + "runner_group_id": { + "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "integer", + "nullable": true + }, + "runner_group_name": { + "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "string", + "nullable": true + }, + "runner_id": { + "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "integer", + "nullable": true + }, + "runner_name": { + "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "string", + "nullable": true + }, + "started_at": { + "type": "string" + }, + "status": { + "description": "The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting" + ] + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true + }, + "steps": { + "type": "array", + "items": { + "title": "Workflow Step", + "type": "object", + "properties": { + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "failure", + "skipped", + "success", + "cancelled", + null + ] + }, + "name": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "started_at": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "queued" + ] + } + }, + "required": [ + "name", + "status", + "conclusion", + "number", + "started_at", + "completed_at" + ] + } + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "run_id", + "run_url", + "run_attempt", + "node_id", + "head_sha", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "name", + "steps", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "workflow_name", + "head_branch", + "created_at" + ] + }, + { + "type": "object", + "properties": { + "check_run_url": { + "type": "string" + }, + "completed_at": { + "type": "string" + }, + "conclusion": { + "type": "string", + "enum": [ + "success", + "failure", + "skipped", + "cancelled", + "action_required", + "neutral", + "timed_out" + ] + }, + "created_at": { + "description": "The time that the job created.", + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "string", + "nullable": true + } + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_id": { + "type": "integer" + }, + "run_url": { + "type": "string" + }, + "runner_group_id": { + "type": "number", + "nullable": true + }, + "runner_group_name": { + "type": "string", + "nullable": true + }, + "runner_id": { + "type": "number", + "nullable": true + }, + "runner_name": { + "type": "string", + "nullable": true + }, + "started_at": { + "type": "string" + }, + "status": { + "type": "string" + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true + }, + "steps": { + "type": "array", + "items": { + "type": "object", + "nullable": true + } + }, + "url": { + "type": "string" + } + }, + "required": [ + "conclusion" + ] + } + ] + }, + "deployment": { + "$ref": "#/components/schemas/deployment" + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow_job" + ] + }, + "webhook-workflow-job-in-progress": { + "title": "workflow_job in_progress event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "in_progress" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow_job": { + "allOf": [ + { + "title": "Workflow Job", + "description": "The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object.", + "type": "object", + "properties": { + "check_run_url": { + "type": "string", + "format": "uri" + }, + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + null, + "cancelled", + "neutral" + ] + }, + "created_at": { + "description": "The time that the job created.", + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "description": "Custom labels for the job. Specified by the [`\"runs-on\"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML.", + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_id": { + "type": "number" + }, + "run_url": { + "type": "string", + "format": "uri" + }, + "runner_group_id": { + "description": "The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "integer", + "nullable": true + }, + "runner_group_name": { + "description": "The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "string", + "nullable": true + }, + "runner_id": { + "description": "The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "integer", + "nullable": true + }, + "runner_name": { + "description": "The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`.", + "type": "string", + "nullable": true + }, + "started_at": { + "type": "string" + }, + "status": { + "description": "The current status of the job. Can be `queued`, `in_progress`, or `completed`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true + }, + "steps": { + "type": "array", + "items": { + "title": "Workflow Step", + "type": "object", + "properties": { + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "failure", + "skipped", + "success", + null, + "cancelled" + ] + }, + "name": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "started_at": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "queued", + "pending" + ] + } + }, + "required": [ + "name", + "status", + "conclusion", + "number", + "started_at", + "completed_at" + ] + } + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "run_id", + "run_url", + "run_attempt", + "node_id", + "head_sha", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "name", + "steps", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "workflow_name", + "head_branch", + "created_at" + ] + }, + { + "type": "object", + "properties": { + "check_run_url": { + "type": "string" + }, + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true + }, + "created_at": { + "description": "The time that the job created.", + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_id": { + "type": "integer" + }, + "run_url": { + "type": "string" + }, + "runner_group_id": { + "type": "number", + "nullable": true + }, + "runner_group_name": { + "type": "string", + "nullable": true + }, + "runner_id": { + "type": "number", + "nullable": true + }, + "runner_name": { + "type": "string", + "nullable": true + }, + "started_at": { + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "queued" + ] + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true + }, + "steps": { + "type": "array", + "items": { + "title": "Workflow Step", + "type": "object", + "properties": { + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "started_at": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "pending", + "queued" + ] + } + }, + "required": [ + "name", + "status", + "conclusion", + "number", + "started_at", + "completed_at" + ] + } + }, + "url": { + "type": "string" + } + }, + "required": [ + "status", + "steps" + ] + } + ] + }, + "deployment": { + "$ref": "#/components/schemas/deployment" + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow_job" + ] + }, + "webhook-workflow-job-queued": { + "title": "workflow_job queued event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "queued" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow_job": { + "type": "object", + "properties": { + "check_run_url": { + "type": "string", + "format": "uri" + }, + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true + }, + "created_at": { + "description": "The time that the job created.", + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_id": { + "type": "number" + }, + "run_url": { + "type": "string", + "format": "uri" + }, + "runner_group_id": { + "type": "integer", + "nullable": true + }, + "runner_group_name": { + "type": "string", + "nullable": true + }, + "runner_id": { + "type": "integer", + "nullable": true + }, + "runner_name": { + "type": "string", + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting" + ] + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true + }, + "steps": { + "type": "array", + "items": { + "title": "Workflow Step", + "type": "object", + "properties": { + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "failure", + "skipped", + "success", + "cancelled", + null + ] + }, + "name": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "started_at": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "completed", + "in_progress", + "queued", + "pending" + ] + } + }, + "required": [ + "name", + "status", + "conclusion", + "number", + "started_at", + "completed_at" + ] + } + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "run_id", + "run_url", + "run_attempt", + "node_id", + "head_sha", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "name", + "steps", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "workflow_name", + "head_branch", + "created_at" + ] + }, + "deployment": { + "$ref": "#/components/schemas/deployment" + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow_job" + ] + }, + "webhook-workflow-job-waiting": { + "title": "workflow_job waiting event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "waiting" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow_job": { + "type": "object", + "properties": { + "check_run_url": { + "type": "string", + "format": "uri" + }, + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true + }, + "created_at": { + "description": "The time that the job created.", + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "run_attempt": { + "type": "integer" + }, + "run_id": { + "type": "number" + }, + "run_url": { + "type": "string", + "format": "uri" + }, + "runner_group_id": { + "type": "integer", + "nullable": true + }, + "runner_group_name": { + "type": "string", + "nullable": true + }, + "runner_id": { + "type": "integer", + "nullable": true + }, + "runner_name": { + "type": "string", + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time" + }, + "head_branch": { + "type": "string", + "description": "The name of the current branch.", + "nullable": true + }, + "workflow_name": { + "type": "string", + "description": "The name of the workflow.", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed", + "waiting" + ] + }, + "steps": { + "type": "array", + "items": { + "title": "Workflow Step", + "type": "object", + "properties": { + "completed_at": { + "type": "string", + "nullable": true + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "failure", + "skipped", + "success", + "cancelled", + null + ] + }, + "name": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "started_at": { + "type": "string", + "nullable": true + }, + "status": { + "type": "string", + "enum": [ + "completed", + "in_progress", + "queued", + "pending", + "waiting" + ] + } + }, + "required": [ + "name", + "status", + "conclusion", + "number", + "started_at", + "completed_at" + ] + } + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "run_id", + "run_url", + "run_attempt", + "node_id", + "head_sha", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "name", + "steps", + "check_run_url", + "labels", + "runner_id", + "runner_name", + "runner_group_id", + "runner_group_name", + "workflow_name", + "head_branch", + "created_at" + ] + }, + "deployment": { + "$ref": "#/components/schemas/deployment" + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow_job" + ] + }, + "webhook-workflow-run-completed": { + "title": "workflow_run completed event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "completed" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow": { + "$ref": "#/components/schemas/webhooks_workflow" + }, + "workflow_run": { + "title": "Workflow Run", + "type": "object", + "required": [ + "actor", + "artifacts_url", + "cancel_url", + "check_suite_id", + "check_suite_node_id", + "check_suite_url", + "conclusion", + "created_at", + "event", + "head_branch", + "head_commit", + "head_repository", + "head_sha", + "html_url", + "id", + "jobs_url", + "logs_url", + "name", + "node_id", + "path", + "previous_attempt_url", + "pull_requests", + "repository", + "rerun_url", + "run_attempt", + "run_number", + "run_started_at", + "status", + "triggering_actor", + "updated_at", + "url", + "workflow_id", + "workflow_url" + ], + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "artifacts_url": { + "type": "string", + "format": "uri" + }, + "cancel_url": { + "type": "string", + "format": "uri" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string", + "nullable": true + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ], + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "required": [ + "email", + "name" + ], + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "required": [ + "email", + "name" + ], + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + } + }, + "head_repository": { + "title": "Repository Lite", + "type": "object", + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "node_id", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "properties": { + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string", + "format": "uri" + }, + "logs_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "required": [ + "url", + "id", + "number", + "head", + "base" + ], + "nullable": true, + "properties": { + "base": { + "type": "object", + "required": [ + "ref", + "sha", + "repo" + ], + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "required": [ + "id", + "url", + "name" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "sha": { + "type": "string" + } + } + }, + "head": { + "type": "object", + "required": [ + "ref", + "sha", + "repo" + ], + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "required": [ + "id", + "url", + "name" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "sha": { + "type": "string" + } + } + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "required": [ + "path", + "sha" + ], + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "repository": { + "title": "Repository Lite", + "type": "object", + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "node_id", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "properties": { + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "rerun_url": { + "type": "string", + "format": "uri" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "pending", + "waiting" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string", + "format": "uri" + }, + "display_title": { + "type": "string", + "example": "Simple Workflow", + "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow." + } + } + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow", + "workflow_run" + ] + }, + "webhook-workflow-run-in-progress": { + "title": "workflow_run in_progress event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "in_progress" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow": { + "$ref": "#/components/schemas/webhooks_workflow" + }, + "workflow_run": { + "title": "Workflow Run", + "type": "object", + "required": [ + "actor", + "artifacts_url", + "cancel_url", + "check_suite_id", + "check_suite_node_id", + "check_suite_url", + "conclusion", + "created_at", + "event", + "head_branch", + "head_commit", + "head_repository", + "head_sha", + "html_url", + "id", + "jobs_url", + "logs_url", + "name", + "node_id", + "path", + "previous_attempt_url", + "pull_requests", + "repository", + "rerun_url", + "run_attempt", + "run_number", + "run_started_at", + "status", + "triggering_actor", + "updated_at", + "url", + "workflow_id", + "workflow_url" + ], + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "artifacts_url": { + "type": "string", + "format": "uri" + }, + "cancel_url": { + "type": "string", + "format": "uri" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string", + "nullable": true + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ], + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "required": [ + "email", + "name" + ], + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "required": [ + "email", + "name" + ], + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + } + }, + "head_repository": { + "title": "Repository Lite", + "type": "object", + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "node_id", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "properties": { + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string", + "format": "uri" + }, + "logs_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "required": [ + "url", + "id", + "number", + "head", + "base" + ], + "nullable": true, + "properties": { + "base": { + "type": "object", + "required": [ + "ref", + "sha", + "repo" + ], + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "required": [ + "id", + "url", + "name" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "sha": { + "type": "string" + } + } + }, + "head": { + "type": "object", + "required": [ + "ref", + "sha", + "repo" + ], + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "required": [ + "id", + "url", + "name" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "sha": { + "type": "string" + } + } + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "url": { + "type": "string", + "format": "uri" + } + } + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "required": [ + "path", + "sha" + ], + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "repository": { + "title": "Repository Lite", + "type": "object", + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "node_id", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ], + "properties": { + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "rerun_url": { + "type": "string", + "format": "uri" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "pending" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string", + "format": "uri" + } + } + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow", + "workflow_run" + ] + }, + "webhook-workflow-run-requested": { + "title": "workflow_run requested event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "requested" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + }, + "workflow": { + "$ref": "#/components/schemas/webhooks_workflow" + }, + "workflow_run": { + "title": "Workflow Run", + "type": "object", + "properties": { + "actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "artifacts_url": { + "type": "string", + "format": "uri" + }, + "cancel_url": { + "type": "string", + "format": "uri" + }, + "check_suite_id": { + "type": "integer" + }, + "check_suite_node_id": { + "type": "string" + }, + "check_suite_url": { + "type": "string", + "format": "uri" + }, + "conclusion": { + "type": "string", + "nullable": true, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required", + "stale", + null, + "skipped", + "startup_failure" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "event": { + "type": "string" + }, + "head_branch": { + "type": "string", + "nullable": true + }, + "head_commit": { + "title": "SimpleCommit", + "type": "object", + "properties": { + "author": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "committer": { + "title": "Committer", + "description": "Metaproperties for Git author/committer information.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true, + "format": "email" + }, + "name": { + "description": "The git author's name.", + "type": "string" + }, + "username": { + "type": "string" + } + }, + "required": [ + "email", + "name" + ] + }, + "id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "tree_id": { + "type": "string" + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "head_repository": { + "title": "Repository Lite", + "type": "object", + "properties": { + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "node_id", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_sha": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "jobs_url": { + "type": "string", + "format": "uri" + }, + "logs_url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string", + "nullable": true + }, + "node_id": { + "type": "string" + }, + "path": { + "type": "string" + }, + "previous_attempt_url": { + "type": "string", + "nullable": true, + "format": "uri" + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "repo": { + "title": "Repo Ref", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "url", + "name" + ] + }, + "sha": { + "type": "string" + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "url", + "id", + "number", + "head", + "base" + ] + } + }, + "referenced_workflows": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + } + }, + "required": [ + "path", + "sha" + ] + } + }, + "repository": { + "title": "Repository Lite", + "type": "object", + "properties": { + "archive_url": { + "type": "string", + "format": "uri-template" + }, + "assignees_url": { + "type": "string", + "format": "uri-template" + }, + "blobs_url": { + "type": "string", + "format": "uri-template" + }, + "branches_url": { + "type": "string", + "format": "uri-template" + }, + "collaborators_url": { + "type": "string", + "format": "uri-template" + }, + "comments_url": { + "type": "string", + "format": "uri-template" + }, + "commits_url": { + "type": "string", + "format": "uri-template" + }, + "compare_url": { + "type": "string", + "format": "uri-template" + }, + "contents_url": { + "type": "string", + "format": "uri-template" + }, + "contributors_url": { + "type": "string", + "format": "uri" + }, + "deployments_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": "string", + "nullable": true + }, + "downloads_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "fork": { + "type": "boolean" + }, + "forks_url": { + "type": "string", + "format": "uri" + }, + "full_name": { + "type": "string" + }, + "git_commits_url": { + "type": "string", + "format": "uri-template" + }, + "git_refs_url": { + "type": "string", + "format": "uri-template" + }, + "git_tags_url": { + "type": "string", + "format": "uri-template" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "description": "Unique identifier of the repository", + "type": "integer" + }, + "issue_comment_url": { + "type": "string", + "format": "uri-template" + }, + "issue_events_url": { + "type": "string", + "format": "uri-template" + }, + "issues_url": { + "type": "string", + "format": "uri-template" + }, + "keys_url": { + "type": "string", + "format": "uri-template" + }, + "labels_url": { + "type": "string", + "format": "uri-template" + }, + "languages_url": { + "type": "string", + "format": "uri" + }, + "merges_url": { + "type": "string", + "format": "uri" + }, + "milestones_url": { + "type": "string", + "format": "uri-template" + }, + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "node_id": { + "type": "string" + }, + "notifications_url": { + "type": "string", + "format": "uri-template" + }, + "owner": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "type": "boolean" + }, + "pulls_url": { + "type": "string", + "format": "uri-template" + }, + "releases_url": { + "type": "string", + "format": "uri-template" + }, + "stargazers_url": { + "type": "string", + "format": "uri" + }, + "statuses_url": { + "type": "string", + "format": "uri-template" + }, + "subscribers_url": { + "type": "string", + "format": "uri" + }, + "subscription_url": { + "type": "string", + "format": "uri" + }, + "tags_url": { + "type": "string", + "format": "uri" + }, + "teams_url": { + "type": "string", + "format": "uri" + }, + "trees_url": { + "type": "string", + "format": "uri-template" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "node_id", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "rerun_url": { + "type": "string", + "format": "uri" + }, + "run_attempt": { + "type": "integer" + }, + "run_number": { + "type": "integer" + }, + "run_started_at": { + "type": "string", + "format": "date-time" + }, + "status": { + "type": "string", + "enum": [ + "requested", + "in_progress", + "completed", + "queued", + "pending", + "waiting" + ] + }, + "triggering_actor": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "format": "uri" + }, + "workflow_id": { + "type": "integer" + }, + "workflow_url": { + "type": "string", + "format": "uri" + }, + "display_title": { + "type": "string" + } + }, + "required": [ + "artifacts_url", + "cancel_url", + "check_suite_url", + "check_suite_id", + "check_suite_node_id", + "conclusion", + "created_at", + "event", + "head_branch", + "head_commit", + "head_repository", + "head_sha", + "html_url", + "id", + "jobs_url", + "logs_url", + "node_id", + "name", + "path", + "pull_requests", + "repository", + "rerun_url", + "run_number", + "status", + "updated_at", + "url", + "workflow_id", + "workflow_url", + "run_attempt", + "run_started_at", + "previous_attempt_url", + "actor", + "triggering_actor", + "display_title" + ] + } + }, + "required": [ + "action", + "repository", + "sender", + "workflow", + "workflow_run" + ] + }, + "create-event": { + "title": "CreateEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "master_branch": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "master_branch", + "pusher_type" + ] + }, + "delete-event": { + "title": "DeleteEvent", + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "ref_type": { + "type": "string" + }, + "full_ref": { + "type": "string" + }, + "pusher_type": { + "type": "string" + } + }, + "required": [ + "ref", + "ref_type", + "full_ref", + "pusher_type" + ] + }, + "discussion-event": { + "title": "DiscussionEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "discussion": { + "$ref": "#/components/schemas/discussion" + } + }, + "required": [ + "action", + "discussion" + ] + }, + "issues-event": { + "title": "IssuesEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "label": { + "$ref": "#/components/schemas/label" + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + } + }, + "required": [ + "action", + "issue" + ] + }, + "issue-comment-event": { + "title": "IssueCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "$ref": "#/components/schemas/issue" + }, + "comment": { + "$ref": "#/components/schemas/issue-comment" + } + }, + "required": [ + "action", + "issue", + "comment" + ] + }, + "fork-event": { + "title": "ForkEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "forkee": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "git_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "size": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "language": { + "type": "string", + "nullable": true + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "has_pull_requests": { + "type": "boolean" + }, + "pull_request_creation_policy": { + "description": "The policy controlling who can create pull requests: all or collaborators_only.", + "type": "string", + "enum": [ + "all", + "collaborators_only" + ] + }, + "forks_count": { + "type": "integer" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "open_issues_count": { + "type": "integer" + }, + "license": { + "$ref": "#/components/schemas/nullable-license-simple" + }, + "allow_forking": { + "type": "boolean" + }, + "is_template": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "visibility": { + "type": "string" + }, + "forks": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "public": { + "type": "boolean" + } + } + } + }, + "required": [ + "action", + "forkee" + ] + }, + "gollum-event": { + "title": "GollumEvent", + "type": "object", + "properties": { + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } + }, + "required": [ + "pages" + ] + }, + "member-event": { + "title": "MemberEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "member": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "member" + ] + }, + "public-event": { + "title": "PublicEvent", + "type": "object" + }, + "push-event": { + "title": "PushEvent", + "type": "object", + "properties": { + "repository_id": { + "type": "integer" + }, + "push_id": { + "type": "integer" + }, + "ref": { + "type": "string" + }, + "head": { + "type": "string" + }, + "before": { + "type": "string" + } + }, + "required": [ + "repository_id", + "push_id", + "ref", + "head", + "before" + ] + }, + "pull-request-event": { + "title": "PullRequestEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-minimal" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/simple-user" + } + }, + "label": { + "$ref": "#/components/schemas/label" + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/label" + } + } + }, + "required": [ + "action", + "number", + "pull_request" + ] + }, + "pull-request-review-comment-event": { + "title": "PullRequestReviewCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-minimal" + }, + "comment": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "pull_request_review_id": { + "type": "integer", + "nullable": true + }, + "diff_hunk": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "integer", + "nullable": true + }, + "original_position": { + "type": "integer" + }, + "subject_type": { + "type": "string", + "nullable": true + }, + "commit_id": { + "type": "string" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "body": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + }, + "self": { + "title": "Link", + "type": "object", + "properties": { + "href": { + "type": "string", + "format": "uri-template" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "self", + "html", + "pull_request" + ] + }, + "original_commit_id": { + "type": "string" + }, + "reactions": { + "title": "Reactions", + "type": "object", + "properties": { + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "rocket": { + "type": "integer" + }, + "total_count": { + "type": "integer" + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "in_reply_to_id": { + "type": "integer" + } + }, + "required": [ + "url", + "pull_request_review_id", + "id", + "node_id", + "diff_hunk", + "path", + "position", + "original_position", + "commit_id", + "original_commit_id", + "user", + "body", + "created_at", + "updated_at", + "html_url", + "pull_request_url", + "_links", + "reactions" + ] + } + }, + "required": [ + "action", + "comment", + "pull_request" + ] + }, + "pull-request-review-event": { + "title": "PullRequestReviewEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "review": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "submitted_at": { + "type": "string", + "nullable": true + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "pull_request_url": { + "type": "string", + "format": "uri" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + }, + "required": [ + "href" + ] + } + }, + "required": [ + "html", + "pull_request" + ] + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_request": { + "$ref": "#/components/schemas/pull-request-minimal" + } + }, + "required": [ + "action", + "review", + "pull_request" + ] + }, + "commit-comment-event": { + "title": "CommitCommentEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "comment": { + "type": "object", + "properties": { + "html_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": "string", + "nullable": true + }, + "position": { + "type": "integer", + "nullable": true + }, + "line": { + "type": "integer", + "nullable": true + }, + "commit_id": { + "type": "string" + }, + "user": { + "$ref": "#/components/schemas/nullable-simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "reactions": { + "$ref": "#/components/schemas/reaction-rollup" + } + } + } + }, + "required": [ + "action", + "comment" + ] + }, + "release-event": { + "title": "ReleaseEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "release": { + "allOf": [ + { + "$ref": "#/components/schemas/release" + }, + { + "type": "object", + "properties": { + "is_short_description_html_truncated": { + "type": "boolean" + }, + "short_description_html": { + "type": "string" + } + } + } + ] + } + }, + "required": [ + "action", + "release" + ] + }, + "watch-event": { + "title": "WatchEvent", + "type": "object", + "properties": { + "action": { + "type": "string" + } + }, + "required": [ + "action" + ] + } + }, + "examples": { + "root": { + "value": { + "current_user_url": "https://api.github.com/user", + "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}", + "authorizations_url": "https://api.github.com/authorizations", + "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}", + "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}", + "emails_url": "https://api.github.com/user/emails", + "emojis_url": "https://api.github.com/emojis", + "events_url": "https://api.github.com/events", + "feeds_url": "https://api.github.com/feeds", + "followers_url": "https://api.github.com/user/followers", + "following_url": "https://api.github.com/user/following{/target}", + "gists_url": "https://api.github.com/gists{/gist_id}", + "hub_url": "https://api.github.com/hub", + "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}", + "issues_url": "https://api.github.com/issues", + "keys_url": "https://api.github.com/user/keys", + "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}", + "notifications_url": "https://api.github.com/notifications", + "organization_url": "https://api.github.com/orgs/{org}", + "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}", + "organization_teams_url": "https://api.github.com/orgs/{org}/teams", + "public_gists_url": "https://api.github.com/gists/public", + "rate_limit_url": "https://api.github.com/rate_limit", + "repository_url": "https://api.github.com/repos/{owner}/{repo}", + "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}", + "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}", + "starred_url": "https://api.github.com/user/starred{/owner}{/repo}", + "starred_gists_url": "https://api.github.com/gists/starred", + "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}", + "user_url": "https://api.github.com/users/{user}", + "user_organizations_url": "https://api.github.com/user/orgs", + "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}", + "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}" + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_authorizations_url_from_api_root", + "patch": [ + { + "op": "remove", + "path": "/value/authorizations_url" + } + ], + "version": "2026-03-10" + }, + { + "changeset": "remove_hub_url_from_api_root", + "patch": { + "value": { + "hub_url": null + } + }, + "version": "2026-03-10" + } + ] + }, + "global-advisory-items": { + "value": [ + { + "id": 1, + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "Heartbleed security advisory", + "description": "This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + ] + }, + "global-advisory": { + "value": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/advisories/GHSA-abcd-1234-efgh", + "repository_advisory_url": "https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "type": "reviewed", + "severity": "high", + "source_code_location": "https://github.com/project/a-package", + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "references": [ + "https://nvd.nist.gov/vuln/detail/CVE-2050-00000" + ], + "published_at": "2023-03-23T02:30:56Z", + "updated_at": "2023-03-24T02:30:56Z", + "github_reviewed_at": "2023-03-23T02:30:56Z", + "nvd_published_at": "2023-03-25T02:30:56Z", + "withdrawn_at": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "first_patched_version": "1.0.3", + "vulnerable_version_range": "<=1.0.2", + "vulnerable_functions": [ + "a_function" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H", + "score": 7.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-400", + "name": "Uncontrolled Resource Consumption" + } + ], + "credits": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst" + } + ] + } + }, + "integration": { + "value": { + "id": 1, + "slug": "octoapp", + "client_id": "Iv1.ab1112223334445c", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + }, + "integration-from-manifest": { + "value": { + "id": 1, + "slug": "octoapp", + "node_id": "MDxOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ], + "client_id": "Iv1.8a61f9b3a7aba766", + "client_secret": "1726be1638095a19edd134c77bde3aa2ece1e5d8", + "webhook_secret": "e340154128314309424b7c8e90325147d99fdafa", + "pem": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\n-----END RSA PRIVATE KEY-----\n" + } + }, + "webhook-config": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + }, + "hook-delivery-items": { + "value": [ + { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "throttled_at": "2019-06-03T00:57:16Z" + }, + { + "id": 123456789, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-04T00:57:16Z", + "redelivery": true, + "duration": 0.28, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "throttled_at": null + } + ] + }, + "hook-delivery": { + "value": { + "id": 12345678, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "delivered_at": "2019-06-03T00:57:16Z", + "redelivery": false, + "duration": 0.27, + "status": "OK", + "status_code": 200, + "event": "issues", + "action": "opened", + "installation_id": 123, + "repository_id": 456, + "url": "https://www.example.com", + "throttled_at": "2019-06-03T00:57:16Z", + "request": { + "headers": { + "X-GitHub-Delivery": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "X-Hub-Signature-256": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "Accept": "*/*", + "X-GitHub-Hook-ID": "42", + "User-Agent": "GitHub-Hookshot/b8c71d8", + "X-GitHub-Event": "issues", + "X-GitHub-Hook-Installation-Target-ID": "123", + "X-GitHub-Hook-Installation-Target-Type": "repository", + "content-type": "application/json", + "X-Hub-Signature": "sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "payload": { + "action": "opened", + "issue": { + "body": "foo" + }, + "repository": { + "id": 123 + } + } + }, + "response": { + "headers": { + "Content-Type": "text/html;charset=utf-8" + }, + "payload": "ok" + } + } + }, + "integration-installation-request-paginated": { + "value": [ + { + "id": 25381, + "node_id": "MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA==", + "account": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "requester": { + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-07-08T16:18:44-04:00" + } + ] + }, + "base-installation-items": { + "value": [ + { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + ] + }, + "base-installation": { + "value": { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "selected", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + }, + "installation-token": { + "value": { + "token": "ghs_16C7e42F292c6912E7710c838347Ae178B4a", + "expires_at": "2016-07-11T22:14:10Z", + "permissions": { + "issues": "write", + "contents": "read" + }, + "repository_selection": "selected", + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "authorization-with-user": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": [ + "public_repo", + "user" + ], + "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", + "token_last_eight": "Ae178B4a", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "Iv1.8a61f9b3a7aba766" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678", + "expires_at": "2011-09-08T17:26:27Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "scope-token": { + "value": { + "id": 1, + "url": "https://api.github.com/authorizations/1", + "scopes": [], + "token": "ghu_16C7e42F292c6912E7710c838347Ae178B4a", + "token_last_eight": "Ae178B4a", + "hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8", + "app": { + "url": "http://my-github-app.com", + "name": "my github app", + "client_id": "Iv1.8a61f9b3a7aba766" + }, + "note": "optional note", + "note_url": "http://optional/note/url", + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "fingerprint": "jklmnop12345678", + "expires_at": "2011-09-08T17:26:27Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "installation": { + "permissions": { + "metadata": "read", + "issues": "write", + "contents": "read" + }, + "repository_selection": "selected", + "single_file_name": ".github/workflow.yml", + "repositories_url": "https://api.github.com/user/repos", + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "has_multiple_single_files": false, + "single_file_paths": [] + } + } + }, + "classroom-assignment": { + "value": { + "id": "12,", + "public_repo": "false,", + "title": "Intro to Binaries", + "type": "individual", + "invite_link": "https://classroom.github.com/a/Lx7jiUgx", + "invitations_enabled": "true,", + "slug": "intro-to-binaries", + "students_are_repo_admins": false, + "feedback_pull_requests_enabled": true, + "max_teams": 0, + "max_members": 0, + "editor": "codespaces", + "accepted": 100, + "submitted": 40, + "passing": 10, + "language": "ruby", + "deadline": "2011-01-26T19:06:43Z", + "stater_code_repository": { + "id": 1296269, + "full_name": "octocat/Hello-World", + "html_url": "https://github.com/octocat/Hello-World", + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "private": false, + "default_branch": "main" + }, + "classroom": { + "id": 1296269, + "name": "Programming Elixir", + "archived": "false,", + "url": "https://classroom.github.com/classrooms/1-programming-elixir" + } + } + }, + "classroom-accepted-assignment": { + "value": { + "id": "12,", + "submitted": "false,", + "passing": "false,", + "commit_count": 5, + "grade": "5/10", + "students": [ + { + "id": 1, + "login": "octocat", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "html_url": "https://github.com/octocat" + } + ], + "repository": { + "id": 1296269, + "full_name": "octocat/Hello-World", + "html_url": "https://github.com/octocat/Hello-World", + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "private": false, + "default_branch": "main" + }, + "assignment": { + "id": "12,", + "public_repo": "false,", + "title": "Intro to Binaries", + "type": "individual", + "invite_link": "https://classroom.github.com/a/Lx7jiUgx", + "invitations_enabled": "true,", + "slug": "intro-to-binaries", + "students_are_repo_admins": false, + "feedback_pull_requests_enabled": true, + "max_teams": 0, + "max_members": 0, + "editor": "codespaces", + "accepted": 100, + "submitted": 40, + "passing": 10, + "language": "ruby", + "classroom": { + "id": 1296269, + "name": "Programming Elixir", + "archived": "false,", + "url": "https://classroom.github.com/classrooms/1-programming-elixir" + } + } + } + }, + "classroom-assignment-grades": { + "value": [ + { + "assignment_name": "Introduction to Strings", + "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337", + "starter_code_url": "", + "github_username": "octocat", + "roster_identifier": "octocat@github.com", + "student_repository_name": "intro-to-strings-1337-octocat", + "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-octocat", + "submission_timestamp": "2018-11-12 01:02", + "points_awarded": 10, + "points_available": 15, + "group_name": "octocat-and-friends" + }, + { + "assignment_name": "Introduction to Strings", + "assignment_url": "https://classroom.github.com/classrooms/1337/assignments/1337", + "starter_code_url": "", + "github_username": "monalisa", + "roster_identifier": "monalisa@github.com", + "student_repository_name": "intro-to-strings-1337-monalisa", + "student_repository_url": "https://github.com/timeforschool/intro-to-strings-1337-monalisa", + "submission_timestamp": "2018-11-12 01:11", + "points_awarded": 15, + "points_available": 15, + "group_name": "monalisa-and-friends" + } + ] + }, + "simple-classroom": { + "value": { + "id": 1296269, + "name": "Programming Elixir", + "archived": "false,", + "url": "https://classroom.github.com/classrooms/1-programming-elixir" + } + }, + "classroom": { + "value": { + "id": 1296269, + "name": "Programming Elixir", + "archived": "false,", + "organization": { + "id": 1, + "login": "programming-elixir", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "html_url": "https://github.com/programming-elixir", + "name": "Learn how to build fault tolerant applications", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4" + }, + "url": "https://classroom.github.com/classrooms/1-programming-elixir" + } + }, + "simple-classroom-assignment": { + "value": { + "id": "12,", + "public_repo": "false,", + "title": "Intro to Binaries", + "type": "individual", + "invite_link": "https://classroom.github.com/a/Lx7jiUgx", + "invitations_enabled": "true,", + "slug": "intro-to-binaries", + "students_are_repo_admins": false, + "feedback_pull_requests_enabled": true, + "max_teams": 0, + "max_members": 0, + "editor": "codespaces", + "accepted": 100, + "submitted": 40, + "passing": 10, + "language": "ruby", + "deadline": "2020-01-11T11:59:22Z", + "classroom": { + "id": 1296269, + "name": "Programming Elixir", + "archived": "false,", + "url": "https://classroom.github.com/classrooms/1-programming-elixir" + } + } + }, + "code-of-conduct-simple-items": { + "value": [ + { + "key": "citizen_code_of_conduct", + "name": "Citizen Code of Conduct", + "url": "https://api.github.com/codes_of_conduct/citizen_code_of_conduct", + "html_url": "http://citizencodeofconduct.org/" + }, + { + "key": "contributor_covenant", + "name": "Contributor Covenant", + "url": "https://api.github.com/codes_of_conduct/contributor_covenant", + "html_url": "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" + } + ] + }, + "code-of-conduct": { + "value": { + "key": "contributor_covenant", + "name": "Contributor Covenant", + "url": "https://api.github.com/codes_of_conduct/contributor_covenant", + "body": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n", + "html_url": "http://contributor-covenant.org/version/1/4/" + } + }, + "emojis-get": { + "value": { + "+1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", + "-1": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", + "100": "https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8", + "1234": "https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8", + "1st_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8", + "2nd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8", + "3rd_place_medal": "https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8", + "8ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8", + "a": "https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8", + "ab": "https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8", + "abacus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8", + "abc": "https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8", + "abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8", + "accept": "https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8", + "accessibility": "https://github.githubassets.com/images/icons/emoji/accessibility.png?v8", + "accordion": "https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8", + "adhesive_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8", + "adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8", + "aerial_tramway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8", + "afghanistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8", + "airplane": "https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8", + "aland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8", + "alarm_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8", + "albania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8", + "alembic": "https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8", + "algeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8", + "alien": "https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8", + "ambulance": "https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8", + "american_samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8", + "amphora": "https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8", + "anatomical_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8", + "anchor": "https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8", + "andorra": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8", + "angel": "https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8", + "anger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8", + "angola": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8", + "angry": "https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8", + "anguilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8", + "anguished": "https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8", + "ant": "https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8", + "antarctica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8", + "antigua_barbuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8", + "apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8", + "aquarius": "https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8", + "argentina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8", + "aries": "https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8", + "armenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8", + "arrow_backward": "https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8", + "arrow_double_down": "https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8", + "arrow_double_up": "https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8", + "arrow_down": "https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8", + "arrow_down_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8", + "arrow_forward": "https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8", + "arrow_heading_down": "https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8", + "arrow_heading_up": "https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8", + "arrow_left": "https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8", + "arrow_lower_left": "https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8", + "arrow_lower_right": "https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8", + "arrow_right": "https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8", + "arrow_right_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8", + "arrow_up": "https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8", + "arrow_up_down": "https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8", + "arrow_up_small": "https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8", + "arrow_upper_left": "https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8", + "arrow_upper_right": "https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8", + "arrows_clockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8", + "arrows_counterclockwise": "https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8", + "art": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8", + "articulated_lorry": "https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8", + "artificial_satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8", + "artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8", + "aruba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8", + "ascension_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8", + "asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8", + "astonished": "https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8", + "astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8", + "athletic_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8", + "atm": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8", + "atom": "https://github.githubassets.com/images/icons/emoji/atom.png?v8", + "atom_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8", + "australia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8", + "austria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8", + "auto_rickshaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8", + "avocado": "https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8", + "axe": "https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8", + "azerbaijan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8", + "b": "https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8", + "baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8", + "baby_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8", + "baby_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8", + "baby_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8", + "back": "https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8", + "bacon": "https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8", + "badger": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8", + "badminton": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8", + "bagel": "https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8", + "baggage_claim": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8", + "baguette_bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8", + "bahamas": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8", + "bahrain": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8", + "balance_scale": "https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8", + "bald_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8", + "bald_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8", + "ballet_shoes": "https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8", + "balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8", + "ballot_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8", + "ballot_box_with_check": "https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8", + "bamboo": "https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8", + "banana": "https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8", + "bangbang": "https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8", + "bangladesh": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8", + "banjo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8", + "bank": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8", + "bar_chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8", + "barbados": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8", + "barber": "https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8", + "baseball": "https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8", + "basecamp": "https://github.githubassets.com/images/icons/emoji/basecamp.png?v8", + "basecampy": "https://github.githubassets.com/images/icons/emoji/basecampy.png?v8", + "basket": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8", + "basketball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8", + "basketball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", + "basketball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", + "bat": "https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8", + "bath": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8", + "bathtub": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8", + "battery": "https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8", + "beach_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8", + "bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8", + "bearded_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8", + "beaver": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8", + "bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8", + "bee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", + "beer": "https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8", + "beers": "https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8", + "beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8", + "beginner": "https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8", + "belarus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8", + "belgium": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8", + "belize": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8", + "bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8", + "bell_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8", + "bellhop_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8", + "benin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8", + "bento": "https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8", + "bermuda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8", + "beverage_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8", + "bhutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8", + "bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8", + "bike": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8", + "biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8", + "biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8", + "bikini": "https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8", + "billed_cap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8", + "biohazard": "https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8", + "bird": "https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8", + "birthday": "https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8", + "bison": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8", + "black_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8", + "black_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8", + "black_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8", + "black_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8", + "black_joker": "https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8", + "black_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8", + "black_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8", + "black_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8", + "black_nib": "https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8", + "black_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8", + "black_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8", + "blond_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8", + "blond_haired_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8", + "blond_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", + "blonde_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8", + "blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8", + "blowfish": "https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8", + "blue_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8", + "blue_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8", + "blue_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8", + "blue_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8", + "blueberries": "https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8", + "blush": "https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8", + "boar": "https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8", + "boat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", + "bolivia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8", + "bomb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8", + "bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8", + "book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", + "bookmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8", + "bookmark_tabs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8", + "books": "https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8", + "boom": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", + "boomerang": "https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8", + "boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8", + "bosnia_herzegovina": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8", + "botswana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8", + "bouncing_ball_man": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8", + "bouncing_ball_person": "https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8", + "bouncing_ball_woman": "https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8", + "bouquet": "https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8", + "bouvet_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8", + "bow": "https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8", + "bow_and_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8", + "bowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8", + "bowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8", + "bowl_with_spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8", + "bowling": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8", + "bowtie": "https://github.githubassets.com/images/icons/emoji/bowtie.png?v8", + "boxing_glove": "https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8", + "boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8", + "brain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8", + "brazil": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8", + "bread": "https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8", + "breast_feeding": "https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8", + "bricks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8", + "bride_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", + "bridge_at_night": "https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8", + "briefcase": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8", + "british_indian_ocean_territory": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8", + "british_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8", + "broccoli": "https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8", + "broken_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8", + "broom": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8", + "brown_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8", + "brown_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8", + "brown_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8", + "brunei": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8", + "bubble_tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8", + "bucket": "https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8", + "bug": "https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8", + "building_construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8", + "bulb": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8", + "bulgaria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8", + "bullettrain_front": "https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8", + "bullettrain_side": "https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8", + "burkina_faso": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8", + "burrito": "https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8", + "burundi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8", + "bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8", + "business_suit_levitating": "https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8", + "busstop": "https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8", + "bust_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8", + "busts_in_silhouette": "https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8", + "butter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8", + "butterfly": "https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8", + "cactus": "https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8", + "cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8", + "calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8", + "call_me_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8", + "calling": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8", + "cambodia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8", + "camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8", + "camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8", + "camera_flash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8", + "cameroon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8", + "camping": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8", + "canada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8", + "canary_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8", + "cancer": "https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8", + "candle": "https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8", + "candy": "https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8", + "canned_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8", + "canoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8", + "cape_verde": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8", + "capital_abcd": "https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8", + "capricorn": "https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8", + "car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", + "card_file_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8", + "card_index": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8", + "card_index_dividers": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8", + "caribbean_netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8", + "carousel_horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8", + "carpentry_saw": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8", + "carrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8", + "cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8", + "cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8", + "cat2": "https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8", + "cayman_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8", + "cd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8", + "central_african_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8", + "ceuta_melilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8", + "chad": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8", + "chains": "https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8", + "chair": "https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8", + "champagne": "https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8", + "chart": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8", + "chart_with_downwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8", + "chart_with_upwards_trend": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8", + "checkered_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8", + "cheese": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8", + "cherries": "https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8", + "cherry_blossom": "https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8", + "chess_pawn": "https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8", + "chestnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8", + "chicken": "https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8", + "child": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8", + "children_crossing": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8", + "chile": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8", + "chipmunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8", + "chocolate_bar": "https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8", + "chopsticks": "https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8", + "christmas_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8", + "christmas_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8", + "church": "https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8", + "cinema": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8", + "circus_tent": "https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8", + "city_sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8", + "city_sunset": "https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8", + "cityscape": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8", + "cl": "https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8", + "clamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8", + "clap": "https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8", + "clapper": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8", + "classical_building": "https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8", + "climbing": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8", + "climbing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8", + "climbing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8", + "clinking_glasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8", + "clipboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8", + "clipperton_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8", + "clock1": "https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8", + "clock10": "https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8", + "clock1030": "https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8", + "clock11": "https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8", + "clock1130": "https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8", + "clock12": "https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8", + "clock1230": "https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8", + "clock130": "https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8", + "clock2": "https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8", + "clock230": "https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8", + "clock3": "https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8", + "clock330": "https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8", + "clock4": "https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8", + "clock430": "https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8", + "clock5": "https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8", + "clock530": "https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8", + "clock6": "https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8", + "clock630": "https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8", + "clock7": "https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8", + "clock730": "https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8", + "clock8": "https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8", + "clock830": "https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8", + "clock9": "https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8", + "clock930": "https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8", + "closed_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8", + "closed_lock_with_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8", + "closed_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8", + "cloud": "https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8", + "cloud_with_lightning": "https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8", + "cloud_with_lightning_and_rain": "https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8", + "cloud_with_rain": "https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8", + "cloud_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8", + "clown_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8", + "clubs": "https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8", + "cn": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8", + "coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8", + "cockroach": "https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8", + "cocktail": "https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8", + "coconut": "https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8", + "cocos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8", + "coffee": "https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8", + "coffin": "https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8", + "coin": "https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8", + "cold_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8", + "cold_sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8", + "collision": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8", + "colombia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8", + "comet": "https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8", + "comoros": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8", + "compass": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8", + "computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8", + "computer_mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8", + "confetti_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8", + "confounded": "https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8", + "confused": "https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8", + "congo_brazzaville": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8", + "congo_kinshasa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8", + "congratulations": "https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8", + "construction": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8", + "construction_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8", + "construction_worker_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8", + "construction_worker_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8", + "control_knobs": "https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8", + "convenience_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8", + "cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8", + "cook_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8", + "cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8", + "cool": "https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8", + "cop": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "copilot": "https://github.githubassets.com/images/icons/emoji/copilot.png?v8", + "copyright": "https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8", + "corn": "https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8", + "costa_rica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8", + "cote_divoire": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8", + "couch_and_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8", + "couple": "https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8", + "couple_with_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8", + "couple_with_heart_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8", + "couple_with_heart_woman_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8", + "couple_with_heart_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8", + "couplekiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8", + "couplekiss_man_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8", + "couplekiss_man_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8", + "couplekiss_woman_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8", + "cow": "https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8", + "cow2": "https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8", + "cowboy_hat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8", + "crab": "https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8", + "crayon": "https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8", + "credit_card": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8", + "crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8", + "cricket": "https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8", + "cricket_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8", + "croatia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8", + "crocodile": "https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8", + "croissant": "https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8", + "crossed_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8", + "crossed_flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8", + "crossed_swords": "https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8", + "crown": "https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8", + "cry": "https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8", + "crying_cat_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8", + "crystal_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8", + "cuba": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8", + "cucumber": "https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8", + "cup_with_straw": "https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8", + "cupcake": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8", + "cupid": "https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8", + "curacao": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8", + "curling_stone": "https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8", + "curly_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8", + "curly_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8", + "curly_loop": "https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8", + "currency_exchange": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8", + "curry": "https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8", + "cursing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8", + "custard": "https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8", + "customs": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8", + "cut_of_meat": "https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8", + "cyclone": "https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8", + "cyprus": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8", + "czech_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8", + "dagger": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8", + "dancer": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", + "dancers": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8", + "dancing_men": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8", + "dancing_women": "https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8", + "dango": "https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8", + "dark_sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8", + "dart": "https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8", + "dash": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8", + "date": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8", + "de": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8", + "deaf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8", + "deaf_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8", + "deaf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8", + "deciduous_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8", + "deer": "https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8", + "denmark": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8", + "department_store": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8", + "dependabot": "https://github.githubassets.com/images/icons/emoji/dependabot.png?v8", + "derelict_house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8", + "desert": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8", + "desert_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8", + "desktop_computer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8", + "detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8", + "diamond_shape_with_a_dot_inside": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8", + "diamonds": "https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8", + "diego_garcia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8", + "disappointed": "https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8", + "disappointed_relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8", + "disguised_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8", + "diving_mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8", + "diya_lamp": "https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8", + "dizzy": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8", + "dizzy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8", + "djibouti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8", + "dna": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8", + "do_not_litter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8", + "dodo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8", + "dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8", + "dog2": "https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8", + "dollar": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8", + "dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8", + "dolphin": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", + "dominica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8", + "dominican_republic": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8", + "door": "https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8", + "doughnut": "https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8", + "dove": "https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8", + "dragon": "https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8", + "dragon_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8", + "dress": "https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8", + "dromedary_camel": "https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8", + "drooling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8", + "drop_of_blood": "https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8", + "droplet": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8", + "drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8", + "duck": "https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8", + "dumpling": "https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8", + "dvd": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8", + "e-mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", + "eagle": "https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8", + "ear": "https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8", + "ear_of_rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8", + "ear_with_hearing_aid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8", + "earth_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8", + "earth_americas": "https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8", + "earth_asia": "https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8", + "ecuador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8", + "egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8", + "eggplant": "https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8", + "egypt": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8", + "eight": "https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8", + "eight_pointed_black_star": "https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8", + "eight_spoked_asterisk": "https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8", + "eject_button": "https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8", + "el_salvador": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8", + "electric_plug": "https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8", + "electron": "https://github.githubassets.com/images/icons/emoji/electron.png?v8", + "elephant": "https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8", + "elevator": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8", + "elf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8", + "elf_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8", + "elf_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8", + "email": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8", + "end": "https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8", + "england": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8", + "envelope": "https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8", + "envelope_with_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8", + "equatorial_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8", + "eritrea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8", + "es": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8", + "estonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8", + "ethiopia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8", + "eu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", + "euro": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8", + "european_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8", + "european_post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8", + "european_union": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8", + "evergreen_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8", + "exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", + "exploding_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8", + "expressionless": "https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8", + "eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8", + "eye_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8", + "eyeglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8", + "eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8", + "face_exhaling": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8", + "face_in_clouds": "https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8", + "face_with_head_bandage": "https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8", + "face_with_spiral_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8", + "face_with_thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8", + "facepalm": "https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8", + "facepunch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", + "factory": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8", + "factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8", + "fairy": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8", + "fairy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8", + "fairy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8", + "falafel": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8", + "falkland_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8", + "fallen_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8", + "family": "https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8", + "family_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8", + "family_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8", + "family_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8", + "family_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8", + "family_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8", + "family_man_man_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8", + "family_man_man_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8", + "family_man_man_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8", + "family_man_man_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8", + "family_man_man_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8", + "family_man_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8", + "family_man_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8", + "family_man_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8", + "family_man_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8", + "family_man_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8", + "family_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8", + "family_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8", + "family_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8", + "family_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8", + "family_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8", + "family_woman_woman_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8", + "family_woman_woman_boy_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8", + "family_woman_woman_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8", + "family_woman_woman_girl_boy": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8", + "family_woman_woman_girl_girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8", + "farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8", + "faroe_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8", + "fast_forward": "https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8", + "fax": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8", + "fearful": "https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8", + "feather": "https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8", + "feelsgood": "https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8", + "feet": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", + "female_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8", + "female_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8", + "ferris_wheel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8", + "ferry": "https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8", + "field_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8", + "fiji": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8", + "file_cabinet": "https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8", + "file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8", + "film_projector": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8", + "film_strip": "https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8", + "finland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8", + "finnadie": "https://github.githubassets.com/images/icons/emoji/finnadie.png?v8", + "fire": "https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8", + "fire_engine": "https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8", + "fire_extinguisher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8", + "firecracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8", + "firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8", + "fireworks": "https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8", + "first_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8", + "first_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8", + "fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8", + "fish_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8", + "fishsticks": "https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8", + "fishing_pole_and_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8", + "fist": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", + "fist_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8", + "fist_oncoming": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", + "fist_raised": "https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8", + "fist_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8", + "five": "https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8", + "flags": "https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8", + "flamingo": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8", + "flashlight": "https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8", + "flat_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8", + "flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8", + "fleur_de_lis": "https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8", + "flight_arrival": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8", + "flight_departure": "https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8", + "flipper": "https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8", + "floppy_disk": "https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8", + "flower_playing_cards": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8", + "flushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8", + "fly": "https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8", + "flying_disc": "https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8", + "flying_saucer": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8", + "fog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8", + "foggy": "https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8", + "fondue": "https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8", + "foot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8", + "football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8", + "footprints": "https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8", + "fork_and_knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8", + "fortune_cookie": "https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8", + "fountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8", + "fountain_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8", + "four": "https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8", + "four_leaf_clover": "https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8", + "fox_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8", + "fr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8", + "framed_picture": "https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8", + "free": "https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8", + "french_guiana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8", + "french_polynesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8", + "french_southern_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8", + "fried_egg": "https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8", + "fried_shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8", + "fries": "https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8", + "frog": "https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8", + "frowning": "https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8", + "frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8", + "frowning_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8", + "frowning_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8", + "frowning_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8", + "fu": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", + "fuelpump": "https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8", + "full_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8", + "full_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8", + "funeral_urn": "https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8", + "gabon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8", + "gambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8", + "game_die": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8", + "garlic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8", + "gb": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", + "gear": "https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8", + "gem": "https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8", + "gemini": "https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8", + "genie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8", + "genie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8", + "genie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8", + "georgia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8", + "ghana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8", + "ghost": "https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8", + "gibraltar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8", + "gift": "https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8", + "gift_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8", + "giraffe": "https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8", + "girl": "https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8", + "globe_with_meridians": "https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8", + "gloves": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8", + "goal_net": "https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8", + "goat": "https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8", + "goberserk": "https://github.githubassets.com/images/icons/emoji/goberserk.png?v8", + "godmode": "https://github.githubassets.com/images/icons/emoji/godmode.png?v8", + "goggles": "https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8", + "golf": "https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8", + "golfing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8", + "golfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8", + "golfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8", + "gorilla": "https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8", + "grapes": "https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8", + "greece": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8", + "green_apple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8", + "green_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8", + "green_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8", + "green_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8", + "green_salad": "https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8", + "green_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8", + "greenland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8", + "grenada": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8", + "grey_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8", + "grey_question": "https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8", + "grimacing": "https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8", + "grin": "https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8", + "grinning": "https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8", + "guadeloupe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8", + "guam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8", + "guard": "https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8", + "guardsman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8", + "guardswoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8", + "guatemala": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8", + "guernsey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8", + "guide_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8", + "guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8", + "guinea_bissau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8", + "guitar": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8", + "gun": "https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8", + "guyana": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8", + "haircut": "https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8", + "haircut_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8", + "haircut_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8", + "haiti": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8", + "hamburger": "https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8", + "hammer": "https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8", + "hammer_and_pick": "https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8", + "hammer_and_wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8", + "hamster": "https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8", + "hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", + "hand_over_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8", + "handbag": "https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8", + "handball_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8", + "handshake": "https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8", + "hankey": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", + "hash": "https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8", + "hatched_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8", + "hatching_chick": "https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8", + "headphones": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8", + "headstone": "https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8", + "health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8", + "hear_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8", + "heard_mcdonald_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8", + "heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8", + "heart_decoration": "https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8", + "heart_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8", + "heart_eyes_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8", + "heart_on_fire": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8", + "heartbeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8", + "heartpulse": "https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8", + "hearts": "https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8", + "heavy_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8", + "heavy_division_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8", + "heavy_dollar_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8", + "heavy_exclamation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8", + "heavy_heart_exclamation": "https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8", + "heavy_minus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8", + "heavy_multiplication_x": "https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8", + "heavy_plus_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8", + "hedgehog": "https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8", + "helicopter": "https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8", + "herb": "https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8", + "hibiscus": "https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8", + "high_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8", + "high_heel": "https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8", + "hiking_boot": "https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8", + "hindu_temple": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8", + "hippopotamus": "https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8", + "hocho": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", + "hole": "https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8", + "honduras": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8", + "honey_pot": "https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8", + "honeybee": "https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8", + "hong_kong": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8", + "hook": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8", + "horse": "https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8", + "horse_racing": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8", + "hospital": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8", + "hot_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8", + "hot_pepper": "https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8", + "hotdog": "https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8", + "hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8", + "hotsprings": "https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8", + "hourglass": "https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8", + "hourglass_flowing_sand": "https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8", + "house": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8", + "house_with_garden": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8", + "houses": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8", + "hugs": "https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8", + "hungary": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8", + "hurtrealbad": "https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8", + "hushed": "https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8", + "hut": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8", + "ice_cream": "https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8", + "ice_cube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8", + "ice_hockey": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8", + "ice_skate": "https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8", + "icecream": "https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8", + "iceland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8", + "id": "https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8", + "ideograph_advantage": "https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8", + "imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8", + "inbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8", + "incoming_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8", + "india": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8", + "indonesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8", + "infinity": "https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8", + "information_desk_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", + "information_source": "https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8", + "innocent": "https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8", + "interrobang": "https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8", + "iphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8", + "iran": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8", + "iraq": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8", + "ireland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8", + "isle_of_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8", + "israel": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8", + "it": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8", + "izakaya_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", + "jack_o_lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8", + "jamaica": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8", + "japan": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8", + "japanese_castle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8", + "japanese_goblin": "https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8", + "japanese_ogre": "https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8", + "jeans": "https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8", + "jersey": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8", + "jigsaw": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8", + "jordan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8", + "joy": "https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8", + "joy_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8", + "joystick": "https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8", + "jp": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8", + "judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8", + "juggling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8", + "kangaroo": "https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8", + "kazakhstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8", + "kenya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8", + "key": "https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8", + "keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8", + "keycap_ten": "https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8", + "kick_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8", + "kimono": "https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8", + "kiribati": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8", + "kiss": "https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8", + "kissing": "https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8", + "kissing_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8", + "kissing_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8", + "kissing_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8", + "kissing_smiling_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8", + "kite": "https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8", + "kiwi_fruit": "https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8", + "kneeling_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8", + "kneeling_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8", + "kneeling_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8", + "knife": "https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8", + "knot": "https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8", + "koala": "https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8", + "koko": "https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8", + "kosovo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8", + "kr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8", + "kuwait": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8", + "kyrgyzstan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8", + "lab_coat": "https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8", + "label": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8", + "lacrosse": "https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8", + "ladder": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8", + "lady_beetle": "https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8", + "lantern": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8", + "laos": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8", + "large_blue_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8", + "large_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8", + "large_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8", + "last_quarter_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8", + "last_quarter_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8", + "latin_cross": "https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8", + "latvia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8", + "laughing": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", + "leafy_green": "https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8", + "leaves": "https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8", + "lebanon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8", + "ledger": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8", + "left_luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8", + "left_right_arrow": "https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8", + "left_speech_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8", + "leftwards_arrow_with_hook": "https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8", + "leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8", + "lemon": "https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8", + "leo": "https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8", + "leopard": "https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8", + "lesotho": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8", + "level_slider": "https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8", + "liberia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8", + "libra": "https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8", + "libya": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8", + "liechtenstein": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8", + "light_rail": "https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8", + "link": "https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8", + "lion": "https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8", + "lips": "https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8", + "lipstick": "https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8", + "lithuania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8", + "lizard": "https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8", + "llama": "https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8", + "lobster": "https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8", + "lock": "https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8", + "lock_with_ink_pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8", + "lollipop": "https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8", + "long_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8", + "loop": "https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8", + "lotion_bottle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8", + "lotus_position": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8", + "lotus_position_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8", + "lotus_position_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8", + "loud_sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8", + "loudspeaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8", + "love_hotel": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8", + "love_letter": "https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8", + "love_you_gesture": "https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8", + "low_brightness": "https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8", + "luggage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8", + "lungs": "https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8", + "luxembourg": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8", + "lying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8", + "m": "https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8", + "macau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8", + "macedonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8", + "madagascar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8", + "mag": "https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8", + "mag_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8", + "mage": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8", + "mage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8", + "mage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8", + "magic_wand": "https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8", + "magnet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8", + "mahjong": "https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8", + "mailbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8", + "mailbox_closed": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8", + "mailbox_with_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8", + "mailbox_with_no_mail": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8", + "malawi": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8", + "malaysia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8", + "maldives": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8", + "male_detective": "https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8", + "male_sign": "https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8", + "mali": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8", + "malta": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8", + "mammoth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8", + "man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8", + "man_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8", + "man_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8", + "man_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8", + "man_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8", + "man_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8", + "man_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8", + "man_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8", + "man_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8", + "man_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8", + "man_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8", + "man_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8", + "man_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8", + "man_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8", + "man_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8", + "man_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8", + "man_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8", + "man_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8", + "man_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8", + "man_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8", + "man_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8", + "man_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8", + "man_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8", + "man_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8", + "man_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8", + "man_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8", + "man_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8", + "man_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8", + "man_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8", + "man_with_gua_pi_mao": "https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8", + "man_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8", + "man_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8", + "man_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8", + "mandarin": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", + "mango": "https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8", + "mans_shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", + "mantelpiece_clock": "https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8", + "manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8", + "maple_leaf": "https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8", + "marshall_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8", + "martial_arts_uniform": "https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8", + "martinique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8", + "mask": "https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8", + "massage": "https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8", + "massage_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8", + "massage_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8", + "mate": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8", + "mauritania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8", + "mauritius": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8", + "mayotte": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8", + "meat_on_bone": "https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8", + "mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8", + "mechanical_arm": "https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8", + "mechanical_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8", + "medal_military": "https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8", + "medal_sports": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8", + "medical_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8", + "mega": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8", + "melon": "https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8", + "memo": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", + "men_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8", + "mending_heart": "https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8", + "menorah": "https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8", + "mens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8", + "mermaid": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8", + "merman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8", + "merperson": "https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8", + "metal": "https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8", + "metro": "https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8", + "mexico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8", + "microbe": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8", + "micronesia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8", + "microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8", + "microscope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8", + "middle_finger": "https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8", + "military_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8", + "milk_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8", + "milky_way": "https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8", + "minibus": "https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8", + "minidisc": "https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8", + "mirror": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8", + "mobile_phone_off": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8", + "moldova": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8", + "monaco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8", + "money_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8", + "money_with_wings": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8", + "moneybag": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8", + "mongolia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8", + "monkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8", + "monkey_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8", + "monocle_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8", + "monorail": "https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8", + "montenegro": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8", + "montserrat": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8", + "moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", + "moon_cake": "https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8", + "morocco": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8", + "mortar_board": "https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8", + "mosque": "https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8", + "mosquito": "https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8", + "motor_boat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8", + "motor_scooter": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8", + "motorcycle": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8", + "motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8", + "motorway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8", + "mount_fuji": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8", + "mountain": "https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8", + "mountain_bicyclist": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8", + "mountain_biking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8", + "mountain_biking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8", + "mountain_cableway": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8", + "mountain_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8", + "mountain_snow": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8", + "mouse": "https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8", + "mouse2": "https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8", + "mouse_trap": "https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8", + "movie_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8", + "moyai": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8", + "mozambique": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8", + "mrs_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8", + "muscle": "https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8", + "mushroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8", + "musical_keyboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8", + "musical_note": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8", + "musical_score": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8", + "mute": "https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8", + "mx_claus": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8", + "myanmar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8", + "nail_care": "https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8", + "name_badge": "https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8", + "namibia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8", + "national_park": "https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8", + "nauru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8", + "nauseated_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8", + "nazar_amulet": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8", + "neckbeard": "https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8", + "necktie": "https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8", + "negative_squared_cross_mark": "https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8", + "nepal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8", + "nerd_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8", + "nesting_dolls": "https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8", + "netherlands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8", + "neutral_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8", + "new": "https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8", + "new_caledonia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8", + "new_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8", + "new_moon_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8", + "new_zealand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8", + "newspaper": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8", + "newspaper_roll": "https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8", + "next_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8", + "ng": "https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8", + "ng_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", + "ng_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", + "nicaragua": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8", + "niger": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8", + "nigeria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8", + "night_with_stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8", + "nine": "https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8", + "ninja": "https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8", + "niue": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8", + "no_bell": "https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8", + "no_bicycles": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8", + "no_entry": "https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8", + "no_entry_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8", + "no_good": "https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8", + "no_good_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8", + "no_good_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8", + "no_mobile_phones": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8", + "no_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8", + "no_pedestrians": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8", + "no_smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8", + "non-potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8", + "norfolk_island": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8", + "north_korea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8", + "northern_mariana_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8", + "norway": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8", + "nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8", + "notebook": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8", + "notebook_with_decorative_cover": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8", + "notes": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8", + "nut_and_bolt": "https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8", + "o": "https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8", + "o2": "https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8", + "ocean": "https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8", + "octocat": "https://github.githubassets.com/images/icons/emoji/octocat.png?v8", + "octopus": "https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8", + "oden": "https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8", + "office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8", + "office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8", + "oil_drum": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8", + "ok": "https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8", + "ok_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8", + "ok_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8", + "ok_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8", + "ok_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8", + "old_key": "https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8", + "older_adult": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8", + "older_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8", + "older_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8", + "olive": "https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8", + "om": "https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8", + "oman": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8", + "on": "https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8", + "oncoming_automobile": "https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8", + "oncoming_bus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8", + "oncoming_police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8", + "oncoming_taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8", + "one": "https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8", + "one_piece_swimsuit": "https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8", + "onion": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8", + "open_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8", + "open_file_folder": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8", + "open_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8", + "open_mouth": "https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8", + "open_umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8", + "ophiuchus": "https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8", + "orange": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", + "orange_book": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8", + "orange_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8", + "orange_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8", + "orange_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8", + "orangutan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8", + "orthodox_cross": "https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8", + "otter": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8", + "outbox_tray": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8", + "owl": "https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8", + "ox": "https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8", + "oyster": "https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8", + "package": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8", + "page_facing_up": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8", + "page_with_curl": "https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8", + "pager": "https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8", + "paintbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8", + "pakistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8", + "palau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8", + "palestinian_territories": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8", + "palm_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8", + "palms_up_together": "https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8", + "panama": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8", + "pancakes": "https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8", + "panda_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8", + "paperclip": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8", + "paperclips": "https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8", + "papua_new_guinea": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8", + "parachute": "https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8", + "paraguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8", + "parasol_on_ground": "https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8", + "parking": "https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8", + "parrot": "https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8", + "part_alternation_mark": "https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8", + "partly_sunny": "https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8", + "partying_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8", + "passenger_ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8", + "passport_control": "https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8", + "pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8", + "paw_prints": "https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8", + "peace_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8", + "peach": "https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8", + "peacock": "https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8", + "peanuts": "https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8", + "pear": "https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8", + "pen": "https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8", + "pencil": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8", + "pencil2": "https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8", + "penguin": "https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8", + "pensive": "https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8", + "people_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8", + "people_hugging": "https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8", + "performing_arts": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8", + "persevere": "https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8", + "person_bald": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8", + "person_curly_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8", + "person_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8", + "person_fencing": "https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8", + "person_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8", + "person_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8", + "person_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8", + "person_red_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8", + "person_white_hair": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8", + "person_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8", + "person_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8", + "person_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8", + "peru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8", + "petri_dish": "https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8", + "philippines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8", + "phone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", + "pick": "https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8", + "pickup_truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8", + "pie": "https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8", + "pig": "https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8", + "pig2": "https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8", + "pig_nose": "https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8", + "pill": "https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8", + "pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8", + "pinata": "https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8", + "pinched_fingers": "https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8", + "pinching_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8", + "pineapple": "https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8", + "ping_pong": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8", + "pirate_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8", + "pisces": "https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8", + "pitcairn_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8", + "pizza": "https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8", + "placard": "https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8", + "place_of_worship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8", + "plate_with_cutlery": "https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8", + "play_or_pause_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8", + "pleading_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8", + "plunger": "https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8", + "point_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8", + "point_left": "https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8", + "point_right": "https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8", + "point_up": "https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8", + "point_up_2": "https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8", + "poland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8", + "polar_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8", + "police_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8", + "police_officer": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8", + "policeman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8", + "policewoman": "https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8", + "poodle": "https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8", + "poop": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8", + "popcorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8", + "portugal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8", + "post_office": "https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8", + "postal_horn": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8", + "postbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8", + "potable_water": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8", + "potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8", + "potted_plant": "https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8", + "pouch": "https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8", + "poultry_leg": "https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8", + "pound": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8", + "pout": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", + "pouting_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8", + "pouting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8", + "pouting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8", + "pouting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8", + "pray": "https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8", + "prayer_beads": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8", + "pregnant_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8", + "pretzel": "https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8", + "previous_track_button": "https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8", + "prince": "https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8", + "princess": "https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8", + "printer": "https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8", + "probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8", + "puerto_rico": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8", + "punch": "https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8", + "purple_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8", + "purple_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8", + "purple_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8", + "purse": "https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8", + "pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8", + "put_litter_in_its_place": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8", + "qatar": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8", + "question": "https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8", + "rabbit": "https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8", + "rabbit2": "https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8", + "raccoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8", + "racehorse": "https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8", + "racing_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8", + "radio": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8", + "radio_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8", + "radioactive": "https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8", + "rage": "https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8", + "rage1": "https://github.githubassets.com/images/icons/emoji/rage1.png?v8", + "rage2": "https://github.githubassets.com/images/icons/emoji/rage2.png?v8", + "rage3": "https://github.githubassets.com/images/icons/emoji/rage3.png?v8", + "rage4": "https://github.githubassets.com/images/icons/emoji/rage4.png?v8", + "railway_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8", + "railway_track": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8", + "rainbow": "https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8", + "rainbow_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8", + "raised_back_of_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8", + "raised_eyebrow": "https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8", + "raised_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8", + "raised_hand_with_fingers_splayed": "https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8", + "raised_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8", + "raising_hand": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8", + "raising_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8", + "raising_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8", + "ram": "https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8", + "ramen": "https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8", + "rat": "https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8", + "razor": "https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8", + "receipt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8", + "record_button": "https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8", + "recycle": "https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8", + "red_car": "https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8", + "red_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8", + "red_envelope": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8", + "red_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8", + "red_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8", + "red_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8", + "registered": "https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8", + "relaxed": "https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8", + "relieved": "https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8", + "reminder_ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8", + "repeat": "https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8", + "repeat_one": "https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8", + "rescue_worker_helmet": "https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8", + "restroom": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8", + "reunion": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8", + "revolving_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8", + "rewind": "https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8", + "rhinoceros": "https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8", + "ribbon": "https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8", + "rice": "https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8", + "rice_ball": "https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8", + "rice_cracker": "https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8", + "rice_scene": "https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8", + "right_anger_bubble": "https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8", + "ring": "https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8", + "ringed_planet": "https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8", + "robot": "https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8", + "rock": "https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8", + "rocket": "https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8", + "rofl": "https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8", + "roll_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8", + "roll_of_paper": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8", + "roller_coaster": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8", + "roller_skate": "https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8", + "romania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8", + "rooster": "https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8", + "rose": "https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8", + "rosette": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8", + "rotating_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8", + "round_pushpin": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8", + "rowboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8", + "rowing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8", + "rowing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8", + "ru": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8", + "rugby_football": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8", + "runner": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", + "running": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8", + "running_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8", + "running_shirt_with_sash": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8", + "running_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8", + "rwanda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8", + "sa": "https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8", + "safety_pin": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8", + "safety_vest": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8", + "sagittarius": "https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8", + "sailboat": "https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8", + "sake": "https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8", + "salt": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8", + "samoa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8", + "san_marino": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8", + "sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8", + "sandwich": "https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8", + "santa": "https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8", + "sao_tome_principe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8", + "sari": "https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8", + "sassy_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", + "sassy_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", + "satellite": "https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8", + "satisfied": "https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8", + "saudi_arabia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8", + "sauna_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8", + "sauna_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8", + "sauna_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8", + "sauropod": "https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8", + "saxophone": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8", + "scarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8", + "school": "https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8", + "school_satchel": "https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8", + "scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8", + "scissors": "https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8", + "scorpion": "https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8", + "scorpius": "https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8", + "scotland": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8", + "scream": "https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8", + "scream_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8", + "screwdriver": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8", + "scroll": "https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8", + "seal": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8", + "seat": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8", + "secret": "https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8", + "see_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8", + "seedling": "https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8", + "selfie": "https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8", + "senegal": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8", + "serbia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8", + "service_dog": "https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8", + "seven": "https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8", + "sewing_needle": "https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8", + "seychelles": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8", + "shallow_pan_of_food": "https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8", + "shamrock": "https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8", + "shark": "https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8", + "shaved_ice": "https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8", + "sheep": "https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8", + "shell": "https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8", + "shield": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8", + "shinto_shrine": "https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8", + "ship": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8", + "shipit": "https://github.githubassets.com/images/icons/emoji/shipit.png?v8", + "shirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", + "shoe": "https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8", + "shopping": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8", + "shopping_cart": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8", + "shorts": "https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8", + "shower": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8", + "shrimp": "https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8", + "shrug": "https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8", + "shushing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8", + "sierra_leone": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8", + "signal_strength": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8", + "singapore": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8", + "singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8", + "sint_maarten": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8", + "six": "https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8", + "six_pointed_star": "https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8", + "skateboard": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8", + "ski": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8", + "skier": "https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8", + "skull": "https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8", + "skull_and_crossbones": "https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8", + "skunk": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8", + "sled": "https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8", + "sleeping": "https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8", + "sleeping_bed": "https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8", + "sleepy": "https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8", + "slightly_frowning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8", + "slightly_smiling_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8", + "slot_machine": "https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8", + "sloth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8", + "slovakia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8", + "slovenia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8", + "small_airplane": "https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8", + "small_blue_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8", + "small_orange_diamond": "https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8", + "small_red_triangle": "https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8", + "small_red_triangle_down": "https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8", + "smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8", + "smile_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8", + "smiley": "https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8", + "smiley_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8", + "smiling_face_with_tear": "https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8", + "smiling_face_with_three_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8", + "smiling_imp": "https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8", + "smirk": "https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8", + "smirk_cat": "https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8", + "smoking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8", + "snail": "https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8", + "snake": "https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8", + "sneezing_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8", + "snowboarder": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8", + "snowflake": "https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8", + "snowman": "https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8", + "snowman_with_snow": "https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8", + "soap": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8", + "sob": "https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8", + "soccer": "https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8", + "socks": "https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8", + "softball": "https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8", + "solomon_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8", + "somalia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8", + "soon": "https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8", + "sos": "https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8", + "sound": "https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8", + "south_africa": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8", + "south_georgia_south_sandwich_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8", + "south_sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8", + "space_invader": "https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8", + "spades": "https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8", + "spaghetti": "https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8", + "sparkle": "https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8", + "sparkler": "https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8", + "sparkles": "https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8", + "sparkling_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8", + "speak_no_evil": "https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8", + "speaker": "https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8", + "speaking_head": "https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8", + "speech_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8", + "speedboat": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8", + "spider": "https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8", + "spider_web": "https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8", + "spiral_calendar": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8", + "spiral_notepad": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8", + "sponge": "https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8", + "spoon": "https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8", + "squid": "https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8", + "sri_lanka": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8", + "st_barthelemy": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8", + "st_helena": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8", + "st_kitts_nevis": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8", + "st_lucia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8", + "st_martin": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8", + "st_pierre_miquelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8", + "st_vincent_grenadines": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8", + "stadium": "https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8", + "standing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8", + "standing_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8", + "standing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8", + "star": "https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8", + "star2": "https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8", + "star_and_crescent": "https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8", + "star_of_david": "https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8", + "star_struck": "https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8", + "stars": "https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8", + "station": "https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8", + "statue_of_liberty": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8", + "steam_locomotive": "https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8", + "stethoscope": "https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8", + "stew": "https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8", + "stop_button": "https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8", + "stop_sign": "https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8", + "stopwatch": "https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8", + "straight_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8", + "strawberry": "https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8", + "stuck_out_tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8", + "stuck_out_tongue_closed_eyes": "https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8", + "stuck_out_tongue_winking_eye": "https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8", + "student": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8", + "studio_microphone": "https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8", + "stuffed_flatbread": "https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8", + "sudan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8", + "sun_behind_large_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8", + "sun_behind_rain_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8", + "sun_behind_small_cloud": "https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8", + "sun_with_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8", + "sunflower": "https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8", + "sunglasses": "https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8", + "sunny": "https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8", + "sunrise": "https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8", + "sunrise_over_mountains": "https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8", + "superhero": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8", + "superhero_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8", + "superhero_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8", + "supervillain": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8", + "supervillain_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8", + "supervillain_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8", + "surfer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8", + "surfing_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8", + "surfing_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8", + "suriname": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8", + "sushi": "https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8", + "suspect": "https://github.githubassets.com/images/icons/emoji/suspect.png?v8", + "suspension_railway": "https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8", + "svalbard_jan_mayen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8", + "swan": "https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8", + "swaziland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8", + "sweat": "https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8", + "sweat_drops": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8", + "sweat_smile": "https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8", + "sweden": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8", + "sweet_potato": "https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8", + "swim_brief": "https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8", + "swimmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8", + "swimming_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8", + "swimming_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8", + "switzerland": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8", + "symbols": "https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8", + "synagogue": "https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8", + "syria": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8", + "syringe": "https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8", + "t-rex": "https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8", + "taco": "https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8", + "tada": "https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8", + "taiwan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8", + "tajikistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8", + "takeout_box": "https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8", + "tamale": "https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8", + "tanabata_tree": "https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8", + "tangerine": "https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8", + "tanzania": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8", + "taurus": "https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8", + "taxi": "https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8", + "tea": "https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8", + "teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8", + "teapot": "https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8", + "technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8", + "teddy_bear": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8", + "telephone": "https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8", + "telephone_receiver": "https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8", + "telescope": "https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8", + "tennis": "https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8", + "tent": "https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8", + "test_tube": "https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8", + "thailand": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8", + "thermometer": "https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8", + "thinking": "https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8", + "thong_sandal": "https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8", + "thought_balloon": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8", + "thread": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8", + "three": "https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8", + "thumbsdown": "https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8", + "thumbsup": "https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8", + "ticket": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8", + "tickets": "https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8", + "tiger": "https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8", + "tiger2": "https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8", + "timer_clock": "https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8", + "timor_leste": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8", + "tipping_hand_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8", + "tipping_hand_person": "https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8", + "tipping_hand_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8", + "tired_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8", + "tm": "https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8", + "togo": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8", + "toilet": "https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8", + "tokelau": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8", + "tokyo_tower": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8", + "tomato": "https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8", + "tonga": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8", + "tongue": "https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8", + "toolbox": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8", + "tooth": "https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8", + "toothbrush": "https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8", + "top": "https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8", + "tophat": "https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8", + "tornado": "https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8", + "tr": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8", + "trackball": "https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8", + "tractor": "https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8", + "traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8", + "train": "https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8", + "train2": "https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8", + "tram": "https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8", + "transgender_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8", + "transgender_symbol": "https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8", + "triangular_flag_on_post": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8", + "triangular_ruler": "https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8", + "trident": "https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8", + "trinidad_tobago": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8", + "tristan_da_cunha": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8", + "triumph": "https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8", + "trolleybus": "https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8", + "trollface": "https://github.githubassets.com/images/icons/emoji/trollface.png?v8", + "trophy": "https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8", + "tropical_drink": "https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8", + "tropical_fish": "https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8", + "truck": "https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8", + "trumpet": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8", + "tshirt": "https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8", + "tulip": "https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8", + "tumbler_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8", + "tunisia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8", + "turkey": "https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8", + "turkmenistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8", + "turks_caicos_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8", + "turtle": "https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8", + "tuvalu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8", + "tv": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8", + "twisted_rightwards_arrows": "https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8", + "two": "https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8", + "two_hearts": "https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8", + "two_men_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8", + "two_women_holding_hands": "https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8", + "u5272": "https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8", + "u5408": "https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8", + "u55b6": "https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8", + "u6307": "https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8", + "u6708": "https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8", + "u6709": "https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8", + "u6e80": "https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8", + "u7121": "https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8", + "u7533": "https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8", + "u7981": "https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8", + "u7a7a": "https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8", + "uganda": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8", + "uk": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8", + "ukraine": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8", + "umbrella": "https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8", + "unamused": "https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8", + "underage": "https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8", + "unicorn": "https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8", + "united_arab_emirates": "https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8", + "united_nations": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8", + "unlock": "https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8", + "up": "https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8", + "upside_down_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8", + "uruguay": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8", + "us": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8", + "us_outlying_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8", + "us_virgin_islands": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8", + "uzbekistan": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8", + "v": "https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8", + "vampire": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8", + "vampire_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8", + "vampire_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8", + "vanuatu": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8", + "vatican_city": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8", + "venezuela": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8", + "vertical_traffic_light": "https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8", + "vhs": "https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8", + "vibration_mode": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8", + "video_camera": "https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8", + "video_game": "https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8", + "vietnam": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8", + "violin": "https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8", + "virgo": "https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8", + "volcano": "https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8", + "volleyball": "https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8", + "vomiting_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8", + "vs": "https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8", + "vulcan_salute": "https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8", + "waffle": "https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8", + "wales": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8", + "walking": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8", + "walking_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8", + "walking_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8", + "wallis_futuna": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8", + "waning_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8", + "waning_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8", + "warning": "https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8", + "wastebasket": "https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8", + "watch": "https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8", + "water_buffalo": "https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8", + "water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8", + "watermelon": "https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8", + "wave": "https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8", + "wavy_dash": "https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8", + "waxing_crescent_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8", + "waxing_gibbous_moon": "https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8", + "wc": "https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8", + "weary": "https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8", + "wedding": "https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8", + "weight_lifting": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8", + "weight_lifting_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8", + "weight_lifting_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8", + "western_sahara": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8", + "whale": "https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8", + "whale2": "https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8", + "wheel_of_dharma": "https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8", + "wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8", + "white_check_mark": "https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8", + "white_circle": "https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8", + "white_flag": "https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8", + "white_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8", + "white_haired_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8", + "white_haired_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8", + "white_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8", + "white_large_square": "https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8", + "white_medium_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8", + "white_medium_square": "https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8", + "white_small_square": "https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8", + "white_square_button": "https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8", + "wilted_flower": "https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8", + "wind_chime": "https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8", + "wind_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8", + "window": "https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8", + "wine_glass": "https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8", + "wink": "https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8", + "wolf": "https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8", + "woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8", + "woman_artist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8", + "woman_astronaut": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8", + "woman_beard": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8", + "woman_cartwheeling": "https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8", + "woman_cook": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8", + "woman_dancing": "https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8", + "woman_facepalming": "https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8", + "woman_factory_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8", + "woman_farmer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8", + "woman_feeding_baby": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8", + "woman_firefighter": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8", + "woman_health_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8", + "woman_in_manual_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8", + "woman_in_motorized_wheelchair": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8", + "woman_in_tuxedo": "https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8", + "woman_judge": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8", + "woman_juggling": "https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8", + "woman_mechanic": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8", + "woman_office_worker": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8", + "woman_pilot": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8", + "woman_playing_handball": "https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8", + "woman_playing_water_polo": "https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8", + "woman_scientist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8", + "woman_shrugging": "https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8", + "woman_singer": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8", + "woman_student": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8", + "woman_teacher": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8", + "woman_technologist": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8", + "woman_with_headscarf": "https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8", + "woman_with_probing_cane": "https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8", + "woman_with_turban": "https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8", + "woman_with_veil": "https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8", + "womans_clothes": "https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8", + "womans_hat": "https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8", + "women_wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8", + "womens": "https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8", + "wood": "https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8", + "woozy_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8", + "world_map": "https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8", + "worm": "https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8", + "worried": "https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8", + "wrench": "https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8", + "wrestling": "https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8", + "writing_hand": "https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8", + "x": "https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8", + "yarn": "https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8", + "yawning_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8", + "yellow_circle": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8", + "yellow_heart": "https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8", + "yellow_square": "https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8", + "yemen": "https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8", + "yen": "https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8", + "yin_yang": "https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8", + "yo_yo": "https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8", + "yum": "https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8", + "zambia": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8", + "zany_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8", + "zap": "https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8", + "zebra": "https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8", + "zero": "https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8", + "zimbabwe": "https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8", + "zipper_mouth_face": "https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8", + "zombie": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8", + "zombie_man": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8", + "zombie_woman": "https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8", + "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" + } + }, + "actions-cache-retention-limit": { + "value": { + "max_cache_retention_days": 80 + } + }, + "actions-cache-storage-limit": { + "value": { + "max_cache_size_gb": 150 + } + }, + "oidc-custom-property-inclusion": { + "value": { + "custom_property_name": "environment" + } + }, + "enterprise-code-security-configuration-list": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + }, + "enterprise-code-security-configuration": { + "value": { + "id": 1325, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "code-security-default-configurations": { + "value": [ + { + "default_for_new_repos": "public", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + { + "default_for_new_repos": "private_and_internal", + "configuration": { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + } + } + ] + }, + "code-security-configuration": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "enabled", + "secret_scanning_delegated_bypass_options": { + "reviewers": [ + { + "security_configuration_id": 1325, + "reviewer_id": 5678, + "reviewer_type": "TEAM" + } + ] + }, + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "simple-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + "copilot-usage-metrics-1-day-report": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + }, + "copilot-usage-metrics-28-day-report": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } + }, + "dependabot-alerts-for-organization": { + "value": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2", + "html_url": "https://github.com/octo-org/octo-repo/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}" + } + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octo-org/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [], + "repository": { + "id": 664700648, + "node_id": "MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=", + "name": "hello-world", + "full_name": "octo-org/hello-world", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/hello-world", + "archive_url": "https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/hello-world/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/hello-world/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/hello-world/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/hello-world/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/hello-world/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/hello-world/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/hello-world/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/hello-world/downloads", + "events_url": "https://api.github.com/repos/octo-org/hello-world/events", + "forks_url": "https://api.github.com/repos/octo-org/hello-world/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/hello-world/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/hello-world/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/hello-world/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/hello-world/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/hello-world/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/hello-world/languages", + "merges_url": "https://api.github.com/repos/octo-org/hello-world/merges", + "milestones_url": "https://api.github.com/repos/octo-org/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/hello-world/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/hello-world/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/hello-world/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/hello-world/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/hello-world/subscription", + "tags_url": "https://api.github.com/repos/octo-org/hello-world/tags", + "teams_url": "https://api.github.com/repos/octo-org/hello-world/teams", + "trees_url": "https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}" + } + } + ] + }, + "enterprise-teams-items": { + "value": [ + { + "id": 1, + "name": "Justice League", + "description": "A great team.", + "slug": "justice-league", + "url": "https://api.github.com/enterprises/dc/teams/justice-league", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", + "html_url": "https://github.com/enterprises/dc/teams/justice-league", + "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", + "created_at": "2019-01-26T19:01:12Z", + "updated_at": "2019-01-26T19:14:43Z" + } + ] + }, + "enterprise-teams-item": { + "value": { + "id": 1, + "name": "Justice League", + "description": "A great team.", + "slug": "justice-league", + "url": "https://api.github.com/enterprises/dc/teams/justice-league", + "group_id": "62ab9291-fae2-468e-974b-7e45096d5021", + "html_url": "https://github.com/enterprises/dc/teams/justice-league", + "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}", + "created_at": "2019-01-26T19:01:12Z", + "updated_at": "2019-01-26T19:14:43Z" + } + }, + "simple-user-items": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + }, + "simple-user": { + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "organization-simple": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + }, + "organization-simple-items": { + "value": [ + { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + }, + "public-events-items": { + "value": [ + { + "id": "22249084947", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-07T07:50:26Z" + } + ] + }, + "feed": { + "value": { + "timeline_url": "https://github.com/timeline", + "user_url": "https://github.com/{user}", + "current_user_public_url": "https://github.com/octocat", + "current_user_url": "https://github.com/octocat.private?token=abc123", + "current_user_actor_url": "https://github.com/octocat.private.actor?token=abc123", + "current_user_organization_url": "", + "current_user_organization_urls": [ + "https://github.com/organizations/github/octocat.private.atom?token=abc123" + ], + "security_advisories_url": "https://github.com/security-advisories", + "_links": { + "timeline": { + "href": "https://github.com/timeline", + "type": "application/atom+xml" + }, + "user": { + "href": "https://github.com/{user}", + "type": "application/atom+xml" + }, + "current_user_public": { + "href": "https://github.com/octocat", + "type": "application/atom+xml" + }, + "current_user": { + "href": "https://github.com/octocat.private?token=abc123", + "type": "application/atom+xml" + }, + "current_user_actor": { + "href": "https://github.com/octocat.private.actor?token=abc123", + "type": "application/atom+xml" + }, + "current_user_organization": { + "href": "", + "type": "" + }, + "current_user_organizations": [ + { + "href": "https://github.com/organizations/github/octocat.private.atom?token=abc123", + "type": "application/atom+xml" + } + ], + "security_advisories": { + "href": "https://github.com/security-advisories", + "type": "application/atom+xml" + } + } + } + }, + "base-gist-items": { + "value": [ + { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 0, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "truncated": false + } + ] + }, + "gist": { + "value": { + "url": "https://api.github.com/gists/2decf6c462d9b4418f2", + "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", + "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", + "id": "2decf6c462d9b4418f2", + "node_id": "G_kwDOBhHyLdZDliNDQxOGYy", + "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", + "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", + "html_url": "https://gist.github.com/2decf6c462d9b4418f2", + "files": { + "README.md": { + "filename": "README.md", + "type": "text/markdown", + "language": "Markdown", + "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", + "size": 23, + "truncated": false, + "content": "Hello world from GitHub", + "encoding": "utf-8" + } + }, + "public": true, + "created_at": "2022-09-20T12:11:58Z", + "updated_at": "2022-09-21T10:28:06Z", + "description": "An updated gist description.", + "comments": 0, + "comments_enabled": true, + "user": null, + "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", + "owner": { + "login": "monalisa", + "id": 104456405, + "node_id": "U_kgDOBhHyLQ", + "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "forks": [], + "history": [ + { + "user": { + "login": "monalisa", + "id": 104456405, + "node_id": "U_kgyLQ", + "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "version": "468aac8caed5f0c3b859b8286968", + "committed_at": "2022-09-21T10:28:06Z", + "change_status": { + "total": 2, + "additions": 1, + "deletions": 1 + }, + "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" + } + ], + "truncated": false + } + }, + "delete-gist-file": { + "value": { + "url": "https://api.github.com/gists/2decf6c462d9b4418f2", + "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", + "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", + "id": "2decf6c462d9b4418f2", + "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy", + "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", + "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", + "html_url": "https://gist.github.com/2decf6c462d9b4418f2", + "files": null, + "public": true, + "created_at": "2022-09-20T12:11:58Z", + "updated_at": "2022-09-21T10:28:06Z", + "description": "A gist description.", + "comments": 0, + "user": null, + "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", + "owner": { + "login": "monalisa", + "id": 104456405, + "node_id": "U_kgDOBhHyLQ", + "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "forks": [], + "history": [ + { + "user": { + "login": "monalisa", + "id": 104456405, + "node_id": "U_kgyLQ", + "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "version": "9cc352a89178a6d4", + "committed_at": "2022-09-21T10:28:06Z", + "change_status": { + "total": 1, + "additions": 0, + "deletions": 1 + }, + "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" + } + ], + "truncated": false + } + }, + "rename-gist-file": { + "value": { + "url": "https://api.github.com/gists/2decf6c462d9b4418f2", + "forks_url": "https://api.github.com/gists/2decf6c462d9b4418f2/forks", + "commits_url": "https://api.github.com/gists/2decf6c462d9b4418f2/commits", + "id": "2decf6c462d9b4418f2", + "node_id": "G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy", + "git_pull_url": "https://gist.github.com/2decf6c462d9b4418f2.git", + "git_push_url": "https://gist.github.com/2decf6c462d9b4418f2.git", + "html_url": "https://gist.github.com/2decf6c462d9b4418f2", + "files": { + "goodbye.py": { + "filename": "goodbye.py", + "type": "application/x-python", + "language": "Python", + "raw_url": "https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py", + "size": 4, + "truncated": false, + "content": "# Hello world" + } + }, + "public": true, + "created_at": "2022-09-20T12:11:58Z", + "updated_at": "2022-09-21T10:28:06Z", + "description": "A gist description.", + "comments": 0, + "user": null, + "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", + "owner": { + "login": "monalisa", + "id": 104456405, + "node_id": "U_kgDOBhHyLQ", + "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "forks": [], + "history": [ + { + "user": { + "login": "monalisa", + "id": 104456405, + "node_id": "U_kgyLQ", + "avatar_url": "https://avatars.githubusercontent.com/u/104456405?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "version": "468aac8caed5f0c3b859b8286968", + "committed_at": "2022-09-21T10:28:06Z", + "change_status": { + "total": 0, + "additions": 0, + "deletions": 0 + }, + "url": "https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968" + } + ], + "truncated": false + } + }, + "gist-comment-items": { + "value": [ + { + "id": 1, + "node_id": "MDExOkdpc3RDb21tZW50MQ==", + "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", + "body": "Just commenting for the sake of commenting", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-18T23:23:56Z", + "updated_at": "2011-04-18T23:23:56Z", + "author_association": "COLLABORATOR" + } + ] + }, + "gist-comment": { + "value": { + "id": 1, + "node_id": "MDExOkdpc3RDb21tZW50MQ==", + "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", + "body": "Just commenting for the sake of commenting", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-18T23:23:56Z", + "updated_at": "2011-04-18T23:23:56Z", + "author_association": "COLLABORATOR" + } + }, + "gist-commit-items": { + "value": [ + { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f", + "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "change_status": { + "deletions": 0, + "additions": 180, + "total": 180 + }, + "committed_at": "2010-04-14T02:15:15Z" + } + ] + }, + "gist-fork-items": { + "value": [ + { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 1, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "base-gist": { + "value": { + "url": "https://api.github.com/gists/aa5a315d61ae9438b18d", + "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks", + "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits", + "id": "aa5a315d61ae9438b18d", + "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk", + "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git", + "html_url": "https://gist.github.com/aa5a315d61ae9438b18d", + "files": { + "hello_world.rb": { + "filename": "hello_world.rb", + "type": "application/x-ruby", + "language": "Ruby", + "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb", + "size": 167 + } + }, + "public": true, + "created_at": "2010-04-14T02:15:15Z", + "updated_at": "2011-06-20T11:34:15Z", + "description": "Hello World Examples", + "comments": 0, + "user": null, + "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "truncated": false + } + }, + "gitignore-template": { + "value": { + "name": "C", + "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n" + } + }, + "repository-paginated-2": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "issue-with-repo-items": { + "value": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pinned_comment": null, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "COLLABORATOR" + } + ] + }, + "license-simple-items": { + "value": [ + { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "lgpl-3.0", + "name": "GNU Lesser General Public License v3.0", + "spdx_id": "LGPL-3.0", + "url": "https://api.github.com/licenses/lgpl-3.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "mpl-2.0", + "name": "Mozilla Public License 2.0", + "spdx_id": "MPL-2.0", + "url": "https://api.github.com/licenses/mpl-2.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "agpl-3.0", + "name": "GNU Affero General Public License v3.0", + "spdx_id": "AGPL-3.0", + "url": "https://api.github.com/licenses/agpl-3.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "unlicense", + "name": "The Unlicense", + "spdx_id": "Unlicense", + "url": "https://api.github.com/licenses/unlicense", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "apache-2.0", + "name": "Apache License 2.0", + "spdx_id": "Apache-2.0", + "url": "https://api.github.com/licenses/apache-2.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + { + "key": "gpl-3.0", + "name": "GNU General Public License v3.0", + "spdx_id": "GPL-3.0", + "url": "https://api.github.com/licenses/gpl-3.0", + "node_id": "MDc6TGljZW5zZW1pdA==" + } + ] + }, + "license": { + "value": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "http://choosealicense.com/licenses/mit/", + "description": "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.", + "implementation": "Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.", + "permissions": [ + "commercial-use", + "modifications", + "distribution", + "sublicense", + "private-use" + ], + "conditions": [ + "include-copyright" + ], + "limitations": [ + "no-liability" + ], + "body": "\n\nThe MIT License (MIT)\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n", + "featured": true + } + }, + "marketplace-purchase": { + "value": { + "url": "https://api.github.com/orgs/github", + "type": "Organization", + "id": 4, + "login": "github", + "organization_billing_email": "billing@github.com", + "email": "billing@github.com", + "marketplace_pending_change": { + "effective_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "id": 77, + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1111", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", + "id": 1111, + "number": 2, + "name": "Startup", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 699, + "yearly_price_in_cents": 7870, + "price_model": "FLAT_RATE", + "has_free_trial": true, + "state": "published", + "unit_name": null, + "bullets": [ + "Up to 10 private repositories", + "3 concurrent builds" + ] + } + }, + "marketplace_purchase": { + "billing_cycle": "monthly", + "next_billing_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "on_free_trial": true, + "free_trial_ends_on": "2017-11-11T00:00:00Z", + "updated_at": "2017-11-02T01:12:12Z", + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "FLAT_RATE", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + } + } + }, + "marketplace-listing-plan-items": { + "value": [ + { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "FLAT_RATE", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + ] + }, + "marketplace-purchase-items": { + "value": [ + { + "url": "https://api.github.com/orgs/github", + "type": "Organization", + "id": 4, + "login": "github", + "organization_billing_email": "billing@github.com", + "marketplace_pending_change": { + "effective_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "id": 77, + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1111", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts", + "id": 1111, + "number": 2, + "name": "Startup", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 699, + "yearly_price_in_cents": 7870, + "price_model": "FLAT_RATE", + "has_free_trial": true, + "state": "published", + "unit_name": null, + "bullets": [ + "Up to 10 private repositories", + "3 concurrent builds" + ] + } + }, + "marketplace_purchase": { + "billing_cycle": "monthly", + "next_billing_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "on_free_trial": true, + "free_trial_ends_on": "2017-11-11T00:00:00Z", + "updated_at": "2017-11-02T01:12:12Z", + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "FLAT_RATE", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + } + } + ] + }, + "api-overview": { + "value": { + "verifiable_password_authentication": true, + "ssh_key_fingerprints": { + "SHA256_RSA": 1234567890, + "SHA256_DSA": 1234567890, + "SHA256_ECDSA": 1234567890, + "SHA256_ED25519": 1234567890 + }, + "ssh_keys": [ + "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ", + "ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ", + "ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ" + ], + "hooks": [ + "192.0.2.1" + ], + "github_enterprise_importer": [ + "192.0.2.1" + ], + "web": [ + "192.0.2.1" + ], + "api": [ + "192.0.2.1" + ], + "git": [ + "192.0.2.1" + ], + "packages": [ + "192.0.2.1" + ], + "pages": [ + "192.0.2.1" + ], + "importer": [ + "192.0.2.1" + ], + "actions": [ + "192.0.2.1" + ], + "actions_macos": [ + "192.0.2.1" + ], + "dependabot": [ + "192.0.2.1" + ], + "copilot": [ + "192.0.2.1" + ], + "domains": { + "website": [ + "*.example.com" + ], + "codespaces": [ + "*.example.com" + ], + "copilot": [ + "*.example.com" + ], + "packages": [ + "*.example.com" + ] + } + } + }, + "public-repo-events-items": { + "value": [ + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22237752260", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z" + } + ] + }, + "thread-items": { + "value": [ + { + "id": "1", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "subject": { + "title": "Greetings", + "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", + "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", + "type": "Issue" + }, + "reason": "subscribed", + "unread": true, + "updated_at": "2014-11-07T22:01:45Z", + "last_read_at": "2014-11-07T22:01:45Z", + "url": "https://api.github.com/notifications/threads/1", + "subscription_url": "https://api.github.com/notifications/threads/1/subscription" + } + ] + }, + "notifications-mark-read": { + "value": { + "message": "Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background." + } + }, + "thread": { + "value": { + "id": "1", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "subject": { + "title": "Greetings", + "url": "https://api.github.com/repos/octokit/octokit.rb/issues/123", + "latest_comment_url": "https://api.github.com/repos/octokit/octokit.rb/issues/comments/123", + "type": "Issue" + }, + "reason": "subscribed", + "unread": true, + "updated_at": "2014-11-07T22:01:45Z", + "last_read_at": "2014-11-07T22:01:45Z", + "url": "https://api.github.com/notifications/threads/1", + "subscription_url": "https://api.github.com/notifications/threads/1/subscription" + } + }, + "thread-subscription": { + "value": { + "subscribed": true, + "ignored": false, + "reason": null, + "created_at": "2012-10-06T21:34:12Z", + "url": "https://api.github.com/notifications/threads/1/subscription", + "thread_url": "https://api.github.com/notifications/threads/1" + } + }, + "octocat": { + "value": " MMM. .MMM\n MMMMMMMMMMMMMMMMMMM\n MMMMMMMMMMMMMMMMMMM ___________________________________\n MMMMMMMMMMMMMMMMMMMMM | |\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\n MMMM::- -:::::::- -::MMMM |/\n MM~:~ 00~:::::~ 00~:~MM\n .. MMMMM::.00:::+:::.00::MMMMM ..\n .MM::::: ._. :::::MM.\n MMMM;:::::;MMMM\n -MM MMMMMMM\n ^ M+ MMMMMMMMM\n MMMMMMM MM MM MM\n MM MM MM MM\n MM MM MM MM\n .~~MM~MM~MM~MM~~.\n ~~~~MM:~MM~~~MM~:MM~~~~\n ~~~~~~==~==~~~==~==~~~~~~\n ~~~~~~==~==~==~==~~~~~~\n :~==~==~==~==~~\n" + }, + "dependabot-repository-access-details": { + "value": { + "default_level": "public", + "accessible_repositories": [ + { + "id": 123456, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjM0NTY=", + "name": "example-repo", + "full_name": "octocat/example-repo", + "owner": { + "name": "octocat", + "email": "octo@github.com", + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://avatars.githubusercontent.com/u/1?v=4", + "gravatar_id": 1, + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat/example-repo", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "starred_at": "\"2020-07-09T00:17:55Z\"", + "user_view_type": "default" + }, + "private": false, + "html_url": "https://github.com/octocat/example-repo", + "description": "This is an example repository.", + "fork": false, + "url": "https://api.github.com/repos/octocat/example-repo", + "archive_url": "https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/example-repo/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/example-repo/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/example-repo/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/example-repo/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/example-repo/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/example-repo/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/example-repo/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/example-repo/contributors", + "deployments_url": "https://api.github.com/repos/octocat/example-repo/deployments", + "downloads_url": "https://api.github.com/repos/octocat/example-repo/downloads", + "events_url": "https://api.github.com/repos/octocat/example-repo/events", + "forks_url": "https://api.github.com/repos/octocat/example-repo/forks", + "git_commits_url": "https://api.github.com/repos/octocat/example-repo/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/example-repo/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/example-repo/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/example-repo/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/example-repo/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/example-repo/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/example-repo/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/example-repo/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/example-repo/languages", + "merges_url": "https://api.github.com/repos/octocat/example-repo/merges", + "milestones_url": "https://api.github.com/repos/octocat/example-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/example-repo/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/example-repo/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/example-repo/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/example-repo/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/example-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/example-repo/subscription", + "tags_url": "https://api.github.com/repos/octocat/example-repo/tags", + "teams_url": "https://api.github.com/repos/octocat/example-repo/teams", + "trees_url": "https://api.github.com/repos/octocat/example-repo/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/example-repo/hooks" + } + ] + } + }, + "get_all_budgets": { + "value": { + "budgets": [ + { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "actions" + ], + "budget_scope": "enterprise", + "budget_amount": 1000.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "enterprise-admin", + "billing-manager" + ] + } + }, + { + "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + "budget_type": "SkuPricing", + "budget_product_skus": [ + "actions_linux" + ], + "budget_scope": "organization", + "budget_amount": 500.0, + "prevent_further_usage": false, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "org-owner" + ] + } + }, + { + "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8", + "budget_type": "ProductPricing", + "budget_product_skus": [ + "packages" + ], + "budget_scope": "cost_center", + "budget_amount": 250.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + ], + "has_next_page": false, + "total_count": 3 + } + }, + "get-budget": { + "value": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, + "delete-budget": { + "value": { + "message": "Budget successfully deleted.", + "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + } + }, + "billing-premium-request-usage-report-org": { + "value": { + "timePeriod": { + "year": 2025 + }, + "organization": "GitHub", + "usageItems": [ + { + "product": "Copilot", + "sku": "Copilot Premium Request", + "model": "GPT-5", + "unitType": "requests", + "pricePerUnit": 0.04, + "grossQuantity": 100, + "grossAmount": 4.0, + "discountQuantity": 0, + "discountAmount": 0.0, + "netQuantity": 100, + "netAmount": 4.0 + } + ] + } + }, + "billing-usage-report": { + "value": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "organizationName": "GitHub", + "repositoryName": "github/example" + } + ] + } + }, + "billing-usage-summary-report-org": { + "value": { + "timePeriod": { + "year": 2025 + }, + "organization": "GitHub", + "usageItems": [ + { + "product": "Actions", + "sku": "actions_linux", + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossQuantity": 1000, + "grossAmount": 8.0, + "discountQuantity": 0, + "discountAmount": 0.0, + "netQuantity": 1000, + "netAmount": 8.0 + } + ] + } + }, + "organization-full": { + "value": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "twitter_username": "github", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "type": "Organization", + "total_private_repos": 100, + "owned_private_repos": 100, + "private_gists": 81, + "disk_usage": 10000, + "collaborators": 8, + "billing_email": "mona@github.com", + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "filled_seats": 4, + "seats": 5 + }, + "default_repository_permission": "read", + "default_repository_branch": "main", + "members_can_create_repositories": true, + "two_factor_requirement_enabled": true, + "members_allowed_repository_creation_type": "all", + "members_can_create_public_repositories": false, + "members_can_create_private_repositories": false, + "members_can_create_internal_repositories": false, + "members_can_create_pages": true, + "members_can_create_public_pages": true, + "members_can_create_private_pages": true, + "members_can_delete_repositories": true, + "members_can_change_repo_visibility": true, + "members_can_invite_outside_collaborators": true, + "members_can_delete_issues": false, + "display_commenter_full_name_setting_enabled": false, + "readers_can_create_discussions": true, + "members_can_create_teams": true, + "members_can_view_dependency_insights": true, + "members_can_fork_private_repositories": false, + "web_commit_signoff_required": false, + "updated_at": "2014-03-03T18:58:10Z", + "deploy_keys_enabled_for_repositories": false, + "dependency_graph_enabled_for_new_repositories": false, + "dependabot_alerts_enabled_for_new_repositories": false, + "dependabot_security_updates_enabled_for_new_repositories": false, + "advanced_security_enabled_for_new_repositories": false, + "secret_scanning_enabled_for_new_repositories": false, + "secret_scanning_push_protection_enabled_for_new_repositories": false, + "secret_scanning_push_protection_custom_link": "https://github.com/octo-org/octo-repo/blob/main/im-blocked.md", + "secret_scanning_push_protection_custom_link_enabled": false + }, + "x-github-breaking-changes": [ + { + "changeset": "remove_secret_scanning_custom_link_enablement_field", + "patch": [ + { + "op": "remove", + "path": "/value/secret_scanning_push_protection_custom_link_enabled" + } + ], + "version": "2026-03-10" + } + ] + }, + "actions-cache-usage-org-enterprise": { + "value": { + "total_active_caches_size_in_bytes": 3344284, + "total_active_caches_count": 5 + } + }, + "org-actions-cache-usage-by-repo": { + "value": { + "total_count": 2, + "repository_cache_usages": [ + { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + }, + { + "full_name": "octo-org/server", + "active_caches_size_in_bytes": 1022142, + "active_caches_count": 2 + } + ] + } + }, + "actions-hosted-runner-paginated": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + }, + { + "id": 7, + "name": "My hosted Windows runner", + "runner_group_id": 2, + "platform": "win-x64", + "image": { + "id": "windows-latest", + "size": 256 + }, + "machine_size_details": { + "id": "8-core", + "cpu_cores": 8, + "memory_gb": 32, + "storage_gb": 300 + }, + "status": "Ready", + "maximum_runners": 20, + "public_ip_enabled": false, + "public_ips": [], + "last_active_on": "2023-04-26T15:23:37Z" + } + ] + } + }, + "actions-hosted-runner": { + "value": { + "id": 5, + "name": "My hosted ubuntu runner", + "runner_group_id": 2, + "platform": "linux-x64", + "image": { + "id": "ubuntu-20.04", + "size": 86 + }, + "machine_size_details": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + }, + "status": "Ready", + "maximum_runners": 10, + "public_ip_enabled": true, + "public_ips": [ + { + "enabled": true, + "prefix": "20.80.208.150", + "length": 31 + } + ], + "last_active_on": "2022-10-09T23:39:01Z" + } + }, + "actions-hosted-runner-custom-image-versions": { + "value": { + "total_count": 2, + "image_versions": [ + { + "version": "1.1.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-09T23:39:01Z" + }, + { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + ] + } + }, + "actions-hosted-runner-custom-image": { + "value": { + "id": 1, + "platform": "linux-x64", + "name": "CustomImage", + "source": "custom", + "versions_count": 4, + "total_versions_size": 200, + "latest_version": "1.3.0", + "state": "Ready" + } + }, + "actions-hosted-runner-custom-image-version": { + "value": { + "version": "1.0.0", + "size_gb": 75, + "state": "Ready", + "created_on": "2024-11-08T20:39:01Z" + } + }, + "actions-hosted-runner-curated-image": { + "value": { + "id": "ubuntu-20.04", + "platform": "linux-x64", + "size_gb": 86, + "display_name": "20.04", + "source": "github" + } + }, + "actions-hosted-runner-limits-default": { + "value": { + "public_ips": { + "current_usage": 17, + "maximum": 50 + } + } + }, + "actions-hosted-runner-machine-spec": { + "value": { + "id": "4-core", + "cpu_cores": 4, + "memory_gb": 16, + "storage_gb": 150 + } + }, + "oidc-custom-sub": { + "value": { + "include_claim_keys": [ + "repo", + "context" + ] + } + }, + "actions-organization-permissions": { + "value": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions", + "sha_pinning_required": true + } + }, + "actions-fork-pr-contributor-approval": { + "value": { + "approval_policy": "first_time_contributors" + } + }, + "actions-fork-pr-workflows-private-repos": { + "value": { + "run_workflows_from_fork_pull_requests": true, + "send_write_tokens_to_workflows": false, + "send_secrets_and_variables": false, + "require_approval_for_fork_pr_workflows": true + } + }, + "repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "selected-actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + }, + "actions-default-workflow-permissions": { + "summary": "Give read-only permission, and allow approving PRs.", + "value": { + "default_workflow_permissions": "read", + "can_approve_pull_request_reviews": true + } + }, + "runner-groups-org": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + } + }, + "runner-group": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + }, + "runner-group-item": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + }, + "minimal-repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } + }, + "runner-paginated": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + }, + "runner-application-items": { + "value": [ + { + "os": "osx", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz", + "filename": "actions-runner-osx-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz", + "filename": "actions-runner-linux-x64-2.164.0.tar.gz" + }, + { + "os": "linux", + "architecture": "arm", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm-2.164.0.tar.gz" + }, + { + "os": "win", + "architecture": "x64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip", + "filename": "actions-runner-win-x64-2.164.0.zip" + }, + { + "os": "linux", + "architecture": "arm64", + "download_url": "https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz", + "filename": "actions-runner-linux-arm64-2.164.0.tar.gz" + } + ] + }, + "runner-jitconfig": { + "value": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + }, + "encoded_jit_config": "abc123" + } + }, + "authentication-token": { + "value": { + "token": "LLBF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-22T12:13:35.123-08:00" + } + }, + "authentication-token-2": { + "value": { + "token": "AABF3JGZDX3P5PMEXLND6TS6FCWO6", + "expires_at": "2020-01-29T12:13:35.123-08:00" + } + }, + "runner": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "ephemeral": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + }, + "runner-labels": { + "value": { + "total_count": 4, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + }, + "runner-labels-readonly": { + "value": { + "total_count": 3, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + } + ] + } + }, + "organization-actions-secret-paginated": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + ] + } + }, + "actions-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "organization-actions-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + }, + "public-repository-paginated": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + } + }, + "organization-actions-variables-paginated": { + "value": { + "total_count": 3, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "ACTIONS_RUNNER_DEBUG", + "value": true, + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "ADMIN_EMAIL", + "value": "octocat@github.com", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories" + } + ] + } + }, + "organization-actions-variable": { + "value": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories" + } + }, + "artifact-deployment-record-list": { + "value": { + "total_count": 1, + "deployment_records": [ + { + "id": 123, + "digest": "sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72", + "logical_environment": "prod", + "physical_environment": "pacific-east", + "cluster": "moda-1", + "deployment_name": "prod-deployment", + "tags": { + "data": "sensitive" + }, + "created": "2011-01-26T19:14:43Z", + "updated_at": "2011-01-26T19:14:43Z", + "attestation_id": 456 + } + ] + } + }, + "bulk-subject-digest-body": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ] + } + }, + "bulk-subject-digest-body-with-predicate-type": { + "value": { + "subject_digests": [ + "sha256:abc123", + "sha512:def456" + ], + "predicateType": "provenance" + } + }, + "list-attestations-bulk": { + "value": { + "attestations_subject_digests": [ + { + "sha256:abc": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + ] + } + }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, + "list-attestations": { + "value": { + "attestations": [ + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + }, + { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + }, + "repository_id": 1 + } + ] + } + }, + "campaign-org-items": { + "value": [ + { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open" + }, + { + "number": 4, + "created_at": "2024-03-30T12:29:18Z", + "updated_at": "2024-03-30T12:29:18Z", + "name": "Mitre top 10 KEV", + "description": "Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data.", + "managers": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "ends_at": "2024-04-30T12:29:18Z", + "closed_at": null, + "state": "open" + } + ] + }, + "campaign-summary": { + "value": { + "number": 3, + "created_at": "2024-02-14T12:29:18Z", + "updated_at": "2024-02-14T12:29:18Z", + "name": "Critical CodeQL alert", + "description": "Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage.", + "managers": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "published_at": "2024-02-14T12:29:18Z", + "ends_at": "2024-03-14T12:29:18Z", + "closed_at": null, + "state": "open", + "alert_stats": { + "open_count": 10, + "closed_count": 3, + "in_progress_count": 3 + } + } + }, + "code-scanning-organization-alert-items": { + "value": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + } + } + ] + }, + "code-security-configuration-list": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_delegated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "secret_scanning_delegated_alert_dismissal": "not_set", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "organization", + "name": "High risk settings", + "description": "This is a code security configuration for octo-org high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_delegated_alert_dismissal": "enabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1326", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] + }, + "code-security-configuration-updated": { + "value": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings v2", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "code_scanning_options": { + "allow_advanced": false + }, + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "disabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + }, + "codespaces-list": { + "value": { + "total_count": 3, + "codespaces": [ + { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/foobar/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", + "recent_folders": [] + }, + { + "id": 1, + "name": "monalisa-octocat-hello-world-f8adfad99a", + "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-f8adfad99a.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", + "recent_folders": [] + } + ] + } + }, + "repo-codespaces-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z", + "visibility": "all" + } + ] + } + }, + "codespaces-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "repo-codespaces-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + } + }, + "copilot-organization-details": { + "value": { + "seat_breakdown": { + "total": 12, + "added_this_cycle": 9, + "pending_invitation": 0, + "pending_cancellation": 0, + "active_this_cycle": 12, + "inactive_this_cycle": 11 + }, + "seat_management_setting": "assign_selected", + "ide_chat": "enabled", + "platform_chat": "enabled", + "cli": "enabled", + "public_code_suggestions": "block", + "plan_type": "business" + } + }, + "copilot-seats-list": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "plan_type": "business", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + }, + "copilot-organization-content-exclusion-details": { + "value": { + "octo-repo": [ + "/src/some-dir/kernel.rs" + ] + } + }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, + "organization-dependabot-secret-paginated": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "NPM_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2021-12-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories" + } + ] + } + }, + "dependabot-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "organization-dependabot-secret": { + "value": { + "name": "NPM_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories" + } + }, + "packages-for-org": { + "value": [ + { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/goodbye_docker" + } + ] + }, + "public-org-events-items": { + "value": [ + { + "id": "22237752260", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z", + "org": { + "id": 9919, + "login": "octo-org", + "gravatar_id": "", + "url": "https://api.github.com/orgs/octo-org", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?" + } + }, + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z", + "org": { + "id": 9919, + "login": "octo-org", + "gravatar_id": "", + "url": "https://api.github.com/orgs/octo-org", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?" + } + } + ] + }, + "organization-invitation-items": { + "value": [ + { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "failed_at": "", + "failed_reason": "", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + ] + }, + "org-hook-items": { + "value": [ + { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + ] + }, + "org-hook": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/orgs/octocat/hooks/1/deliveries", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + }, + "org-hook-2": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "name": "web", + "events": [ + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } + }, + "api-insights-route-stats": { + "value": [ + { + "http_method": "GET", + "api_route": "/repositories/:repository_id", + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "api-insights-subject-stats": { + "value": [ + { + "subject_type": "installation", + "subject_id": 954453, + "subject_name": "GitHub Actions", + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "api-insights-summary-stats": { + "value": { + "total_request_count": 34225, + "rate_limited_request_count": 23 + } + }, + "api-insights-time-stats": { + "value": [ + { + "timestamp": "2024-09-11T15:00:00Z", + "total_request_count": 34225, + "rate_limited_request_count": 0 + }, + { + "timestamp": "2024-09-11T15:05:00Z", + "total_request_count": 10587, + "rate_limited_request_count": 18 + }, + { + "timestamp": "2024-09-11T15:10:00Z", + "total_request_count": 43587, + "rate_limited_request_count": 14 + }, + { + "timestamp": "2024-09-11T15:15:00Z", + "total_request_count": 19463, + "rate_limited_request_count": 4 + }, + { + "timestamp": "2024-09-11T15:20:00Z", + "total_request_count": 60542, + "rate_limited_request_count": 3 + }, + { + "timestamp": "2024-09-11T15:25:00Z", + "total_request_count": 55872, + "rate_limited_request_count": 23 + } + ] + }, + "api-insights-user-stats": { + "value": [ + { + "actor_type": "oauth_app", + "actor_id": 954453, + "actor_name": "GitHub Actions", + "oauth_application_id": 1245, + "total_request_count": 544665, + "rate_limited_request_count": 13, + "last_request_timestamp": "2024-09-18T15:43:03Z", + "last_rate_limited_timestamp": "2024-09-18T06:30:09Z" + } + ] + }, + "installation": { + "value": { + "id": 1, + "account": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "client_id": "Iv1.ab1112223334445c", + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + }, + "installation-paginated": { + "value": { + "total_count": 1, + "installations": [ + { + "id": 25381, + "account": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "selected", + "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", + "app_id": 2218, + "target_id": 6811672, + "target_type": "Organization", + "permissions": { + "deployments": "write", + "metadata": "read", + "pull_requests": "read", + "statuses": "read" + }, + "events": [ + "deployment", + "deployment_status" + ], + "created_at": "2017-05-16T08:47:09.000-07:00", + "updated_at": "2017-06-06T11:23:23.000-07:00", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + ] + } + }, + "interaction-limit-response": { + "value": { + "limit": "collaborators_only", + "origin": "organization", + "expires_at": "2018-08-17T04:18:39Z" + } + }, + "organization-invitation": { + "value": { + "id": 1, + "login": "monalisa", + "node_id": "MDQ6VXNlcjE=", + "email": "octocat@github.com", + "role": "direct_member", + "created_at": "2016-11-30T06:46:10-08:00", + "inviter": { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + }, + "team_count": 2, + "invitation_teams_url": "https://api.github.com/organizations/2/invitations/1/teams", + "invitation_source": "member" + } + }, + "team-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + }, + "issue-field-items": { + "value": [ + { + "id": 1, + "node_id": "IFT_kwDNAd3NAZo", + "name": "Text field", + "description": "DRI", + "data_type": "text", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 2, + "node_id": "IFSS_kwDNAd3NAZs", + "name": "Priority", + "description": "Level of importance", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "color": "red" + }, + { + "id": 2, + "name": "Medium", + "color": "yellow" + }, + { + "id": 3, + "name": "Low", + "color": "green" + } + ], + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ] + }, + "issue-field": { + "value": { + "id": 512, + "node_id": "IF_kwDNAd3NAZr", + "name": "Priority", + "description": "Level of importance for the issue", + "data_type": "single_select", + "options": [ + { + "id": 1, + "name": "High", + "description": "High priority", + "color": "red", + "priority": 1, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 2, + "name": "Medium", + "description": "Medium priority", + "color": "yellow", + "priority": 2, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + }, + { + "id": 3, + "name": "Low", + "description": "Low priority", + "color": "green", + "priority": 3, + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + ], + "created_at": "2025-01-15T10:30:15Z", + "updated_at": "2025-01-15T10:30:15Z" + } + }, + "issue-type-items": { + "value": [ + { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + }, + { + "id": 411, + "node_id": "IT_kwDNAd3NAZs", + "name": "Bug", + "description": "An unexpected problem or behavior", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + ] + }, + "issue-type": { + "value": { + "id": 410, + "node_id": "IT_kwDNAd3NAZo", + "name": "Task", + "description": "A specific piece of work", + "created_at": "2024-12-11T14:39:09Z", + "updated_at": "2024-12-11T14:39:09Z" + } + }, + "codespace": { + "value": { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "retention_period_minutes": 43200, + "retention_expires_at": null, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "recent_folders": [], + "template": null + } + }, + "copilot-seat-detail-active": { + "value": { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "last_authenticated_at": "2021-10-14T00:53:32-06:00", + "plan_type": "business", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + } + }, + "org-membership-response-if-user-has-an-active-admin-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "direct_membership": true, + "enterprise_teams_providing_indirect_membership": [ + "ent:justice-league", + "ent:security-managers" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "migration-with-short-org-items": { + "value": [ + { + "id": 79, + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "migration-with-short-org-2": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "migration-with-short-org": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "exported", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "minimal-repository-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "status": "disabled" + } + } + } + ] + }, + "organization-role-list": { + "value": { + "total_count": 2, + "roles": [ + { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + }, + { + "id": 8031, + "name": "Auditor", + "description": "Permissions to read the organization audit log", + "permissions": [ + "read_audit_logs" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + ] + } + }, + "organization-role": { + "value": { + "id": 8030, + "name": "Custom Role Manager", + "description": "Permissions to manage custom roles within an org", + "permissions": [ + "write_organization_custom_repo_role", + "write_organization_custom_org_role", + "read_organization_custom_repo_role", + "read_organization_custom_org_role" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" + } + }, + "package-org": { + "value": { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + } + }, + "package-versions-for-org": { + "value": [ + { + "id": 245301, + "name": "1.0.4", + "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301", + "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", + "created_at": "2019-11-05T22:49:04Z", + "updated_at": "2019-11-05T22:49:04Z", + "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4", + "metadata": { + "package_type": "npm" + } + }, + { + "id": 209672, + "name": "1.0.3", + "url": "https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672", + "package_html_url": "https://github.com/octo-org/hello-world-npm/packages/43752", + "created_at": "2019-10-29T15:42:11Z", + "updated_at": "2019-10-29T15:42:12Z", + "html_url": "https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3", + "metadata": { + "package_type": "npm" + } + } + ] + }, + "package-version-org": { + "value": { + "id": 836, + "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker/versions/836", + "package_html_url": "https://github.com/orgs/github/packages/container/package/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/hello_docker/836", + "metadata": { + "package_type": "container", + "container": { + "tags": [ + "latest" + ] + } + } + } + }, + "org-pat-grant-request-paginated": { + "value": [ + { + "id": 25381, + "reason": "I need to access the GitHub API", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "created_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + }, + "org-pat-grant-paginated": { + "value": [ + { + "id": 25381, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository_selection": "all", + "repositories_url": "https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories", + "permissions": { + "organization": { + "members": "read" + }, + "repository": { + "metadata": "read" + } + }, + "access_granted_at": "2023-05-16T08:47:09.000-07:00", + "token_id": 98716, + "token_name": "Some Token", + "token_expired": false, + "token_expires_at": "2023-11-16T08:47:09.000-07:00", + "token_last_used_at": null + } + ] + }, + "org-private-registry-configurations-paginated": { + "value": { + "total_count": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" + } + ] + } + }, + "org-private-registry-configuration": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "org-private-registry-configuration-with-selected-repositories": { + "value": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "private-registries-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "projects-v2": { + "value": { + "id": 2, + "node_id": "MDc6UHJvamVjdDEwMDI2MDM=", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "title": "My Projects", + "description": "A board to manage my personal projects.", + "public": true, + "closed_at": null, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "number": 2, + "short_description": null, + "deleted_at": null, + "deleted_by": null, + "state": "open", + "latest_status_update": { + "id": 3, + "node_id": "PVTSU_lAECAQM", + "creator": { + "login": "hubot", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": false + }, + "body": "DONE", + "start_date": "2025-07-23", + "target_date": "2025-07-26", + "status": "COMPLETE", + "created_at": "2025-07-11T16:19:28Z", + "updated_at": "2025-07-11T16:19:28Z" + }, + "is_template": true + } + }, + "projects-v2-item-simple": { + "value": { + "id": 17, + "node_id": "PVTI_lADOANN5s84ACbL0zgBueEI", + "content": { + "id": 38, + "node_id": "I_kwDOANN5s85FtLts", + "title": "Example Draft Issue", + "body": "This is a draft issue in the project.", + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "content_type": "DraftIssue", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "archived_at": null, + "project_url": "https://api.github.com/users/octocat/projectsV2/1", + "item_url": "https://api.github.com/users/octocat/projectsV2/items/17" + } + }, + "projects-v2-field-items": { + "value": [ + { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + { + "id": 67891, + "node_id": "PVTF_lADOABCD9876543210", + "name": "Status", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_4", + "name": { + "html": "Todo", + "raw": "Todo" + }, + "color": "GRAY", + "description": { + "html": "Items to be worked on", + "raw": "Items to be worked on" + } + }, + { + "id": "option_5", + "name": { + "html": "In Progress", + "raw": "In Progress" + }, + "color": "BLUE", + "description": { + "html": "Items currently being worked on", + "raw": "Items currently being worked on" + } + }, + { + "id": "option_6", + "name": { + "html": "Done", + "raw": "Done" + }, + "color": "GREEN", + "description": { + "html": "Completed items", + "raw": "Completed items" + } + } + ], + "created_at": "2022-04-29T10:30:00Z", + "updated_at": "2022-04-29T10:30:00Z" + }, + { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + ] + }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, + "projects-v2-field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-item-with-content": { + "value": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "pinned_comment": null, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "πŸš’ wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "data_type": "title", + "value": { + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "data_type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ] + }, + { + "id": 3, + "name": "Status", + "data_type": "single_select", + "value": { + "id": "98236657", + "name": { + "raw": "Done", + "html": "Done" + }, + "color": "PURPLE", + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } + } + }, + { + "id": 4, + "name": "Labels", + "data_type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "πŸš’ wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "data_type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "data_type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "data_type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "data_type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "data_type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "data_type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "data_type": "sub_issues_progress", + "value": null + } + ] + } + }, + "projects-v2-view": { + "value": { + "id": 1, + "number": 1, + "name": "Sprint Board", + "layout": "board", + "node_id": "PVTV_lADOANN5s84ACbL0zgBueEI", + "project_url": "https://api.github.com/orgs/octocat/projectsV2/1", + "html_url": "https://github.com/orgs/octocat/projects/1/views/1", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z", + "filter": "is:issue is:open", + "visible_fields": [ + 123, + 456, + 789 + ], + "sort_by": [ + [ + 123, + "asc" + ], + [ + 456, + "desc" + ] + ], + "group_by": [ + 123 + ], + "vertical_group_by": [ + 456 + ] + } + }, + "custom-properties": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors", + "require_explicit_values": true + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "custom-property": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + }, + "org-repo-custom-property-values": { + "value": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + }, + "org-repo-update-custom-property-values": { + "value": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, + "full-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "web_commit_signoff_required": false, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + }, + "org-ruleset-items": { + "value": [ + { + "id": 21, + "name": "super cool ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + }, + { + "id": 432, + "name": "Another ruleset", + "source_type": "Organization", + "source": "my-org", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/432" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/432" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + ] + }, + "org-ruleset": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/orgs/my-org/rulesets/21" + }, + "html": { + "href": "https://github.com/organizations/my-org/settings/rules/21" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + }, + "rule-suite-items": { + "value": [ + { + "id": 21, + "actor_id": 12, + "actor_name": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass" + }, + { + "id": 25, + "actor_id": 11, + "actor_name": "not-octocat", + "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", + "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", + "ref": "refs/heads/i-am-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-07T08:43:03Z", + "result": "pass", + "evaluation_result": "fail" + } + ] + }, + "rule-suite": { + "value": { + "id": 21, + "actor_id": 12, + "actor_name": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass", + "evaluation_result": "fail", + "rule_evaluations": [ + { + "rule_source": { + "type": "ruleset", + "id": 2, + "name": "Author email must be a GitHub email address" + }, + "enforcement": "active", + "result": "pass", + "rule_type": "commit_author_email_pattern" + }, + { + "rule_source": { + "type": "protected_branch" + }, + "enforcement": "active", + "result": "fail", + "rule_type": "pull_request", + "details": "Changes must be made through a pull request." + }, + { + "rule_source": { + "type": "ruleset", + "id": 3, + "name": "Evaluate commit message pattern" + }, + "enforcement": "evaluate", + "result": "fail", + "rule_type": "commit_message_pattern" + } + ] + } + }, + "ruleset-history": { + "value": [ + { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z" + }, + { + "version_id": 2, + "actor": { + "id": 2, + "type": "User" + }, + "updated_at": "2024-09-23T16:29:47Z" + }, + { + "version_id": 1, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-08-23T16:29:47Z" + } + ] + }, + "org-ruleset-version-with-state": { + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 21, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Organization", + "source": "my-org", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + }, + "repository_name": { + "include": [ + "important_repository", + "another_important_repository" + ], + "exclude": [ + "unimportant_repository" + ], + "protected": true + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + }, + "organization-secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "active", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "secret-scanning-pattern-configuration": { + "value": { + "pattern_config_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "provider_pattern_overrides": [ + { + "token_type": "GITHUB_PERSONAL_ACCESS_TOKEN", + "slug": "github_personal_access_token_legacy_v2", + "display_name": "GitHub Personal Access Token (Legacy v2)", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 2, + "false_positive_rate": 13, + "bypass_rate": 13, + "default_setting": "enabled", + "setting": "enabled", + "enterprise_setting": "enabled" + } + ], + "custom_pattern_overrides": [ + { + "token_type": "cp_2", + "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K", + "slug": "custom-api-key", + "display_name": "Custom API Key", + "alert_total": 15, + "alert_total_percentage": 36, + "false_positives": 3, + "false_positive_rate": 20, + "bypass_rate": 20, + "default_setting": "disabled", + "setting": "enabled" + } + ] + } + }, + "list-repository-advisories": { + "value": [ + { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "critical", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "state": "published", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": "2020-01-03T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "analyst" + } + ], + "credits_detailed": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": null + }, + { + "ghsa_id": "GHSA-1234-5678-9012", + "cve_id": "CVE-2051-0000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "low", + "author": { + "login": "monauser", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monauser", + "html_url": "https://github.com/monauser", + "followers_url": "https://api.github.com/users/monauser/followers", + "following_url": "https://api.github.com/users/monauser/following{/other_user}", + "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", + "organizations_url": "https://api.github.com/users/monauser/orgs", + "repos_url": "https://api.github.com/users/monauser/repos", + "events_url": "https://api.github.com/users/monauser/events{/privacy}", + "received_events_url": "https://api.github.com/users/monauser/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "monalisa", + "id": 3, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-1234-5678-9012" + }, + { + "type": "CVE", + "value": "CVE-2051-00000" + } + ], + "state": "published", + "created_at": "2020-01-03T00:00:00Z", + "updated_at": "2020-01-04T00:00:00Z", + "published_at": "2020-01-04T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": { + "accepted": true + }, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N", + "score": 1.6 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 7.1 + } + }, + "cwes": [ + { + "cwe_id": "CWE-456", + "name": "A CWE 2.0" + } + ], + "cwe_ids": [ + "CWE-456" + ], + "credits": [ + { + "login": "monauser", + "type": "reporter" + } + ], + "credits_detailed": [ + { + "user": { + "login": "monauser", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monauser", + "html_url": "https://github.com/monauser", + "followers_url": "https://api.github.com/users/monauser/followers", + "following_url": "https://api.github.com/users/monauser/following{/other_user}", + "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monauser/subscriptions", + "organizations_url": "https://api.github.com/users/monauser/orgs", + "repos_url": "https://api.github.com/users/monauser/repos", + "events_url": "https://api.github.com/users/monauser/events{/privacy}", + "received_events_url": "https://api.github.com/users/monauser/received_events", + "type": "User", + "site_admin": false + }, + "type": "reporter", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo-ghsa-1234-5678-9012", + "full_name": "octo-org/octo-repo-ghsa-1234-5678-9012", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha}" + } + } + ] + }, + "team-simple-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/organizations/1/team/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/organizations/1/team/1/members{/member}", + "repositories_url": "https://api.github.com/organizations/1/team/1/repos", + "type": "organization", + "organization_id": 1 + } + ] + }, + "network-configurations-paginated": { + "value": { + "total_count": 2, + "network_configurations": [ + { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + }, + { + "id": "456789ABDCEF123", + "name": "My other configuration", + "compute_service": "none", + "network_settings_ids": [ + "56789ABDCEF1234", + "6789ABDCEF12345" + ], + "created_on": "2023-04-26T15:23:37Z" + } + ] + } + }, + "network-configuration": { + "value": { + "id": "123456789ABCDEF", + "name": "My network configuration", + "compute_service": "actions", + "network_settings_ids": [ + "23456789ABDCEF1", + "3456789ABDCEF12" + ], + "created_on": "2022-10-09T23:39:01Z" + } + }, + "network-settings": { + "value": { + "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D", + "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562", + "name": "my_network_settings", + "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet", + "region": "eastus" + } + }, + "team-full": { + "value": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + }, + "team-membership-response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + }, + "team-membership-response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + }, + "team-repository-alternative-response-with-repository-permissions": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "team-items-response-if-child-teams-exist": { + "value": [ + { + "id": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + }, + "html_url": "https://github.com/orgs/rails/teams/core" + } + ] + }, + "rate-limit-overview": { + "value": { + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } + } + }, + "full-repository-default-response": { + "summary": "Default response", + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + }, + "secret_scanning_delegated_bypass": { + "status": "disabled" + }, + "secret_scanning_delegated_alert_dismissal": { + "status": "disabled" + } + } + } + } + }, + "artifact-paginated": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332938, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + } + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "Test output", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332942, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" + } + } + ] + } + }, + "artifact": { + "value": { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-01-21T14:59:22Z", + "updated_at": "2020-01-21T14:59:22Z", + "digest": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c", + "workflow_run": { + "id": 2332938, + "repository_id": 1296269, + "head_repository_id": 1296269, + "head_branch": "main", + "head_sha": "328faa0536e6fef19753d9d91dc96a9931694ce3" + } + } + }, + "actions-cache-usage": { + "value": { + "full_name": "octo-org/Hello-World", + "active_caches_size_in_bytes": 2322142, + "active_caches_count": 3 + } + }, + "actions-cache-list": { + "value": { + "total_count": 1, + "actions_caches": [ + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + ] + } + }, + "job": { + "value": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group", + "workflow_name": "CI", + "head_branch": "main" + } + }, + "oidc-custom-sub-repo": { + "value": { + "use_default": false, + "include_claim_keys": [ + "repo", + "context" + ] + } + }, + "actions-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + }, + "actions-variables-paginated": { + "value": { + "total_count": 2, + "variables": [ + { + "name": "USERNAME", + "value": "octocat", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "EMAIL", + "value": "octocat@github.com", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + }, + "actions-repository-permissions": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions", + "sha_pinning_required": true + } + }, + "actions-workflow-access-to-repository": { + "value": { + "access_level": "organization" + } + }, + "workflow-run-paginated": { + "value": { + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "check_suite_id": 42, + "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "path": ".github/workflows/build.yml@main", + "run_number": 562, + "event": "push", + "display_title": "Update README.md", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "run_attempt": 1, + "run_started_at": "2020-01-22T19:33:08Z", + "triggering_actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + ] + } + }, + "workflow-run": { + "value": { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "check_suite_id": 42, + "check_suite_node_id": "MDEwOkNoZWNrU3VpdGU0Mg==", + "head_branch": "main", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "path": ".github/workflows/build.yml@main", + "run_number": 562, + "event": "push", + "display_title": "Update README.md", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "run_attempt": 1, + "referenced_workflows": [ + { + "path": "octocat/Hello-World/.github/workflows/deploy.yml@main", + "sha": "86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db", + "ref": "refs/heads/main" + }, + { + "path": "octo-org/octo-repo/.github/workflows/report.yml@v2", + "sha": "79e9790903e1c3373b1a3e3a941d57405478a232", + "ref": "refs/tags/v2" + }, + { + "path": "octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e", + "sha": "1595d4b6de6a9e9751fb270a41019ce507d4099e" + } + ], + "run_started_at": "2020-01-22T19:33:08Z", + "triggering_actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "previous_attempt_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + }, + "environment-approvals-items": { + "value": [ + { + "state": "approved", + "comment": "Ship it!", + "environments": [ + { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z" + } + ], + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "job-paginated": { + "value": { + "total_count": 1, + "jobs": [ + { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v3", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496", + "labels": [ + "self-hosted", + "foo", + "bar" + ], + "runner_id": 1, + "runner_name": "my runner", + "runner_group_id": 2, + "runner_group_name": "my runner group", + "workflow_name": "CI", + "head_branch": "main" + } + ] + } + }, + "pending-deployment-items": { + "value": [ + { + "environment": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "wait_timer": 30, + "wait_timer_started_at": "2020-11-23T22:00:40Z", + "current_user_can_approve": true, + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + } + ] + } + ] + }, + "deployment-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + ] + }, + "workflow-run-usage": { + "value": { + "billable": { + "UBUNTU": { + "total_ms": 180000, + "jobs": 1, + "job_runs": [ + { + "job_id": 1, + "duration_ms": 180000 + } + ] + }, + "MACOS": { + "total_ms": 240000, + "jobs": 4, + "job_runs": [ + { + "job_id": 2, + "duration_ms": 60000 + }, + { + "job_id": 3, + "duration_ms": 60000 + }, + { + "job_id": 4, + "duration_ms": 60000 + }, + { + "job_id": 5, + "duration_ms": 60000 + } + ] + }, + "WINDOWS": { + "total_ms": 300000, + "jobs": 2, + "job_runs": [ + { + "job_id": 6, + "duration_ms": 150000 + }, + { + "job_id": 7, + "duration_ms": 150000 + } + ] + } + }, + "run_duration_ms": 500000 + } + }, + "actions-secret": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "actions-variable": { + "value": { + "name": "USERNAME", + "value": "octocat", + "created_at": "2021-08-10T14:59:22Z", + "updated_at": "2022-01-10T14:59:22Z" + } + }, + "workflow-paginated": { + "value": { + "total_count": 2, + "workflows": [ + { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + }, + { + "id": 269289, + "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==", + "name": "Linter", + "path": ".github/workflows/linter.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg" + } + ] + } + }, + "workflow": { + "value": { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + } + }, + "workflow-dispatch-response": { + "value": { + "workflow_run_id": 1, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/1", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/1" + } + }, + "workflow-usage": { + "value": { + "billable": { + "UBUNTU": { + "total_ms": 180000 + }, + "MACOS": { + "total_ms": 240000 + }, + "WINDOWS": { + "total_ms": 300000 + } + } + } + }, + "activity-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "before": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "after": "827efc6d56897b048c772eb4087f854f46256132", + "ref": "refs/heads/main", + "pushed_at": "2011-01-26T19:06:43Z", + "push_type": "normal", + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "attestation": { + "value": { + "bundle": { + "mediaType": "application/vnd.dev.sigstore.bundle.v0.3+json", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "97913980", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "dsse", + "version": "0.0.1" + }, + "integratedTime": "1716998992", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL" + }, + "inclusionProof": { + "logIndex": "93750549", + "rootHash": "KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=", + "treeSize": "93750551", + "hashes": [ + "8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg=", + "nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck=", + "hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A=", + "MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM=", + "XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc=", + "Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY=", + "wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU=", + "uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s=", + "jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs=", + "xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ=", + "cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc=", + "sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ=", + "98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\\n93750551\\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\\n\\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0=" + } + ], + "timestampVerificationData": {}, + "certificate": { + "rawBytes": "MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw==" + } + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==" + } + ] + } + } + } + }, + "autolink-items": { + "value": [ + { + "id": 1, + "key_prefix": "TICKET-", + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true + } + ] + }, + "autolink": { + "value": { + "id": 1, + "key_prefix": "TICKET-", + "url_template": "https://example.com/TICKET?query=", + "is_alphanumeric": true + } + }, + "short-branch-with-protection-items": { + "value": [ + { + "name": "master", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + } + ] + }, + "branch-get": { + "value": { + "name": "main", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk", + "commit": { + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com", + "date": "2012-03-06T23:06:50Z" + }, + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comment_count": 77, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + }, + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "html_url": "https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments", + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "html_url": "https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303", + "html_url": "https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ] + }, + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/branches/main", + "html": "https://github.com/octocat/Hello-World/tree/main" + }, + "protected": false, + "protection": { + "enabled": false, + "required_status_checks": { + "enforcement_level": "off", + "contexts": [], + "checks": [] + } + }, + "protection_url": "https://api.github.com/repos/octocat/Hello-World/branches/main/protection" + } + }, + "branch-protection": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts", + "enforcement_level": "non_admins" + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "require_last_push_approval": true + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + }, + "lock_branch": { + "enabled": true + }, + "allow_fork_syncing": { + "enabled": true + } + } + }, + "branch-protection-update": { + "value": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection", + "required_status_checks": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts", + "checks": [ + { + "context": "continuous-integration/travis-ci", + "app_id": null + } + ] + }, + "restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps", + "users": [], + "teams": [], + "apps": [] + }, + "required_pull_request_reviews": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews", + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "require_last_push_approval": true, + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams", + "users": [], + "teams": [], + "apps": [] + } + }, + "required_signatures": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures", + "enabled": false + }, + "enforce_admins": { + "url": "https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins", + "enabled": true + }, + "required_linear_history": { + "enabled": true + }, + "allow_force_pushes": { + "enabled": true + }, + "allow_deletions": { + "enabled": true + }, + "block_creations": { + "enabled": true + }, + "required_conversation_resolution": { + "enabled": true + }, + "lock_branch": { + "enabled": true + }, + "allow_fork_syncing": { + "enabled": true + } + } + }, + "protected-branch-admin-enforced-2": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins", + "enabled": true + } + }, + "protected-branch-pull-request-review": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews", + "dismissal_restrictions": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "dismiss_stale_reviews": true, + "require_code_owner_reviews": true, + "required_approving_review_count": 2, + "require_last_push_approval": true + } + }, + "protected-branch-admin-enforced": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures", + "enabled": true + } + }, + "status-check-policy": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks", + "strict": true, + "contexts": [ + "continuous-integration/travis-ci" + ], + "contexts_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts" + } + }, + "branch-restriction-policy": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions", + "users_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams", + "apps_url": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps", + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "apps": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + } + }, + "integration-items": { + "value": [ + { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + } + ] + }, + "branch-with-protection": { + "value": { + "name": "master", + "commit": { + "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "node_id": "MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==", + "commit": { + "author": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "tree": { + "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608", + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608" + }, + "committer": { + "name": "The Octocat", + "date": "2012-03-06T15:06:50-08:00", + "email": "octocat@nowhere.com" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + }, + "comment_count": 0 + }, + "author": { + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "parents": [ + { + "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e" + }, + { + "sha": "762941318ee16e59dabbacb1b4049eec22f0d303", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303" + } + ], + "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "committer": { + "gravatar_id": "", + "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png", + "url": "https://api.github.com/users/octocat", + "id": 583231, + "login": "octocat", + "node_id": "MDQ6VXNlcjE=", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments" + }, + "_links": { + "html": "https://github.com/octocat/Hello-World/tree/master", + "self": "https://api.github.com/repos/octocat/Hello-World/branches/master" + }, + "protected": true, + "protection": { + "required_status_checks": { + "enforcement_level": "non_admins", + "contexts": [ + "ci-test", + "linter" + ] + } + }, + "protection_url": "https://api.github.com/repos/octocat/hello-world/branches/master/protection" + } + }, + "check-run-example-of-completed-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + }, + "check-run-example-of-in-progress-conclusion": { + "summary": "Response for in_progress conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + }, + "check-run": { + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + }, + "check-annotation-items": { + "value": [ + { + "path": "README.md", + "start_line": 2, + "end_line": 2, + "start_column": 5, + "end_column": 10, + "annotation_level": "warning", + "title": "Spell Checker", + "message": "Check your spelling for 'banaas'.", + "raw_details": "Do you mean 'bananas' or 'banana'?", + "blob_href": "https://api.github.com/repos/github/rest-api-description/git/blobs/abc" + } + ] + }, + "check-suite": { + "value": { + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "status": "completed", + "conclusion": "neutral", + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [], + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + } + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" + } + }, + "check-suite-preference": { + "value": { + "preferences": { + "auto_trigger_checks": [ + { + "app_id": 2, + "setting": true + }, + { + "app_id": 4, + "setting": false + } + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + } + } + } + }, + "check-run-paginated": { + "value": { + "total_count": 1, + "check_runs": [ + { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + ] + } + }, + "code-scanning-alert-items": { + "value": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "fixed_at": null, + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "dismissed_comment": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances" + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances" + } + ] + }, + "code-scanning-alert": { + "value": { + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + } + }, + "code-scanning-alert-dismissed": { + "value": { + "number": 42, + "created_at": "2020-08-25T21:28:36Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "fixed_at": null, + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-09-02T22:34:56Z", + "dismissed_reason": "false positive", + "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.", + "rule": { + "id": "js/zipslip", + "severity": "error", + "security_severity_level": "high", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...", + "help_uri": "https://codeql.github.com/" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + } + }, + "code-scanning-autofix": { + "value": { + "status": "success", + "description": "This fixes an XSS vulnerability by escaping the user input.", + "started_at": "2024-02-14T12:29:18Z" + } + }, + "code-scanning-bad-request": { + "value": { + "message": "The alert_number is not valid", + "documentation_url": "https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert", + "status": "400" + } + }, + "code-scanning-autofix-pending": { + "value": { + "status": "pending", + "description": null, + "started_at": "2024-02-14T12:29:18Z" + } + }, + "code-scanning-autofix-commits": { + "value": { + "target_ref": "refs/heads/fix-bug", + "message": "Let's fix this πŸͺ²!" + } + }, + "code-scanning-autofix-commits-response": { + "value": { + "target_ref": "refs/heads/main", + "sha": "178f4f6090b3fccad4a65b3e83d076a622d59652" + } + }, + "code-scanning-alert-instances": { + "value": [ + { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "library" + ] + }, + { + "ref": "refs/pull/3740/merge", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "state": "fixed", + "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", + "message": { + "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." + }, + "location": { + "path": "app/script.js", + "start_line": 2, + "end_line": 2, + "start_column": 10, + "end_column": 50 + }, + "classifications": [ + "source" + ] + } + ] + }, + "code-scanning-analysis-items": { + "value": [ + { + "ref": "refs/heads/main", + "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"python\"}", + "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", + "created_at": "2020-08-27T15:05:21Z", + "results_count": 17, + "rules_count": 49, + "id": 201, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true, + "warning": "" + }, + { + "ref": "refs/heads/my-branch", + "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", + "analysis_key": ".github/workflows/shiftleft.yml:build", + "environment": "{}", + "error": "", + "category": ".github/workflows/shiftleft.yml:build/", + "created_at": "2020-08-31T22:46:44Z", + "results_count": 17, + "rules_count": 32, + "id": 200, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", + "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", + "tool": { + "name": "Python Security Analysis", + "guid": null, + "version": "1.2.0" + }, + "deletable": true, + "warning": "" + } + ] + }, + "code-scanning-analysis-default": { + "summary": "application/json response", + "value": { + "ref": "refs/heads/main", + "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"javascript\"}", + "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", + "created_at": "2021-01-13T11:55:49Z", + "results_count": 3, + "rules_count": 67, + "id": 3602840, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true, + "warning": "" + } + }, + "code-scanning-analysis-sarif": { + "summary": "application/sarif+json response", + "value": { + "runs": [ + { + "tool": { + "driver": { + "name": "CodeQL", + "organization": "GitHub", + "semanticVersion": "1.0.0", + "rules": [ + { + "id": "js/unused-local-variable", + "name": "js/unused-local-variable" + } + ] + } + }, + "results": [ + { + "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38", + "message": { + "text": "Unused variable foo." + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "file1.js" + }, + "region": { + "startLine": 1 + } + } + } + ], + "ruleId": "js/unused-local-variable", + "properties": [ + { + "github/alertNumber": 2 + }, + { + "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2" + } + ] + } + ] + } + ] + } + }, + "code-scanning-analysis-deletion": { + "summary": "Default response", + "value": { + "next_analysis_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41", + "confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete" + } + }, + "code-scanning-codeql-databases": { + "value": [ + { + "id": 1, + "name": "database.zip", + "language": "java", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content_type": "application/zip", + "size": 1024, + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" + }, + { + "id": 2, + "name": "database.zip", + "language": "ruby", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content_type": "application/zip", + "size": 1024, + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" + } + ] + }, + "code-scanning-codeql-database": { + "value": { + "id": 1, + "name": "database.zip", + "language": "java", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content_type": "application/zip", + "size": 1024, + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" + } + }, + "code-scanning-variant-analysis": { + "summary": "Default response", + "value": { + "id": 1, + "controller_repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "query_language": "python", + "query_pack_url": "https://www.example.com", + "created_at": "2022-09-12T12:14:32Z", + "updated_at": "2022-09-12T12:14:32Z", + "completed_at": "2022-09-12T13:15:33Z", + "status": "succeeded", + "actions_workflow_run_id": 3453588, + "scanned_repositories": [ + { + "repository": { + "id": 1296269, + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "private": false + }, + "analysis_status": "succeeded", + "result_count": 532, + "artifact_size_in_bytes": 12345 + } + ], + "skipped_repositories": { + "access_mismatch_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 1, + "name": "octo-repo1", + "full_name": "octo-org/octo-repo1", + "private": false + }, + { + "id": 2, + "name": "octo-repo2", + "full_name": "octo-org/octo-repo2", + "private": false + } + ] + }, + "not_found_repos": { + "repository_count": 3, + "repository_full_names": [ + "octo-org/octo-repo4", + "octo-org/octo-repo5", + "octo-org/octo-repo6" + ] + }, + "no_codeql_db_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 7, + "name": "octo-repo7", + "full_name": "octo-org/octo-repo7", + "private": false + }, + { + "id": 8, + "name": "octo-repo8", + "full_name": "octo-org/octo-repo8", + "private": false + } + ] + }, + "over_limit_repos": { + "repository_count": 2, + "repositories": [ + { + "id": 9, + "name": "octo-repo9", + "full_name": "octo-org/octo-repo9", + "private": false + }, + { + "id": 10, + "name": "octo-repo10", + "full_name": "octo-org/octo-repo10", + "private": false + } + ] + } + } + } + }, + "code-scanning-variant-analysis-repo-task": { + "summary": "Default response", + "value": { + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks" + }, + "analysis_status": "succeeded", + "artifact_size_in_bytes": 12345, + "result_count": 532, + "database_commit_sha": "2d870c2a717a524627af38fa2da382188a096f90", + "source_location_prefix": "/", + "artifact_url": "https://example.com" + } + }, + "code-scanning-default-setup": { + "value": { + "state": "configured", + "languages": [ + "ruby", + "python" + ], + "query_suite": "default", + "threat_model": "remote", + "updated_at": "2023-01-19T11:21:34Z", + "schedule": "weekly" + } + }, + "code-scanning-default-setup-update": { + "value": { + "state": "configured", + "threat_model": "remote_and_local" + } + }, + "code-scanning-default-setup-update-response": { + "value": { + "run_id": 42, + "run_url": "https://api.github.com/repos/octoorg/octocat/actions/runs/42" + } + }, + "code-scanning-sarif-upload": { + "summary": "Default response", + "value": { + "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" + } + }, + "code-scanning-sarif-upload-status": { + "summary": "Default response", + "value": { + "processing_status": "complete", + "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" + } + }, + "code-security-configuration-for-repository": { + "value": { + "status": "attached", + "configuration": { + "id": 1325, + "target_type": "organization", + "name": "octo-org recommended settings", + "description": "This is a code security configuration for octo-org", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "disabled", + "code_scanning_delegated_alert_dismissal": "disabled", + "secret_scanning": "enabled", + "secret_scanning_push_protection": "disabled", + "secret_scanning_delegated_bypass": "disabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_generic_secrets": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", + "private_vulnerability_reporting": "disabled", + "enforcement": "enforced", + "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", + "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", + "created_at": "2024-05-01T00:00:00Z", + "updated_at": "2024-05-01T00:00:00Z" + } + } + }, + "codeowners-errors": { + "value": { + "errors": [ + { + "line": 3, + "column": 1, + "kind": "Invalid pattern", + "source": "***/*.rb @monalisa", + "suggestion": "Did you mean `**/*.rb`?", + "message": "Invalid pattern on line 3: Did you mean `**/*.rb`?\n\n ***/*.rb @monalisa\n ^", + "path": ".github/CODEOWNERS" + }, + { + "line": 7, + "column": 7, + "kind": "Invalid owner", + "source": "*.txt docs@", + "suggestion": null, + "message": "Invalid owner on line 7:\n\n *.txt docs@\n ^", + "path": ".github/CODEOWNERS" + } + ] + } + }, + "codespaces-list-for-repository": { + "value": { + "total_count": 2, + "codespaces": [ + { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "recent_folders": [] + }, + { + "id": 2, + "name": "monalisa-octocat-hello-world-3f89ada1j3", + "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", + "recent_folders": [] + } + ] + } + }, + "codespaces-list-devcontainers-for-repository": { + "value": { + "devcontainers": [ + { + "path": ".devcontainer/foobar/devcontainer.json", + "name": "foobar", + "display_name": "foobar" + }, + { + "path": ".devcontainer/devcontainer.json", + "name": "kitchensink", + "display_name": "kitchensink" + }, + { + "path": ".devcontainer.json", + "display_name": "Default project configuration" + } + ], + "total_count": 3 + } + }, + "codespace-machines-list": { + "value": { + "total_count": 2, + "machines": [ + { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + { + "name": "premiumLinux", + "display_name": "8 cores, 32 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 34359738368, + "cpus": 8 + } + ] + } + }, + "codespaces-default-attributes-for-a-codespace": { + "value": { + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "defaults": { + "location": "EastUs", + "devcontainer_path": ".devcontainer/devcontainer.json" + } + } + }, + "codespaces-permissions-check-for-devcontainer": { + "value": { + "accepted": true + } + }, + "collaborator-items": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "permissions": { + "pull": true, + "triage": true, + "push": true, + "maintain": false, + "admin": false + }, + "role_name": "write" + } + ] + }, + "repository-invitation-response-when-a-new-invitation-is-created": { + "value": { + "id": 1, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" + } + }, + "repository-collaborator-permission-response-if-user-has-admin-permissions": { + "value": { + "permission": "admin", + "role_name": "admin", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "commit-comment-items": { + "value": [ + { + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", + "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "id": 1, + "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 14, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "author_association": "COLLABORATOR" + } + ] + }, + "commit-comment": { + "value": { + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", + "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "id": 1, + "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", + "body": "Great stuff", + "path": "file1.txt", + "position": 4, + "line": 14, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author_association": "COLLABORATOR", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z" + } + }, + "commit-comment-2": { + "value": { + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1", + "url": "https://api.github.com/repos/octocat/Hello-World/comments/1", + "id": 1, + "node_id": "MDEzOkNvbW1pdENvbW1lbnQx", + "body": "Nice change", + "path": "file1.txt", + "position": 4, + "line": 14, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author_association": "COLLABORATOR", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z" + } + }, + "reaction-items": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + }, + "reaction": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + }, + "commit-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "support@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "support@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + } + ] + }, + "branch-short-items": { + "value": [ + { + "name": "branch_5", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "protected": false + } + ] + }, + "pull-request-simple-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "notification_setting": "notifications_enabled", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "auto_merge": null, + "draft": false + } + ] + }, + "commit": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ], + "stats": { + "additions": 104, + "deletions": 4, + "total": 108 + }, + "files": [ + { + "filename": "file1.txt", + "additions": 10, + "deletions": 2, + "changes": 12, + "status": "modified", + "raw_url": "https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "blob_url": "https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt", + "patch": "@@ -29,7 +29,7 @@\n....." + } + ] + } + }, + "diff-media-type": { + "value": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n" + }, + "patch-media-type": { + "value": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n" + }, + "check-suite-paginated": { + "value": { + "total_count": 1, + "check_suites": [ + { + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "status": "completed", + "conclusion": "neutral", + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [], + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + } + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" + } + ] + } + }, + "combined-commit-status": { + "value": { + "state": "success", + "statuses": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "id": 1, + "node_id": "MDY6U3RhdHVzMQ==", + "state": "success", + "description": "Build has completed successfully", + "target_url": "https://ci.example.com/1000/output", + "context": "continuous-integration/jenkins", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z" + }, + { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "id": 2, + "node_id": "MDY6U3RhdHVzMg==", + "state": "success", + "description": "Testing has completed successfully", + "target_url": "https://ci.example.com/2000/output", + "context": "security/brakeman", + "created_at": "2012-08-20T01:19:13Z", + "updated_at": "2012-08-20T01:19:13Z" + } + ], + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "total_count": 2, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "commit_url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "url": "https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status" + } + }, + "status-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "id": 1, + "node_id": "MDY6U3RhdHVzMQ==", + "state": "success", + "description": "Build has completed successfully", + "target_url": "https://ci.example.com/1000/output", + "context": "continuous-integration/jenkins", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "community-profile": { + "value": { + "health_percentage": 100, + "description": "My first repository on GitHub!", + "documentation": null, + "files": { + "code_of_conduct": { + "name": "Contributor Covenant", + "key": "contributor_covenant", + "url": "https://api.github.com/codes_of_conduct/contributor_covenant", + "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" + }, + "code_of_conduct_file": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md", + "html_url": "https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md" + }, + "contributing": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING", + "html_url": "https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING" + }, + "issue_template": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE", + "html_url": "https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE" + }, + "pull_request_template": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE", + "html_url": "https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE" + }, + "license": { + "name": "MIT License", + "key": "mit", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "html_url": "https://github.com/octocat/Hello-World/blob/master/LICENSE", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "readme": { + "url": "https://api.github.com/repos/octocat/Hello-World/contents/README.md", + "html_url": "https://github.com/octocat/Hello-World/blob/master/README.md" + } + }, + "updated_at": "2017-02-28T19:09:29Z", + "content_reports_enabled": true + } + }, + "commit-comparison": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic", + "html_url": "https://github.com/octocat/Hello-World/compare/master...topic", + "permalink_url": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17", + "diff_url": "https://github.com/octocat/Hello-World/compare/master...topic.diff", + "patch_url": "https://github.com/octocat/Hello-World/compare/master...topic.patch", + "base_commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + }, + "merge_base_commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + }, + "status": "behind", + "ahead_by": 1, + "behind_by": 2, + "total_commits": 1, + "commits": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "author": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "committer": { + "name": "Monalisa Octocat", + "email": "mona@github.com", + "date": "2011-04-14T16:00:49Z" + }, + "message": "Fix all the bugs", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + }, + "comment_count": 0, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + }, + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + ] + } + ], + "files": [ + { + "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", + "filename": "file1.txt", + "status": "added", + "additions": 103, + "deletions": 21, + "changes": 124, + "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + } + ] + } + }, + "content-file-response-if-content-is-a-file": { + "summary": "Response if content is a file", + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\nIHdvcmtmbG93Lgo=\\n", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + }, + "content-file-response-if-content-is-a-directory-object": { + "summary": "Response if content is a directory and the application/vnd.github.v3.object media type is requested", + "value": { + "type": "dir", + "size": 0, + "name": "src", + "path": "src", + "sha": "2962be1c94eaae9794b3080790ec9d74b2fa8358", + "url": "https://api.github.com/repos/octocat/octorepo/contents/src?ref=main", + "git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html_url": "https://github.com/octocat/octorepo/blob/main/src", + "download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src", + "_links": { + "self": "https://api.github.com/repos/octocat/octorepo/contents/src", + "git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html": "https://github.com/octocat/octorepo/blob/main/src" + }, + "entries": [ + { + "type": "file", + "size": 625, + "name": "app.js", + "path": "src/app.js", + "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "url": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js", + "git_url": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html_url": "https://github.com/octocat/octorepo/blob/main/src/app.js", + "download_url": "https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js", + "_links": { + "self": "https://api.github.com/repos/octocat/octorepo/contents/src/app.js", + "git": "https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html": "https://github.com/octocat/octorepo/blob/main/src/app.js" + } + }, + { + "type": "dir", + "size": 0, + "name": "images", + "path": "src/images", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "url": "https://api.github.com/repos/octocat/octorepo/contents/src/images", + "git_url": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "html_url": "https://github.com/octocat/octorepo/tree/main/src/images", + "download_url": null, + "_links": { + "self": "https://api.github.com/repos/octocat/octorepo/contents/src/images", + "git": "https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "html": "https://github.com/octocat/octorepo/tree/main/src/images" + } + } + ] + } + }, + "content-file-response-if-content-is-a-directory": { + "summary": "Response if content is a directory and the application/json media type is requested", + "value": [ + { + "type": "file", + "size": 625, + "name": "octokit.rb", + "path": "lib/octokit.rb", + "sha": "fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb", + "_links": { + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb", + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b", + "html": "https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb" + } + }, + { + "type": "dir", + "size": 0, + "name": "octokit", + "path": "lib/octokit", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "html_url": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit", + "download_url": null, + "_links": { + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit", + "git": "https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "html": "https://github.com/octokit/octokit.rb/tree/master/lib/octokit" + } + } + ] + }, + "content-file-response-if-content-is-a-symlink": { + "summary": "Response if content is a symlink and the application/json media type is requested", + "value": { + "type": "symlink", + "target": "/path/to/symlink/target", + "size": 23, + "name": "some-symlink", + "path": "bin/some-symlink", + "sha": "452a98979c88e093d682cab404a3ec82babebb48", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink", + "html": "https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink" + } + } + }, + "content-file-response-if-content-is-a-submodule": { + "summary": "Response if content is a submodule and the application/json media type is requested", + "value": { + "type": "submodule", + "submodule_git_url": "git://github.com/jquery/qunit.git", + "size": 0, + "name": "qunit", + "path": "test/qunit", + "sha": "6ca3721222109997540bd6d9ccd396902e0ad2f9", + "url": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", + "git_url": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", + "html_url": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9", + "download_url": null, + "_links": { + "git": "https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9", + "self": "https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master", + "html": "https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9" + } + } + }, + "file-commit-example-for-updating-a-file": { + "value": { + "content": { + "name": "hello.txt", + "path": "notes/hello.txt", + "sha": "a56507ed892d05a37c6d6128c260937ea4d287bd", + "size": 9, + "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", + "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", + "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", + "type": "file", + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd", + "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" + } + }, + "commit": { + "sha": "18a43cd8e1e3a79c786e3d808a73d23b6d212b16", + "node_id": "MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", + "html_url": "https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f", + "sha": "9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6", + "html_url": "https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6", + "sha": "da5a433788da5c255edad7979b328b67d79f53f6" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + } + }, + "file-commit-example-for-creating-a-file": { + "value": { + "content": { + "name": "hello.txt", + "path": "notes/hello.txt", + "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3", + "size": 9, + "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt", + "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", + "download_url": "https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt", + "type": "file", + "_links": { + "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt", + "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3", + "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt" + } + }, + "commit": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + } + }, + "file-commit": { + "value": { + "content": null, + "commit": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + } + }, + "contributor-items-response-if-repository-contains-content": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "contributions": 32 + } + ] + }, + "dependabot-alerts-for-repository": { + "value": [ + { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + }, + { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [] + } + ] + }, + "dependabot-alert-open": { + "value": { + "number": 1, + "state": "open", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-8f4m-hccc-8qph", + "cve_id": "CVE-2021-20191", + "summary": "Insertion of Sensitive Information into Log File in ansible", + "description": "A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.9.0, < 2.9.18", + "first_patched_version": { + "identifier": "2.9.18" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": ">= 2.10.0, < 2.10.7", + "first_patched_version": { + "identifier": "2.10.7" + } + } + ], + "severity": "medium", + "cvss": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N", + "score": 5.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 8.5 + } + }, + "epss": { + "percentage": 0.00045, + "percentile": "0.16001e0" + }, + "cwes": [ + { + "cwe_id": "CWE-532", + "name": "Insertion of Sensitive Information into Log File" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-8f4m-hccc-8qph" + }, + { + "type": "CVE", + "value": "CVE-2021-20191" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2021-20191" + }, + { + "url": "https://access.redhat.com/security/cve/cve-2021-20191" + }, + { + "url": "https://bugzilla.redhat.com/show_bug.cgi?id=1916813" + } + ], + "published_at": "2021-06-01T17:38:00Z", + "updated_at": "2021-08-12T23:06:00Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "ansible" + }, + "severity": "medium", + "vulnerable_version_range": "< 2.8.19", + "first_patched_version": { + "identifier": "2.8.19" + } + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/1", + "created_at": "2022-06-14T15:21:52Z", + "updated_at": "2022-06-14T15:21:52Z", + "dismissed_at": null, + "dismissed_by": null, + "dismissed_reason": null, + "dismissed_comment": null, + "fixed_at": null, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + }, + "dependabot-alert-dismissed": { + "value": { + "number": 2, + "state": "dismissed", + "dependency": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "manifest_path": "path/to/requirements.txt", + "scope": "runtime" + }, + "security_advisory": { + "ghsa_id": "GHSA-rf4j-j272-fj86", + "cve_id": "CVE-2018-6188", + "summary": "Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive", + "description": "django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.", + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 1.11.8, < 1.11.10", + "first_patched_version": { + "identifier": "1.11.10" + } + } + ], + "severity": "high", + "cvss": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N", + "score": 7.5 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N", + "score": 8.7 + } + }, + "cwes": [ + { + "cwe_id": "CWE-200", + "name": "Exposure of Sensitive Information to an Unauthorized Actor" + } + ], + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-rf4j-j272-fj86" + }, + { + "type": "CVE", + "value": "CVE-2018-6188" + } + ], + "references": [ + { + "url": "https://nvd.nist.gov/vuln/detail/CVE-2018-6188" + }, + { + "url": "https://github.com/advisories/GHSA-rf4j-j272-fj86" + }, + { + "url": "https://usn.ubuntu.com/3559-1/" + }, + { + "url": "https://www.djangoproject.com/weblog/2018/feb/01/security-releases/" + }, + { + "url": "http://www.securitytracker.com/id/1040422" + } + ], + "published_at": "2018-10-03T21:13:54Z", + "updated_at": "2022-04-26T18:35:37Z", + "withdrawn_at": null + }, + "security_vulnerability": { + "package": { + "ecosystem": "pip", + "name": "django" + }, + "severity": "high", + "vulnerable_version_range": ">= 2.0.0, < 2.0.2", + "first_patched_version": { + "identifier": "2.0.2" + } + }, + "url": "https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2", + "html_url": "https://github.com/octocat/hello-world/security/dependabot/2", + "created_at": "2022-06-15T07:43:03Z", + "updated_at": "2022-08-23T14:29:47Z", + "dismissed_at": "2022-08-23T14:29:47Z", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_reason": "tolerable_risk", + "dismissed_comment": "This alert is accurate but we use a sanitizer.", + "fixed_at": null, + "assignees": [] + } + }, + "dependabot-secret-paginated": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "AZURE_DEVOPS_PAT", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + }, + "dependabot-secret": { + "value": { + "name": "MY_ARTIFACTORY_PASSWORD", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + }, + "diff-range-response": { + "value": [ + { + "change_type": "removed", + "manifest": "package.json", + "ecosystem": "npm", + "name": "helmet", + "version": "4.6.0", + "package_url": "pkg:npm/helmet@4.6.0", + "license": "MIT", + "source_repository_url": "https://github.com/helmetjs/helmet", + "vulnerabilities": [] + }, + { + "change_type": "added", + "manifest": "package.json", + "ecosystem": "npm", + "name": "helmet", + "version": "5.0.0", + "package_url": "pkg:npm/helmet@5.0.0", + "license": "MIT", + "source_repository_url": "https://github.com/helmetjs/helmet", + "vulnerabilities": [] + }, + { + "change_type": "added", + "manifest": "Gemfile", + "ecosystem": "rubygems", + "name": "ruby-openid", + "version": "2.7.0", + "package_url": "pkg:gem/ruby-openid@2.7.0", + "license": null, + "source_repository_url": "https://github.com/openid/ruby-openid", + "vulnerabilities": [ + { + "severity": "critical", + "advisory_ghsa_id": "GHSA-fqfj-cmh6-hj49", + "advisory_summary": "Ruby OpenID", + "advisory_url": "https://github.com/advisories/GHSA-fqfj-cmh6-hj49" + } + ] + } + ] + }, + "dependency-graph-export-sbom-response": { + "value": { + "sbom": { + "SPDXID": "SPDXRef-DOCUMENT", + "spdxVersion": "SPDX-2.3", + "creationInfo": { + "created": "2021-09-01T00:00:00Z", + "creators": [ + "Tool: GitHub.com-Dependency-Graph" + ] + }, + "name": "github/example", + "dataLicense": "CC0-1.0", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", + "packages": [ + { + "name": "rails", + "SPDXID": "SPDXRef-Package", + "versionInfo": "1.0.0", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "licenseConcluded": "MIT", + "licenseDeclared": "MIT", + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" + } + ] + } + } + }, + "dependency-graph-create-snapshot-request": { + "value": { + "version": 0, + "sha": "ce587453ced02b1526dfb4cb910479d431683101", + "ref": "refs/heads/main", + "job": { + "correlator": "yourworkflowname_youractionname", + "id": "yourrunid" + }, + "detector": { + "name": "octo-detector", + "version": "0.0.1", + "url": "https://github.com/octo-org/octo-repo" + }, + "scanned": "2022-06-14T20:25:00Z", + "manifests": { + "package-lock.json": { + "name": "package-lock.json", + "file": { + "source_location": "src/package-lock.json" + }, + "resolved": { + "@actions/core": { + "package_url": "pkg:/npm/%40actions/core@1.1.9", + "dependencies": [ + "@actions/http-client" + ] + }, + "@actions/http-client": { + "package_url": "pkg:/npm/%40actions/http-client@1.0.7", + "dependencies": [ + "tunnel" + ] + }, + "tunnel": { + "package_url": "pkg:/npm/tunnel@0.0.6" + } + } + } + } + } + }, + "dependency-graph-create-snapshot-success": { + "value": { + "id": 12345, + "created_at": "2018-05-04T01:14:52Z", + "message": "Dependency results for the repo have been successfully updated.", + "result": "SUCCESS" + } + }, + "deployment-simple-example": { + "summary": "Simple example", + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + }, + "deployment": { + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": {}, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + }, + "deployment-status-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", + "id": 1, + "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", + "state": "success", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "description": "Deployment finished successfully.", + "environment": "production", + "target_url": "https://example.com/deployment/42/output", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", + "repository_url": "https://api.github.com/repos/octocat/example", + "environment_url": "https://test-branch.lab.acme.com", + "log_url": "https://example.com/deployment/42/output" + } + ] + }, + "deployment-status": { + "value": { + "url": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1", + "id": 1, + "node_id": "MDE2OkRlcGxveW1lbnRTdGF0dXMx", + "state": "success", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "description": "Deployment finished successfully.", + "environment": "production", + "target_url": "https://example.com/deployment/42/output", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "deployment_url": "https://api.github.com/repos/octocat/example/deployments/42", + "repository_url": "https://api.github.com/repos/octocat/example", + "environment_url": "https://test-branch.lab.acme.com", + "log_url": "https://example.com/deployment/42/output" + } + }, + "environments": { + "value": { + "total_count": 1, + "environments": [ + { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + ] + } + }, + "environment": { + "value": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + }, + "deployment-branch-policies-list": { + "value": { + "total_count": 2, + "branch_policies": [ + { + "id": 361471, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=", + "name": "release/*" + }, + { + "id": 361472, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=", + "name": "main" + } + ] + } + }, + "deployment-branch-policy-wildcard": { + "value": { + "id": 364662, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=", + "name": "release/*" + } + }, + "deployment-branch-policy-single-branch": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "main" + } + }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, + "deployment-protection-rules": { + "value": [ + { + "total_count": 2 + }, + { + "custom_deployment_protection_rules": [ + { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + }, + { + "id": 4, + "node_id": "MDE2OkRlcGxveW1lbnRTdHJ41128", + "enabled": true, + "app": { + "id": 1, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + } + ] + } + ] + }, + "deployment-protection-rule": { + "value": { + "id": 3, + "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv", + "enabled": true, + "app": { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + } + } + }, + "custom-deployment-protection-rule-apps": { + "value": [ + { + "total_count": 2 + }, + { + "available_custom_deployment_protection_rule_integrations": [ + { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + }, + { + "id": 2, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + ] + } + ] + }, + "repo-events-items": { + "value": [ + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22237752260", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z" + } + ] + }, + "minimal-repository-items-2": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": true, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + } + } + ] + }, + "short-blob": { + "value": { + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15" + } + }, + "blob": { + "value": { + "content": "Q29udGVudCBvZiB0aGUgYmxvYg==", + "encoding": "base64", + "url": "https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15", + "size": 19, + "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg==" + } + }, + "git-commit": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "my commit message", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132", + "sha": "827efc6d56897b048c772eb4087f854f46256132" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "sha": "7d1b31e74ee336d15cbd21741bc88a537ed063a0", + "html_url": "https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + }, + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + }, + "git-commit-2": { + "value": { + "sha": "7638417db6d59f3c431d3e1f261cc637155684cd", + "node_id": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd", + "author": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "committer": { + "date": "2014-11-07T22:01:45Z", + "name": "Monalisa Octocat", + "email": "octocat@github.com" + }, + "message": "added readme, because im a good github citizen", + "tree": { + "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb", + "sha": "691272480426f78a0138979dd3ce63b77f706feb" + }, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5", + "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5", + "html_url": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd" + } + ], + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + }, + "git-ref-items": { + "value": [ + { + "ref": "refs/heads/feature-a", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + }, + { + "ref": "refs/heads/feature-b", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b", + "object": { + "type": "commit", + "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac" + } + } + ] + }, + "git-ref": { + "value": { + "ref": "refs/heads/featureA", + "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==", + "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA", + "object": { + "type": "commit", + "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd" + } + } + }, + "git-tag": { + "value": { + "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", + "tag": "v0.0.1", + "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", + "message": "initial version", + "tagger": { + "name": "Monalisa Octocat", + "email": "octocat@github.com", + "date": "2014-11-07T22:01:45Z" + }, + "object": { + "type": "commit", + "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", + "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" + }, + "verification": { + "verified": false, + "reason": "unsigned", + "signature": null, + "payload": null, + "verified_at": null + } + } + }, + "git-tree": { + "value": { + "sha": "cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": true + } + }, + "git-tree-default-response": { + "summary": "Default response", + "value": { + "sha": "9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312", + "tree": [ + { + "path": "file.rb", + "mode": "100644", + "type": "blob", + "size": 30, + "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" + }, + { + "path": "subdir", + "mode": "040000", + "type": "tree", + "sha": "f484d249c660418515fb01c2b9662073663c242e", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e" + }, + { + "path": "exec_file", + "mode": "100755", + "type": "blob", + "size": 75, + "sha": "45b983be36b73c0788dc9cbcb76cbb80fc7bb057", + "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057" + } + ], + "truncated": false + } + }, + "git-tree-response-recursively-retrieving-a-tree": { + "summary": "Response recursively retrieving a tree", + "value": { + "sha": "fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "url": "https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7", + "tree": [ + { + "path": "subdir/file.txt", + "mode": "100644", + "type": "blob", + "size": 132, + "sha": "7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b", + "url": "https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b" + } + ], + "truncated": false + } + }, + "hook-items": { + "value": [ + { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + ] + }, + "hook": { + "value": { + "type": "Repository", + "id": 12345678, + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "content_type": "json", + "insecure_ssl": "0", + "url": "https://example.com/webhook" + }, + "updated_at": "2019-06-03T00:57:16Z", + "created_at": "2019-06-03T00:57:16Z", + "url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678", + "test_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test", + "ping_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings", + "deliveries_url": "https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + } + }, + "import": { + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "complete", + "status_text": "Done", + "has_large_files": true, + "large_files_size": 132331036, + "large_files_count": 1, + "authors_count": 4, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-2": { + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-example-1": { + "summary": "Example 1", + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "detecting", + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-example-2": { + "summary": "Example 2", + "value": { + "vcs": "tfvc", + "use_lfs": true, + "vcs_url": "http://tfs.mycompany.com/tfs/myproject", + "tfvc_project": "project1", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "import-response": { + "summary": "Response", + "value": { + "vcs": "subversion", + "use_lfs": true, + "vcs_url": "http://svn.mycompany.com/svn/myproject", + "status": "importing", + "status_text": "Importing...", + "has_large_files": false, + "large_files_size": 0, + "large_files_count": 0, + "authors_count": 0, + "commit_count": 1042, + "url": "https://api.github.com/repos/octocat/socm/import", + "html_url": "https://import.github.com/octocat/socm/import", + "authors_url": "https://api.github.com/repos/octocat/socm/import/authors", + "repository_url": "https://api.github.com/repos/octocat/socm" + } + }, + "porter-author-items": { + "value": [ + { + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268558, + "remote_id": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner", + "email": "svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268558", + "import_url": "https://api.github.com/repos/octocat/socm/import" + }, + { + "id": 2268559, + "remote_id": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "svner@example.com", + "email": "svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "name": "svner@example.com", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268559", + "import_url": "https://api.github.com/repos/octocat/socm/import" + } + ] + }, + "porter-author": { + "value": { + "id": 2268557, + "remote_id": "nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef", + "remote_name": "nobody", + "email": "hubot@github.com", + "name": "Hubot", + "url": "https://api.github.com/repos/octocat/socm/import/authors/2268557", + "import_url": "https://api.github.com/repos/octocat/socm/import" + } + }, + "porter-large-file-items": { + "value": [ + { + "ref_name": "refs/heads/master", + "path": "foo/bar/1", + "oid": "d3d9446802a44259755d38e6d163e820", + "size": 10485760 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/2", + "oid": "6512bd43d9caa6e02c990b0a82652dca", + "size": 11534336 + }, + { + "ref_name": "refs/heads/master", + "path": "foo/bar/3", + "oid": "c20ad4d76fe97759aa27a0c99bff6710", + "size": 12582912 + } + ] + }, + "interaction-limit-2": { + "value": { + "limit": "collaborators_only", + "origin": "repository", + "expires_at": "2018-08-17T04:18:39Z" + } + }, + "repository-invitation-items": { + "value": [ + { + "id": 1, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "repository-invitation": { + "value": { + "id": 1, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "invitee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "inviter": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "permissions": "write", + "created_at": "2016-06-13T14:52:50-05:00", + "expired": false, + "url": "https://api.github.com/user/repository_invitations/1296269", + "html_url": "https://github.com/octocat/Hello-World/invitations" + } + }, + "issue-items": { + "value": [ + { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pinned_comment": null, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ] + }, + "issue": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pinned_comment": null, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + }, + "issue-comment-items": { + "value": [ + { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + } + ] + }, + "issue-comment": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR", + "pin": null + } + }, + "issue-comment-pinned": { + "value": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR", + "pin": { + "pinned_at": "2021-01-01T00:00:00Z", + "pinned_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + }, + "issue-event-items": { + "value": [ + { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pinned_comment": null, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + ] + }, + "issue-event": { + "value": { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "issue": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pinned_comment": null, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "performed_via_github_app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + } + }, + "issue-with-pinned-comment": { + "value": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pinned_comment": { + "id": 1, + "node_id": "MDEyOklzc3VlQ29tbWVudDE=", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", + "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", + "body": "Me too", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "pin": { + "pinned_at": "2021-01-01T00:00:00Z", + "pinned_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "author_association": "COLLABORATOR" + }, + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 1, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "closed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + }, + "issue-event-for-issue-items": { + "value": [ + { + "id": 1, + "node_id": "MDEwOklzc3VlRXZlbnQx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/events/1", + "actor": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "event": "closed", + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "commit_url": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "created_at": "2011-04-14T16:00:49Z", + "performed_via_github_app": null, + "label": { + "name": "label", + "color": "red" + } + } + ] + }, + "issue-field-value-items": { + "value": [ + { + "issue_field_id": 1, + "node_id": "IFT_GDKND", + "data_type": "text", + "value": "DRI" + }, + { + "issue_field_id": 2, + "node_id": "IFSS_SADMS", + "data_type": "single_select", + "value": 1, + "single_select_option": { + "id": 1, + "name": "High", + "color": "red" + } + }, + { + "issue_field_id": 3, + "node_id": "IFN_POINTS", + "data_type": "number", + "value": 42 + }, + { + "issue_field_id": 4, + "node_id": "IFD_DUEDATE", + "data_type": "date", + "value": "2025-12-25" + } + ] + }, + "label-items": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + }, + { + "id": 208045947, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement", + "name": "enhancement", + "description": "New feature or request", + "color": "a2eeef", + "default": false + } + ] + }, + "label-items-2": { + "value": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ] + }, + "timeline-issue-events": { + "value": [ + { + "id": 6430295168, + "node_id": "LOE_lADODwFebM5HwC0kzwAAAAF_RoSA", + "url": "https://api.github.com/repos/github/roadmap/issues/events/6430295168", + "actor": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "event": "locked", + "commit_id": null, + "commit_url": null, + "created_at": "2022-04-13T20:49:13Z", + "lock_reason": null, + "performed_via_github_app": null + }, + { + "id": 6430296748, + "node_id": "LE_lADODwFebM5HwC0kzwAAAAF_Roqs", + "url": "https://api.github.com/repos/github/roadmap/issues/events/6430296748", + "actor": { + "login": "github-product-roadmap", + "id": 67656570, + "node_id": "MDQ6VXNlcjY3NjU2NTcw", + "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github-product-roadmap", + "html_url": "https://github.com/github-product-roadmap", + "followers_url": "https://api.github.com/users/github-product-roadmap/followers", + "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", + "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", + "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", + "repos_url": "https://api.github.com/users/github-product-roadmap/repos", + "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", + "type": "User", + "site_admin": false + }, + "event": "labeled", + "commit_id": null, + "commit_url": null, + "created_at": "2022-04-13T20:49:34Z", + "label": { + "name": "beta", + "color": "99dd88" + }, + "performed_via_github_app": null + }, + { + "id": 6635165802, + "node_id": "RTE_lADODwFebM5HwC0kzwAAAAGLfJhq", + "url": "https://api.github.com/repos/github/roadmap/issues/events/6635165802", + "actor": { + "login": "github-product-roadmap", + "id": 67656570, + "node_id": "MDQ6VXNlcjY3NjU2NTcw", + "avatar_url": "https://avatars.githubusercontent.com/u/67656570?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github-product-roadmap", + "html_url": "https://github.com/github-product-roadmap", + "followers_url": "https://api.github.com/users/github-product-roadmap/followers", + "following_url": "https://api.github.com/users/github-product-roadmap/following{/other_user}", + "gists_url": "https://api.github.com/users/github-product-roadmap/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github-product-roadmap/subscriptions", + "organizations_url": "https://api.github.com/users/github-product-roadmap/orgs", + "repos_url": "https://api.github.com/users/github-product-roadmap/repos", + "events_url": "https://api.github.com/users/github-product-roadmap/events{/privacy}", + "received_events_url": "https://api.github.com/users/github-product-roadmap/received_events", + "type": "User", + "site_admin": false + }, + "event": "renamed", + "commit_id": null, + "commit_url": null, + "created_at": "2022-05-18T19:29:01Z", + "rename": { + "from": "Secret scanning: dry-runs for enterprise-level custom patterns (cloud)", + "to": "Secret scanning: dry-runs for enterprise-level custom patterns" + }, + "performed_via_github_app": null + }, + { + "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857", + "html_url": "https://github.com/github/roadmap/issues/493#issuecomment-1130876857", + "issue_url": "https://api.github.com/repos/github/roadmap/issues/493", + "id": 1130876857, + "node_id": "IC_kwDODwFebM5DZ8-5", + "user": { + "login": "octocat", + "id": 94867353, + "node_id": "U_kgDOBaePmQ", + "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "created_at": "2022-05-19T00:52:15Z", + "updated_at": "2022-05-19T00:52:15Z", + "author_association": "COLLABORATOR", + "body": "🚒 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/", + "reactions": { + "url": "https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions", + "total_count": 0, + "+1": 0, + "-1": 0, + "laugh": 0, + "hooray": 0, + "confused": 0, + "heart": 0, + "rocket": 0, + "eyes": 0 + }, + "performed_via_github_app": null, + "event": "commented", + "actor": { + "login": "octocat", + "id": 94867353, + "node_id": "U_kgDOBaePmQ", + "avatar_url": "https://avatars.githubusercontent.com/u/94867353?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + } + } + ] + }, + "deploy-key-items": { + "value": [ + { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z", + "enabled": true + } + ] + }, + "deploy-key": { + "value": { + "id": 1, + "key": "ssh-rsa AAA...", + "url": "https://api.github.com/repos/octocat/Hello-World/keys/1", + "title": "octocat@octomac", + "verified": true, + "created_at": "2014-12-10T15:53:42Z", + "read_only": true, + "added_by": "octocat", + "last_used": "2022-01-10T15:53:42Z", + "enabled": true + } + }, + "label": { + "value": { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + }, + "label-2": { + "value": { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "description": "Small bug fix required", + "color": "b01f26", + "default": true + } + }, + "language": { + "value": { + "C": 78769, + "Python": 7769 + } + }, + "license-content": { + "value": { + "name": "LICENSE", + "path": "LICENSE", + "sha": "401c59dcc4570b954dd6d345e76199e1f4e76266", + "size": 1077, + "url": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", + "html_url": "https://github.com/benbalter/gman/blob/master/LICENSE", + "git_url": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", + "download_url": "https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true", + "type": "file", + "content": "VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\n", + "encoding": "base64", + "_links": { + "self": "https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master", + "git": "https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266", + "html": "https://github.com/benbalter/gman/blob/master/LICENSE" + }, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + } + } + }, + "merged-upstream": { + "value": { + "message": "Successfully fetched and fast-forwarded from upstream defunkt:main", + "merge_type": "fast-forward", + "base_branch": "defunkt:main" + } + }, + "milestone-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + } + ] + }, + "milestone": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + } + }, + "page": { + "value": { + "url": "https://api.github.com/repos/github/developer.github.com/pages", + "status": "built", + "cname": "developer.github.com", + "custom_404": false, + "html_url": "https://developer.github.com", + "source": { + "branch": "master", + "path": "/" + }, + "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", + "https_certificate": { + "state": "approved", + "description": "Certificate is approved", + "domains": [ + "developer.github.com" + ], + "expires_at": "2021-05-22" + }, + "https_enforced": true + } + }, + "page-build-items": { + "value": [ + { + "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", + "status": "built", + "error": { + "message": null + }, + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", + "duration": 2104, + "created_at": "2014-02-10T19:00:49Z", + "updated_at": "2014-02-10T19:00:51Z" + } + ] + }, + "page-build-status": { + "value": { + "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/latest", + "status": "queued" + } + }, + "page-build": { + "value": { + "url": "https://api.github.com/repos/github/developer.github.com/pages/builds/5472601", + "status": "built", + "error": { + "message": null + }, + "pusher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "commit": "351391cdcb88ffae71ec3028c91f375a8036a26b", + "duration": 2104, + "created_at": "2014-02-10T19:00:49Z", + "updated_at": "2014-02-10T19:00:51Z" + } + }, + "page-deployment": { + "value": { + "id": "4fd754f7e594640989b406850d0bc8f06a121251", + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", + "page_url": "developer.github.com" + } + }, + "pages-deployment-status": { + "value": { + "status": "succeed" + } + }, + "pages-health-check": { + "value": { + "domain": { + "host": "example.com", + "uri": "http://example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + }, + "alt_domain": { + "host": "www.example.com", + "uri": "http://www.example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + } + } + }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, + "pull-request": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "forks": 123, + "open_issues": 123, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "watchers": 123 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_merge_commit": true, + "forks": 123, + "open_issues": 123, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "watchers": 123 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "auto_merge": null, + "draft": false, + "merged": false, + "mergeable": true, + "rebaseable": true, + "mergeable_state": "clean", + "merged_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "comments": 10, + "review_comments": 0, + "maintainer_can_modify": true, + "commits": 3, + "additions": 100, + "deletions": 3, + "changed_files": 5 + } + }, + "pull-request-review-comment-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + ] + }, + "pull-request-review-comment-2": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + }, + "pull-request-review-comment-example-for-a-multi-line-comment": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + }, + "pull-request-review-comment": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 426899381, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + }, + "start_line": 1, + "original_start_line": 1, + "start_side": "RIGHT", + "line": 2, + "original_line": 2, + "side": "RIGHT" + } + }, + "diff-entry-items": { + "value": [ + { + "sha": "bbcd538c8e72b8c175046e27cc8f907076331401", + "filename": "file1.txt", + "status": "added", + "additions": 103, + "deletions": 21, + "changes": 124, + "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + } + ] + }, + "pull-request-merge-result-response-if-merge-was-successful": { + "value": { + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "merged": true, + "message": "Pull Request successfully merged" + } + }, + "simple-pull-request-review-request": { + "value": { + "users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ] + } + }, + "pull-request-review-request": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + }, + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "auto_merge": null, + "draft": false + } + }, + "pull-request-simple": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "id": 1, + "node_id": "MDExOlB1bGxSZXF1ZXN0MQ==", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch", + "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits", + "review_comments_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments", + "review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "number": 1347, + "state": "open", + "locked": true, + "title": "Amazing new feature", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Please pull these awesome changes in!", + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "active_lock_reason": "too heated", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:01:12Z", + "closed_at": "2011-01-26T19:01:12Z", + "merged_at": "2011-01-26T19:01:12Z", + "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + { + "login": "hubot", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/hubot", + "html_url": "https://github.com/hubot", + "followers_url": "https://api.github.com/users/hubot/followers", + "following_url": "https://api.github.com/users/hubot/following{/other_user}", + "gists_url": "https://api.github.com/users/hubot/gists{/gist_id}", + "starred_url": "https://api.github.com/users/hubot/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/hubot/subscriptions", + "organizations_url": "https://api.github.com/users/hubot/orgs", + "repos_url": "https://api.github.com/users/hubot/repos", + "events_url": "https://api.github.com/users/hubot/events{/privacy}", + "received_events_url": "https://api.github.com/users/hubot/received_events", + "type": "User", + "site_admin": true + } + ], + "requested_reviewers": [ + { + "login": "other_user", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/other_user_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/other_user", + "html_url": "https://github.com/other_user", + "followers_url": "https://api.github.com/users/other_user/followers", + "following_url": "https://api.github.com/users/other_user/following{/other_user}", + "gists_url": "https://api.github.com/users/other_user/gists{/gist_id}", + "starred_url": "https://api.github.com/users/other_user/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/other_user/subscriptions", + "organizations_url": "https://api.github.com/users/other_user/orgs", + "repos_url": "https://api.github.com/users/other_user/repos", + "events_url": "https://api.github.com/users/other_user/events{/privacy}", + "received_events_url": "https://api.github.com/users/other_user/received_events", + "type": "User", + "site_admin": false + } + ], + "requested_teams": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + ], + "head": { + "label": "octocat:new-topic", + "ref": "new-topic", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "base": { + "label": "octocat:master", + "ref": "master", + "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1347" + }, + "issue": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" + } + }, + "author_association": "OWNER", + "auto_merge": null, + "draft": false + } + }, + "pull-request-review-items": { + "value": [ + { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Here is the body for the review.", + "state": "APPROVED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "COLLABORATOR" + } + ] + }, + "pull-request-review": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "This is close to perfect! Please address the suggested inline change.", + "state": "CHANGES_REQUESTED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "COLLABORATOR" + } + }, + "pull-request-review-4": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Here is the body for the review.", + "state": "APPROVED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "COLLABORATOR" + } + }, + "pull-request-review-5": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "This is close to perfect! Please address the suggested inline change. And add more about this.", + "state": "CHANGES_REQUESTED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "COLLABORATOR" + } + }, + "review-comment-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1", + "pull_request_review_id": 42, + "id": 10, + "node_id": "MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw", + "diff_hunk": "@@ -16,33 +16,40 @@ public class Connection : IConnection...", + "path": "file1.txt", + "position": 1, + "original_position": 4, + "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", + "original_commit_id": "9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840", + "in_reply_to_id": 8, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Great stuff!", + "created_at": "2011-04-14T16:00:49Z", + "updated_at": "2011-04-14T16:00:49Z", + "html_url": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "author_association": "NONE", + "_links": { + "self": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/1" + }, + "html": { + "href": "https://github.com/octocat/Hello-World/pull/1#discussion-diff-1" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/1" + } + } + } + ] + }, + "pull-request-review-3": { + "value": { + "id": 80, + "node_id": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Here is the body for the review.", + "state": "DISMISSED", + "html_url": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80", + "pull_request_url": "https://api.github.com/repos/octocat/Hello-World/pulls/12", + "_links": { + "html": { + "href": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80" + }, + "pull_request": { + "href": "https://api.github.com/repos/octocat/Hello-World/pulls/12" + } + }, + "submitted_at": "2019-11-17T17:43:43Z", + "commit_id": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091", + "author_association": "COLLABORATOR" + } + }, + "content-file": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + }, + "release-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", + "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", + "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", + "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", + "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", + "id": 1, + "node_id": "MDc6UmVsZWFzZTE=", + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false, + "immutable": false, + "created_at": "2013-02-27T19:35:32Z", + "published_at": "2013-02-27T19:35:32Z", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assets": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + ] + }, + "release": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", + "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", + "assets_url": "https://api.github.com/repos/octocat/Hello-World/releases/1/assets", + "upload_url": "https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}", + "tarball_url": "https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0", + "zipball_url": "https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0", + "discussion_url": "https://github.com/octocat/Hello-World/discussions/90", + "id": 1, + "node_id": "MDc6UmVsZWFzZTE=", + "tag_name": "v1.0.0", + "target_commitish": "master", + "name": "v1.0.0", + "body": "Description of the release", + "draft": false, + "prerelease": false, + "immutable": false, + "created_at": "2013-02-27T19:35:32Z", + "published_at": "2013-02-27T19:35:32Z", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assets": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + }, + "release-asset": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "release-notes-content": { + "value": { + "name": "Release v1.0.0 is now available!", + "body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa" + } + }, + "release-asset-items": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "release-asset-response-for-successful-upload": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", + "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", + "id": 1, + "node_id": "MDEyOlJlbGVhc2VBc3NldDE=", + "name": "example.zip", + "label": "short description", + "state": "uploaded", + "content_type": "application/zip", + "size": 1024, + "digest": "sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255", + "download_count": 42, + "created_at": "2013-02-27T19:35:32Z", + "updated_at": "2013-02-27T19:35:32Z", + "uploader": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "repository-rule-items": { + "value": [ + { + "type": "commit_message_pattern", + "ruleset_source_type": "Repository", + "ruleset_source": "monalisa/my-repo", + "ruleset_id": 42, + "parameters": { + "operator": "starts_with", + "pattern": "issue" + } + }, + { + "type": "commit_author_email_pattern", + "ruleset_source_type": "Organization", + "ruleset_source": "my-org", + "ruleset_id": 73, + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + }, + "repository-ruleset-items": { + "value": [ + { + "id": 42, + "name": "super cool ruleset", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/42" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + }, + { + "id": 314, + "name": "Another ruleset", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "enabled", + "node_id": "RRS_lACkVXNlcgQQ", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/314" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/314" + } + }, + "created_at": "2023-08-15T08:43:03Z", + "updated_at": "2023-09-23T16:29:47Z" + } + ] + }, + "repository-ruleset": { + "value": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/repos/monalisa/my-repo/rulesets/42" + }, + "html": { + "href": "https://github.com/monalisa/my-repo/rules/42" + } + }, + "created_at": "2023-07-15T08:43:03Z", + "updated_at": "2023-08-23T16:29:47Z" + } + }, + "repository-ruleset-version-with-state": { + "value": { + "version_id": 3, + "actor": { + "id": 1, + "type": "User" + }, + "updated_at": "2024-10-23T16:29:47Z", + "state": { + "id": 42, + "name": "super cool ruleset", + "target": "branch", + "source_type": "Repository", + "source": "monalisa/my-repo", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "ref_name": { + "include": [ + "refs/heads/main", + "refs/heads/master" + ], + "exclude": [ + "refs/heads/dev*" + ] + } + }, + "rules": [ + { + "type": "commit_author_email_pattern", + "parameters": { + "operator": "contains", + "pattern": "github" + } + } + ] + } + } + }, + "secret-scanning-alert-list": { + "value": [ + { + "number": 2, + "created_at": "2020-11-06T18:48:51Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/2", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations", + "state": "resolved", + "resolution": "false_positive", + "resolved_at": "2020-11-07T02:47:13Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "adafruit_io_key", + "secret_type_display_name": "Adafruit IO Key", + "secret": "aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX", + "push_protection_bypassed_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypassed": true, + "push_protection_bypassed_at": "2020-11-06T21:48:51Z", + "push_protection_bypass_request_reviewer": { + "login": "octocat", + "id": 3, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/3?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "push_protection_bypass_request_reviewer_comment": "Example response", + "push_protection_bypass_request_comment": "Example comment", + "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", + "resolution_comment": "Example comment", + "validity": "inactive", + "publicly_leaked": false, + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "secret-scanning-alert-open": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "push_protection_bypassed_by": null, + "push_protection_bypassed": false, + "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": null, + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false + } + }, + "secret-scanning-alert-resolved": { + "value": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42", + "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", + "state": "resolved", + "resolution": "used_in_tests", + "resolved_at": "2020-11-16T22:42:07Z", + "resolved_by": { + "login": "monalisa", + "id": 2, + "node_id": "MDQ6VXNlcjI=", + "avatar_url": "https://alambic.github.com/avatars/u/2?", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "site_admin": true + }, + "secret_type": "mailchimp_api_key", + "secret_type_display_name": "Mailchimp API Key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "push_protection_bypassed": false, + "push_protection_bypassed_by": null, + "push_protection_bypassed_at": null, + "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, + "push_protection_bypass_request_comment": null, + "push_protection_bypass_request_html_url": null, + "resolution_comment": "Example comment", + "validity": "unknown", + "publicly_leaked": false, + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "secret-scanning-location-list": { + "value": [ + { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + { + "type": "wiki_commit", + "details": { + "path": "/example/Home.md", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" + } + }, + { + "type": "issue_title", + "details": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + { + "type": "issue_body", + "details": { + "issue_body_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + } + }, + { + "type": "issue_comment", + "details": { + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" + } + }, + { + "type": "discussion_title", + "details": { + "discussion_title_url": "https://github.com/community/community/discussions/39082" + } + }, + { + "type": "discussion_body", + "details": { + "discussion_body_url": "https://github.com/community/community/discussions/39082#discussion-4566270" + } + }, + { + "type": "discussion_comment", + "details": { + "discussion_comment_url": "https://github.com/community/community/discussions/39082#discussioncomment-4158232" + } + }, + { + "type": "pull_request_title", + "details": { + "pull_request_title_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + { + "type": "pull_request_body", + "details": { + "pull_request_body_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846" + } + }, + { + "type": "pull_request_comment", + "details": { + "pull_request_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898" + } + }, + { + "type": "pull_request_review", + "details": { + "pull_request_review_url": "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" + } + }, + { + "type": "pull_request_review_comment", + "details": { + "pull_request_review_comment_url": "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" + } + } + ] + }, + "secret-scanning-push-protection-bypass": { + "value": { + "reason": "will_fix_later", + "expire_at": "2020-11-06T18:18:30Z", + "token_type": "mailchimp_api_key" + } + }, + "secret-scanning-scan-history": { + "value": { + "incremental_scans": [ + { + "type": "git", + "status": "completed", + "completed_at": "2024-10-07T02:47:00Z" + } + ], + "backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:50:00Z" + }, + { + "type": "issue", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:49:00Z" + }, + { + "type": "discussion", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:48:00Z" + } + ], + "pattern_update_scans": [ + { + "type": "discussion", + "status": "in_progress", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:51:00Z" + } + ], + "custom_pattern_backfill_scans": [ + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z", + "pattern_slug": "my-custom-pattern", + "pattern_scope": "enterprise" + }, + { + "type": "git", + "status": "completed", + "started_at": "2024-10-07T02:47:00Z", + "completed_at": "2024-10-07T02:55:00Z", + "pattern_slug": "my-custom-pattern", + "pattern_scope": "organization" + } + ] + } + }, + "repository-advisory": { + "value": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A short summary of the advisory.", + "description": "A detailed description of what the advisory entails.", + "severity": "critical", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "publisher": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": "CVE-2050-00000" + } + ], + "state": "published", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": "2020-01-03T00:00:00Z", + "closed_at": null, + "withdrawn_at": null, + "submission": null, + "vulnerabilities": [ + { + "package": { + "ecosystem": "pip", + "name": "a-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.1", + "patched_versions": "1.0.1", + "vulnerable_functions": [ + "function1" + ] + }, + { + "package": { + "ecosystem": "pip", + "name": "another-package" + }, + "vulnerable_version_range": ">= 1.0.0, < 1.0.2", + "patched_versions": "1.0.2", + "vulnerable_functions": [ + "function2" + ] + } + ], + "cvss": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_severities": { + "cvss_v3": { + "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", + "score": 9.8 + }, + "cvss_v4": { + "vector_string": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", + "score": 9.3 + } + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "analyst" + } + ], + "credits_detailed": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "analyst", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octokitten", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "received_events_url": "https://api.github.com/users/octokitten/received_events", + "type": "User", + "site_admin": false + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo-ghsa-abcd-1234-efgh", + "full_name": "octo-org/octo-repo-ghsa-abcd-1234-efgh", + "owner": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "private": true, + "html_url": "https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number}", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads", + "events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha}", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number}", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id}", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha}" + } + } + }, + "repository-advisory-pvr": { + "value": { + "ghsa_id": "GHSA-abcd-1234-efgh", + "cve_id": "CVE-2050-00000", + "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh", + "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh", + "summary": "A newly discovered vulnerability", + "description": "A more in-depth description of what the problem is.", + "severity": "high", + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "publisher": null, + "identifiers": [ + { + "type": "GHSA", + "value": "GHSA-abcd-1234-efgh" + }, + { + "type": "CVE", + "value": null + } + ], + "state": "triage", + "created_at": "2020-01-01T00:00:00Z", + "updated_at": "2020-01-02T00:00:00Z", + "published_at": null, + "closed_at": null, + "withdrawn_at": null, + "submission": { + "accepted": false + }, + "vulnerabilities": [ + { + "package": { + "ecosystem": "npm", + "name": "a-package" + }, + "vulnerable_version_range": "< 1.0.0", + "patched_versions": "1.0.0", + "vulnerable_functions": [ + "important_function" + ] + } + ], + "cvss": null, + "cvss_severities": { + "cvss_v3": null, + "cvss_v4": null + }, + "cwes": [ + { + "cwe_id": "CWE-123", + "name": "A CWE" + } + ], + "cwe_ids": [ + "CWE-123" + ], + "credits": [ + { + "login": "octocat", + "type": "finder" + } + ], + "credits_detailed": [ + { + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "type": "finder", + "state": "accepted" + } + ], + "collaborating_users": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "collaborating_teams": [ + { + "name": "Justice League", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "permission": "admin", + "parent": null + } + ], + "private_fork": null + } + }, + "simple-user-items-default-response": { + "summary": "Default response", + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + }, + "stargazer-items-alternative-response-with-star-creation-timestamps": { + "summary": "Alternative response with star creation timestamps", + "value": [ + { + "starred_at": "2011-01-16T19:06:43Z", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "code-frequency-stat-items": { + "value": [ + [ + 1302998400, + 1124, + -435 + ] + ] + }, + "commit-activity-items": { + "value": [ + { + "days": [ + 0, + 3, + 26, + 20, + 39, + 1, + 0 + ], + "total": 89, + "week": 1336280400 + } + ] + }, + "contributor-activity-items": { + "value": [ + { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "total": 135, + "weeks": [ + { + "w": 1367712000, + "a": 6898, + "d": 77, + "c": 10 + } + ] + } + ] + }, + "participation-stats": { + "value": { + "all": [ + 11, + 21, + 15, + 2, + 8, + 1, + 8, + 23, + 17, + 21, + 11, + 10, + 33, + 91, + 38, + 34, + 22, + 23, + 32, + 3, + 43, + 87, + 71, + 18, + 13, + 5, + 13, + 16, + 66, + 27, + 12, + 45, + 110, + 117, + 13, + 8, + 18, + 9, + 19, + 26, + 39, + 12, + 20, + 31, + 46, + 91, + 45, + 10, + 24, + 9, + 29, + 7 + ], + "owner": [ + 3, + 2, + 3, + 0, + 2, + 0, + 5, + 14, + 7, + 9, + 1, + 5, + 0, + 48, + 19, + 2, + 0, + 1, + 10, + 2, + 23, + 40, + 35, + 8, + 8, + 2, + 10, + 6, + 30, + 0, + 2, + 9, + 53, + 104, + 3, + 3, + 10, + 4, + 7, + 11, + 21, + 4, + 4, + 22, + 26, + 63, + 11, + 2, + 14, + 1, + 10, + 3 + ] + } + }, + "code-frequency-stat-items-2": { + "value": [ + [ + 0, + 0, + 5 + ], + [ + 0, + 1, + 43 + ], + [ + 0, + 2, + 21 + ] + ] + }, + "status": { + "value": { + "url": "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", + "id": 1, + "node_id": "MDY6U3RhdHVzMQ==", + "state": "success", + "description": "Build has completed successfully", + "target_url": "https://ci.example.com/1000/output", + "context": "continuous-integration/jenkins", + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "repository-subscription-response-if-you-subscribe-to-the-repository": { + "value": { + "subscribed": true, + "ignored": false, + "reason": null, + "created_at": "2012-10-06T21:34:12Z", + "url": "https://api.github.com/repos/octocat/example/subscription", + "repository_url": "https://api.github.com/repos/octocat/example" + } + }, + "repository-subscription": { + "value": { + "subscribed": true, + "ignored": false, + "reason": null, + "created_at": "2012-10-06T21:34:12Z", + "url": "https://api.github.com/repos/octocat/example/subscription", + "repository_url": "https://api.github.com/repos/octocat/example" + } + }, + "tag-items": { + "value": [ + { + "name": "v0.1", + "commit": { + "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc", + "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc" + }, + "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1", + "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "topic": { + "value": { + "names": [ + "octocat", + "atom", + "electron", + "api" + ] + } + }, + "clone-traffic": { + "value": { + "count": 173, + "uniques": 128, + "clones": [ + { + "timestamp": "2016-10-10T00:00:00Z", + "count": 2, + "uniques": 1 + }, + { + "timestamp": "2016-10-11T00:00:00Z", + "count": 17, + "uniques": 16 + }, + { + "timestamp": "2016-10-12T00:00:00Z", + "count": 21, + "uniques": 15 + }, + { + "timestamp": "2016-10-13T00:00:00Z", + "count": 8, + "uniques": 7 + }, + { + "timestamp": "2016-10-14T00:00:00Z", + "count": 5, + "uniques": 5 + }, + { + "timestamp": "2016-10-15T00:00:00Z", + "count": 2, + "uniques": 2 + }, + { + "timestamp": "2016-10-16T00:00:00Z", + "count": 8, + "uniques": 7 + }, + { + "timestamp": "2016-10-17T00:00:00Z", + "count": 26, + "uniques": 15 + }, + { + "timestamp": "2016-10-18T00:00:00Z", + "count": 19, + "uniques": 17 + }, + { + "timestamp": "2016-10-19T00:00:00Z", + "count": 19, + "uniques": 14 + }, + { + "timestamp": "2016-10-20T00:00:00Z", + "count": 19, + "uniques": 15 + }, + { + "timestamp": "2016-10-21T00:00:00Z", + "count": 9, + "uniques": 7 + }, + { + "timestamp": "2016-10-22T00:00:00Z", + "count": 5, + "uniques": 5 + }, + { + "timestamp": "2016-10-23T00:00:00Z", + "count": 6, + "uniques": 5 + }, + { + "timestamp": "2016-10-24T00:00:00Z", + "count": 7, + "uniques": 5 + } + ] + } + }, + "content-traffic-items": { + "value": [ + { + "path": "/github/hubot", + "title": "github/hubot: A customizable life embetterment robot.", + "count": 3542, + "uniques": 2225 + }, + { + "path": "/github/hubot/blob/master/docs/scripting.md", + "title": "hubot/scripting.md at master Β· github/hubot Β· GitHub", + "count": 1707, + "uniques": 804 + }, + { + "path": "/github/hubot/tree/master/docs", + "title": "hubot/docs at master Β· github/hubot Β· GitHub", + "count": 685, + "uniques": 435 + }, + { + "path": "/github/hubot/tree/master/src", + "title": "hubot/src at master Β· github/hubot Β· GitHub", + "count": 577, + "uniques": 347 + }, + { + "path": "/github/hubot/blob/master/docs/index.md", + "title": "hubot/index.md at master Β· github/hubot Β· GitHub", + "count": 379, + "uniques": 259 + }, + { + "path": "/github/hubot/blob/master/docs/adapters.md", + "title": "hubot/adapters.md at master Β· github/hubot Β· GitHub", + "count": 354, + "uniques": 201 + }, + { + "path": "/github/hubot/tree/master/examples", + "title": "hubot/examples at master Β· github/hubot Β· GitHub", + "count": 340, + "uniques": 260 + }, + { + "path": "/github/hubot/blob/master/docs/deploying/heroku.md", + "title": "hubot/heroku.md at master Β· github/hubot Β· GitHub", + "count": 324, + "uniques": 217 + }, + { + "path": "/github/hubot/blob/master/src/robot.coffee", + "title": "hubot/robot.coffee at master Β· github/hubot Β· GitHub", + "count": 293, + "uniques": 191 + }, + { + "path": "/github/hubot/blob/master/LICENSE.md", + "title": "hubot/LICENSE.md at master Β· github/hubot Β· GitHub", + "count": 281, + "uniques": 222 + } + ] + }, + "referrer-traffic-items": { + "value": [ + { + "referrer": "Google", + "count": 4, + "uniques": 3 + }, + { + "referrer": "stackoverflow.com", + "count": 2, + "uniques": 2 + }, + { + "referrer": "eggsonbread.com", + "count": 1, + "uniques": 1 + }, + { + "referrer": "yandex.ru", + "count": 1, + "uniques": 1 + } + ] + }, + "view-traffic": { + "value": { + "count": 14850, + "uniques": 3782, + "views": [ + { + "timestamp": "2016-10-10T00:00:00Z", + "count": 440, + "uniques": 143 + }, + { + "timestamp": "2016-10-11T00:00:00Z", + "count": 1308, + "uniques": 414 + }, + { + "timestamp": "2016-10-12T00:00:00Z", + "count": 1486, + "uniques": 452 + }, + { + "timestamp": "2016-10-13T00:00:00Z", + "count": 1170, + "uniques": 401 + }, + { + "timestamp": "2016-10-14T00:00:00Z", + "count": 868, + "uniques": 266 + }, + { + "timestamp": "2016-10-15T00:00:00Z", + "count": 495, + "uniques": 157 + }, + { + "timestamp": "2016-10-16T00:00:00Z", + "count": 524, + "uniques": 175 + }, + { + "timestamp": "2016-10-17T00:00:00Z", + "count": 1263, + "uniques": 412 + }, + { + "timestamp": "2016-10-18T00:00:00Z", + "count": 1402, + "uniques": 417 + }, + { + "timestamp": "2016-10-19T00:00:00Z", + "count": 1394, + "uniques": 424 + }, + { + "timestamp": "2016-10-20T00:00:00Z", + "count": 1492, + "uniques": 448 + }, + { + "timestamp": "2016-10-21T00:00:00Z", + "count": 1153, + "uniques": 332 + }, + { + "timestamp": "2016-10-22T00:00:00Z", + "count": 566, + "uniques": 168 + }, + { + "timestamp": "2016-10-23T00:00:00Z", + "count": 675, + "uniques": 184 + }, + { + "timestamp": "2016-10-24T00:00:00Z", + "count": 614, + "uniques": 237 + } + ] + } + }, + "minimal-repository": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "subscribers_count": 42, + "network_count": 0 + } + } + }, + "public-repository-items": { + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + } + ] + }, + "code-search-result-item-paginated": { + "value": { + "total_count": 7, + "incomplete_results": false, + "items": [ + { + "name": "classes.js", + "path": "src/attributes/classes.js", + "sha": "d7212f9dee2dcc18f084d7df8f417b80846ded5a", + "url": "https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4", + "git_url": "https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a", + "html_url": "https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js", + "repository": { + "id": 167174, + "node_id": "MDEwOlJlcG9zaXRvcnkxNjcxNzQ=", + "name": "jquery", + "full_name": "jquery/jquery", + "owner": { + "login": "jquery", + "id": 70142, + "node_id": "MDQ6VXNlcjcwMTQy", + "avatar_url": "https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png", + "gravatar_id": "", + "url": "https://api.github.com/users/jquery", + "html_url": "https://github.com/jquery", + "followers_url": "https://api.github.com/users/jquery/followers", + "following_url": "https://api.github.com/users/jquery/following{/other_user}", + "gists_url": "https://api.github.com/users/jquery/gists{/gist_id}", + "starred_url": "https://api.github.com/users/jquery/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/jquery/subscriptions", + "organizations_url": "https://api.github.com/users/jquery/orgs", + "repos_url": "https://api.github.com/users/jquery/repos", + "events_url": "https://api.github.com/users/jquery/events{/privacy}", + "received_events_url": "https://api.github.com/users/jquery/received_events", + "type": "Organization", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/jquery/jquery", + "description": "jQuery JavaScript Library", + "fork": false, + "url": "https://api.github.com/repos/jquery/jquery", + "forks_url": "https://api.github.com/repos/jquery/jquery/forks", + "keys_url": "https://api.github.com/repos/jquery/jquery/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/jquery/jquery/teams", + "hooks_url": "https://api.github.com/repos/jquery/jquery/hooks", + "issue_events_url": "https://api.github.com/repos/jquery/jquery/issues/events{/number}", + "events_url": "https://api.github.com/repos/jquery/jquery/events", + "assignees_url": "https://api.github.com/repos/jquery/jquery/assignees{/user}", + "branches_url": "https://api.github.com/repos/jquery/jquery/branches{/branch}", + "tags_url": "https://api.github.com/repos/jquery/jquery/tags", + "blobs_url": "https://api.github.com/repos/jquery/jquery/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/jquery/jquery/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/jquery/jquery/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/jquery/jquery/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/jquery/jquery/statuses/{sha}", + "languages_url": "https://api.github.com/repos/jquery/jquery/languages", + "stargazers_url": "https://api.github.com/repos/jquery/jquery/stargazers", + "contributors_url": "https://api.github.com/repos/jquery/jquery/contributors", + "subscribers_url": "https://api.github.com/repos/jquery/jquery/subscribers", + "subscription_url": "https://api.github.com/repos/jquery/jquery/subscription", + "commits_url": "https://api.github.com/repos/jquery/jquery/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/jquery/jquery/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/jquery/jquery/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/jquery/jquery/issues/comments/{number}", + "contents_url": "https://api.github.com/repos/jquery/jquery/contents/{+path}", + "compare_url": "https://api.github.com/repos/jquery/jquery/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/jquery/jquery/merges", + "archive_url": "https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/jquery/jquery/downloads", + "issues_url": "https://api.github.com/repos/jquery/jquery/issues{/number}", + "pulls_url": "https://api.github.com/repos/jquery/jquery/pulls{/number}", + "milestones_url": "https://api.github.com/repos/jquery/jquery/milestones{/number}", + "notifications_url": "https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/jquery/jquery/labels{/name}", + "deployments_url": "http://api.github.com/repos/octocat/Hello-World/deployments", + "releases_url": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "score": 1 + } + ] + } + }, + "commit-search-result-item-paginated": { + "value": { + "total_count": 1, + "incomplete_results": false, + "items": [ + { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "sha": "bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "html_url": "https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments", + "commit": { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f", + "author": { + "date": "2014-02-04T14:38:36-08:00", + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "date": "2014-02-12T15:18:55-08:00", + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "message": "Create styles.css and updated README", + "tree": { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68", + "sha": "a639e96f9038797fba6e0469f94a4b0cc459fa68" + }, + "comment_count": 8 + }, + "author": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "committer": {}, + "parents": [ + { + "url": "https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", + "html_url": "https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4", + "sha": "a30c19e3f13765a3b48829788bc1cb8b4e95cee4" + } + ], + "repository": { + "id": 1300192, + "node_id": "MDEwOlJlcG9zaXRvcnkxMzAwMTky", + "name": "Spoon-Knife", + "full_name": "octocat/Spoon-Knife", + "owner": { + "login": "octocat", + "id": 583231, + "node_id": "MDQ6VXNlcjU4MzIzMQ==", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=3", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Spoon-Knife", + "description": "This repo is for demonstration purposes only.", + "fork": false, + "url": "https://api.github.com/repos/octocat/Spoon-Knife", + "forks_url": "https://api.github.com/repos/octocat/Spoon-Knife/forks", + "keys_url": "https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat/Spoon-Knife/teams", + "hooks_url": "https://api.github.com/repos/octocat/Spoon-Knife/hooks", + "issue_events_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat/Spoon-Knife/events", + "assignees_url": "https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/tags", + "blobs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat/Spoon-Knife/languages", + "stargazers_url": "https://api.github.com/repos/octocat/Spoon-Knife/stargazers", + "contributors_url": "https://api.github.com/repos/octocat/Spoon-Knife/contributors", + "subscribers_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Spoon-Knife/subscription", + "commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat/Spoon-Knife/merges", + "archive_url": "https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat/Spoon-Knife/downloads", + "issues_url": "https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat/Spoon-Knife/deployments" + }, + "score": 1, + "node_id": "MDQ6VXNlcjU4MzIzMQ==" + } + ] + } + }, + "issue-search-result-item-paginated": { + "summary": "Hybrid search response", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "hybrid", + "items": [ + { + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", + "repository_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit", + "labels_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}", + "comments_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments", + "events_url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events", + "html_url": "https://github.com/batterseapower/pinyin-toolkit/issues/132", + "id": 35802, + "node_id": "MDU6SXNzdWUzNTgwMg==", + "number": 132, + "title": "Line Number Indexes Beyond 20 Not Displayed", + "user": { + "login": "Nick3C", + "id": 90254, + "node_id": "MDQ6VXNlcjkwMjU0", + "avatar_url": "https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/Nick3C", + "html_url": "https://github.com/Nick3C", + "followers_url": "https://api.github.com/users/Nick3C/followers", + "following_url": "https://api.github.com/users/Nick3C/following{/other_user}", + "gists_url": "https://api.github.com/users/Nick3C/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Nick3C/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Nick3C/subscriptions", + "organizations_url": "https://api.github.com/users/Nick3C/orgs", + "repos_url": "https://api.github.com/users/Nick3C/repos", + "events_url": "https://api.github.com/users/Nick3C/events{/privacy}", + "received_events_url": "https://api.github.com/users/Nick3C/received_events", + "type": "User", + "site_admin": true + }, + "labels": [ + { + "id": 4, + "node_id": "MDU6TGFiZWw0", + "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug", + "name": "bug", + "color": "ff0000" + } + ], + "state": "open", + "assignee": null, + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "comments": 15, + "created_at": "2009-07-12T20:10:41Z", + "updated_at": "2009-07-19T09:23:43Z", + "closed_at": null, + "pull_request": { + "url": "https://api/github.com/repos/octocat/Hello-World/pull/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347" + }, + "body": "...", + "score": 1, + "locked": true, + "author_association": "COLLABORATOR", + "state_reason": "completed" + } + ] + } + }, + "issue-search-result-item-paginated-lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } + }, + "label-search-result-item-paginated": { + "value": { + "total_count": 2, + "incomplete_results": false, + "items": [ + { + "id": 418327088, + "node_id": "MDU6TGFiZWw0MTgzMjcwODg=", + "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement", + "name": "enhancement", + "color": "84b6eb", + "default": true, + "description": "New feature or request.", + "score": 1 + }, + { + "id": 418327086, + "node_id": "MDU6TGFiZWw0MTgzMjcwODY=", + "url": "https://api.github.com/repos/octocat/linguist/labels/bug", + "name": "bug", + "color": "ee0701", + "default": true, + "description": "Something isn't working.", + "score": 1 + } + ] + } + }, + "repo-search-result-item-paginated": { + "value": { + "total_count": 40, + "incomplete_results": false, + "items": [ + { + "id": 3081286, + "node_id": "MDEwOlJlcG9zaXRvcnkzMDgxMjg2", + "name": "Tetris", + "full_name": "dtrupenn/Tetris", + "owner": { + "login": "dtrupenn", + "id": 872147, + "node_id": "MDQ6VXNlcjg3MjE0Nw==", + "avatar_url": "https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/dtrupenn", + "received_events_url": "https://api.github.com/users/dtrupenn/received_events", + "type": "User", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "site_admin": true + }, + "private": false, + "html_url": "https://github.com/dtrupenn/Tetris", + "description": "A C implementation of Tetris using Pennsim through LC4", + "fork": false, + "url": "https://api.github.com/repos/dtrupenn/Tetris", + "created_at": "2012-01-01T00:31:50Z", + "updated_at": "2013-01-05T17:58:47Z", + "pushed_at": "2012-01-01T00:37:02Z", + "homepage": "https://github.com", + "size": 524, + "stargazers_count": 1, + "watchers_count": 1, + "language": "Assembly", + "forks_count": 0, + "open_issues_count": 0, + "master_branch": "master", + "default_branch": "master", + "score": 1, + "archive_url": "https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}", + "blobs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/dtrupenn/Tetris/comments{/number}", + "commits_url": "https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}", + "compare_url": "https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}", + "contributors_url": "https://api.github.com/repos/dtrupenn/Tetris/contributors", + "deployments_url": "https://api.github.com/repos/dtrupenn/Tetris/deployments", + "downloads_url": "https://api.github.com/repos/dtrupenn/Tetris/downloads", + "events_url": "https://api.github.com/repos/dtrupenn/Tetris/events", + "forks_url": "https://api.github.com/repos/dtrupenn/Tetris/forks", + "git_commits_url": "https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}", + "git_url": "git:github.com/dtrupenn/Tetris.git", + "issue_comment_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}", + "issues_url": "https://api.github.com/repos/dtrupenn/Tetris/issues{/number}", + "keys_url": "https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}", + "labels_url": "https://api.github.com/repos/dtrupenn/Tetris/labels{/name}", + "languages_url": "https://api.github.com/repos/dtrupenn/Tetris/languages", + "merges_url": "https://api.github.com/repos/dtrupenn/Tetris/merges", + "milestones_url": "https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}", + "notifications_url": "https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}", + "releases_url": "https://api.github.com/repos/dtrupenn/Tetris/releases{/id}", + "ssh_url": "git@github.com:dtrupenn/Tetris.git", + "stargazers_url": "https://api.github.com/repos/dtrupenn/Tetris/stargazers", + "statuses_url": "https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/dtrupenn/Tetris/subscribers", + "subscription_url": "https://api.github.com/repos/dtrupenn/Tetris/subscription", + "tags_url": "https://api.github.com/repos/dtrupenn/Tetris/tags", + "teams_url": "https://api.github.com/repos/dtrupenn/Tetris/teams", + "trees_url": "https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}", + "clone_url": "https://github.com/dtrupenn/Tetris.git", + "mirror_url": "git:git.example.com/dtrupenn/Tetris", + "hooks_url": "https://api.github.com/repos/dtrupenn/Tetris/hooks", + "svn_url": "https://svn.github.com/dtrupenn/Tetris", + "forks": 1, + "open_issues": 1, + "watchers": 1, + "has_issues": true, + "has_projects": true, + "has_pages": true, + "has_wiki": true, + "has_downloads": true, + "archived": true, + "disabled": true, + "visibility": "private", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + } + } + ] + } + }, + "topic-search-result-item-paginated": { + "value": { + "total_count": 6, + "incomplete_results": false, + "items": [ + { + "name": "ruby", + "display_name": "Ruby", + "short_description": "Ruby is a scripting language designed for simplified object-oriented programming.", + "description": "Ruby was developed byΒ Yukihiro \"Matz\" MatsumotoΒ in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.", + "created_by": "Yukihiro Matsumoto", + "released": "December 21, 1995", + "created_at": "2016-11-28T22:03:59Z", + "updated_at": "2017-10-30T18:16:32Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "rails", + "display_name": "Rails", + "short_description": "Ruby on Rails (Rails) is a web application framework written in Ruby.", + "description": "Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.", + "created_by": "David Heinemeier Hansson", + "released": "December 13 2005", + "created_at": "2016-12-09T17:03:50Z", + "updated_at": "2017-10-30T16:20:19Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "python", + "display_name": "Python", + "short_description": "Python is a dynamically typed programming language.", + "description": "Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.", + "created_by": "Guido van Rossum", + "released": "February 20, 1991", + "created_at": "2016-12-07T00:07:02Z", + "updated_at": "2017-10-27T22:45:43Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "jekyll", + "display_name": "Jekyll", + "short_description": "Jekyll is a simple, blog-aware static site generator.", + "description": "Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.", + "created_by": "Tom Preston-Werner", + "released": "2008", + "created_at": "2016-12-16T21:53:08Z", + "updated_at": "2017-10-27T19:00:24Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "sass", + "display_name": "Sass", + "short_description": "Sass is a stable extension to classic CSS.", + "description": "Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.", + "created_by": "Hampton Catlin, Natalie Weizenbaum, Chris Eppstein", + "released": "November 28, 2006", + "created_at": "2016-12-16T21:53:45Z", + "updated_at": "2018-01-16T16:30:40Z", + "featured": true, + "curated": true, + "score": 1 + }, + { + "name": "homebrew", + "display_name": "Homebrew", + "short_description": "Homebrew is a package manager for macOS.", + "description": "Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.", + "created_by": "Max Howell", + "released": "2009", + "created_at": "2016-12-17T20:30:44Z", + "updated_at": "2018-02-06T16:14:56Z", + "featured": true, + "curated": true, + "score": 1 + } + ] + } + }, + "user-search-result-item-paginated": { + "value": { + "total_count": 12, + "incomplete_results": false, + "items": [ + { + "login": "mojombo", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png", + "gravatar_id": "", + "url": "https://api.github.com/users/mojombo", + "html_url": "https://github.com/mojombo", + "followers_url": "https://api.github.com/users/mojombo/followers", + "subscriptions_url": "https://api.github.com/users/mojombo/subscriptions", + "organizations_url": "https://api.github.com/users/mojombo/orgs", + "repos_url": "https://api.github.com/users/mojombo/repos", + "received_events_url": "https://api.github.com/users/mojombo/received_events", + "type": "User", + "score": 1, + "following_url": "https://api.github.com/users/mojombo/following{/other_user}", + "gists_url": "https://api.github.com/users/mojombo/gists{/gist_id}", + "starred_url": "https://api.github.com/users/mojombo/starred{/owner}{/repo}", + "events_url": "https://api.github.com/users/mojombo/events{/privacy}", + "site_admin": true + } + ] + } + }, + "team-repository-alternative-response-with-extra-repository-information": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "maintain": false, + "push": false, + "triage": false, + "pull": true + }, + "role_name": "read", + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "private-user-response-with-public-and-private-profile-information": { + "summary": "Response with public and private profile information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "private_gists": 81, + "total_private_repos": 100, + "owned_private_repos": 100, + "disk_usage": 10000, + "collaborators": 8, + "two_factor_authentication": true, + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "collaborators": 0 + } + } + }, + "private-user-response-with-public-profile-information": { + "summary": "Response with public profile information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "private-user": { + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "private_gists": 81, + "total_private_repos": 100, + "owned_private_repos": 100, + "disk_usage": 10000, + "collaborators": 8, + "two_factor_authentication": true, + "plan": { + "name": "Medium", + "space": 400, + "private_repos": 20, + "collaborators": 0 + } + } + }, + "codespaces-user-public-key": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + }, + "user-codespaces-secret": { + "value": { + "name": "CODESPACE_GH_SECRET", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories" + } + }, + "user-export-details": { + "value": { + "state": "succeeded", + "completed_at": "2022-01-01T14:59:22Z", + "branch": "codespace-monalisa-octocat-hello-world-g4wpq6h95q", + "sha": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2", + "id": "latest", + "export_url": "https://api.github.com/user/codespaces/:name/exports/latest" + } + }, + "codespace-with-full-repository": { + "value": { + "id": 1, + "name": "monalisa-octocat-hello-world-g4wpq6h95q", + "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "billable_owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "allow_forking": true, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + }, + "machine": { + "name": "standardLinux", + "display_name": "4 cores, 16 GB RAM, 64 GB storage", + "operating_system": "linux", + "storage_in_bytes": 68719476736, + "memory_in_bytes": 17179869184, + "cpus": 4 + }, + "prebuild": false, + "devcontainer_path": ".devcontainer/devcontainer.json", + "created_at": "2021-10-14T00:53:30-06:00", + "updated_at": "2021-10-14T00:53:32-06:00", + "last_used_at": "2021-10-14T00:53:30-06:00", + "state": "Available", + "url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", + "git_status": { + "ahead": 0, + "behind": 0, + "has_unpushed_changes": false, + "has_uncommitted_changes": false, + "ref": "main" + }, + "location": "WestUs2", + "idle_timeout_minutes": 60, + "retention_period_minutes": 43200, + "retention_expires_at": null, + "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev", + "machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", + "start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", + "stop_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls/1", + "recent_folders": [], + "template": null + } + }, + "packages-for-user": { + "value": [ + { + "id": 197, + "name": "hello_docker", + "package_type": "container", + "owner": { + "login": "octocat", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.octocatusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "User", + "site_admin": false + }, + "version_count": 1, + "visibility": "private", + "url": "https://api.github.com/orgs/github/packages/container/hello_docker", + "created_at": "2020-05-19T22:19:11Z", + "updated_at": "2020-05-19T22:19:11Z", + "html_url": "https://github.com/orgs/github/packages/container/package/hello_docker" + }, + { + "id": 198, + "name": "goodbye_docker", + "package_type": "container", + "owner": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "User", + "site_admin": false + }, + "version_count": 2, + "visibility": "private", + "url": "https://api.github.com/user/octocat/packages/container/goodbye_docker", + "created_at": "2020-05-20T22:19:11Z", + "updated_at": "2020-05-20T22:19:11Z", + "html_url": "https://github.com/user/octocat/packages/container/package/goodbye_docker" + } + ] + }, + "email-items-3": { + "value": [ + { + "email": "octocat@github.com", + "primary": true, + "verified": true, + "visibility": "private" + } + ] + }, + "email-items-2": { + "value": [ + { + "email": "octocat@github.com", + "verified": true, + "primary": true, + "visibility": "public" + } + ] + }, + "email-items": { + "value": [ + { + "email": "octocat@octocat.org", + "primary": false, + "verified": false, + "visibility": "public" + }, + { + "email": "octocat@github.com", + "primary": false, + "verified": false, + "visibility": null + }, + { + "email": "mona@github.com", + "primary": false, + "verified": false, + "visibility": null + } + ] + }, + "gpg-key-items": { + "value": [ + { + "id": 3, + "name": "Octocat's GPG Key", + "primary_key_id": 2, + "key_id": "3262EFF25BA0D270", + "public_key": "xsBNBFayYZ...", + "emails": [ + { + "email": "octocat@users.noreply.github.com", + "verified": true + } + ], + "subkeys": [ + { + "id": 4, + "primary_key_id": 3, + "key_id": "4A595D4C72EE49C7", + "public_key": "zsBNBFayYZ...", + "emails": [], + "can_sign": false, + "can_encrypt_comms": true, + "can_encrypt_storage": true, + "can_certify": false, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false + } + ], + "can_sign": true, + "can_encrypt_comms": false, + "can_encrypt_storage": false, + "can_certify": true, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, + "raw_key": "string" + } + ] + }, + "gpg-key": { + "value": { + "id": 3, + "name": "Octocat's GPG Key", + "primary_key_id": 2, + "key_id": "3262EFF25BA0D270", + "public_key": "xsBNBFayYZ...", + "emails": [ + { + "email": "octocat@users.noreply.github.com", + "verified": true + } + ], + "subkeys": [ + { + "id": 4, + "primary_key_id": 3, + "key_id": "4A595D4C72EE49C7", + "public_key": "zsBNBFayYZ...", + "emails": [], + "can_sign": false, + "can_encrypt_comms": true, + "can_encrypt_storage": true, + "can_certify": false, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false + } + ], + "can_sign": true, + "can_encrypt_comms": false, + "can_encrypt_storage": false, + "can_certify": true, + "created_at": "2016-03-24T11:31:04-06:00", + "expires_at": "2016-03-24T11:31:04-07:00", + "revoked": false, + "raw_key": "\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v2\\n\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\nIts/HFYRLiFgDLmTlxo=\\n=+OzK\\n-----END PGP PUBLIC KEY BLOCK-----\"" + } + }, + "base-installation-for-auth-user-paginated": { + "value": { + "total_count": 2, + "installations": [ + { + "id": 1, + "account": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "all", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + }, + { + "id": 3, + "account": { + "login": "octocat", + "id": 2, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "access_tokens_url": "https://api.github.com/app/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "single_file_name": "config.yaml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "repository_selection": "all", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app_slug": "github-actions", + "suspended_at": null, + "suspended_by": null + } + ] + } + }, + "interaction-limit-user": { + "value": { + "limit": "collaborators_only", + "origin": "user", + "expires_at": "2018-08-17T04:18:39Z" + } + }, + "key-items": { + "value": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z", + "verified": false, + "read_only": false + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z", + "verified": false, + "read_only": false + } + ] + }, + "key": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z", + "verified": false, + "read_only": false + } + }, + "user-marketplace-purchase-items": { + "value": [ + { + "billing_cycle": "monthly", + "next_billing_date": "2017-11-11T00:00:00Z", + "unit_count": null, + "on_free_trial": true, + "free_trial_ends_on": "2017-11-11T00:00:00Z", + "updated_at": "2017-11-02T01:12:12Z", + "account": { + "login": "github", + "id": 4, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "email": null, + "organization_billing_email": "billing@github.com", + "type": "Organization" + }, + "plan": { + "url": "https://api.github.com/marketplace_listing/plans/1313", + "accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts", + "id": 1313, + "number": 3, + "name": "Pro", + "description": "A professional-grade CI solution", + "monthly_price_in_cents": 1099, + "yearly_price_in_cents": 11870, + "price_model": "FLAT_RATE", + "has_free_trial": true, + "unit_name": null, + "state": "published", + "bullets": [ + "Up to 25 private repositories", + "11 concurrent builds" + ] + } + } + ] + }, + "org-membership-items": { + "value": [ + { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "direct_membership": true, + "enterprise_teams_providing_indirect_membership": [], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "direct_membership": false, + "enterprise_teams_providing_indirect_membership": [ + "ent:justice-league", + "ent:security-managers" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + }, + "org-membership": { + "value": { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "direct_membership": true, + "enterprise_teams_providing_indirect_membership": [ + "ent:justice-league", + "ent:security-managers" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "org-membership-2": { + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "direct_membership": true, + "enterprise_teams_providing_indirect_membership": [ + "ent:justice-league", + "ent:security-managers" + ], + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "migration-items": { + "value": [ + { + "id": 79, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00", + "node_id": "MDQ6VXNlcjE=" + } + ] + }, + "migration-2": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "pending", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "migration": { + "value": { + "id": 79, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "guid": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "state": "exported", + "lock_repositories": true, + "exclude_attachments": false, + "exclude_releases": false, + "exclude_owner_projects": false, + "org_metadata_only": false, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ], + "url": "https://api.github.com/orgs/octo-org/migrations/79", + "created_at": "2015-07-06T15:33:38-07:00", + "updated_at": "2015-07-06T15:33:38-07:00" + } + }, + "package-user": { + "value": { + "id": 40201, + "name": "octo-name", + "package_type": "rubygems", + "owner": { + "login": "octocat", + "id": 209477, + "node_id": "MDQ6VXNlcjIwOTQ3Nw==", + "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "version_count": 3, + "visibility": "public", + "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name", + "created_at": "2019-10-20T14:17:14Z", + "updated_at": "2019-10-20T14:17:14Z", + "repository": { + "id": 216219492, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI=", + "name": "octo-name-repo", + "full_name": "octocat/octo-name-repo", + "private": false, + "owner": { + "login": "octocat", + "id": 209477, + "node_id": "MDQ6VXNlcjIwOTQ3Nw==", + "avatar_url": "https://avatars.githubusercontent.com/u/209477?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "html_url": "https://github.com/octocat/octo-name-repo", + "description": "Project for octocats", + "fork": false, + "url": "https://api.github.com/repos/octocat/octo-name-repo", + "forks_url": "https://api.github.com/repos/octocat/octo-name-repo/forks", + "keys_url": "https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat/octo-name-repo/teams", + "hooks_url": "https://api.github.com/repos/octocat/octo-name-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat/octo-name-repo/events", + "assignees_url": "https://api.github.com/repos/octocat/octo-name-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat/octo-name-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat/octo-name-repo/tags", + "blobs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat/octo-name-repo/languages", + "stargazers_url": "https://api.github.com/repos/octocat/octo-name-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octocat/octo-name-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octocat/octo-name-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/octo-name-repo/subscription", + "commits_url": "https://api.github.com/repos/octocat/octo-name-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat/octo-name-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat/octo-name-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat/octo-name-repo/merges", + "archive_url": "https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat/octo-name-repo/downloads", + "issues_url": "https://api.github.com/repos/octocat/octo-name-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat/octo-name-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat/octo-name-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat/octo-name-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat/octo-name-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat/octo-name-repo/deployments" + }, + "html_url": "https://github.com/octocat/octo-name-repo/packages/40201" + } + }, + "package-versions-for-authenticated-user": { + "value": [ + { + "id": 45763, + "name": "sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9", + "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763", + "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", + "created_at": "2020-09-11T21:56:40Z", + "updated_at": "2021-02-05T21:32:32Z", + "html_url": "https://github.com/users/octocat/packages/container/hello_docker/45763", + "metadata": { + "package_type": "container", + "container": { + "tags": [ + "latest" + ] + } + } + }, + { + "id": 881, + "name": "sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344", + "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/881", + "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", + "created_at": "2020-05-21T22:22:20Z", + "updated_at": "2021-02-05T21:32:32Z", + "html_url": "https://github.com/users/octocat/packages/container/hello_docker/881", + "metadata": { + "package_type": "container", + "container": { + "tags": [] + } + } + } + ] + }, + "package-version-authenticated-user": { + "value": { + "id": 214, + "name": "sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a", + "url": "https://api.github.com/users/octocat/packages/container/hello_docker/versions/214", + "package_html_url": "https://github.com/users/octocat/packages/container/package/hello_docker", + "created_at": "2020-05-15T03:46:45Z", + "updated_at": "2020-05-15T03:46:45Z", + "html_url": "https://github.com/users/octocat/packages/container/hello_docker/214", + "metadata": { + "package_type": "container", + "container": { + "tags": [ + "1.13.6" + ] + } + } + } + }, + "repository-items-default-response": { + "summary": "Default response", + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + }, + "social-account-items": { + "value": [ + { + "provider": "twitter", + "url": "https://twitter.com/github" + } + ] + }, + "ssh-signing-key-items": { + "value": [ + { + "id": 2, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "id": 3, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ] + }, + "ssh-signing-key": { + "value": { + "id": 2, + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + }, + "starred-repository-items-alternative-response-with-star-creation-timestamps": { + "summary": "Alternative response with star creation timestamps", + "value": [ + { + "starred_at": "2011-01-16T19:06:43Z", + "repo": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + ] + }, + "team-full-items": { + "value": [ + { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + ] + }, + "public-user-default-response": { + "summary": "Default response", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z" + } + }, + "public-user-response-with-git-hub-plan-information": { + "summary": "Response with GitHub plan information", + "value": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false, + "name": "monalisa octocat", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "hireable": false, + "bio": "There once was...", + "twitter_username": "monatheoctocat", + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2008-01-14T04:33:35Z", + "plan": { + "name": "pro", + "space": 976562499, + "collaborators": 0, + "private_repos": 9999 + } + } + }, + "user-events-items": { + "value": [ + { + "id": "22249084947", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": false, + "created_at": "2022-06-07T07:50:26Z" + } + ] + }, + "user-org-events-items": { + "value": [ + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": false, + "created_at": "2022-06-09T12:47:28Z", + "org": { + "id": 9919, + "login": "octo-org", + "gravatar_id": "", + "url": "https://api.github.com/orgs/octo-org", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?" + } + }, + { + "id": "22196946742", + "type": "CreateEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octo-org/octo-repo", + "url": "https://api.github.com/repos/octo-org/octo-repo" + }, + "payload": { + "ref": "master", + "ref_type": "repository", + "full_ref": "refs/heads/master", + "master_branch": "master", + "description": null, + "pusher_type": "user" + }, + "public": false, + "created_at": "2022-06-07T07:50:26Z", + "org": { + "id": 9919, + "login": "octo-org", + "gravatar_id": "", + "url": "https://api.github.com/orgs/octo-org", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?" + } + } + ] + }, + "user-public-events-items": { + "value": [ + { + "id": "22249084947", + "type": "WatchEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "action": "started" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-08T23:29:25Z" + } + ] + }, + "hovercard": { + "value": { + "contexts": [ + { + "message": "Owns this repository", + "octicon": "repo" + } + ] + } + }, + "key-simple-items": { + "value": [ + { + "id": 1, + "key": "ssh-rsa AAA..." + } + ] + }, + "package-versions-for-user": { + "value": [ + { + "id": 3497268, + "name": "0.3.0", + "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268", + "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", + "license": "MIT", + "created_at": "2020-08-31T15:22:11Z", + "updated_at": "2020-08-31T15:22:12Z", + "description": "Project for octocats", + "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0", + "metadata": { + "package_type": "rubygems" + } + }, + { + "id": 387039, + "name": "0.2.0", + "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", + "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", + "license": "MIT", + "created_at": "2019-12-01T20:49:29Z", + "updated_at": "2019-12-01T20:49:30Z", + "description": "Project for octocats", + "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", + "metadata": { + "package_type": "rubygems" + } + }, + { + "id": 169770, + "name": "0.1.0", + "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770", + "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", + "license": "MIT", + "created_at": "2019-10-20T14:17:14Z", + "updated_at": "2019-10-20T14:17:15Z", + "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0", + "metadata": { + "package_type": "rubygems" + } + } + ] + }, + "package-version-user": { + "value": { + "id": 387039, + "name": "0.2.0", + "url": "https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039", + "package_html_url": "https://github.com/octocat/octo-name-repo/packages/40201", + "license": "MIT", + "created_at": "2019-12-01T20:49:29Z", + "updated_at": "2019-12-01T20:49:30Z", + "description": "Octo-name client for Ruby", + "html_url": "https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0", + "metadata": { + "package_type": "rubygems" + } + } + }, + "user-received-events-items": { + "value": [ + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22196946742", + "type": "CreateEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "ref": "master", + "ref_type": "repository", + "full_ref": "refs/heads/master", + "master_branch": "master", + "description": null, + "pusher_type": "user" + }, + "public": false, + "created_at": "2022-06-07T07:50:26Z" + } + ] + }, + "user-received-public-events-items": { + "value": [ + { + "id": "22249084964", + "type": "PushEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "repository_id": 1296269, + "push_id": 10115855396, + "ref": "refs/heads/master", + "head": "7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300", + "before": "883efe034920928c47fe18598c01249d1a9fdabd" + }, + "public": true, + "created_at": "2022-06-09T12:47:28Z" + }, + { + "id": "22196946742", + "type": "CreateEvent", + "actor": { + "id": 583231, + "login": "octocat", + "display_login": "octocat", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "avatar_url": "https://avatars.githubusercontent.com/u/583231?v=4" + }, + "repo": { + "id": 1296269, + "name": "octocat/Hello-World", + "url": "https://api.github.com/repos/octocat/Hello-World" + }, + "payload": { + "ref": "master", + "ref_type": "repository", + "full_ref": "refs/heads/master", + "master_branch": "master", + "description": null, + "pusher_type": "user" + }, + "public": false, + "created_at": "2022-06-07T07:50:26Z" + } + ] + }, + "billing-premium-request-usage-report-user": { + "value": { + "timePeriod": { + "year": 2025 + }, + "user": "monalisa", + "usageItems": [ + { + "product": "Copilot", + "sku": "Copilot Premium Request", + "model": "GPT-5", + "unitType": "requests", + "pricePerUnit": 0.04, + "grossQuantity": 100, + "grossAmount": 4.0, + "discountQuantity": 0, + "discountAmount": 0.0, + "netQuantity": 100, + "netAmount": 4.0 + } + ] + } + }, + "billing-usage-report-user": { + "value": { + "usageItems": [ + { + "date": "2023-08-01", + "product": "Actions", + "sku": "Actions Linux", + "quantity": 100, + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossAmount": 0.8, + "discountAmount": 0, + "netAmount": 0.8, + "repositoryName": "user/example" + } + ] + } + }, + "billing-usage-summary-report-user": { + "value": { + "timePeriod": { + "year": 2025 + }, + "user": "monalisa", + "usageItems": [ + { + "product": "Actions", + "sku": "actions_linux", + "unitType": "minutes", + "pricePerUnit": 0.008, + "grossQuantity": 1000, + "grossAmount": 8.0, + "discountQuantity": 0, + "discountAmount": 0.0, + "netQuantity": 1000, + "netAmount": 8.0 + } + ] + } + }, + "check-run-completed": { + "value": { + "action": "completed", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "completed", + "conclusion": "success", + "started_at": "2019-05-15T15:21:12Z", + "completed_at": "2019-05-15T15:21:45Z", + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "check-run-completed-form-encoded": { + "value": { + "payload": "%7B%22action%22%3A%22completed%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + }, + "check-run-created": { + "value": { + "action": "created", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "check-run-created-form-encoded": { + "value": { + "payload": "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + }, + "check-run-requested-action": { + "value": { + "action": "requested_action", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "queued", + "conclusion": null, + "started_at": "2019-05-15T15:21:12Z", + "completed_at": null, + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "queued", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } + }, + "requested_action": { + "identifier": "lgtm|1234" + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "check-run-requested-action-form-encoded": { + "value": { + "payload": "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + }, + "check-run-rerequested": { + "value": { + "action": "rerequested", + "check_run": { + "id": 128620228, + "node_id": "MDg6Q2hlY2tSdW4xMjg2MjAyMjg=", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "external_id": "", + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228", + "html_url": "https://github.com/Codertocat/Hello-World/runs/128620228", + "details_url": "https://octocoders.github.io", + "status": "completed", + "conclusion": "success", + "started_at": "2019-05-15T15:21:12Z", + "completed_at": "2019-05-15T15:21:45Z", + "output": { + "title": null, + "summary": null, + "text": null, + "annotations_count": 0, + "annotations_url": "https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations" + }, + "name": "Octocoders-linter", + "check_suite": { + "id": 118578147, + "node_id": "MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc=", + "head_branch": "changes", + "head_sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "status": "completed", + "conclusion": null, + "url": "https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147", + "before": "6113728f27ae82c7b1a177c8d03f9e96e0adf246", + "after": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "created_at": "2019-05-15T15:20:31Z", + "updated_at": "2019-05-15T15:20:31Z" + }, + "app": { + "id": 29310, + "node_id": "MDM6QXBwMjkzMTA=", + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "name": "octocoders-linter", + "description": "", + "external_url": "https://octocoders.github.io", + "html_url": "https://github.com/apps/octocoders-linter", + "created_at": "2019-04-19T19:36:24Z", + "updated_at": "2019-04-19T19:36:56Z", + "permissions": { + "administration": "write", + "checks": "write", + "contents": "write", + "deployments": "write", + "issues": "write", + "members": "write", + "metadata": "read", + "organization_administration": "write", + "organization_hooks": "write", + "organization_plan": "read", + "organization_projects": "write", + "organization_user_blocking": "write", + "pages": "write", + "pull_requests": "write", + "repository_hooks": "write", + "repository_projects": "write", + "statuses": "write", + "vulnerability_alerts": "read" + }, + "events": [] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/Codertocat/Hello-World/pulls/2", + "id": 279147437, + "number": 2, + "head": { + "ref": "changes", + "sha": "ec26c3e57ca3a959ca5aad62de7213c562f8c821", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + }, + "base": { + "ref": "master", + "sha": "f95f852bd8fca8fcc58a9a2d6c842781e32a215e", + "repo": { + "id": 186853002, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "name": "Hello-World" + } + } + } + ] + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "Hello-World", + "full_name": "Codertocat/Hello-World", + "private": false, + "owner": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/Codertocat/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/Codertocat/Hello-World", + "forks_url": "https://api.github.com/repos/Codertocat/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Codertocat/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Codertocat/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Codertocat/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Codertocat/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Codertocat/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Codertocat/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Codertocat/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Codertocat/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Codertocat/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Codertocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Codertocat/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Codertocat/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Codertocat/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Codertocat/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Codertocat/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Codertocat/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Codertocat/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Codertocat/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Codertocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Codertocat/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Codertocat/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/Codertocat/Hello-World.git", + "ssh_url": "git@github.com:Codertocat/Hello-World.git", + "clone_url": "https://github.com/Codertocat/Hello-World.git", + "svn_url": "https://github.com/Codertocat/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "check-run-rerequested-form-encoded": { + "value": { + "payload": "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" + } + }, + "ping": { + "value": { + "zen": "Anything added dilutes everything else.", + "hook_id": 109948940, + "hook": { + "type": "Repository", + "id": 109948940, + "name": "web", + "active": true, + "events": [ + "*" + ], + "config": { + "content_type": "json", + "url": "https://smee.io/****************", + "insecure_ssl": "0" + }, + "updated_at": "2019-05-15T15:20:49Z", + "created_at": "2019-05-15T15:20:49Z", + "url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940", + "test_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test", + "ping_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings", + "last_response": { + "code": null, + "status": "unused", + "message": null + } + }, + "repository": { + "id": 186853261, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE=", + "name": "Hello-World", + "full_name": "Octocoders/Hello-World", + "private": false, + "owner": { + "login": "Octocoders", + "id": 38302899, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5", + "avatar_url": "https://avatars1.githubusercontent.com/u/38302899?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Octocoders", + "html_url": "https://github.com/Octocoders", + "followers_url": "https://api.github.com/users/Octocoders/followers", + "following_url": "https://api.github.com/users/Octocoders/following{/other_user}", + "gists_url": "https://api.github.com/users/Octocoders/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Octocoders/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Octocoders/subscriptions", + "organizations_url": "https://api.github.com/users/Octocoders/orgs", + "repos_url": "https://api.github.com/users/Octocoders/repos", + "events_url": "https://api.github.com/users/Octocoders/events{/privacy}", + "received_events_url": "https://api.github.com/users/Octocoders/received_events", + "type": "Organization", + "site_admin": false + }, + "html_url": "https://github.com/Octocoders/Hello-World", + "description": null, + "fork": true, + "url": "https://api.github.com/repos/Octocoders/Hello-World", + "forks_url": "https://api.github.com/repos/Octocoders/Hello-World/forks", + "keys_url": "https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/Octocoders/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/Octocoders/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/Octocoders/Hello-World/events", + "assignees_url": "https://api.github.com/repos/Octocoders/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/Octocoders/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/Octocoders/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/Octocoders/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/Octocoders/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/Octocoders/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/Octocoders/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/Octocoders/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/Octocoders/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/Octocoders/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/Octocoders/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/Octocoders/Hello-World/merges", + "archive_url": "https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/Octocoders/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/Octocoders/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/Octocoders/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/Octocoders/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/Octocoders/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/Octocoders/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/Octocoders/Hello-World/deployments", + "created_at": "2019-05-15T15:20:42Z", + "updated_at": "2019-05-15T15:20:45Z", + "pushed_at": "2019-05-15T15:20:33Z", + "git_url": "git://github.com/Octocoders/Hello-World.git", + "ssh_url": "git@github.com:Octocoders/Hello-World.git", + "clone_url": "https://github.com/Octocoders/Hello-World.git", + "svn_url": "https://github.com/Octocoders/Hello-World", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": false, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 0, + "license": null, + "forks": 0, + "open_issues": 0, + "watchers": 0, + "default_branch": "master" + }, + "sender": { + "login": "Codertocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/Codertocat", + "html_url": "https://github.com/Codertocat", + "followers_url": "https://api.github.com/users/Codertocat/followers", + "following_url": "https://api.github.com/users/Codertocat/following{/other_user}", + "gists_url": "https://api.github.com/users/Codertocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/Codertocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/Codertocat/subscriptions", + "organizations_url": "https://api.github.com/users/Codertocat/orgs", + "repos_url": "https://api.github.com/users/Codertocat/repos", + "events_url": "https://api.github.com/users/Codertocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/Codertocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "ping-form-encoded": { + "value": { + "payload": "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D" + } + }, + "secret-scanning-alert-location-created": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "secret-scanning-alert-location-created-form-encoded": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } + }, + "parameters": { + "pagination-before": { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "pagination-after": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "direction": { + "name": "direction", + "description": "The direction to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + "ghsa_id": { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "per-page": { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + "cursor": { + "name": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "webhook-delivery-status": { + "name": "status", + "description": "Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "success", + "failure" + ] + } + }, + "delivery-id": { + "name": "delivery_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "page": { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + "since": { + "name": "since", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "installation-id": { + "name": "installation_id", + "description": "The unique identifier of the installation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "examples": { + "default": { + "value": 1 + } + } + }, + "client-id": { + "name": "client_id", + "in": "path", + "required": true, + "description": "The client ID of the GitHub app.", + "schema": { + "type": "string" + }, + "examples": { + "default": { + "value": "Iv1.8a61f9b3a7aba766" + } + } + }, + "app-slug": { + "name": "app_slug", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "assignment-id": { + "name": "assignment_id", + "description": "The unique identifier of the classroom assignment.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "classroom-id": { + "name": "classroom_id", + "description": "The unique identifier of the classroom.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "enterprise": { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "configuration-id": { + "name": "configuration_id", + "description": "The unique identifier of the code security configuration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "day": { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "example": "2025-10-13" + } + }, + "dependabot-alert-comma-separated-classifications": { + "name": "classification", + "in": "query", + "description": "A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned.\n\nCan be: `malware`, `general`", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-states": { + "name": "state", + "in": "query", + "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `auto_dismissed`, `dismissed`, `fixed`, `open`", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-severities": { + "name": "severity", + "in": "query", + "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-ecosystems": { + "name": "ecosystem", + "in": "query", + "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-packages": { + "name": "package", + "in": "query", + "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-epss": { + "name": "epss_percentage", + "in": "query", + "description": "CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:\n- An exact number (`n`)\n- Comparators such as `>n`, `=n`, `<=n`\n- A range like `n..n`, where `n` is a number from 0.0 to 1.0\n\nFilters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-has": { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch" + ] + } + } + ] + } + }, + "dependabot-alert-comma-separated-assignees": { + "name": "assignee", + "in": "query", + "description": "Filter alerts by assignees.\nProvide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.\nUse `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.", + "schema": { + "type": "string" + } + }, + "dependabot-alert-scope": { + "name": "scope", + "in": "query", + "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.", + "schema": { + "type": "string", + "enum": [ + "development", + "runtime" + ] + } + }, + "dependabot-alert-sort": { + "name": "sort", + "in": "query", + "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.\n`epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "epss_percentage" + ], + "default": "created" + } + }, + "enterprise-team": { + "name": "enterprise-team", + "description": "The slug version of the enterprise team name. You can also substitute this value with the enterprise team id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "username": { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "org": { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "team-slug": { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "public-events-per-page": { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 15 + } + }, + "gist-id": { + "name": "gist_id", + "description": "The unique identifier of the gist.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "comment-id": { + "name": "comment_id", + "description": "The unique identifier of the comment.", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + "labels": { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "account-id": { + "name": "account_id", + "description": "account_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "plan-id": { + "name": "plan_id", + "description": "The unique identifier of the plan.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + "owner": { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "repo": { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "all": { + "name": "all", + "description": "If `true`, show notifications marked as read.", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "participating": { + "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "before": { + "name": "before", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "thread-id": { + "name": "thread_id", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "since-org": { + "name": "since", + "description": "An organization ID. Only return organizations with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "budget": { + "name": "budget_id", + "description": "The ID corresponding to the budget.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "billing-usage-report-year": { + "name": "year", + "description": "If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-month-default": { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-day": { + "name": "day", + "description": "If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-user": { + "name": "user", + "description": "The user name to query usage for. The name is not case sensitive.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "billing-usage-report-model": { + "name": "model", + "description": "The model name to query usage for. The name is not case sensitive.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "billing-usage-report-product": { + "name": "product", + "description": "The product name to query usage for. The name is not case sensitive.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "billing-usage-report-month": { + "name": "month", + "description": "If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "billing-usage-report-repository": { + "name": "repository", + "description": "The repository name to query for usage in the format owner/repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "billing-usage-report-sku": { + "name": "sku", + "description": "The SKU to query for usage.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "actions-custom-image-definition-id": { + "name": "image_definition_id", + "description": "Image definition ID of custom image", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-custom-image-version": { + "name": "version", + "description": "Version of a custom image", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+$" + } + }, + "hosted-runner-id": { + "name": "hosted_runner_id", + "description": "Unique identifier of the GitHub-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "repository-id": { + "name": "repository_id", + "description": "The unique identifier of the repository.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "visible-to-repository": { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "runner-group-id": { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "runner-id": { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "runner-label-name": { + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "secret-name": { + "name": "secret_name", + "description": "The name of the secret.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "variables-per-page": { + "name": "per_page", + "description": "The number of results per page (max 30). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + "variable-name": { + "name": "name", + "description": "The name of the variable.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "subject-digest": { + "name": "subject_digest", + "description": "The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "minLength": 71, + "maxLength": 71, + "pattern": "^sha256:[a-f0-9]{64}$" + } + }, + "tool-name": { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-name" + } + }, + "tool-guid": { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + } + }, + "dependabot-alert-comma-separated-artifact-registry-urls": { + "name": "artifact_registry_url", + "in": "query", + "description": "A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.", + "schema": { + "type": "string" + } + }, + "dependabot-alert-comma-separated-artifact-registry": { + "name": "artifact_registry", + "in": "query", + "description": "A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.\n\nCan be: `jfrog-artifactory`", + "schema": { + "type": "string" + } + }, + "dependabot-alert-org-scope-comma-separated-has": { + "name": "has", + "in": "query", + "description": "Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.\nMultiple `has` filters can be passed to filter for alerts that have all of the values.", + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string", + "enum": [ + "patch", + "deployment" + ] + } + } + ] + } + }, + "dependabot-alert-comma-separated-runtime-risk": { + "name": "runtime_risk", + "in": "query", + "description": "A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.\n\nCan be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`", + "schema": { + "type": "string" + } + }, + "hook-id": { + "name": "hook_id", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "api-insights-actor-type": { + "name": "actor_type", + "in": "path", + "description": "The type of the actor", + "required": true, + "schema": { + "type": "string", + "enum": [ + "installation", + "classic_pat", + "fine_grained_pat", + "oauth_app", + "github_app_user_to_server" + ] + } + }, + "api-insights-actor-id": { + "name": "actor_id", + "in": "path", + "description": "The ID of the actor", + "required": true, + "schema": { + "type": "integer" + } + }, + "api-insights-min-timestamp": { + "name": "min_timestamp", + "description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-max-timestamp": { + "name": "max_timestamp", + "description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-route-stats-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "http_method", + "api_route", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + "api-insights-api-route-substring": { + "name": "api_route_substring", + "in": "query", + "description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-sort": { + "name": "sort", + "description": "The property to sort the results by.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "last_rate_limited_timestamp", + "last_request_timestamp", + "rate_limited_request_count", + "subject_name", + "total_request_count" + ], + "default": "total_request_count" + } + } + }, + "api-insights-subject-name-substring": { + "name": "subject_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "api-insights-user-id": { + "name": "user_id", + "in": "path", + "description": "The ID of the user to query for stats", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-timestamp-increment": { + "name": "timestamp_increment", + "description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "api-insights-actor-name-substring": { + "name": "actor_name_substring", + "in": "query", + "description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search.", + "required": false, + "schema": { + "type": "string" + } + }, + "invitation-id": { + "name": "invitation_id", + "description": "The unique identifier of the invitation.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "issue-field-id": { + "name": "issue_field_id", + "description": "The unique identifier of the issue field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "issue-type-id": { + "name": "issue_type_id", + "description": "The unique identifier of the issue type.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "codespace-name": { + "name": "codespace_name", + "in": "path", + "required": true, + "description": "The name of the codespace.", + "schema": { + "type": "string" + } + }, + "migration-id": { + "name": "migration_id", + "description": "The unique identifier of the migration.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "repo-name": { + "name": "repo_name", + "description": "repo_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "role-id": { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "package-visibility": { + "name": "visibility", + "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\nThe `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.\nFor the list of GitHub Packages registries that support granular permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "public", + "private", + "internal" + ] + } + }, + "package-type": { + "name": "package_type", + "description": "The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "npm", + "maven", + "rubygems", + "docker", + "nuget", + "container" + ] + } + }, + "package-name": { + "name": "package_name", + "description": "The name of the package.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "package-version-id": { + "name": "package_version_id", + "description": "Unique identifier of the package version.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "personal-access-token-sort": { + "name": "sort", + "description": "The property by which to sort the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + "personal-access-token-owner": { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "example": "owner[]=octocat1,owner[]=octocat2" + } + }, + "personal-access-token-repository": { + "name": "repository", + "description": "The name of the repository to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "Hello-World" + } + }, + "personal-access-token-permission": { + "name": "permission", + "description": "The permission to use to filter the results.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "issues_read" + } + }, + "personal-access-token-before": { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "personal-access-token-after": { + "name": "last_used_after", + "description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "personal-access-token-token-id": { + "name": "token_id", + "description": "The ID of the token", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + }, + "example": "token_id[]=1,token_id[]=2" + } + }, + "fine-grained-personal-access-token-id": { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "project-number": { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "field-id": { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "item-id": { + "name": "item_id", + "description": "The unique identifier of the project item.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "view-number": { + "name": "view_number", + "description": "The number that identifies the project view.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "ruleset-targets": { + "name": "targets", + "description": "A comma-separated list of rule targets to filter by.\nIf provided, only rulesets that apply to the specified targets will be returned.\nFor example, `branch,tag,push`.\n", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "branch,tag,push" + } + }, + "ref-in-query": { + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on.", + "in": "query", + "schema": { + "type": "string" + } + }, + "time-period": { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + "actor-name-in-query": { + "name": "actor_name", + "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + "rule-suite-result": { + "name": "rule_suite_result", + "description": "The rule suite results to filter on. When specified, only suites with this result will be returned.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass", + "all" + ], + "default": "all" + } + }, + "rule-suite-id": { + "name": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "secret-scanning-alert-state": { + "name": "state", + "in": "query", + "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "resolved" + ] + } + }, + "secret-scanning-alert-secret-type": { + "name": "secret_type", + "in": "query", + "description": "A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-exclude-secret-types": { + "name": "exclude_secret_types", + "in": "query", + "description": "A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See \"[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)\" for a complete list of secret types.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-exclude-providers": { + "name": "exclude_providers", + "in": "query", + "description": "A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-providers": { + "name": "providers", + "in": "query", + "description": "A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`).\nYou can find the provider slug in the `provider_slug` field of each alert.\nCannot be combined with the `exclude_providers` parameter.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-resolution": { + "name": "resolution", + "in": "query", + "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, + "secret-scanning-alert-sort": { + "name": "sort", + "description": "The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + "secret-scanning-pagination-before-org-repo": { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-pagination-after-org-repo": { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-validity": { + "name": "validity", + "in": "query", + "description": "A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.", + "required": false, + "schema": { + "type": "string" + } + }, + "secret-scanning-alert-publicly-leaked": { + "name": "is_publicly_leaked", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-multi-repo": { + "name": "is_multi_repo", + "in": "query", + "description": "A boolean value representing whether or not to filter alerts by the multi-repo tag being present.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "secret-scanning-alert-hide-secret": { + "name": "hide_secret", + "in": "query", + "description": "A boolean value representing whether or not to hide literal secrets in the results.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "network-configuration-id": { + "name": "network_configuration_id", + "description": "Unique identifier of the hosted compute network configuration.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "network-settings-id": { + "name": "network_settings_id", + "description": "Unique identifier of the hosted compute network settings.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "team-type": { + "name": "team_type", + "description": "Filter team results by their type. For more information, see \"[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "enterprise", + "organization" + ], + "default": "all" + } + }, + "security-product": { + "name": "security_product", + "in": "path", + "description": "The security feature to enable or disable.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "dependency_graph", + "dependabot_alerts", + "dependabot_security_updates", + "advanced_security", + "code_scanning_default_setup", + "secret_scanning", + "secret_scanning_push_protection" + ] + } + }, + "org-security-product-enablement": { + "name": "enablement", + "in": "path", + "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the organization.\n`disable_all` means to disable the specified security feature for all repositories in the organization.", + "required": true, + "schema": { + "type": "string", + "enum": [ + "enable_all", + "disable_all" + ] + } + }, + "artifact-name": { + "name": "name", + "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "artifact-id": { + "name": "artifact_id", + "description": "The unique identifier of the artifact.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actions-cache-git-ref-full": { + "name": "ref", + "description": "The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "actions-cache-key": { + "name": "key", + "description": "An explicit key or prefix for identifying the cache", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "actions-cache-list-sort": { + "name": "sort", + "description": "The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at", + "last_accessed_at", + "size_in_bytes" + ], + "default": "last_accessed_at" + } + }, + "actions-cache-key-required": { + "name": "key", + "description": "A key for identifying the cache.", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + "cache-id": { + "name": "cache_id", + "description": "The unique identifier of the GitHub Actions cache.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "job-id": { + "name": "job_id", + "description": "The unique identifier of the job.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "actor": { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "workflow-run-branch": { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "event": { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "workflow-run-status": { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting", + "pending" + ] + } + }, + "created": { + "name": "created", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "exclude-pull-requests": { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + }, + "workflow-run-check-suite-id": { + "name": "check_suite_id", + "description": "Returns workflow runs with the `check_suite_id` that you specify.", + "in": "query", + "schema": { + "type": "integer" + } + }, + "workflow-run-head-sha": { + "name": "head_sha", + "description": "Only returns workflow runs that are associated with the specified `head_sha`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "run-id": { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "attempt-number": { + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "workflow-id": { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, + "autolink-id": { + "name": "autolink_id", + "description": "The unique identifier of the autolink.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "branch": { + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + "check-run-id": { + "name": "check_run_id", + "description": "The unique identifier of the check run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "check-suite-id": { + "name": "check_suite_id", + "description": "The unique identifier of the check suite.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "check-name": { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "status": { + "name": "status", + "description": "Returns check runs with the specified `status`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + } + }, + "git-ref": { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/code-scanning-ref" + } + }, + "pr-alias": { + "name": "pr", + "description": "The number of the pull request for the results you want to list.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "alert-number": { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "$ref": "#/components/schemas/alert-number" + } + }, + "reaction-id": { + "name": "reaction_id", + "description": "The unique identifier of the reaction.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "commit-sha": { + "name": "commit_sha", + "description": "The SHA of the commit.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + "commit-ref": { + "name": "ref", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + "dependabot-alert-comma-separated-manifests": { + "name": "manifest", + "in": "query", + "description": "A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.", + "schema": { + "type": "string" + } + }, + "dependabot-alert-number": { + "name": "alert_number", + "in": "path", + "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.", + "required": true, + "schema": { + "$ref": "#/components/schemas/alert-number" + } + }, + "manifest-path": { + "name": "name", + "description": "The full path, relative to the repository root, of the dependency manifest file.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "deployment-id": { + "name": "deployment_id", + "description": "deployment_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "environment-name": { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.", + "schema": { + "type": "string" + } + }, + "branch-policy-id": { + "name": "branch_policy_id", + "in": "path", + "required": true, + "description": "The unique identifier of the branch policy.", + "schema": { + "type": "integer" + } + }, + "protection-rule-id": { + "name": "protection_rule_id", + "description": "The unique identifier of the protection rule.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "git-ref-only": { + "name": "ref", + "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "in": "path", + "required": true, + "example": "heads/feature-a", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + "since-user": { + "name": "since", + "description": "A user ID. Only return users with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "issue-number": { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "key-id": { + "name": "key_id", + "description": "The unique identifier of the key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "milestone-number": { + "name": "milestone_number", + "description": "The number that identifies the milestone.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "pages-deployment-id": { + "name": "pages_deployment_id", + "description": "The ID of the Pages deployment. You can also give the commit SHA of the deployment.", + "in": "path", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, + "pull-number": { + "name": "pull_number", + "description": "The number that identifies the pull request.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "review-id": { + "name": "review_id", + "description": "The unique identifier of the review.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "asset-id": { + "name": "asset_id", + "description": "The unique identifier of the asset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "release-id": { + "name": "release_id", + "description": "The unique identifier of the release.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "per": { + "name": "per", + "description": "The time frame to display results for.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "day", + "week" + ], + "default": "day" + } + }, + "since-repo": { + "name": "since", + "description": "A repository ID. Only return repositories with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "order": { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + } + }, + "issues-advanced-search": { + "name": "advanced_search", + "description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "search-type": { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` β€” performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` β€” combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } + }, + "team-id": { + "name": "team_id", + "description": "The unique identifier of the team.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "repository-id-in-query": { + "name": "repository_id", + "description": "ID of the Repository to filter on", + "in": "query", + "schema": { + "type": "integer" + } + }, + "export-id": { + "name": "export_id", + "in": "path", + "required": true, + "description": "The ID of the export operation, or `latest`. Currently only `latest` is currently supported.", + "schema": { + "type": "string" + } + }, + "gpg-key-id": { + "name": "gpg_key_id", + "description": "The unique identifier of the GPG key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "since-repo-date": { + "name": "since", + "description": "Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "before-repo-date": { + "name": "before", + "description": "Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "format": "date-time" + } + }, + "ssh-signing-key-id": { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + "sort-starred": { + "name": "sort", + "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + } + }, + "user-id": { + "name": "user_id", + "description": "The unique identifier of the user.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + }, + "responses": { + "validation_failed_simple": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/validation-error-simple" + } + } + } + }, + "not_found": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + }, + "application/scim+json": { + "schema": { + "$ref": "#/components/schemas/scim-error" + } + } + } + }, + "validation_failed": { + "description": "Validation failed, or the endpoint has been spammed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/validation-error" + } + } + } + }, + "accepted": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "type": "object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "not_modified": { + "description": "Not modified" + }, + "requires_authentication": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "forbidden": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "conflict": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "no_content": { + "description": "A header with no content is returned." + }, + "service_unavailable": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "forbidden_gist": { + "description": "Forbidden Gist", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "block": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "html_url": { + "type": "string", + "nullable": true + } + } + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "moved_permanently": { + "description": "Moved permanently", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "get_all_budgets": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_all_budgets" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get_all_budgets" + } + } + } + } + }, + "budget": { + "description": "Response when updating a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/get-budget" + } + } + } + } + }, + "delete-budget": { + "description": "Response when deleting a budget", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/delete-budget" + }, + "examples": { + "default": { + "$ref": "#/components/examples/delete-budget" + } + } + } + } + }, + "billing_premium_request_usage_report_org": { + "description": "Response when getting a billing premium request usage report", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-premium-request-usage-report-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-premium-request-usage-report-org" + } + } + } + } + }, + "billing_usage_report_org": { + "description": "Billing usage report response for an organization", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-usage-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-report" + } + } + } + } + }, + "billing_usage_summary_report_org": { + "description": "Response when getting a billing usage summary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-usage-summary-report-org" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-summary-report-org" + } + } + } + } + }, + "actions_runner_jitconfig": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "$ref": "#/components/schemas/runner" + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-jitconfig" + } + } + } + } + }, + "actions_runner_labels": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-label" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-labels" + } + } + } + } + }, + "actions_runner_labels_readonly": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "labels" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runner-label" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/runner-labels-readonly" + } + } + } + } + }, + "too_large": { + "description": "Payload Too Large", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Metrics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "package_es_list_error": { + "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." + }, + "enterprise_team_unsupported": { + "description": "Unprocessable entity if you attempt to modify an enterprise team at the organization level." + }, + "temporary_redirect": { + "description": "Temporary Redirect", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "gone": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "code_scanning_forbidden_read": { + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "code_scanning_forbidden_write": { + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "code_scanning_bad_request": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "default": { + "$ref": "#/components/examples/code-scanning-bad-request" + } + } + } + } + }, + "code_scanning_autofix_create_forbidden": { + "description": "Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "unprocessable_analysis": { + "description": "Response if analysis could not be processed", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "found": { + "description": "Found" + }, + "code_scanning_conflict": { + "description": "Response if there is already a validation run in progress with a different default setup configuration", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "code_scanning_invalid_state": { + "description": "Response if the configuration change cannot be made because the repository is not in the required state", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "dependency_review_forbidden": { + "description": "Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "porter_maintenance": { + "description": "Unavailable due to service under maintenance.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "unacceptable": { + "description": "Unacceptable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, + "billing_premium_request_usage_report_user": { + "description": "Response when getting a billing premium request usage report", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-premium-request-usage-report-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-premium-request-usage-report-user" + } + } + } + } + }, + "billing_usage_report_user": { + "description": "Response when getting a billing usage report", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-usage-report-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-report-user" + } + } + } + } + }, + "billing_usage_summary_report_user": { + "description": "Response when getting a billing usage summary", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/billing-usage-summary-report-user" + }, + "examples": { + "default": { + "$ref": "#/components/examples/billing-usage-summary-report-user" + } + } + } + } + } + }, + "headers": { + "link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + }, + "content-type": { + "example": "text/html", + "schema": { + "type": "string" + } + }, + "x-common-marker-version": { + "example": "0.17.4", + "schema": { + "type": "string" + } + }, + "x-rate-limit-limit": { + "example": 5000, + "schema": { + "type": "integer" + } + }, + "x-rate-limit-remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "x-rate-limit-reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" + } + }, + "location": { + "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", + "schema": { + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/provider-dev/openapi/api.github.com.deref.yaml b/provider-dev/openapi/api.github.com.deref.yaml deleted file mode 100644 index 1633b76..0000000 --- a/provider-dev/openapi/api.github.com.deref.yaml +++ /dev/null @@ -1,237628 +0,0 @@ ---- -openapi: 3.0.3 -info: - version: 1.1.4 - title: GitHub v3 REST API - description: GitHub's v3 REST API. - license: - name: MIT - url: https://spdx.org/licenses/MIT - termsOfService: https://docs.github.com/articles/github-terms-of-service - contact: - name: Support - url: https://support.github.com/contact?tags=dotcom-rest-api - x-github-plan: api.github.com -tags: -- name: actions - description: Endpoints to manage GitHub Actions using the REST API. -- name: activity - description: Activity APIs provide access to notifications, subscriptions, and timelines. -- name: apps - description: Information for integrations and installations. -- name: billing - description: Monitor charges and usage from Actions and Packages. -- name: checks - description: Rich interactions with checks run by your integrations. -- name: code-scanning - description: Retrieve code scanning alerts from a repository. -- name: codes-of-conduct - description: Insight into codes of conduct for your communities. -- name: emojis - description: List emojis available to use on GitHub. -- name: dependabot - description: Endpoints to manage Dependabot. -- name: dependency-graph - description: Endpoints to access Dependency Graph features. -- name: gists - description: View, modify your gists. -- name: git - description: Raw Git functionality. -- name: gitignore - description: View gitignore templates -- name: issues - description: Interact with GitHub Issues. -- name: licenses - description: View various OSS licenses. -- name: markdown - description: Render GitHub flavored Markdown -- name: merge-queue - description: Interact with GitHub Merge Queues. -- name: meta - description: Endpoints that give information about the API. -- name: migrations - description: Move projects to or from GitHub. -- name: oidc - description: Endpoints to manage GitHub OIDC configuration using the REST API. -- name: orgs - description: Interact with organizations. -- name: packages - description: Manage packages for authenticated users and organizations. -- name: pulls - description: Interact with GitHub Pull Requests. -- name: rate-limit - description: Check your current rate limit status. -- name: reactions - description: Interact with reactions to various GitHub entities. -- name: repos - description: Interact with GitHub Repos. -- name: search - description: Search for specific items on GitHub. -- name: secret-scanning - description: Retrieve secret scanning alerts from a repository. -- name: teams - description: Interact with GitHub Teams. -- name: users - description: Interact with and view information about users and also current user. -- name: codespaces - description: Endpoints to manage Codespaces using the REST API. -- name: copilot - description: Endpoints to manage Copilot using the REST API. -- name: security-advisories - description: Manage security advisories. -- name: interactions - description: Owner or admin management of users interactions. -- name: classroom - description: Interact with GitHub Classroom. -- name: desktop - description: Desktop specific endpoints. -- name: enterprise-teams - description: Endpoints to manage GitHub Enterprise Teams. -- name: enterprise-team-memberships - description: Endpoints to manage GitHub Enterprise Team memberships. -- name: enterprise-team-organizations - description: Endpoints to manage GitHub Enterprise Team organization assignments. -- name: code-security - description: Endpoints to manage Code security using the REST API. -- name: private-registries - description: Manage private registry configurations. -- name: hosted-compute - description: Manage hosted compute networking resources. -- name: credentials - description: Revoke compromised or leaked GitHub credentials. -- name: campaigns - description: Endpoints to manage campaigns via the REST API. -- name: projects - description: Endpoints to manage Projects using the REST API. -- name: agent-tasks - description: Endpoints to manage and interact with agent tasks. -servers: -- url: https://api.github.com -externalDocs: - description: GitHub v3 REST API - url: https://docs.github.com/rest/ -paths: - "/": - get: - summary: GitHub API Root - description: Get Hypermedia links to resources accessible in GitHub's REST API - tags: - - meta - operationId: meta/root - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - current_user_url: - type: string - format: uri-template - current_user_authorizations_html_url: - type: string - format: uri-template - authorizations_url: - type: string - format: uri-template - code_search_url: - type: string - format: uri-template - commit_search_url: - type: string - format: uri-template - emails_url: - type: string - format: uri-template - emojis_url: - type: string - format: uri-template - events_url: - type: string - format: uri-template - feeds_url: - type: string - format: uri-template - followers_url: - type: string - format: uri-template - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - hub_url: - type: string - format: uri-template - deprecated: true - issue_search_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - label_search_url: - type: string - format: uri-template - notifications_url: - type: string - format: uri-template - organization_url: - type: string - format: uri-template - organization_repositories_url: - type: string - format: uri-template - organization_teams_url: - type: string - format: uri-template - public_gists_url: - type: string - format: uri-template - rate_limit_url: - type: string - format: uri-template - repository_url: - type: string - format: uri-template - repository_search_url: - type: string - format: uri-template - current_user_repositories_url: - type: string - format: uri-template - starred_url: - type: string - format: uri-template - starred_gists_url: - type: string - format: uri-template - topic_search_url: - type: string - format: uri-template - user_url: - type: string - format: uri-template - user_organizations_url: - type: string - format: uri-template - user_repositories_url: - type: string - format: uri-template - user_search_url: - type: string - format: uri-template - required: - - current_user_url - - current_user_authorizations_html_url - - authorizations_url - - code_search_url - - commit_search_url - - emails_url - - emojis_url - - events_url - - feeds_url - - followers_url - - following_url - - gists_url - - issue_search_url - - issues_url - - keys_url - - label_search_url - - notifications_url - - organization_url - - organization_repositories_url - - organization_teams_url - - public_gists_url - - rate_limit_url - - repository_url - - repository_search_url - - current_user_repositories_url - - starred_url - - starred_gists_url - - user_url - - user_organizations_url - - user_repositories_url - - user_search_url - x-github-breaking-changes: - - changeset: remove_authorizations_url_from_api_root - patch: - - op: remove - path: "/properties/authorizations_url" - - op: remove - path: "/required/2" - version: '2026-03-10' - - changeset: remove_hub_url_from_api_root - patch: - properties: - hub_url: - version: '2026-03-10' - examples: - default: - value: - current_user_url: https://api.github.com/user - current_user_authorizations_html_url: https://github.com/settings/connections/applications{/client_id} - authorizations_url: https://api.github.com/authorizations - code_search_url: https://api.github.com/search/code?q={query}{&page,per_page,sort,order} - commit_search_url: https://api.github.com/search/commits?q={query}{&page,per_page,sort,order} - emails_url: https://api.github.com/user/emails - emojis_url: https://api.github.com/emojis - events_url: https://api.github.com/events - feeds_url: https://api.github.com/feeds - followers_url: https://api.github.com/user/followers - following_url: https://api.github.com/user/following{/target} - gists_url: https://api.github.com/gists{/gist_id} - hub_url: https://api.github.com/hub - issue_search_url: https://api.github.com/search/issues?q={query}{&page,per_page,sort,order} - issues_url: https://api.github.com/issues - keys_url: https://api.github.com/user/keys - label_search_url: https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page} - notifications_url: https://api.github.com/notifications - organization_url: https://api.github.com/orgs/{org} - organization_repositories_url: https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort} - organization_teams_url: https://api.github.com/orgs/{org}/teams - public_gists_url: https://api.github.com/gists/public - rate_limit_url: https://api.github.com/rate_limit - repository_url: https://api.github.com/repos/{owner}/{repo} - repository_search_url: https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order} - current_user_repositories_url: https://api.github.com/user/repos{?type,page,per_page,sort} - starred_url: https://api.github.com/user/starred{/owner}{/repo} - starred_gists_url: https://api.github.com/gists/starred - topic_search_url: https://api.github.com/search/topics?q={query}{&page,per_page} - user_url: https://api.github.com/users/{user} - user_organizations_url: https://api.github.com/user/orgs - user_repositories_url: https://api.github.com/users/{user}/repos{?type,page,per_page,sort} - user_search_url: https://api.github.com/search/users?q={query}{&page,per_page,sort,order} - x-github-breaking-changes: - - changeset: remove_authorizations_url_from_api_root - patch: - - op: remove - path: "/value/authorizations_url" - version: '2026-03-10' - - changeset: remove_hub_url_from_api_root - patch: - value: - hub_url: - version: '2026-03-10' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: meta - subcategory: meta - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/meta/meta#github-api-root - "/advisories": - get: - summary: List global security advisories - description: |- - Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. - - By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." - tags: - - security-advisories - operationId: security-advisories/list-global-advisories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories - parameters: - - name: ghsa_id - in: query - description: If specified, only advisories with this GHSA (GitHub Security - Advisory) identifier will be returned. - schema: - type: string - - name: type - in: query - description: If specified, only advisories of this type will be returned. - By default, a request with no other parameters defined will only return - reviewed advisories that are not malware. - schema: - type: string - enum: - - reviewed - - malware - - unreviewed - default: reviewed - - name: cve_id - description: If specified, only advisories with this CVE (Common Vulnerabilities - and Exposures) identifier will be returned. - in: query - schema: - type: string - - name: ecosystem - in: query - description: If specified, only advisories for these ecosystems will be returned. - schema: &1 - type: string - description: The package's language or package management ecosystem. - enum: - - rubygems - - npm - - pip - - maven - - nuget - - composer - - go - - rust - - erlang - - actions - - pub - - other - - swift - - name: severity - in: query - description: If specified, only advisories with these severities will be returned. - schema: - type: string - enum: - - unknown - - low - - medium - - high - - critical - - name: cwes - in: query - description: |- - If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. - - Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` - schema: - oneOf: - - type: string - - type: array - items: - type: string - - name: is_withdrawn - in: query - description: Whether to only return advisories that have been withdrawn. - schema: - type: boolean - - name: affects - in: query - description: |- - If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. - If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. - - Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` - schema: - oneOf: - - type: string - - type: array - maxItems: 1000 - items: - type: string - - name: published - in: query - description: |- - If specified, only return advisories that were published on a date or date range. - - For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - schema: - type: string - - name: updated - in: query - description: |- - If specified, only return advisories that were updated on a date or date range. - - For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - schema: - type: string - - name: modified - description: |- - If specified, only show advisories that were updated or published on a date or date range. - - For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - in: query - schema: - type: string - - name: epss_percentage - in: query - description: |- - If specified, only return advisories that have an EPSS percentage score that matches the provided value. - The EPSS percentage represents the likelihood of a CVE being exploited. - schema: - type: string - - name: epss_percentile - in: query - description: |- - If specified, only return advisories that have an EPSS percentile score that matches the provided value. - The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. - schema: - type: string - - &47 - name: before - description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). - If specified, the query only searches for results before this cursor. For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - required: false - schema: - type: string - - &48 - name: after - description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). - If specified, the query only searches for results after this cursor. For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - required: false - schema: - type: string - - &61 - name: direction - description: The direction to sort the results by. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - updated - - published - - epss_percentage - - epss_percentile - default: published - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &2 - description: A GitHub Security Advisory. - type: object - properties: - ghsa_id: - type: string - description: The GitHub Security Advisory ID. - readOnly: true - cve_id: - type: string - description: The Common Vulnerabilities and Exposures (CVE) - ID. - nullable: true - readOnly: true - url: - type: string - description: The API URL for the advisory. - readOnly: true - html_url: - type: string - format: uri - description: The URL for the advisory. - readOnly: true - repository_advisory_url: - type: string - format: uri - description: The API URL for the repository advisory. - readOnly: true - nullable: true - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: string - description: A detailed description of what the advisory entails. - maxLength: 65535 - nullable: true - type: - type: string - description: The type of advisory. - readOnly: true - enum: - - reviewed - - unreviewed - - malware - severity: - type: string - description: The severity of the advisory. - enum: - - critical - - high - - medium - - low - - unknown - source_code_location: - type: string - format: uri - description: The URL of the advisory's source code. - nullable: true - identifiers: - type: array - nullable: true - readOnly: true - items: - type: object - properties: - type: - type: string - description: The type of identifier. - enum: - - CVE - - GHSA - value: - type: string - description: The identifier value. - required: - - type - - value - references: - type: array - nullable: true - items: - type: string - description: URLs with more information regarding the advisory. - published_at: - type: string - format: date-time - description: The date and time of when the advisory was published, - in ISO 8601 format. - readOnly: true - updated_at: - type: string - format: date-time - description: The date and time of when the advisory was last - updated, in ISO 8601 format. - readOnly: true - github_reviewed_at: - type: string - format: date-time - description: The date and time of when the advisory was reviewed - by GitHub, in ISO 8601 format. - readOnly: true - nullable: true - nvd_published_at: - type: string - format: date-time - description: |- - The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - This field is only populated when the advisory is imported from the National Vulnerability Database. - readOnly: true - nullable: true - withdrawn_at: - type: string - format: date-time - description: The date and time of when the advisory was withdrawn, - in ISO 8601 format. - readOnly: true - nullable: true - vulnerabilities: - type: array - description: The products and respective version ranges affected - by the advisory. - nullable: true - items: - description: A vulnerability describing the product and its - affected versions within a GitHub Security Advisory. - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - nullable: true - properties: - ecosystem: *1 - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - - name - vulnerable_version_range: - type: string - description: The range of the package versions affected - by the vulnerability. - nullable: true - first_patched_version: - type: string - description: The package version that resolves the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected - by the vulnerability. - nullable: true - readOnly: true - items: - type: string - required: - - package - - vulnerable_version_range - - first_patched_version - - vulnerable_functions - cvss: - type: object - nullable: true - properties: - vector_string: - type: string - description: The CVSS vector. - nullable: true - score: - type: number - description: The CVSS score. - minimum: 0 - maximum: 10 - nullable: true - readOnly: true - required: - - vector_string - - score - cvss_severities: &63 - type: object - nullable: true - properties: - cvss_v3: - type: object - nullable: true - properties: - vector_string: - type: string - description: The CVSS 3 vector string. - nullable: true - score: - type: number - description: The CVSS 3 score. - minimum: 0 - maximum: 10 - nullable: true - readOnly: true - required: - - vector_string - - score - cvss_v4: - type: object - nullable: true - properties: - vector_string: - type: string - description: The CVSS 4 vector string. - nullable: true - score: - type: number - description: The CVSS 4 score. - minimum: 0 - maximum: 10 - nullable: true - readOnly: true - required: - - vector_string - - score - epss: &64 - type: object - nullable: true - readOnly: true - description: The EPSS scores as calculated by the [Exploit Prediction - Scoring System](https://www.first.org/epss). - properties: - percentage: - type: number - minimum: 0 - maximum: 100 - percentile: - type: number - minimum: 0 - maximum: 100 - cwes: - type: array - nullable: true - items: - type: object - properties: - cwe_id: - type: string - description: The Common Weakness Enumeration (CWE) identifier. - name: - type: string - description: The name of the CWE. - readOnly: true - required: - - cwe_id - - name - credits: - type: array - description: The users who contributed to the advisory. - nullable: true - readOnly: true - items: - type: object - properties: - user: &4 - title: Simple User - description: A GitHub user. - type: object - properties: &20 - name: - nullable: true - type: string - email: - nullable: true - type: string - login: - type: string - example: octocat - id: - type: integer - format: int64 - example: 1 - node_id: - type: string - example: MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - gravatar_id: - type: string - example: 41d064eb2195891e12d0413f63227ea7 - nullable: true - url: - type: string - format: uri - example: https://api.github.com/users/octocat - html_url: - type: string - format: uri - example: https://github.com/octocat - followers_url: - type: string - format: uri - example: https://api.github.com/users/octocat/followers - following_url: - type: string - example: https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - example: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: - type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: - type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: - type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: - type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: - type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: - type: string - format: uri - example: https://api.github.com/users/octocat/received_events - type: - type: string - example: User - site_admin: - type: boolean - starred_at: - type: string - example: '"2020-07-09T00:17:55Z"' - user_view_type: - type: string - example: public - required: &21 - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - type: &332 - type: string - description: The type of credit the user is receiving. - enum: - - analyst - - finder - - reporter - - coordinator - - remediation_developer - - remediation_reviewer - - remediation_verifier - - tool - - sponsor - - other - required: - - user - - type - required: - - ghsa_id - - cve_id - - url - - html_url - - repository_advisory_url - - summary - - description - - type - - severity - - source_code_location - - identifiers - - references - - published_at - - updated_at - - github_reviewed_at - - nvd_published_at - - withdrawn_at - - vulnerabilities - - cvss - - cwes - - credits - additionalProperties: false - x-github-breaking-changes: - - changeset: deprecate_cvss - patch: - properties: - cvss: - required: - - ghsa_id - - cve_id - - url - - html_url - - repository_advisory_url - - summary - - description - - type - - severity - - source_code_location - - identifiers - - references - - published_at - - updated_at - - github_reviewed_at - - nvd_published_at - - withdrawn_at - - vulnerabilities - - cwes - - credits - version: '2026-03-10' - examples: - default: - value: - - id: 1 - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/advisories/GHSA-abcd-1234-efgh - repository_advisory_url: https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh - summary: Heartbleed security advisory - description: This bug allows an attacker to read portions of the - affected server’s memory, potentially disclosing sensitive information. - type: reviewed - severity: high - source_code_location: https://github.com/project/a-package - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: CVE-2050-00000 - references: - - https://nvd.nist.gov/vuln/detail/CVE-2050-00000 - published_at: '2023-03-23T02:30:56Z' - updated_at: '2023-03-24T02:30:56Z' - github_reviewed_at: '2023-03-23T02:30:56Z' - nvd_published_at: '2023-03-25T02:30:56Z' - withdrawn_at: - vulnerabilities: - - package: - ecosystem: npm - name: a-package - first_patched_version: 1.0.3 - vulnerable_version_range: "<=1.0.2" - vulnerable_functions: - - a_function - cvss: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 9.3 - cwes: - - cwe_id: CWE-400 - name: Uncontrolled Resource Consumption - epss: - percentage: 0.00045 - percentile: 0.16001e0 - credits: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - '429': - description: Too many requests - content: - application/json: - schema: &3 - title: Basic Error - description: Basic Error - type: object - properties: - message: - type: string - documentation_url: - type: string - url: - type: string - status: - type: string - '422': &7 - description: Validation failed, or the endpoint has been spammed. - content: - application/json: - schema: &130 - title: Validation Error Simple - description: Validation Error Simple - type: object - required: - - message - - documentation_url - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: global-advisories - "/advisories/{ghsa_id}": - get: - summary: Get a global security advisory - description: Gets a global security advisory using its GitHub Security Advisory - (GHSA) identifier. - tags: - - security-advisories - operationId: security-advisories/get-global-advisory - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory - parameters: - - &666 - name: ghsa_id - description: The GHSA (GitHub Security Advisory) identifier of the advisory. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *2 - examples: - default: - value: - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/advisories/GHSA-abcd-1234-efgh - repository_advisory_url: https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - type: reviewed - severity: high - source_code_location: https://github.com/project/a-package - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: CVE-2050-00000 - references: - - https://nvd.nist.gov/vuln/detail/CVE-2050-00000 - published_at: '2023-03-23T02:30:56Z' - updated_at: '2023-03-24T02:30:56Z' - github_reviewed_at: '2023-03-23T02:30:56Z' - nvd_published_at: '2023-03-25T02:30:56Z' - withdrawn_at: - vulnerabilities: - - package: - ecosystem: npm - name: a-package - first_patched_version: 1.0.3 - vulnerable_version_range: "<=1.0.2" - vulnerable_functions: - - a_function - cvss: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H - score: 7.6 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 9.3 - cwes: - - cwe_id: CWE-400 - name: Uncontrolled Resource Consumption - credits: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - '404': &6 - description: Resource not found - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: global-advisories - "/agents/repos/{owner}/{repo}/tasks": - get: - summary: List tasks for repository - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for a specific repository - tags: - - agent-tasks - operationId: agent-tasks/list-tasks-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: 'Comma-separated list of task states to filter by. Can be any - combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, - `waiting_for_user`, `timed_out`, `cancelled`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - - name: creator_id - in: query - schema: - type: integer - description: Filter tasks by creator user ID - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="prev" (when current page > 1), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; - rel="next", ; - rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: string - format: date-time - nullable: true - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - post: - summary: Create a task - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Creates a new task for a repository. - tags: - - agent-tasks - operationId: agent-tasks/create-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - prompt - properties: - prompt: - type: string - description: The user's prompt for the agent - model: - type: string - description: 'The model to use for this task. The allowed models - may change over time and depend on the user''s GitHub Copilot - plan and organization policies. Currently supported values: `claude-sonnet-4.6`, - `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, - `claude-sonnet-4.5`, `claude-opus-4.5`' - create_pull_request: - type: boolean - description: Whether to create a PR. - default: false - base_ref: - type: string - description: Base ref for new branch/PR - examples: - default: - value: - prompt: Fix the login button on the homepage - base_ref: main - responses: - '201': - description: Task created successfully - content: - application/json: - schema: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, etc.) - archived_at: - type: string - format: date-time - nullable: true - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: queued - session_count: 1 - artifacts: [] - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T00:00:00Z' - '400': - description: Problems parsing JSON - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/repos/{owner}/{repo}/tasks/{task_id}": - get: - summary: Get a task by repo - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID scoped to an owner/repo path - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-repo-and-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: owner - in: path - required: true - schema: - type: string - description: The account owner of the repository. The name is not case sensitive. - - name: repo - in: path - required: true - schema: - type: string - description: The name of the repository. The name is not case sensitive. - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: string - format: date-time - nullable: true - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks": - get: - summary: List tasks - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a list of tasks for the authenticated user - tags: - - agent-tasks - operationId: agent-tasks/list-tasks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: per_page - in: query - schema: - type: integer - default: 30 - minimum: 1 - maximum: 100 - description: The number of results per page (max 100). - - name: page - in: query - schema: - type: integer - default: 1 - minimum: 1 - description: The page number of the results to fetch. - - name: sort - in: query - schema: - type: string - default: updated_at - enum: - - updated_at - - created_at - description: The field to sort results by. Can be `updated_at` or `created_at`. - - name: direction - in: query - schema: - type: string - default: desc - enum: - - asc - - desc - description: The direction to sort results. Can be `asc` or `desc`. - - name: state - in: query - schema: - type: string - description: 'Comma-separated list of task states to filter by. Can be any - combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, - `waiting_for_user`, `timed_out`, `cancelled`.' - - name: is_archived - in: query - schema: - type: boolean - default: false - description: Filter by archived status. When `true`, returns only archived - tasks. When `false` or omitted, returns only non-archived tasks. Defaults - to `false`. - - name: since - in: query - schema: - type: string - format: date-time - description: Only show tasks updated at or after this time (ISO 8601 timestamp) - responses: - '200': - description: Tasks retrieved successfully - headers: - Link: - description: | - Pagination links. Contains rel="first" (always), - rel="next" (when more pages exist), and rel="last" (when on the final page). - schema: - type: string - example: ; rel="next", - ; rel="first" - content: - application/json: - schema: - type: object - required: - - tasks - properties: - tasks: - type: array - items: - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its - most recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: - `pull`, `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: string - format: date-time - nullable: true - description: Timestamp when the task was archived, null - if not archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - description: List of tasks - total_active_count: - type: integer - format: int32 - description: Total count of active (non-archived) tasks - total_archived_count: - type: integer - format: int32 - description: Total count of archived tasks - examples: - default: - value: - tasks: - - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - '400': - description: Bad request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/agents/tasks/{task_id}": - get: - summary: Get a task by ID - description: | - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Returns a task by ID with its associated sessions - tags: - - agent-tasks - operationId: agent-tasks/get-task-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: agent-tasks - subcategory: agent-tasks - parameters: - - name: task_id - in: path - required: true - schema: - type: string - description: The unique identifier of the task. - responses: - '200': - description: Task retrieved successfully - content: - application/json: - schema: - allOf: - - type: object - required: - - id - - state - - created_at - properties: - id: - type: string - description: Unique task identifier - url: - type: string - description: API URL for this task - html_url: - type: string - description: Web URL for this task - name: - type: string - description: Human-readable name derived from the task prompt - creator: - oneOf: - - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: The entity who created this task - creator_type: - type: string - description: Type of the task creator - enum: - - user - - organization - user_collaborators: - type: array - items: - type: object - description: A GitHub user - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - description: User objects of collaborators on this task - deprecated: true - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this task belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - state: - type: string - description: Current state of the task, derived from its most - recent session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - session_count: - type: integer - format: int32 - description: Number of sessions in this task - artifacts: - type: array - items: - type: object - description: A resource generated by the task - required: - - provider - - type - - data - properties: - provider: - type: string - enum: - - github - description: Provider namespace - type: - type: string - enum: - - pull - - branch - description: 'Type of artifact. Available Values: `pull`, - `branch`. - - ' - data: - oneOf: - - type: object - description: A GitHub resource (pull request, issue, - etc.) - required: - - id - properties: - id: - type: integer - format: int64 - description: GitHub resource ID - global_id: - type: string - description: GraphQL global ID - - type: object - description: A Git branch reference - required: - - head_ref - - base_ref - properties: - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - description: Resource data (shape depends on type) - description: Resources created by this task (PRs, branches, - etc.) - archived_at: - type: string - format: date-time - nullable: true - description: Timestamp when the task was archived, null if not - archived - updated_at: - type: string - format: date-time - description: Timestamp of the most recent update - created_at: - type: string - format: date-time - description: Timestamp when the task was created - - type: object - properties: - sessions: - type: array - items: - type: object - description: Full session details within a task - required: - - id - - state - - created_at - properties: - id: - type: string - description: Session ID - name: - type: string - description: Session name - user: - description: The user who created this session - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - owner: - description: The owner of the repository - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the user - repository: - description: The repository this session belongs to - type: object - properties: - id: - type: integer - format: int64 - description: The unique identifier of the repository - task_id: - type: string - description: Task ID this session belongs to - state: - type: string - description: Current state of a session - enum: - - queued - - in_progress - - completed - - failed - - idle - - waiting_for_user - - timed_out - - cancelled - created_at: - type: string - format: date-time - description: Creation timestamp - updated_at: - type: string - format: date-time - description: Last update timestamp - completed_at: - type: string - format: date-time - description: Completion timestamp - prompt: - type: string - description: Content of the triggering event - head_ref: - type: string - description: Head branch name - base_ref: - type: string - description: Base branch name - model: - type: string - description: Model used for this session - error: - type: object - description: Error details for a failed session - properties: - message: - type: string - description: Error message - description: Sessions associated with this task - examples: - default: - value: - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - creator: - id: 1 - creator_type: user - owner: - id: 1 - repository: - id: 1296269 - state: completed - session_count: 1 - artifacts: - - provider: github - type: pull - data: - id: 42 - archived_at: - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - sessions: - - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 - name: Fix the login button on the homepage - user: - id: 1 - owner: - id: 1 - repository: - id: 1296269 - task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 - state: completed - created_at: '2025-01-01T00:00:00Z' - updated_at: '2025-01-01T01:00:00Z' - completed_at: '2025-01-01T01:00:00Z' - prompt: Fix the login button on the homepage - head_ref: copilot/fix-1 - base_ref: main - model: claude-sonnet-4.6 - '400': - description: Problems parsing request - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '401': - description: Authentication required - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '403': - description: Insufficient permissions - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '404': - description: Resource not found - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - '422': - description: Validation Failed - content: - application/json: - schema: - type: object - description: |- - Structured error response following GitHub REST API conventions. - For 422 Unprocessable Entity the errors array contains validation - details; for other error status codes only message and - documentation_url are returned. - required: - - message - - documentation_url - properties: - message: - type: string - description: Summary message (e.g. "Validation Failed", "Not Found") - errors: - type: array - items: - type: object - description: A single validation error - required: - - code - properties: - code: - type: string - enum: - - missing - - missing_field - - invalid - - already_exists - - unprocessable - - custom - description: Machine-readable error code - message: - type: string - description: Human-readable message (populated when code - is "custom") - description: List of validation errors (present only for 422 responses) - documentation_url: - type: string - description: URL to relevant API documentation - "/app": - get: - summary: Get the authenticated app - description: |- - Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-authenticated - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#get-the-authenticated-app - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: &5 - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They can - be installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within - GitHub. - type: object - nullable: true - properties: &80 - id: - description: Unique identifier of the GitHub app - example: 37 - type: integer - slug: - description: The slug name of the GitHub app - example: probot-owners - type: string - node_id: - type: string - example: MDExOkludGVncmF0aW9uMQ== - client_id: - type: string - example: '"Iv1.25b5d1e65ffc4022"' - owner: - oneOf: - - *4 - - &18 - title: Enterprise - description: An enterprise on GitHub. - type: object - properties: - description: - description: A short description of the enterprise. - type: string - nullable: true - html_url: - type: string - format: uri - example: https://github.com/enterprises/octo-business - website_url: - description: The enterprise's website URL. - type: string - nullable: true - format: uri - id: - description: Unique identifier of the enterprise - example: 42 - type: integer - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the enterprise. - type: string - example: Octo Business - slug: - description: The slug url identifier for the enterprise. - type: string - example: octo-business - created_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:01:12Z' - updated_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:14:43Z' - avatar_url: - type: string - format: uri - required: - - id - - node_id - - name - - slug - - html_url - - created_at - - updated_at - - avatar_url - name: - description: The name of the GitHub app - example: Probot Owners - type: string - description: - type: string - example: The description of the app. - nullable: true - external_url: - type: string - format: uri - example: https://example.com - html_url: - type: string - format: uri - example: https://github.com/apps/super-ci - created_at: - type: string - format: date-time - example: '2017-07-08T16:18:44-04:00' - updated_at: - type: string - format: date-time - example: '2017-07-08T16:18:44-04:00' - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - issues: - type: string - checks: - type: string - metadata: - type: string - contents: - type: string - deployments: - type: string - additionalProperties: - type: string - example: - issues: read - deployments: write - events: - description: The list of events for the GitHub app. Note that - the `installation_target`, `security_advisory`, and `meta` events - are not included because they are global events and not specific - to an installation. - example: - - label - - deployment - type: array - items: - type: string - installations_count: - description: The number of installations associated with the GitHub - app. Only returned when the integration is requesting details - about itself. - example: 5 - type: integer - required: &81 - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - - permissions - - events - examples: - default: &30 - value: - id: 1 - slug: octoapp - client_id: Iv1.ab1112223334445c - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: apps - "/app-manifests/{code}/conversions": - post: - summary: Create a GitHub App from a manifest - description: Use this endpoint to complete the handshake necessary when implementing - the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). - When you create a GitHub App with the manifest flow, you receive a temporary - `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - tags: - - apps - operationId: apps/create-from-manifest - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest - parameters: - - name: code - in: path - required: true - schema: - type: string - responses: - '201': - description: Response - content: - application/json: - schema: - allOf: - - *5 - - type: object - properties: - client_id: - type: string - client_secret: - type: string - webhook_secret: - type: string - nullable: true - pem: - type: string - required: - - client_id - - client_secret - - webhook_secret - - pem - additionalProperties: true - examples: - default: - value: - id: 1 - slug: octoapp - node_id: MDxOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - client_id: Iv1.8a61f9b3a7aba766 - client_secret: 1726be1638095a19edd134c77bde3aa2ece1e5d8 - webhook_secret: e340154128314309424b7c8e90325147d99fdafa - pem: | - -----BEGIN RSA PRIVATE KEY----- - MIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM - 9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP - X0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/ - 6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm - oNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma - szdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ - dBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva - KOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo - gDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP - kYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX - NuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd - NBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE - ZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG - J4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv - eDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3 - FI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk - 77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH - Pza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB - 1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c - 57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8 - M5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic - I9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN - 6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK - fgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG - ZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu - -----END RSA PRIVATE KEY----- - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - "/app/hook/config": - get: - summary: Get a webhook configuration for an app - description: |- - Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-webhook-config-for-app - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app - responses: - '200': - description: Response - content: - application/json: - schema: &12 - title: Webhook Configuration - description: Configuration object of the webhook - type: object - properties: - url: &8 - type: string - description: The URL to which the payloads will be delivered. - example: https://example.com/webhook - format: uri - content_type: &9 - type: string - description: The media type used to serialize the payloads. Supported - values include `json` and `form`. The default is `form`. - example: '"json"' - secret: &10 - type: string - description: If provided, the `secret` will be used as the `key` - to generate the HMAC hex digest value for [delivery signature - headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). - example: '"********"' - insecure_ssl: &11 - oneOf: - - type: string - description: Determines whether the SSL certificate of the host - for `url` will be verified when delivering payloads. Supported - values include `0` (verification is performed) and `1` (verification - is not performed). The default is `0`. **We strongly recommend - not setting this to `1` as you are subject to man-in-the-middle - and other attacks.** - example: '"0"' - - type: number - examples: - default: &13 - value: - content_type: json - insecure_ssl: '0' - secret: "********" - url: https://example.com/webhook - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: webhooks - patch: - summary: Update a webhook configuration for an app - description: |- - Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/update-webhook-config-for-app - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - examples: - default: - value: - content_type: json - insecure_ssl: '0' - secret: "********" - url: https://example.com/webhook - responses: - '200': - description: Response - content: - application/json: - schema: *12 - examples: - default: *13 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: webhooks - "/app/hook/deliveries": - get: - summary: List deliveries for an app webhook - description: |- - Returns a list of webhook deliveries for the webhook configured for a GitHub App. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/list-webhook-deliveries - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook - parameters: - - &17 - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 30 - - &217 - name: cursor - description: 'Used for pagination: the starting delivery from which the page - of deliveries is fetched. Refer to the `link` header for the next and previous - page cursors.' - in: query - required: false - schema: - type: string - - &218 - name: status - description: Returns webhook deliveries filtered by delivery outcome classification - based on `status_code` range. A `status` of `success` returns deliveries - with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` - returns deliveries with a `status_code` in the 400-599 range (inclusive). - in: query - required: false - schema: - type: string - enum: - - success - - failure - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &219 - title: Simple webhook delivery - description: Delivery made by a webhook, without request and response - information. - type: object - properties: - id: - description: Unique identifier of the webhook delivery. - type: integer - format: int64 - example: 42 - guid: - description: Unique identifier for the event (shared with all - deliveries for all webhooks that subscribe to this event). - type: string - example: 58474f00-b361-11eb-836d-0e4f3503ccbe - delivered_at: - description: Time when the webhook delivery occurred. - type: string - format: date-time - example: '2021-05-12T20:33:44Z' - redelivery: - description: Whether the webhook delivery is a redelivery. - type: boolean - example: false - duration: - description: Time spent delivering. - type: number - example: 0.03 - status: - description: Describes the response returned after attempting - the delivery. - type: string - example: failed to connect - status_code: - description: Status code received when delivery was made. - type: integer - example: 502 - event: - description: The event that triggered the delivery. - type: string - example: issues - action: - description: The type of activity for the event that triggered - the delivery. - type: string - example: opened - nullable: true - installation_id: - description: The id of the GitHub App installation associated - with this event. - type: integer - format: int64 - example: 123 - nullable: true - repository_id: - description: The id of the repository associated with this event. - type: integer - format: int64 - example: 123 - nullable: true - throttled_at: - description: Time when the webhook delivery was throttled. - type: string - format: date-time - example: '2021-05-12T20:33:44Z' - nullable: true - required: - - id - - guid - - delivered_at - - redelivery - - duration - - status - - status_code - - event - - action - - installation_id - - repository_id - examples: - default: &220 - value: - - id: 12345678 - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - delivered_at: '2019-06-03T00:57:16Z' - redelivery: false - duration: 0.27 - status: OK - status_code: 200 - event: issues - action: opened - installation_id: 123 - repository_id: 456 - throttled_at: '2019-06-03T00:57:16Z' - - id: 123456789 - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - delivered_at: '2019-06-04T00:57:16Z' - redelivery: true - duration: 0.28 - status: OK - status_code: 200 - event: issues - action: opened - installation_id: 123 - repository_id: 456 - throttled_at: - '400': &14 - description: Bad Request - content: - application/json: - schema: *3 - application/scim+json: - schema: - title: Scim Error - description: Scim Error - type: object - properties: - message: - type: string - nullable: true - documentation_url: - type: string - nullable: true - detail: - type: string - nullable: true - status: - type: integer - scimType: - type: string - nullable: true - schemas: - type: array - items: - type: string - '422': &15 - description: Validation failed, or the endpoint has been spammed. - content: - application/json: - schema: &129 - title: Validation Error - description: Validation Error - type: object - required: - - message - - documentation_url - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - required: - - code - properties: - resource: - type: string - field: - type: string - message: - type: string - code: - type: string - index: - type: integer - value: - oneOf: - - type: string - nullable: true - - type: integer - nullable: true - - type: array - nullable: true - items: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: webhooks - "/app/hook/deliveries/{delivery_id}": - get: - summary: Get a delivery for an app webhook - description: |- - Returns a delivery for the webhook configured for a GitHub App. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-webhook-delivery - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook - parameters: - - &16 - name: delivery_id - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &221 - title: Webhook delivery - description: Delivery made by a webhook. - type: object - properties: - id: - description: Unique identifier of the delivery. - type: integer - example: 42 - guid: - description: Unique identifier for the event (shared with all - deliveries for all webhooks that subscribe to this event). - type: string - example: 58474f00-b361-11eb-836d-0e4f3503ccbe - delivered_at: - description: Time when the delivery was delivered. - type: string - format: date-time - example: '2021-05-12T20:33:44Z' - redelivery: - description: Whether the delivery is a redelivery. - type: boolean - example: false - duration: - description: Time spent delivering. - type: number - example: 0.03 - status: - description: Description of the status of the attempted delivery - type: string - example: failed to connect - status_code: - description: Status code received when delivery was made. - type: integer - example: 502 - event: - description: The event that triggered the delivery. - type: string - example: issues - action: - description: The type of activity for the event that triggered - the delivery. - type: string - example: opened - nullable: true - installation_id: - description: The id of the GitHub App installation associated - with this event. - type: integer - example: 123 - nullable: true - repository_id: - description: The id of the repository associated with this event. - type: integer - example: 123 - nullable: true - throttled_at: - description: Time when the webhook delivery was throttled. - type: string - format: date-time - example: '2021-05-12T20:33:44Z' - nullable: true - url: - description: The URL target of the delivery. - type: string - example: https://www.example.com - request: - type: object - properties: - headers: - description: The request headers sent with the webhook delivery. - type: object - nullable: true - additionalProperties: true - payload: - description: The webhook payload. - type: object - nullable: true - additionalProperties: true - required: - - headers - - payload - response: - type: object - properties: - headers: - description: The response headers received when the delivery - was made. - type: object - nullable: true - additionalProperties: true - payload: - description: The response payload received. - type: string - nullable: true - additionalProperties: true - required: - - headers - - payload - required: - - id - - guid - - delivered_at - - redelivery - - duration - - status - - status_code - - event - - action - - installation_id - - repository_id - - request - - response - examples: - default: &222 - value: - id: 12345678 - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - delivered_at: '2019-06-03T00:57:16Z' - redelivery: false - duration: 0.27 - status: OK - status_code: 200 - event: issues - action: opened - installation_id: 123 - repository_id: 456 - url: https://www.example.com - throttled_at: '2019-06-03T00:57:16Z' - request: - headers: - X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - Accept: "*/*" - X-GitHub-Hook-ID: '42' - User-Agent: GitHub-Hookshot/b8c71d8 - X-GitHub-Event: issues - X-GitHub-Hook-Installation-Target-ID: '123' - X-GitHub-Hook-Installation-Target-Type: repository - content-type: application/json - X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - payload: - action: opened - issue: - body: foo - repository: - id: 123 - response: - headers: - Content-Type: text/html;charset=utf-8 - payload: ok - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: webhooks - "/app/hook/deliveries/{delivery_id}/attempts": - post: - summary: Redeliver a delivery for an app webhook - description: |- - Redeliver a delivery for the webhook configured for a GitHub App. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/redeliver-webhook-delivery - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook - parameters: - - *16 - responses: - '202': &39 - description: Accepted - content: - application/json: - schema: - type: object - examples: - default: - value: - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: webhooks - "/app/installation-requests": - get: - summary: List installation requests for the authenticated app - description: Lists all the pending installation requests for the authenticated - GitHub App. - tags: - - apps - operationId: apps/list-installation-requests-for-authenticated-app - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app - parameters: - - *17 - - &19 - name: page - description: The page number of the results to fetch. For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 1 - responses: - '200': - description: List of integration installation requests - content: - application/json: - schema: - type: array - items: - title: Integration Installation Request - description: Request to install an integration on a target - type: object - properties: - id: - description: Unique identifier of the request installation. - type: integer - example: 42 - node_id: - type: string - example: MDExOkludGVncmF0aW9uMQ== - account: - anyOf: - - *4 - - *18 - requester: *4 - created_at: - type: string - format: date-time - example: '2022-07-08T16:18:44-04:00' - required: - - id - - account - - requester - - created_at - examples: - exampleKey1: - value: - - id: 25381 - node_id: MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA== - account: - login: octo-org - id: 6811672 - node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= - avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 - gravatar_id: '' - url: https://api.github.com/users/octo-org - html_url: https://github.com/octo-org - followers_url: https://api.github.com/users/octo-org/followers - following_url: https://api.github.com/users/octo-org/following{/other_user} - gists_url: https://api.github.com/users/octo-org/gists{/gist_id} - starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octo-org/subscriptions - organizations_url: https://api.github.com/users/octo-org/orgs - repos_url: https://api.github.com/users/octo-org/repos - events_url: https://api.github.com/users/octo-org/events{/privacy} - received_events_url: https://api.github.com/users/octo-org/received_events - type: Organization - site_admin: false - requester: - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2022-07-08T16:18:44-04:00' - '304': &37 - description: Not modified - '401': &25 - description: Requires authentication - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: apps - "/app/installations": - get: - summary: List installations for the authenticated app - description: |- - The permissions the installation has are included under the `permissions` key. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/list-installations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app - parameters: - - *17 - - *19 - - &92 - name: since - description: 'Only show results that were last updated after the given time. - This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - format: date-time - - name: outdated - in: query - required: false - schema: - type: string - responses: - '200': - description: The permissions the installation has are included under the - `permissions` key. - content: - application/json: - schema: - type: array - items: &22 - title: Installation - description: Installation - type: object - properties: - id: - description: The ID of the installation. - type: integer - example: 1 - account: - nullable: true - anyOf: - - *4 - - *18 - repository_selection: - description: Describe whether all repositories have been selected - or there's a selection involved - type: string - enum: - - all - - selected - access_tokens_url: - type: string - format: uri - example: https://api.github.com/app/installations/1/access_tokens - repositories_url: - type: string - format: uri - example: https://api.github.com/installation/repositories - html_url: - type: string - format: uri - example: https://github.com/organizations/github/settings/installations/1 - app_id: - type: integer - example: 1 - client_id: - type: string - example: Iv1.ab1112223334445c - target_id: - description: The ID of the user or organization this token is - being scoped to. - type: integer - target_type: - type: string - example: Organization - permissions: &24 - title: App Permissions - type: object - description: The permissions granted to the user access token. - properties: - actions: - type: string - description: The level of permission to grant the access - token for GitHub Actions workflows, workflow runs, and - artifacts. - enum: - - read - - write - administration: - type: string - description: The level of permission to grant the access - token for repository creation, deletion, settings, teams, - and collaborators creation. - enum: - - read - - write - artifact_metadata: - type: string - description: The level of permission to grant the access - token to create and retrieve build artifact metadata records. - enum: - - read - - write - attestations: - type: string - description: The level of permission to create and retrieve - the access token for repository attestations. - enum: - - read - - write - checks: - type: string - description: The level of permission to grant the access - token for checks on code. - enum: - - read - - write - codespaces: - type: string - description: The level of permission to grant the access - token to create, edit, delete, and list Codespaces. - enum: - - read - - write - contents: - type: string - description: The level of permission to grant the access - token for repository contents, commits, branches, downloads, - releases, and merges. - enum: - - read - - write - dependabot_secrets: - type: string - description: The level of permission to grant the access - token to manage Dependabot secrets. - enum: - - read - - write - deployments: - type: string - description: The level of permission to grant the access - token for deployments and deployment statuses. - enum: - - read - - write - discussions: - type: string - description: The level of permission to grant the access - token for discussions and related comments and labels. - enum: - - read - - write - environments: - type: string - description: The level of permission to grant the access - token for managing repository environments. - enum: - - read - - write - issues: - type: string - description: The level of permission to grant the access - token for issues and related comments, assignees, labels, - and milestones. - enum: - - read - - write - merge_queues: - type: string - description: The level of permission to grant the access - token to manage the merge queues for a repository. - enum: - - read - - write - metadata: - type: string - description: The level of permission to grant the access - token to search repositories, list collaborators, and - access repository metadata. - enum: - - read - - write - packages: - type: string - description: The level of permission to grant the access - token for packages published to GitHub Packages. - enum: - - read - - write - pages: - type: string - description: The level of permission to grant the access - token to retrieve Pages statuses, configuration, and builds, - as well as create new builds. - enum: - - read - - write - pull_requests: - type: string - description: The level of permission to grant the access - token for pull requests and related comments, assignees, - labels, milestones, and merges. - enum: - - read - - write - repository_custom_properties: - type: string - description: The level of permission to grant the access - token to view and edit custom properties for a repository, - when allowed by the property. - enum: - - read - - write - repository_hooks: - type: string - description: The level of permission to grant the access - token to manage the post-receive hooks for a repository. - enum: - - read - - write - repository_projects: - type: string - description: The level of permission to grant the access - token to manage repository projects, columns, and cards. - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - description: The level of permission to grant the access - token to view and manage secret scanning alerts. - enum: - - read - - write - secrets: - type: string - description: The level of permission to grant the access - token to manage repository secrets. - enum: - - read - - write - security_events: - type: string - description: The level of permission to grant the access - token to view and manage security events like code scanning - alerts. - enum: - - read - - write - single_file: - type: string - description: The level of permission to grant the access - token to manage just a single file. - enum: - - read - - write - statuses: - type: string - description: The level of permission to grant the access - token for commit statuses. - enum: - - read - - write - vulnerability_alerts: - type: string - description: The level of permission to grant the access - token to manage Dependabot alerts. - enum: - - read - - write - workflows: - type: string - description: The level of permission to grant the access - token to update GitHub Actions workflow files. - enum: - - write - custom_properties_for_organizations: - type: string - description: The level of permission to grant the access - token to view and edit custom properties for an organization, - when allowed by the property. - enum: - - read - - write - members: - type: string - description: The level of permission to grant the access - token for organization teams and members. - enum: - - read - - write - organization_administration: - type: string - description: The level of permission to grant the access - token to manage access to an organization. - enum: - - read - - write - organization_custom_roles: - type: string - description: The level of permission to grant the access - token for custom repository roles management. - enum: - - read - - write - organization_custom_org_roles: - type: string - description: The level of permission to grant the access - token for custom organization roles management. - enum: - - read - - write - organization_custom_properties: - type: string - description: The level of permission to grant the access - token for repository custom properties management at the - organization level. - enum: - - read - - write - - admin - organization_copilot_seat_management: - type: string - description: The level of permission to grant the access - token for managing access to GitHub Copilot for members - of an organization with a Copilot Business subscription. - This property is in public preview and is subject to change. - enum: - - write - organization_copilot_agent_settings: - type: string - description: The level of permission to grant the access - token to view and manage Copilot coding agent settings - for an organization. - enum: - - read - - write - organization_announcement_banners: - type: string - description: The level of permission to grant the access - token to view and manage announcement banners for an organization. - enum: - - read - - write - organization_events: - type: string - description: The level of permission to grant the access - token to view events triggered by an activity in an organization. - enum: - - read - organization_hooks: - type: string - description: The level of permission to grant the access - token to manage the post-receive hooks for an organization. - enum: - - read - - write - organization_personal_access_tokens: - type: string - description: The level of permission to grant the access - token for viewing and managing fine-grained personal access - token requests to an organization. - enum: - - read - - write - organization_personal_access_token_requests: - type: string - description: The level of permission to grant the access - token for viewing and managing fine-grained personal access - tokens that have been approved by an organization. - enum: - - read - - write - organization_plan: - type: string - description: The level of permission to grant the access - token for viewing an organization's plan. - enum: - - read - organization_projects: - type: string - description: The level of permission to grant the access - token to manage organization projects and projects public - preview (where available). - enum: - - read - - write - - admin - organization_packages: - type: string - description: The level of permission to grant the access - token for organization packages published to GitHub Packages. - enum: - - read - - write - organization_secrets: - type: string - description: The level of permission to grant the access - token to manage organization secrets. - enum: - - read - - write - organization_self_hosted_runners: - type: string - description: The level of permission to grant the access - token to view and manage GitHub Actions self-hosted runners - available to an organization. - enum: - - read - - write - organization_user_blocking: - type: string - description: The level of permission to grant the access - token to view and manage users blocked by the organization. - enum: - - read - - write - email_addresses: - type: string - description: The level of permission to grant the access - token to manage the email addresses belonging to a user. - enum: - - read - - write - followers: - type: string - description: The level of permission to grant the access - token to manage the followers belonging to a user. - enum: - - read - - write - git_ssh_keys: - type: string - description: The level of permission to grant the access - token to manage git SSH keys. - enum: - - read - - write - gpg_keys: - type: string - description: The level of permission to grant the access - token to view and manage GPG keys belonging to a user. - enum: - - read - - write - interaction_limits: - type: string - description: The level of permission to grant the access - token to view and manage interaction limits on a repository. - enum: - - read - - write - profile: - type: string - description: The level of permission to grant the access - token to manage the profile settings belonging to a user. - enum: - - write - starring: - type: string - description: The level of permission to grant the access - token to list and manage repositories a user is starring. - enum: - - read - - write - enterprise_custom_properties_for_organizations: - type: string - description: The level of permission to grant the access - token for organization custom properties management at - the enterprise level. - enum: - - read - - write - - admin - example: - contents: read - issues: read - deployments: write - single_file: read - events: - type: array - items: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - single_file_name: - type: string - example: config.yaml - nullable: true - has_multiple_single_files: - type: boolean - example: true - single_file_paths: - type: array - items: - type: string - example: - - config.yml - - ".github/issue_TEMPLATE.md" - app_slug: - type: string - example: github-actions - suspended_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - suspended_at: - type: string - format: date-time - nullable: true - contact_email: - type: string - example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' - nullable: true - required: - - id - - app_id - - app_slug - - target_id - - target_type - - single_file_name - - repository_selection - - access_tokens_url - - html_url - - repositories_url - - events - - account - - permissions - - created_at - - updated_at - - suspended_by - - suspended_at - examples: - default: - value: - - id: 1 - account: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - single_file_name: config.yaml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - repository_selection: selected - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - app_slug: github-actions - suspended_at: - suspended_by: - headers: - Link: &67 - example: ; rel="next", ; - rel="last" - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: apps - "/app/installations/{installation_id}": - get: - summary: Get an installation for the authenticated app - description: |- - Enables an authenticated GitHub App to find an installation's information using the installation id. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app - parameters: - - &23 - name: installation_id - description: The unique identifier of the installation. - in: path - required: true - schema: - type: integer - examples: - default: - value: 1 - responses: - '200': - description: Response - content: - application/json: - schema: *22 - examples: - default: - value: - id: 1 - account: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - single_file_name: config.yaml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - repository_selection: selected - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - app_slug: github-actions - suspended_at: - suspended_by: - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: apps - delete: - summary: Delete an installation for the authenticated app - description: |- - Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/delete-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app - parameters: - - *23 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - x-github-breaking-changes: - - changeset: change_delete_installation_success_status - patch: - responses: - '202': - description: Response - '204': - version: '2026-03-10' - "/app/installations/{installation_id}/access_tokens": - post: - summary: Create an installation access token for an app - description: |- - Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. - - Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. - - Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/create-installation-access-token - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app - parameters: - - *23 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - repositories: - description: List of repository names that the token should have - access to - type: array - items: - type: string - example: rails - repository_ids: - description: List of repository IDs that the token should have access - to - example: - - 1 - type: array - items: - type: integer - permissions: *24 - examples: - default: - value: - repositories: - - Hello-World - permissions: - issues: write - contents: read - responses: - '201': - description: Response - content: - application/json: - schema: - title: Installation Token - description: Authentication token for a GitHub App installed on a - user or org. - type: object - properties: - token: - type: string - expires_at: - type: string - permissions: *24 - repository_selection: - type: string - enum: - - all - - selected - repositories: - type: array - items: &79 - title: Repository - description: A repository on GitHub. - type: object - properties: &296 - id: - description: Unique identifier of the repository - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the repository. - type: string - example: Team Environment - full_name: - type: string - example: octocat/Hello-World - license: - title: License Simple - description: License Simple - type: object - properties: &88 - key: - type: string - example: mit - name: - type: string - example: MIT License - url: - type: string - nullable: true - format: uri - example: https://api.github.com/licenses/mit - spdx_id: - type: string - nullable: true - example: MIT - node_id: - type: string - example: MDc6TGljZW5zZW1pdA== - html_url: - type: string - format: uri - required: &89 - - key - - name - - url - - spdx_id - - node_id - nullable: true - forks: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - required: - - admin - - pull - - push - owner: *4 - private: - description: Whether the repository is private or public. - default: false - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: - type: string - format: uri - example: git:git.example.com/octocat/Hello-World - nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: - type: string - format: uri - example: https://github.com - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - description: The size of the repository, in kilobytes. Size - is calculated hourly. When a repository is initially created, - the size is 0. - type: integer - example: 108 - default_branch: - description: The default branch of the repository. - type: string - example: master - open_issues_count: - type: integer - example: 0 - is_template: - description: Whether this repository acts as a template - that can be used to generate new repositories. - default: false - type: boolean - example: true - topics: - type: array - items: - type: string - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - deprecated: true - has_discussions: - description: Whether discussions are enabled. - default: false - type: boolean - example: true - has_pull_requests: - description: Whether pull requests are enabled. - default: true - type: boolean - example: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull - requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - example: all - archived: - description: Whether the repository is archived. - default: false - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, - or internal.' - default: public - type: string - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true - type: boolean - example: true - temp_clone_token: - type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull - requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - default: false - type: boolean - example: false - allow_update_branch: - description: Whether or not a pull request head branch that - is behind its base branch can always be updated even if - it is not required to be up to date before merging. - default: false - type: boolean - example: false - use_squash_pr_title_as_default: - type: boolean - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - default: false - deprecated: true - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true - allow_forking: - description: Whether to allow forking this repo - type: boolean - web_commit_signoff_required: - description: Whether to require contributors to sign off - on web-based commits - default: false - type: boolean - open_issues: - type: integer - watchers: - type: integer - master_branch: - type: string - starred_at: - type: string - example: '"2020-07-09T00:17:42Z"' - anonymous_access_enabled: - type: boolean - description: Whether anonymous git access is enabled for - this repository - code_search_index_status: - type: object - description: The status of the code search index for this - repository - properties: - lexical_search_ok: - type: boolean - lexical_commit_sha: - type: string - required: &297 - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - x-github-breaking-changes: &298 - - changeset: remove_use_squash_pr_title_as_default - patch: - properties: - use_squash_pr_title_as_default: - version: '2026-03-10' - - changeset: deprecate_beta_media_type - patch: - properties: - master_branch: - version: '2026-03-10' - - changeset: remove_has_downloads - patch: - properties: - has_downloads: - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - version: '2026-03-10' - single_file: - type: string - example: README.md - has_multiple_single_files: - type: boolean - example: true - single_file_paths: - type: array - items: - type: string - example: - - config.yml - - ".github/issue_TEMPLATE.md" - required: - - token - - expires_at - examples: - default: - value: - token: ghs_16C7e42F292c6912E7710c838347Ae178B4a - expires_at: '2016-07-11T22:14:10Z' - permissions: - issues: write - contents: read - repository_selection: selected - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - '403': &29 - description: Forbidden - content: - application/json: - schema: *3 - '401': *25 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: apps - "/app/installations/{installation_id}/suspended": - put: - summary: Suspend an app installation - description: |- - Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/suspend-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#suspend-an-app-installation - parameters: - - *23 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - delete: - summary: Unsuspend an app installation - description: |- - Removes a GitHub App installation suspension. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/unsuspend-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation - parameters: - - *23 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - "/applications/{client_id}/grant": - delete: - summary: Delete an app authorization - description: |- - OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - operationId: apps/delete-authorization - tags: - - apps - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization - parameters: - - &26 - name: client_id - in: path - required: true - description: The client ID of the GitHub app. - schema: - type: string - examples: - default: - value: Iv1.8a61f9b3a7aba766 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - access_token: - type: string - description: The OAuth access token used to authenticate to the - GitHub API. - required: - - access_token - examples: - default: - value: - access_token: e72e16c7e42f292c6912e7710c838347ae178b4a - responses: - '204': - description: Response - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: oauth-applications - "/applications/{client_id}/token": - post: - summary: Check a token - description: OAuth applications and GitHub applications with OAuth authorizations - can use this API method for checking OAuth token validity without exceeding - the normal rate limits for failed login attempts. Authentication works differently - with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. - tags: - - apps - operationId: apps/check-token - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/oauth-applications#check-a-token - parameters: - - *26 - requestBody: - required: true - content: - application/json: - schema: - properties: - access_token: - description: The access_token of the OAuth or GitHub application. - type: string - required: - - access_token - type: object - examples: - default: - value: - access_token: e72e16c7e42f292c6912e7710c838347ae178b4a - responses: - '200': - description: Response - content: - application/json: - schema: &27 - title: Authorization - description: The authorization for an OAuth app, GitHub App, or a - Personal Access Token. - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - format: uri - scopes: - description: A list of scopes that this authorization is in. - type: array - items: - type: string - nullable: true - token: - type: string - token_last_eight: - type: string - nullable: true - hashed_token: - type: string - nullable: true - app: - type: object - properties: - client_id: - type: string - name: - type: string - url: - type: string - format: uri - required: - - client_id - - name - - url - note: - type: string - nullable: true - note_url: - type: string - format: uri - nullable: true - updated_at: - type: string - format: date-time - created_at: - type: string - format: date-time - fingerprint: - type: string - nullable: true - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - installation: - title: Scoped Installation - type: object - properties: - permissions: *24 - repository_selection: - description: Describe whether all repositories have been selected - or there's a selection involved - type: string - enum: - - all - - selected - single_file_name: - type: string - example: config.yaml - nullable: true - has_multiple_single_files: - type: boolean - example: true - single_file_paths: - type: array - items: - type: string - example: - - config.yml - - ".github/issue_TEMPLATE.md" - repositories_url: - type: string - format: uri - example: https://api.github.com/users/octocat/repos - account: *4 - required: - - permissions - - repository_selection - - single_file_name - - repositories_url - - account - nullable: true - expires_at: - type: string - format: date-time - nullable: true - required: - - app - - id - - note - - note_url - - scopes - - token - - hashed_token - - token_last_eight - - fingerprint - - url - - created_at - - updated_at - - expires_at - examples: - default: &28 - value: - id: 1 - url: https://api.github.com/authorizations/1 - scopes: - - public_repo - - user - token: ghu_16C7e42F292c6912E7710c838347Ae178B4a - token_last_eight: Ae178B4a - hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 - app: - url: http://my-github-app.com - name: my github app - client_id: Iv1.8a61f9b3a7aba766 - note: optional note - note_url: http://optional/note/url - updated_at: '2011-09-06T20:39:23Z' - created_at: '2011-09-06T17:26:27Z' - fingerprint: jklmnop12345678 - expires_at: '2011-09-08T17:26:27Z' - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: oauth-applications - patch: - summary: Reset a token - description: OAuth applications and GitHub applications with OAuth authorizations - can use this API method to reset a valid OAuth token without end-user involvement. - Applications must save the "token" property in the response because changes - take effect immediately. Invalid tokens will return `404 NOT FOUND`. - tags: - - apps - operationId: apps/reset-token - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/oauth-applications#reset-a-token - parameters: - - *26 - requestBody: - required: true - content: - application/json: - schema: - properties: - access_token: - description: The access_token of the OAuth or GitHub application. - type: string - required: - - access_token - type: object - examples: - default: - value: - access_token: e72e16c7e42f292c6912e7710c838347ae178b4a - responses: - '200': - description: Response - content: - application/json: - schema: *27 - examples: - default: *28 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: oauth-applications - delete: - summary: Delete an app token - description: OAuth or GitHub application owners can revoke a single token for - an OAuth application or a GitHub application with an OAuth authorization. - tags: - - apps - operationId: apps/delete-token - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token - parameters: - - *26 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - access_token: - type: string - description: The OAuth access token used to authenticate to the - GitHub API. - required: - - access_token - examples: - default: - value: - access_token: e72e16c7e42f292c6912e7710c838347ae178b4a - responses: - '204': - description: Response - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: oauth-applications - "/applications/{client_id}/token/scoped": - post: - summary: Create a scoped access token - description: |- - Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - which repositories the token can access and which permissions are granted to the - token. - - Invalid tokens will return `404 NOT FOUND`. - tags: - - apps - operationId: apps/scope-token - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#create-a-scoped-access-token - parameters: - - *26 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - access_token: - type: string - description: The access token used to authenticate to the GitHub - API. - example: e72e16c7e42f292c6912e7710c838347ae178b4a - target: - description: The name of the user or organization to scope the user - access token to. **Required** unless `target_id` is specified. - type: string - example: octocat - target_id: - description: The ID of the user or organization to scope the user - access token to. **Required** unless `target` is specified. - example: 1 - type: integer - repositories: - description: The list of repository names to scope the user access - token to. `repositories` may not be specified if `repository_ids` - is specified. - type: array - items: - type: string - example: rails - repository_ids: - description: The list of repository IDs to scope the user access - token to. `repository_ids` may not be specified if `repositories` - is specified. - example: - - 1 - type: array - items: - type: integer - permissions: *24 - required: - - access_token - examples: - default: - value: - access_token: e72e16c7e42f292c6912e7710c838347ae178b4a - target: octocat - permissions: - metadata: read - issues: write - contents: read - responses: - '200': - description: Response - content: - application/json: - schema: *27 - examples: - default: - value: - id: 1 - url: https://api.github.com/authorizations/1 - scopes: [] - token: ghu_16C7e42F292c6912E7710c838347Ae178B4a - token_last_eight: Ae178B4a - hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 - app: - url: http://my-github-app.com - name: my github app - client_id: Iv1.8a61f9b3a7aba766 - note: optional note - note_url: http://optional/note/url - updated_at: '2011-09-06T20:39:23Z' - created_at: '2011-09-06T17:26:27Z' - fingerprint: jklmnop12345678 - expires_at: '2011-09-08T17:26:27Z' - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - installation: - permissions: - metadata: read - issues: write - contents: read - repository_selection: selected - single_file_name: ".github/workflow.yml" - repositories_url: https://api.github.com/user/repos - account: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - has_multiple_single_files: false - single_file_paths: [] - '401': *25 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - "/apps/{app_slug}": - get: - summary: Get an app - description: |- - > [!NOTE] - > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - tags: - - apps - operationId: apps/get-by-slug - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#get-an-app - parameters: - - name: app_slug - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *5 - examples: - default: *30 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: apps - "/assignments/{assignment_id}": - get: - summary: Get an assignment - description: Gets a GitHub Classroom assignment. Assignment will only be returned - if the current user is an administrator of the GitHub Classroom for the assignment. - tags: - - classroom - operationId: classroom/get-an-assignment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-an-assignment - parameters: - - &31 - name: assignment_id - description: The unique identifier of the classroom assignment. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - title: Classroom Assignment - description: A GitHub Classroom assignment - type: object - properties: - id: - description: Unique identifier of the repository. - type: integer - example: 42 - public_repo: - description: Whether an accepted assignment creates a public repository. - type: boolean - example: true - title: - description: Assignment title. - type: string - example: Intro to Binaries - type: - description: Whether it's a group assignment or individual assignment. - type: string - example: individual - enum: - - individual - - group - invite_link: - description: The link that a student can use to accept the assignment. - type: string - example: https://classroom.github.com/a/Lx7jiUgx - invitations_enabled: - description: Whether the invitation link is enabled. Visiting - an enabled invitation link will accept the assignment. - type: boolean - example: true - slug: - description: Sluggified name of the assignment. - type: string - example: intro-to-binaries - students_are_repo_admins: - description: Whether students are admins on created repository - when a student accepts the assignment. - type: boolean - example: true - feedback_pull_requests_enabled: - description: Whether feedback pull request will be created when - a student accepts the assignment. - type: boolean - example: true - max_teams: - description: The maximum allowable teams for the assignment. - nullable: true - type: integer - example: 0 - max_members: - description: The maximum allowable members per team. - nullable: true - type: integer - example: 0 - editor: - description: The selected editor for the assignment. - type: string - example: codespaces - accepted: - description: The number of students that have accepted the assignment. - type: integer - example: 25 - submitted: - description: The number of students that have submitted the assignment. - type: integer - example: 10 - passing: - description: The number of students that have passed the assignment. - type: integer - example: 10 - language: - description: The programming language used in the assignment. - type: string - example: elixir - deadline: - description: The time at which the assignment is due. - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - starter_code_repository: &32 - title: Simple Classroom Repository - description: A GitHub repository view for Classroom - type: object - properties: - id: - type: integer - example: 1296269 - description: A unique identifier of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique name of the repository. - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: The URL to view the repository on GitHub.com. - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - description: The GraphQL identifier of the repository. - private: - type: boolean - description: Whether the repository is private. - default_branch: - type: string - example: main - description: The default branch for the repository. - required: - - id - - full_name - - html_url - - node_id - - private - - default_branch - classroom: &34 - title: Classroom - description: A GitHub Classroom classroom - type: object - properties: - id: - description: Unique identifier of the classroom. - example: 42 - type: integer - name: - description: The name of the classroom. - type: string - example: Programming Elixir - archived: - description: Whether classroom is archived. - type: boolean - example: false - organization: - title: Organization Simple for Classroom - description: A GitHub organization. - type: object - properties: - id: - type: integer - example: 1 - login: - type: string - example: github - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - html_url: - type: string - format: uri - example: https://github.com/github - name: - type: string - example: Github - Code thigns happen here - nullable: true - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - required: - - id - - login - - node_id - - html_url - - name - - avatar_url - url: - description: The URL of the classroom on GitHub Classroom. - type: string - example: https://classroom.github.com/classrooms/1-programming-elixir - required: - - id - - name - - archived - - organization - - url - required: - - id - - public_repo - - title - - type - - invite_link - - invitations_enabled - - slug - - students_are_repo_admins - - feedback_pull_requests_enabled - - max_teams - - max_members - - editor - - accepted - - submitted - - passing - - language - - deadline - - starter_code_repository - - classroom - examples: - default: - value: - id: 12, - public_repo: false, - title: Intro to Binaries - type: individual - invite_link: https://classroom.github.com/a/Lx7jiUgx - invitations_enabled: true, - slug: intro-to-binaries - students_are_repo_admins: false - feedback_pull_requests_enabled: true - max_teams: 0 - max_members: 0 - editor: codespaces - accepted: 100 - submitted: 40 - passing: 10 - language: ruby - deadline: '2011-01-26T19:06:43Z' - stater_code_repository: - id: 1296269 - full_name: octocat/Hello-World - html_url: https://github.com/octocat/Hello-World - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - private: false - default_branch: main - classroom: - id: 1296269 - name: Programming Elixir - archived: false, - url: https://classroom.github.com/classrooms/1-programming-elixir - '404': *6 - x-github: - enabledForGitHubApps: true - category: classroom - subcategory: classroom - "/assignments/{assignment_id}/accepted_assignments": - get: - summary: List accepted assignments for an assignment - description: Lists any assignment repositories that have been created by students - accepting a GitHub Classroom assignment. Accepted assignments will only be - returned if the current user is an administrator of the GitHub Classroom for - the assignment. - tags: - - classroom - operationId: classroom/list-accepted-assignments-for-an-assignment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment - parameters: - - *31 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Classroom Accepted Assignment - description: A GitHub Classroom accepted assignment - type: object - properties: - id: - description: Unique identifier of the repository. - type: integer - example: 42 - submitted: - description: Whether an accepted assignment has been submitted. - type: boolean - example: true - passing: - description: Whether a submission passed. - type: boolean - example: true - commit_count: - description: Count of student commits. - type: integer - example: 5 - grade: - description: Most recent grade. - type: string - example: 10/10 - students: - type: array - items: - title: Simple Classroom User - description: A GitHub user simplified for Classroom. - type: object - properties: - id: - type: integer - example: 1 - login: - type: string - example: octocat - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - html_url: - type: string - format: uri - example: https://github.com/octocat - required: - - id - - login - - avatar_url - - html_url - repository: *32 - assignment: &36 - title: Simple Classroom Assignment - description: A GitHub Classroom assignment - type: object - properties: - id: - description: Unique identifier of the repository. - type: integer - example: 42 - public_repo: - description: Whether an accepted assignment creates a public - repository. - type: boolean - example: true - title: - description: Assignment title. - type: string - example: Intro to Binaries - type: - description: Whether it's a Group Assignment or Individual - Assignment. - type: string - example: individual - enum: - - individual - - group - invite_link: - description: The link that a student can use to accept the - assignment. - type: string - example: https://classroom.github.com/a/Lx7jiUgx - invitations_enabled: - description: Whether the invitation link is enabled. Visiting - an enabled invitation link will accept the assignment. - type: boolean - example: true - slug: - description: Sluggified name of the assignment. - type: string - example: intro-to-binaries - students_are_repo_admins: - description: Whether students are admins on created repository - on accepted assignment. - type: boolean - example: true - feedback_pull_requests_enabled: - description: Whether feedback pull request will be created - on assignment acceptance. - type: boolean - example: true - max_teams: - description: The maximum allowable teams for the assignment. - nullable: true - type: integer - example: 0 - max_members: - description: The maximum allowable members per team. - nullable: true - type: integer - example: 0 - editor: - description: The selected editor for the assignment. - type: string - example: codespaces - accepted: - description: The number of students that have accepted the - assignment. - type: integer - example: 25 - submitted: - description: The number of students that have submitted - the assignment. - type: integer - example: 10 - passing: - description: The number of students that have passed the - assignment. - type: integer - example: 10 - language: - description: The programming language used in the assignment. - type: string - example: elixir - deadline: - description: The time at which the assignment is due. - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - classroom: &33 - title: Simple Classroom - description: A GitHub Classroom classroom - type: object - properties: - id: - description: Unique identifier of the classroom. - example: 42 - type: integer - name: - description: The name of the classroom. - type: string - example: Programming Elixir - archived: - description: Returns whether classroom is archived or - not. - type: boolean - example: false - url: - description: The url of the classroom on GitHub Classroom. - type: string - example: https://classroom.github.com/classrooms/1-programming-elixir - required: - - id - - name - - archived - - url - required: - - id - - public_repo - - title - - type - - invite_link - - invitations_enabled - - slug - - students_are_repo_admins - - feedback_pull_requests_enabled - - editor - - accepted - - submitted - - passing - - language - - deadline - - classroom - required: - - id - - submitted - - passing - - commit_count - - grade - - students - - repository - - assignment - examples: - default: - value: - id: 12, - submitted: false, - passing: false, - commit_count: 5 - grade: 5/10 - students: - - id: 1 - login: octocat - avatar_url: https://github.com/images/error/octocat_happy.gif - html_url: https://github.com/octocat - repository: - id: 1296269 - full_name: octocat/Hello-World - html_url: https://github.com/octocat/Hello-World - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - private: false - default_branch: main - assignment: - id: 12, - public_repo: false, - title: Intro to Binaries - type: individual - invite_link: https://classroom.github.com/a/Lx7jiUgx - invitations_enabled: true, - slug: intro-to-binaries - students_are_repo_admins: false - feedback_pull_requests_enabled: true - max_teams: 0 - max_members: 0 - editor: codespaces - accepted: 100 - submitted: 40 - passing: 10 - language: ruby - classroom: - id: 1296269 - name: Programming Elixir - archived: false, - url: https://classroom.github.com/classrooms/1-programming-elixir - x-github: - enabledForGitHubApps: true - category: classroom - subcategory: classroom - "/assignments/{assignment_id}/grades": - get: - summary: Get assignment grades - description: Gets grades for a GitHub Classroom assignment. Grades will only - be returned if the current user is an administrator of the GitHub Classroom - for the assignment. - tags: - - classroom - operationId: classroom/get-assignment-grades - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades - parameters: - - *31 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Classroom Assignment Grade - description: Grade for a student or groups GitHub Classroom assignment - type: object - properties: - assignment_name: - description: Name of the assignment - type: string - assignment_url: - description: URL of the assignment - type: string - starter_code_url: - description: URL of the starter code for the assignment - type: string - github_username: - description: GitHub username of the student - type: string - roster_identifier: - description: Roster identifier of the student - type: string - student_repository_name: - description: Name of the student's assignment repository - type: string - student_repository_url: - description: URL of the student's assignment repository - type: string - submission_timestamp: - description: Timestamp of the student's assignment submission - type: string - points_awarded: - description: Number of points awarded to the student - type: integer - points_available: - description: Number of points available for the assignment - type: integer - group_name: - description: If a group assignment, name of the group the student - is in - type: string - required: - - assignment_name - - assignment_url - - starter_code_url - - github_username - - roster_identifier - - student_repository_name - - student_repository_url - - submission_timestamp - - points_awarded - - points_available - examples: - default: - value: - - assignment_name: Introduction to Strings - assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337 - starter_code_url: '' - github_username: octocat - roster_identifier: octocat@github.com - student_repository_name: intro-to-strings-1337-octocat - student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-octocat - submission_timestamp: 2018-11-12 01:02 - points_awarded: 10 - points_available: 15 - group_name: octocat-and-friends - - assignment_name: Introduction to Strings - assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337 - starter_code_url: '' - github_username: monalisa - roster_identifier: monalisa@github.com - student_repository_name: intro-to-strings-1337-monalisa - student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-monalisa - submission_timestamp: 2018-11-12 01:11 - points_awarded: 15 - points_available: 15 - group_name: monalisa-and-friends - '404': *6 - x-github: - enabledForGitHubApps: true - category: classroom - subcategory: classroom - "/classrooms": - get: - summary: List classrooms - description: Lists GitHub Classroom classrooms for the current user. Classrooms - will only be returned if the current user is an administrator of one or more - GitHub Classrooms. - tags: - - classroom - operationId: classroom/list-classrooms - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-classrooms - parameters: - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *33 - examples: - default: - value: - id: 1296269 - name: Programming Elixir - archived: false, - url: https://classroom.github.com/classrooms/1-programming-elixir - x-github: - enabledForGitHubApps: true - category: classroom - subcategory: classroom - "/classrooms/{classroom_id}": - get: - summary: Get a classroom - description: Gets a GitHub Classroom classroom for the current user. Classroom - will only be returned if the current user is an administrator of the GitHub - Classroom. - tags: - - classroom - operationId: classroom/get-a-classroom - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#get-a-classroom - parameters: - - &35 - name: classroom_id - description: The unique identifier of the classroom. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *34 - examples: - default: - value: - id: 1296269 - name: Programming Elixir - archived: false, - organization: - id: 1 - login: programming-elixir - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - html_url: https://github.com/programming-elixir - name: Learn how to build fault tolerant applications - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - url: https://classroom.github.com/classrooms/1-programming-elixir - '404': *6 - x-github: - enabledForGitHubApps: true - category: classroom - subcategory: classroom - "/classrooms/{classroom_id}/assignments": - get: - summary: List assignments for a classroom - description: Lists GitHub Classroom assignments for a classroom. Assignments - will only be returned if the current user is an administrator of the GitHub - Classroom. - tags: - - classroom - operationId: classroom/list-assignments-for-a-classroom - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom - parameters: - - *35 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *36 - examples: - default: - value: - id: 12, - public_repo: false, - title: Intro to Binaries - type: individual - invite_link: https://classroom.github.com/a/Lx7jiUgx - invitations_enabled: true, - slug: intro-to-binaries - students_are_repo_admins: false - feedback_pull_requests_enabled: true - max_teams: 0 - max_members: 0 - editor: codespaces - accepted: 100 - submitted: 40 - passing: 10 - language: ruby - deadline: '2020-01-11T11:59:22Z' - classroom: - id: 1296269 - name: Programming Elixir - archived: false, - url: https://classroom.github.com/classrooms/1-programming-elixir - x-github: - enabledForGitHubApps: true - category: classroom - subcategory: classroom - "/codes_of_conduct": - get: - summary: Get all codes of conduct - description: Returns array of all GitHub's codes of conduct. - tags: - - codes-of-conduct - operationId: codes-of-conduct/get-all-codes-of-conduct - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &38 - title: Code Of Conduct - description: Code Of Conduct - type: object - properties: - key: - type: string - example: contributor_covenant - name: - type: string - example: Contributor Covenant - url: - type: string - format: uri - example: https://api.github.com/codes_of_conduct/contributor_covenant - body: - type: string - example: | - # Contributor Covenant Code of Conduct - - ## Our Pledge - - In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - - ## Our Standards - - Examples of behavior that contributes to creating a positive environment include: - - * Using welcoming and inclusive language - * Being respectful of differing viewpoints and experiences - * Gracefully accepting constructive criticism - * Focusing on what is best for the community - * Showing empathy towards other community members - - Examples of unacceptable behavior by participants include: - - * The use of sexualized language or imagery and unwelcome sexual attention or advances - * Trolling, insulting/derogatory comments, and personal or political attacks - * Public or private harassment - * Publishing others' private information, such as a physical or electronic address, without explicit permission - * Other conduct which could reasonably be considered inappropriate in a professional setting - - ## Our Responsibilities - - Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - to any instances of unacceptable behavior. - - Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - - ## Scope - - This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - - ## Enforcement - - Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - - Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. - - ## Attribution - - This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - html_url: - type: string - format: uri - nullable: true - required: - - url - - html_url - - key - - name - examples: - default: - value: - - key: citizen_code_of_conduct - name: Citizen Code of Conduct - url: https://api.github.com/codes_of_conduct/citizen_code_of_conduct - html_url: http://citizencodeofconduct.org/ - - key: contributor_covenant - name: Contributor Covenant - url: https://api.github.com/codes_of_conduct/contributor_covenant - html_url: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codes-of-conduct - subcategory: codes-of-conduct - "/codes_of_conduct/{key}": - get: - summary: Get a code of conduct - description: Returns information about the specified GitHub code of conduct. - tags: - - codes-of-conduct - operationId: codes-of-conduct/get-conduct-code - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct - parameters: - - name: key - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *38 - examples: - default: - value: - key: contributor_covenant - name: Contributor Covenant - url: https://api.github.com/codes_of_conduct/contributor_covenant - body: | - # Contributor Covenant Code of Conduct - - ## Our Pledge - - In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. - - ## Our Standards - - Examples of behavior that contributes to creating a positive environment include: - - * Using welcoming and inclusive language - * Being respectful of differing viewpoints and experiences - * Gracefully accepting constructive criticism - * Focusing on what is best for the community - * Showing empathy towards other community members - - Examples of unacceptable behavior by participants include: - - * The use of sexualized language or imagery and unwelcome sexual attention or advances - * Trolling, insulting/derogatory comments, and personal or political attacks - * Public or private harassment - * Publishing others' private information, such as a physical or electronic address, without explicit permission - * Other conduct which could reasonably be considered inappropriate in a professional setting - - ## Our Responsibilities - - Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - to any instances of unacceptable behavior. - - Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. - - ## Scope - - This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. - - ## Enforcement - - Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. - - Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. - - ## Attribution - - This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - html_url: http://contributor-covenant.org/version/1/4/ - '404': *6 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codes-of-conduct - subcategory: codes-of-conduct - "/credentials/revoke": - post: - summary: Revoke a list of credentials - description: |- - Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. - - This endpoint currently accepts the following credential types: - - Personal access tokens (classic) (`ghp_`) - - Fine-grained personal access tokens (`github_pat_`) - - OAuth app access tokens (`gho_`) - - User-to-server tokens from GitHub Apps (`ghu_`) - - Refresh tokens from GitHub Apps (`ghr_`) - - - Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. - GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. - - To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. - - > [!NOTE] - > Any authenticated requests will return a 403. - tags: - - credentials - operationId: credentials/revoke - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - credentials: - type: array - description: A list of credentials to be revoked, up to 1000 per - request. - items: - type: string - minItems: 1 - maxItems: 1000 - required: - - credentials - examples: - default: - value: - credentials: - - ghp_1234567890abcdef1234567890abcdef12345678 - - github_pat_0A1B2C3D4E5F6G7H8I9J0K_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456 - - gho_1234567890abcdef1234567890abcdef12345678 - - ghu_1234567890abcdef1234567890abcdef12345678 - - ghr_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab - responses: - '202': *39 - '422': *7 - '500': &55 - description: Internal Error - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: credentials - subcategory: revoke - "/emojis": - get: - summary: Get emojis - description: Lists all the emojis available to use on GitHub. - operationId: emojis/get - tags: - - emojis - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/emojis/emojis#get-emojis - parameters: [] - responses: - '200': - content: - application/json: - schema: - type: object - additionalProperties: - type: string - examples: - default: - value: - "+1": https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8 - "-1": https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8 - '100': https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8 - '1234': https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8 - 1st_place_medal: https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8 - 2nd_place_medal: https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8 - 3rd_place_medal: https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8 - 8ball: https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8 - a: https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8 - ab: https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8 - abacus: https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8 - abc: https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8 - abcd: https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8 - accept: https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8 - accessibility: https://github.githubassets.com/images/icons/emoji/accessibility.png?v8 - accordion: https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8 - adhesive_bandage: https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8 - adult: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8 - aerial_tramway: https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8 - afghanistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8 - airplane: https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8 - aland_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8 - alarm_clock: https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8 - albania: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8 - alembic: https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8 - algeria: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8 - alien: https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8 - ambulance: https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8 - american_samoa: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8 - amphora: https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8 - anatomical_heart: https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8 - anchor: https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8 - andorra: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8 - angel: https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8 - anger: https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8 - angola: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8 - angry: https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8 - anguilla: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8 - anguished: https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8 - ant: https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8 - antarctica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8 - antigua_barbuda: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8 - apple: https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8 - aquarius: https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8 - argentina: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8 - aries: https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8 - armenia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8 - arrow_backward: https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8 - arrow_double_down: https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8 - arrow_double_up: https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8 - arrow_down: https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8 - arrow_down_small: https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8 - arrow_forward: https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8 - arrow_heading_down: https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8 - arrow_heading_up: https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8 - arrow_left: https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8 - arrow_lower_left: https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8 - arrow_lower_right: https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8 - arrow_right: https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8 - arrow_right_hook: https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8 - arrow_up: https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8 - arrow_up_down: https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8 - arrow_up_small: https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8 - arrow_upper_left: https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8 - arrow_upper_right: https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8 - arrows_clockwise: https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8 - arrows_counterclockwise: https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8 - art: https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8 - articulated_lorry: https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8 - artificial_satellite: https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8 - artist: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8 - aruba: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8 - ascension_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8 - asterisk: https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8 - astonished: https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8 - astronaut: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8 - athletic_shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8 - atm: https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8 - atom: https://github.githubassets.com/images/icons/emoji/atom.png?v8 - atom_symbol: https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8 - australia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8 - austria: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8 - auto_rickshaw: https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8 - avocado: https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8 - axe: https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8 - azerbaijan: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8 - b: https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8 - baby: https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8 - baby_bottle: https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8 - baby_chick: https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8 - baby_symbol: https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8 - back: https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8 - bacon: https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8 - badger: https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8 - badminton: https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8 - bagel: https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8 - baggage_claim: https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8 - baguette_bread: https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8 - bahamas: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8 - bahrain: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8 - balance_scale: https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8 - bald_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8 - bald_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8 - ballet_shoes: https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8 - balloon: https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8 - ballot_box: https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8 - ballot_box_with_check: https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8 - bamboo: https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8 - banana: https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8 - bangbang: https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8 - bangladesh: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8 - banjo: https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8 - bank: https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8 - bar_chart: https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8 - barbados: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8 - barber: https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8 - baseball: https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8 - basecamp: https://github.githubassets.com/images/icons/emoji/basecamp.png?v8 - basecampy: https://github.githubassets.com/images/icons/emoji/basecampy.png?v8 - basket: https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8 - basketball: https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8 - basketball_man: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8 - basketball_woman: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8 - bat: https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8 - bath: https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8 - bathtub: https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8 - battery: https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8 - beach_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8 - bear: https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8 - bearded_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8 - beaver: https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8 - bed: https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8 - bee: https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8 - beer: https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8 - beers: https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8 - beetle: https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8 - beginner: https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8 - belarus: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8 - belgium: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8 - belize: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8 - bell: https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8 - bell_pepper: https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8 - bellhop_bell: https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8 - benin: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8 - bento: https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8 - bermuda: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8 - beverage_box: https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8 - bhutan: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8 - bicyclist: https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8 - bike: https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8 - biking_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8 - biking_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8 - bikini: https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8 - billed_cap: https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8 - biohazard: https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8 - bird: https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8 - birthday: https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8 - bison: https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8 - black_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8 - black_circle: https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8 - black_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8 - black_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8 - black_joker: https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8 - black_large_square: https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8 - black_medium_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8 - black_medium_square: https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8 - black_nib: https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8 - black_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8 - black_square_button: https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8 - blond_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8 - blond_haired_person: https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8 - blond_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8 - blonde_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8 - blossom: https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8 - blowfish: https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8 - blue_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8 - blue_car: https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8 - blue_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8 - blue_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8 - blueberries: https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8 - blush: https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8 - boar: https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8 - boat: https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8 - bolivia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8 - bomb: https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8 - bone: https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8 - book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8 - bookmark: https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8 - bookmark_tabs: https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8 - books: https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8 - boom: https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8 - boomerang: https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8 - boot: https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8 - bosnia_herzegovina: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8 - botswana: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8 - bouncing_ball_man: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8 - bouncing_ball_person: https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8 - bouncing_ball_woman: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8 - bouquet: https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8 - bouvet_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8 - bow: https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8 - bow_and_arrow: https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8 - bowing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8 - bowing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8 - bowl_with_spoon: https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8 - bowling: https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8 - bowtie: https://github.githubassets.com/images/icons/emoji/bowtie.png?v8 - boxing_glove: https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8 - boy: https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8 - brain: https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8 - brazil: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8 - bread: https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8 - breast_feeding: https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8 - bricks: https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8 - bride_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8 - bridge_at_night: https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8 - briefcase: https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8 - british_indian_ocean_territory: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8 - british_virgin_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8 - broccoli: https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8 - broken_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8 - broom: https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8 - brown_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8 - brown_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8 - brown_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8 - brunei: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8 - bubble_tea: https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8 - bucket: https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8 - bug: https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8 - building_construction: https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8 - bulb: https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8 - bulgaria: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8 - bullettrain_front: https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8 - bullettrain_side: https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8 - burkina_faso: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8 - burrito: https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8 - burundi: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8 - bus: https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8 - business_suit_levitating: https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8 - busstop: https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8 - bust_in_silhouette: https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8 - busts_in_silhouette: https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8 - butter: https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8 - butterfly: https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8 - cactus: https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8 - cake: https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8 - calendar: https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8 - call_me_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8 - calling: https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8 - cambodia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8 - camel: https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8 - camera: https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8 - camera_flash: https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8 - cameroon: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8 - camping: https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8 - canada: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8 - canary_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8 - cancer: https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8 - candle: https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8 - candy: https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8 - canned_food: https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8 - canoe: https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8 - cape_verde: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8 - capital_abcd: https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8 - capricorn: https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8 - car: https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8 - card_file_box: https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8 - card_index: https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8 - card_index_dividers: https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8 - caribbean_netherlands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8 - carousel_horse: https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8 - carpentry_saw: https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8 - carrot: https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8 - cartwheeling: https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8 - cat: https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8 - cat2: https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8 - cayman_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8 - cd: https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8 - central_african_republic: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8 - ceuta_melilla: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8 - chad: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8 - chains: https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8 - chair: https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8 - champagne: https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8 - chart: https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8 - chart_with_downwards_trend: https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8 - chart_with_upwards_trend: https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8 - checkered_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8 - cheese: https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8 - cherries: https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8 - cherry_blossom: https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8 - chess_pawn: https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8 - chestnut: https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8 - chicken: https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8 - child: https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8 - children_crossing: https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8 - chile: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8 - chipmunk: https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8 - chocolate_bar: https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8 - chopsticks: https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8 - christmas_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8 - christmas_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8 - church: https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8 - cinema: https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8 - circus_tent: https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8 - city_sunrise: https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8 - city_sunset: https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8 - cityscape: https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8 - cl: https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8 - clamp: https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8 - clap: https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8 - clapper: https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8 - classical_building: https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8 - climbing: https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8 - climbing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8 - climbing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8 - clinking_glasses: https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8 - clipboard: https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8 - clipperton_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8 - clock1: https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8 - clock10: https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8 - clock1030: https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8 - clock11: https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8 - clock1130: https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8 - clock12: https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8 - clock1230: https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8 - clock130: https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8 - clock2: https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8 - clock230: https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8 - clock3: https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8 - clock330: https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8 - clock4: https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8 - clock430: https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8 - clock5: https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8 - clock530: https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8 - clock6: https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8 - clock630: https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8 - clock7: https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8 - clock730: https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8 - clock8: https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8 - clock830: https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8 - clock9: https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8 - clock930: https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8 - closed_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8 - closed_lock_with_key: https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8 - closed_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8 - cloud: https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8 - cloud_with_lightning: https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8 - cloud_with_lightning_and_rain: https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8 - cloud_with_rain: https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8 - cloud_with_snow: https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8 - clown_face: https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8 - clubs: https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8 - cn: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8 - coat: https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8 - cockroach: https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8 - cocktail: https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8 - coconut: https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8 - cocos_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8 - coffee: https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8 - coffin: https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8 - coin: https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8 - cold_face: https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8 - cold_sweat: https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8 - collision: https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8 - colombia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8 - comet: https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8 - comoros: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8 - compass: https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8 - computer: https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8 - computer_mouse: https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8 - confetti_ball: https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8 - confounded: https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8 - confused: https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8 - congo_brazzaville: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8 - congo_kinshasa: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8 - congratulations: https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8 - construction: https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8 - construction_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8 - construction_worker_man: https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8 - construction_worker_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8 - control_knobs: https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8 - convenience_store: https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8 - cook: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8 - cook_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8 - cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 - cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 - cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 - copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 - copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 - corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 - costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 - cote_divoire: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8 - couch_and_lamp: https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8 - couple: https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8 - couple_with_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8 - couple_with_heart_man_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8 - couple_with_heart_woman_man: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8 - couple_with_heart_woman_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8 - couplekiss: https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8 - couplekiss_man_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8 - couplekiss_man_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8 - couplekiss_woman_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8 - cow: https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8 - cow2: https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8 - cowboy_hat_face: https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8 - crab: https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8 - crayon: https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8 - credit_card: https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8 - crescent_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8 - cricket: https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8 - cricket_game: https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8 - croatia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8 - crocodile: https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8 - croissant: https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8 - crossed_fingers: https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8 - crossed_flags: https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8 - crossed_swords: https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8 - crown: https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8 - cry: https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8 - crying_cat_face: https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8 - crystal_ball: https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8 - cuba: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8 - cucumber: https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8 - cup_with_straw: https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8 - cupcake: https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8 - cupid: https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8 - curacao: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8 - curling_stone: https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8 - curly_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8 - curly_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8 - curly_loop: https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8 - currency_exchange: https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8 - curry: https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8 - cursing_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8 - custard: https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8 - customs: https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8 - cut_of_meat: https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8 - cyclone: https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8 - cyprus: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8 - czech_republic: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8 - dagger: https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8 - dancer: https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8 - dancers: https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8 - dancing_men: https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8 - dancing_women: https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8 - dango: https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8 - dark_sunglasses: https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8 - dart: https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8 - dash: https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8 - date: https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8 - de: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8 - deaf_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8 - deaf_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8 - deaf_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8 - deciduous_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8 - deer: https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8 - denmark: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8 - department_store: https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8 - dependabot: https://github.githubassets.com/images/icons/emoji/dependabot.png?v8 - derelict_house: https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8 - desert: https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8 - desert_island: https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8 - desktop_computer: https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8 - detective: https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8 - diamond_shape_with_a_dot_inside: https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8 - diamonds: https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8 - diego_garcia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8 - disappointed: https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8 - disappointed_relieved: https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8 - disguised_face: https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8 - diving_mask: https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8 - diya_lamp: https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8 - dizzy: https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8 - dizzy_face: https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8 - djibouti: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8 - dna: https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8 - do_not_litter: https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8 - dodo: https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8 - dog: https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8 - dog2: https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8 - dollar: https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8 - dolls: https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8 - dolphin: https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8 - dominica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8 - dominican_republic: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8 - door: https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8 - doughnut: https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8 - dove: https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8 - dragon: https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8 - dragon_face: https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8 - dress: https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8 - dromedary_camel: https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8 - drooling_face: https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8 - drop_of_blood: https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8 - droplet: https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8 - drum: https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8 - duck: https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8 - dumpling: https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8 - dvd: https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8 - e-mail: https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8 - eagle: https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8 - ear: https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8 - ear_of_rice: https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8 - ear_with_hearing_aid: https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8 - earth_africa: https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8 - earth_americas: https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8 - earth_asia: https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8 - ecuador: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8 - egg: https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8 - eggplant: https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8 - egypt: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8 - eight: https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8 - eight_pointed_black_star: https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8 - eight_spoked_asterisk: https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8 - eject_button: https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8 - el_salvador: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8 - electric_plug: https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8 - electron: https://github.githubassets.com/images/icons/emoji/electron.png?v8 - elephant: https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8 - elevator: https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8 - elf: https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8 - elf_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8 - elf_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8 - email: https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8 - end: https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8 - england: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8 - envelope: https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8 - envelope_with_arrow: https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8 - equatorial_guinea: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8 - eritrea: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8 - es: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8 - estonia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8 - ethiopia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8 - eu: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8 - euro: https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8 - european_castle: https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8 - european_post_office: https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8 - european_union: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8 - evergreen_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8 - exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8 - exploding_head: https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8 - expressionless: https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8 - eye: https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8 - eye_speech_bubble: https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8 - eyeglasses: https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8 - eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8 - face_exhaling: https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8 - face_in_clouds: https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8 - face_with_head_bandage: https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8 - face_with_spiral_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8 - face_with_thermometer: https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8 - facepalm: https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8 - facepunch: https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 - factory: https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8 - factory_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8 - fairy: https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8 - fairy_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8 - fairy_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8 - falafel: https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8 - falkland_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8 - fallen_leaf: https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8 - family: https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8 - family_man_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8 - family_man_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8 - family_man_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8 - family_man_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8 - family_man_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8 - family_man_man_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8 - family_man_man_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8 - family_man_man_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8 - family_man_man_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8 - family_man_man_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8 - family_man_woman_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8 - family_man_woman_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8 - family_man_woman_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8 - family_man_woman_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8 - family_man_woman_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8 - family_woman_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8 - family_woman_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8 - family_woman_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8 - family_woman_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8 - family_woman_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8 - family_woman_woman_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8 - family_woman_woman_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8 - family_woman_woman_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8 - family_woman_woman_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8 - family_woman_woman_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8 - farmer: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8 - faroe_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8 - fast_forward: https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8 - fax: https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8 - fearful: https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8 - feather: https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8 - feelsgood: https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8 - feet: https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8 - female_detective: https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8 - female_sign: https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8 - ferris_wheel: https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8 - ferry: https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8 - field_hockey: https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8 - fiji: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8 - file_cabinet: https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8 - file_folder: https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8 - film_projector: https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8 - film_strip: https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8 - finland: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8 - finnadie: https://github.githubassets.com/images/icons/emoji/finnadie.png?v8 - fire: https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8 - fire_engine: https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8 - fire_extinguisher: https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8 - firecracker: https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8 - firefighter: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8 - fireworks: https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8 - first_quarter_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8 - first_quarter_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8 - fish: https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8 - fish_cake: https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8 - fishsticks: https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8 - fishing_pole_and_fish: https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8 - fist: https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8 - fist_left: https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8 - fist_oncoming: https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 - fist_raised: https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8 - fist_right: https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8 - five: https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8 - flags: https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8 - flamingo: https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8 - flashlight: https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8 - flat_shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8 - flatbread: https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8 - fleur_de_lis: https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8 - flight_arrival: https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8 - flight_departure: https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8 - flipper: https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8 - floppy_disk: https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8 - flower_playing_cards: https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8 - flushed: https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8 - fly: https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8 - flying_disc: https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8 - flying_saucer: https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8 - fog: https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8 - foggy: https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8 - fondue: https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8 - foot: https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8 - football: https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8 - footprints: https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8 - fork_and_knife: https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8 - fortune_cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8 - fountain: https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8 - fountain_pen: https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8 - four: https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8 - four_leaf_clover: https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8 - fox_face: https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8 - fr: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8 - framed_picture: https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8 - free: https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8 - french_guiana: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8 - french_polynesia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8 - french_southern_territories: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8 - fried_egg: https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8 - fried_shrimp: https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8 - fries: https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8 - frog: https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8 - frowning: https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8 - frowning_face: https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8 - frowning_man: https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8 - frowning_person: https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8 - frowning_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8 - fu: https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8 - fuelpump: https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8 - full_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8 - full_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8 - funeral_urn: https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8 - gabon: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8 - gambia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8 - game_die: https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8 - garlic: https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8 - gb: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8 - gear: https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8 - gem: https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8 - gemini: https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8 - genie: https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8 - genie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8 - genie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8 - georgia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8 - ghana: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8 - ghost: https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8 - gibraltar: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8 - gift: https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8 - gift_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8 - giraffe: https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8 - girl: https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8 - globe_with_meridians: https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8 - gloves: https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8 - goal_net: https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8 - goat: https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8 - goberserk: https://github.githubassets.com/images/icons/emoji/goberserk.png?v8 - godmode: https://github.githubassets.com/images/icons/emoji/godmode.png?v8 - goggles: https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8 - golf: https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8 - golfing: https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8 - golfing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8 - golfing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8 - gorilla: https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8 - grapes: https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8 - greece: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8 - green_apple: https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8 - green_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8 - green_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8 - green_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8 - green_salad: https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8 - green_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8 - greenland: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8 - grenada: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8 - grey_exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8 - grey_question: https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8 - grimacing: https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8 - grin: https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8 - grinning: https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8 - guadeloupe: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8 - guam: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8 - guard: https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8 - guardsman: https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8 - guardswoman: https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8 - guatemala: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8 - guernsey: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8 - guide_dog: https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8 - guinea: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8 - guinea_bissau: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8 - guitar: https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8 - gun: https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8 - guyana: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8 - haircut: https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8 - haircut_man: https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8 - haircut_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8 - haiti: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8 - hamburger: https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8 - hammer: https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8 - hammer_and_pick: https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8 - hammer_and_wrench: https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8 - hamster: https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8 - hand: https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8 - hand_over_mouth: https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8 - handbag: https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8 - handball_person: https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8 - handshake: https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8 - hankey: https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8 - hash: https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8 - hatched_chick: https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8 - hatching_chick: https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8 - headphones: https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8 - headstone: https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8 - health_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8 - hear_no_evil: https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8 - heard_mcdonald_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8 - heart: https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8 - heart_decoration: https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8 - heart_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8 - heart_eyes_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8 - heart_on_fire: https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8 - heartbeat: https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8 - heartpulse: https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8 - hearts: https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8 - heavy_check_mark: https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8 - heavy_division_sign: https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8 - heavy_dollar_sign: https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8 - heavy_exclamation_mark: https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8 - heavy_heart_exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8 - heavy_minus_sign: https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8 - heavy_multiplication_x: https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8 - heavy_plus_sign: https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8 - hedgehog: https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8 - helicopter: https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8 - herb: https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8 - hibiscus: https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8 - high_brightness: https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8 - high_heel: https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8 - hiking_boot: https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8 - hindu_temple: https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8 - hippopotamus: https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8 - hocho: https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8 - hole: https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8 - honduras: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8 - honey_pot: https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8 - honeybee: https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8 - hong_kong: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8 - hook: https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8 - horse: https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8 - horse_racing: https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8 - hospital: https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8 - hot_face: https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8 - hot_pepper: https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8 - hotdog: https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8 - hotel: https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8 - hotsprings: https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8 - hourglass: https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8 - hourglass_flowing_sand: https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8 - house: https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8 - house_with_garden: https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8 - houses: https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8 - hugs: https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8 - hungary: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8 - hurtrealbad: https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8 - hushed: https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8 - hut: https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8 - ice_cream: https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8 - ice_cube: https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8 - ice_hockey: https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8 - ice_skate: https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8 - icecream: https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8 - iceland: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8 - id: https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8 - ideograph_advantage: https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8 - imp: https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8 - inbox_tray: https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8 - incoming_envelope: https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8 - india: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8 - indonesia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8 - infinity: https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8 - information_desk_person: https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8 - information_source: https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8 - innocent: https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8 - interrobang: https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8 - iphone: https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8 - iran: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8 - iraq: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8 - ireland: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8 - isle_of_man: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8 - israel: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8 - it: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8 - izakaya_lantern: https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8 - jack_o_lantern: https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8 - jamaica: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8 - japan: https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8 - japanese_castle: https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8 - japanese_goblin: https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8 - japanese_ogre: https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8 - jeans: https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8 - jersey: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8 - jigsaw: https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8 - jordan: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8 - joy: https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8 - joy_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8 - joystick: https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8 - jp: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8 - judge: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8 - juggling_person: https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8 - kangaroo: https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8 - kazakhstan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8 - kenya: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8 - key: https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8 - keyboard: https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8 - keycap_ten: https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8 - kick_scooter: https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8 - kimono: https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8 - kiribati: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8 - kiss: https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8 - kissing: https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8 - kissing_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8 - kissing_closed_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8 - kissing_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8 - kissing_smiling_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8 - kite: https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8 - kiwi_fruit: https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8 - kneeling_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8 - kneeling_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8 - kneeling_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8 - knife: https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8 - knot: https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8 - koala: https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8 - koko: https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8 - kosovo: https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8 - kr: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8 - kuwait: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8 - kyrgyzstan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8 - lab_coat: https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8 - label: https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8 - lacrosse: https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8 - ladder: https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8 - lady_beetle: https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8 - lantern: https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8 - laos: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8 - large_blue_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8 - large_blue_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8 - large_orange_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8 - last_quarter_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8 - last_quarter_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8 - latin_cross: https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8 - latvia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8 - laughing: https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8 - leafy_green: https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8 - leaves: https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8 - lebanon: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8 - ledger: https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8 - left_luggage: https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8 - left_right_arrow: https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8 - left_speech_bubble: https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8 - leftwards_arrow_with_hook: https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8 - leg: https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8 - lemon: https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8 - leo: https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8 - leopard: https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8 - lesotho: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8 - level_slider: https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8 - liberia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8 - libra: https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8 - libya: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8 - liechtenstein: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8 - light_rail: https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8 - link: https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8 - lion: https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8 - lips: https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8 - lipstick: https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8 - lithuania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8 - lizard: https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8 - llama: https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8 - lobster: https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8 - lock: https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8 - lock_with_ink_pen: https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8 - lollipop: https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8 - long_drum: https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8 - loop: https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8 - lotion_bottle: https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8 - lotus_position: https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8 - lotus_position_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8 - lotus_position_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8 - loud_sound: https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8 - loudspeaker: https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8 - love_hotel: https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8 - love_letter: https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8 - love_you_gesture: https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8 - low_brightness: https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8 - luggage: https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8 - lungs: https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8 - luxembourg: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8 - lying_face: https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8 - m: https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8 - macau: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8 - macedonia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8 - madagascar: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8 - mag: https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8 - mag_right: https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8 - mage: https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8 - mage_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8 - mage_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8 - magic_wand: https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8 - magnet: https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8 - mahjong: https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8 - mailbox: https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8 - mailbox_closed: https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8 - mailbox_with_mail: https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8 - mailbox_with_no_mail: https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8 - malawi: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8 - malaysia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8 - maldives: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8 - male_detective: https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8 - male_sign: https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8 - mali: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8 - malta: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8 - mammoth: https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8 - man: https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8 - man_artist: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8 - man_astronaut: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8 - man_beard: https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8 - man_cartwheeling: https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8 - man_cook: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8 - man_dancing: https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8 - man_facepalming: https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8 - man_factory_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8 - man_farmer: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8 - man_feeding_baby: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8 - man_firefighter: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8 - man_health_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8 - man_in_manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8 - man_in_motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8 - man_in_tuxedo: https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8 - man_judge: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8 - man_juggling: https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8 - man_mechanic: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8 - man_office_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8 - man_pilot: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8 - man_playing_handball: https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8 - man_playing_water_polo: https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8 - man_scientist: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8 - man_shrugging: https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8 - man_singer: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8 - man_student: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8 - man_teacher: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8 - man_technologist: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8 - man_with_gua_pi_mao: https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8 - man_with_probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8 - man_with_turban: https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8 - man_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8 - mandarin: https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 - mango: https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8 - mans_shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8 - mantelpiece_clock: https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8 - manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8 - maple_leaf: https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8 - marshall_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8 - martial_arts_uniform: https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8 - martinique: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8 - mask: https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8 - massage: https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8 - massage_man: https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8 - massage_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8 - mate: https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8 - mauritania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8 - mauritius: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8 - mayotte: https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8 - meat_on_bone: https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8 - mechanic: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8 - mechanical_arm: https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8 - mechanical_leg: https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8 - medal_military: https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8 - medal_sports: https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8 - medical_symbol: https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8 - mega: https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8 - melon: https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8 - memo: https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8 - men_wrestling: https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8 - mending_heart: https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8 - menorah: https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8 - mens: https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8 - mermaid: https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8 - merman: https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8 - merperson: https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8 - metal: https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8 - metro: https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8 - mexico: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8 - microbe: https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8 - micronesia: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8 - microphone: https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8 - microscope: https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8 - middle_finger: https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8 - military_helmet: https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8 - milk_glass: https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8 - milky_way: https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8 - minibus: https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8 - minidisc: https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8 - mirror: https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8 - mobile_phone_off: https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8 - moldova: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8 - monaco: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8 - money_mouth_face: https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8 - money_with_wings: https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8 - moneybag: https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8 - mongolia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8 - monkey: https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8 - monkey_face: https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8 - monocle_face: https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8 - monorail: https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8 - montenegro: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8 - montserrat: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8 - moon: https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8 - moon_cake: https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8 - morocco: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8 - mortar_board: https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8 - mosque: https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8 - mosquito: https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8 - motor_boat: https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8 - motor_scooter: https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8 - motorcycle: https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8 - motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8 - motorway: https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8 - mount_fuji: https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8 - mountain: https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8 - mountain_bicyclist: https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8 - mountain_biking_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8 - mountain_biking_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8 - mountain_cableway: https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8 - mountain_railway: https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8 - mountain_snow: https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8 - mouse: https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8 - mouse2: https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8 - mouse_trap: https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8 - movie_camera: https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8 - moyai: https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8 - mozambique: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8 - mrs_claus: https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8 - muscle: https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8 - mushroom: https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8 - musical_keyboard: https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8 - musical_note: https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8 - musical_score: https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8 - mute: https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8 - mx_claus: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8 - myanmar: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8 - nail_care: https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8 - name_badge: https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8 - namibia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8 - national_park: https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8 - nauru: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8 - nauseated_face: https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8 - nazar_amulet: https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8 - neckbeard: https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8 - necktie: https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8 - negative_squared_cross_mark: https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8 - nepal: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8 - nerd_face: https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8 - nesting_dolls: https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8 - netherlands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8 - neutral_face: https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8 - new: https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8 - new_caledonia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8 - new_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8 - new_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8 - new_zealand: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8 - newspaper: https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8 - newspaper_roll: https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8 - next_track_button: https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8 - ng: https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8 - ng_man: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8 - ng_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8 - nicaragua: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8 - niger: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8 - nigeria: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8 - night_with_stars: https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8 - nine: https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8 - ninja: https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8 - niue: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8 - no_bell: https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8 - no_bicycles: https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8 - no_entry: https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8 - no_entry_sign: https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8 - no_good: https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8 - no_good_man: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8 - no_good_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8 - no_mobile_phones: https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8 - no_mouth: https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8 - no_pedestrians: https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8 - no_smoking: https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8 - non-potable_water: https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8 - norfolk_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8 - north_korea: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8 - northern_mariana_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8 - norway: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8 - nose: https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8 - notebook: https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8 - notebook_with_decorative_cover: https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8 - notes: https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8 - nut_and_bolt: https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8 - o: https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8 - o2: https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8 - ocean: https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8 - octocat: https://github.githubassets.com/images/icons/emoji/octocat.png?v8 - octopus: https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8 - oden: https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8 - office: https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8 - office_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8 - oil_drum: https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8 - ok: https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8 - ok_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8 - ok_man: https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8 - ok_person: https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8 - ok_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8 - old_key: https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8 - older_adult: https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8 - older_man: https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8 - older_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8 - olive: https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8 - om: https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8 - oman: https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8 - 'on': https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8 - oncoming_automobile: https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8 - oncoming_bus: https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8 - oncoming_police_car: https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8 - oncoming_taxi: https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8 - one: https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8 - one_piece_swimsuit: https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8 - onion: https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8 - open_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8 - open_file_folder: https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8 - open_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8 - open_mouth: https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8 - open_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8 - ophiuchus: https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8 - orange: https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 - orange_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8 - orange_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8 - orange_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8 - orange_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8 - orangutan: https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8 - orthodox_cross: https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8 - otter: https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8 - outbox_tray: https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8 - owl: https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8 - ox: https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8 - oyster: https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8 - package: https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8 - page_facing_up: https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8 - page_with_curl: https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8 - pager: https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8 - paintbrush: https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8 - pakistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8 - palau: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8 - palestinian_territories: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8 - palm_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8 - palms_up_together: https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8 - panama: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8 - pancakes: https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8 - panda_face: https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8 - paperclip: https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8 - paperclips: https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8 - papua_new_guinea: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8 - parachute: https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8 - paraguay: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8 - parasol_on_ground: https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8 - parking: https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8 - parrot: https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8 - part_alternation_mark: https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8 - partly_sunny: https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8 - partying_face: https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8 - passenger_ship: https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8 - passport_control: https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8 - pause_button: https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8 - paw_prints: https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8 - peace_symbol: https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8 - peach: https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8 - peacock: https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8 - peanuts: https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8 - pear: https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8 - pen: https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8 - pencil: https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8 - pencil2: https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8 - penguin: https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8 - pensive: https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8 - people_holding_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8 - people_hugging: https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8 - performing_arts: https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8 - persevere: https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8 - person_bald: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8 - person_curly_hair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8 - person_feeding_baby: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8 - person_fencing: https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8 - person_in_manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8 - person_in_motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8 - person_in_tuxedo: https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8 - person_red_hair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8 - person_white_hair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8 - person_with_probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8 - person_with_turban: https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8 - person_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8 - peru: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8 - petri_dish: https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8 - philippines: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8 - phone: https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8 - pick: https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8 - pickup_truck: https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8 - pie: https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8 - pig: https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8 - pig2: https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8 - pig_nose: https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8 - pill: https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8 - pilot: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8 - pinata: https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8 - pinched_fingers: https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8 - pinching_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8 - pineapple: https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8 - ping_pong: https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8 - pirate_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8 - pisces: https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8 - pitcairn_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8 - pizza: https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8 - placard: https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8 - place_of_worship: https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8 - plate_with_cutlery: https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8 - play_or_pause_button: https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8 - pleading_face: https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8 - plunger: https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8 - point_down: https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8 - point_left: https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8 - point_right: https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8 - point_up: https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8 - point_up_2: https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8 - poland: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8 - polar_bear: https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8 - police_car: https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8 - police_officer: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 - policeman: https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8 - policewoman: https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8 - poodle: https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8 - poop: https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8 - popcorn: https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8 - portugal: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8 - post_office: https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8 - postal_horn: https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8 - postbox: https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8 - potable_water: https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8 - potato: https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8 - potted_plant: https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8 - pouch: https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8 - poultry_leg: https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8 - pound: https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8 - pout: https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8 - pouting_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8 - pouting_face: https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8 - pouting_man: https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8 - pouting_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8 - pray: https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8 - prayer_beads: https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8 - pregnant_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8 - pretzel: https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8 - previous_track_button: https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8 - prince: https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8 - princess: https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8 - printer: https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8 - probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8 - puerto_rico: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8 - punch: https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 - purple_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8 - purple_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8 - purple_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8 - purse: https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8 - pushpin: https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8 - put_litter_in_its_place: https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8 - qatar: https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8 - question: https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8 - rabbit: https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8 - rabbit2: https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8 - raccoon: https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8 - racehorse: https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8 - racing_car: https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8 - radio: https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8 - radio_button: https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8 - radioactive: https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8 - rage: https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8 - rage1: https://github.githubassets.com/images/icons/emoji/rage1.png?v8 - rage2: https://github.githubassets.com/images/icons/emoji/rage2.png?v8 - rage3: https://github.githubassets.com/images/icons/emoji/rage3.png?v8 - rage4: https://github.githubassets.com/images/icons/emoji/rage4.png?v8 - railway_car: https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8 - railway_track: https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8 - rainbow: https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8 - rainbow_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8 - raised_back_of_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8 - raised_eyebrow: https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8 - raised_hand: https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8 - raised_hand_with_fingers_splayed: https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8 - raised_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8 - raising_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8 - raising_hand_man: https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8 - raising_hand_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8 - ram: https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8 - ramen: https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8 - rat: https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8 - razor: https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8 - receipt: https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8 - record_button: https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8 - recycle: https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8 - red_car: https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8 - red_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8 - red_envelope: https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8 - red_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8 - red_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8 - red_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8 - registered: https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8 - relaxed: https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8 - relieved: https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8 - reminder_ribbon: https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8 - repeat: https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8 - repeat_one: https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8 - rescue_worker_helmet: https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8 - restroom: https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8 - reunion: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8 - revolving_hearts: https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8 - rewind: https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8 - rhinoceros: https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8 - ribbon: https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8 - rice: https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8 - rice_ball: https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8 - rice_cracker: https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8 - rice_scene: https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8 - right_anger_bubble: https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8 - ring: https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8 - ringed_planet: https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8 - robot: https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8 - rock: https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8 - rocket: https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8 - rofl: https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8 - roll_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8 - roll_of_paper: https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8 - roller_coaster: https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8 - roller_skate: https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8 - romania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8 - rooster: https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8 - rose: https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8 - rosette: https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8 - rotating_light: https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8 - round_pushpin: https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8 - rowboat: https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8 - rowing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8 - rowing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8 - ru: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8 - rugby_football: https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8 - runner: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8 - running: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8 - running_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8 - running_shirt_with_sash: https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8 - running_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8 - rwanda: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8 - sa: https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8 - safety_pin: https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8 - safety_vest: https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8 - sagittarius: https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8 - sailboat: https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8 - sake: https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8 - salt: https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8 - samoa: https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8 - san_marino: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8 - sandal: https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8 - sandwich: https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8 - santa: https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8 - sao_tome_principe: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8 - sari: https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8 - sassy_man: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8 - sassy_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8 - satellite: https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8 - satisfied: https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8 - saudi_arabia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8 - sauna_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8 - sauna_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8 - sauna_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8 - sauropod: https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8 - saxophone: https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8 - scarf: https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8 - school: https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8 - school_satchel: https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8 - scientist: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8 - scissors: https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8 - scorpion: https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8 - scorpius: https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8 - scotland: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8 - scream: https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8 - scream_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8 - screwdriver: https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8 - scroll: https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8 - seal: https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8 - seat: https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8 - secret: https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8 - see_no_evil: https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8 - seedling: https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8 - selfie: https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8 - senegal: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8 - serbia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8 - service_dog: https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8 - seven: https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8 - sewing_needle: https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8 - seychelles: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8 - shallow_pan_of_food: https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8 - shamrock: https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8 - shark: https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8 - shaved_ice: https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8 - sheep: https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8 - shell: https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8 - shield: https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8 - shinto_shrine: https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8 - ship: https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8 - shipit: https://github.githubassets.com/images/icons/emoji/shipit.png?v8 - shirt: https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8 - shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8 - shopping: https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8 - shopping_cart: https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8 - shorts: https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8 - shower: https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8 - shrimp: https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8 - shrug: https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8 - shushing_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8 - sierra_leone: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8 - signal_strength: https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8 - singapore: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8 - singer: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8 - sint_maarten: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8 - six: https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8 - six_pointed_star: https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8 - skateboard: https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8 - ski: https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8 - skier: https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8 - skull: https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8 - skull_and_crossbones: https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8 - skunk: https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8 - sled: https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8 - sleeping: https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8 - sleeping_bed: https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8 - sleepy: https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8 - slightly_frowning_face: https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8 - slightly_smiling_face: https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8 - slot_machine: https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8 - sloth: https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8 - slovakia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8 - slovenia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8 - small_airplane: https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8 - small_blue_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8 - small_orange_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8 - small_red_triangle: https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8 - small_red_triangle_down: https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8 - smile: https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8 - smile_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8 - smiley: https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8 - smiley_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8 - smiling_face_with_tear: https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8 - smiling_face_with_three_hearts: https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8 - smiling_imp: https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8 - smirk: https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8 - smirk_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8 - smoking: https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8 - snail: https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8 - snake: https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8 - sneezing_face: https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8 - snowboarder: https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8 - snowflake: https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8 - snowman: https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8 - snowman_with_snow: https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8 - soap: https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8 - sob: https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8 - soccer: https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8 - socks: https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8 - softball: https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8 - solomon_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8 - somalia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8 - soon: https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8 - sos: https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8 - sound: https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8 - south_africa: https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8 - south_georgia_south_sandwich_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8 - south_sudan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8 - space_invader: https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8 - spades: https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8 - spaghetti: https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8 - sparkle: https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8 - sparkler: https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8 - sparkles: https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8 - sparkling_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8 - speak_no_evil: https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8 - speaker: https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8 - speaking_head: https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8 - speech_balloon: https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8 - speedboat: https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8 - spider: https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8 - spider_web: https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8 - spiral_calendar: https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8 - spiral_notepad: https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8 - sponge: https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8 - spoon: https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8 - squid: https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8 - sri_lanka: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8 - st_barthelemy: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8 - st_helena: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8 - st_kitts_nevis: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8 - st_lucia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8 - st_martin: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8 - st_pierre_miquelon: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8 - st_vincent_grenadines: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8 - stadium: https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8 - standing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8 - standing_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8 - standing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8 - star: https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8 - star2: https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8 - star_and_crescent: https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8 - star_of_david: https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8 - star_struck: https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8 - stars: https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8 - station: https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8 - statue_of_liberty: https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8 - steam_locomotive: https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8 - stethoscope: https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8 - stew: https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8 - stop_button: https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8 - stop_sign: https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8 - stopwatch: https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8 - straight_ruler: https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8 - strawberry: https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8 - stuck_out_tongue: https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8 - stuck_out_tongue_closed_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8 - stuck_out_tongue_winking_eye: https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8 - student: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8 - studio_microphone: https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8 - stuffed_flatbread: https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8 - sudan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8 - sun_behind_large_cloud: https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8 - sun_behind_rain_cloud: https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8 - sun_behind_small_cloud: https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8 - sun_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8 - sunflower: https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8 - sunglasses: https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8 - sunny: https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8 - sunrise: https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8 - sunrise_over_mountains: https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8 - superhero: https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8 - superhero_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8 - superhero_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8 - supervillain: https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8 - supervillain_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8 - supervillain_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8 - surfer: https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8 - surfing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8 - surfing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8 - suriname: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8 - sushi: https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8 - suspect: https://github.githubassets.com/images/icons/emoji/suspect.png?v8 - suspension_railway: https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8 - svalbard_jan_mayen: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8 - swan: https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8 - swaziland: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8 - sweat: https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8 - sweat_drops: https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8 - sweat_smile: https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8 - sweden: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8 - sweet_potato: https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8 - swim_brief: https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8 - swimmer: https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8 - swimming_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8 - swimming_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8 - switzerland: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8 - symbols: https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8 - synagogue: https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8 - syria: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8 - syringe: https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8 - t-rex: https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8 - taco: https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8 - tada: https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8 - taiwan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8 - tajikistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8 - takeout_box: https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8 - tamale: https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8 - tanabata_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8 - tangerine: https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 - tanzania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8 - taurus: https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8 - taxi: https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8 - tea: https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8 - teacher: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8 - teapot: https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8 - technologist: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8 - teddy_bear: https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8 - telephone: https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8 - telephone_receiver: https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8 - telescope: https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8 - tennis: https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8 - tent: https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8 - test_tube: https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8 - thailand: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8 - thermometer: https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8 - thinking: https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8 - thong_sandal: https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8 - thought_balloon: https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8 - thread: https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8 - three: https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8 - thumbsdown: https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8 - thumbsup: https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8 - ticket: https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8 - tickets: https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8 - tiger: https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8 - tiger2: https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8 - timer_clock: https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8 - timor_leste: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8 - tipping_hand_man: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8 - tipping_hand_person: https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8 - tipping_hand_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8 - tired_face: https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8 - tm: https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8 - togo: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8 - toilet: https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8 - tokelau: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8 - tokyo_tower: https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8 - tomato: https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8 - tonga: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8 - tongue: https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8 - toolbox: https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8 - tooth: https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8 - toothbrush: https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8 - top: https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8 - tophat: https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8 - tornado: https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8 - tr: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8 - trackball: https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8 - tractor: https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8 - traffic_light: https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8 - train: https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8 - train2: https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8 - tram: https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8 - transgender_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8 - transgender_symbol: https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8 - triangular_flag_on_post: https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8 - triangular_ruler: https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8 - trident: https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8 - trinidad_tobago: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8 - tristan_da_cunha: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8 - triumph: https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8 - trolleybus: https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8 - trollface: https://github.githubassets.com/images/icons/emoji/trollface.png?v8 - trophy: https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8 - tropical_drink: https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8 - tropical_fish: https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8 - truck: https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8 - trumpet: https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8 - tshirt: https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8 - tulip: https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8 - tumbler_glass: https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8 - tunisia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8 - turkey: https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8 - turkmenistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8 - turks_caicos_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8 - turtle: https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8 - tuvalu: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8 - tv: https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8 - twisted_rightwards_arrows: https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8 - two: https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8 - two_hearts: https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8 - two_men_holding_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8 - two_women_holding_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8 - u5272: https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8 - u5408: https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8 - u55b6: https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8 - u6307: https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8 - u6708: https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8 - u6709: https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8 - u6e80: https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8 - u7121: https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8 - u7533: https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8 - u7981: https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8 - u7a7a: https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8 - uganda: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8 - uk: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8 - ukraine: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8 - umbrella: https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8 - unamused: https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8 - underage: https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8 - unicorn: https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8 - united_arab_emirates: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8 - united_nations: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8 - unlock: https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8 - up: https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8 - upside_down_face: https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8 - uruguay: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8 - us: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8 - us_outlying_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8 - us_virgin_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8 - uzbekistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8 - v: https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8 - vampire: https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8 - vampire_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8 - vampire_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8 - vanuatu: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8 - vatican_city: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8 - venezuela: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8 - vertical_traffic_light: https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8 - vhs: https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8 - vibration_mode: https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8 - video_camera: https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8 - video_game: https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8 - vietnam: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8 - violin: https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8 - virgo: https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8 - volcano: https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8 - volleyball: https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8 - vomiting_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8 - vs: https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8 - vulcan_salute: https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8 - waffle: https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8 - wales: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8 - walking: https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8 - walking_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8 - walking_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8 - wallis_futuna: https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8 - waning_crescent_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8 - waning_gibbous_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8 - warning: https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8 - wastebasket: https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8 - watch: https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8 - water_buffalo: https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8 - water_polo: https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8 - watermelon: https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8 - wave: https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8 - wavy_dash: https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8 - waxing_crescent_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8 - waxing_gibbous_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8 - wc: https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8 - weary: https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8 - wedding: https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8 - weight_lifting: https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8 - weight_lifting_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8 - weight_lifting_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8 - western_sahara: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8 - whale: https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8 - whale2: https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8 - wheel_of_dharma: https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8 - wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8 - white_check_mark: https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8 - white_circle: https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8 - white_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8 - white_flower: https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8 - white_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8 - white_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8 - white_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8 - white_large_square: https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8 - white_medium_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8 - white_medium_square: https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8 - white_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8 - white_square_button: https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8 - wilted_flower: https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8 - wind_chime: https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8 - wind_face: https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8 - window: https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8 - wine_glass: https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8 - wink: https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8 - wolf: https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8 - woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8 - woman_artist: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8 - woman_astronaut: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8 - woman_beard: https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8 - woman_cartwheeling: https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8 - woman_cook: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8 - woman_dancing: https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8 - woman_facepalming: https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8 - woman_factory_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8 - woman_farmer: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8 - woman_feeding_baby: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8 - woman_firefighter: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8 - woman_health_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8 - woman_in_manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8 - woman_in_motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8 - woman_in_tuxedo: https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8 - woman_judge: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8 - woman_juggling: https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8 - woman_mechanic: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8 - woman_office_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8 - woman_pilot: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8 - woman_playing_handball: https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8 - woman_playing_water_polo: https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8 - woman_scientist: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8 - woman_shrugging: https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8 - woman_singer: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8 - woman_student: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8 - woman_teacher: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8 - woman_technologist: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8 - woman_with_headscarf: https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8 - woman_with_probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8 - woman_with_turban: https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8 - woman_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8 - womans_clothes: https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8 - womans_hat: https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8 - women_wrestling: https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8 - womens: https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8 - wood: https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8 - woozy_face: https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8 - world_map: https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8 - worm: https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8 - worried: https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8 - wrench: https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8 - wrestling: https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8 - writing_hand: https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8 - x: https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8 - yarn: https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8 - yawning_face: https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8 - yellow_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8 - yellow_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8 - yellow_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8 - yemen: https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8 - yen: https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8 - yin_yang: https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8 - yo_yo: https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8 - yum: https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8 - zambia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8 - zany_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8 - zap: https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8 - zebra: https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8 - zero: https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8 - zimbabwe: https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8 - zipper_mouth_face: https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8 - zombie: https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8 - zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 - zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 - zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 - description: Response - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: emojis - subcategory: emojis - "/enterprises/{enterprise}/actions/cache/retention-limit": - get: - summary: Get GitHub Actions cache retention limit for an enterprise - description: |- - Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this - enterprise may not set a higher cache retention limit. - - OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-retention-limit-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise - parameters: - - &40 - name: enterprise - description: The slug version of the enterprise name. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: &41 - title: Actions cache retention limit for an enterprise - description: GitHub Actions cache retention policy for an enterprise. - type: object - properties: - max_cache_retention_days: - description: For repositories & organizations in an enterprise, - the maximum duration, in days, for which caches in a repository - may be retained. - type: integer - example: 14 - examples: - default: &42 - value: - max_cache_retention_days: 80 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - put: - summary: Set GitHub Actions cache retention limit for an enterprise - description: |- - Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this - enterprise may not set a higher cache retention limit. - - OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - actions - operationId: actions/set-actions-cache-retention-limit-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise - parameters: - - *40 - requestBody: - required: true - content: - application/json: - schema: *41 - examples: - selected_actions: *42 - responses: - '204': - description: Response - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/enterprises/{enterprise}/actions/cache/storage-limit": - get: - summary: Get GitHub Actions cache storage limit for an enterprise - description: |- - Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this - enterprise may not set a higher cache storage limit. - - OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-storage-limit-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise - parameters: - - *40 - responses: - '200': - description: Response - content: - application/json: - schema: &43 - title: Actions cache storage limit for an enterprise - description: GitHub Actions cache storage policy for an enterprise. - type: object - properties: - max_cache_size_gb: - description: For repositories & organizations in an enterprise, - the maximum size limit for the sum of all caches in a repository, - in gigabytes. - type: integer - example: 10 - examples: - default: &44 - value: - max_cache_size_gb: 150 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - put: - summary: Set GitHub Actions cache storage limit for an enterprise - description: |- - Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this - enterprise may not set a higher cache storage limit. - - OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - actions - operationId: actions/set-actions-cache-storage-limit-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise - parameters: - - *40 - requestBody: - required: true - content: - application/json: - schema: *43 - examples: - selected_actions: *44 - responses: - '204': - description: Response - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/enterprises/{enterprise}/actions/oidc/customization/properties/repo": - get: - summary: List OIDC custom property inclusions for an enterprise - description: |- - Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - oidc - operationId: oidc/list-oidc-custom-property-inclusions-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise - parameters: - - *40 - responses: - '200': - description: A JSON array of OIDC custom property inclusions - content: - application/json: - schema: - type: array - items: &45 - title: Actions OIDC Custom Property Inclusion - description: An OIDC custom property inclusion for repository properties - type: object - properties: - custom_property_name: - type: string - description: The name of the custom property that is included - in the OIDC token - inclusion_source: - type: string - description: Whether the inclusion was defined at the organization - or enterprise level - enum: - - organization - - enterprise - example: organization - required: - - custom_property_name - - inclusion_source - examples: - default: - value: - - custom_property_name: environment - inclusion_source: enterprise - - custom_property_name: team - inclusion_source: enterprise - '404': *6 - '403': *29 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: oidc - post: - summary: Create an OIDC custom property inclusion for an enterprise - description: |- - Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - oidc - operationId: oidc/create-oidc-custom-property-inclusion-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise - parameters: - - *40 - requestBody: - required: true - content: - application/json: - schema: &142 - title: Actions OIDC Custom Property Inclusion Input - description: Input for creating an OIDC custom property inclusion - type: object - properties: - custom_property_name: - type: string - description: The name of the custom property to include in the OIDC - token - required: - - custom_property_name - examples: - default: &46 - value: - custom_property_name: environment - responses: - '201': - description: OIDC custom property inclusion created - content: - application/json: - schema: *45 - examples: - default: *46 - '400': - description: Invalid input - '403': *29 - '422': - description: Property inclusion already exists - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: oidc - "/enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}": - delete: - summary: Delete an OIDC custom property inclusion for an enterprise - description: |- - Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - oidc - operationId: oidc/delete-oidc-custom-property-inclusion-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise - parameters: - - *40 - - name: custom_property_name - in: path - required: true - schema: - type: string - description: The name of the custom property to remove from OIDC token inclusion - responses: - '204': - description: OIDC custom property inclusion deleted - '400': - description: Invalid input - '403': *29 - '404': - description: Property inclusion not found - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: oidc - "/enterprises/{enterprise}/code-security/configurations": - get: - summary: Get code security configurations for an enterprise - description: |- - Lists all code security configurations available in an enterprise. - - The authenticated user must be an administrator of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-configurations-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise - parameters: - - *40 - - name: per_page - in: query - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - required: false - schema: - type: integer - default: 30 - - *47 - - *48 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &49 - type: object - description: A code security configuration - properties: - id: - type: integer - description: The ID of the code security configuration - name: - type: string - description: The name of the code security configuration. Must - be unique within the organization. - target_type: - type: string - description: The type of the code security configuration. - enum: - - global - - organization - - enterprise - description: - type: string - description: A description of the code security configuration - advanced_security: - type: string - description: The enablement status of GitHub Advanced Security - enum: - - enabled - - disabled - - code_security - - secret_protection - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - dependabot_delegated_alert_dismissal: - type: string - nullable: true - description: The enablement status of Dependabot delegated alert - dismissal - enum: - - enabled - - disabled - - not_set - code_scanning_options: - type: object - description: Feature options for code scanning - nullable: true - properties: - allow_advanced: - nullable: true - type: boolean - description: Whether to allow repos which use advanced setup - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default - setup - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup_options: - type: object - description: Feature options for code scanning default setup - nullable: true - properties: - runner_type: - nullable: true - type: string - enum: - - standard - - labeled - - not_set - description: Whether to use labeled runners or standard - GitHub runners. - runner_label: - nullable: true - type: string - description: The label of the runner to use for code scanning - when runner_type is 'labeled'. - code_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of code scanning delegated - alert dismissal - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass: - type: string - description: The enablement status of secret scanning delegated - bypass - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass_options: - type: object - description: Feature options for secret scanning delegated bypass - properties: - reviewers: - type: array - description: The bypass reviewers for secret scanning delegated - bypass - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected as - a bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - mode: - type: string - description: The bypass mode for the reviewer - enum: - - ALWAYS - - EXEMPT - default: ALWAYS - security_configuration_id: - type: integer - description: The ID of the security configuration - associated with this bypass reviewer - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity - checks - enum: - - enabled - - disabled - - not_set - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non-provider - patterns - enum: - - enabled - - disabled - - not_set - secret_scanning_generic_secrets: - type: string - description: The enablement status of Copilot secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of secret scanning delegated - alert dismissal - enum: - - enabled - - disabled - - not_set - secret_scanning_extended_metadata: - type: string - description: The enablement status of secret scanning extended - metadata - enum: - - enabled - - disabled - - not_set - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability - reporting - enum: - - enabled - - disabled - - not_set - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - url: - type: string - format: uri - description: The URL of the configuration - html_url: - type: string - format: uri - description: The URL of the configuration - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - examples: - default: - value: - - id: 17 - target_type: global - name: GitHub recommended - description: Suggested settings for Dependabot, secret scanning, - and code scanning. - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - code_scanning_default_setup_options: - runner_type: not_set - runner_label: - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_validity_checks: enabled - secret_scanning_non_provider_patterns: enabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17 - html_url: https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view - created_at: '2023-12-04T15:58:07Z' - updated_at: '2023-12-04T15:58:07Z' - - id: 1326 - target_type: enterprise - name: High risk settings - description: This is a code security configuration for octo-enterprise - high risk repositories - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: enabled - code_scanning_default_setup: enabled - code_scanning_default_setup_options: - runner_type: not_set - runner_label: - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326 - html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit - created_at: '2024-05-10T00:00:00Z' - updated_at: '2024-05-10T00:00:00Z' - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: code-security - subcategory: configurations - post: - summary: Create a code security configuration for an enterprise - description: |- - Creates a code security configuration in an enterprise. - - The authenticated user must be an administrator of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/create-configuration-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise - parameters: - - *40 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - name: - type: string - description: The name of the code security configuration. Must be - unique within the enterprise. - description: - type: string - description: A description of the code security configuration - maxLength: 255 - advanced_security: - type: string - description: | - The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. - - > [!WARNING] - > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. - enum: - - enabled - - disabled - - code_security - - secret_protection - default: disabled - code_security: - type: string - description: The enablement status of GitHub Code Security features. - enum: - - enabled - - disabled - - not_set - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - default: enabled - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - default: disabled - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - default: false - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - default: disabled - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - default: disabled - code_scanning_options: &53 - type: object - description: Security Configuration feature options for code scanning - nullable: true - properties: - allow_advanced: - nullable: true - type: boolean - description: Whether to allow repos which use advanced setup - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default setup - enum: - - enabled - - disabled - - not_set - default: disabled - code_scanning_default_setup_options: &52 - type: object - description: Feature options for code scanning default setup - nullable: true - properties: - runner_type: - type: string - enum: - - standard - - labeled - - not_set - description: Whether to use labeled runners or standard GitHub - runners. - runner_label: - nullable: true - type: string - description: The label of the runner to use for code scanning - default setup when runner_type is 'labeled'. - code_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of code scanning delegated alert - dismissal - enum: - - enabled - - disabled - - not_set - default: disabled - secret_protection: - type: string - description: The enablement status of GitHub Secret Protection features. - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity checks - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non provider - patterns - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_generic_secrets: - type: string - description: The enablement status of Copilot secret scanning - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of secret scanning delegated - alert dismissal - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_extended_metadata: - type: string - description: The enablement status of secret scanning extended metadata - enum: - - enabled - - disabled - - not_set - default: disabled - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability reporting - enum: - - enabled - - disabled - - not_set - default: disabled - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - default: enforced - required: - - name - - description - examples: - default: - summary: Example for a code security configuration - value: - name: High rish settings - description: This is a code security configuration for octo-enterprise - advanced_security: enabled - dependabot_alerts: enabled - dependabot_security_updates: not_set - secret_scanning: enabled - responses: - '201': - description: Successfully created code security configuration - content: - application/json: - schema: *49 - examples: - default: &50 - value: - id: 1325 - target_type: enterprise - name: High risk settings - description: This is a code security configuration for octo-enterprise - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: disabled - code_scanning_delegated_alert_dismissal: disabled - secret_scanning: enabled - secret_scanning_push_protection: disabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - secret_scanning_generic_secrets: disabled - secret_scanning_delegated_alert_dismissal: disabled - private_vulnerability_reporting: disabled - enforcement: enforced - url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 - html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: code-security - subcategory: configurations - "/enterprises/{enterprise}/code-security/configurations/defaults": - get: - summary: Get default code security configurations for an enterprise - description: |- - Lists the default code security configurations for an enterprise. - - The authenticated user must be an administrator of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-default-configurations-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise - parameters: - - *40 - responses: - '200': - description: Response - content: - application/json: - schema: &189 - type: array - description: A list of default code security configurations - items: - type: object - properties: - default_for_new_repos: - enum: - - public - - private_and_internal - - all - description: The visibility of newly created repositories for - which the code security configuration will be applied to by - default - configuration: *49 - examples: - default: &190 - value: - - default_for_new_repos: public - configuration: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - code_scanning_default_setup_options: - runner_type: not_set - runner_label: - code_scanning_options: - allow_advanced: false - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: enabled - secret_scanning_non_provider_patterns: enabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - - default_for_new_repos: private_and_internal - configuration: - id: 17 - target_type: global - name: GitHub recommended - description: Suggested settings for Dependabot, secret scanning, - and code scanning. - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - code_scanning_default_setup_options: - runner_type: not_set - runner_label: - code_scanning_options: - allow_advanced: false - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/17 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view - created_at: '2023-12-04T15:58:07Z' - updated_at: '2023-12-04T15:58:07Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": - get: - summary: Retrieve a code security configuration of an enterprise - description: |- - Gets a code security configuration available in an enterprise. - - The authenticated user must be an administrator of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-single-configuration-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise - parameters: - - *40 - - &51 - name: configuration_id - description: The unique identifier of the code security configuration. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *49 - examples: - default: *50 - '304': *37 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: code-security - subcategory: configurations - patch: - summary: Update a custom code security configuration for an enterprise - description: |- - Updates a code security configuration in an enterprise. - - The authenticated user must be an administrator of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/update-enterprise-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise - parameters: - - *40 - - *51 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - name: - type: string - description: The name of the code security configuration. Must be - unique across the enterprise. - description: - type: string - description: A description of the code security configuration - maxLength: 255 - advanced_security: - type: string - description: | - The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. - - > [!WARNING] - > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. - enum: - - enabled - - disabled - - code_security - - secret_protection - code_security: - type: string - description: The enablement status of GitHub Code Security features. - enum: - - enabled - - disabled - - not_set - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default setup - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup_options: *52 - code_scanning_options: *53 - code_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of code scanning delegated alert - dismissal - enum: - - enabled - - disabled - - not_set - default: disabled - secret_protection: - type: string - description: The enablement status of GitHub Secret Protection features. - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity checks - enum: - - enabled - - disabled - - not_set - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non-provider - patterns - enum: - - enabled - - disabled - - not_set - secret_scanning_generic_secrets: - type: string - description: The enablement status of Copilot secret scanning - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of secret scanning delegated - alert dismissal - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_extended_metadata: - type: string - description: The enablement status of secret scanning extended metadata - enum: - - enabled - - disabled - - not_set - default: disabled - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability reporting - enum: - - enabled - - disabled - - not_set - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - examples: - default: - summary: Example for updating a code security configuration - value: - name: octo-enterprise recommended settings v2 - secret_scanning: disabled - code_scanning_default_setup: enabled - responses: - '200': - description: Response - content: - application/json: - schema: *49 - examples: - default: *50 - '304': *37 - '403': *29 - '404': *6 - '409': &54 - description: Conflict - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: code-security - subcategory: configurations - delete: - summary: Delete a code security configuration for an enterprise - description: |- - Deletes a code security configuration from an enterprise. - Repositories attached to the configuration will retain their settings but will no longer be associated with - the configuration. - - The authenticated user must be an administrator for the enterprise to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/delete-configuration-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise - parameters: - - *40 - - *51 - responses: - '204': &191 - description: A header with no content is returned. - '400': *14 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: code-security - subcategory: configurations - "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": - post: - summary: Attach an enterprise configuration to repositories - description: |- - Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. - - If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. - - The authenticated user must be an administrator for the enterprise to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/attach-enterprise-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories - parameters: - - *40 - - *51 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - scope: - type: string - description: The type of repositories to attach the configuration - to. - enum: - - all - - all_without_configurations - required: - - scope - examples: - default: - summary: Example for attaching a configuration to some repositories - value: - scope: all - responses: - '202': *39 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": - put: - summary: Set a code security configuration as a default for an enterprise - description: |- - Sets a code security configuration as a default to be applied to new repositories in your enterprise. - - This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. - - The authenticated user must be an administrator for the enterprise to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/set-configuration-as-default-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise - parameters: - - *40 - - *51 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - default_for_new_repos: - type: string - description: Specify which types of repository this security configuration - should be applied to by default. - enum: - - all - - none - - private_and_internal - - public - examples: - default: - summary: Set this configuration to be enabled by default on all new - repositories. - value: - default_for_new_repos: all - responses: - '200': - description: Default successfully changed. - content: - application/json: - schema: - type: object - properties: - default_for_new_repos: - type: string - description: Specifies which types of repository this security - configuration is applied to by default. - enum: - - all - - none - - private_and_internal - - public - configuration: *49 - examples: - default: - value: - default_for_new_repos: all - configuration: &188 - value: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: disabled - code_scanning_default_setup_options: - runner_type: not_set - runner_label: - code_scanning_options: - allow_advanced: false - code_scanning_delegated_alert_dismissal: disabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: enabled - secret_scanning_delegated_bypass_options: - reviewers: - - security_configuration_id: 1325 - reviewer_id: 5678 - reviewer_type: TEAM - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - secret_scanning_generic_secrets: disabled - secret_scanning_delegated_alert_dismissal: disabled - private_vulnerability_reporting: disabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": - get: - summary: Get repositories associated with an enterprise code security configuration - description: |- - Lists the repositories associated with an enterprise code security configuration in an organization. - - The authenticated user must be an administrator of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-repositories-for-enterprise-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration - parameters: - - *40 - - *51 - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - required: false - schema: - type: integer - default: 30 - - *47 - - *48 - - name: status - description: |- - A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. - - Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` - in: query - required: false - schema: - type: string - default: all - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &192 - type: object - description: Repositories associated with a code security configuration - and attachment status - properties: - status: - type: string - description: The attachment status of the code security configuration - on the repository. - enum: - - attached - - attaching - - detached - - removed - - enforced - - failed - - updating - - removed_by_enterprise - repository: &66 - title: Simple Repository - description: A GitHub repository. - type: object - properties: &119 - id: - type: integer - format: int64 - example: 1296269 - description: A unique identifier of the repository. - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - description: The GraphQL identifier of the repository. - name: - type: string - example: Hello-World - description: The name of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique, name of the repository. - owner: *4 - private: - type: boolean - description: Whether the repository is private. - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: The URL to view the repository on GitHub.com. - description: - type: string - example: This your first repo! - nullable: true - description: The repository description. - fork: - type: boolean - description: Whether the repository is a fork. - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - description: The URL to get more information about the repository - from the GitHub API. - archive_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - description: A template for the API URL to download the - repository as an archive. - assignees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - description: A template for the API URL to list the available - assignees for issues in the repository. - blobs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - description: A template for the API URL to create or retrieve - a raw Git blob in the repository. - branches_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - description: A template for the API URL to get information - about branches in the repository. - collaborators_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - description: A template for the API URL to get information - about collaborators of the repository. - comments_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/comments{/number} - description: A template for the API URL to get information - about comments on the repository. - commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - description: A template for the API URL to get information - about commits on the repository. - compare_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - description: A template for the API URL to compare two commits - or refs. - contents_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - description: A template for the API URL to get the contents - of the repository. - contributors_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/contributors - description: A template for the API URL to list the contributors - to the repository. - deployments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/deployments - description: The API URL to list the deployments of the - repository. - downloads_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/downloads - description: The API URL to list the downloads on the repository. - events_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/events - description: The API URL to list the events of the repository. - forks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/forks - description: The API URL to list the forks of the repository. - git_commits_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - description: A template for the API URL to get information - about Git commits of the repository. - git_refs_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - description: A template for the API URL to get information - about Git refs of the repository. - git_tags_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - description: A template for the API URL to get information - about Git tags of the repository. - issue_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - description: A template for the API URL to get information - about issue comments on the repository. - issue_events_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - description: A template for the API URL to get information - about issue events on the repository. - issues_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/issues{/number} - description: A template for the API URL to get information - about issues on the repository. - keys_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - description: A template for the API URL to get information - about deploy keys on the repository. - labels_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/labels{/name} - description: A template for the API URL to get information - about labels of the repository. - languages_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/languages - description: The API URL to get information about the languages - of the repository. - merges_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/merges - description: The API URL to merge branches in the repository. - milestones_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - description: A template for the API URL to get information - about milestones of the repository. - notifications_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - description: A template for the API URL to get information - about notifications on the repository. - pulls_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - description: A template for the API URL to get information - about pull requests on the repository. - releases_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/releases{/id} - description: A template for the API URL to get information - about releases on the repository. - stargazers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/stargazers - description: The API URL to list the stargazers on the repository. - statuses_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - description: A template for the API URL to get information - about statuses of a commit. - subscribers_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscribers - description: The API URL to list the subscribers on the - repository. - subscription_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/subscription - description: The API URL to subscribe to notifications for - this repository. - tags_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/tags - description: The API URL to get information about tags on - the repository. - teams_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/teams - description: The API URL to list the teams on the repository. - trees_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - description: A template for the API URL to create or retrieve - a raw Git tree of the repository. - hooks_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks - description: The API URL to list the hooks on the repository. - required: &120 - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - examples: - default: - summary: Example of code security configuration repositories - value: - - status: attached - repository: &193 - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: code-security - subcategory: configurations - "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day": - get: - summary: Get Copilot enterprise usage metrics for a specific day - description: |- - Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. - - The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. - - The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. - - Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-enterprise-one-day-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day - parameters: - - *40 - - &56 - name: day - description: The day to request data for, in `YYYY-MM-DD` format. - in: query - required: true - schema: - type: string - format: date - example: '2025-10-13' - responses: - '200': - description: Response - content: - application/json: - schema: &57 - type: object - title: Copilot Metrics 1 Day Report - description: Links to download the Copilot usage metrics report for - an enterprise/organization for a specific day. - properties: - download_links: - type: array - items: - type: string - format: uri - description: The URLs to download the Copilot usage metrics report - for the enterprise/organization for the specified day. - report_day: - type: string - format: date - description: The day of the report in `YYYY-MM-DD` format. - required: - - download_links - - report_day - examples: - default: &58 - value: - download_links: - - https://example.com/copilot-usage-report-1.json - - https://example.com/copilot-usage-report-2.json - report_day: '2025-07-01' - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest": - get: - summary: Get Copilot enterprise usage metrics - description: |- - Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. - - The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. - - The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. - - Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-enterprise-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics - parameters: - - *40 - responses: - '200': - description: Response - content: - application/json: - schema: &59 - type: object - title: Copilot Metrics 28 Day Report - description: Links to download the latest Copilot usage metrics report - for an enterprise/organization. - properties: - download_links: - type: array - items: - type: string - format: uri - description: The URLs to download the latest Copilot usage metrics - report for the enterprise/organization. - report_start_day: - type: string - format: date - description: The start date of the report period in `YYYY-MM-DD` - format. - report_end_day: - type: string - format: date - description: The end date of the report period in `YYYY-MM-DD` - format. - required: - - download_links - - report_start_day - - report_end_day - examples: - default: &60 - value: - download_links: - - https://example.com/copilot-usage-report-1.json - - https://example.com/copilot-usage-report-2.json - report_start_day: '2025-07-01' - report_end_day: '2025-07-28' - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": - get: - summary: Get Copilot users usage metrics for a specific day - description: |- - Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. - - The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. - - Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. - - Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-users-one-day-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day - parameters: - - *40 - - *56 - responses: - '200': - description: Response - content: - application/json: - schema: *57 - examples: - default: *58 - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": - get: - summary: Get Copilot users usage metrics - description: |- - Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. - - The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. - - Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. - - Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-users-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics - parameters: - - *40 - responses: - '200': - description: Response - content: - application/json: - schema: *59 - examples: - default: *60 - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/enterprises/{enterprise}/dependabot/alerts": - get: - summary: List Dependabot alerts for an enterprise - description: |- - Lists Dependabot alerts for repositories that are owned by the specified enterprise. - - The authenticated user must be a member of the enterprise to use this endpoint. - - Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/list-alerts-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise - parameters: - - *40 - - &199 - name: classification - in: query - description: |- - A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned. - - Can be: `malware`, `general` - schema: - type: string - - &200 - name: state - in: query - description: |- - A comma-separated list of states. If specified, only alerts with these states will be returned. - - Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - schema: - type: string - - &201 - name: severity - in: query - description: |- - A comma-separated list of severities. If specified, only alerts with these severities will be returned. - - Can be: `low`, `medium`, `high`, `critical` - schema: - type: string - - &202 - name: ecosystem - in: query - description: |- - A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - - Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - schema: - type: string - - &203 - name: package - in: query - description: A comma-separated list of package names. If specified, only alerts - for these packages will be returned. - schema: - type: string - - &204 - name: epss_percentage - in: query - description: |- - CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - - An exact number (`n`) - - Comparators such as `>n`, `=n`, `<=n` - - A range like `n..n`, where `n` is a number from 0.0 to 1.0 - - Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. - schema: - type: string - - &497 - name: has - in: query - description: |- - Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. - Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. - schema: - oneOf: - - type: string - - type: array - items: - type: string - enum: - - patch - - &205 - name: assignee - in: query - description: |- - Filter alerts by assignees. - Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. - Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. - schema: - type: string - - &206 - name: scope - in: query - description: The scope of the vulnerable dependency. If specified, only alerts - with this scope will be returned. - schema: - type: string - enum: - - development - - runtime - - &207 - name: sort - in: query - description: |- - The property by which to sort the results. - `created` means when the alert was created. - `updated` means when the alert's state last changed. - `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. - schema: - type: string - enum: - - created - - updated - - epss_percentage - default: created - - *61 - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &208 - type: object - description: A Dependabot alert. - properties: - number: &178 - type: integer - description: The security alert number. - readOnly: true - state: - type: string - description: The state of the Dependabot alert. - readOnly: true - enum: - - auto_dismissed - - dismissed - - fixed - - open - dependency: - type: object - description: Details for the vulnerable dependency. - readOnly: true - properties: - package: &62 - type: object - description: Details for the vulnerable package. - readOnly: true - properties: - ecosystem: - type: string - description: The package's language or package management - ecosystem. - readOnly: true - name: - type: string - description: The unique package name within its ecosystem. - readOnly: true - required: - - ecosystem - - name - additionalProperties: false - manifest_path: - type: string - description: The full path to the dependency manifest file, - relative to the root of the repository. - readOnly: true - scope: - type: string - description: The execution scope of the vulnerable dependency. - readOnly: true - nullable: true - enum: - - development - - runtime - relationship: - type: string - description: | - The vulnerable dependency's relationship to your project. - - > [!NOTE] - > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. - readOnly: true - nullable: true - enum: - - unknown - - direct - - transitive - - inconclusive - security_advisory: &498 - type: object - description: Details for the GitHub Security Advisory. - readOnly: true - properties: - ghsa_id: - type: string - description: The unique GitHub Security Advisory ID assigned - to the advisory. - readOnly: true - cve_id: - type: string - description: The unique CVE ID assigned to the advisory. - readOnly: true - nullable: true - summary: - type: string - description: A short, plain text summary of the advisory. - readOnly: true - maxLength: 1024 - description: - type: string - description: A long-form Markdown-supported description - of the advisory. - readOnly: true - vulnerabilities: - type: array - description: Vulnerable version range information for the - advisory. - readOnly: true - items: &65 - type: object - description: Details pertaining to one vulnerable version - range for the advisory. - readOnly: true - properties: - package: *62 - severity: - type: string - description: The severity of the vulnerability. - readOnly: true - enum: - - low - - medium - - high - - critical - vulnerable_version_range: - type: string - description: Conditions that identify vulnerable versions - of this vulnerability's package. - readOnly: true - first_patched_version: - type: object - description: Details pertaining to the package version - that patches this vulnerability. - readOnly: true - nullable: true - properties: - identifier: - type: string - description: The package version that patches - this vulnerability. - readOnly: true - required: - - identifier - additionalProperties: false - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - additionalProperties: false - severity: - type: string - description: The severity of the advisory. - readOnly: true - enum: - - low - - medium - - high - - critical - classification: - type: string - description: The classification of the advisory. - readOnly: true - enum: - - general - - malware - cvss: - type: object - description: Details for the advisory pertaining to the - Common Vulnerability Scoring System. - readOnly: true - properties: - score: - type: number - description: The overall CVSS score of the advisory. - minimum: 0 - maximum: 10 - readOnly: true - vector_string: - type: string - description: The full CVSS vector string for the advisory. - readOnly: true - nullable: true - required: - - score - - vector_string - additionalProperties: false - cvss_severities: *63 - epss: *64 - cwes: - type: array - description: Details for the advisory pertaining to Common - Weakness Enumeration. - readOnly: true - items: - type: object - description: A CWE weakness assigned to the advisory. - readOnly: true - properties: - cwe_id: - type: string - description: The unique CWE ID. - readOnly: true - name: - type: string - description: The short, plain text name of the CWE. - readOnly: true - required: - - cwe_id - - name - additionalProperties: false - identifiers: - type: array - description: Values that identify this advisory among security - information sources. - readOnly: true - items: - type: object - description: An advisory identifier. - readOnly: true - properties: - type: - type: string - description: The type of advisory identifier. - readOnly: true - enum: - - CVE - - GHSA - value: - type: string - description: The value of the advisory identifer. - readOnly: true - required: - - value - - type - additionalProperties: false - references: - type: array - description: Links to additional advisory information. - readOnly: true - items: - type: object - description: A link to additional advisory information. - readOnly: true - properties: - url: - type: string - description: The URL of the reference. - format: uri - readOnly: true - required: - - url - additionalProperties: false - published_at: - type: string - description: 'The time that the advisory was published in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - updated_at: - type: string - description: 'The time that the advisory was last modified - in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - withdrawn_at: - type: string - description: 'The time that the advisory was withdrawn in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - required: - - ghsa_id - - cve_id - - summary - - description - - vulnerabilities - - severity - - cvss - - cwes - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - additionalProperties: false - x-github-breaking-changes: - - changeset: deprecate_cvss - patch: - properties: - cvss: - required: - - ghsa_id - - cve_id - - summary - - description - - vulnerabilities - - severity - - cwes - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - version: '2026-03-10' - security_vulnerability: *65 - url: &181 - type: string - description: The REST API URL of the alert resource. - format: uri - readOnly: true - html_url: &182 - type: string - description: The GitHub URL of the alert resource. - format: uri - readOnly: true - created_at: &179 - type: string - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - updated_at: &180 - type: string - description: 'The time that the alert was last updated in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - dismissed_at: &184 - type: string - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - dismissed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - dismissed_reason: - type: string - description: The reason that the alert was dismissed. - nullable: true - enum: - - fix_started - - inaccurate - - no_bandwidth - - not_used - - tolerable_risk - dismissed_comment: - type: string - description: An optional comment associated with the alert's - dismissal. - nullable: true - maxLength: 280 - fixed_at: &183 - type: string - description: 'The time that the alert was no longer detected - and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - auto_dismissed_at: &499 - type: string - description: 'The time that the alert was auto-dismissed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - dismissal_request: &500 - title: Dependabot alert dismissal request - description: Information about an active dismissal request for - this Dependabot alert. - type: object - nullable: true - properties: - id: - type: integer - description: The unique identifier of the dismissal request. - status: - type: string - description: The current status of the dismissal request. - enum: - - pending - - approved - - rejected - - cancelled - requester: - type: object - description: The user who requested the dismissal. - properties: - id: - type: integer - description: The unique identifier of the user. - login: - type: string - description: The login name of the user. - created_at: - type: string - format: date-time - description: The date and time when the dismissal request - was created. - url: - type: string - format: uri - description: The API URL to get more information about this - dismissal request. - assignees: - type: array - description: The users assigned to this alert. - readOnly: true - items: *4 - repository: *66 - required: - - number - - state - - dependency - - security_advisory - - security_vulnerability - - url - - html_url - - created_at - - updated_at - - dismissed_at - - dismissed_by - - dismissed_reason - - dismissed_comment - - fixed_at - - repository - additionalProperties: false - examples: - default: &209 - value: - - number: 2 - state: dismissed - dependency: - package: - ecosystem: pip - name: django - manifest_path: path/to/requirements.txt - scope: runtime - security_advisory: - ghsa_id: GHSA-rf4j-j272-fj86 - cve_id: CVE-2018-6188 - summary: Django allows remote attackers to obtain potentially - sensitive information by leveraging data exposure from the - confirm_login_allowed() method, as demonstrated by discovering - whether a user account is inactive - description: django.contrib.auth.forms.AuthenticationForm in - Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote - attackers to obtain potentially sensitive information by leveraging - data exposure from the confirm_login_allowed() method, as - demonstrated by discovering whether a user account is inactive. - vulnerabilities: - - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 2.0.0, < 2.0.2" - first_patched_version: - identifier: 2.0.2 - - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 1.11.8, < 1.11.10" - first_patched_version: - identifier: 1.11.10 - severity: high - cvss: - vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N - score: 7.5 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N - score: 7.5 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N - score: 8.7 - epss: - percentage: 0.00045 - percentile: 0.16001e0 - cwes: - - cwe_id: CWE-200 - name: Exposure of Sensitive Information to an Unauthorized - Actor - identifiers: - - type: GHSA - value: GHSA-rf4j-j272-fj86 - - type: CVE - value: CVE-2018-6188 - references: - - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 - - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 - - url: https://usn.ubuntu.com/3559-1/ - - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ - - url: http://www.securitytracker.com/id/1040422 - published_at: '2018-10-03T21:13:54Z' - updated_at: '2022-04-26T18:35:37Z' - withdrawn_at: - security_vulnerability: - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 2.0.0, < 2.0.2" - first_patched_version: - identifier: 2.0.2 - url: https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2 - html_url: https://github.com/octo-org/octo-repo/security/dependabot/2 - created_at: '2022-06-15T07:43:03Z' - updated_at: '2022-08-23T14:29:47Z' - dismissed_at: '2022-08-23T14:29:47Z' - dismissed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_reason: tolerable_risk - dismissed_comment: This alert is accurate but we use a sanitizer. - fixed_at: - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 217723378 - node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= - name: octo-repo - full_name: octo-org/octo-repo - owner: - login: octo-org - id: 6811672 - node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= - avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 - gravatar_id: '' - url: https://api.github.com/users/octo-org - html_url: https://github.com/octo-org - followers_url: https://api.github.com/users/octo-org/followers - following_url: https://api.github.com/users/octo-org/following{/other_user} - gists_url: https://api.github.com/users/octo-org/gists{/gist_id} - starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octo-org/subscriptions - organizations_url: https://api.github.com/users/octo-org/orgs - repos_url: https://api.github.com/users/octo-org/repos - events_url: https://api.github.com/users/octo-org/events{/privacy} - received_events_url: https://api.github.com/users/octo-org/received_events - type: Organization - site_admin: false - private: true - html_url: https://github.com/octo-org/octo-repo - description: - fork: false - url: https://api.github.com/repos/octo-org/octo-repo - archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} - commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} - compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors - deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments - downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads - events_url: https://api.github.com/repos/octo-org/octo-repo/events - forks_url: https://api.github.com/repos/octo-org/octo-repo/forks - git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} - hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks - issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} - keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} - languages_url: https://api.github.com/repos/octo-org/octo-repo/languages - merges_url: https://api.github.com/repos/octo-org/octo-repo/merges - milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} - releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers - statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers - subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription - tags_url: https://api.github.com/repos/octo-org/octo-repo/tags - teams_url: https://api.github.com/repos/octo-org/octo-repo/teams - trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} - - number: 1 - state: open - dependency: - package: - ecosystem: pip - name: ansible - manifest_path: path/to/requirements.txt - scope: runtime - security_advisory: - ghsa_id: GHSA-8f4m-hccc-8qph - cve_id: CVE-2021-20191 - summary: Insertion of Sensitive Information into Log File in - ansible - description: A flaw was found in ansible. Credentials, such - as secrets, are being disclosed in console log by default - and not protected by no_log feature when using those modules. - An attacker can take advantage of this information to steal - those credentials. The highest threat from this vulnerability - is to data confidentiality. - vulnerabilities: - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: ">= 2.9.0, < 2.9.18" - first_patched_version: - identifier: 2.9.18 - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: "< 2.8.19" - first_patched_version: - identifier: 2.8.19 - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: ">= 2.10.0, < 2.10.7" - first_patched_version: - identifier: 2.10.7 - severity: medium - cvss: - vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N - score: 5.5 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N - score: 5.5 - cvss_v4: - vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 8.5 - cwes: - - cwe_id: CWE-532 - name: Insertion of Sensitive Information into Log File - identifiers: - - type: GHSA - value: GHSA-8f4m-hccc-8qph - - type: CVE - value: CVE-2021-20191 - references: - - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 - - url: https://access.redhat.com/security/cve/cve-2021-20191 - - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 - published_at: '2021-06-01T17:38:00Z' - updated_at: '2021-08-12T23:06:00Z' - withdrawn_at: - security_vulnerability: - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: "< 2.8.19" - first_patched_version: - identifier: 2.8.19 - url: https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1 - html_url: https://github.com/octo-org/hello-world/security/dependabot/1 - created_at: '2022-06-14T15:21:52Z' - updated_at: '2022-06-14T15:21:52Z' - dismissed_at: - dismissed_by: - dismissed_reason: - dismissed_comment: - fixed_at: - assignees: [] - repository: - id: 664700648 - node_id: MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg= - name: hello-world - full_name: octo-org/hello-world - owner: - login: octo-org - id: 6811672 - node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= - avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 - gravatar_id: '' - url: https://api.github.com/users/octo-org - html_url: https://github.com/octo-org - followers_url: https://api.github.com/users/octo-org/followers - following_url: https://api.github.com/users/octo-org/following{/other_user} - gists_url: https://api.github.com/users/octo-org/gists{/gist_id} - starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octo-org/subscriptions - organizations_url: https://api.github.com/users/octo-org/orgs - repos_url: https://api.github.com/users/octo-org/repos - events_url: https://api.github.com/users/octo-org/events{/privacy} - received_events_url: https://api.github.com/users/octo-org/received_events - type: Organization - site_admin: false - private: true - html_url: https://github.com/octo-org/hello-world - description: - fork: false - url: https://api.github.com/repos/octo-org/hello-world - archive_url: https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octo-org/hello-world/assignees{/user} - blobs_url: https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha} - branches_url: https://api.github.com/repos/octo-org/hello-world/branches{/branch} - collaborators_url: https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octo-org/hello-world/comments{/number} - commits_url: https://api.github.com/repos/octo-org/hello-world/commits{/sha} - compare_url: https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head} - contents_url: https://api.github.com/repos/octo-org/hello-world/contents/{+path} - contributors_url: https://api.github.com/repos/octo-org/hello-world/contributors - deployments_url: https://api.github.com/repos/octo-org/hello-world/deployments - downloads_url: https://api.github.com/repos/octo-org/hello-world/downloads - events_url: https://api.github.com/repos/octo-org/hello-world/events - forks_url: https://api.github.com/repos/octo-org/hello-world/forks - git_commits_url: https://api.github.com/repos/octo-org/hello-world/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octo-org/hello-world/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octo-org/hello-world/git/tags{/sha} - hooks_url: https://api.github.com/repos/octo-org/hello-world/hooks - issue_comment_url: https://api.github.com/repos/octo-org/hello-world/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octo-org/hello-world/issues/events{/number} - issues_url: https://api.github.com/repos/octo-org/hello-world/issues{/number} - keys_url: https://api.github.com/repos/octo-org/hello-world/keys{/key_id} - labels_url: https://api.github.com/repos/octo-org/hello-world/labels{/name} - languages_url: https://api.github.com/repos/octo-org/hello-world/languages - merges_url: https://api.github.com/repos/octo-org/hello-world/merges - milestones_url: https://api.github.com/repos/octo-org/hello-world/milestones{/number} - notifications_url: https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octo-org/hello-world/pulls{/number} - releases_url: https://api.github.com/repos/octo-org/hello-world/releases{/id} - stargazers_url: https://api.github.com/repos/octo-org/hello-world/stargazers - statuses_url: https://api.github.com/repos/octo-org/hello-world/statuses/{sha} - subscribers_url: https://api.github.com/repos/octo-org/hello-world/subscribers - subscription_url: https://api.github.com/repos/octo-org/hello-world/subscription - tags_url: https://api.github.com/repos/octo-org/hello-world/tags - teams_url: https://api.github.com/repos/octo-org/hello-world/teams - trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} - '304': *37 - '403': *29 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - previews: [] - category: dependabot - subcategory: alerts - "/enterprises/{enterprise}/teams": - get: - summary: List enterprise teams - description: List all teams in the enterprise for the authenticated user - tags: - - enterprise-teams - operationId: enterprise-teams/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams - parameters: - - *40 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &68 - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - description: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - description: 'Retired: this field will not be returned with - GHEC enterprise teams.' - example: disabled | all - organization_selection_type: - type: string - example: disabled | selected | all - group_id: - nullable: true - type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - group_name: - nullable: true - type: string - description: 'Retired: this field will not be returned with - GHEC enterprise teams.' - example: Justice League - html_url: - type: string - format: uri - example: https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - name - - html_url - - slug - - created_at - - updated_at - - group_id - examples: - default: - value: - - id: 1 - name: Justice League - description: A great team. - slug: justice-league - url: https://api.github.com/enterprises/dc/teams/justice-league - group_id: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: https://github.com/enterprises/dc/teams/justice-league - members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} - created_at: '2019-01-26T19:01:12Z' - updated_at: '2019-01-26T19:14:43Z' - headers: - Link: *67 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-teams - post: - summary: Create an enterprise team - description: To create an enterprise team, the authenticated user must be an - owner of the enterprise. - tags: - - enterprise-teams - operationId: enterprise-teams/create - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team - parameters: - - *40 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the team. - description: - nullable: true - type: string - description: A description of the team. - sync_to_organizations: - type: string - description: | - Retired: this field is no longer supported. - Whether the enterprise team should be reflected in each organization. - This value cannot be set. - enum: - - all - - disabled - default: disabled - organization_selection_type: - type: string - description: | - Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. - `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. - `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. - `all`: The team is assigned to all current and future organizations in the enterprise. - enum: - - disabled - - selected - - all - default: disabled - group_id: - nullable: true - type: string - description: The ID of the IdP group to assign team membership with. - You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). - required: - - name - examples: - default: - value: - name: Justice League - description: A great team. - group_id: 62ab9291-fae2-468e-974b-7e45096d5021 - responses: - '201': - description: Response - content: - application/json: - schema: *68 - examples: - default: &76 - value: - id: 1 - name: Justice League - description: A great team. - slug: justice-league - url: https://api.github.com/enterprises/dc/teams/justice-league - group_id: 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: https://github.com/enterprises/dc/teams/justice-league - members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} - created_at: '2019-01-26T19:01:12Z' - updated_at: '2019-01-26T19:14:43Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-teams - "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": - get: - summary: List members in an enterprise team - description: Lists all team members in an enterprise team. - tags: - - enterprise-team-memberships - operationId: enterprise-team-memberships/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team - parameters: - - *40 - - &69 - name: enterprise-team - description: The slug version of the enterprise team name. You can also substitute - this value with the enterprise team id. - in: path - required: true - schema: - type: string - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: &70 - value: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-members - "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": - post: - summary: Bulk add team members - description: Add multiple team members to an enterprise team. - tags: - - enterprise-team-memberships - operationId: enterprise-team-memberships/bulk-add - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members - parameters: - - *40 - - *69 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - usernames - properties: - usernames: - type: array - description: The GitHub user handles to add to the team. - items: - type: string - description: The handle for the GitHub user account. - examples: - default: - value: - usernames: - - monalisa - - octocat - responses: - '200': - description: Successfully added team members. - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-members - "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": - post: - summary: Bulk remove team members - description: Remove multiple team members from an enterprise team. - tags: - - enterprise-team-memberships - operationId: enterprise-team-memberships/bulk-remove - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members - parameters: - - *40 - - *69 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - usernames - properties: - usernames: - type: array - description: The GitHub user handles to be removed from the team. - items: - type: string - description: The handle for the GitHub user account. - examples: - default: - value: - usernames: - - monalisa - - octocat - responses: - '200': - description: Successfully removed team members. - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-members - "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": - get: - summary: Get enterprise team membership - description: Returns whether the user is a member of the enterprise team. - tags: - - enterprise-team-memberships - operationId: enterprise-team-memberships/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership - parameters: - - *40 - - *69 - - &71 - name: username - description: The handle for the GitHub user account. - in: path - required: true - schema: - type: string - responses: - '200': - description: User is a member of the enterprise team. - content: - application/json: - schema: *4 - examples: - exampleKey1: &72 - value: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-members - put: - summary: Add team member - description: Add a team member to an enterprise team. - tags: - - enterprise-team-memberships - operationId: enterprise-team-memberships/add - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member - parameters: - - *40 - - *69 - - *71 - responses: - '201': - description: Successfully added team member - content: - application/json: - schema: *4 - examples: - exampleKey1: *72 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-members - delete: - summary: Remove team membership - description: Remove membership of a specific user from a particular team in - an enterprise. - tags: - - enterprise-team-memberships - operationId: enterprise-team-memberships/remove - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership - parameters: - - *40 - - *69 - - *71 - responses: - '204': - description: Response - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-members - "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": - get: - summary: Get organization assignments - description: Get all organizations assigned to an enterprise team - tags: - - enterprise-team-organizations - operationId: enterprise-team-organizations/get-assignments - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments - parameters: - - *40 - - *69 - - *17 - - *19 - responses: - '200': - description: An array of organizations the team is assigned to - content: - application/json: - schema: - type: array - items: &73 - title: Organization Simple - description: A GitHub organization. - type: object - properties: &195 - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: &196 - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - examples: - default: &74 - value: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-organizations - "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": - post: - summary: Add organization assignments - description: Assign an enterprise team to multiple organizations. - tags: - - enterprise-team-organizations - operationId: enterprise-team-organizations/bulk-add - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments - parameters: - - *40 - - *69 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - organization_slugs - properties: - organization_slugs: - type: array - description: Organization slug to assign the team to. - items: - type: string - description: Organization slug to assign the team to - examples: - default: - value: - organization_slugs: - - github - responses: - '200': - description: Successfully assigned the enterprise team to organizations. - content: - application/json: - schema: - type: array - items: *73 - examples: - default: &116 - value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-organizations - "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": - post: - summary: Remove organization assignments - description: Unassign an enterprise team from multiple organizations. - tags: - - enterprise-team-organizations - operationId: enterprise-team-organizations/bulk-remove - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments - parameters: - - *40 - - *69 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - organization_slugs - properties: - organization_slugs: - type: array - description: Organization slug to unassign the team from. - items: - type: string - description: Organization slug to unassign the team from - examples: - default: - value: - organization_slugs: - - github - responses: - '204': - description: Successfully unassigned the enterprise team from organizations. - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-organizations - "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": - get: - summary: Get organization assignment - description: Check if an enterprise team is assigned to an organization - tags: - - enterprise-team-organizations - operationId: enterprise-team-organizations/get-assignment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment - parameters: - - *40 - - *69 - - &75 - name: org - description: The organization name. The name is not case sensitive. - in: path - required: true - schema: - type: string - responses: - '200': - description: The team is assigned to the organization - content: - application/json: - schema: *73 - examples: - default: *74 - '404': - description: The team is not assigned to the organization - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-organizations - put: - summary: Add an organization assignment - description: Assign an enterprise team to an organization. - tags: - - enterprise-team-organizations - operationId: enterprise-team-organizations/add - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment - parameters: - - *40 - - *69 - - *75 - responses: - '201': - description: Successfully assigned the enterprise team to the organization. - content: - application/json: - schema: *73 - examples: - default: *74 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-organizations - delete: - summary: Delete an organization assignment - description: Unassign an enterprise team from an organization. - tags: - - enterprise-team-organizations - operationId: enterprise-team-organizations/delete - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment - parameters: - - *40 - - *69 - - *75 - responses: - '204': - description: Successfully unassigned the enterprise team from the organization. - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-team-organizations - "/enterprises/{enterprise}/teams/{team_slug}": - get: - summary: Get an enterprise team - description: Gets a team using the team's slug. To create the slug, GitHub replaces - special characters in the name string, changes all words to lowercase, and - replaces spaces with a `-` separator and adds the "ent:" prefix. For example, - "My TEam NΓ€me" would become `ent:my-team-name`. - tags: - - enterprise-teams - operationId: enterprise-teams/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team - parameters: - - *40 - - &77 - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *68 - examples: - default: *76 - headers: - Link: *67 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-teams - patch: - summary: Update an enterprise team - description: To edit a team, the authenticated user must be an enterprise owner. - tags: - - enterprise-teams - operationId: enterprise-teams/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team - parameters: - - *40 - - *77 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - nullable: true - type: string - description: A new name for the team. - description: - nullable: true - type: string - description: A new description for the team. - sync_to_organizations: - type: string - description: | - Retired: this field is no longer supported. - Whether the enterprise team should be reflected in each organization. - This value cannot be changed. - enum: - - all - - disabled - default: disabled - organization_selection_type: - type: string - description: | - Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. - `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. - `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). - `all`: The team is assigned to all current and future organizations in the enterprise. - enum: - - disabled - - selected - - all - default: disabled - group_id: - nullable: true - type: string - description: The ID of the IdP group to assign team membership with. - The new IdP group will replace the existing one, or replace existing - direct members if the team isn't currently linked to an IdP group. - examples: - default: - value: - name: Justice League - description: A great team. - group_id: 62ab9291-fae2-468e-974b-7e45096d5021 - responses: - '200': - description: Response - content: - application/json: - schema: *68 - examples: - default: *76 - headers: - Link: *67 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-teams - delete: - summary: Delete an enterprise team - description: |- - To delete an enterprise team, the authenticated user must be an enterprise owner. - - If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. - tags: - - enterprise-teams - operationId: enterprise-teams/delete - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team - parameters: - - *40 - - *77 - responses: - '204': - description: Response - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: enterprise-teams - subcategory: enterprise-teams - "/events": - get: - summary: List public events - description: |- - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-public-events - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-public-events - parameters: - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 15 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &111 - title: Event - description: Event - type: object - properties: - id: - type: string - type: - type: string - nullable: true - actor: &78 - title: Actor - description: Actor - type: object - properties: - id: - type: integer - login: - type: string - display_login: - type: string - gravatar_id: - type: string - nullable: true - url: - type: string - format: uri - avatar_url: - type: string - format: uri - required: - - id - - login - - gravatar_id - - url - - avatar_url - repo: - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - name - - url - org: *78 - payload: - oneOf: - - title: CreateEvent - type: object - properties: - ref: - type: string - ref_type: - type: string - full_ref: - type: string - master_branch: - type: string - description: - type: string - nullable: true - pusher_type: - type: string - required: - - ref - - ref_type - - full_ref - - master_branch - - pusher_type - - title: DeleteEvent - type: object - properties: - ref: - type: string - ref_type: - type: string - full_ref: - type: string - pusher_type: - type: string - required: - - ref - - ref_type - - full_ref - - pusher_type - - title: DiscussionEvent - type: object - properties: - action: - type: string - discussion: &760 - title: Discussion - description: A Discussion in a repository. - type: object - properties: - active_lock_reason: - type: string - nullable: true - answer_chosen_at: - type: string - nullable: true - answer_chosen_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - answer_html_url: - type: string - nullable: true - author_association: - title: AuthorAssociation - description: How the author is associated with the - repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - category: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer - created_at: - type: string - format: date-time - html_url: - type: string - id: - type: integer - locked: - type: boolean - node_id: - type: string - number: - type: integer - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - state: - type: string - description: |- - The current state of the discussion. - `converting` means that the discussion is being converted from an issue. - `transferring` means that the discussion is being transferred from another repository. - enum: - - open - - closed - - locked - - converting - - transferring - state_reason: - description: The reason for the current state - example: resolved - type: string - nullable: true - enum: - - resolved - - outdated - - duplicate - - reopened - timeline_url: - type: string - title: - type: string - updated_at: - type: string - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - labels: - type: array - items: &84 - title: Label - description: Color-coded labels help you categorize - and filter your issues (just like labels in Gmail). - type: object - properties: - id: - description: Unique identifier for the label. - type: integer - format: int64 - example: 208045946 - node_id: - type: string - example: MDU6TGFiZWwyMDgwNDU5NDY= - url: - description: URL for the label - example: https://api.github.com/repositories/42/labels/bug - type: string - format: uri - name: - description: The name of the label. - example: bug - type: string - description: - description: Optional description of the label, - such as its purpose. - type: string - example: Something isn't working - nullable: true - color: - description: '6-character hex code, without - the leading #, identifying the color' - example: FFFFFF - type: string - default: - description: Whether this label comes by default - in a new repository. - type: boolean - example: true - required: - - id - - node_id - - url - - name - - description - - color - - default - required: - - repository_url - - category - - answer_html_url - - answer_chosen_at - - answer_chosen_by - - html_url - - id - - node_id - - number - - title - - user - - state - - state_reason - - locked - - comments - - created_at - - updated_at - - active_lock_reason - - body - required: - - action - - discussion - - title: IssuesEvent - type: object - properties: - action: - type: string - issue: &85 - title: Issue - description: Issues are a great way to keep track of tasks, - enhancements, and bugs for your projects. - type: object - properties: &551 - id: - type: integer - format: int64 - node_id: - type: string - url: - description: URL for the issue - example: https://api.github.com/repositories/42/issues/1 - type: string - format: uri - repository_url: - type: string - format: uri - labels_url: - type: string - comments_url: - type: string - format: uri - events_url: - type: string - format: uri - html_url: - type: string - format: uri - number: - description: Number uniquely identifying the issue - within its repository - example: 42 - type: integer - state: - description: State of the issue; either 'open' or - 'closed' - example: open - type: string - state_reason: - description: The reason for the current state - example: not_planned - type: string - nullable: true - enum: - - completed - - reopened - - not_planned - - duplicate - title: - description: Title of the issue - example: Widget creation fails in Safari on OS X 10.8 - type: string - body: - description: Contents of the issue - example: It looks like the new widget form is broken - on Safari. When I try and create the widget, Safari - crashes. This is reproducible on 10.8, but not 10.9. - Maybe a browser bug? - type: string - nullable: true - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - labels: - description: Labels to associate with this issue; - pass one or more label names to replace the set - of labels on this issue; send an empty array to - clear all labels from the issue; note that the labels - are silently dropped for users without push access - to the repository - example: - - bug - - registration - type: array - items: - oneOf: - - type: string - - type: object - properties: - id: - type: integer - format: int64 - node_id: - type: string - url: - type: string - format: uri - name: - type: string - description: - type: string - nullable: true - color: - type: string - nullable: true - default: - type: boolean - assignee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignees: - type: array - items: *4 - milestone: - title: Milestone - description: A collection of related issues and pull - requests. - type: object - properties: &280 - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: - description: The number of the milestone. - type: integer - example: 42 - state: - description: The state of the milestone. - example: open - type: string - enum: - - open - - closed - default: open - title: - description: The title of the milestone. - example: v1.0 - type: string - description: - type: string - example: Tracking milestone for version 1.0 - nullable: true - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - open_issues: - type: integer - example: 4 - closed_issues: - type: integer - example: 8 - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '2014-03-03T18:58:10Z' - closed_at: - type: string - format: date-time - example: '2013-02-12T13:22:01Z' - nullable: true - due_on: - type: string - format: date-time - example: '2012-10-09T23:39:01Z' - nullable: true - required: &281 - - closed_issues - - creator - - description - - due_on - - closed_at - - id - - node_id - - labels_url - - html_url - - number - - open_issues - - state - - title - - url - - created_at - - updated_at - nullable: true - locked: - type: boolean - active_lock_reason: - type: string - nullable: true - comments: - type: integer - pull_request: - type: object - properties: - merged_at: - type: string - format: date-time - nullable: true - diff_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - patch_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - nullable: true - required: - - diff_url - - html_url - - patch_url - - url - closed_at: - type: string - format: date-time - nullable: true - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - draft: - type: boolean - closed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - body_html: - type: string - body_text: - type: string - timeline_url: - type: string - format: uri - type: &243 - title: Issue Type - description: The type of issue. - type: object - nullable: true - properties: - id: - type: integer - description: The unique identifier of the issue - type. - node_id: - type: string - description: The node identifier of the issue - type. - name: - type: string - description: The name of the issue type. - description: - type: string - description: The description of the issue type. - nullable: true - color: - type: string - description: The color of the issue type. - enum: - - gray - - blue - - green - - yellow - - orange - - red - - pink - - purple - nullable: true - created_at: - type: string - description: The time the issue type created. - format: date-time - updated_at: - type: string - description: The time the issue type last updated. - format: date-time - is_enabled: - type: boolean - description: The enabled state of the issue type. - required: - - id - - node_id - - name - - description - repository: *79 - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. - They can be installed directly on organizations - and user accounts and granted access to specific - repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class - actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - author_association: &82 - title: author_association - type: string - example: OWNER - description: How the author is associated with the - repository. - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - reactions: &83 - title: Reaction Rollup - type: object - properties: - url: - type: string - format: uri - total_count: - type: integer - "+1": - type: integer - "-1": - type: integer - laugh: - type: integer - confused: - type: integer - heart: - type: integer - hooray: - type: integer - eyes: - type: integer - rocket: - type: integer - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - sub_issues_summary: &678 - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed - parent_issue_url: - description: URL to get the parent issue of this issue, - if it is a sub-issue - type: string - format: uri - nullable: true - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to - collaborate on an issue. - type: object - properties: &86 - id: - description: Unique identifier of the issue comment - example: 42 - type: integer - format: int64 - node_id: - type: string - url: - description: URL for the issue comment - example: https://api.github.com/repositories/42/issues/comments/1 - type: string - format: uri - body: - description: Contents of the issue comment - example: What version of Safari were you using - when you observed this bug? - type: string - body_text: - type: string - body_html: - type: string - html_url: - type: string - format: uri - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - updated_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - issue_url: - type: string - format: uri - author_association: *82 - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend - GitHub. They can be installed directly on organizations - and user accounts and granted access to specific - repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first - class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - reactions: *83 - pin: - title: Pinned Issue Comment - description: Context around who pinned an issue - comment and when it was pinned. - type: object - properties: &574 - pinned_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - pinned_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: &575 - - pinned_at - - pinned_by - nullable: true - required: &87 - - id - - node_id - - html_url - - issue_url - - user - - url - - created_at - - updated_at - nullable: true - issue_dependencies_summary: &679 - title: Issue Dependencies Summary - type: object - properties: - blocked_by: - type: integer - blocking: - type: integer - total_blocked_by: - type: integer - total_blocking: - type: integer - required: - - blocked_by - - blocking - - total_blocked_by - - total_blocking - issue_field_values: - type: array - items: &559 - title: Issue Field Value - description: A value assigned to an issue field - type: object - properties: - issue_field_id: - description: Unique identifier for the issue - field. - type: integer - format: int64 - example: 1 - node_id: - type: string - example: IFT_GDKND - data_type: - description: The data type of the issue field - type: string - enum: - - text - - single_select - - number - - date - example: text - value: - description: The value of the issue field - anyOf: - - type: string - example: Sample text - - type: number - example: 42.5 - - type: integer - example: 1 - nullable: true - single_select_option: - description: Details about the selected option - (only present for single_select fields) - type: object - properties: - id: - description: Unique identifier for the option. - type: integer - format: int64 - example: 1 - name: - description: The name of the option - type: string - example: High - color: - description: The color of the option - type: string - example: red - required: - - id - - name - - color - nullable: true - required: - - issue_field_id - - node_id - - data_type - - value - required: &552 - - assignee - - closed_at - - comments - - comments_url - - events_url - - html_url - - id - - node_id - - labels - - labels_url - - milestone - - number - - repository_url - - state - - locked - - title - - url - - user - - created_at - - updated_at - x-github-breaking-changes: &553 - - changeset: deprecate_beta_media_type - patch: - properties: - pull_request: - type: object - properties: - merged_at: - nullable: false - diff_url: - nullable: false - html_url: - nullable: false - patch_url: - nullable: false - url: - nullable: false - version: '2026-03-10' - - changeset: remove_singular_assignee_from_issues_and_pull_requests - patch: - properties: - assignee: - required: - - closed_at - - comments - - comments_url - - events_url - - html_url - - id - - node_id - - labels - - labels_url - - milestone - - number - - repository_url - - state - - locked - - title - - url - - user - - created_at - - updated_at - version: '2026-03-10' - assignee: *4 - assignees: - type: array - items: *4 - label: *84 - labels: - type: array - items: *84 - required: - - action - - issue - - title: IssueCommentEvent - type: object - properties: - action: - type: string - issue: *85 - comment: &547 - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - required: - - action - - issue - - comment - - title: ForkEvent - type: object - properties: - action: - type: string - forkee: - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - private: - type: boolean - owner: *4 - html_url: - type: string - description: - type: string - nullable: true - fork: - type: boolean - url: - type: string - forks_url: - type: string - keys_url: - type: string - collaborators_url: - type: string - teams_url: - type: string - hooks_url: - type: string - issue_events_url: - type: string - events_url: - type: string - assignees_url: - type: string - branches_url: - type: string - tags_url: - type: string - blobs_url: - type: string - git_tags_url: - type: string - git_refs_url: - type: string - trees_url: - type: string - statuses_url: - type: string - languages_url: - type: string - stargazers_url: - type: string - contributors_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - commits_url: - type: string - git_commits_url: - type: string - comments_url: - type: string - issue_comment_url: - type: string - contents_url: - type: string - compare_url: - type: string - merges_url: - type: string - archive_url: - type: string - downloads_url: - type: string - issues_url: - type: string - pulls_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - labels_url: - type: string - releases_url: - type: string - deployments_url: - type: string - created_at: - type: string - format: date-time - nullable: true - updated_at: - type: string - format: date-time - nullable: true - pushed_at: - type: string - format: date-time - nullable: true - git_url: - type: string - ssh_url: - type: string - clone_url: - type: string - svn_url: - type: string - homepage: - type: string - nullable: true - size: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - language: - type: string - nullable: true - has_issues: - type: boolean - has_projects: - type: boolean - has_downloads: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_discussions: - type: boolean - has_pull_requests: - type: boolean - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - forks_count: - type: integer - mirror_url: - type: string - nullable: true - archived: - type: boolean - disabled: - type: boolean - open_issues_count: - type: integer - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - allow_forking: - type: boolean - is_template: - type: boolean - web_commit_signoff_required: - type: boolean - topics: - type: array - items: - type: string - visibility: - type: string - forks: - type: integer - open_issues: - type: integer - watchers: - type: integer - default_branch: - type: string - public: - type: boolean - required: - - action - - forkee - - title: GollumEvent - type: object - properties: - pages: - type: array - items: - type: object - properties: - page_name: - type: string - nullable: true - title: - type: string - nullable: true - summary: - type: string - nullable: true - action: - type: string - sha: - type: string - html_url: - type: string - required: - - pages - - title: MemberEvent - type: object - properties: - action: - type: string - member: *4 - required: - - action - - member - - title: PublicEvent - type: object - - title: PushEvent - type: object - properties: - repository_id: - type: integer - push_id: - type: integer - ref: - type: string - head: - type: string - before: - type: string - required: - - repository_id - - push_id - - ref - - head - - before - - title: PullRequestEvent - type: object - properties: - action: - type: string - number: - type: integer - pull_request: &90 - title: Pull Request Minimal - type: object - properties: - id: - type: integer - format: int64 - number: - type: integer - url: - type: string - head: - type: object - properties: - ref: - type: string - sha: - type: string - repo: - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - name: - type: string - required: - - id - - url - - name - required: - - ref - - sha - - repo - base: - type: object - properties: - ref: - type: string - sha: - type: string - repo: - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - name: - type: string - required: - - id - - url - - name - required: - - ref - - sha - - repo - required: - - id - - number - - url - - head - - base - assignee: *4 - assignees: - type: array - items: *4 - label: *84 - labels: - type: array - items: *84 - required: - - action - - number - - pull_request - - title: PullRequestReviewCommentEvent - type: object - properties: - action: - type: string - pull_request: *90 - comment: - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - format: uri - pull_request_review_id: - type: integer - nullable: true - diff_hunk: - type: string - path: - type: string - position: - type: integer - nullable: true - original_position: - type: integer - subject_type: - type: string - nullable: true - commit_id: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - body: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - html_url: - type: string - format: uri - pull_request_url: - type: string - format: uri - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - original_commit_id: - type: string - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - in_reply_to_id: - type: integer - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - _links - - reactions - required: - - action - - comment - - pull_request - - title: PullRequestReviewEvent - type: object - properties: - action: - type: string - review: - type: object - properties: - id: - type: integer - node_id: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - body: - type: string - commit_id: - type: string - submitted_at: - type: string - nullable: true - state: - type: string - html_url: - type: string - format: uri - pull_request_url: - type: string - format: uri - _links: - type: object - properties: - html: - type: object - properties: - href: - type: string - required: - - href - pull_request: - type: object - properties: - href: - type: string - required: - - href - required: - - html - - pull_request - updated_at: - type: string - pull_request: *90 - required: - - action - - review - - pull_request - - title: CommitCommentEvent - type: object - properties: - action: - type: string - comment: - type: object - properties: - html_url: - type: string - format: uri - url: - type: string - format: uri - id: - type: integer - node_id: - type: string - body: - type: string - path: - type: string - nullable: true - position: - type: integer - nullable: true - line: - type: integer - nullable: true - commit_id: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - reactions: *83 - required: - - action - - comment - - title: ReleaseEvent - type: object - properties: - action: - type: string - release: - allOf: - - &608 - title: Release - description: A release. - type: object - properties: - url: - type: string - format: uri - html_url: - type: string - format: uri - assets_url: - type: string - format: uri - upload_url: - type: string - tarball_url: - type: string - format: uri - nullable: true - zipball_url: - type: string - format: uri - nullable: true - id: - type: integer - node_id: - type: string - tag_name: - description: The name of the tag. - example: v1.0.0 - type: string - target_commitish: - description: Specifies the commitish value that - determines where the Git tag is created from. - example: master - type: string - name: - type: string - nullable: true - body: - type: string - nullable: true - draft: - description: true to create a draft (unpublished) - release, false to create a published one. - example: false - type: boolean - prerelease: - description: Whether to identify the release as - a prerelease or a full release. - example: false - type: boolean - immutable: - description: Whether or not the release is immutable. - example: false - type: boolean - created_at: - type: string - format: date-time - published_at: - type: string - format: date-time - nullable: true - updated_at: - type: string - nullable: true - format: date-time - author: *4 - assets: - type: array - items: &609 - title: Release Asset - description: Data related to a release. - type: object - properties: - url: - type: string - format: uri - browser_download_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - name: - description: The file name of the asset. - type: string - example: Team Environment - label: - type: string - nullable: true - state: - description: State of the release asset. - type: string - enum: - - uploaded - - open - content_type: - type: string - size: - type: integer - digest: - type: string - nullable: true - download_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - uploader: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - id - - name - - content_type - - size - - digest - - state - - url - - node_id - - download_count - - label - - uploader - - browser_download_url - - created_at - - updated_at - body_html: - type: string - body_text: - type: string - mentions_count: - type: integer - discussion_url: - description: The URL of the release discussion. - type: string - format: uri - reactions: *83 - required: - - assets_url - - upload_url - - tarball_url - - zipball_url - - created_at - - published_at - - draft - - id - - node_id - - author - - html_url - - name - - prerelease - - tag_name - - target_commitish - - assets - - url - - type: object - properties: - is_short_description_html_truncated: - type: boolean - short_description_html: - type: string - required: - - action - - release - - title: WatchEvent - type: object - properties: - action: - type: string - required: - - action - public: - type: boolean - created_at: - type: string - format: date-time - nullable: true - required: - - id - - type - - actor - - repo - - payload - - public - - created_at - examples: - default: - value: - - id: '22249084947' - type: WatchEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - action: started - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-07T07:50:26Z' - '304': *37 - '403': *29 - '503': &121 - description: Service unavailable - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/feeds": - get: - summary: Get feeds - description: |- - Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. - - * **Timeline**: The GitHub global public timeline - * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * **Current user public**: The public timeline for the authenticated user - * **Current user**: The private timeline for the authenticated user - * **Current user actor**: The private timeline for activity created by the authenticated user - * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. - - By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - > [!NOTE] - > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. - tags: - - activity - operationId: activity/get-feeds - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/feeds#get-feeds - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - title: Feed - description: Feed - type: object - properties: - timeline_url: - type: string - example: https://github.com/timeline - user_url: - type: string - example: https://github.com/{user} - current_user_public_url: - type: string - example: https://github.com/octocat - current_user_url: - type: string - example: https://github.com/octocat.private?token=abc123 - current_user_actor_url: - type: string - example: https://github.com/octocat.private.actor?token=abc123 - current_user_organization_url: - type: string - example: https://github.com/octocat-org - current_user_organization_urls: - type: array - example: - - https://github.com/organizations/github/octocat.private.atom?token=abc123 - items: - type: string - format: uri - security_advisories_url: - type: string - example: https://github.com/security-advisories - repository_discussions_url: - type: string - example: https://github.com/{user}/{repo}/discussions - description: A feed of discussions for a given repository. - repository_discussions_category_url: - type: string - example: https://github.com/{user}/{repo}/discussions/categories/{category} - description: A feed of discussions for a given repository and - category. - _links: - type: object - properties: - timeline: &91 - title: Link With Type - description: Hypermedia Link with Type - type: object - properties: - href: - type: string - type: - type: string - required: - - href - - type - user: *91 - security_advisories: *91 - current_user: *91 - current_user_public: *91 - current_user_actor: *91 - current_user_organization: *91 - current_user_organizations: - type: array - items: *91 - repository_discussions: *91 - repository_discussions_category: *91 - required: - - timeline - - user - required: - - _links - - timeline_url - - user_url - examples: - default: - value: - timeline_url: https://github.com/timeline - user_url: https://github.com/{user} - current_user_public_url: https://github.com/octocat - current_user_url: https://github.com/octocat.private?token=abc123 - current_user_actor_url: https://github.com/octocat.private.actor?token=abc123 - current_user_organization_url: '' - current_user_organization_urls: - - https://github.com/organizations/github/octocat.private.atom?token=abc123 - security_advisories_url: https://github.com/security-advisories - _links: - timeline: - href: https://github.com/timeline - type: application/atom+xml - user: - href: https://github.com/{user} - type: application/atom+xml - current_user_public: - href: https://github.com/octocat - type: application/atom+xml - current_user: - href: https://github.com/octocat.private?token=abc123 - type: application/atom+xml - current_user_actor: - href: https://github.com/octocat.private.actor?token=abc123 - type: application/atom+xml - current_user_organization: - href: '' - type: '' - current_user_organizations: - - href: https://github.com/organizations/github/octocat.private.atom?token=abc123 - type: application/atom+xml - security_advisories: - href: https://github.com/security-advisories - type: application/atom+xml - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: feeds - "/gists": - get: - summary: List gists for the authenticated user - description: 'Lists the authenticated user''s gists or if called anonymously, - this endpoint returns all public gists:' - tags: - - gists - operationId: gists/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user - parameters: - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &93 - title: Base Gist - description: Base Gist - type: object - properties: - url: - type: string - format: uri - forks_url: - type: string - format: uri - commits_url: - type: string - format: uri - id: - type: string - node_id: - type: string - git_pull_url: - type: string - format: uri - git_push_url: - type: string - format: uri - html_url: - type: string - format: uri - files: - type: object - additionalProperties: - type: object - properties: - filename: - type: string - type: - type: string - language: - type: string - raw_url: - type: string - size: - type: integer - encoding: - type: string - description: The encoding used for `content`. Currently, - `"utf-8"` and `"base64"` are supported. - default: utf-8 - public: - type: boolean - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - description: - type: string - nullable: true - comments: - type: integer - comments_enabled: - type: boolean - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - comments_url: - type: string - format: uri - owner: *4 - truncated: - type: boolean - forks: - type: array - items: {} - history: - type: array - items: {} - required: - - id - - node_id - - url - - forks_url - - commits_url - - git_pull_url - - git_push_url - - html_url - - comments_url - - public - - description - - comments - - user - - files - - created_at - - updated_at - x-github-breaking-changes: - - changeset: deprecate_beta_media_type - patch: - properties: - user: - required: - - id - - node_id - - url - - forks_url - - commits_url - - git_pull_url - - git_push_url - - html_url - - comments_url - - public - - description - - comments - - files - - created_at - - updated_at - version: '2026-03-10' - - changeset: remove_forks_history_from_base_gist - patch: - - op: remove - path: "/properties/forks" - - op: remove - path: "/properties/history" - version: '2026-03-10' - examples: - default: &94 - value: - - url: https://api.github.com/gists/aa5a315d61ae9438b18d - forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks - commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits - id: aa5a315d61ae9438b18d - node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk - git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git - git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git - html_url: https://gist.github.com/aa5a315d61ae9438b18d - files: - hello_world.rb: - filename: hello_world.rb - type: application/x-ruby - language: Ruby - raw_url: https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb - size: 167 - public: true - created_at: '2010-04-14T02:15:15Z' - updated_at: '2011-06-20T11:34:15Z' - description: Hello World Examples - comments: 0 - user: - comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - truncated: false - headers: - Link: *67 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - post: - summary: Create a gist - description: |- - Allows you to add a new gist with one or more files. - - > [!NOTE] - > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - operationId: gists/create - tags: - - gists - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#create-a-gist - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - description: - description: Description of the gist - example: Example Ruby script - type: string - files: - description: Names and content for the files that make up the gist - example: - hello.rb: - content: puts "Hello, World!" - type: object - additionalProperties: - type: object - properties: - content: - description: Content of the file - readOnly: false - type: string - required: - - content - public: - oneOf: - - description: Flag indicating whether the gist is public - example: true - type: boolean - default: false - - type: string - example: 'true' - default: 'false' - enum: - - 'true' - - 'false' - required: - - files - type: object - examples: - default: - summary: Creating a gist - value: - description: Example of a gist - public: false - files: - README.md: - content: Hello World - responses: - '201': - description: Response - content: - application/json: - schema: &95 - title: Gist Simple - description: Gist Simple - type: object - properties: - forks: - deprecated: true - nullable: true - type: array - items: - type: object - properties: - id: - type: string - url: - type: string - format: uri - user: &685 - title: Public User - description: Public User - type: object - properties: - login: - type: string - id: - type: integer - format: int64 - user_view_type: - type: string - node_id: - type: string - avatar_url: - type: string - format: uri - gravatar_id: - type: string - nullable: true - url: - type: string - format: uri - html_url: - type: string - format: uri - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - format: uri - organizations_url: - type: string - format: uri - repos_url: - type: string - format: uri - events_url: - type: string - received_events_url: - type: string - format: uri - type: - type: string - site_admin: - type: boolean - name: - type: string - nullable: true - company: - type: string - nullable: true - blog: - type: string - nullable: true - location: - type: string - nullable: true - email: - type: string - format: email - nullable: true - notification_email: - type: string - format: email - nullable: true - hireable: - type: boolean - nullable: true - bio: - type: string - nullable: true - twitter_username: - type: string - nullable: true - public_repos: - type: integer - public_gists: - type: integer - followers: - type: integer - following: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - plan: - type: object - properties: - collaborators: - type: integer - name: - type: string - space: - type: integer - private_repos: - type: integer - required: - - collaborators - - name - - space - - private_repos - private_gists: - type: integer - example: 1 - total_private_repos: - type: integer - example: 2 - owned_private_repos: - type: integer - example: 2 - disk_usage: - type: integer - example: 1 - collaborators: - type: integer - example: 3 - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - - bio - - blog - - company - - email - - followers - - following - - hireable - - location - - name - - public_gists - - public_repos - - created_at - - updated_at - additionalProperties: false - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - history: - deprecated: true - nullable: true - type: array - items: - title: Gist History - description: Gist History - type: object - properties: - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - version: - type: string - committed_at: - type: string - format: date-time - change_status: - type: object - properties: - total: - type: integer - additions: - type: integer - deletions: - type: integer - url: - type: string - format: uri - fork_of: - nullable: true - title: Gist - description: Gist - type: object - properties: - url: - type: string - format: uri - forks_url: - type: string - format: uri - commits_url: - type: string - format: uri - id: - type: string - node_id: - type: string - git_pull_url: - type: string - format: uri - git_push_url: - type: string - format: uri - html_url: - type: string - format: uri - files: - type: object - additionalProperties: - type: object - properties: - filename: - type: string - type: - type: string - language: - type: string - raw_url: - type: string - size: - type: integer - public: - type: boolean - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - description: - type: string - nullable: true - comments: - type: integer - comments_enabled: - type: boolean - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - comments_url: - type: string - format: uri - owner: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - truncated: - type: boolean - forks: - type: array - items: {} - history: - type: array - items: {} - required: - - id - - node_id - - url - - forks_url - - commits_url - - git_pull_url - - git_push_url - - html_url - - comments_url - - public - - description - - comments - - user - - files - - created_at - - updated_at - url: - type: string - forks_url: - type: string - commits_url: - type: string - id: - type: string - node_id: - type: string - git_pull_url: - type: string - git_push_url: - type: string - html_url: - type: string - files: - type: object - additionalProperties: - nullable: true - type: object - properties: - filename: - type: string - type: - type: string - language: - type: string - raw_url: - type: string - size: - type: integer - truncated: - type: boolean - content: - type: string - encoding: - type: string - description: The encoding used for `content`. Currently, - `"utf-8"` and `"base64"` are supported. - default: utf-8 - public: - type: boolean - created_at: - type: string - updated_at: - type: string - description: - type: string - nullable: true - comments: - type: integer - comments_enabled: - type: boolean - user: - type: string - nullable: true - comments_url: - type: string - owner: *4 - truncated: - type: boolean - x-github-breaking-changes: - - changeset: remove_forks_history_from_base_gist - patch: - - op: remove - path: "/properties/forks" - - op: remove - path: "/properties/history" - version: '2026-03-10' - examples: - default: &96 - value: - url: https://api.github.com/gists/2decf6c462d9b4418f2 - forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks - commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits - id: 2decf6c462d9b4418f2 - node_id: G_kwDOBhHyLdZDliNDQxOGYy - git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git - git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git - html_url: https://gist.github.com/2decf6c462d9b4418f2 - files: - README.md: - filename: README.md - type: text/markdown - language: Markdown - raw_url: https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md - size: 23 - truncated: false - content: Hello world from GitHub - encoding: utf-8 - public: true - created_at: '2022-09-20T12:11:58Z' - updated_at: '2022-09-21T10:28:06Z' - description: An updated gist description. - comments: 0 - comments_enabled: true - user: - comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments - owner: - login: monalisa - id: 104456405 - node_id: U_kgDOBhHyLQ - avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - forks: [] - history: - - user: - login: monalisa - id: 104456405 - node_id: U_kgyLQ - avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - version: 468aac8caed5f0c3b859b8286968 - committed_at: '2022-09-21T10:28:06Z' - change_status: - total: 2 - additions: 1 - deletions: 1 - url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 - truncated: false - headers: - Location: - example: https://api.github.com/gists/aa5a315d61ae9438b18d - schema: - type: string - '422': *15 - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/public": - get: - summary: List public gists - description: |- - List public gists sorted by most recently updated to least recently updated. - - Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - tags: - - gists - operationId: gists/list-public - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#list-public-gists - parameters: - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *93 - examples: - default: *94 - headers: - Link: *67 - '422': *15 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/starred": - get: - summary: List starred gists - description: 'List the authenticated user''s starred gists:' - tags: - - gists - operationId: gists/list-starred - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#list-starred-gists - parameters: - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *93 - examples: - default: *94 - headers: - Link: *67 - '401': *25 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/{gist_id}": - get: - summary: Get a gist - description: |- - Gets a specified gist. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#get-a-gist - parameters: - - &97 - name: gist_id - description: The unique identifier of the gist. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *95 - examples: - default: *96 - '403': &100 - description: Forbidden Gist - content: - application/json: - schema: - type: object - properties: - block: - type: object - properties: - reason: - type: string - created_at: - type: string - html_url: - type: string - nullable: true - message: - type: string - documentation_url: - type: string - '404': *6 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - patch: - summary: Update a gist - description: |- - Allows you to update a gist's description and to update, delete, or rename gist files. Files - from the previous version of the gist that aren't explicitly changed during an edit - are unchanged. - - At least one of `description` or `files` is required. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#update-a-gist - parameters: - - *97 - requestBody: - required: true - content: - application/json: - schema: - properties: - description: - description: The description of the gist. - example: Example Ruby script - type: string - files: - description: |- - The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - (including extension) of the targeted gist file. For example: `hello.py`. - - To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be - deleted if the specified object does not contain at least one of `content` or `filename`. - example: - hello.rb: - content: blah - filename: goodbye.rb - type: object - additionalProperties: - type: object - nullable: true - properties: - content: - description: The new content of the file. - type: string - filename: - description: The new filename for the file. - type: string - nullable: true - type: object - nullable: true - examples: - updateGist: - summary: Updating a gist - value: - description: An updated gist description - files: - README.md: - content: Hello World from GitHub - deleteFile: - summary: Deleting a gist file - value: - files: - hello.py: - renameFile: - summary: Renaming a gist file - value: - files: - hello.py: - filename: goodbye.py - responses: - '200': - description: Response - content: - application/json: - schema: *95 - examples: - updateGist: *96 - deleteFile: - value: - url: https://api.github.com/gists/2decf6c462d9b4418f2 - forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks - commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits - id: 2decf6c462d9b4418f2 - node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy - git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git - git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git - html_url: https://gist.github.com/2decf6c462d9b4418f2 - files: - public: true - created_at: '2022-09-20T12:11:58Z' - updated_at: '2022-09-21T10:28:06Z' - description: A gist description. - comments: 0 - user: - comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments - owner: - login: monalisa - id: 104456405 - node_id: U_kgDOBhHyLQ - avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - forks: [] - history: - - user: - login: monalisa - id: 104456405 - node_id: U_kgyLQ - avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - version: 9cc352a89178a6d4 - committed_at: '2022-09-21T10:28:06Z' - change_status: - total: 1 - additions: 0 - deletions: 1 - url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 - truncated: false - renameFile: - value: - url: https://api.github.com/gists/2decf6c462d9b4418f2 - forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks - commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits - id: 2decf6c462d9b4418f2 - node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy - git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git - git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git - html_url: https://gist.github.com/2decf6c462d9b4418f2 - files: - goodbye.py: - filename: goodbye.py - type: application/x-python - language: Python - raw_url: https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py - size: 4 - truncated: false - content: "# Hello world" - public: true - created_at: '2022-09-20T12:11:58Z' - updated_at: '2022-09-21T10:28:06Z' - description: A gist description. - comments: 0 - user: - comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments - owner: - login: monalisa - id: 104456405 - node_id: U_kgDOBhHyLQ - avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - forks: [] - history: - - user: - login: monalisa - id: 104456405 - node_id: U_kgyLQ - avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - version: 468aac8caed5f0c3b859b8286968 - committed_at: '2022-09-21T10:28:06Z' - change_status: - total: 0 - additions: 0 - deletions: 0 - url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 - truncated: false - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - delete: - summary: Delete a gist - description: '' - tags: - - gists - operationId: gists/delete - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#delete-a-gist - parameters: - - *97 - responses: - '204': - description: Response - '404': *6 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/{gist_id}/comments": - get: - summary: List gist comments - description: |- - Lists the comments on a gist. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/list-comments - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/comments#list-gist-comments - parameters: - - *97 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &98 - title: Gist Comment - description: A comment made to a gist. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDExOkdpc3RDb21tZW50MQ== - url: - type: string - format: uri - example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 - body: - description: The comment text. - type: string - maxLength: 65535 - example: Body of the attachment - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-18T23:23:56Z' - updated_at: - type: string - format: date-time - example: '2011-04-18T23:23:56Z' - author_association: *82 - required: - - url - - id - - node_id - - user - - body - - author_association - - created_at - - updated_at - examples: - default: - value: - - id: 1 - node_id: MDExOkdpc3RDb21tZW50MQ== - url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 - body: Just commenting for the sake of commenting - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-18T23:23:56Z' - updated_at: '2011-04-18T23:23:56Z' - author_association: COLLABORATOR - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: comments - post: - summary: Create a gist comment - description: |- - Creates a comment on a gist. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/create-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/comments#create-a-gist-comment - parameters: - - *97 - requestBody: - required: true - content: - application/json: - schema: - properties: - body: - description: The comment text. - type: string - maxLength: 65535 - example: Body of the attachment - type: object - required: - - body - examples: - default: - summary: Creating a comment in a gist - value: - body: This is a comment to a gist - responses: - '201': - description: Response - content: - application/json: - schema: *98 - examples: - default: &99 - value: - id: 1 - node_id: MDExOkdpc3RDb21tZW50MQ== - url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 - body: Just commenting for the sake of commenting - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-18T23:23:56Z' - updated_at: '2011-04-18T23:23:56Z' - author_association: COLLABORATOR - headers: - Location: - example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 - schema: - type: string - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: comments - "/gists/{gist_id}/comments/{comment_id}": - get: - summary: Get a gist comment - description: |- - Gets a comment on a gist. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/get-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/comments#get-a-gist-comment - parameters: - - *97 - - &101 - name: comment_id - description: The unique identifier of the comment. - in: path - required: true - schema: - type: integer - format: int64 - responses: - '200': - description: Response - content: - application/json: - schema: *98 - examples: - default: *99 - '304': *37 - '404': *6 - '403': *100 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: comments - patch: - summary: Update a gist comment - description: |- - Updates a comment on a gist. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/update-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/comments#update-a-gist-comment - parameters: - - *97 - - *101 - requestBody: - required: true - content: - application/json: - schema: - properties: - body: - description: The comment text. - type: string - maxLength: 65535 - example: Body of the attachment - type: object - required: - - body - examples: - default: - summary: Updating a comment in a gist - value: - body: This is an update to a comment in a gist - responses: - '200': - description: Response - content: - application/json: - schema: *98 - examples: - default: *99 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: comments - delete: - summary: Delete a gist comment - description: '' - tags: - - gists - operationId: gists/delete-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment - parameters: - - *97 - - *101 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: comments - "/gists/{gist_id}/commits": - get: - summary: List gist commits - description: '' - tags: - - gists - operationId: gists/list-commits - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#list-gist-commits - parameters: - - *97 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Gist Commit - description: Gist Commit - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f - version: - type: string - example: 57a7f021a713b1c5a6a199b54cc514735d2d462f - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - change_status: - type: object - properties: - total: - type: integer - additions: - type: integer - deletions: - type: integer - committed_at: - type: string - format: date-time - example: '2010-04-14T02:15:15Z' - required: - - url - - user - - version - - committed_at - - change_status - examples: - default: - value: - - url: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f - version: 57a7f021a713b1c5a6a199b54cc514735d2d462f - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - change_status: - deletions: 0 - additions: 180 - total: 180 - committed_at: '2010-04-14T02:15:15Z' - headers: - Link: - example: ; rel="next" - schema: - type: string - '404': *6 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/{gist_id}/forks": - get: - summary: List gist forks - description: '' - tags: - - gists - operationId: gists/list-forks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#list-gist-forks - parameters: - - *97 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *95 - examples: - default: - value: - - url: https://api.github.com/gists/aa5a315d61ae9438b18d - forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks - commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits - id: aa5a315d61ae9438b18d - node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk - git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git - git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git - html_url: https://gist.github.com/aa5a315d61ae9438b18d - files: - hello_world.rb: - filename: hello_world.rb - type: application/x-ruby - language: Ruby - raw_url: https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb - size: 167 - public: true - created_at: '2010-04-14T02:15:15Z' - updated_at: '2011-06-20T11:34:15Z' - description: Hello World Examples - comments: 1 - user: - comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '404': *6 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - post: - summary: Fork a gist - description: '' - tags: - - gists - operationId: gists/fork - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#fork-a-gist - parameters: - - *97 - responses: - '201': - description: Response - content: - application/json: - schema: *93 - examples: - default: - value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d - forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks - commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits - id: aa5a315d61ae9438b18d - node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk - git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git - git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git - html_url: https://gist.github.com/aa5a315d61ae9438b18d - files: - hello_world.rb: - filename: hello_world.rb - type: application/x-ruby - language: Ruby - raw_url: https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb - size: 167 - public: true - created_at: '2010-04-14T02:15:15Z' - updated_at: '2011-06-20T11:34:15Z' - description: Hello World Examples - comments: 0 - user: - comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - truncated: false - headers: - Location: - example: https://api.github.com/gists/aa5a315d61ae9438b18d - schema: - type: string - '404': *6 - '422': *15 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/{gist_id}/star": - get: - summary: Check if a gist is starred - description: '' - tags: - - gists - operationId: gists/check-is-starred - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred - parameters: - - *97 - responses: - '204': - description: Response if gist is starred - '404': - description: Not Found if gist is not starred - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - put: - summary: Star a gist - description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - tags: - - gists - operationId: gists/star - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#star-a-gist - parameters: - - *97 - responses: - '204': - description: Response - '404': *6 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - delete: - summary: Unstar a gist - description: '' - tags: - - gists - operationId: gists/unstar - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#unstar-a-gist - parameters: - - *97 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gists/{gist_id}/{sha}": - get: - summary: Get a gist revision - description: |- - Gets a specified gist revision. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - tags: - - gists - operationId: gists/get-revision - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#get-a-gist-revision - parameters: - - *97 - - name: sha - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *95 - examples: - default: *96 - '422': *15 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/gitignore/templates": - get: - summary: Get all gitignore templates - description: List all templates available to pass as an option when [creating - a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). - operationId: gitignore/get-all-templates - tags: - - gitignore - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: string - examples: - default: - value: - - Actionscript - - Android - - AppceleratorTitanium - - Autotools - - Bancha - - C - - C++ - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: gitignore - subcategory: gitignore - "/gitignore/templates/{name}": - get: - summary: Get a gitignore template - description: |- - Get the content of a gitignore template. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - operationId: gitignore/get-template - tags: - - gitignore - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template - parameters: - - name: name - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Gitignore Template - description: Gitignore Template - type: object - properties: - name: - type: string - example: C - source: - type: string - example: | - # Object files - *.o - - # Libraries - *.lib - *.a - - # Shared objects (inc. Windows DLLs) - *.dll - *.so - *.so.* - *.dylib - - # Executables - *.exe - *.out - *.app - required: - - name - - source - examples: - default: - value: - name: C - source: | - # Object files - *.o - - # Libraries - *.lib - *.a - - # Shared objects (inc. Windows DLLs) - *.dll - *.so - *.so.* - *.dylib - - # Executables - *.exe - *.out - *.app - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: gitignore - subcategory: gitignore - "/installation/repositories": - get: - summary: List repositories accessible to the app installation - description: List repositories that an app installation can access. - tags: - - apps - operationId: apps/list-repos-accessible-to-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: - allOf: - - *79 - repository_selection: - type: string - example: selected - examples: - default: - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - headers: - Link: *67 - '403': *29 - '304': *37 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: installations - "/installation/token": - delete: - summary: Revoke an installation access token - description: |- - Revokes the installation token you're using to authenticate as an installation and access this endpoint. - - Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - tags: - - apps - operationId: apps/revoke-installation-access-token - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token - parameters: [] - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: apps - subcategory: installations - "/issues": - get: - summary: List issues assigned to the authenticated user - description: |- - List issues assigned to the authenticated user across all visible repositories including owned repositories, member - repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - necessarily assigned to you. - - > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user - parameters: - - name: filter - description: Indicates which sorts of issues to return. `assigned` means issues - assigned to you. `created` means issues created by you. `mentioned` means - issues mentioning you. `subscribed` means issues you're subscribed to updates - for. `all` or `repos` means all issues you can see, regardless of participation - or creation. - in: query - required: false - schema: - type: string - enum: - - assigned - - created - - mentioned - - subscribed - - repos - - all - default: assigned - - name: state - description: Indicates the state of the issues to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - &246 - name: labels - description: 'A list of comma separated label names. Example: `bug,ui,@high`' - in: query - required: false - schema: - type: string - - name: sort - description: What to sort results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - comments - default: created - - *61 - - *92 - - name: collab - in: query - required: false - schema: - type: boolean - - name: orgs - in: query - required: false - schema: - type: boolean - - name: owned - in: query - required: false - schema: - type: boolean - - name: pulls - in: query - required: false - schema: - type: boolean - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: &247 - value: - - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - author_association: COLLABORATOR - headers: - Link: *67 - '422': *15 - '304': *37 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: issues - subcategory: issues - "/licenses": - get: - summary: Get all commonly used licenses - description: Lists the most commonly used licenses on GitHub. For more information, - see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - tags: - - licenses - operationId: licenses/get-all-commonly-used - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses - parameters: - - name: featured - in: query - required: false - schema: - type: boolean - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - examples: - default: - value: - - key: mit - name: MIT License - spdx_id: MIT - url: https://api.github.com/licenses/mit - node_id: MDc6TGljZW5zZW1pdA== - - key: lgpl-3.0 - name: GNU Lesser General Public License v3.0 - spdx_id: LGPL-3.0 - url: https://api.github.com/licenses/lgpl-3.0 - node_id: MDc6TGljZW5zZW1pdA== - - key: mpl-2.0 - name: Mozilla Public License 2.0 - spdx_id: MPL-2.0 - url: https://api.github.com/licenses/mpl-2.0 - node_id: MDc6TGljZW5zZW1pdA== - - key: agpl-3.0 - name: GNU Affero General Public License v3.0 - spdx_id: AGPL-3.0 - url: https://api.github.com/licenses/agpl-3.0 - node_id: MDc6TGljZW5zZW1pdA== - - key: unlicense - name: The Unlicense - spdx_id: Unlicense - url: https://api.github.com/licenses/unlicense - node_id: MDc6TGljZW5zZW1pdA== - - key: apache-2.0 - name: Apache License 2.0 - spdx_id: Apache-2.0 - url: https://api.github.com/licenses/apache-2.0 - node_id: MDc6TGljZW5zZW1pdA== - - key: gpl-3.0 - name: GNU General Public License v3.0 - spdx_id: GPL-3.0 - url: https://api.github.com/licenses/gpl-3.0 - node_id: MDc6TGljZW5zZW1pdA== - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: licenses - subcategory: licenses - "/licenses/{license}": - get: - summary: Get a license - description: Gets information about a specific license. For more information, - see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - tags: - - licenses - operationId: licenses/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/licenses/licenses#get-a-license - parameters: - - name: license - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: License - description: License - type: object - properties: - key: - type: string - example: mit - name: - type: string - example: MIT License - spdx_id: - type: string - example: MIT - nullable: true - url: - type: string - format: uri - example: https://api.github.com/licenses/mit - nullable: true - node_id: - type: string - example: MDc6TGljZW5zZW1pdA== - html_url: - type: string - format: uri - example: http://choosealicense.com/licenses/mit/ - description: - type: string - example: A permissive license that is short and to the point. - It lets people do anything with your code with proper attribution - and without warranty. - implementation: - type: string - example: Create a text file (typically named LICENSE or LICENSE.txt) - in the root of your source code and copy the text of the license - into the file. Replace [year] with the current year and [fullname] - with the name (or names) of the copyright holders. - permissions: - type: array - example: - - commercial-use - - modifications - - distribution - - sublicense - - private-use - items: - type: string - conditions: - type: array - example: - - include-copyright - items: - type: string - limitations: - type: array - example: - - no-liability - items: - type: string - body: - type: string - example: |2 - - - The MIT License (MIT) - - Copyright (c) [year] [fullname] - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. - featured: - type: boolean - example: true - required: - - key - - name - - url - - spdx_id - - node_id - - html_url - - description - - implementation - - permissions - - conditions - - limitations - - body - - featured - examples: - default: - value: - key: mit - name: MIT License - spdx_id: MIT - url: https://api.github.com/licenses/mit - node_id: MDc6TGljZW5zZW1pdA== - html_url: http://choosealicense.com/licenses/mit/ - description: A permissive license that is short and to the point. - It lets people do anything with your code with proper attribution - and without warranty. - implementation: Create a text file (typically named LICENSE or - LICENSE.txt) in the root of your source code and copy the text - of the license into the file. Replace [year] with the current - year and [fullname] with the name (or names) of the copyright - holders. - permissions: - - commercial-use - - modifications - - distribution - - sublicense - - private-use - conditions: - - include-copyright - limitations: - - no-liability - body: |2 - - - The MIT License (MIT) - - Copyright (c) [year] [fullname] - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. - featured: true - '403': *29 - '404': *6 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: licenses - subcategory: licenses - "/markdown": - post: - summary: Render a Markdown document - description: Depending on what is rendered in the Markdown, you may need to - provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. - operationId: markdown/render - tags: - - markdown - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/markdown/markdown#render-a-markdown-document - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - text: - description: The Markdown text to render in HTML. - type: string - mode: - description: The rendering mode. - enum: - - markdown - - gfm - default: markdown - example: markdown - type: string - context: - description: The repository context to use when creating references - in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` - will change the text `#42` into an HTML link to issue 42 in the - `octo-org/octo-repo` repository. - type: string - required: - - text - type: object - examples: - default: - summary: Rendering markdown - value: - text: Hello **world** - responses: - '200': - description: Response - headers: - Content-Type: - example: text/html - schema: - type: string - Content-Length: - example: '279' - schema: - type: string - X-CommonMarker-Version: &102 - example: 0.17.4 - schema: - type: string - content: - text/html: - schema: - type: string - examples: - default: - summary: Example response - value: "

Hello world

" - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: markdown - subcategory: markdown - "/markdown/raw": - post: - summary: Render a Markdown document in raw mode - description: You must send Markdown as plain text (using a `Content-Type` header - of `text/plain` or `text/x-markdown`) to this endpoint, rather than using - JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) - is not supported and Markdown will be rendered in plain format like a README.md - file. Markdown content must be 400 KB or less. - operationId: markdown/render-raw - tags: - - markdown - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode - parameters: [] - requestBody: - required: false - content: - text/plain: - schema: - type: string - examples: - default: - value: - text: Hello **world** - text/x-markdown: - schema: - type: string - examples: - default: - summary: Rendering markdown - value: - text: Hello **world** - responses: - '200': - description: Response - headers: - X-CommonMarker-Version: *102 - content: - text/html: - schema: - type: string - examples: - default: - summary: Example response - value: "

Hello world

" - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: markdown - subcategory: markdown - "/marketplace_listing/accounts/{account_id}": - get: - summary: Get a subscription plan for an account - description: |- - Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - - GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. - tags: - - apps - operationId: apps/get-subscription-plan-for-account - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account - parameters: - - &105 - name: account_id - description: account_id parameter - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &104 - title: Marketplace Purchase - description: Marketplace Purchase - type: object - properties: - url: - type: string - type: - type: string - id: - type: integer - login: - type: string - organization_billing_email: - type: string - email: - type: string - nullable: true - marketplace_pending_change: - type: object - properties: - is_installed: - type: boolean - effective_date: - type: string - unit_count: - type: integer - nullable: true - id: - type: integer - plan: &103 - title: Marketplace Listing Plan - description: Marketplace Listing Plan - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/marketplace_listing/plans/1313 - accounts_url: - type: string - format: uri - example: https://api.github.com/marketplace_listing/plans/1313/accounts - id: - type: integer - example: 1313 - number: - type: integer - example: 3 - name: - type: string - example: Pro - description: - type: string - example: A professional-grade CI solution - monthly_price_in_cents: - type: integer - example: 1099 - yearly_price_in_cents: - type: integer - example: 11870 - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - example: FLAT_RATE - has_free_trial: - type: boolean - example: true - unit_name: - type: string - nullable: true - state: - type: string - example: published - bullets: - type: array - items: - type: string - example: - - Up to 25 private repositories - - 11 concurrent builds - required: - - url - - accounts_url - - id - - number - - name - - description - - has_free_trial - - price_model - - unit_name - - monthly_price_in_cents - - state - - yearly_price_in_cents - - bullets - nullable: true - marketplace_purchase: - type: object - properties: - billing_cycle: - type: string - next_billing_date: - type: string - nullable: true - is_installed: - type: boolean - unit_count: - type: integer - nullable: true - on_free_trial: - type: boolean - free_trial_ends_on: - type: string - nullable: true - updated_at: - type: string - plan: *103 - required: - - url - - id - - type - - login - - marketplace_purchase - examples: - default: &106 - value: - url: https://api.github.com/orgs/github - type: Organization - id: 4 - login: github - organization_billing_email: billing@github.com - email: billing@github.com - marketplace_pending_change: - effective_date: '2017-11-11T00:00:00Z' - unit_count: - id: 77 - plan: - url: https://api.github.com/marketplace_listing/plans/1111 - accounts_url: https://api.github.com/marketplace_listing/plans/1111/accounts - id: 1111 - number: 2 - name: Startup - description: A professional-grade CI solution - monthly_price_in_cents: 699 - yearly_price_in_cents: 7870 - price_model: FLAT_RATE - has_free_trial: true - state: published - unit_name: - bullets: - - Up to 10 private repositories - - 3 concurrent builds - marketplace_purchase: - billing_cycle: monthly - next_billing_date: '2017-11-11T00:00:00Z' - unit_count: - on_free_trial: true - free_trial_ends_on: '2017-11-11T00:00:00Z' - updated_at: '2017-11-02T01:12:12Z' - plan: - url: https://api.github.com/marketplace_listing/plans/1313 - accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts - id: 1313 - number: 3 - name: Pro - description: A professional-grade CI solution - monthly_price_in_cents: 1099 - yearly_price_in_cents: 11870 - price_model: FLAT_RATE - has_free_trial: true - unit_name: - state: published - bullets: - - Up to 25 private repositories - - 11 concurrent builds - '404': - description: Not Found when the account has not purchased the listing - content: - application/json: - schema: *3 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/marketplace_listing/plans": - get: - summary: List plans - description: |- - Lists all plans that are part of your GitHub Marketplace listing. - - GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. - tags: - - apps - operationId: apps/list-plans - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#list-plans - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *103 - examples: - default: &107 - value: - - url: https://api.github.com/marketplace_listing/plans/1313 - accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts - id: 1313 - number: 3 - name: Pro - description: A professional-grade CI solution - monthly_price_in_cents: 1099 - yearly_price_in_cents: 11870 - price_model: FLAT_RATE - has_free_trial: true - unit_name: - state: published - bullets: - - Up to 25 private repositories - - 11 concurrent builds - headers: - Link: *67 - '404': *6 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/marketplace_listing/plans/{plan_id}/accounts": - get: - summary: List accounts for a plan - description: |- - Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - - GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. - tags: - - apps - operationId: apps/list-accounts-for-plan - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan - parameters: - - &108 - name: plan_id - description: The unique identifier of the plan. - in: path - required: true - schema: - type: integer - - &109 - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - name: direction - description: To return the oldest accounts first, set to `asc`. Ignored without - the `sort` parameter. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *104 - examples: - default: &110 - value: - - url: https://api.github.com/orgs/github - type: Organization - id: 4 - login: github - organization_billing_email: billing@github.com - marketplace_pending_change: - effective_date: '2017-11-11T00:00:00Z' - unit_count: - id: 77 - plan: - url: https://api.github.com/marketplace_listing/plans/1111 - accounts_url: https://api.github.com/marketplace_listing/plans/1111/accounts - id: 1111 - number: 2 - name: Startup - description: A professional-grade CI solution - monthly_price_in_cents: 699 - yearly_price_in_cents: 7870 - price_model: FLAT_RATE - has_free_trial: true - state: published - unit_name: - bullets: - - Up to 10 private repositories - - 3 concurrent builds - marketplace_purchase: - billing_cycle: monthly - next_billing_date: '2017-11-11T00:00:00Z' - unit_count: - on_free_trial: true - free_trial_ends_on: '2017-11-11T00:00:00Z' - updated_at: '2017-11-02T01:12:12Z' - plan: - url: https://api.github.com/marketplace_listing/plans/1313 - accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts - id: 1313 - number: 3 - name: Pro - description: A professional-grade CI solution - monthly_price_in_cents: 1099 - yearly_price_in_cents: 11870 - price_model: FLAT_RATE - has_free_trial: true - unit_name: - state: published - bullets: - - Up to 25 private repositories - - 11 concurrent builds - headers: - Link: *67 - '404': *6 - '422': *15 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/marketplace_listing/stubbed/accounts/{account_id}": - get: - summary: Get a subscription plan for an account (stubbed) - description: |- - Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - - GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. - tags: - - apps - operationId: apps/get-subscription-plan-for-account-stubbed - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed - parameters: - - *105 - responses: - '200': - description: Response - content: - application/json: - schema: *104 - examples: - default: *106 - '404': - description: Not Found when the account has not purchased the listing - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/marketplace_listing/stubbed/plans": - get: - summary: List plans (stubbed) - description: |- - Lists all plans that are part of your GitHub Marketplace listing. - - GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. - tags: - - apps - operationId: apps/list-plans-stubbed - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#list-plans-stubbed - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *103 - examples: - default: *107 - headers: - Link: *67 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/marketplace_listing/stubbed/plans/{plan_id}/accounts": - get: - summary: List accounts for a plan (stubbed) - description: |- - Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - - GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. - tags: - - apps - operationId: apps/list-accounts-for-plan-stubbed - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed - parameters: - - *108 - - *109 - - name: direction - description: To return the oldest accounts first, set to `asc`. Ignored without - the `sort` parameter. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *104 - examples: - default: *110 - headers: - Link: *67 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/meta": - get: - summary: Get GitHub meta information - description: |- - Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." - - The API's response also includes a list of GitHub's domain names. - - The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. - - > [!NOTE] - > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. - tags: - - meta - operationId: meta/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/meta/meta#get-apiname-meta-information - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - title: Api Overview - description: Api Overview - type: object - properties: - verifiable_password_authentication: - type: boolean - example: true - ssh_key_fingerprints: - type: object - properties: - SHA256_RSA: - type: string - SHA256_DSA: - type: string - SHA256_ECDSA: - type: string - SHA256_ED25519: - type: string - ssh_keys: - type: array - items: - type: string - example: - - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ - hooks: - type: array - items: - type: string - example: - - 192.0.2.1 - github_enterprise_importer: - type: array - items: - type: string - example: - - 192.0.2.1 - web: - type: array - items: - type: string - example: - - 192.0.2.1 - api: - type: array - items: - type: string - example: - - 192.0.2.1 - git: - type: array - items: - type: string - example: - - 192.0.2.1 - packages: - type: array - items: - type: string - example: - - 192.0.2.1 - pages: - type: array - items: - type: string - example: - - 192.0.2.1 - importer: - type: array - items: - type: string - example: - - 192.0.2.1 - actions: - type: array - items: - type: string - example: - - 192.0.2.1 - actions_macos: - type: array - items: - type: string - example: - - 192.0.2.1 - codespaces: - type: array - items: - type: string - example: - - 192.0.2.1 - dependabot: - type: array - items: - type: string - example: - - 192.0.2.1 - copilot: - type: array - items: - type: string - example: - - 192.0.2.1 - domains: - type: object - properties: - website: - type: array - items: - type: string - example: - - example.com - codespaces: - type: array - items: - type: string - example: - - example.com - copilot: - type: array - items: - type: string - example: - - example.com - packages: - type: array - items: - type: string - example: - - example.com - actions: - type: array - items: - type: string - example: - - example.com - actions_inbound: - type: object - properties: - full_domains: - type: array - items: - type: string - example: - - example.com - wildcard_domains: - type: array - items: - type: string - example: - - example.com - artifact_attestations: - type: object - properties: - trust_domain: - type: string - example: - - example - services: - type: array - items: - type: string - example: - - example.com - required: - - verifiable_password_authentication - examples: - default: - value: - verifiable_password_authentication: true - ssh_key_fingerprints: - SHA256_RSA: 1234567890 - SHA256_DSA: 1234567890 - SHA256_ECDSA: 1234567890 - SHA256_ED25519: 1234567890 - ssh_keys: - - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ - - ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ - - ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ - hooks: - - 192.0.2.1 - github_enterprise_importer: - - 192.0.2.1 - web: - - 192.0.2.1 - api: - - 192.0.2.1 - git: - - 192.0.2.1 - packages: - - 192.0.2.1 - pages: - - 192.0.2.1 - importer: - - 192.0.2.1 - actions: - - 192.0.2.1 - actions_macos: - - 192.0.2.1 - dependabot: - - 192.0.2.1 - copilot: - - 192.0.2.1 - domains: - website: - - "*.example.com" - codespaces: - - "*.example.com" - copilot: - - "*.example.com" - packages: - - "*.example.com" - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: meta - subcategory: meta - "/networks/{owner}/{repo}/events": - get: - summary: List public events for a network of repositories - description: |- - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-public-events-for-repo-network - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories - parameters: - - &344 - name: owner - description: The account owner of the repository. The name is not case sensitive. - in: path - required: true - schema: - type: string - - &345 - name: repo - description: The name of the repository without the `.git` extension. The - name is not case sensitive. - in: path - required: true - schema: - type: string - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - default: - value: - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22237752260' - type: WatchEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - action: started - public: true - created_at: '2022-06-08T23:29:25Z' - '404': *6 - '403': *29 - '304': *37 - '301': &348 - description: Moved permanently - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/notifications": - get: - summary: List notifications for the authenticated user - description: List all notifications for the current user, sorted by most recently - updated. - tags: - - activity - operationId: activity/list-notifications-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user - parameters: - - &584 - name: all - description: If `true`, show notifications marked as read. - in: query - required: false - schema: - type: boolean - default: false - - &585 - name: participating - description: If `true`, only shows notifications in which the user is directly - participating or mentioned. - in: query - required: false - schema: - type: boolean - default: false - - *92 - - &586 - name: before - description: 'Only show notifications updated before the given time. This - is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - format: date-time - - *19 - - name: per_page - description: The number of results per page (max 50). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 50 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &112 - title: Thread - description: Thread - type: object - properties: - id: - type: string - repository: &160 - title: Minimal Repository - description: Minimal Repository - type: object - properties: &211 - id: - type: integer - format: int64 - example: 1296269 - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - type: string - example: Hello-World - full_name: - type: string - example: octocat/Hello-World - owner: *4 - private: - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - stargazers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - mirror_url: - type: string - nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - homepage: - type: string - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - description: The size of the repository, in kilobytes. Size - is calculated hourly. When a repository is initially created, - the size is 0. - type: integer - default_branch: - type: string - open_issues_count: - type: integer - is_template: - type: boolean - topics: - type: array - items: - type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - has_discussions: - type: boolean - has_pull_requests: - type: boolean - pull_request_creation_policy: - description: 'The policy controlling who can create pull - requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - archived: - type: boolean - disabled: - type: boolean - visibility: - type: string - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - role_name: - type: string - example: admin - temp_clone_token: - type: string - delete_branch_on_merge: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer - code_of_conduct: *38 - license: - type: object - properties: - key: - type: string - name: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - node_id: - type: string - nullable: true - forks: - type: integer - example: 0 - open_issues: - type: integer - example: 0 - watchers: - type: integer - example: 0 - allow_forking: - type: boolean - web_commit_signoff_required: - type: boolean - example: false - security_and_analysis: &299 - nullable: true - type: object - properties: - advanced_security: - description: | - Enable or disable GitHub Advanced Security for the repository. - - For standalone Code Scanning or Secret Protection products, this parameter cannot be used. - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - code_security: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - dependabot_security_updates: - description: Enable or disable Dependabot security updates - for the repository. - type: object - properties: - status: - description: The enablement status of Dependabot - security updates for the repository. - type: string - enum: - - enabled - - disabled - secret_scanning: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - secret_scanning_push_protection: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - secret_scanning_non_provider_patterns: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - secret_scanning_ai_detection: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - secret_scanning_delegated_alert_dismissal: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - secret_scanning_delegated_bypass: - type: object - properties: - status: - type: string - enum: - - enabled - - disabled - secret_scanning_delegated_bypass_options: - type: object - properties: - reviewers: - type: array - description: The bypass reviewers for secret scanning - delegated bypass - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected - as a bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - mode: - type: string - description: The bypass mode for the reviewer - enum: - - ALWAYS - - EXEMPT - default: ALWAYS - custom_properties: - type: object - description: The custom properties that were defined for - the repository. The keys are the custom property names, - and the values are the corresponding custom property values. - additionalProperties: true - required: &212 - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - x-github-breaking-changes: &213 - - changeset: remove_has_downloads - patch: - properties: - has_downloads: - version: '2026-03-10' - subject: - type: object - properties: - title: - type: string - url: - type: string - latest_comment_url: - type: string - type: - type: string - required: - - title - - url - - latest_comment_url - - type - reason: - type: string - unread: - type: boolean - updated_at: - type: string - last_read_at: - type: string - nullable: true - url: - type: string - subscription_url: - type: string - example: https://api.github.com/notifications/threads/2/subscription - required: - - id - - unread - - reason - - updated_at - - last_read_at - - subject - - repository - - url - - subscription_url - examples: - default: &587 - value: - - id: '1' - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - subject: - title: Greetings - url: https://api.github.com/repos/octokit/octokit.rb/issues/123 - latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 - type: Issue - reason: subscribed - unread: true - updated_at: '2014-11-07T22:01:45Z' - last_read_at: '2014-11-07T22:01:45Z' - url: https://api.github.com/notifications/threads/1 - subscription_url: https://api.github.com/notifications/threads/1/subscription - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - put: - summary: Mark notifications as read - description: Marks all notifications as "read" for the current user. If the - number of notifications is too large to complete in one request, you will - receive a `202 Accepted` status and GitHub will run an asynchronous process - to mark notifications as "read." To check whether any "unread" notifications - remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) - endpoint and pass the query parameter `all=false`. - tags: - - activity - operationId: activity/mark-notifications-as-read - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#mark-notifications-as-read - parameters: [] - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - last_read_at: - description: 'Describes the last point that notifications were checked. - Anything updated since this time will not be marked as read. If - you omit this parameter, all notifications are marked as read. - This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.' - type: string - format: date-time - read: - description: Whether the notification has been read. - type: boolean - examples: - default: - value: - last_read_at: '2022-06-10T00:00:00Z' - read: true - responses: - '202': - description: Response - content: - application/json: - schema: - type: object - properties: - message: - type: string - examples: - default: - value: - message: Unread notifications couldn't be marked in a single request. - Notifications are being marked as read in the background. - '205': - description: Reset Content - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - "/notifications/threads/{thread_id}": - get: - summary: Get a thread - description: Gets information about a notification thread. - tags: - - activity - operationId: activity/get-thread - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#get-a-thread - parameters: - - &113 - name: thread_id - description: The unique identifier of the notification thread. This corresponds - to the value returned in the `id` field when you retrieve notifications - (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *112 - examples: - default: - value: - id: '1' - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - subject: - title: Greetings - url: https://api.github.com/repos/octokit/octokit.rb/issues/123 - latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 - type: Issue - reason: subscribed - unread: true - updated_at: '2014-11-07T22:01:45Z' - last_read_at: '2014-11-07T22:01:45Z' - url: https://api.github.com/notifications/threads/1 - subscription_url: https://api.github.com/notifications/threads/1/subscription - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - patch: - summary: Mark a thread as read - description: 'Marks a thread as "read." Marking a thread as "read" is equivalent - to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.' - tags: - - activity - operationId: activity/mark-thread-as-read - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read - parameters: - - *113 - responses: - '205': - description: Reset Content - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - delete: - summary: Mark a thread as done - description: 'Marks a thread as "done." Marking a thread as "done" is equivalent - to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.' - tags: - - activity - operationId: activity/mark-thread-as-done - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done - parameters: - - *113 - responses: - '204': - description: No content - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - "/notifications/threads/{thread_id}/subscription": - get: - summary: Get a thread subscription for the authenticated user - description: |- - This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription). - - Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - tags: - - activity - operationId: activity/get-thread-subscription-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user - parameters: - - *113 - responses: - '200': - description: Response - content: - application/json: - schema: &114 - title: Thread Subscription - description: Thread Subscription - type: object - properties: - subscribed: - type: boolean - example: true - ignored: - type: boolean - reason: - type: string - nullable: true - created_at: - type: string - format: date-time - example: '2012-10-06T21:34:12Z' - nullable: true - url: - type: string - format: uri - example: https://api.github.com/notifications/threads/1/subscription - thread_url: - type: string - format: uri - example: https://api.github.com/notifications/threads/1 - repository_url: - type: string - format: uri - example: https://api.github.com/repos/1 - required: - - created_at - - ignored - - reason - - url - - subscribed - examples: - default: &115 - value: - subscribed: true - ignored: false - reason: - created_at: '2012-10-06T21:34:12Z' - url: https://api.github.com/notifications/threads/1/subscription - thread_url: https://api.github.com/notifications/threads/1 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - put: - summary: Set a thread subscription - description: |- - If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - - You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - - Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. - tags: - - activity - operationId: activity/set-thread-subscription - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription - parameters: - - *113 - requestBody: - required: false - content: - application/json: - schema: - properties: - ignored: - description: Whether to block all notifications from a thread. - default: false - type: boolean - type: object - examples: - default: - value: - ignored: false - responses: - '200': - description: Response - content: - application/json: - schema: *114 - examples: - default: *115 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - delete: - summary: Delete a thread subscription - description: Mutes all future notifications for a conversation until you comment - on the thread or get an **@mention**. If you are watching the repository of - the thread, you will still receive notifications. To ignore future notifications - for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) - endpoint and set `ignore` to `true`. - tags: - - activity - operationId: activity/delete-thread-subscription - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription - parameters: - - *113 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - "/octocat": - get: - summary: Get Octocat - description: Get the octocat as ASCII art - tags: - - meta - operationId: meta/get-octocat - parameters: - - name: s - in: query - description: The words to show in Octocat's speech bubble - schema: - type: string - required: false - responses: - '200': - description: Response - content: - application/octocat-stream: - schema: - type: string - examples: - default: - value: |2 - MMM. .MMM - MMMMMMMMMMMMMMMMMMM - MMMMMMMMMMMMMMMMMMM ___________________________________ - MMMMMMMMMMMMMMMMMMMMM | | - MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. | - MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________| - MMMM::- -:::::::- -::MMMM |/ - MM~:~ 00~:::::~ 00~:~MM - .. MMMMM::.00:::+:::.00::MMMMM .. - .MM::::: ._. :::::MM. - MMMM;:::::;MMMM - -MM MMMMMMM - ^ M+ MMMMMMMMM - MMMMMMM MM MM MM - MM MM MM MM - MM MM MM MM - .~~MM~MM~MM~MM~~. - ~~~~MM:~MM~~~MM~:MM~~~~ - ~~~~~~==~==~~~==~==~~~~~~ - ~~~~~~==~==~==~==~~~~~~ - :~==~==~==~==~~ - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/meta/meta#get-octocat - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: meta - subcategory: meta - "/organizations": - get: - summary: List organizations - description: |- - Lists all organizations, in the order that they were created. - - > [!NOTE] - > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - tags: - - orgs - operationId: orgs/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-organizations - parameters: - - name: since - description: An organization ID. Only return organizations with an ID greater - than this ID. - in: query - required: false - schema: - type: integer - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *73 - examples: - default: *116 - headers: - Link: - example: ; rel="next" - schema: - type: string - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - "/organizations/{org}/actions/cache/retention-limit": - get: - summary: Get GitHub Actions cache retention limit for an organization - description: |- - Gets GitHub Actions cache retention limit for an organization. All repositories under this - organization may not set a higher cache retention limit. - - OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-retention-limit-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &117 - title: Actions cache retention limit for an organization - description: GitHub Actions cache retention policy for an organization. - type: object - properties: - max_cache_retention_days: - description: For repositories in this organization, the maximum - duration, in days, for which caches in a repository may be retained. - type: integer - example: 14 - examples: - default: *42 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - put: - summary: Set GitHub Actions cache retention limit for an organization - description: |- - Sets GitHub Actions cache retention limit for an organization. All repositories under this - organization may not set a higher cache retention limit. - - OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. - tags: - - actions - operationId: actions/set-actions-cache-retention-limit-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: *117 - examples: - selected_actions: *42 - responses: - '204': - description: Response - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/organizations/{org}/actions/cache/storage-limit": - get: - summary: Get GitHub Actions cache storage limit for an organization - description: |- - Gets GitHub Actions cache storage limit for an organization. All repositories under this - organization may not set a higher cache storage limit. - - OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-storage-limit-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &118 - title: Actions cache storage limit for an organization - description: GitHub Actions cache storage policy for an organization. - type: object - properties: - max_cache_size_gb: - description: For repositories in the organization, the maximum - size limit for the sum of all caches in a repository, in gigabytes. - type: integer - example: 10 - examples: - default: *44 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - put: - summary: Set GitHub Actions cache storage limit for an organization - description: |- - Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this - organization may not set a higher cache storage limit. - - OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. - tags: - - actions - operationId: actions/set-actions-cache-storage-limit-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: *118 - examples: - selected_actions: *44 - responses: - '204': - description: Response - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/organizations/{org}/dependabot/repository-access": - get: - summary: Lists the repositories Dependabot can access in an organization - description: |- - Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. - > [!NOTE] - > This operation supports both server-to-server and user-to-server access. - Unauthorized users will not see the existence of this endpoint. - tags: - - dependabot - operationId: dependabot/repository-access-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization - parameters: - - *75 - - name: page - in: query - description: The page number of results to fetch. - required: false - schema: - type: integer - minimum: 1 - default: 1 - - name: per_page - in: query - description: Number of results per page. - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Dependabot Repository Access Details - description: Information about repositories that Dependabot is able - to access in an organization - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot - updates. - enum: - - public - - internal - example: internal - nullable: true - accessible_repositories: - type: array - items: - title: Simple Repository - description: A GitHub repository. - type: object - properties: *119 - required: *120 - nullable: true - additionalProperties: false - examples: - default: - value: - default_level: public - accessible_repositories: - - id: 123456 - node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= - name: example-repo - full_name: octocat/example-repo - owner: - name: octocat - email: octo@github.com - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://avatars.githubusercontent.com/u/1?v=4 - gravatar_id: 1 - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat/example-repo - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - starred_at: '"2020-07-09T00:17:55Z"' - user_view_type: default - private: false - html_url: https://github.com/octocat/example-repo - description: This is an example repository. - fork: false - url: https://api.github.com/repos/octocat/example-repo - archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} - commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} - compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/example-repo/contributors - deployments_url: https://api.github.com/repos/octocat/example-repo/deployments - downloads_url: https://api.github.com/repos/octocat/example-repo/downloads - events_url: https://api.github.com/repos/octocat/example-repo/events - forks_url: https://api.github.com/repos/octocat/example-repo/forks - git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} - keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} - languages_url: https://api.github.com/repos/octocat/example-repo/languages - merges_url: https://api.github.com/repos/octocat/example-repo/merges - milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} - releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers - statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/example-repo/subscription - tags_url: https://api.github.com/repos/octocat/example-repo/tags - teams_url: https://api.github.com/repos/octocat/example-repo/teams - trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/example-repo/hooks - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: repository-access - patch: - summary: Updates Dependabot's repository access list for an organization - description: |- - Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. - - > [!NOTE] - > This operation supports both server-to-server and user-to-server access. - Unauthorized users will not see the existence of this endpoint. - - **Example request body:** - ```json - { - "repository_ids_to_add": [123, 456], - "repository_ids_to_remove": [789] - } - ``` - tags: - - dependabot - operationId: dependabot/update-repository-access-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - repository_ids_to_add: - type: array - items: - type: integer - description: List of repository IDs to add. - repository_ids_to_remove: - type: array - items: - type: integer - description: List of repository IDs to remove. - example: - repository_ids_to_add: - - 123 - - 456 - repository_ids_to_remove: - - 789 - examples: - '204': - summary: Example with a 'succeeded' status. - add-example: - summary: Add repositories - value: - repository_ids_to_add: - - 123 - - 456 - remove-example: - summary: Remove repositories - value: - repository_ids_to_remove: - - 789 - responses: - '204': - description: Response - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: repository-access - "/organizations/{org}/dependabot/repository-access/default-level": - put: - summary: Set the default repository access level for Dependabot - description: |- - Sets the default level of repository access Dependabot will have while performing an update. Available values are: - - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. - - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. - - Unauthorized users will not see the existence of this endpoint. - - This operation supports both server-to-server and user-to-server access. - tags: - - dependabot - operationId: dependabot/set-repository-access-default-level - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - default_level: - type: string - description: The default repository access level for Dependabot - updates. - enum: - - public - - internal - example: internal - required: - - default_level - examples: - '204': - summary: Example with a 'succeeded' status. - value: - default_level: public - responses: - '204': - description: Response - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: repository-access - "/organizations/{org}/settings/billing/budgets": - get: - summary: Get all budgets for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. - Each page returns up to 10 budgets. - tags: - - billing - operationId: billing/get-all-budgets-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization - parameters: - - *75 - - name: page - description: The page number of the results to fetch. - in: query - schema: - type: integer - default: 1 - - name: per_page - description: The number of results per page (max 10). - in: query - schema: - type: integer - default: 10 - - name: scope - description: Filter budgets by scope type. - in: query - schema: - type: string - enum: - - enterprise - - organization - - repository - - cost_center - responses: - '200': - description: Response when getting all budgets - content: - application/json: - schema: - type: object - properties: - budgets: - type: array - items: - type: object - properties: - id: - type: string - description: The unique identifier for the budget - example: 2066deda-923f-43f9-88d2-62395a28c0cdd - budget_type: - description: The type of pricing for the budget - example: SkuPricing - oneOf: - - type: string - enum: - - SkuPricing - - type: string - enum: - - ProductPricing - budget_amount: - type: integer - description: The budget amount limit in whole dollars. For - license-based products, this represents the number of - licenses. - prevent_further_usage: - type: boolean - description: The type of limit enforcement for the budget - example: true - budget_scope: - type: string - description: The scope of the budget (enterprise, organization, - repository, cost center) - example: enterprise - budget_entity_name: - type: string - description: The name of the entity for the budget (enterprise - does not require a name). - example: octocat/hello-world - budget_product_sku: - type: string - description: A single product or sku to apply the budget - to. - budget_alerting: - type: object - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - example: true - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - example: - - mona - - lisa - required: - - will_alert - - alert_recipients - required: - - id - - budget_type - - budget_product_sku - - budget_scope - - budget_amount - - prevent_further_usage - - budget_alerting - description: Array of budget objects for the enterprise - has_next_page: - type: boolean - description: Indicates if there are more pages of results available - (maps to hasNextPage from billing platform) - total_count: - type: integer - description: Total number of budgets matching the query - required: - - budgets - examples: - default: - value: - budgets: - - id: 2066deda-923f-43f9-88d2-62395a28c0cdd - budget_type: ProductPricing - budget_product_skus: - - actions - budget_scope: enterprise - budget_amount: 1000.0 - prevent_further_usage: true - budget_alerting: - will_alert: true - alert_recipients: - - enterprise-admin - - billing-manager - - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 - budget_type: SkuPricing - budget_product_skus: - - actions_linux - budget_scope: organization - budget_amount: 500.0 - prevent_further_usage: false - budget_alerting: - will_alert: true - alert_recipients: - - org-owner - - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 - budget_type: ProductPricing - budget_product_skus: - - packages - budget_scope: cost_center - budget_amount: 250.0 - prevent_further_usage: true - budget_alerting: - will_alert: false - alert_recipients: [] - has_next_page: false - total_count: 3 - '404': *6 - '403': *29 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: budgets - "/organizations/{org}/settings/billing/budgets/{budget_id}": - get: - summary: Get a budget by ID for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets a budget by ID. The authenticated user must be an organization admin or billing manager. - tags: - - billing - operationId: billing/get-budget-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization - parameters: - - *75 - - &122 - name: budget_id - description: The ID corresponding to the budget. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response when updating a budget - content: - application/json: - schema: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_scope: - type: string - description: The type of scope for the budget - example: enterprise - enum: - - enterprise - - organization - - repository - - cost_center - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - example: octocat/hello-world - budget_amount: - type: integer - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the budget - is exceeded - example: true - budget_product_sku: - type: string - description: A single product or sku to apply the budget to. - example: actions_linux - budget_type: - description: The type of pricing for the budget - example: ProductPricing - oneOf: - - type: string - enum: - - ProductPricing - - type: string - enum: - - SkuPricing - budget_alerting: - type: object - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - example: true - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive alerts - example: - - mona - - lisa - required: - - id - - budget_amount - - prevent_further_usage - - budget_product_sku - - budget_type - - budget_alerting - - budget_scope - - budget_entity_name - examples: - default: - value: - id: 2066deda-923f-43f9-88d2-62395a28c0cdd - budget_type: ProductPricing - budget_product_sku: actions_linux - budget_scope: repository - budget_entity_name: example-repo-name - budget_amount: 0.0 - prevent_further_usage: true - budget_alerting: - will_alert: true - alert_recipients: - - mona - - lisa - '400': *14 - '404': *6 - '403': *29 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: budgets - patch: - summary: Update a budget for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. - tags: - - billing - operationId: billing/update-budget-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization - parameters: - - *75 - - *122 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - budget_amount: - type: integer - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the budget - is exceeded - budget_alerting: - type: object - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - enterprise - - organization - - repository - - cost_center - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - budget_type: - description: The type of pricing for the budget - oneOf: - - type: string - enum: - - ProductPricing - - type: string - enum: - - SkuPricing - budget_product_sku: - type: string - description: A single product or SKU that will be covered in the - budget - examples: - update-budget: - summary: Update budget example - value: - prevent_further_usage: false - budget_amount: 10 - budget_alerting: - will_alert: false - alert_recipients: [] - responses: - '200': - description: Budget updated successfully - content: - application/json: - schema: - type: object - properties: - message: - type: string - example: Budget successfully updated. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - enterprise - - organization - - repository - - cost_center - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - oneOf: - - type: string - enum: - - ProductPricing - - type: string - enum: - - SkuPricing - budget_product_sku: - type: string - description: A single product or SKU that will be covered - in the budget - examples: - update-budget: - value: - message: Budget successfully updated. - budget: - id: 2066deda-923f-43f9-88d2-62395a28c0cdd - budget_type: ProductPricing - budget_product_sku: actions_linux - budget_scope: repository - budget_entity_name: org-name/example-repo-name - budget_amount: 0.0 - prevent_further_usage: true - budget_alerting: - will_alert: true - alert_recipients: - - mona - - lisa - '400': *14 - '401': *25 - '403': *29 - '404': - description: Budget not found or feature not enabled - content: - application/json: - schema: *3 - examples: - budget-not-found: - value: - message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not - found. - documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget - feature-not-enabled: - value: - message: Not Found - documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget - '422': *15 - '500': - description: Internal server error - content: - application/json: - schema: *3 - examples: - server-error: - value: - message: Unable to update budget. - documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: budgets - delete: - summary: Delete a budget for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. - tags: - - billing - operationId: billing/delete-budget-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization - parameters: - - *75 - - *122 - responses: - '200': - description: Response when deleting a budget - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A message indicating the result of the deletion operation - id: - type: string - description: The ID of the deleted budget - required: - - message - - id - examples: - default: - value: - message: Budget successfully deleted. - budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b - '400': *14 - '404': *6 - '403': *29 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: budgets - "/organizations/{org}/settings/billing/premium_request/usage": - get: - summary: Get billing premium request usage report for an organization - description: |- - Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. - - **Note:** Only data from the past 24 months is accessible via this endpoint. - tags: - - billing - operationId: billing/get-github-billing-premium-request-usage-report-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization - parameters: - - *75 - - &123 - name: year - description: If specified, only return results for a single year. The value - of `year` is an integer with four digits representing a year. For example, - `2025`. Default value is the current year. - in: query - required: false - schema: - type: integer - - &125 - name: month - description: If specified, only return results for a single month. The value - of `month` is an integer between `1` and `12`. Default value is the current - month. If no year is specified the default `year` is used. - in: query - required: false - schema: - type: integer - - &124 - name: day - description: If specified, only return results for a single day. The value - of `day` is an integer between `1` and `31`. If no `year` or `month` is - specified, the default `year` and `month` are used. - in: query - required: false - schema: - type: integer - - name: user - description: The user name to query usage for. The name is not case sensitive. - in: query - required: false - schema: - type: string - - &735 - name: model - description: The model name to query usage for. The name is not case sensitive. - in: query - required: false - schema: - type: string - - &126 - name: product - description: The product name to query usage for. The name is not case sensitive. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response when getting a billing premium request usage report - content: - application/json: - schema: - type: object - properties: - timePeriod: - type: object - properties: - year: - type: integer - description: The year for the usage report. - month: - type: integer - description: The month for the usage report. - day: - type: integer - description: The day for the usage report. - required: - - year - organization: - type: string - description: The unique identifier of the organization. - user: - type: string - description: The name of the user for the usage report. - product: - type: string - description: The product for the usage report. - model: - type: string - description: The model for the usage report. - usageItems: - type: array - items: - type: object - properties: - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - model: - type: string - description: Model name. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossQuantity: - type: number - description: Gross quantity of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountQuantity: - type: number - description: Discount quantity of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netQuantity: - type: number - description: Net quantity of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - required: - - product - - sku - - model - - unitType - - pricePerUnit - - grossQuantity - - grossAmount - - discountQuantity - - discountAmount - - netQuantity - - netAmount - required: - - timePeriod - - organization - - usageItems - examples: - default: - value: - timePeriod: - year: 2025 - organization: GitHub - usageItems: - - product: Copilot - sku: Copilot Premium Request - model: GPT-5 - unitType: requests - pricePerUnit: 0.04 - grossQuantity: 100 - grossAmount: 4.0 - discountQuantity: 0 - discountAmount: 0.0 - netQuantity: 100 - netAmount: 4.0 - '400': *14 - '403': *29 - '404': *6 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: usage - "/organizations/{org}/settings/billing/usage": - get: - summary: Get billing usage report for an organization - description: |- - Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. - - **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." - tags: - - billing - operationId: billing/get-github-billing-usage-report-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization - parameters: - - *75 - - *123 - - &736 - name: month - description: If specified, only return results for a single month. The value - of `month` is an integer between `1` and `12`. If no year is specified the - default `year` is used. - in: query - required: false - schema: - type: integer - - *124 - responses: - '200': - description: Billing usage report response for an organization - content: - application/json: - schema: - type: object - properties: - usageItems: - type: array - items: - type: object - properties: - date: - type: string - description: Date of the usage line item. - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - quantity: - type: integer - description: Quantity of the usage line item. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - organizationName: - type: string - description: Name of the organization. - repositoryName: - type: string - description: Name of the repository. - required: - - date - - product - - sku - - quantity - - unitType - - pricePerUnit - - grossAmount - - discountAmount - - netAmount - - organizationName - examples: - default: - value: - usageItems: - - date: '2023-08-01' - product: Actions - sku: Actions Linux - quantity: 100 - unitType: minutes - pricePerUnit: 0.008 - grossAmount: 0.8 - discountAmount: 0 - netAmount: 0.8 - organizationName: GitHub - repositoryName: github/example - '400': *14 - '403': *29 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: usage - "/organizations/{org}/settings/billing/usage/summary": - get: - summary: Get billing usage summary for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. - - **Note:** Only data from the past 24 months is accessible via this endpoint. - tags: - - billing - operationId: billing/get-github-billing-usage-summary-report-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization - parameters: - - *75 - - *123 - - *125 - - *124 - - &737 - name: repository - description: The repository name to query for usage in the format owner/repository. - in: query - required: false - schema: - type: string - - *126 - - &738 - name: sku - description: The SKU to query for usage. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response when getting a billing usage summary - content: - application/json: - schema: - type: object - properties: - timePeriod: - type: object - properties: - year: - type: integer - description: The year for the usage report. - month: - type: integer - description: The month for the usage report. - day: - type: integer - description: The day for the usage report. - required: - - year - organization: - type: string - description: The unique identifier of the organization. - repository: - type: string - description: The name of the repository for the usage report. - product: - type: string - description: The product for the usage report. - sku: - type: string - description: The SKU for the usage report. - usageItems: - type: array - items: - type: object - properties: - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossQuantity: - type: number - description: Gross quantity of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountQuantity: - type: number - description: Discount quantity of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netQuantity: - type: number - description: Net quantity of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - required: - - product - - sku - - unitType - - pricePerUnit - - grossQuantity - - grossAmount - - discountQuantity - - discountAmount - - netQuantity - - netAmount - required: - - timePeriod - - organization - - usageItems - examples: - default: - value: - timePeriod: - year: 2025 - organization: GitHub - usageItems: - - product: Actions - sku: actions_linux - unitType: minutes - pricePerUnit: 0.008 - grossQuantity: 1000 - grossAmount: 8.0 - discountQuantity: 0 - discountAmount: 0.0 - netQuantity: 1000 - netAmount: 8.0 - '400': *14 - '403': *29 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: usage - "/orgs/{org}": - get: - summary: Get an organization - description: |- - Gets information about an organization. - - When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). - - To see the full details about an organization, the authenticated user must be an organization owner. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. - - To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. - tags: - - orgs - operationId: orgs/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#get-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &127 - title: Organization Full - description: Organization Full - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - name: - type: string - example: github - company: - type: string - example: GitHub - blog: - type: string - format: uri - example: https://github.com/blog - location: - type: string - example: San Francisco - email: - type: string - format: email - example: octocat@github.com - twitter_username: - type: string - example: github - nullable: true - is_verified: - type: boolean - example: true - has_organization_projects: - type: boolean - example: true - has_repository_projects: - type: boolean - example: true - public_repos: - type: integer - example: 2 - public_gists: - type: integer - example: 1 - followers: - type: integer - example: 20 - following: - type: integer - example: 0 - html_url: - type: string - format: uri - example: https://github.com/octocat - type: - type: string - example: Organization - total_private_repos: - type: integer - example: 100 - owned_private_repos: - type: integer - example: 100 - private_gists: - type: integer - example: 81 - nullable: true - disk_usage: - type: integer - example: 10000 - nullable: true - collaborators: - type: integer - example: 8 - nullable: true - description: |- - The number of collaborators on private repositories. - - This field may be null if the number of private repositories is over 50,000. - billing_email: - type: string - format: email - example: org@example.com - nullable: true - plan: - type: object - properties: - name: - type: string - space: - type: integer - private_repos: - type: integer - filled_seats: - type: integer - seats: - type: integer - required: - - name - - space - - private_repos - default_repository_permission: - type: string - nullable: true - default_repository_branch: - type: string - example: main - nullable: true - description: The default branch for repositories created in this - organization. - members_can_create_repositories: - type: boolean - example: true - nullable: true - two_factor_requirement_enabled: - type: boolean - example: true - nullable: true - members_allowed_repository_creation_type: - type: string - example: all - members_can_create_public_repositories: - type: boolean - example: true - members_can_create_private_repositories: - type: boolean - example: true - members_can_create_internal_repositories: - type: boolean - example: true - members_can_create_pages: - type: boolean - example: true - members_can_create_public_pages: - type: boolean - example: true - members_can_create_private_pages: - type: boolean - example: true - members_can_delete_repositories: - type: boolean - example: true - members_can_change_repo_visibility: - type: boolean - example: true - members_can_invite_outside_collaborators: - type: boolean - example: true - members_can_delete_issues: - type: boolean - example: true - display_commenter_full_name_setting_enabled: - type: boolean - example: true - readers_can_create_discussions: - type: boolean - example: true - members_can_create_teams: - type: boolean - example: true - members_can_view_dependency_insights: - type: boolean - example: true - members_can_fork_private_repositories: - type: boolean - example: false - nullable: true - web_commit_signoff_required: - type: boolean - example: false - advanced_security_enabled_for_new_repositories: - type: boolean - example: false - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. - - This field is only visible to organization owners or members of a team with the security manager role. - deprecated: true - dependabot_alerts_enabled_for_new_repositories: - type: boolean - example: false - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. - - This field is only visible to organization owners or members of a team with the security manager role. - deprecated: true - dependabot_security_updates_enabled_for_new_repositories: - type: boolean - example: false - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. - - This field is only visible to organization owners or members of a team with the security manager role. - deprecated: true - dependency_graph_enabled_for_new_repositories: - type: boolean - example: false - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. - - This field is only visible to organization owners or members of a team with the security manager role. - deprecated: true - secret_scanning_enabled_for_new_repositories: - type: boolean - example: false - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. - - This field is only visible to organization owners or members of a team with the security manager role. - deprecated: true - secret_scanning_push_protection_enabled_for_new_repositories: - type: boolean - example: false - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. - - This field is only visible to organization owners or members of a team with the security manager role. - deprecated: true - secret_scanning_push_protection_custom_link_enabled: - type: boolean - example: false - description: Whether a custom link is shown to contributors who - are blocked from pushing a secret by push protection. - secret_scanning_push_protection_custom_link: - type: string - example: https://github.com/test-org/test-repo/blob/main/README.md - nullable: true - description: An optional URL string to display to contributors - who are blocked from pushing a secret. - created_at: - type: string - format: date-time - example: '2008-01-14T04:33:35Z' - updated_at: - type: string - format: date-time - archived_at: - type: string - format: date-time - nullable: true - deploy_keys_enabled_for_repositories: - type: boolean - example: false - description: Controls whether or not deploy keys may be added - and used for repositories in the organization. - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - - html_url - - has_organization_projects - - has_repository_projects - - public_repos - - public_gists - - followers - - following - - type - - created_at - - updated_at - - archived_at - x-github-breaking-changes: - - changeset: remove_secret_scanning_custom_link_enablement_field - patch: - - op: remove - path: "/properties/secret_scanning_push_protection_custom_link_enabled" - version: '2026-03-10' - examples: - default-response: &128 - value: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: github - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - twitter_username: github - is_verified: true - has_organization_projects: true - has_repository_projects: true - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - html_url: https://github.com/octocat - created_at: '2008-01-14T04:33:35Z' - type: Organization - total_private_repos: 100 - owned_private_repos: 100 - private_gists: 81 - disk_usage: 10000 - collaborators: 8 - billing_email: mona@github.com - plan: - name: Medium - space: 400 - private_repos: 20 - filled_seats: 4 - seats: 5 - default_repository_permission: read - default_repository_branch: main - members_can_create_repositories: true - two_factor_requirement_enabled: true - members_allowed_repository_creation_type: all - members_can_create_public_repositories: false - members_can_create_private_repositories: false - members_can_create_internal_repositories: false - members_can_create_pages: true - members_can_create_public_pages: true - members_can_create_private_pages: true - members_can_delete_repositories: true - members_can_change_repo_visibility: true - members_can_invite_outside_collaborators: true - members_can_delete_issues: false - display_commenter_full_name_setting_enabled: false - readers_can_create_discussions: true - members_can_create_teams: true - members_can_view_dependency_insights: true - members_can_fork_private_repositories: false - web_commit_signoff_required: false - updated_at: '2014-03-03T18:58:10Z' - deploy_keys_enabled_for_repositories: false - dependency_graph_enabled_for_new_repositories: false - dependabot_alerts_enabled_for_new_repositories: false - dependabot_security_updates_enabled_for_new_repositories: false - advanced_security_enabled_for_new_repositories: false - secret_scanning_enabled_for_new_repositories: false - secret_scanning_push_protection_enabled_for_new_repositories: false - secret_scanning_push_protection_custom_link: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md - secret_scanning_push_protection_custom_link_enabled: false - x-github-breaking-changes: - - changeset: remove_secret_scanning_custom_link_enablement_field - patch: - - op: remove - path: "/value/secret_scanning_push_protection_custom_link_enabled" - version: '2026-03-10' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - patch: - summary: Update an organization - description: |- - > [!WARNING] - > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - - > [!WARNING] - > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). - - Updates the organization's profile and member privileges. - - The authenticated user must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - tags: - - orgs - operationId: orgs/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#update-an-organization - parameters: - - *75 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - billing_email: - type: string - description: Billing email address. This address is not publicized. - company: - type: string - description: The company name. - email: - type: string - description: The publicly visible email address. - twitter_username: - type: string - description: The Twitter username of the company. - location: - type: string - description: The location. - name: - type: string - description: The shorthand name of the company. - description: - type: string - description: The description of the company. The maximum size is - 160 characters. - has_organization_projects: - type: boolean - description: Whether an organization can use organization projects. - has_repository_projects: - type: boolean - description: Whether repositories that belong to the organization - can use repository projects. - default_repository_permission: - type: string - description: Default permission level members have for organization - repositories. - enum: - - read - - write - - admin - - none - default: read - members_can_create_repositories: - type: boolean - description: Whether of non-admin organization members can create - repositories. **Note:** A parameter can override this parameter. - See `members_allowed_repository_creation_type` in this table for - details. - default: true - members_can_create_internal_repositories: - type: boolean - description: Whether organization members can create internal repositories, - which are visible to all enterprise members. You can only allow - members to create internal repositories if your organization is - associated with an enterprise account using GitHub Enterprise - Cloud or GitHub Enterprise Server 2.20+. For more information, - see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" - in the GitHub Help documentation. - members_can_create_private_repositories: - type: boolean - description: Whether organization members can create private repositories, - which are visible to organization members with permission. For - more information, see "[Restricting repository creation in your - organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" - in the GitHub Help documentation. - members_can_create_public_repositories: - type: boolean - description: Whether organization members can create public repositories, - which are visible to anyone. For more information, see "[Restricting - repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" - in the GitHub Help documentation. - members_allowed_repository_creation_type: - type: string - description: "Specifies which types of repositories non-admin organization - members can create. `private` is only available to repositories - that are part of an organization on GitHub Enterprise Cloud. \n**Note:** - This parameter is closing down and will be removed in the future. - Its return value ignores internal repositories. Using this parameter - overrides values set in `members_can_create_repositories`. See - the parameter deprecation notice in the operation description - for details." - enum: - - all - - private - - none - members_can_create_pages: - type: boolean - description: Whether organization members can create GitHub Pages - sites. Existing published sites will not be impacted. - default: true - members_can_create_public_pages: - type: boolean - description: Whether organization members can create public GitHub - Pages sites. Existing published sites will not be impacted. - default: true - members_can_create_private_pages: - type: boolean - description: Whether organization members can create private GitHub - Pages sites. Existing published sites will not be impacted. - default: true - members_can_fork_private_repositories: - type: boolean - description: Whether organization members can fork private organization - repositories. - default: false - web_commit_signoff_required: - type: boolean - description: Whether contributors to organization repositories are - required to sign off on commits they make through GitHub's web - interface. - default: false - blog: - type: string - example: '"http://github.blog"' - advanced_security_enabled_for_new_repositories: - type: boolean - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - deprecated: true - dependabot_alerts_enabled_for_new_repositories: - type: boolean - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - deprecated: true - dependabot_security_updates_enabled_for_new_repositories: - type: boolean - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - deprecated: true - dependency_graph_enabled_for_new_repositories: - type: boolean - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - deprecated: true - secret_scanning_enabled_for_new_repositories: - type: boolean - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - deprecated: true - secret_scanning_push_protection_enabled_for_new_repositories: - type: boolean - description: |- - **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. - - Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - deprecated: true - secret_scanning_push_protection_custom_link_enabled: - type: boolean - description: Whether a custom link is shown to contributors who - are blocked from pushing a secret by push protection. - secret_scanning_push_protection_custom_link: - type: string - description: If `secret_scanning_push_protection_custom_link_enabled` - is true, the URL that will be displayed to contributors who are - blocked from pushing a secret. - deploy_keys_enabled_for_repositories: - type: boolean - description: Controls whether or not deploy keys may be added and - used for repositories in the organization. - examples: - default: - value: - billing_email: mona@github.com - company: GitHub - email: mona@github.com - twitter_username: github - location: San Francisco - name: github - description: GitHub, the company. - default_repository_permission: read - members_can_create_repositories: true - members_allowed_repository_creation_type: all - responses: - '200': - description: Response - content: - application/json: - schema: *127 - examples: - default: *128 - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - *129 - - *130 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - x-github-breaking-changes: - - changeset: remove_secret_scanning_custom_link_enablement_field - patch: - requestBody: - content: - application/json: - schema: - properties: - secret_scanning_push_protection_custom_link_enabled: - version: '2026-03-10' - delete: - summary: Delete an organization - description: |- - Deletes an organization and all its repositories. - - The organization login will be unavailable for 90 days after deletion. - - Please review the Terms of Service regarding account deletion before using this endpoint: - - https://docs.github.com/site-policy/github-terms/github-terms-of-service - operationId: orgs/delete - tags: - - orgs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#delete-an-organization - parameters: - - *75 - responses: - '202': *39 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - x-github-breaking-changes: - - changeset: change_delete_organization_trade_compliance_respose_status - patch: - responses: - '451': *15 - version: '2026-03-10' - "/orgs/{org}/actions/cache/usage": - get: - summary: Get GitHub Actions cache usage for an organization - description: |- - Gets the total GitHub Actions cache usage for an organization. - The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - - OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-usage-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_active_caches_count: - type: integer - description: The count of active caches across all repositories - of an enterprise or an organization. - total_active_caches_size_in_bytes: - type: integer - description: The total size in bytes of all active cache items - across all repositories of an enterprise or an organization. - required: - - total_active_caches_count - - total_active_caches_size_in_bytes - examples: - default: - value: - total_active_caches_size_in_bytes: 3344284 - total_active_caches_count: 5 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/orgs/{org}/actions/cache/usage-by-repository": - get: - summary: List repositories with GitHub Actions cache usage for an organization - description: |- - Lists repositories and their GitHub Actions cache usage for an organization. - The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - - OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-usage-by-repo-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repository_cache_usages - properties: - total_count: - type: integer - repository_cache_usages: - type: array - items: &355 - title: Actions Cache Usage by repository - description: GitHub Actions Cache Usage by repository. - type: object - properties: - full_name: - description: The repository owner and name for the cache - usage being shown. - type: string - example: octo-org/Hello-World - active_caches_size_in_bytes: - description: The sum of the size in bytes of all the active - cache items in the repository. - type: integer - example: 2322142 - active_caches_count: - description: The number of active caches in the repository. - type: integer - example: 3 - required: - - full_name - - active_caches_size_in_bytes - - active_caches_count - examples: - default: - value: - total_count: 2 - repository_cache_usages: - - full_name: octo-org/Hello-World - active_caches_size_in_bytes: 2322142 - active_caches_count: 3 - - full_name: octo-org/server - active_caches_size_in_bytes: 1022142 - active_caches_count: 2 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/orgs/{org}/actions/hosted-runners": - get: - summary: List GitHub-hosted runners for an organization - description: |- - Lists all GitHub-hosted runners configured in an organization. - - OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. - tags: - - actions - operationId: actions/list-hosted-runners-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - runners - properties: - total_count: - type: integer - runners: - type: array - items: &131 - title: GitHub-hosted hosted runner - description: A Github-hosted hosted runner. - type: object - properties: - id: - description: The unique identifier of the hosted runner. - type: integer - example: 5 - name: - description: The name of the hosted runner. - type: string - example: my-github-hosted-runner - runner_group_id: - description: The unique identifier of the group that the - hosted runner belongs to. - type: integer - example: 2 - image_details: - title: GitHub-hosted runner image details. - description: Provides details of a hosted runner image - type: object - properties: - id: - description: The ID of the image. Use this ID for the - `image` parameter when creating a new larger runner. - type: string - example: ubuntu-20.04 - size_gb: - description: Image size in GB. - type: integer - example: 86 - display_name: - description: Display name for this image. - type: string - example: 20.04 - source: - description: The image provider. - type: string - enum: - - github - - partner - - custom - version: - description: The image version of the hosted runner - pool. - type: string - example: latest - required: - - id - - size_gb - - display_name - - source - nullable: true - machine_size_details: &139 - title: Github-owned VM details. - description: Provides details of a particular machine spec. - type: object - properties: - id: - description: The ID used for the `size` parameter when - creating a new runner. - type: string - example: 8-core - cpu_cores: - description: The number of cores. - type: integer - example: 8 - memory_gb: - description: The available RAM for the machine spec. - type: integer - example: 32 - storage_gb: - description: The available SSD storage for the machine - spec. - type: integer - example: 300 - required: - - id - - cpu_cores - - memory_gb - - storage_gb - status: - description: The status of the runner. - type: string - example: Ready - enum: - - Ready - - Provisioning - - Shutdown - - Deleting - - Stuck - platform: - description: The operating system of the image. - type: string - example: linux-x64 - maximum_runners: - description: The maximum amount of hosted runners. Runners - will not scale automatically above this number. Use this - setting to limit your cost. - type: integer - default: 10 - example: 5 - public_ip_enabled: - description: Whether public IP is enabled for the hosted - runners. - type: boolean - example: true - public_ips: - description: The public IP ranges when public IP is enabled - for the hosted runners. - type: array - items: - title: Public IP for a GitHub-hosted larger runners. - description: Provides details of Public IP for a GitHub-hosted - larger runners - type: object - properties: - enabled: - description: Whether public IP is enabled. - type: boolean - example: true - prefix: - description: The prefix for the public IP. - type: string - example: 20.80.208.150 - length: - description: The length of the IP prefix. - type: integer - example: 28 - last_active_on: - description: The time at which the runner was last used, - in ISO 8601 format. - type: string - format: date-time - example: '2022-10-09T23:39:01Z' - nullable: true - image_gen: - type: boolean - description: Whether custom image generation is enabled - for the hosted runners. - required: - - id - - name - - image_details - - machine_size_details - - status - - public_ip_enabled - - platform - examples: - default: &159 - value: - total_count: 2 - runners: - - id: 5 - name: My hosted ubuntu runner - runner_group_id: 2 - platform: linux-x64 - image: - id: ubuntu-20.04 - size: 86 - machine_size_details: - id: 4-core - cpu_cores: 4 - memory_gb: 16 - storage_gb: 150 - status: Ready - maximum_runners: 10 - public_ip_enabled: true - public_ips: - - enabled: true - prefix: 20.80.208.150 - length: 31 - last_active_on: '2022-10-09T23:39:01Z' - - id: 7 - name: My hosted Windows runner - runner_group_id: 2 - platform: win-x64 - image: - id: windows-latest - size: 256 - machine_size_details: - id: 8-core - cpu_cores: 8 - memory_gb: 32 - storage_gb: 300 - status: Ready - maximum_runners: 20 - public_ip_enabled: false - public_ips: [] - last_active_on: '2023-04-26T15:23:37Z' - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - post: - summary: Create a GitHub-hosted runner for an organization - description: |- - Creates a GitHub-hosted runner for an organization. - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - operationId: actions/create-hosted-runner-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the runner. Must be between 1 and 64 characters - and may only contain upper and lowercase letters a-z, numbers - 0-9, '.', '-', and '_'. - type: string - image: - description: The image of runner. To list all available images, - use `GET /actions/hosted-runners/images/github-owned` or `GET - /actions/hosted-runners/images/partner`. - type: object - properties: - id: - description: The unique identifier of the runner image. - type: string - source: - description: The source of the runner image. - type: string - enum: - - github - - partner - - custom - version: - description: The version of the runner image to deploy. This - is relevant only for runners using custom images. - type: string - nullable: true - size: - description: The machine size of the runner. To list available sizes, - use `GET actions/hosted-runners/machine-sizes` - type: string - runner_group_id: - description: The existing runner group to add this runner to. - type: integer - maximum_runners: - description: The maximum amount of runners to scale up to. Runners - will not auto-scale above this number. Use this setting to limit - your cost. - type: integer - enable_static_ip: - description: Whether this runner should be created with a static - public IP. Note limit on account. To list limits on account, use - `GET actions/hosted-runners/limits` - type: boolean - image_gen: - description: Whether this runner should be used to generate custom - images. - type: boolean - default: false - required: - - name - - image - - size - - runner_group_id - examples: - default: - value: - name: My Hosted runner - image: - id: ubuntu-latest - source: github - runner_group_id: 1 - size: 4-core - maximum_runners: 50 - enable_static_ip: false - responses: - '201': - description: Response - content: - application/json: - schema: *131 - examples: - default: &140 - value: - id: 5 - name: My hosted ubuntu runner - runner_group_id: 2 - platform: linux-x64 - image: - id: ubuntu-20.04 - size: 86 - machine_size_details: - id: 4-core - cpu_cores: 4 - memory_gb: 16 - storage_gb: 150 - status: Ready - maximum_runners: 10 - public_ip_enabled: true - public_ips: - - enabled: true - prefix: 20.80.208.150 - length: 31 - last_active_on: '2022-10-09T23:39:01Z' - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/images/custom": - get: - summary: List custom images for an organization - description: |- - List custom images for an organization. - - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/list-custom-images-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - images - properties: - total_count: - type: integer - images: - type: array - items: &132 - title: GitHub-hosted runner custom image details - description: Provides details of a custom runner image - type: object - properties: - id: - description: The ID of the image. Use this ID for the `image` - parameter when creating a new larger runner. - type: integer - example: 1 - platform: - description: The operating system of the image. - type: string - example: linux-x64 - total_versions_size: - description: Total size of all the image versions in GB. - type: integer - example: 200 - name: - description: Display name for this image. - type: string - example: CustomImage - source: - description: The image provider. - type: string - example: custom - versions_count: - description: The number of image versions associated with - the image. - type: integer - example: 4 - latest_version: - description: The latest image version associated with the - image. - type: string - example: 1.3.0 - state: - description: The number of image versions associated with - the image. - type: string - example: Ready - required: - - id - - platform - - name - - source - - versions_count - - total_versions_size - - latest_version - - state - examples: - default: &134 - value: - total_count: 2 - image_versions: - - version: 1.1.0 - size_gb: 75 - state: Ready - created_on: '2024-11-09T23:39:01Z' - - version: 1.0.0 - size_gb: 75 - state: Ready - created_on: '2024-11-08T20:39:01Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": - get: - summary: Get a custom image definition for GitHub Actions Hosted Runners - description: |- - Get a custom image definition for GitHub Actions Hosted Runners. - - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/get-custom-image-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners - parameters: - - *75 - - &133 - name: image_definition_id - description: Image definition ID of custom image - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *132 - examples: - default: - value: - id: 1 - platform: linux-x64 - name: CustomImage - source: custom - versions_count: 4 - total_versions_size: 200 - latest_version: 1.3.0 - state: Ready - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - delete: - summary: Delete a custom image from the organization - description: |- - Delete a custom image from the organization. - - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-custom-image-from-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization - parameters: - - *75 - - *133 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": - get: - summary: List image versions of a custom image for an organization - description: |- - List image versions of a custom image for an organization. - - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/list-custom-image-versions-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization - parameters: - - *133 - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - image_versions - properties: - total_count: - type: integer - image_versions: - type: array - items: &135 - title: GitHub-hosted runner custom image version details. - description: Provides details of a hosted runner custom image - version - type: object - properties: - version: - description: The version of image. - type: string - example: 1.0.0 - state: - description: The state of image version. - type: string - example: Ready - size_gb: - description: Image version size in GB. - type: integer - example: 30 - created_on: - description: The creation date time of the image version. - type: string - example: '2024-11-09T23:39:01Z' - state_details: - description: The image version status details. - type: string - example: None - required: - - version - - state - - size_gb - - created_on - - state_details - examples: - default: *134 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": - get: - summary: Get an image version of a custom image for GitHub Actions Hosted Runners - description: |- - Get an image version of a custom image for GitHub Actions Hosted Runners. - - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/get-custom-image-version-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners - parameters: - - *75 - - *133 - - &136 - name: version - description: Version of a custom image - in: path - required: true - schema: - type: string - pattern: "^\\d+\\.\\d+\\.\\d+$" - responses: - '200': - description: Response - content: - application/json: - schema: *135 - examples: - default: - value: - version: 1.0.0 - size_gb: 75 - state: Ready - created_on: '2024-11-08T20:39:01Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - delete: - summary: Delete an image version of custom image from the organization - description: |- - Delete an image version of custom image from the organization. - - OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-custom-image-version-from-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization - parameters: - - *75 - - *133 - - *136 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/images/github-owned": - get: - summary: Get GitHub-owned images for GitHub-hosted runners in an organization - description: Get the list of GitHub-owned images available for GitHub-hosted - runners for an organization. - operationId: actions/get-hosted-runners-github-owned-images-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - images - properties: - total_count: - type: integer - images: - type: array - items: &137 - title: GitHub-hosted runner image details. - description: Provides details of a hosted runner image - type: object - properties: - id: - description: The ID of the image. Use this ID for the `image` - parameter when creating a new larger runner. - type: string - example: ubuntu-20.04 - platform: - description: The operating system of the image. - type: string - example: linux-x64 - size_gb: - description: Image size in GB. - type: integer - example: 86 - display_name: - description: Display name for this image. - type: string - example: 20.04 - source: - description: The image provider. - type: string - enum: - - github - - partner - - custom - required: - - id - - platform - - size_gb - - display_name - - source - examples: - default: &138 - value: - id: ubuntu-20.04 - platform: linux-x64 - size_gb: 86 - display_name: '20.04' - source: github - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/images/partner": - get: - summary: Get partner images for GitHub-hosted runners in an organization - description: Get the list of partner images available for GitHub-hosted runners - for an organization. - operationId: actions/get-hosted-runners-partner-images-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - images - properties: - total_count: - type: integer - images: - type: array - items: *137 - examples: - default: *138 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/limits": - get: - summary: Get limits on GitHub-hosted runners for an organization - description: Get the GitHub-hosted runners limits for an organization. - operationId: actions/get-hosted-runners-limits-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - public_ips: - title: Static public IP Limits for GitHub-hosted Hosted Runners. - description: Provides details of static public IP limits for GitHub-hosted - Hosted Runners - type: object - properties: - maximum: - type: integer - description: The maximum number of static public IP addresses - that can be used for Hosted Runners. - example: 50 - current_usage: - type: integer - description: The current number of static public IP addresses - in use by Hosted Runners. - example: 17 - required: - - maximum - - current_usage - required: - - public_ips - examples: - default: - value: - public_ips: - current_usage: 17 - maximum: 50 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/machine-sizes": - get: - summary: Get GitHub-hosted runners machine specs for an organization - description: Get the list of machine specs available for GitHub-hosted runners - for an organization. - operationId: actions/get-hosted-runners-machine-specs-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - machine_specs - properties: - total_count: - type: integer - machine_specs: - type: array - items: *139 - examples: - default: - value: - id: 4-core - cpu_cores: 4 - memory_gb: 16 - storage_gb: 150 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/platforms": - get: - summary: Get platforms for GitHub-hosted runners in an organization - description: Get the list of platforms available for GitHub-hosted runners for - an organization. - operationId: actions/get-hosted-runners-platforms-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - platforms - properties: - total_count: - type: integer - platforms: - type: array - items: - type: string - examples: - default: - value: - total_count: 1 - platforms: - - linux-x64 - - win-x64 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": - get: - summary: Get a GitHub-hosted runner for an organization - description: |- - Gets a GitHub-hosted runner configured in an organization. - - OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - tags: - - actions - operationId: actions/get-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization - parameters: - - *75 - - &141 - name: hosted_runner_id - description: Unique identifier of the GitHub-hosted runner. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *131 - examples: - default: *140 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: hosted-runners - patch: - summary: Update a GitHub-hosted runner for an organization - description: |- - Updates a GitHub-hosted runner for an organization. - OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. - operationId: actions/update-hosted-runner-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization - parameters: - - *75 - - *141 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the runner. Must be between 1 and 64 characters - and may only contain upper and lowercase letters a-z, numbers - 0-9, '.', '-', and '_'. - type: string - runner_group_id: - description: The existing runner group to add this runner to. - type: integer - maximum_runners: - description: The maximum amount of runners to scale up to. Runners - will not auto-scale above this number. Use this setting to limit - your cost. - type: integer - enable_static_ip: - description: Whether this runner should be updated with a static - public IP. Note limit on account. To list limits on account, use - `GET actions/hosted-runners/limits` - type: boolean - size: - description: The machine size of the runner. To list available sizes, - use `GET actions/hosted-runners/machine-sizes` - type: string - image_id: - description: The unique identifier of the runner image. To list - available images, use `GET /actions/hosted-runners/images/github-owned`, - `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`. - type: string - image_version: - description: The version of the runner image to deploy. This is - relevant only for runners using custom images. - type: string - nullable: true - examples: - default: - value: - name: My larger runner - runner_group_id: 1 - maximum_runners: 50 - enable_static_ip: false - responses: - '200': - description: Response - content: - application/json: - schema: *131 - examples: - default: *140 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: hosted-runners - delete: - summary: Delete a GitHub-hosted runner for an organization - description: Deletes a GitHub-hosted runner for an organization. - operationId: actions/delete-hosted-runner-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization - parameters: - - *75 - - *141 - responses: - '202': - description: Response - content: - application/json: - schema: *131 - examples: - default: *140 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: actions - subcategory: hosted-runners - "/orgs/{org}/actions/oidc/customization/properties/repo": - get: - summary: List OIDC custom property inclusions for an organization - description: |- - Lists the repository custom properties that are included in the OIDC token for repository actions in an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - oidc - operationId: oidc/list-oidc-custom-property-inclusions-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization - parameters: - - *75 - responses: - '200': - description: A JSON array of OIDC custom property inclusions - content: - application/json: - schema: - type: array - items: *45 - examples: - default: - value: - - property_name: environment - - property_name: team - '404': *6 - '403': *29 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: oidc - post: - summary: Create an OIDC custom property inclusion for an organization - description: |- - Adds a repository custom property to be included in the OIDC token for repository actions in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - oidc - operationId: oidc/create-oidc-custom-property-inclusion-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: *142 - examples: - default: *46 - responses: - '201': - description: OIDC custom property inclusion created - content: - application/json: - schema: *45 - examples: - default: *46 - '400': - description: Invalid input - '403': *29 - '422': - description: Property inclusion already exists - x-github: - enabledForGitHubApps: true - category: actions - subcategory: oidc - "/orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}": - delete: - summary: Delete an OIDC custom property inclusion for an organization - description: |- - Removes a repository custom property from being included in the OIDC token for repository actions in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - oidc - operationId: oidc/delete-oidc-custom-property-inclusion-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization - parameters: - - *75 - - name: custom_property_name - in: path - required: true - schema: - type: string - description: The name of the custom property to remove from OIDC token inclusion - responses: - '204': - description: OIDC custom property inclusion deleted - '400': - description: Invalid input - '403': *29 - '404': - description: Property inclusion not found - x-github: - enabledForGitHubApps: true - category: actions - subcategory: oidc - "/orgs/{org}/actions/oidc/customization/sub": - get: - summary: Get the customization template for an OIDC subject claim for an organization - description: |- - Gets the customization template for an OpenID Connect (OIDC) subject claim. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - oidc - operationId: oidc/get-oidc-custom-sub-template-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization - parameters: - - *75 - responses: - '200': - description: A JSON serialized template for OIDC subject claim customization - content: - application/json: - schema: - title: Actions OIDC Subject customization - description: Actions OIDC Subject customization - type: object - properties: - include_claim_keys: - description: Array of unique strings. Each claim key can only - contain alphanumeric characters and underscores. - type: array - items: - type: string - required: - - include_claim_keys - examples: - default: &143 - value: - include_claim_keys: - - repo - - context - x-github: - enabledForGitHubApps: true - category: actions - subcategory: oidc - put: - summary: Set the customization template for an OIDC subject claim for an organization - description: |- - Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - oidc - operationId: oidc/update-oidc-custom-sub-template-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - title: Actions OIDC Subject customization - description: Actions OIDC Subject customization - type: object - properties: - include_claim_keys: - description: Array of unique strings. Each claim key can only contain - alphanumeric characters and underscores. - type: array - items: - type: string - examples: - default: *143 - responses: - '201': - description: Empty response - content: - application/json: - schema: &169 - title: Empty Object - description: An object without any properties. - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '404': *6 - '403': *29 - x-github: - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: oidc - "/orgs/{org}/actions/permissions": - get: - summary: Get GitHub Actions permissions for an organization - description: |- - Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/get-github-actions-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - enabled_repositories: &144 - type: string - description: The policy that controls the repositories in the - organization that are allowed to run GitHub Actions. - enum: - - all - - none - - selected - selected_repositories_url: - type: string - description: The API URL to use to get or set the selected repositories - that are allowed to run GitHub Actions, when `enabled_repositories` - is set to `selected`. - allowed_actions: &145 - type: string - description: The permissions policy that controls the actions - and reusable workflows that are allowed to run. - enum: - - all - - local_only - - selected - selected_actions_url: &361 - type: string - description: The API URL to use to get or set the actions and - reusable workflows that are allowed to run, when `allowed_actions` - is set to `selected`. - sha_pinning_required: &146 - type: boolean - description: Whether actions must be pinned to a full-length commit - SHA. - required: - - enabled_repositories - examples: - default: - value: - enabled_repositories: all - allowed_actions: selected - selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions - sha_pinning_required: true - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - put: - summary: Set GitHub Actions permissions for an organization - description: |- - Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-github-actions-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization - parameters: - - *75 - responses: - '204': - description: Response - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - enabled_repositories: *144 - allowed_actions: *145 - sha_pinning_required: *146 - required: - - enabled_repositories - examples: - default: - value: - enabled_repositories: all - allowed_actions: selected - sha_pinning_required: true - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for an organization - description: |- - Gets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &365 - type: object - properties: - days: - type: integer - description: The number of days artifacts and logs are retained - maximum_allowed_days: - type: integer - description: The maximum number of days that can be configured - required: - - days - - maximum_allowed_days - examples: - response: - summary: Example response - value: - days: 90 - maximum_allowed_days: 365 - '403': *29 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for an organization - description: |- - Sets artifact and log retention settings for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: &366 - type: object - properties: - days: - type: integer - description: The number of days to retain artifacts and logs - required: - - days - examples: - application/json: - value: - days: 100 - responses: - '204': - description: No content - '403': *29 - '404': *6 - '409': *54 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for an organization - description: |- - Gets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &147 - type: object - properties: - approval_policy: - type: string - enum: - - first_time_contributors_new_to_github - - first_time_contributors - - all_external_contributors - description: The policy that controls when fork PR workflows require - approval from a maintainer. - required: - - approval_policy - examples: - default: &367 - value: - approval_policy: first_time_contributors - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for an organization - description: |- - Sets the fork PR contributor approval policy for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization - parameters: - - *75 - responses: - '204': - description: Response - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *147 - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for an organization - description: Gets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/get-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &368 - type: object - required: - - run_workflows_from_fork_pull_requests - - send_write_tokens_to_workflows - - send_secrets_and_variables - - require_approval_for_fork_pr_workflows - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from - forks are allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or - submit approving pull request reviews from a workflow triggered - by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to - workflows triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from - forks require approval from a repository administrator to run. - examples: - default: &148 - value: - run_workflows_from_fork_pull_requests: true - send_write_tokens_to_workflows: false - send_secrets_and_variables: false - require_approval_for_fork_pr_workflows: true - '403': *29 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for an organization - description: Sets the settings for whether workflows from fork pull requests - can run on private repositories in an organization. - operationId: actions/set-private-repo-fork-pr-workflows-settings-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: &369 - type: object - required: - - run_workflows_from_fork_pull_requests - properties: - run_workflows_from_fork_pull_requests: - type: boolean - description: Whether workflows triggered by pull requests from forks - are allowed to run on private repositories. - send_write_tokens_to_workflows: - type: boolean - description: Whether GitHub Actions can create pull requests or - submit approving pull request reviews from a workflow triggered - by a fork pull request. - send_secrets_and_variables: - type: boolean - description: Whether to make secrets and variables available to - workflows triggered by pull requests from forks. - require_approval_for_fork_pr_workflows: - type: boolean - description: Whether workflows triggered by pull requests from forks - require approval from a repository administrator to run. - examples: - default: *148 - responses: - '204': - description: Empty response for successful settings update - '403': - description: Forbidden - Fork PR workflow settings for private repositories - are managed by the enterprise owner - content: - application/json: - schema: *3 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/repositories": - get: - summary: List selected repositories enabled for GitHub Actions in an organization - description: |- - Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/list-selected-repositories-enabled-github-actions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: number - repositories: - type: array - items: *79 - examples: - default: &152 - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - put: - summary: Set selected repositories enabled for GitHub Actions in an organization - description: |- - Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-selected-repositories-enabled-github-actions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization - parameters: - - *75 - responses: - '204': - description: Response - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - description: List of repository IDs to enable for GitHub Actions. - type: array - items: - type: integer - description: Unique identifier of the repository. - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 32 - - 42 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/repositories/{repository_id}": - put: - summary: Enable a selected repository for GitHub Actions in an organization - description: |- - Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/enable-selected-repository-github-actions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization - parameters: - - *75 - - &149 - name: repository_id - description: The unique identifier of the repository. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - delete: - summary: Disable a selected repository for GitHub Actions in an organization - description: |- - Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/disable-selected-repository-github-actions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/selected-actions": - get: - summary: Get allowed actions and reusable workflows for an organization - description: |- - Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/get-allowed-actions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &150 - type: object - properties: - github_owned_allowed: - type: boolean - description: Whether GitHub-owned actions are allowed. For example, - this includes the actions in the `actions` organization. - verified_allowed: - type: boolean - description: Whether actions from GitHub Marketplace verified - creators are allowed. Set to `true` to allow all actions by - GitHub Marketplace verified creators. - patterns_allowed: - type: array - description: |- - Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. - - > [!NOTE] - > The `patterns_allowed` setting only applies to public repositories. - items: - type: string - examples: - default: &151 - value: - github_owned_allowed: true - verified_allowed: false - patterns_allowed: - - monalisa/octocat@* - - docker/* - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - put: - summary: Set allowed actions and reusable workflows for an organization - description: |- - Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-allowed-actions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization - parameters: - - *75 - responses: - '204': - description: Response - requestBody: - required: false - content: - application/json: - schema: *150 - examples: - selected_actions: *151 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/self-hosted-runners": - get: - summary: Get self-hosted runners settings for an organization - description: |- - Gets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/get-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used by repositories in the organization - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL to the endpoint for managing selected repositories - for self-hosted runners in the organization - examples: - response: - summary: Example response - value: - enabled_repositories: selected - selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories - '403': *29 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set self-hosted runners settings for an organization - description: |- - Sets the settings for self-hosted runners for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-self-hosted-runners-permissions-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - enabled_repositories - properties: - enabled_repositories: - type: string - description: The policy that controls whether self-hosted runners - can be used in the organization - enum: - - all - - selected - - none - examples: - application/json: - value: - enabled_repositories: all - responses: - '204': - description: No content - '403': *29 - '404': *6 - '409': *54 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": - get: - summary: List repositories allowed to use self-hosted runners in an organization - description: |- - Lists repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/list-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - repositories: - type: array - items: *79 - examples: - default: *152 - '403': *29 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set repositories allowed to use self-hosted runners in an organization - description: |- - Sets repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/set-selected-repositories-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - selected_repository_ids - properties: - selected_repository_ids: - type: array - items: - type: integer - description: IDs of repositories that can use repository-level self-hosted - runners - examples: - application/json: - value: - selected_repository_ids: - - 1 - - 2 - - 3 - responses: - '204': - description: No content - '403': *29 - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": - put: - summary: Add a repository to the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/enable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: No content - '403': *29 - '404': *6 - '409': *54 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - delete: - summary: Remove a repository from the list of repositories allowed to use self-hosted - runners in an organization - description: |- - Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. - operationId: actions/disable-selected-repository-self-hosted-runners-organization - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: No content - '403': *29 - '404': *6 - '409': *54 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/permissions/workflow": - get: - summary: Get default workflow permissions for an organization - description: |- - Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - actions - operationId: actions/get-github-actions-default-workflow-permissions-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &370 - type: object - properties: - default_workflow_permissions: &153 - type: string - description: The default workflow permissions granted to the GITHUB_TOKEN - when running workflows. - enum: - - read - - write - can_approve_pull_request_reviews: &154 - type: boolean - description: Whether GitHub Actions can approve pull requests. - Enabling this can be a security risk. - required: - - default_workflow_permissions - - can_approve_pull_request_reviews - examples: - default: &155 - summary: Give read-only permission, and allow approving PRs. - value: - default_workflow_permissions: read - can_approve_pull_request_reviews: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set default workflow permissions for an organization - description: |- - Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions - can submit approving pull request reviews. For more information, see - "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - actions - operationId: actions/set-github-actions-default-workflow-permissions-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization - parameters: - - *75 - responses: - '204': - description: Success response - requestBody: - required: false - content: - application/json: - schema: &371 - type: object - properties: - default_workflow_permissions: *153 - can_approve_pull_request_reviews: *154 - examples: - default: *155 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/orgs/{org}/actions/runner-groups": - get: - summary: List self-hosted runner groups for an organization - description: |- - Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/list-self-hosted-runner-groups-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization - parameters: - - *75 - - *17 - - *19 - - name: visible_to_repository - description: Only return runner groups that are allowed to be used by this - repository. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - runner_groups - properties: - total_count: - type: number - runner_groups: - type: array - items: &156 - type: object - properties: - id: - type: number - name: - type: string - visibility: - type: string - default: - type: boolean - selected_repositories_url: - description: Link to the selected repositories resource - for this runner group. Not present unless visibility was - set to `selected` - type: string - runners_url: - type: string - hosted_runners_url: - type: string - network_configuration_id: - description: The identifier of a hosted compute network - configuration. - type: string - inherited: - type: boolean - inherited_allows_public_repositories: - type: boolean - allows_public_repositories: - type: boolean - workflow_restrictions_read_only: - description: If `true`, the `restricted_to_workflows` and - `selected_workflows` fields cannot be modified. - type: boolean - default: false - restricted_to_workflows: - description: If `true`, the runner group will be restricted - to running only the workflows specified in the `selected_workflows` - array. - type: boolean - default: false - selected_workflows: - description: List of workflows the runner group should be - allowed to run. This setting will be ignored unless `restricted_to_workflows` - is set to `true`. - type: array - items: - type: string - description: Name of workflow the runner group should - be allowed to run. Note that a ref, tag, or long SHA - is required. - example: octo-org/octo-repo/.github/workflows/deploy.yaml@main - required: - - id - - name - - visibility - - default - - runners_url - - inherited - - allows_public_repositories - examples: - default: - value: - total_count: 3 - runner_groups: - - id: 1 - name: Default - visibility: all - default: true - runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners - inherited: false - allows_public_repositories: true - restricted_to_workflows: false - selected_workflows: [] - workflow_restrictions_read_only: false - - id: 2 - name: octo-runner-group - visibility: selected - default: false - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories - runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners - inherited: true - allows_public_repositories: true - restricted_to_workflows: true - selected_workflows: - - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main - workflow_restrictions_read_only: true - - id: 3 - name: expensive-hardware - visibility: private - default: false - runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners - inherited: false - allows_public_repositories: true - restricted_to_workflows: false - selected_workflows: - - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main - workflow_restrictions_read_only: false - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - post: - summary: Create a self-hosted runner group for an organization - description: |- - Creates a new self-hosted runner group for an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/create-self-hosted-runner-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the runner group. - type: string - visibility: - description: Visibility of a runner group. You can select all repositories, - select individual repositories, or limit access to private repositories. - type: string - enum: - - selected - - all - - private - default: all - selected_repository_ids: - description: List of repository IDs that can access the runner group. - type: array - items: - type: integer - description: Unique identifier of the repository. - runners: - description: List of runner IDs to add to the runner group. - type: array - items: - type: integer - description: Unique identifier of the runner. - allows_public_repositories: - description: Whether the runner group can be used by `public` repositories. - type: boolean - default: false - restricted_to_workflows: - description: If `true`, the runner group will be restricted to running - only the workflows specified in the `selected_workflows` array. - type: boolean - default: false - selected_workflows: - description: List of workflows the runner group should be allowed - to run. This setting will be ignored unless `restricted_to_workflows` - is set to `true`. - type: array - items: - type: string - description: Name of workflow the runner group should be allowed - to run. Note that a ref, tag, or long SHA is required. - example: octo-org/octo-repo/.github/workflows/deploy.yaml@main - network_configuration_id: - description: The identifier of a hosted compute network configuration. - type: string - required: - - name - examples: - default: - value: - name: Expensive hardware runners - visibility: selected - selected_repository_ids: - - 32 - - 91 - runners: - - 9 - - 2 - responses: - '201': - description: Response - content: - application/json: - schema: *156 - examples: - default: &158 - value: - id: 2 - name: octo-runner-group - visibility: selected - default: false - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories - runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners - hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners - network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA - inherited: false - allows_public_repositories: true - restricted_to_workflows: true - selected_workflows: - - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main - workflow_restrictions_read_only: false - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runner-groups/{runner_group_id}": - get: - summary: Get a self-hosted runner group for an organization - description: |- - Gets a specific self-hosted runner group for an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/get-self-hosted-runner-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization - parameters: - - *75 - - &157 - name: runner_group_id - description: Unique identifier of the self-hosted runner group. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *156 - examples: - default: - value: - id: 2 - name: octo-runner-group - visibility: selected - default: false - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories - runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners - hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners - network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA - inherited: false - allows_public_repositories: true - restricted_to_workflows: true - selected_workflows: - - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main - workflow_restrictions_read_only: false - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - patch: - summary: Update a self-hosted runner group for an organization - description: |- - Updates the `name` and `visibility` of a self-hosted runner group in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/update-self-hosted-runner-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization - parameters: - - *75 - - *157 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the runner group. - type: string - visibility: - description: Visibility of a runner group. You can select all repositories, - select individual repositories, or all private repositories. - type: string - enum: - - selected - - all - - private - allows_public_repositories: - description: Whether the runner group can be used by `public` repositories. - type: boolean - default: false - restricted_to_workflows: - description: If `true`, the runner group will be restricted to running - only the workflows specified in the `selected_workflows` array. - type: boolean - default: false - selected_workflows: - description: List of workflows the runner group should be allowed - to run. This setting will be ignored unless `restricted_to_workflows` - is set to `true`. - type: array - items: - type: string - description: Name of workflow the runner group should be allowed - to run. Note that a ref, tag, or long SHA is required. - example: octo-org/octo-repo/.github/workflows/deploy.yaml@main - network_configuration_id: - description: The identifier of a hosted compute network configuration. - type: string - nullable: true - required: - - name - examples: - default: - value: - name: Expensive hardware runners - visibility: selected - responses: - '200': - description: Response - content: - application/json: - schema: *156 - examples: - default: *158 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - delete: - summary: Delete a self-hosted runner group from an organization - description: |- - Deletes a self-hosted runner group for an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/delete-self-hosted-runner-group-from-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization - parameters: - - *75 - - *157 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": - get: - summary: List GitHub-hosted runners in a group for an organization - description: |- - Lists the GitHub-hosted runners in an organization group. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/list-github-hosted-runners-in-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization - parameters: - - *75 - - *157 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - runners - properties: - total_count: - type: number - runners: - type: array - items: *131 - examples: - default: *159 - headers: - Link: *67 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": - get: - summary: List repository access to a self-hosted runner group in an organization - description: |- - Lists the repositories with access to a self-hosted runner group configured in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization - parameters: - - *75 - - *157 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: number - repositories: - type: array - items: *160 - examples: - default: &198 - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - organization: - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - delete_branch_on_merge: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - forks: 1 - open_issues: 1 - watchers: 1 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - put: - summary: Set repository access for a self-hosted runner group in an organization - description: |- - Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization - parameters: - - *75 - - *157 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - description: List of repository IDs that can access the runner group. - type: array - items: - type: integer - description: Unique identifier of the repository. - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 32 - - 91 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": - put: - summary: Add repository access to a self-hosted runner group in an organization - description: |- - Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization - parameters: - - *75 - - *157 - - *149 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - delete: - summary: Remove repository access to a self-hosted runner group in an organization - description: |- - Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization - parameters: - - *75 - - *157 - - *149 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": - get: - summary: List self-hosted runners in a group for an organization - description: |- - Lists self-hosted runners that are in a specific organization group. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/list-self-hosted-runners-in-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization - parameters: - - *75 - - *157 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - runners - properties: - total_count: - type: number - runners: - type: array - items: &162 - title: Self hosted runners - description: A self hosted runner - type: object - properties: - id: - description: The ID of the runner. - type: integer - example: 5 - runner_group_id: - description: The ID of the runner group. - type: integer - example: 1 - name: - description: The name of the runner. - type: string - example: iMac - os: - description: The Operating System of the runner. - type: string - example: macos - status: - description: The status of the runner. - type: string - example: online - busy: - type: boolean - labels: - type: array - items: &165 - title: Self hosted runner label - description: A label for a self hosted runner - type: object - properties: - id: - type: integer - description: Unique identifier of the label. - name: - type: string - description: Name of the label. - type: - type: string - description: The type of label. Read-only labels are - applied automatically when the runner is configured. - enum: - - read-only - - custom - required: - - name - ephemeral: - type: boolean - required: - - id - - name - - os - - status - - busy - - labels - examples: - default: &163 - value: - total_count: 2 - runners: - - id: 23 - name: linux_runner - os: linux - status: online - busy: true - ephemeral: false - labels: - - id: 5 - name: self-hosted - type: read-only - - id: 7 - name: X64 - type: read-only - - id: 11 - name: Linux - type: read-only - - id: 24 - name: mac_runner - os: macos - status: offline - busy: false - ephemeral: false - labels: - - id: 5 - name: self-hosted - type: read-only - - id: 7 - name: X64 - type: read-only - - id: 20 - name: macOS - type: read-only - - id: 21 - name: no-gpu - type: custom - headers: - Link: *67 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - put: - summary: Set self-hosted runners in a group for an organization - description: |- - Replaces the list of self-hosted runners that are part of an organization runner group. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/set-self-hosted-runners-in-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization - parameters: - - *75 - - *157 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - runners: - description: List of runner IDs to add to the runner group. - type: array - items: - type: integer - description: Unique identifier of the runner. - required: - - runners - examples: - default: - value: - runners: - - 9 - - 2 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": - put: - summary: Add a self-hosted runner to a group for an organization - description: |- - Adds a self-hosted runner to a runner group configured in an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/add-self-hosted-runner-to-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization - parameters: - - *75 - - *157 - - &161 - name: runner_id - description: Unique identifier of the self-hosted runner. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - delete: - summary: Remove a self-hosted runner from a group for an organization - description: |- - Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: actions/remove-self-hosted-runner-from-group-for-org - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization - parameters: - - *75 - - *157 - - *161 - responses: - '204': - description: Response - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: self-hosted-runner-groups - "/orgs/{org}/actions/runners": - get: - summary: List self-hosted runners for an organization - description: |- - Lists all self-hosted runners configured in an organization. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-self-hosted-runners-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization - parameters: - - name: name - description: The name of a self-hosted runner. - in: query - schema: - type: string - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - runners - properties: - total_count: - type: integer - runners: - type: array - items: *162 - examples: - default: *163 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/downloads": - get: - summary: List runner applications for an organization - description: |- - Lists binaries for the runner application that you can download and run. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-runner-applications-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &372 - title: Runner Application - description: Runner Application - type: object - properties: - os: - type: string - architecture: - type: string - download_url: - type: string - filename: - type: string - temp_download_token: - description: A short lived bearer token used to download the - runner, if needed. - type: string - sha256_checksum: - type: string - required: - - os - - architecture - - download_url - - filename - examples: - default: &373 - value: - - os: osx - architecture: x64 - download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz - filename: actions-runner-osx-x64-2.164.0.tar.gz - - os: linux - architecture: x64 - download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz - filename: actions-runner-linux-x64-2.164.0.tar.gz - - os: linux - architecture: arm - download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz - filename: actions-runner-linux-arm-2.164.0.tar.gz - - os: win - architecture: x64 - download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip - filename: actions-runner-win-x64-2.164.0.zip - - os: linux - architecture: arm64 - download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz - filename: actions-runner-linux-arm64-2.164.0.tar.gz - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/generate-jitconfig": - post: - summary: Create configuration for a just-in-time runner for an organization - description: |- - Generates a configuration that can be passed to the runner application at startup. - - The authenticated user must have admin access to the organization. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/generate-runner-jitconfig-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - - runner_group_id - - labels - properties: - name: - type: string - description: The name of the new runner. - runner_group_id: - type: integer - description: The ID of the runner group to register the runner to. - labels: - type: array - minItems: 1 - maxItems: 100 - items: - type: string - description: 'The names of the custom labels to add to the runner. - **Minimum items**: 1. **Maximum items**: 100.' - work_folder: - type: string - description: The working directory to be used for job execution, - relative to the runner install directory. - default: _work - examples: - default: - value: - name: New runner - runner_group_id: 1 - labels: - - self-hosted - - X64 - - macOS - - no-gpu - work_folder: _work - responses: - '201': &374 - description: Response - content: - application/json: - schema: - type: object - required: - - runner - - encoded_jit_config - properties: - runner: *162 - encoded_jit_config: - type: string - description: The base64 encoded runner configuration. - examples: - default: - value: - runner: - id: 23 - name: New runner - os: unknown - status: offline - busy: false - labels: - - id: 5 - name: self-hosted - type: read-only - - id: 7 - name: X64 - type: read-only - - id: 20 - name: macOS - type: read-only - - id: 21 - name: no-gpu - type: custom - encoded_jit_config: abc123 - '404': *6 - '422': *7 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/registration-token": - post: - summary: Create a registration token for an organization - description: |- - Returns a token that you can pass to the `config` script. The token expires after one hour. - - For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - - ``` - ./config.sh --url https://github.com/octo-org --token TOKEN - ``` - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-registration-token-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization - parameters: - - *75 - responses: - '201': - description: Response - content: - application/json: - schema: &164 - title: Authentication Token - description: Authentication Token - type: object - properties: - token: - description: The token used for authentication - type: string - example: v1.1f699f1069f60xxx - expires_at: - description: The time this token expires - type: string - format: date-time - example: '2016-07-11T22:14:10Z' - permissions: - type: object - example: - issues: read - deployments: write - repositories: - description: The repositories this token has access to - type: array - items: *79 - single_file: - type: string - example: config.yaml - nullable: true - repository_selection: - description: Describe whether all repositories have been selected - or there's a selection involved - type: string - enum: - - all - - selected - required: - - token - - expires_at - examples: - default: &375 - value: - token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 - expires_at: '2020-01-22T12:13:35.123-08:00' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/remove-token": - post: - summary: Create a remove token for an organization - description: |- - 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. - - For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - - ``` - ./config.sh remove --token TOKEN - ``` - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-remove-token-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization - parameters: - - *75 - responses: - '201': - description: Response - content: - application/json: - schema: *164 - examples: - default: &376 - value: - token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 - expires_at: '2020-01-29T12:13:35.123-08:00' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/{runner_id}": - get: - summary: Get a self-hosted runner for an organization - description: |- - Gets a specific self-hosted runner configured in an organization. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/get-self-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization - parameters: - - *75 - - *161 - responses: - '200': - description: Response - content: - application/json: - schema: *162 - examples: - default: &377 - value: - id: 23 - name: MBP - os: macos - status: online - busy: true - ephemeral: false - labels: - - id: 5 - name: self-hosted - type: read-only - - id: 7 - name: X64 - type: read-only - - id: 20 - name: macOS - type: read-only - - id: 21 - name: no-gpu - type: custom - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - delete: - summary: Delete a self-hosted runner from an organization - description: |- - Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-self-hosted-runner-from-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization - parameters: - - *75 - - *161 - responses: - '204': - description: Response - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/{runner_id}/labels": - get: - summary: List labels for a self-hosted runner for an organization - description: |- - Lists all labels for a self-hosted runner configured in an organization. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-labels-for-self-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization - parameters: - - *75 - - *161 - responses: - '200': &166 - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - labels - properties: - total_count: - type: integer - labels: - type: array - items: *165 - examples: - default: - value: - total_count: 4 - labels: - - id: 5 - name: self-hosted - type: read-only - - id: 7 - name: X64 - type: read-only - - id: 20 - name: macOS - type: read-only - - id: 21 - name: no-gpu - type: custom - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - post: - summary: Add custom labels to a self-hosted runner for an organization - description: |- - Adds custom labels to a self-hosted runner configured in an organization. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - actions - operationId: actions/add-custom-labels-to-self-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization - parameters: - - *75 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - labels - properties: - labels: - type: array - minItems: 1 - maxItems: 100 - description: The names of the custom labels to add to the runner. - items: - type: string - examples: - default: - value: - labels: - - gpu - - accelerated - responses: - '200': *166 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - put: - summary: Set custom labels for a self-hosted runner for an organization - description: |- - Remove all previous custom labels and set the new custom labels for a specific - self-hosted runner configured in an organization. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/set-custom-labels-for-self-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization - parameters: - - *75 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - labels - properties: - labels: - type: array - minItems: 0 - maxItems: 100 - description: The names of the custom labels to set for the runner. - You can pass an empty array to remove all custom labels. - items: - type: string - examples: - default: - value: - labels: - - gpu - - accelerated - responses: - '200': *166 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - delete: - summary: Remove all custom labels from a self-hosted runner for an organization - description: |- - Remove all custom labels from a self-hosted runner configured in an - organization. Returns the remaining read-only labels from the runner. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization - parameters: - - *75 - - *161 - responses: - '200': &378 - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - labels - properties: - total_count: - type: integer - labels: - type: array - items: *165 - examples: - default: - value: - total_count: 3 - labels: - - id: 5 - name: self-hosted - type: read-only - - id: 7 - name: X64 - type: read-only - - id: 20 - name: macOS - type: read-only - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": - delete: - summary: Remove a custom label from a self-hosted runner for an organization - description: |- - Remove a custom label from a self-hosted runner configured - in an organization. Returns the remaining labels from the runner. - - This endpoint returns a `404 Not Found` status if the custom label is not - present on the runner. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/remove-custom-label-from-self-hosted-runner-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization - parameters: - - *75 - - *161 - - &379 - name: name - description: The name of a self-hosted runner's custom label. - in: path - required: true - schema: - type: string - responses: - '200': *166 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/orgs/{org}/actions/secrets": - get: - summary: List organization secrets - description: |- - Lists all secrets available in an organization without revealing their - encrypted values. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-org-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-organization-secrets - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &167 - title: Actions Secret for an Organization - description: Secrets for GitHub Actions for an organization. - type: object - properties: - name: - description: The name of the secret. - example: SECRET_TOKEN - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - visibility: - description: Visibility of a secret - enum: - - all - - private - - selected - type: string - selected_repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/org/secrets/my_secret/repositories - required: - - name - - created_at - - updated_at - - visibility - examples: - default: - value: - total_count: 3 - secrets: - - name: GIST_ID - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: private - - name: DEPLOY_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: all - - name: GH_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/orgs/{org}/actions/secrets/public-key": - get: - summary: Get an organization public key - description: |- - Gets your public key, which you need to encrypt secrets. You need to - encrypt a secret before you can create or update secrets. - - The authenticated user must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &391 - title: ActionsPublicKey - description: The public key used for setting Actions Secrets. - type: object - properties: - key_id: - description: The identifier for the key. - type: string - example: '1234567' - key: - description: The Base64 encoded public key. - type: string - example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= - id: - type: integer - example: 2 - url: - type: string - example: https://api.github.com/user/keys/2 - title: - type: string - example: ssh-rsa AAAAB3NzaC1yc2EAAA - created_at: - type: string - example: '2011-01-26T19:01:12Z' - required: - - key_id - - key - examples: - default: &392 - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/orgs/{org}/actions/secrets/{secret_name}": - get: - summary: Get an organization secret - description: |- - Gets a single organization secret without revealing its encrypted value. - - The authenticated user must have collaborator access to a repository to create, update, or read secrets - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret - parameters: - - *75 - - &168 - name: secret_name - description: The name of the secret. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *167 - examples: - default: - value: - name: GH_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - put: - summary: Create or update an organization secret - description: |- - Creates or updates an organization secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-or-update-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get an organization public - key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - visibility: - type: string - description: Which type of organization repositories have access - to the organization secret. `selected` means only the repositories - specified by `selected_repository_ids` can access the secret. - enum: - - all - - private - - selected - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - secret. You can only provide a list of repository ids when the - `visibility` is set to `selected`. You can manage the list of - selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) - endpoints. - items: - type: integer - required: - - encrypted_value - - key_id - - visibility - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - delete: - summary: Delete an organization secret - description: |- - Deletes a secret in an organization using the secret name. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret - parameters: - - *75 - - *168 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/orgs/{org}/actions/secrets/{secret_name}/repositories": - get: - summary: List selected repositories for an organization secret - description: |- - Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-selected-repos-for-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret - parameters: - - *75 - - *168 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - examples: - default: &172 - value: - total_count: 1 - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - put: - summary: Set selected repositories for an organization secret - description: |- - Replaces all repositories for an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/set-selected-repos-for-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - secret. You can only provide a list of repository ids when the - `visibility` is set to `selected`. You can add and remove individual - repositories using the [Add selected repository to an organization - secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) - endpoints. - items: - type: integer - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 64780797 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": - put: - summary: Add selected repository to an organization secret - description: |- - Adds a repository to an organization secret when the `visibility` for - repository access is set to `selected`. For more information about setting the visibility, see [Create or - update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/add-selected-repo-to-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret - parameters: - - *75 - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: No Content when repository was added to the selected list - '409': - description: Conflict when visibility type is not set to selected - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - delete: - summary: Remove selected repository from an organization secret - description: |- - Removes a repository from an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/remove-selected-repo-from-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret - parameters: - - *75 - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response when repository was removed from the selected list - '409': - description: Conflict when visibility type not set to selected - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/orgs/{org}/actions/variables": - get: - summary: List organization variables - description: |- - Lists all organization variables. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-org-variables - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-organization-variables - parameters: - - *75 - - &360 - name: per_page - description: The number of results per page (max 30). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 10 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - variables - properties: - total_count: - type: integer - variables: - type: array - items: &170 - title: Actions Variable for an Organization - description: Organization variable for GitHub Actions. - type: object - properties: - name: - description: The name of the variable. - example: USERNAME - type: string - value: - description: The value of the variable. - example: octocat - type: string - created_at: - description: The date and time at which the variable was - created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - example: '2019-01-24T22:45:36.000Z' - type: string - format: date-time - updated_at: - description: The date and time at which the variable was - last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - example: '2019-01-24T22:45:36.000Z' - type: string - format: date-time - visibility: - description: Visibility of a variable - enum: - - all - - private - - selected - type: string - selected_repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/org/variables/USERNAME/repositories - required: - - name - - value - - created_at - - updated_at - - visibility - examples: - default: - value: - total_count: 3 - variables: - - name: USERNAME - value: octocat - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: private - - name: ACTIONS_RUNNER_DEBUG - value: true - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: all - - name: ADMIN_EMAIL - value: octocat@github.com - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - post: - summary: Create an organization variable - description: |- - Creates an organization variable that you can reference in a GitHub Actions workflow. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#create-an-organization-variable - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - visibility: - type: string - description: The type of repositories in the organization that can - access the variable. `selected` means only the repositories specified - by `selected_repository_ids` can access the variable. - enum: - - all - - private - - selected - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - variable. You can only provide a list of repository ids when the - `visibility` is set to `selected`. - items: - type: integer - required: - - name - - value - - visibility - examples: - default: - value: - name: USERNAME - value: octocat - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - responses: - '201': - description: Response when creating a variable - content: - application/json: - schema: *169 - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/orgs/{org}/actions/variables/{name}": - get: - summary: Get an organization variable - description: |- - Gets a specific variable in an organization. - - The authenticated user must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#get-an-organization-variable - parameters: - - *75 - - &171 - name: name - description: The name of the variable. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *170 - examples: - default: - value: - name: USERNAME - value: octocat - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - patch: - summary: Update an organization variable - description: |- - Updates an organization variable that you can reference in a GitHub Actions workflow. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/update-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#update-an-organization-variable - parameters: - - *75 - - *171 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - visibility: - type: string - description: The type of repositories in the organization that can - access the variable. `selected` means only the repositories specified - by `selected_repository_ids` can access the variable. - enum: - - all - - private - - selected - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - variable. You can only provide a list of repository ids when the - `visibility` is set to `selected`. - items: - type: integer - examples: - default: - value: - name: USERNAME - value: octocat - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - delete: - summary: Delete an organization variable - description: |- - Deletes an organization variable using the variable name. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable - parameters: - - *75 - - *171 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/orgs/{org}/actions/variables/{name}/repositories": - get: - summary: List selected repositories for an organization variable - description: |- - Lists all repositories that can access an organization variable - that is available to selected repositories. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/list-selected-repos-for-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable - parameters: - - *75 - - *171 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - examples: - default: *172 - '409': - description: Response when the visibility of the variable is not set to - `selected` - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - put: - summary: Set selected repositories for an organization variable - description: |- - Replaces all repositories for an organization variable that is available - to selected repositories. Organization variables that are available to selected - repositories have their `visibility` field set to `selected`. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/set-selected-repos-for-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable - parameters: - - *75 - - *171 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - type: array - description: The IDs of the repositories that can access the organization - variable. - items: - type: integer - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 64780797 - responses: - '204': - description: Response - '409': - description: Response when the visibility of the variable is not set to - `selected` - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": - put: - summary: Add selected repository to an organization variable - description: |- - Adds a repository to an organization variable that is available to selected repositories. - Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/add-selected-repo-to-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable - parameters: - - *75 - - *171 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - '409': - description: Response when the visibility of the variable is not set to - `selected` - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - delete: - summary: Remove selected repository from an organization variable - description: |- - Removes a repository from an organization variable that is - available to selected repositories. Organization variables that are available to - selected repositories have their `visibility` field set to `selected`. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - tags: - - actions - operationId: actions/remove-selected-repo-from-org-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable - parameters: - - *75 - - *171 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - '409': - description: Response when the visibility of the variable is not set to - `selected` - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/orgs/{org}/artifacts/metadata/deployment-record": - post: - summary: Create an artifact deployment record - description: |- - Create or update deployment records for an artifact associated - with an organization. - This endpoint allows you to record information about a specific - artifact, such as its name, digest, environments, cluster, and - deployment. - The deployment name has to be uniqe within a cluster (i.e a - combination of logical, physical environment and cluster) as it - identifies unique deployment. - Multiple requests for the same combination of logical, physical - environment, cluster and deployment name will only create one - record, successive request will update the existing record. - This allows for a stable tracking of a deployment where the actual - deployed artifact can change over time. - tags: - - orgs - operationId: orgs/create-artifact-deployment-record - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the artifact. - minLength: 1 - maxLength: 256 - example: libfoo - digest: - type: string - description: The hex encoded digest of the artifact. - minLength: 71 - maxLength: 71 - pattern: "^sha256:[a-f0-9]{64}$" - version: - type: string - description: The artifact version. - minLength: 1 - maxLength: 100 - x-multi-segment: true - example: 1.2.3 - status: - type: string - description: The status of the artifact. Can be either deployed - or decommissioned. - enum: - - deployed - - decommissioned - logical_environment: - type: string - description: The stage of the deployment. - minLength: 1 - maxLength: 128 - physical_environment: - type: string - description: The physical region of the deployment. - maxLength: 128 - cluster: - type: string - description: The deployment cluster. - maxLength: 128 - deployment_name: - type: string - description: | - The unique identifier for the deployment represented by the new record. To accommodate differing - containers and namespaces within a cluster, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName}. - maxLength: 256 - tags: - type: object - description: The tags associated with the deployment. - additionalProperties: - type: string - maxProperties: 5 - runtime_risks: - type: array - description: A list of runtime risks associated with the deployment. - maxItems: 4 - uniqueItems: true - items: - type: string - enum: - - critical-resource - - internet-exposed - - lateral-movement - - sensitive-data - github_repository: - type: string - description: |- - The name of the GitHub repository associated with the artifact. This should be used - when there are no provenance attestations available for the artifact. The repository - must belong to the organization specified in the path parameter. - - If a provenance attestation is available for the artifact, the API will use - the repository information from the attestation instead of this parameter. - minLength: 1 - maxLength: 100 - pattern: "^[A-Za-z0-9.\\-_]+$" - example: my-github-repo - return_records: - type: boolean - default: true - description: 'If true, the endpoint will return the created or updated - record in the response body. - - ' - required: - - name - - digest - - status - - logical_environment - - deployment_name - examples: - default: - value: - name: awesome-image - digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - status: deployed - logical_environment: prod - physical_environment: pacific-east - cluster: moda-1 - deployment_name: deployment-pod - tags: - data-access: sensitive - responses: - '200': - description: Artifact deployment record stored successfully. - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of deployment records created - type: integer - deployment_records: - type: array - items: &173 - title: Artifact Deployment Record - description: Artifact Metadata Deployment Record - type: object - properties: - id: - type: integer - digest: - type: string - logical_environment: - type: string - physical_environment: - type: string - cluster: - type: string - deployment_name: - type: string - tags: - type: object - additionalProperties: - type: string - runtime_risks: - type: array - description: A list of runtime risks associated with the - deployment. - maxItems: 4 - uniqueItems: true - items: - type: string - enum: - - critical-resource - - internet-exposed - - lateral-movement - - sensitive-data - created_at: - type: string - updated_at: - type: string - attestation_id: - type: integer - description: The ID of the provenance attestation associated - with the deployment record. - nullable: true - required: - - total_count - examples: - default: &174 - value: - total_count: 1 - deployment_records: - - id: 123 - digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - logical_environment: prod - physical_environment: pacific-east - cluster: moda-1 - deployment_name: prod-deployment - tags: - data: sensitive - created: '2011-01-26T19:14:43Z' - updated_at: '2011-01-26T19:14:43Z' - attestation_id: 456 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: artifact-metadata - "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": - post: - summary: Set cluster deployment records - description: |- - Set deployment records for a given cluster. - If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', - 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. - If no existing records match, new records will be created. - tags: - - orgs - operationId: orgs/set-cluster-deployment-records - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records - parameters: - - *75 - - name: cluster - in: path - description: The cluster name. - required: true - schema: - type: string - minLength: 1 - maxLength: 128 - pattern: "^[a-zA-Z0-9._-]+$" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - logical_environment: - type: string - description: The stage of the deployment. - minLength: 1 - maxLength: 128 - physical_environment: - type: string - description: The physical region of the deployment. - maxLength: 128 - deployments: - type: array - description: The list of deployments to record. - maxItems: 1000 - items: - type: object - properties: - name: - type: string - description: | - The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name parameter must also be identical across all entries. - minLength: 1 - maxLength: 256 - digest: - type: string - description: | - The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, - the name and version parameters must also be identical across all entries. - minLength: 71 - maxLength: 71 - pattern: "^sha256:[a-f0-9]{64}$" - version: - type: string - description: | - The artifact version. Note that if multiple deployments have identical 'digest' parameter values, - the version parameter must also be identical across all entries. - maxLength: 100 - x-multi-segment: true - example: 1.2.3 - status: - type: string - description: The deployment status of the artifact. - default: deployed - enum: - - deployed - - decommissioned - deployment_name: - type: string - description: | - The unique identifier for the deployment represented by the new record. To accommodate differing - containers and namespaces within a record set, the following format is recommended: - {namespaceName}-{deploymentName}-{containerName}. - The deployment_name must be unique across all entries in the deployments array. - minLength: 1 - maxLength: 256 - github_repository: - type: string - description: |- - The name of the GitHub repository associated with the artifact. This should be used - when there are no provenance attestations available for the artifact. The repository - must belong to the organization specified in the path parameter. - - If a provenance attestation is available for the artifact, the API will use - the repository information from the attestation instead of this parameter. - maxLength: 100 - pattern: "^[A-Za-z0-9.\\-_]+$" - example: my-github-repo - tags: - type: object - description: Key-value pairs to tag the deployment record. - additionalProperties: - type: string - runtime_risks: - type: array - description: A list of runtime risks associated with the deployment. - maxItems: 4 - uniqueItems: true - items: - type: string - enum: - - critical-resource - - internet-exposed - - lateral-movement - - sensitive-data - required: - - name - - deployment_name - - digest - return_records: - type: boolean - default: true - description: 'If true, the endpoint will return the set records - in the response body - - ' - required: - - logical_environment - - deployments - examples: - default: - value: - logical_environment: prod - physical_environment: pacific-east - deployments: - - name: awesome-image - digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - version: 2.1.0 - status: deployed - deployment_name: deployment-pod - tags: - runtime-risk: sensitive-data - responses: - '200': - description: 'Deployment records created or updated successfully. - - ' - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of deployment records created - type: integer - deployment_records: - type: array - items: *173 - required: - - total_count - examples: - default: *174 - '403': - description: Forbidden - content: - application/json: - schema: *3 - examples: - insufficient_repo_permissions: - value: - message: - cause: artifact metadata write permission required on one or - more repositories - repositories: - - 123 - - 345 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: artifact-metadata - "/orgs/{org}/artifacts/metadata/storage-record": - post: - summary: Create artifact metadata storage record - description: |- - Create metadata storage records for artifacts associated with an organization. - This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and - associated with a repository owned by the organization. - tags: - - orgs - operationId: orgs/create-artifact-storage-record - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the artifact. - example: libfoo - minLength: 1 - maxLength: 256 - digest: - type: string - description: The digest of the artifact (algorithm:hex-encoded-digest). - example: sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... - minLength: 71 - maxLength: 71 - pattern: "^sha256:[a-f0-9]{64}$" - version: - type: string - description: The artifact version. - minLength: 1 - maxLength: 100 - x-multi-segment: true - example: 1.2.3 - artifact_url: - type: string - format: uri - pattern: "^https://" - description: The URL where the artifact is stored. - example: https://reg.example.com/artifactory/bar/libfoo-1.2.3 - path: - type: string - format: uri - description: The path of the artifact. - example: com/github/bar/libfoo-1.2.3 - registry_url: - type: string - format: uri - pattern: "^https://" - description: The base URL of the artifact registry. - example: https://reg.example.com/artifactory/ - minLength: 1 - repository: - type: string - description: The repository name within the registry. - example: bar - status: - type: string - description: The status of the artifact (e.g., active, inactive). - example: active - enum: - - active - - eol - - deleted - default: active - github_repository: - type: string - description: |- - The name of the GitHub repository associated with the artifact. This should be used - when there are no provenance attestations available for the artifact. The repository - must belong to the organization specified in the path parameter. - - If a provenance attestation is available for the artifact, the API will use - the repository information from the attestation instead of this parameter. - minLength: 1 - maxLength: 100 - pattern: "^[A-Za-z0-9.\\-_]+$" - example: my-github-repo - return_records: - type: boolean - default: true - description: 'If true, the endpoint will return the created record - in the response body. - - ' - required: - - name - - digest - - registry_url - examples: - default: - value: - name: libfoo - version: 1.2.3 - digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 - registry_url: https://reg.example.com/artifactory/ - repository: bar - status: active - responses: - '200': - description: Artifact metadata storage record stored successfully. - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - example: 1 - storage_records: - type: array - items: - type: object - properties: - id: - type: integer - name: - type: string - digest: - type: string - artifact_url: - type: string - nullable: true - registry_url: - type: string - repository: - type: string - nullable: true - status: - type: string - created_at: - type: string - updated_at: - type: string - required: - - total_count - examples: - default: - value: - total_count: 1 - storage_records: - - name: libfoo - digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 - registry_url: https://reg.example.com/artifactory/ - repository: bar - status: active - created_at: '2023-10-01T12:00:00Z' - updated_at: '2023-10-01T12:00:00Z' - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: artifact-metadata - "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": - get: - summary: List artifact deployment records - description: List deployment records for an artifact metadata associated with - an organization. - tags: - - orgs - operationId: orgs/list-artifact-deployment-records - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records - parameters: - - *75 - - name: subject_digest - description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. - in: path - required: true - schema: - type: string - minLength: 71 - maxLength: 71 - pattern: "^sha256:[a-f0-9]{64}$" - responses: - '200': - description: Successful response - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of deployment records for this digest - and organization - example: 3 - type: integer - deployment_records: - type: array - items: *173 - examples: - default: *174 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: artifact-metadata - "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": - get: - summary: List artifact storage records - description: |- - List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. - - The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. - tags: - - orgs - operationId: orgs/list-artifact-storage-records - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records - parameters: - - *75 - - name: subject_digest - description: The parameter should be set to the attestation's subject's SHA256 - digest, in the form `sha256:HEX_DIGEST`. - in: path - required: true - example: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - schema: - type: string - minLength: 71 - maxLength: 71 - pattern: "^sha256:[a-f0-9]{64}$" - x-multi-segment: true - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of storage records for this digest and - organization - example: 3 - type: integer - storage_records: - type: array - items: - type: object - properties: - id: - type: integer - name: - type: string - digest: - type: string - artifact_url: - type: string - registry_url: - type: string - repository: - type: string - status: - type: string - created_at: - type: string - updated_at: - type: string - examples: - default: - value: - storage_records: - - name: libfoo-1.2.3 - digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 - artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 - registry_url: https://reg.example.com/artifactory/ - repository: bar - status: active - created_at: '2023-10-01T12:00:00Z' - updated_at: '2023-10-01T12:00:00Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: artifact-metadata - "/orgs/{org}/attestations/bulk-list": - post: - summary: List attestations by bulk subject digests - description: |- - List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. - - The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - tags: - - orgs - operationId: orgs/list-attestations-bulk - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests - parameters: - - *17 - - *47 - - *48 - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - subject_digests: - type: array - items: - type: string - description: List of subject digests to fetch attestations for. - minItems: 1 - maxItems: 1024 - predicate_type: - type: string - description: |- - Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, `release`, or freeform text - for custom predicate types. - required: - - subject_digests - examples: - default: &717 - value: - subject_digests: - - sha256:abc123 - - sha512:def456 - withPredicateType: &718 - value: - subject_digests: - - sha256:abc123 - - sha512:def456 - predicateType: provenance - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - attestations_subject_digests: - type: object - additionalProperties: - nullable: true - type: array - items: - type: object - properties: - bundle: - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: {} - additionalProperties: true - dsseEnvelope: - type: object - properties: {} - additionalProperties: true - description: The bundle of the attestation. - repository_id: - type: integer - bundle_url: - type: string - description: Mapping of subject digest to bundles. - page_info: - type: object - properties: - has_next: - type: boolean - description: Indicates whether there is a next page. - has_previous: - type: boolean - description: Indicates whether there is a previous page. - next: - type: string - description: The cursor to the next page. - previous: - type: string - description: The cursor to the previous page. - description: Information about the current page. - examples: - default: &719 - value: - attestations_subject_digests: - - sha256:abc: - - bundle: - mediaType: application/vnd.dev.sigstore.bundle.v0.3+json - verificationMaterial: - tlogEntries: - - logIndex: '97913980' - logId: - keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= - kindVersion: - kind: dsse - version: 0.0.1 - integratedTime: '1716998992' - inclusionPromise: - signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL - inclusionProof: - logIndex: '93750549' - rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= - treeSize: '93750551' - hashes: - - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= - - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= - - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= - - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= - - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= - - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= - - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= - - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= - - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= - - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= - - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= - - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= - - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= - checkpoint: - envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” - rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n - canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= - timestampVerificationData: {} - certificate: - rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== - dsseEnvelope: - payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 - payloadType: application/vnd.in-toto+json - signatures: - - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== - repository_id: 1 - - bundle: - mediaType: application/vnd.dev.sigstore.bundle.v0.3+json - verificationMaterial: - tlogEntries: - - logIndex: '97913980' - logId: - keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= - kindVersion: - kind: dsse - version: 0.0.1 - integratedTime: '1716998992' - inclusionPromise: - signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL - inclusionProof: - logIndex: '93750549' - rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= - treeSize: '93750551' - hashes: - - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= - - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= - - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= - - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= - - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= - - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= - - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= - - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= - - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= - - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= - - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= - - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= - - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= - checkpoint: - envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” - rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n - canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= - timestampVerificationData: {} - certificate: - rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== - dsseEnvelope: - payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 - payloadType: application/vnd.in-toto+json - signatures: - - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== - repository_id: 1 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: attestations - x-github-breaking-changes: - - changeset: remove_bundle - patch: - responses: - '200': - content: - application/json: - schema: - properties: - attestations_subject_digests: - additionalProperties: - items: - properties: - bundle: - version: '2026-03-10' - "/orgs/{org}/attestations/delete-request": - post: - summary: Delete attestations in bulk - description: Delete artifact attestations in bulk by either subject digests - or unique ID. - tags: - - orgs - operationId: orgs/delete-attestations-bulk - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - oneOf: - - properties: - subject_digests: - type: array - items: - type: string - description: List of subject digests associated with the artifact - attestations to delete. - minItems: 1 - maxItems: 1024 - required: - - subject_digests - - properties: - attestation_ids: - type: array - items: - type: integer - description: List of unique IDs associated with the artifact attestations - to delete. - minItems: 1 - maxItems: 1024 - required: - - attestation_ids - description: The request body must include either `subject_digests` - or `attestation_ids`, but not both. - examples: - by-subject-digests: - summary: Delete by subject digests - value: - subject_digests: - - sha256:abc123 - - sha512:def456 - by-attestation-ids: - summary: Delete by attestation IDs - value: - attestation_ids: - - 111 - - 222 - responses: - '200': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: attestations - "/orgs/{org}/attestations/digest/{subject_digest}": - delete: - summary: Delete attestations by subject digest - description: Delete an artifact attestation by subject digest. - tags: - - orgs - operationId: orgs/delete-attestations-by-subject-digest - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest - parameters: - - *75 - - name: subject_digest - description: Subject Digest - in: path - required: true - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: attestations - "/orgs/{org}/attestations/repositories": - get: - summary: List attestation repositories - description: |- - List repositories owned by the provided organization that have created at least one attested artifact - Results will be sorted in ascending order by repository ID - tags: - - orgs - operationId: orgs/list-attestation-repositories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories - parameters: - - *17 - - *47 - - *48 - - *75 - - name: predicate_type - description: |- - Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, `release`, or freeform text - for custom predicate types. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: object - properties: - id: - type: integer - name: - type: string - examples: - default: - value: - - id: 123 - name: foo - - id: 456 - name: bar - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: attestations - "/orgs/{org}/attestations/{attestation_id}": - delete: - summary: Delete attestations by ID - description: Delete an artifact attestation by unique ID that is associated - with a repository owned by an org. - tags: - - orgs - operationId: orgs/delete-attestations-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id - parameters: - - *75 - - name: attestation_id - description: Attestation ID - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - '204': - description: Response - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: attestations - "/orgs/{org}/attestations/{subject_digest}": - get: - summary: List attestations - description: |- - List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. - - The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - tags: - - orgs - operationId: orgs/list-attestations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/attestations#list-attestations - parameters: - - *17 - - *47 - - *48 - - *75 - - name: subject_digest - description: The parameter should be set to the attestation's subject's SHA256 - digest, in the form `sha256:HEX_DIGEST`. - in: path - required: true - schema: - type: string - x-multi-segment: true - - name: predicate_type - description: |- - Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, `release`, or freeform text - for custom predicate types. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - attestations: - type: array - items: - type: object - properties: - bundle: - nullable: true - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: {} - additionalProperties: true - dsseEnvelope: - type: object - properties: {} - additionalProperties: true - description: |- - The attestation's Sigstore Bundle. - Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - repository_id: - type: integer - bundle_url: - type: string - initiator: - type: string - examples: - default: &405 - value: - attestations: - - bundle: - mediaType: application/vnd.dev.sigstore.bundle.v0.3+json - verificationMaterial: - tlogEntries: - - logIndex: '97913980' - logId: - keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= - kindVersion: - kind: dsse - version: 0.0.1 - integratedTime: '1716998992' - inclusionPromise: - signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL - inclusionProof: - logIndex: '93750549' - rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= - treeSize: '93750551' - hashes: - - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= - - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= - - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= - - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= - - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= - - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= - - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= - - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= - - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= - - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= - - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= - - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= - - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= - checkpoint: - envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” - rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n - canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= - timestampVerificationData: {} - certificate: - rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== - dsseEnvelope: - payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 - payloadType: application/vnd.in-toto+json - signatures: - - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== - repository_id: 1 - - bundle: - mediaType: application/vnd.dev.sigstore.bundle.v0.3+json - verificationMaterial: - tlogEntries: - - logIndex: '97913980' - logId: - keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= - kindVersion: - kind: dsse - version: 0.0.1 - integratedTime: '1716998992' - inclusionPromise: - signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL - inclusionProof: - logIndex: '93750549' - rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= - treeSize: '93750551' - hashes: - - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= - - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= - - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= - - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= - - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= - - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= - - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= - - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= - - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= - - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= - - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= - - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= - - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= - checkpoint: - envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” - rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n - canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= - timestampVerificationData: {} - certificate: - rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== - dsseEnvelope: - payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 - payloadType: application/vnd.in-toto+json - signatures: - - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== - repository_id: 1 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: attestations - x-github-breaking-changes: - - changeset: remove_bundle - patch: - responses: - '200': - content: - application/json: - schema: - properties: - attestations: - items: - properties: - bundle: - version: '2026-03-10' - "/orgs/{org}/blocks": - get: - summary: List users blocked by an organization - description: List the users blocked by an organization. - tags: - - orgs - operationId: orgs/list-blocked-users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: blocking - "/orgs/{org}/blocks/{username}": - get: - summary: Check if a user is blocked by an organization - description: Returns a 204 if the given user is blocked by the given organization. - Returns a 404 if the organization is not blocking the user, or if the user - account has been identified as spam by GitHub. - tags: - - orgs - operationId: orgs/check-blocked-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization - parameters: - - *75 - - *71 - responses: - '204': - description: If the user is blocked - '404': - description: If the user is not blocked - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: blocking - put: - summary: Block a user from an organization - description: Blocks the given user on behalf of the specified organization and - returns a 204. If the organization cannot block the given user a 422 is returned. - tags: - - orgs - operationId: orgs/block-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization - parameters: - - *75 - - *71 - responses: - '204': - description: Response - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: blocking - delete: - summary: Unblock a user from an organization - description: Unblocks the given user on behalf of the specified organization. - tags: - - orgs - operationId: orgs/unblock-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization - parameters: - - *75 - - *71 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: blocking - "/orgs/{org}/campaigns": - get: - summary: List campaigns for an organization - description: |- - Lists campaigns in an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. - tags: - - campaigns - operationId: campaigns/list-org-campaigns - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization - parameters: - - *75 - - *19 - - *17 - - *61 - - name: state - description: If specified, only campaigns with this state will be returned. - in: query - required: false - schema: &175 - title: Campaign state - description: Indicates whether a campaign is open or closed - type: string - enum: - - open - - closed - - name: sort - description: The property by which to sort the results. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - ends_at - - published - default: created - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &176 - title: Campaign summary - description: The campaign metadata and alert stats. - type: object - properties: - number: - type: integer - description: The number of the newly created campaign - created_at: - type: string - format: date-time - description: The date and time the campaign was created, in - ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - updated_at: - type: string - format: date-time - description: The date and time the campaign was last updated, - in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - name: - type: string - description: The campaign name - description: - type: string - description: The campaign description - managers: - description: The campaign managers - type: array - items: *4 - team_managers: - description: The campaign team managers - type: array - items: &197 - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: string - nullable: true - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to - which this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which - this team belongs - example: 42 - parent: - title: Team Simple - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: &258 - id: - description: Unique identifier of the team - type: integer - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - example: Justice League - description: - description: Description of the team - type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have for - its repositories - type: string - example: admin - privacy: - description: The level of privacy this team should - have - type: string - example: closed - notification_setting: - description: The notification setting the team has - set - type: string - example: notifications_enabled - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: - type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps - to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com - type: string - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization - to which this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to - which this team belongs - example: 42 - required: &259 - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - type - nullable: true - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - - type - published_at: - description: The date and time the campaign was published, in - ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - ends_at: - description: The date and time the campaign has ended, in ISO - 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - closed_at: - description: The date and time the campaign was closed, in ISO - 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign - is still open. - type: string - format: date-time - nullable: true - state: *175 - contact_link: - description: The contact link of the campaign. - type: string - format: uri - nullable: true - alert_stats: - type: object - additionalProperties: false - properties: - open_count: - type: integer - description: The number of open alerts - closed_count: - type: integer - description: The number of closed alerts - in_progress_count: - type: integer - description: The number of in-progress alerts - required: - - open_count - - closed_count - - in_progress_count - required: - - number - - created_at - - updated_at - - description - - managers - - ends_at - - state - - contact_link - examples: - default: - value: - - number: 3 - created_at: '2024-02-14T12:29:18Z' - updated_at: '2024-02-14T12:29:18Z' - name: Critical CodeQL alert - description: Address critical alerts before they are exploited - to prevent breaches, protect sensitive data, and mitigate financial - and reputational damage. - managers: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - ends_at: '2024-03-14T12:29:18Z' - closed_at: - state: open - - number: 4 - created_at: '2024-03-30T12:29:18Z' - updated_at: '2024-03-30T12:29:18Z' - name: Mitre top 10 KEV - description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) - to enhance security by addressing vulnerabilities actively exploited - by attackers. This reduces risk, prevents breaches and can help - protect sensitive data. - managers: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - ends_at: '2024-04-30T12:29:18Z' - closed_at: - state: open - headers: - Link: *67 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: campaigns - subcategory: campaigns - post: - summary: Create a campaign for an organization - description: |- - Create a campaign for an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. - - Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included - in the campaign. - tags: - - campaigns - operationId: campaigns/create-campaign - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - name: - description: The name of the campaign - type: string - minLength: 1 - maxLength: 50 - description: - description: A description for the campaign - type: string - minLength: 1 - maxLength: 255 - managers: - description: The logins of the users to set as the campaign managers. - At this time, only a single manager can be supplied. - type: array - maxItems: 10 - items: - description: The login of each manager - type: string - team_managers: - description: The slugs of the teams to set as the campaign managers. - type: array - maxItems: 10 - items: - description: The slug of each team - type: string - ends_at: - description: The end date and time of the campaign. The date must - be in the future. - type: string - format: date-time - contact_link: - description: The contact link of the campaign. Must be a URI. - type: string - format: uri - nullable: true - code_scanning_alerts: - description: The code scanning alerts to include in this campaign - type: array - minItems: 1 - items: - type: object - additionalProperties: false - properties: - repository_id: - type: integer - description: The repository id - alert_numbers: - type: array - description: The alert numbers - minItems: 1 - items: - type: integer - required: - - repository_id - - alert_numbers - nullable: true - generate_issues: - description: If true, will automatically generate issues for the - campaign. The default is false. - type: boolean - default: false - required: - - name - - description - - ends_at - oneOf: - - required: - - code_scanning_alerts - - required: - - secret_scanning_alerts - examples: - default: - value: - name: Critical CodeQL alerts - description: Address critical alerts before they are exploited to - prevent breaches, protect sensitive data, and mitigate financial - and reputational damage. - managers: - - octocat - ends_at: '2024-03-14T00:00:00Z' - code_scanning_alerts: - - repository_id: 1296269 - alert_numbers: - - 1 - - 2 - responses: - '200': - description: Response - content: - application/json: - schema: *176 - examples: - default: &177 - value: - number: 3 - created_at: '2024-02-14T12:29:18Z' - updated_at: '2024-02-14T12:29:18Z' - name: Critical CodeQL alert - description: Address critical alerts before they are exploited - to prevent breaches, protect sensitive data, and mitigate financial - and reputational damage. - managers: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - published_at: '2024-02-14T12:29:18Z' - ends_at: '2024-03-14T12:29:18Z' - closed_at: - state: open - alert_stats: - open_count: 10 - closed_count: 3 - in_progress_count: 3 - '400': - description: Bad Request - content: - application/json: - schema: *3 - '404': *6 - '422': - description: Unprocessable Entity - content: - application/json: - schema: *3 - '429': - description: Too Many Requests - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: campaigns - subcategory: campaigns - "/orgs/{org}/campaigns/{campaign_number}": - get: - summary: Get a campaign for an organization - description: |- - Gets a campaign for an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. - tags: - - campaigns - operationId: campaigns/get-campaign-summary - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization - parameters: - - *75 - - name: campaign_number - description: The campaign number. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *176 - examples: - default: *177 - '404': *6 - '422': - description: Unprocessable Entity - content: - application/json: - schema: *3 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: campaigns - subcategory: campaigns - patch: - summary: Update a campaign - description: |- - Updates a campaign in an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. - tags: - - campaigns - operationId: campaigns/update-campaign - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign - parameters: - - *75 - - name: campaign_number - description: The campaign number. - in: path - required: true - schema: - type: integer - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - name: - description: The name of the campaign - type: string - minLength: 1 - maxLength: 50 - description: - description: A description for the campaign - type: string - minLength: 1 - maxLength: 255 - managers: - description: The logins of the users to set as the campaign managers. - At this time, only a single manager can be supplied. - type: array - maxItems: 10 - items: - type: string - team_managers: - description: The slugs of the teams to set as the campaign managers. - type: array - maxItems: 10 - items: - description: The slug of each team - type: string - ends_at: - description: The end date and time of the campaign, in ISO 8601 - format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - contact_link: - description: The contact link of the campaign. Must be a URI. - type: string - format: uri - nullable: true - state: *175 - examples: - default: - value: - name: Critical CodeQL alerts - responses: - '200': - description: Response - content: - application/json: - schema: *176 - examples: - default: *177 - '400': - description: Bad Request - content: - application/json: - schema: *3 - '404': *6 - '422': - description: Unprocessable Entity - content: - application/json: - schema: *3 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: campaigns - subcategory: campaigns - delete: - summary: Delete a campaign for an organization - description: |- - Deletes a campaign in an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. - tags: - - campaigns - operationId: campaigns/delete-campaign - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization - parameters: - - *75 - - name: campaign_number - description: The campaign number. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Deletion successful - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: campaigns - subcategory: campaigns - "/orgs/{org}/code-scanning/alerts": - get: - summary: List code scanning alerts for an organization - description: |- - Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/list-alerts-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization - parameters: - - *75 - - &430 - name: tool_name - description: The name of a code scanning tool. Only results by this tool will - be listed. You can specify the tool by using either `tool_name` or `tool_guid`, - but not both. - in: query - required: false - schema: &185 - type: string - description: The name of the tool used to generate the code scanning analysis. - - &431 - name: tool_guid - description: The GUID of a code scanning tool. Only results by this tool will - be listed. Note that some code scanning tools may not include a GUID in - their analysis data. You can specify the tool by using either `tool_guid` - or `tool_name`, but not both. - in: query - required: false - schema: &186 - nullable: true - type: string - description: The GUID of the tool used to generate the code scanning analysis, - if provided in the uploaded SARIF data. - - *47 - - *48 - - *19 - - *17 - - *61 - - name: state - description: If specified, only code scanning alerts with this state will - be returned. - in: query - required: false - schema: &433 - type: string - description: State of a code scanning alert. - enum: - - open - - closed - - dismissed - - fixed - - name: sort - description: The property by which to sort the results. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - name: severity - description: If specified, only code scanning alerts with this severity will - be returned. - in: query - required: false - schema: &434 - type: string - description: Severity of a code scanning alert. - enum: - - critical - - high - - medium - - low - - warning - - note - - error - - name: assignees - description: | - Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). - Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: object - properties: - number: *178 - created_at: *179 - updated_at: *180 - url: *181 - html_url: *182 - instances_url: &435 - type: string - description: The REST API URL for fetching the list of instances - for an alert. - format: uri - readOnly: true - state: &187 - type: string - description: State of a code scanning alert. - nullable: true - enum: - - open - - dismissed - - fixed - fixed_at: *183 - dismissed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - dismissed_at: *184 - dismissed_reason: &436 - type: string - description: "**Required when the state is dismissed.** The - reason for dismissing or closing the alert." - nullable: true - enum: - - false positive - - won't fix - - used in tests - dismissed_comment: &437 - type: string - description: The dismissal comment associated with the dismissal - of the alert. - nullable: true - maxLength: 280 - rule: &438 - type: object - properties: - id: - nullable: true - type: string - description: A unique identifier for the rule used to detect - the alert. - name: - type: string - description: The name of the rule used to detect the alert. - severity: - nullable: true - type: string - description: The severity of the alert. - enum: - - none - - note - - warning - - error - security_severity_level: - nullable: true - type: string - description: The security severity of the alert. - enum: - - low - - medium - - high - - critical - description: - type: string - description: A short description of the rule used to detect - the alert. - full_description: - type: string - description: A description of the rule used to detect the - alert. - tags: - nullable: true - type: array - description: A set of tags applicable for the rule. - items: - type: string - help: - nullable: true - type: string - description: Detailed documentation for the rule as GitHub - Flavored Markdown. - help_uri: - nullable: true - type: string - description: A link to the documentation for the rule used - to detect the alert. - tool: &439 - type: object - properties: - name: *185 - version: - nullable: true - type: string - description: The version of the tool used to generate the - code scanning analysis. - guid: *186 - most_recent_instance: &440 - type: object - properties: - ref: &432 - type: string - description: |- - The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - `refs/heads/` or simply ``. - analysis_key: &450 - type: string - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - environment: &451 - type: string - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - category: &452 - type: string - description: Identifies the configuration under which the - analysis was executed. Used to distinguish between multiple - analyses for the same tool and commit, but performed on - different languages or different parts of the code. - state: *187 - commit_sha: - type: string - message: - type: object - properties: - text: - type: string - markdown: - type: string - description: The message text as GitHub-flavored Markdown, - with placeholder links for related locations replaced - by links to the relevant code. Only populated when - related locations are available for the alert instance. - location: &453 - type: object - description: Describe a region within a file for the alert. - properties: - path: - type: string - start_line: - type: integer - end_line: - type: integer - start_column: - type: integer - end_column: - type: integer - html_url: - type: string - classifications: - type: array - description: |- - Classifications that have been applied to the file that triggered the alert. - For example identifying it as documentation, or a generated file. - items: &454 - type: string - description: A classification of the file. For example - to identify it as generated. - nullable: true - enum: - - source - - generated - - test - - library - repository: *66 - dismissal_approved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignees: - type: array - items: *4 - required: - - number - - created_at - - url - - html_url - - instances_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - - most_recent_instance - - repository - examples: - default: - value: - - number: 4 - created_at: '2020-02-13T12:29:18Z' - url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 - html_url: https://github.com/octocat/hello-world/code-scanning/4 - state: open - dismissed_by: - dismissed_at: - dismissed_reason: - dismissed_comment: - rule: - id: js/zipslip - severity: error - tags: - - security - - external/cwe/cwe-022 - description: Arbitrary file write during zip extraction - name: js/zipslip - tool: - name: CodeQL - guid: - version: 2.4.0 - most_recent_instance: - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: "{}" - state: open - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: spec-main/api-session-spec.ts - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: - - test - instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - - number: 3 - created_at: '2020-02-13T12:29:18Z' - url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 - html_url: https://github.com/octocat/hello-world/code-scanning/3 - state: dismissed - dismissed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_at: '2020-02-14T12:29:18Z' - dismissed_reason: false positive - dismissed_comment: This alert is not actually correct, because - there's a sanitizer included in the library. - rule: - id: js/zipslip - severity: error - tags: - - security - - external/cwe/cwe-022 - description: Arbitrary file write during zip extraction - name: js/zipslip - tool: - name: CodeQL - guid: - version: 2.4.0 - most_recent_instance: - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: "{}" - state: open - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: lib/ab12-gen.js - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: [] - instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - headers: - Link: *67 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - "/orgs/{org}/code-security/configurations": - get: - summary: Get code security configurations for an organization - description: |- - Lists all code security configurations available in an organization. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-configurations-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization - parameters: - - *75 - - name: target_type - in: query - description: The target type of the code security configuration - required: false - schema: - type: string - enum: - - global - - all - default: all - - name: per_page - in: query - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - required: false - schema: - type: integer - default: 30 - - *47 - - *48 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *49 - examples: - default: - value: - - id: 17 - target_type: global - name: GitHub recommended - description: Suggested settings for Dependabot, secret scanning, - and code scanning. - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: not_set - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - code_scanning_delegated_alert_dismissal: enabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: enabled - secret_scanning_non_provider_patterns: enabled - secret_scanning_delegated_alert_dismissal: not_set - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/17 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view - created_at: '2023-12-04T15:58:07Z' - updated_at: '2023-12-04T15:58:07Z' - - id: 1326 - target_type: organization - name: High risk settings - description: This is a code security configuration for octo-org - high risk repositories - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: enabled - code_scanning_default_setup: enabled - code_scanning_delegated_alert_dismissal: enabled - secret_scanning: enabled - secret_scanning_push_protection: enabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - secret_scanning_delegated_alert_dismissal: disabled - private_vulnerability_reporting: enabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 - created_at: '2024-05-10T00:00:00Z' - updated_at: '2024-05-10T00:00:00Z' - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - post: - summary: Create a code security configuration - description: |- - Creates a code security configuration in an organization. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/create-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - name: - type: string - description: The name of the code security configuration. Must be - unique within the organization. - description: - type: string - description: A description of the code security configuration - maxLength: 255 - advanced_security: - type: string - description: | - The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. - - > [!WARNING] - > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. - enum: - - enabled - - disabled - - code_security - - secret_protection - default: disabled - code_security: - type: string - description: The enablement status of GitHub Code Security features. - enum: - - enabled - - disabled - - not_set - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - default: enabled - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - default: disabled - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - default: false - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - default: disabled - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - default: disabled - dependabot_delegated_alert_dismissal: - type: string - description: The enablement status of Dependabot delegated alert - dismissal. Requires Dependabot alerts to be enabled. - enum: - - enabled - - disabled - - not_set - default: disabled - code_scanning_options: *53 - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default setup - enum: - - enabled - - disabled - - not_set - default: disabled - code_scanning_default_setup_options: *52 - code_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of code scanning delegated alert - dismissal - enum: - - enabled - - disabled - - not_set - default: not_set - secret_protection: - type: string - description: The enablement status of GitHub Secret Protection features. - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_delegated_bypass: - type: string - description: The enablement status of secret scanning delegated - bypass - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_delegated_bypass_options: - type: object - description: Feature options for secret scanning delegated bypass - properties: - reviewers: - type: array - description: The bypass reviewers for secret scanning delegated - bypass - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected as a - bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - mode: - type: string - description: The bypass mode for the reviewer - enum: - - ALWAYS - - EXEMPT - default: ALWAYS - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity checks - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non provider - patterns - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_generic_secrets: - type: string - description: The enablement status of Copilot secret scanning - enum: - - enabled - - disabled - - not_set - default: disabled - secret_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of secret scanning delegated - alert dismissal - enum: - - enabled - - disabled - - not_set - secret_scanning_extended_metadata: - type: string - description: The enablement status of secret scanning extended metadata - enum: - - enabled - - disabled - - not_set - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability reporting - enum: - - enabled - - disabled - - not_set - default: disabled - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - default: enforced - required: - - name - - description - examples: - default: - summary: Example for a code security configuration - value: - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependabot_alerts: enabled - dependabot_security_updates: not_set - secret_scanning: enabled - responses: - '201': - description: Successfully created code security configuration - content: - application/json: - schema: *49 - examples: - default: *188 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/code-security/configurations/defaults": - get: - summary: Get default code security configurations - description: |- - Lists the default code security configurations for an organization. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-default-configurations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *189 - examples: - default: *190 - '304': *37 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/code-security/configurations/detach": - delete: - summary: Detach configurations from repositories - description: |- - Detach code security configuration(s) from a set of repositories. - Repositories will retain their settings but will no longer be associated with the configuration. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/detach-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - selected_repository_ids: - type: array - description: An array of repository IDs to detach from configurations. - Up to 250 IDs can be provided. - minItems: 1 - maxItems: 250 - items: - type: integer - description: Unique identifier of the repository. - examples: - default: - summary: Example for detaching repositories from configurations. - value: - selected_repository_ids: - - 32 - - 91 - responses: - '204': *191 - '400': *14 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/code-security/configurations/{configuration_id}": - get: - summary: Get a code security configuration - description: |- - Gets a code security configuration available in an organization. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration - parameters: - - *75 - - *51 - responses: - '200': - description: Response - content: - application/json: - schema: *49 - examples: - default: *188 - '304': *37 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - patch: - summary: Update a code security configuration - description: |- - Updates a code security configuration in an organization. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/update-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration - parameters: - - *75 - - *51 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - name: - type: string - description: The name of the code security configuration. Must be - unique within the organization. - description: - type: string - description: A description of the code security configuration - maxLength: 255 - advanced_security: - type: string - description: | - The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. - - > [!WARNING] - > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. - enum: - - enabled - - disabled - - code_security - - secret_protection - code_security: - type: string - description: The enablement status of GitHub Code Security features. - enum: - - enabled - - disabled - - not_set - dependency_graph: - type: string - description: The enablement status of Dependency Graph - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action: - type: string - description: The enablement status of Automatic dependency submission - enum: - - enabled - - disabled - - not_set - dependency_graph_autosubmit_action_options: - type: object - description: Feature options for Automatic dependency submission - properties: - labeled_runners: - type: boolean - description: Whether to use runners labeled with 'dependency-submission' - or standard GitHub runners. - dependabot_alerts: - type: string - description: The enablement status of Dependabot alerts - enum: - - enabled - - disabled - - not_set - dependabot_security_updates: - type: string - description: The enablement status of Dependabot security updates - enum: - - enabled - - disabled - - not_set - dependabot_delegated_alert_dismissal: - type: string - description: The enablement status of Dependabot delegated alert - dismissal. Requires Dependabot alerts to be enabled. - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup: - type: string - description: The enablement status of code scanning default setup - enum: - - enabled - - disabled - - not_set - code_scanning_default_setup_options: *52 - code_scanning_options: *53 - code_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of code scanning delegated alert - dismissal - enum: - - enabled - - disabled - - not_set - default: disabled - secret_protection: - type: string - description: The enablement status of GitHub Secret Protection features. - enum: - - enabled - - disabled - - not_set - secret_scanning: - type: string - description: The enablement status of secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_push_protection: - type: string - description: The enablement status of secret scanning push protection - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass: - type: string - description: The enablement status of secret scanning delegated - bypass - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_bypass_options: - type: object - description: Feature options for secret scanning delegated bypass - properties: - reviewers: - type: array - description: The bypass reviewers for secret scanning delegated - bypass - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected as a - bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - mode: - type: string - description: The bypass mode for the reviewer - enum: - - ALWAYS - - EXEMPT - default: ALWAYS - secret_scanning_validity_checks: - type: string - description: The enablement status of secret scanning validity checks - enum: - - enabled - - disabled - - not_set - secret_scanning_non_provider_patterns: - type: string - description: The enablement status of secret scanning non-provider - patterns - enum: - - enabled - - disabled - - not_set - secret_scanning_generic_secrets: - type: string - description: The enablement status of Copilot secret scanning - enum: - - enabled - - disabled - - not_set - secret_scanning_delegated_alert_dismissal: - type: string - description: The enablement status of secret scanning delegated - alert dismissal - enum: - - enabled - - disabled - - not_set - secret_scanning_extended_metadata: - type: string - description: The enablement status of secret scanning extended metadata - enum: - - enabled - - disabled - - not_set - private_vulnerability_reporting: - type: string - description: The enablement status of private vulnerability reporting - enum: - - enabled - - disabled - - not_set - enforcement: - type: string - description: The enforcement status for a security configuration - enum: - - enforced - - unenforced - examples: - default: - summary: Example for updating a code security configuration - value: - name: octo-org recommended settings v2 - secret_scanning: disabled - code_scanning_default_setup: enabled - responses: - '200': - description: Response when a configuration is updated - content: - application/json: - schema: *49 - examples: - default: - value: - id: 1325 - target_type: organization - name: octo-org recommended settings v2 - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: enabled - code_scanning_default_setup_options: - runner_type: not_set - runner_label: - code_scanning_options: - allow_advanced: false - code_scanning_delegated_alert_dismissal: disabled - secret_scanning: disabled - secret_scanning_push_protection: disabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - secret_scanning_generic_secrets: disabled - secret_scanning_delegated_alert_dismissal: disabled - private_vulnerability_reporting: disabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - '204': - description: Response when no new updates are made - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - delete: - summary: Delete a code security configuration - description: |- - Deletes the desired code security configuration from an organization. - Repositories attached to the configuration will retain their settings but will no longer be associated with - the configuration. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/delete-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration - parameters: - - *75 - - *51 - responses: - '204': *191 - '400': *14 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/code-security/configurations/{configuration_id}/attach": - post: - summary: Attach a configuration to repositories - description: |- - Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. - - If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/attach-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories - parameters: - - *75 - - *51 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - scope: - type: string - description: The type of repositories to attach the configuration - to. `selected` means the configuration will be attached to only - the repositories specified by `selected_repository_ids` - enum: - - all - - all_without_configurations - - public - - private_or_internal - - selected - selected_repository_ids: - type: array - description: An array of repository IDs to attach the configuration - to. You can only provide a list of repository ids when the `scope` - is set to `selected`. - items: - type: integer - description: Unique identifier of the repository. - required: - - scope - examples: - default: - summary: Example for attaching a configuration to some repositories - value: - scope: selected - selected_repository_ids: - - 32 - - 91 - responses: - '202': *39 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": - put: - summary: Set a code security configuration as a default for an organization - description: |- - Sets a code security configuration as a default to be applied to new repositories in your organization. - - This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/set-configuration-as-default - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization - parameters: - - *75 - - *51 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - default_for_new_repos: - type: string - description: Specify which types of repository this security configuration - should be applied to by default. - enum: - - all - - none - - private_and_internal - - public - examples: - default: - summary: Set this configuration to be enabled by default on all new - repositories. - value: - default_for_new_repos: all - responses: - '200': - description: Default successfully changed. - content: - application/json: - schema: - type: object - properties: - default_for_new_repos: - type: string - description: Specifies which types of repository this security - configuration is applied to by default. - enum: - - all - - none - - private_and_internal - - public - configuration: *49 - examples: - default: - value: - default_for_new_repos: all - configuration: *188 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": - get: - summary: Get repositories associated with a code security configuration - description: |- - Lists the repositories associated with a code security configuration in an organization. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-repositories-for-configuration - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration - parameters: - - *75 - - *51 - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - required: false - schema: - type: integer - default: 30 - - *47 - - *48 - - name: status - description: |- - A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. - - Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` - in: query - required: false - schema: - type: string - default: all - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *192 - examples: - default: - summary: Example of code security configuration repositories - value: - - status: attached - repository: *193 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/orgs/{org}/codespaces": - get: - summary: List codespaces for the organization - description: |- - Lists the codespaces associated to a specified organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-in-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization - parameters: - - *17 - - *19 - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - codespaces - properties: - total_count: - type: integer - codespaces: - type: array - items: &248 - type: object - title: Codespace - description: A codespace. - properties: - id: - type: integer - format: int64 - example: 1 - name: - description: Automatically generated name of this codespace. - type: string - example: monalisa-octocat-hello-world-g4wpq6h95q - display_name: - description: Display name for this codespace. - type: string - example: bookish space pancake - nullable: true - environment_id: - description: UUID identifying this codespace's environment. - type: string - example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 - nullable: true - owner: *4 - billable_owner: *4 - repository: *160 - machine: - type: object - title: Codespace machine - description: A description of the machine powering a codespace. - properties: &466 - name: - type: string - description: The name of the machine. - example: standardLinux - display_name: - type: string - description: The display name of the machine includes - cores, memory, and storage. - example: 4 cores, 16 GB RAM, 64 GB storage - operating_system: - type: string - description: The operating system of the machine. - example: linux - storage_in_bytes: - type: integer - description: How much storage is available to the codespace. - example: 68719476736 - memory_in_bytes: - type: integer - description: How much memory is available to the codespace. - example: 17179869184 - cpus: - type: integer - description: How many cores are available to the codespace. - example: 4 - prebuild_availability: - type: string - description: Whether a prebuild is currently available - when creating a codespace for this machine and repository. - If a branch was not specified as a ref, the default - branch will be assumed. Value will be "null" if prebuilds - are not supported or prebuild availability could not - be determined. Value will be "none" if no prebuild - is available. Latest values "ready" and "in_progress" - indicate the prebuild availability status. - example: ready - enum: - - none - - ready - - in_progress - nullable: true - required: &467 - - name - - display_name - - operating_system - - storage_in_bytes - - memory_in_bytes - - cpus - - prebuild_availability - nullable: true - devcontainer_path: - description: Path to devcontainer.json from repo root used - to create Codespace. - type: string - example: ".devcontainer/example/devcontainer.json" - nullable: true - prebuild: - description: Whether the codespace was created from a prebuild. - type: boolean - example: false - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - last_used_at: - description: Last known time this codespace was started. - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - state: - description: State of this codespace. - enum: - - Unknown - - Created - - Queued - - Provisioning - - Available - - Awaiting - - Unavailable - - Deleted - - Moved - - Shutdown - - Archived - - Starting - - ShuttingDown - - Failed - - Exporting - - Updating - - Rebuilding - example: Available - type: string - url: - description: API URL for this codespace. - type: string - format: uri - git_status: - description: Details about the codespace's git repository. - type: object - properties: - ahead: - description: The number of commits the local repository - is ahead of the remote. - type: integer - example: 0 - behind: - description: The number of commits the local repository - is behind the remote. - type: integer - example: 0 - has_unpushed_changes: - description: Whether the local repository has unpushed - changes. - type: boolean - has_uncommitted_changes: - description: Whether the local repository has uncommitted - changes. - type: boolean - ref: - description: The current branch (or SHA if in detached - HEAD state) of the local repository. - type: string - example: main - location: - description: The initally assigned location of a new codespace. - enum: - - EastUs - - SouthEastAsia - - WestEurope - - WestUs2 - example: WestUs2 - type: string - idle_timeout_minutes: - description: The number of minutes of inactivity after which - this codespace will be automatically stopped. - type: integer - example: 60 - nullable: true - web_url: - description: URL to access this codespace on the web. - type: string - format: uri - machines_url: - description: API URL to access available alternate machine - types for this codespace. - type: string - format: uri - start_url: - description: API URL to start this codespace. - type: string - format: uri - stop_url: - description: API URL to stop this codespace. - type: string - format: uri - publish_url: - description: API URL to publish this codespace to a new - repository. - type: string - format: uri - nullable: true - pulls_url: - description: API URL for the Pull Request associated with - this codespace, if any. - type: string - format: uri - nullable: true - recent_folders: - type: array - items: - type: string - runtime_constraints: - type: object - properties: - allowed_port_privacy_settings: - description: The privacy settings a user can select - from when forwarding a port. - type: array - items: - type: string - nullable: true - pending_operation: - description: Whether or not a codespace has a pending async - operation. This would mean that the codespace is temporarily - unavailable. The only thing that you can do with a codespace - in this state is delete it. - type: boolean - nullable: true - pending_operation_disabled_reason: - description: Text to show user when codespace is disabled - by a pending operation - type: string - nullable: true - idle_timeout_notice: - description: Text to show user when codespace idle timeout - minutes has been overriden by an organization policy - type: string - nullable: true - retention_period_minutes: - description: Duration in minutes after codespace has gone - idle in which it will be deleted. Must be integer minutes - between 0 and 43200 (30 days). - type: integer - example: 60 - nullable: true - retention_expires_at: - description: When a codespace will be auto-deleted based - on the "retention_period_minutes" and "last_used_at" - type: string - format: date-time - example: '2011-01-26T20:01:12Z' - nullable: true - last_known_stop_notice: - description: The text to display to a user when a codespace - has been stopped for a potentially actionable reason. - type: string - example: you've used 100% of your spending limit for Codespaces - nullable: true - required: - - id - - name - - environment_id - - owner - - billable_owner - - repository - - machine - - prebuild - - created_at - - updated_at - - last_used_at - - state - - url - - git_status - - location - - idle_timeout_minutes - - web_url - - machines_url - - start_url - - stop_url - - pulls_url - - recent_folders - examples: - default: &249 - value: - total_count: 3 - codespaces: - - id: 1 - name: monalisa-octocat-hello-world-g4wpq6h95q - environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer/devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop - recent_folders: [] - - id: 1 - name: monalisa-octocat-hello-world-3f89ada1j3 - environment_id: 526ce4d7-46da-494f-a4f9-cfd25b818719 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer/foobar/devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3 - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - web_url: https://monalisa-octocat-hello-world-3f89ada1j3.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop - recent_folders: [] - - id: 1 - name: monalisa-octocat-hello-world-f8adfad99a - environment_id: 6ac8cd6d-a2d0-4ae3-8cea-e135059264df - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - web_url: https://monalisa-octocat-hello-world-f8adfad99a.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop - recent_folders: [] - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - "/orgs/{org}/codespaces/access": - put: - summary: Manage access control for organization codespaces - description: |- - Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/set-codespaces-access - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces - parameters: - - *75 - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - visibility: - type: string - description: Which users can access codespaces in the organization. - `disabled` means that no users can access codespaces in the organization. - enum: - - disabled - - selected_members - - all_members - - all_members_and_outside_collaborators - selected_usernames: - type: array - description: The usernames of the organization members who should - have access to codespaces in the organization. Required when `visibility` - is `selected_members`. The provided list of usernames will replace - any existing value. - items: - type: string - maxItems: 100 - required: - - visibility - examples: - default: - value: - visibility: selected_members - selected_usernames: - - johnDoe - - atomIO - responses: - '204': - description: Response when successfully modifying permissions. - '304': *37 - '400': - description: Users are neither members nor collaborators of this organization. - '404': *6 - '422': *15 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - "/orgs/{org}/codespaces/access/selected_users": - post: - summary: Add users to Codespaces access for an organization - description: |- - Codespaces for the specified users will be billed to the organization. - - To use this endpoint, the access settings for the organization must be set to `selected_members`. - For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/set-codespaces-access-users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization - parameters: - - *75 - deprecated: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_usernames: - type: array - description: The usernames of the organization members and outside - collaborators whose codespaces should be billed to the organization. - items: - type: string - maxItems: 100 - required: - - selected_usernames - examples: - default: - value: - selected_usernames: - - johnDoe - - atomIO - responses: - '204': - description: Response when successfully modifying permissions. - '304': *37 - '400': - description: Users are neither members nor collaborators of this organization. - '404': *6 - '422': *15 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - delete: - summary: Remove users from Codespaces access for an organization - description: |- - Codespaces for the specified users will no longer be billed to the organization. - - To use this endpoint, the access settings for the organization must be set to `selected_members`. - For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/delete-codespaces-access-users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization - deprecated: true - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_usernames: - type: array - description: The usernames of the organization members and outside - collaborators whose codespaces should not be billed to the organization. - items: - type: string - maxItems: 100 - required: - - selected_usernames - examples: - default: - value: - selected_usernames: - - johnDoe - - atomIO - responses: - '204': - description: Response when successfully modifying permissions. - '304': *37 - '400': - description: Users are neither members nor collaborators of this organization. - '404': *6 - '422': *15 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - "/orgs/{org}/codespaces/secrets": - get: - summary: List organization secrets - description: |- - Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted - values. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-org-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &194 - title: Codespaces Secret - description: Secrets for a GitHub Codespace. - type: object - properties: - name: - description: The name of the secret - example: SECRET_NAME - type: string - created_at: - description: The date and time at which the secret was created, - in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - updated_at: - description: The date and time at which the secret was created, - in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - visibility: - description: The type of repositories in the organization - that the secret is visible to - enum: - - all - - private - - selected - type: string - selected_repositories_url: - description: The API URL at which the list of repositories - this secret is visible to can be retrieved - type: string - format: uri - example: https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories - required: - - name - - created_at - - updated_at - - visibility - examples: - default: &468 - value: - total_count: 2 - secrets: - - name: GH_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: all - - name: GIST_ID - created_at: '2020-01-10T10:59:22Z' - updated_at: '2020-01-11T11:59:22Z' - visibility: all - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - "/orgs/{org}/codespaces/secrets/public-key": - get: - summary: Get an organization public key - description: |- - Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &469 - title: CodespacesPublicKey - description: The public key used for setting Codespaces secrets. - type: object - properties: - key_id: - description: The identifier for the key. - type: string - example: '1234567' - key: - description: The Base64 encoded public key. - type: string - example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= - id: - type: integer - example: 2 - url: - type: string - example: https://api.github.com/user/keys/2 - title: - type: string - example: ssh-rsa AAAAB3NzaC1yc2EAAA - created_at: - type: string - example: '2011-01-26T19:01:12Z' - required: - - key_id - - key - examples: - default: &470 - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - "/orgs/{org}/codespaces/secrets/{secret_name}": - get: - summary: Get an organization secret - description: |- - Gets an organization development environment secret without revealing its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret - parameters: - - *75 - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *194 - examples: - default: &472 - value: - name: GH_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: all - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - put: - summary: Create or update an organization secret - description: |- - Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/create-or-update-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get an organization public - key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: The ID of the key you used to encrypt the secret. - visibility: - type: string - description: Which type of organization repositories have access - to the organization secret. `selected` means only the repositories - specified by `selected_repository_ids` can access the secret. - enum: - - all - - private - - selected - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - secret. You can only provide a list of repository IDs when the - `visibility` is set to `selected`. You can manage the list of - selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) - endpoints. - items: - type: integer - required: - - visibility - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - delete: - summary: Delete an organization secret - description: |- - Deletes an organization development environment secret using the secret name. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/delete-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret - parameters: - - *75 - - *168 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": - get: - summary: List selected repositories for an organization secret - description: |- - Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-selected-repos-for-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret - parameters: - - *75 - - *168 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - examples: - default: *172 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - put: - summary: Set selected repositories for an organization secret - description: |- - Replaces all repositories for an organization development environment secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/set-selected-repos-for-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - secret. You can only provide a list of repository ids when the - `visibility` is set to `selected`. You can add and remove individual - repositories using the [Set selected repositories for an organization - secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) - endpoints. - items: - type: integer - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 64780797 - responses: - '204': - description: Response - '404': *6 - '409': - description: Conflict when visibility type not set to selected - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": - put: - summary: Add selected repository to an organization secret - description: |- - Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/add-selected-repo-to-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret - parameters: - - *75 - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: No Content when repository was added to the selected list - '404': *6 - '409': - description: Conflict when visibility type is not set to selected - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - delete: - summary: Remove selected repository from an organization secret - description: |- - Removes a repository from an organization development environment secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/remove-selected-repo-from-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret - parameters: - - *75 - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response when repository was removed from the selected list - '404': *6 - '409': - description: Conflict when visibility type not set to selected - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organization-secrets - "/orgs/{org}/copilot/billing": - get: - summary: Get Copilot seat information and settings for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets information about an organization's Copilot subscription, including seat breakdown - and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." - - Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/get-copilot-organization-details - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization - parameters: - - *75 - responses: - '200': - description: OK - content: - application/json: - schema: - title: Copilot Organization Details - description: Information about the seat breakdown and policies set - for an organization with a Copilot Business or Copilot Enterprise - subscription. - type: object - properties: - seat_breakdown: - title: Copilot Seat Breakdown - description: The breakdown of Copilot Business seats for the organization. - type: object - properties: - total: - type: integer - description: The total number of seats being billed for the - organization as of the current billing cycle. - added_this_cycle: - type: integer - description: Seats added during the current billing cycle. - pending_cancellation: - type: integer - description: The number of seats that are pending cancellation - at the end of the current billing cycle. - pending_invitation: - type: integer - description: The number of users who have been invited to - receive a Copilot seat through this organization. - active_this_cycle: - type: integer - description: The number of seats that have used Copilot during - the current billing cycle. - inactive_this_cycle: - type: integer - description: The number of seats that have not used Copilot - during the current billing cycle. - public_code_suggestions: - type: string - description: The organization policy for allowing or blocking - suggestions matching public code (duplication detection filter). - enum: - - allow - - block - - unconfigured - ide_chat: - type: string - description: The organization policy for allowing or disallowing - Copilot Chat in the IDE. - enum: - - enabled - - disabled - - unconfigured - platform_chat: - type: string - description: The organization policy for allowing or disallowing - Copilot features on GitHub.com. - enum: - - enabled - - disabled - - unconfigured - cli: - type: string - description: The organization policy for allowing or disallowing - Copilot CLI. - enum: - - enabled - - disabled - - unconfigured - seat_management_setting: - type: string - description: The mode of assigning new seats. - enum: - - assign_all - - assign_selected - - disabled - - unconfigured - plan_type: - type: string - description: The Copilot plan of the organization, or the parent - enterprise, when applicable. - enum: - - business - - enterprise - required: - - seat_breakdown - - public_code_suggestions - - seat_management_setting - additionalProperties: true - examples: - default: - value: - seat_breakdown: - total: 12 - added_this_cycle: 9 - pending_invitation: 0 - pending_cancellation: 0 - active_this_cycle: 12 - inactive_this_cycle: 11 - seat_management_setting: assign_selected - ide_chat: enabled - platform_chat: enabled - cli: enabled - public_code_suggestions: block - plan_type: business - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': - description: There is a problem with your account's associated payment method. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/orgs/{org}/copilot/billing/seats": - get: - summary: List all Copilot seat assignments for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. - Only organization owners can view assigned seats. - - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/list-copilot-seats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization - parameters: - - *75 - - *19 - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 50 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_seats: - type: integer - description: Total number of Copilot seats for the organization - currently being billed. - seats: - type: array - items: &251 - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment - for a user, team, or organization. - type: object - properties: - assignee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - organization: - title: Organization Simple - description: A GitHub organization. - type: object - properties: *195 - required: *196 - nullable: true - assigning_team: - description: The team through which the assignee is granted - access to GitHub Copilot, if applicable. - oneOf: - - *197 - - *68 - nullable: true - pending_cancellation_date: - type: string - format: date - nullable: true - description: The pending cancellation date for the seat, - in `YYYY-MM-DD` format. This will be null unless the assignee's - Copilot access has been canceled during the current billing - cycle. If the seat has been cancelled, this corresponds - to the start of the organization's next billing cycle. - last_activity_at: - type: string - format: date-time - nullable: true - description: Timestamp of user's last GitHub Copilot activity, - in ISO 8601 format. - last_activity_editor: - type: string - nullable: true - description: Last editor that was used by the user for a - GitHub Copilot completion. - last_authenticated_at: - type: string - format: date-time - nullable: true - description: Timestamp of the last time the user authenticated - with GitHub Copilot, in ISO 8601 format. - created_at: - type: string - format: date-time - description: Timestamp of when the assignee was last granted - access to GitHub Copilot, in ISO 8601 format. - updated_at: - type: string - format: date-time - deprecated: true - description: "**Closing down notice:** This field is no - longer relevant and is closing down. Use the `created_at` - field to determine when the assignee was last granted - access to GitHub Copilot. Timestamp of when the assignee's - GitHub Copilot access was last updated, in ISO 8601 format." - plan_type: - type: string - description: The Copilot plan of the organization, or the - parent enterprise, when applicable. - enum: - - business - - enterprise - - unknown - required: - - created_at - additionalProperties: false - examples: - default: - value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - last_authenticated_at: '2021-10-14T00:53:32-06:00' - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - last_authenticated_at: '2021-10-14T00:53:32-06:00' - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - headers: - Link: *67 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/orgs/{org}/copilot/billing/selected_teams": - post: - summary: Add teams to the Copilot subscription for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Purchases a GitHub Copilot seat for all users within each specified team. - The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." - For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - - The response contains the total number of new seats that were created and existing seats that were refreshed. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/add-copilot-seats-for-teams - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization - parameters: - - *75 - requestBody: - content: - application/json: - schema: - type: object - properties: - selected_teams: - type: array - description: List of team names within the organization to which - to grant access to GitHub Copilot. - items: - type: string - minItems: 1 - required: - - selected_teams - examples: - default: - value: - selected_teams: - - engteam1 - - engteam2 - - engteam3 - required: true - responses: - '201': - description: OK - content: - application/json: - schema: - type: object - description: The total number of seats created for members of the - specified team(s). - properties: - seats_created: - type: integer - required: - - seats_created - examples: - default: - value: - seats_created: 5 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': - description: Copilot Business or Enterprise is not enabled for this organization, - billing has not been set up for this organization, a public code suggestions - policy has not been set for this organization, or the organization's Copilot - access setting is set to enable Copilot for all users or is unconfigured. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - delete: - summary: Remove teams from the Copilot subscription for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Sets seats for all members of each team specified to "pending cancellation". - This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. - For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." - - Only organization owners can cancel Copilot seats for their organization members. - - The response contains the total number of seats set to "pending cancellation". - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/cancel-copilot-seat-assignment-for-teams - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization - parameters: - - *75 - requestBody: - content: - application/json: - schema: - type: object - properties: - selected_teams: - type: array - description: The names of teams from which to revoke access to GitHub - Copilot. - items: - type: string - minItems: 1 - required: - - selected_teams - examples: - default: - value: - selected_teams: - - engteam1 - - engteam2 - - engteam3 - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - type: object - description: The total number of seats set to "pending cancellation" - for members of the specified team(s). - properties: - seats_cancelled: - type: integer - required: - - seats_cancelled - examples: - default: - value: - seats_cancelled: 5 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': - description: Copilot Business or Enterprise is not enabled for this organization, - billing has not been set up for this organization, a public code suggestions - policy has not been set for this organization, or the organization's Copilot - access setting is set to enable Copilot for all users or is unconfigured. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/orgs/{org}/copilot/billing/selected_users": - post: - summary: Add users to the Copilot subscription for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Purchases a GitHub Copilot seat for each user specified. - The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." - - Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. - For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." - For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." - - The response contains the total number of new seats that were created and existing seats that were refreshed. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/add-copilot-seats-for-users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization - parameters: - - *75 - requestBody: - content: - application/json: - schema: - type: object - properties: - selected_usernames: - type: array - description: The usernames of the organization members to be granted - access to GitHub Copilot. - items: - type: string - minItems: 1 - required: - - selected_usernames - examples: - default: - value: - selected_usernames: - - cooluser1 - - hacker2 - - octocat - required: true - responses: - '201': - description: OK - content: - application/json: - schema: - type: object - description: The total number of seats created for the specified user(s). - properties: - seats_created: - type: integer - required: - - seats_created - examples: - default: - value: - seats_created: 5 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': - description: Copilot Business or Enterprise is not enabled for this organization, - billing has not been set up for this organization, a public code suggestions - policy has not been set for this organization, or the organization's Copilot - access setting is set to enable Copilot for all users or is unconfigured. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - delete: - summary: Remove users from the Copilot subscription for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Sets seats for all users specified to "pending cancellation". - This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. - For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." - - Only organization owners can cancel Copilot seats for their organization members. - - The response contains the total number of seats set to "pending cancellation". - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/cancel-copilot-seat-assignment-for-users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization - parameters: - - *75 - requestBody: - content: - application/json: - schema: - type: object - properties: - selected_usernames: - type: array - description: The usernames of the organization members for which - to revoke access to GitHub Copilot. - items: - type: string - minItems: 1 - required: - - selected_usernames - examples: - default: - value: - selected_usernames: - - cooluser1 - - hacker2 - - octocat - required: true - responses: - '200': - description: OK - content: - application/json: - schema: - type: object - description: The total number of seats set to "pending cancellation" - for the specified users. - properties: - seats_cancelled: - type: integer - required: - - seats_cancelled - examples: - default: - value: - seats_cancelled: 5 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': - description: Copilot Business or Enterprise is not enabled for this organization, - billing has not been set up for this organization, a public code suggestions - policy has not been set for this organization, the seat management setting - is set to enable Copilot for all users or is unconfigured, or a user's - seat cannot be cancelled because it was assigned to them via a team. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/orgs/{org}/copilot/coding-agent/permissions": - get: - summary: Get Copilot coding agent permissions for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets information about which repositories in an organization have been enabled - or disabled for the Copilot coding agent. - - Organization owners can configure whether Copilot coding agent is enabled for - all repositories, selected repositories, or no repositories owned by organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - copilot - operationId: copilot/get-copilot-coding-agent-permissions-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - enabled_repositories: - type: string - description: The policy for which repositories can use Copilot - coding agent. Can be one of `all`, `selected`, or `none`. - enum: - - all - - selected - - none - selected_repositories_url: - type: string - description: The URL for the selected repositories endpoint. Only - present when `enabled_repositories` is `selected`. - required: - - enabled_repositories - examples: - all_enabled: - summary: All repositories enabled - value: - enabled_repositories: all - selected_enabled: - summary: Selected repositories enabled - value: - enabled_repositories: selected - selected_repositories_url: https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories - none_enabled: - summary: No repositories enabled - value: - enabled_repositories: none - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-coding-agent-management - put: - summary: Set Copilot coding agent permissions for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Sets the policy for which repositories in an organization can use Copilot coding agent. - - Organization owners can configure whether Copilot coding agent is enabled for - all repositories, selected repositories, or no repositories owned by the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - copilot - operationId: copilot/set-copilot-coding-agent-permissions-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - enabled_repositories: - type: string - description: The policy for which repositories can use Copilot coding - agent. Can be one of `all`, `selected`, or `none`. - enum: - - all - - selected - - none - required: - - enabled_repositories - examples: - default: - value: - enabled_repositories: selected - responses: - '204': - description: No Content - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-coding-agent-management - "/orgs/{org}/copilot/coding-agent/permissions/repositories": - get: - summary: List repositories enabled for Copilot coding agent in an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists the selected repositories that are enabled for Copilot coding agent in an organization. - - Organization owners can use this endpoint when the coding agent repository policy - is set to `selected` to see which repositories have been enabled. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - copilot - operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - required: - - total_count - - repositories - examples: - default: *198 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-coding-agent-management - put: - summary: Set selected repositories for Copilot coding agent in an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Replaces the list of selected repositories that are enabled for Copilot coding - agent in an organization. This method can only be called when the coding agent - repository policy is set to `selected`. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - copilot - operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - description: List of repository IDs to enable for Copilot coding - agent. - type: array - items: - type: integer - description: Unique identifier of the repository. - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 32 - - 42 - responses: - '204': - description: No Content - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '409': *54 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-coding-agent-management - "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}": - put: - summary: Enable a repository for Copilot coding agent in an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Adds a repository to the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - copilot - operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: No Content - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '409': *54 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-coding-agent-management - delete: - summary: Disable a repository for Copilot coding agent in an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Removes a repository from the list of selected repositories enabled for Copilot - coding agent in an organization. This method can only be called when the - coding agent repository policy is set to `selected`. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: No Content - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-coding-agent-management - "/orgs/{org}/copilot/content_exclusion": - get: - summary: Get Copilot content exclusion rules for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets information about an organization's Copilot content exclusion path rules. - To configure these settings, go to the organization's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." - - Organization owners can view details about Copilot content exclusion rules for the organization. - - OAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint. - - > [!CAUTION] - > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. - > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. - tags: - - copilot - operationId: copilot/copilot-content-exclusion-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization - parameters: - - *75 - responses: - '200': - description: OK - content: - application/json: - schema: - title: Copilot Organization Content Exclusion Details - description: List all Copilot Content Exclusion rules for an organization. - type: object - additionalProperties: - type: array - items: - type: string - description: The path to the file that will be excluded. - examples: - default: - value: - octo-repo: - - "/src/some-dir/kernel.rs" - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-content-exclusion-management - put: - summary: Set Copilot content exclusion rules for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Sets Copilot content exclusion path rules for an organization. - To configure these settings, go to the organization's settings on GitHub. - For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." - - Organization owners can set Copilot content exclusion rules for the organization. - - OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. - - > [!CAUTION] - > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. - > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. - tags: - - copilot - operationId: copilot/set-copilot-content-exclusion-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization - parameters: - - *75 - requestBody: - description: The content exclusion rules to set - required: true - content: - application/json: - schema: - type: object - additionalProperties: - type: array - items: - anyOf: - - type: string - description: The path to the file that will be excluded. - - type: object - properties: - ifAnyMatch: - type: array - items: - type: string - required: - - ifAnyMatch - additionalProperties: false - - type: object - properties: - ifNoneMatch: - type: array - items: - type: string - required: - - ifNoneMatch - additionalProperties: false - examples: - default: - summary: Example of content exclusion paths - value: - octo-repo: - - "/src/some-dir/kernel.rs" - responses: - '200': - description: Success - content: - application/json: - schema: - type: object - properties: - message: - type: string - examples: - default: - value: - message: Content exclusion rules updated successfully. - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '413': - description: Payload Too Large - content: - application/json: - schema: *3 - '422': *7 - x-github: - githubCloudOnly: - enabledForGitHubApps: true - category: copilot - subcategory: copilot-content-exclusion-management - "/orgs/{org}/copilot/metrics": - get: - summary: Get Copilot metrics for an organization - description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - > [!NOTE] - > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. - - The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. - Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization - parameters: - - *75 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 100 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *19 - - name: per_page - description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 100 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &337 - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, - in `YYYY-MM-DD` format. - total_active_users: - type: integer - description: The total number of Copilot users with activity - belonging to any Copilot feature, globally, for the given - day. Includes passive activity such as receiving a code suggestion, - as well as engagement activity such as accepting a code suggestion - or prompting chat. Does not include authentication events. - Is not limited to the individual features detailed on the - endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with - any Copilot feature, for the given day. Examples include but - are not limited to accepting a code suggestion, prompting - Copilot chat, or triggering a PR Summary. Does not include - authentication events. Is not limited to the individual features - detailed on the endpoint. - copilot_ide_code_completions: - type: object - description: Usage metrics for Copilot editor code completions - in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code suggestion, across all active editors. Includes both - full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the - given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot - code completion suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - language. Includes both full and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active - editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - editor. Includes both full and partial acceptances. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: string - nullable: true - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: Number of users who accepted at - least one Copilot code completion suggestion - for the given editor, for the given language - and model. Includes both full and partial - acceptances. - languages: - type: array - description: Code completion metrics for active - languages, for the given editor. - items: - type: object - description: Usage metrics for a given language - for the given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used - for Copilot code completion suggestions, - for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted - at least one Copilot code completion - suggestion for the given editor, for - the given language. Includes both full - and partial acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code - suggestions generated for the given - editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code - suggestions accepted for the given editor, - for the given language. Includes both - full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code - suggested by Copilot code completions - for the given editor, for the given - language. - total_code_lines_accepted: - type: integer - description: The number of lines of code - accepted from Copilot code suggestions - for the given editor, for the given - language. - copilot_ide_chat: - type: object - description: Usage metrics for Copilot Chat in the IDE. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot - Chat in the specified editor. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - Chat. If the default model is used will appear - as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: string - nullable: true - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: The number of users who prompted - Copilot Chat in the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated - by users in the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted - a code suggestion from Copilot Chat using - the 'Insert Code' UI element, for the given - editor. - total_chat_copy_events: - type: integer - description: The number of times users copied - a code suggestion from Copilot Chat using - the keyboard, or the 'Copy' UI element, for - the given editor. - copilot_dotcom_chat: - type: object - description: Usage metrics for Copilot Chat in GitHub.com - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once. - models: - type: array - description: List of model metrics for a custom models and - the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot Chat. - If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or - default. - custom_model_training_date: - type: string - description: The training date for the custom model - (if applicable). - nullable: true - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users - on github.com. - copilot_dotcom_pull_requests: - type: object - description: Usage metrics for Copilot for pull requests. - nullable: true - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull - Requests on github.com to generate a pull request summary - at least once. - repositories: - type: array - description: Repositories in which users used Copilot for - Pull Requests to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull - request summaries using Copilot for Pull Requests - in the given repository. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - pull request summaries. If the default model - is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: string - nullable: true - description: The training date for the custom - model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries - generated using Copilot for Pull Requests - in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated - pull request summaries using Copilot for Pull - Requests in the given repository and model. - required: - - date - additionalProperties: true - examples: - default: &338 - value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - '500': *55 - '403': *29 - '404': *6 - '422': &339 - description: Copilot Usage Metrics API setting is disabled at the organization - or enterprise level. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/orgs/{org}/copilot/metrics/reports/organization-1-day": - get: - summary: Get Copilot organization usage metrics for a specific day - description: |- - Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. - - The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. - - The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. - - Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). - tags: - - copilot - operationId: copilot/copilot-organization-one-day-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day - parameters: - - *75 - - *56 - responses: - '200': - description: Response - content: - application/json: - schema: *57 - examples: - default: *58 - '204': *191 - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest": - get: - summary: Get Copilot organization usage metrics - description: |- - Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization. - - The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. - - The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. - - Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). - tags: - - copilot - operationId: copilot/copilot-organization-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *59 - examples: - default: *60 - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/orgs/{org}/copilot/metrics/reports/users-1-day": - get: - summary: Get Copilot organization users usage metrics for a specific day - description: |- - Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. - - The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. - - Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. - - Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). - tags: - - copilot - operationId: copilot/copilot-organization-users-one-day-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day - parameters: - - *75 - - *56 - responses: - '200': - description: Response - content: - application/json: - schema: *57 - examples: - default: *58 - '204': *191 - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/orgs/{org}/copilot/metrics/reports/users-28-day/latest": - get: - summary: Get Copilot organization users usage metrics - description: |- - Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. - - The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. - - Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. - - Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - - For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). - tags: - - copilot - operationId: copilot/copilot-organization-users-usage-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *59 - examples: - default: *60 - '500': *55 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage-metrics - "/orgs/{org}/dependabot/alerts": - get: - summary: List Dependabot alerts for an organization - description: |- - Lists Dependabot alerts for an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - dependabot - operationId: dependabot/list-alerts-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization - parameters: - - *75 - - *199 - - *200 - - *201 - - *202 - - *203 - - *204 - - name: artifact_registry_url - in: query - description: A comma-separated list of artifact registry URLs. If specified, - only alerts for repositories with storage records matching these URLs will - be returned. - schema: - type: string - - name: artifact_registry - in: query - description: |- - A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. - - Can be: `jfrog-artifactory` - schema: - type: string - - name: has - in: query - description: |- - Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. - Multiple `has` filters can be passed to filter for alerts that have all of the values. - schema: - oneOf: - - type: string - - type: array - items: - type: string - enum: - - patch - - deployment - - *205 - - name: runtime_risk - in: query - description: |- - A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. - - Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` - schema: - type: string - - *206 - - *207 - - *61 - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *208 - examples: - default: *209 - '304': *37 - '400': *14 - '403': *29 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: alerts - "/orgs/{org}/dependabot/secrets": - get: - summary: List organization secrets - description: |- - Lists all secrets available in an organization without revealing their - encrypted values. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/list-org-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &210 - title: Dependabot Secret for an Organization - description: Secrets for GitHub Dependabot for an organization. - type: object - properties: - name: - description: The name of the secret. - example: SECRET_TOKEN - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - visibility: - description: Visibility of a secret - enum: - - all - - private - - selected - type: string - selected_repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories - required: - - name - - created_at - - updated_at - - visibility - examples: - default: - value: - total_count: 3 - secrets: - - name: MY_ARTIFACTORY_PASSWORD - created_at: '2021-08-10T14:59:22Z' - updated_at: '2021-12-10T14:59:22Z' - visibility: private - - name: NPM_TOKEN - created_at: '2021-08-10T14:59:22Z' - updated_at: '2021-12-10T14:59:22Z' - visibility: all - - name: GH_TOKEN - created_at: '2021-08-10T14:59:22Z' - updated_at: '2021-12-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/orgs/{org}/dependabot/secrets/public-key": - get: - summary: Get an organization public key - description: |- - Gets your public key, which you need to encrypt secrets. You need to - encrypt a secret before you can create or update secrets. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: &503 - title: DependabotPublicKey - description: The public key used for setting Dependabot Secrets. - type: object - properties: - key_id: - description: The identifier for the key. - type: string - example: '1234567' - key: - description: The Base64 encoded public key. - type: string - example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= - required: - - key_id - - key - examples: - default: &504 - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/orgs/{org}/dependabot/secrets/{secret_name}": - get: - summary: Get an organization secret - description: |- - Gets a single organization secret without revealing its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/get-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret - parameters: - - *75 - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *210 - examples: - default: - value: - name: NPM_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - put: - summary: Create or update an organization secret - description: |- - Creates or updates an organization secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/create-or-update-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get an organization public - key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - visibility: - type: string - description: Which type of organization repositories have access - to the organization secret. `selected` means only the repositories - specified by `selected_repository_ids` can access the secret. - enum: - - all - - private - - selected - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - secret. You can only provide a list of repository ids when the - `visibility` is set to `selected`. You can manage the list of - selected repositories using the [List selected repositories for - an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), - [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), - and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) - endpoints. - items: - anyOf: - - type: integer - - type: string - required: - - visibility - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - x-github-breaking-changes: - - changeset: remove_string_type_from_repo_id_param - patch: - - op: replace - path: "/requestBody/content/application~1json/schema/properties/selected_repository_ids/items" - value: - type: integer - version: '2026-03-10' - delete: - summary: Delete an organization secret - description: |- - Deletes a secret in an organization using the secret name. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/delete-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret - parameters: - - *75 - - *168 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": - get: - summary: List selected repositories for an organization secret - description: |- - Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/list-selected-repos-for-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret - parameters: - - *75 - - *168 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - examples: - default: *172 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - put: - summary: Set selected repositories for an organization secret - description: |- - Replaces all repositories for an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/set-selected-repos-for-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - type: array - description: An array of repository ids that can access the organization - secret. You can only provide a list of repository ids when the - `visibility` is set to `selected`. You can add and remove individual - repositories using the [Set selected repositories for an organization - secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) - and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) - endpoints. - items: - type: integer - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 64780797 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": - put: - summary: Add selected repository to an organization secret - description: |- - Adds a repository to an organization secret when the `visibility` for - repository access is set to `selected`. The visibility is set when you [Create or - update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/add-selected-repo-to-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret - parameters: - - *75 - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: No Content when repository was added to the selected list - '409': - description: Conflict when visibility type is not set to selected - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - delete: - summary: Remove selected repository from an organization secret - description: |- - Removes a repository from an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you [Create - or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/remove-selected-repo-from-org-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret - parameters: - - *75 - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response when repository was removed from the selected list - '409': - description: Conflict when visibility type not set to selected - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/orgs/{org}/docker/conflicts": - get: - summary: Get list of conflicting packages during Docker migration for organization - description: |- - Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - tags: - - packages - operationId: packages/list-docker-migration-conflicting-packages-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &261 - title: Package - description: A software package - type: object - properties: - id: - description: Unique identifier of the package. - type: integer - example: 1 - name: - description: The name of the package. - type: string - example: super-linter - package_type: - type: string - example: docker - enum: - - npm - - maven - - rubygems - - docker - - nuget - - container - url: - type: string - example: https://api.github.com/orgs/github/packages/container/super-linter - html_url: - type: string - example: https://github.com/orgs/github/packages/container/package/super-linter - version_count: - description: The number of versions of the package. - type: integer - example: 1 - visibility: - type: string - example: private - enum: - - private - - public - owner: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - repository: - title: Minimal Repository - description: Minimal Repository - type: object - properties: *211 - required: *212 - x-github-breaking-changes: *213 - nullable: true - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - name - - package_type - - visibility - - url - - html_url - - version_count - - created_at - - updated_at - examples: - default: &262 - value: - - id: 197 - name: hello_docker - package_type: container - owner: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - version_count: 1 - visibility: private - url: https://api.github.com/orgs/github/packages/container/hello_docker - created_at: '2020-05-19T22:19:11Z' - updated_at: '2020-05-19T22:19:11Z' - html_url: https://github.com/orgs/github/packages/container/package/hello_docker - - id: 198 - name: goodbye_docker - package_type: container - owner: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - version_count: 2 - visibility: private - url: https://api.github.com/orgs/github/packages/container/goodbye_docker - created_at: '2020-05-20T22:19:11Z' - updated_at: '2020-05-20T22:19:11Z' - html_url: https://github.com/orgs/github/packages/container/package/goodbye_docker - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/events": - get: - summary: List public organization events - description: |- - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-public-org-events - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-public-organization-events - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - 200-response: - value: - - id: '22237752260' - type: WatchEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octo-org/octo-repo - url: https://api.github.com/repos/octo-org/octo-repo - payload: - action: started - public: true - created_at: '2022-06-08T23:29:25Z' - org: - id: 9919 - login: octo-org - gravatar_id: '' - url: https://api.github.com/orgs/octo-org - avatar_url: https://avatars.githubusercontent.com/u/9919? - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octo-org/octo-repo - url: https://api.github.com/repos/octo-org/octo-repo - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-09T12:47:28Z' - org: - id: 9919 - login: octo-org - gravatar_id: '' - url: https://api.github.com/orgs/octo-org - avatar_url: https://avatars.githubusercontent.com/u/9919? - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/orgs/{org}/failed_invitations": - get: - summary: List failed organization invitations - description: The return hash contains `failed_at` and `failed_reason` fields - which represent the time at which the invitation failed and the reason for - the failure. - tags: - - orgs - operationId: orgs/list-failed-invitations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &237 - title: Organization Invitation - description: Organization Invitation - type: object - properties: - id: - type: integer - format: int64 - login: - type: string - nullable: true - email: - type: string - nullable: true - role: - type: string - created_at: - type: string - failed_at: - type: string - nullable: true - failed_reason: - type: string - nullable: true - inviter: *4 - team_count: - type: integer - node_id: - type: string - example: '"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x"' - invitation_teams_url: - type: string - example: '"https://api.github.com/organizations/16/invitations/1/teams"' - invitation_source: - type: string - example: '"member"' - required: - - id - - login - - email - - role - - created_at - - inviter - - team_count - - invitation_teams_url - - node_id - examples: - default: &238 - value: - - id: 1 - login: monalisa - node_id: MDQ6VXNlcjE= - email: octocat@github.com - role: direct_member - created_at: '2016-11-30T06:46:10-08:00' - failed_at: '' - failed_reason: '' - inviter: - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - team_count: 2 - invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams - invitation_source: member - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/hooks": - get: - summary: List organization webhooks - description: |- - List webhooks for an organization. - - The authenticated user must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/list-webhooks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &214 - title: Org Hook - description: Org Hook - type: object - properties: - id: - type: integer - example: 1 - url: - type: string - format: uri - example: https://api.github.com/orgs/octocat/hooks/1 - ping_url: - type: string - format: uri - example: https://api.github.com/orgs/octocat/hooks/1/pings - deliveries_url: - type: string - format: uri - example: https://api.github.com/orgs/octocat/hooks/1/deliveries - name: - type: string - example: web - events: - type: array - example: - - push - - pull_request - items: - type: string - active: - type: boolean - example: true - config: - type: object - properties: - url: - type: string - example: '"http://example.com/2"' - insecure_ssl: - type: string - example: '"0"' - content_type: - type: string - example: '"form"' - secret: - type: string - example: '"********"' - updated_at: - type: string - format: date-time - example: '2011-09-06T20:39:23Z' - created_at: - type: string - format: date-time - example: '2011-09-06T17:26:27Z' - type: - type: string - required: - - id - - url - - type - - name - - active - - events - - config - - ping_url - - created_at - - updated_at - examples: - default: - value: - - id: 1 - url: https://api.github.com/orgs/octocat/hooks/1 - ping_url: https://api.github.com/orgs/octocat/hooks/1/pings - deliveries_url: https://api.github.com/orgs/octocat/hooks/1/deliveries - name: web - events: - - push - - pull_request - active: true - config: - url: http://example.com - content_type: json - updated_at: '2011-09-06T20:39:23Z' - created_at: '2011-09-06T17:26:27Z' - type: Organization - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - post: - summary: Create an organization webhook - description: |- - Create a hook that posts payloads in JSON format. - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/create-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: Must be passed as "web". - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - username: - type: string - example: '"kdaigle"' - password: - type: string - example: '"password"' - required: - - url - events: - type: array - description: Determines what [events](https://docs.github.com/webhooks/event-payloads) - the hook is triggered for. Set to `["*"]` to receive all possible - events. - default: - - push - items: - type: string - active: - type: boolean - description: Determines if notifications are sent when the webhook - is triggered. Set to `true` to send notifications. - default: true - required: - - name - - config - examples: - default: - value: - name: web - active: true - events: - - push - - pull_request - config: - url: http://example.com/webhook - content_type: json - responses: - '201': - description: Response - content: - application/json: - schema: *214 - examples: - default: &215 - value: - id: 1 - url: https://api.github.com/orgs/octocat/hooks/1 - ping_url: https://api.github.com/orgs/octocat/hooks/1/pings - deliveries_url: https://api.github.com/orgs/octocat/hooks/1/deliveries - name: web - events: - - push - - pull_request - active: true - config: - url: http://example.com - content_type: json - updated_at: '2011-09-06T20:39:23Z' - created_at: '2011-09-06T17:26:27Z' - type: Organization - headers: - Location: - example: https://api.github.com/orgs/octocat/hooks/1 - schema: - type: string - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/hooks/{hook_id}": - get: - summary: Get an organization webhook - description: |- - Returns a webhook configured in an organization. To get only the webhook - `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/get-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook - parameters: - - *75 - - &216 - name: hook_id - description: The unique identifier of the hook. You can find this value in - the `X-GitHub-Hook-ID` header of a webhook delivery. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *214 - examples: - default: *215 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - patch: - summary: Update an organization webhook - description: |- - Updates a webhook configured in an organization. When you update a webhook, - the `secret` will be overwritten. If you previously had a `secret` set, you must - provide the same `secret` or set a new `secret` or the secret will be removed. If - you are only updating individual webhook `config` properties, use "[Update a webhook - configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/update-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook - parameters: - - *75 - - *216 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - required: - - url - events: - type: array - description: Determines what [events](https://docs.github.com/webhooks/event-payloads) - the hook is triggered for. - default: - - push - items: - type: string - active: - type: boolean - description: Determines if notifications are sent when the webhook - is triggered. Set to `true` to send notifications. - default: true - name: - type: string - example: '"web"' - examples: - default: - value: - active: true - events: - - pull_request - responses: - '200': - description: Response - content: - application/json: - schema: *214 - examples: - default: - value: - id: 1 - url: https://api.github.com/orgs/octocat/hooks/1 - ping_url: https://api.github.com/orgs/octocat/hooks/1/pings - deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries - name: web - events: - - pull_request - active: true - config: - url: http://example.com - content_type: json - updated_at: '2011-09-06T20:39:23Z' - created_at: '2011-09-06T17:26:27Z' - type: Organization - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - delete: - summary: Delete an organization webhook - description: |- - Delete a webhook for an organization. - - The authenticated user must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/delete-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook - parameters: - - *75 - - *216 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/hooks/{hook_id}/config": - get: - summary: Get a webhook configuration for an organization - description: |- - Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/get-webhook-config-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization - parameters: - - *75 - - *216 - responses: - '200': - description: Response - content: - application/json: - schema: *12 - examples: - default: *13 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - patch: - summary: Update a webhook configuration for an organization - description: |- - Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/update-webhook-config-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization - parameters: - - *75 - - *216 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - examples: - default: - summary: Update an existing webhook - value: - url: http://example.com/webhook - content_type: json - insecure_ssl: '0' - secret: "********" - responses: - '200': - description: Response - content: - application/json: - schema: *12 - examples: - default: *13 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/hooks/{hook_id}/deliveries": - get: - summary: List deliveries for an organization webhook - description: |- - Returns a list of webhook deliveries for a webhook configured in an organization. - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/list-webhook-deliveries - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook - parameters: - - *75 - - *216 - - *17 - - *217 - - *218 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *219 - examples: - default: *220 - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": - get: - summary: Get a webhook delivery for an organization webhook - description: |- - Returns a delivery for a webhook configured in an organization. - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/get-webhook-delivery - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook - parameters: - - *75 - - *216 - - *16 - responses: - '200': - description: Response - content: - application/json: - schema: *221 - examples: - default: *222 - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": - post: - summary: Redeliver a delivery for an organization webhook - description: |- - Redeliver a delivery for a webhook configured in an organization. - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/redeliver-webhook-delivery - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook - parameters: - - *75 - - *216 - - *16 - responses: - '202': *39 - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/hooks/{hook_id}/pings": - post: - summary: Ping an organization webhook - description: |- - This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - to be sent to the hook. - - You must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - tags: - - orgs - operationId: orgs/ping-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook - parameters: - - *75 - - *216 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: webhooks - "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": - get: - summary: Get route stats by actor - description: Get API request count statistics for an actor broken down by route - within a specified time frame. - tags: - - orgs - operationId: api-insights/get-route-stats-by-actor - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor - parameters: - - *75 - - &227 - name: actor_type - in: path - description: The type of the actor - required: true - schema: - type: string - enum: - - installation - - classic_pat - - fine_grained_pat - - oauth_app - - github_app_user_to_server - - &228 - name: actor_id - in: path - description: The ID of the actor - required: true - schema: - type: integer - - &223 - name: min_timestamp - description: 'The minimum timestamp to query for stats. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: true - schema: - type: string - - &224 - name: max_timestamp - description: 'The maximum timestamp to query for stats. Defaults to the time - 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - - *19 - - *17 - - *61 - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: array - items: - type: string - enum: - - last_rate_limited_timestamp - - last_request_timestamp - - rate_limited_request_count - - http_method - - api_route - - total_request_count - default: total_request_count - - name: api_route_substring - in: query - description: Providing a substring will filter results where the API route - contains the substring. This is a case-insensitive search. - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Route Stats - description: API Insights usage route stats for an actor - type: array - items: - type: object - properties: - http_method: - description: The HTTP method - type: string - api_route: - description: The API path's route template - type: string - total_request_count: - description: The total number of requests within the queried - time period - type: integer - format: int64 - rate_limited_request_count: - description: The total number of requests that were rate limited - within the queried time period - type: integer - format: int64 - last_rate_limited_timestamp: - type: string - nullable: true - last_request_timestamp: - type: string - examples: - default: - value: - - http_method: GET - api_route: "/repositories/:repository_id" - total_request_count: 544665 - rate_limited_request_count: 13 - last_request_timestamp: '2024-09-18T15:43:03Z' - last_rate_limited_timestamp: '2024-09-18T06:30:09Z' - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/subject-stats": - get: - summary: Get subject stats - description: Get API request statistics for all subjects within an organization - within a specified time frame. Subjects can be users or GitHub Apps. - tags: - - orgs - operationId: api-insights/get-subject-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats - parameters: - - *75 - - *223 - - *224 - - *19 - - *17 - - *61 - - &233 - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: array - items: - type: string - enum: - - last_rate_limited_timestamp - - last_request_timestamp - - rate_limited_request_count - - subject_name - - total_request_count - default: total_request_count - - name: subject_name_substring - in: query - description: Providing a substring will filter results where the subject name - contains the substring. This is a case-insensitive search. - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Subject Stats - description: API Insights usage subject stats for an organization - type: array - items: - type: object - properties: - subject_type: - type: string - subject_name: - type: string - subject_id: - type: integer - format: int64 - total_request_count: - type: integer - rate_limited_request_count: - type: integer - last_rate_limited_timestamp: - type: string - nullable: true - last_request_timestamp: - type: string - examples: - default: - value: - - subject_type: installation - subject_id: 954453 - subject_name: GitHub Actions - total_request_count: 544665 - rate_limited_request_count: 13 - last_request_timestamp: '2024-09-18T15:43:03Z' - last_rate_limited_timestamp: '2024-09-18T06:30:09Z' - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/summary-stats": - get: - summary: Get summary stats - description: Get overall statistics of API requests made within an organization - by all users and apps within a specified time frame. - tags: - - orgs - operationId: api-insights/get-summary-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats - parameters: - - *75 - - *223 - - *224 - responses: - '200': - description: Response - content: - application/json: - schema: &225 - title: Summary Stats - description: API Insights usage summary stats for an organization - type: object - properties: - total_request_count: - description: The total number of requests within the queried time - period - type: integer - format: int64 - rate_limited_request_count: - description: The total number of requests that were rate limited - within the queried time period - type: integer - format: int64 - examples: - default: &226 - value: - total_request_count: 34225 - rate_limited_request_count: 23 - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/summary-stats/users/{user_id}": - get: - summary: Get summary stats by user - description: Get overall statistics of API requests within the organization - for a user. - tags: - - orgs - operationId: api-insights/get-summary-stats-by-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user - parameters: - - *75 - - &229 - name: user_id - in: path - description: The ID of the user to query for stats - required: true - schema: - type: string - - *223 - - *224 - responses: - '200': - description: Response - content: - application/json: - schema: *225 - examples: - default: *226 - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": - get: - summary: Get summary stats by actor - description: Get overall statistics of API requests within the organization - made by a specific actor. Actors can be GitHub App installations, OAuth apps - or other tokens on behalf of a user. - tags: - - orgs - operationId: api-insights/get-summary-stats-by-actor - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor - parameters: - - *75 - - *223 - - *224 - - *227 - - *228 - responses: - '200': - description: Response - content: - application/json: - schema: *225 - examples: - default: *226 - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/time-stats": - get: - summary: Get time stats - description: Get the number of API requests and rate-limited requests made within - an organization over a specified time period. - tags: - - orgs - operationId: api-insights/get-time-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-time-stats - parameters: - - *75 - - *223 - - *224 - - &230 - name: timestamp_increment - description: The increment of time used to breakdown the query results (5m, - 10m, 1h, etc.) - in: query - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: &231 - title: Time Stats - description: API Insights usage time stats for an organization - type: array - items: - type: object - properties: - timestamp: - type: string - total_request_count: - type: integer - format: int64 - rate_limited_request_count: - type: integer - format: int64 - examples: - default: &232 - value: - - timestamp: '2024-09-11T15:00:00Z' - total_request_count: 34225 - rate_limited_request_count: 0 - - timestamp: '2024-09-11T15:05:00Z' - total_request_count: 10587 - rate_limited_request_count: 18 - - timestamp: '2024-09-11T15:10:00Z' - total_request_count: 43587 - rate_limited_request_count: 14 - - timestamp: '2024-09-11T15:15:00Z' - total_request_count: 19463 - rate_limited_request_count: 4 - - timestamp: '2024-09-11T15:20:00Z' - total_request_count: 60542 - rate_limited_request_count: 3 - - timestamp: '2024-09-11T15:25:00Z' - total_request_count: 55872 - rate_limited_request_count: 23 - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/time-stats/users/{user_id}": - get: - summary: Get time stats by user - description: Get the number of API requests and rate-limited requests made within - an organization by a specific user over a specified time period. - tags: - - orgs - operationId: api-insights/get-time-stats-by-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user - parameters: - - *75 - - *229 - - *223 - - *224 - - *230 - responses: - '200': - description: Response - content: - application/json: - schema: *231 - examples: - default: *232 - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": - get: - summary: Get time stats by actor - description: Get the number of API requests and rate-limited requests made within - an organization by a specific actor within a specified time period. - tags: - - orgs - operationId: api-insights/get-time-stats-by-actor - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor - parameters: - - *75 - - *227 - - *228 - - *223 - - *224 - - *230 - responses: - '200': - description: Response - content: - application/json: - schema: *231 - examples: - default: *232 - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/insights/api/user-stats/{user_id}": - get: - summary: Get user stats - description: Get API usage statistics within an organization for a user broken - down by the type of access. - tags: - - orgs - operationId: api-insights/get-user-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/api-insights#get-user-stats - parameters: - - *75 - - *229 - - *223 - - *224 - - *19 - - *17 - - *61 - - *233 - - name: actor_name_substring - in: query - description: Providing a substring will filter results where the actor name - contains the substring. This is a case-insensitive search. - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: User Stats - description: API Insights usage stats for a user - type: array - items: - type: object - properties: - actor_type: - type: string - actor_name: - type: string - actor_id: - type: integer - format: int64 - integration_id: - type: integer - format: int64 - nullable: true - oauth_application_id: - type: integer - format: int64 - nullable: true - total_request_count: - type: integer - rate_limited_request_count: - type: integer - last_rate_limited_timestamp: - type: string - nullable: true - last_request_timestamp: - type: string - examples: - default: - value: - - actor_type: oauth_app - actor_id: 954453 - actor_name: GitHub Actions - oauth_application_id: 1245 - total_request_count: 544665 - rate_limited_request_count: 13 - last_request_timestamp: '2024-09-18T15:43:03Z' - last_rate_limited_timestamp: '2024-09-18T06:30:09Z' - x-github: - enabledForGitHubApps: true - category: orgs - subcategory: api-insights - "/orgs/{org}/installation": - get: - summary: Get an organization installation for the authenticated app - description: |- - Enables an authenticated GitHub App to find the organization's installation information. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-org-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *22 - examples: - default: &542 - value: - id: 1 - account: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/orgs/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - repository_selection: all - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - client_id: Iv1.ab1112223334445c - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - created_at: '2018-02-09T20:51:14Z' - updated_at: '2018-02-09T20:51:14Z' - single_file_name: config.yml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - app_slug: github-actions - suspended_at: - suspended_by: - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - "/orgs/{org}/installations": - get: - summary: List app installations for an organization - description: |- - Lists all GitHub Apps in an organization. The installation count includes - all GitHub Apps installed on repositories in the organization. - - The authenticated user must be an organization owner to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-app-installations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - installations - properties: - total_count: - type: integer - installations: - type: array - items: *22 - examples: - default: - value: - total_count: 1 - installations: - - id: 25381 - account: - login: octo-org - id: 6811672 - node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= - avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 - gravatar_id: '' - url: https://api.github.com/users/octo-org - html_url: https://github.com/octo-org - followers_url: https://api.github.com/users/octo-org/followers - following_url: https://api.github.com/users/octo-org/following{/other_user} - gists_url: https://api.github.com/users/octo-org/gists{/gist_id} - starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octo-org/subscriptions - organizations_url: https://api.github.com/users/octo-org/orgs - repos_url: https://api.github.com/users/octo-org/repos - events_url: https://api.github.com/users/octo-org/events{/privacy} - received_events_url: https://api.github.com/users/octo-org/received_events - type: Organization - site_admin: false - repository_selection: selected - access_tokens_url: https://api.github.com/app/installations/25381/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/octo-org/settings/installations/25381 - app_id: 2218 - target_id: 6811672 - target_type: Organization - permissions: - deployments: write - metadata: read - pull_requests: read - statuses: read - events: - - deployment - - deployment_status - created_at: '2017-05-16T08:47:09.000-07:00' - updated_at: '2017-06-06T11:23:23.000-07:00' - single_file_name: config.yml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - app_slug: github-actions - suspended_at: - suspended_by: - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - "/orgs/{org}/interaction-limits": - get: - summary: Get interaction restrictions for an organization - description: Shows which type of GitHub user can interact with this organization - and when the restriction expires. If there is no restrictions, you will see - an empty response. - tags: - - interactions - operationId: interactions/get-restrictions-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - anyOf: - - &235 - title: Interaction Limits - description: Interaction limit settings. - type: object - properties: - limit: &234 - type: string - description: The type of GitHub user that can comment, open - issues, or create pull requests while the interaction limit - is in effect. - example: collaborators_only - enum: - - existing_users - - contributors_only - - collaborators_only - origin: - type: string - example: repository - expires_at: - type: string - format: date-time - example: '2018-08-17T04:18:39Z' - required: - - limit - - origin - - expires_at - - type: object - properties: {} - additionalProperties: false - examples: - default: &236 - value: - limit: collaborators_only - origin: organization - expires_at: '2018-08-17T04:18:39Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: interactions - subcategory: orgs - put: - summary: Set interaction restrictions for an organization - description: Temporarily restricts interactions to a certain type of GitHub - user in any public repository in the given organization. You must be an organization - owner to set these restrictions. Setting the interaction limit at the organization - level will overwrite any interaction limits that are set for individual repositories - owned by the organization. - tags: - - interactions - operationId: interactions/set-restrictions-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: &543 - title: Interaction Restrictions - description: Limit interactions to a specific type of user for a specified - duration - type: object - properties: - limit: *234 - expiry: - type: string - description: 'The duration of the interaction restriction. Default: - `one_day`.' - example: one_month - enum: - - one_day - - three_days - - one_week - - one_month - - six_months - required: - - limit - examples: - default: - value: - limit: collaborators_only - expiry: one_month - responses: - '200': - description: Response - content: - application/json: - schema: *235 - examples: - default: *236 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: interactions - subcategory: orgs - delete: - summary: Remove interaction restrictions for an organization - description: Removes all interaction restrictions from public repositories in - the given organization. You must be an organization owner to remove restrictions. - tags: - - interactions - operationId: interactions/remove-restrictions-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization - parameters: - - *75 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: interactions - subcategory: orgs - "/orgs/{org}/invitations": - get: - summary: List pending organization invitations - description: |- - The return hash contains a `role` field which refers to the Organization - Invitation role and will be one of the following values: `direct_member`, `admin`, - `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub - member, the `login` field in the return hash will be `null`. - tags: - - orgs - operationId: orgs/list-pending-invitations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations - parameters: - - *75 - - *17 - - *19 - - name: role - description: Filter invitations by their member role. - in: query - required: false - schema: - type: string - enum: - - all - - admin - - direct_member - - billing_manager - - hiring_manager - default: all - - name: invitation_source - description: Filter invitations by their invitation source. - in: query - required: false - schema: - type: string - enum: - - all - - member - - scim - default: all - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *237 - examples: - default: *238 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - post: - summary: Create an organization invitation - description: |- - Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - orgs - operationId: orgs/create-invitation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation - parameters: - - *75 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - invitee_id: - type: integer - description: "**Required unless you provide `email`**. GitHub user - ID for the person you are inviting." - email: - type: string - description: "**Required unless you provide `invitee_id`**. Email - address of the person you are inviting, which can be an existing - GitHub user." - role: - type: string - description: "The role for the new member. \n * `admin` - Organization - owners with full administrative rights to the organization and - complete access to all repositories and teams. \n * `direct_member` - - Non-owner organization members with ability to see other members - and join teams by invitation. \n * `billing_manager` - Non-owner - organization members with ability to manage the billing settings - of your organization. \n * `reinstate` - The previous role assigned - to the invitee before they were removed from your organization. - Can be one of the roles listed above. Only works if the invitee - was previously part of your organization." - enum: - - admin - - direct_member - - billing_manager - - reinstate - default: direct_member - team_ids: - type: array - description: Specify IDs for the teams you want to invite new members - to. - items: - type: integer - examples: - default: - value: - email: octocat@github.com - role: direct_member - team_ids: - - 12 - - 26 - responses: - '201': - description: Response - content: - application/json: - schema: *237 - examples: - default: - value: - id: 1 - login: monalisa - node_id: MDQ6VXNlcjE= - email: octocat@github.com - role: direct_member - created_at: '2016-11-30T06:46:10-08:00' - inviter: - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - team_count: 2 - invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams - invitation_source: member - '422': *15 - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/invitations/{invitation_id}": - delete: - summary: Cancel an organization invitation - description: |- - Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). - tags: - - orgs - operationId: orgs/cancel-invitation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation - parameters: - - *75 - - &239 - name: invitation_id - description: The unique identifier of the invitation. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - '422': *15 - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/invitations/{invitation_id}/teams": - get: - summary: List organization invitation teams - description: List all teams associated with an invitation. In order to see invitations - in an organization, the authenticated user must be an organization owner. - tags: - - orgs - operationId: orgs/list-invitation-teams - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams - parameters: - - *75 - - *239 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: &260 - value: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/issue-fields": - get: - summary: List issue fields for an organization - description: Lists all issue fields for an organization. OAuth app tokens and - personal access tokens (classic) need the read:org scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-issue-fields - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &240 - title: Issue Field - description: A custom attribute defined at the organization level - for attaching structured data to issues. - type: object - nullable: true - properties: - id: - type: integer - description: The unique identifier of the issue field. - node_id: - type: string - description: The node identifier of the issue field. - name: - type: string - description: The name of the issue field. - description: - type: string - description: The description of the issue field. - nullable: true - data_type: - type: string - description: The data type of the issue field. - enum: - - text - - date - - single_select - - number - visibility: - type: string - description: The visibility of the issue field. Can be `organization_members_only` - (visible only within the organization) or `all` (visible to - all users who can see issues). - enum: - - organization_members_only - - all - options: - description: Available options for single select fields. - type: array - items: - type: object - properties: - id: - type: integer - description: The unique identifier of the option. - name: - type: string - description: The name of the option. - description: - type: string - description: The description of the option. - nullable: true - color: - type: string - description: The color of the option. - enum: - - gray - - blue - - green - - yellow - - orange - - red - - pink - - purple - nullable: true - priority: - type: integer - description: The priority of the option for ordering. - nullable: true - created_at: - type: string - description: The time the option was created. - format: date-time - updated_at: - type: string - description: The time the option was last updated. - format: date-time - required: - - id - - name - nullable: true - created_at: - type: string - description: The time the issue field was created. - format: date-time - updated_at: - type: string - description: The time the issue field was last updated. - format: date-time - required: - - id - - node_id - - name - - data_type - examples: - default: - value: - - id: 1 - node_id: IFT_kwDNAd3NAZo - name: Text field - description: DRI - data_type: text - created_at: '2024-12-11T14:39:09Z' - updated_at: '2024-12-11T14:39:09Z' - - id: 2 - node_id: IFSS_kwDNAd3NAZs - name: Priority - description: Level of importance - data_type: single_select - options: - - id: 1 - name: High - color: red - - id: 2 - name: Medium - color: yellow - - id: 3 - name: Low - color: green - created_at: '2024-12-11T14:39:09Z' - updated_at: '2024-12-11T14:39:09Z' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-fields - post: - summary: Create issue field for an organization - description: |- - Creates a new issue field for an organization. - - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). - - To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and - personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/create-issue-field - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the issue field. - type: string - description: - description: Description of the issue field. - type: string - nullable: true - data_type: - description: The data type of the issue field. - type: string - enum: - - text - - date - - single_select - - number - visibility: - description: The visibility of the issue field. Can be `organization_members_only` - (visible only within the organization) or `all` (visible to all - users who can see issues). Only used when the visibility settings - feature is enabled. Defaults to `organization_members_only`. - type: string - enum: - - organization_members_only - - all - options: - description: Options for single select fields. Required when data_type - is 'single_select'. - type: array - items: - type: object - properties: - name: - description: Name of the option. - type: string - description: - description: Description of the option. - type: string - nullable: true - color: - description: Color for the option. - type: string - enum: - - gray - - blue - - green - - yellow - - orange - - red - - pink - - purple - priority: - description: Priority of the option for ordering. - type: integer - required: - - name - - color - - priority - nullable: true - required: - - name - - data_type - examples: - default: - value: - name: Priority - description: Level of importance for the issue - data_type: single_select - options: - - name: High - description: High priority - color: red - - name: Medium - description: Medium priority - color: yellow - - name: Low - description: Low priority - color: green - responses: - '200': - description: Response - content: - application/json: - schema: *240 - examples: - default: &241 - value: - id: 512 - node_id: IF_kwDNAd3NAZr - name: Priority - description: Level of importance for the issue - data_type: single_select - options: - - id: 1 - name: High - description: High priority - color: red - priority: 1 - created_at: '2025-01-15T10:30:15Z' - updated_at: '2025-01-15T10:30:15Z' - - id: 2 - name: Medium - description: Medium priority - color: yellow - priority: 2 - created_at: '2025-01-15T10:30:15Z' - updated_at: '2025-01-15T10:30:15Z' - - id: 3 - name: Low - description: Low priority - color: green - priority: 3 - created_at: '2025-01-15T10:30:15Z' - updated_at: '2025-01-15T10:30:15Z' - created_at: '2025-01-15T10:30:15Z' - updated_at: '2025-01-15T10:30:15Z' - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-fields - "/orgs/{org}/issue-fields/{issue_field_id}": - patch: - summary: Update issue field for an organization - description: |- - Updates an issue field for an organization. - - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). - - To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and - personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/update-issue-field - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization - parameters: - - *75 - - &242 - name: issue_field_id - description: The unique identifier of the issue field. - in: path - required: true - schema: - type: integer - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the issue field. - type: string - description: - description: Description of the issue field. - type: string - nullable: true - visibility: - description: The visibility of the issue field. Can be `organization_members_only` - (visible only within the organization) or `all` (visible to all - users who can see issues). Only used when the visibility settings - feature is enabled. - type: string - enum: - - organization_members_only - - all - options: - description: Options for single select fields. Only applicable when - updating single_select fields. - type: array - items: - type: object - properties: - name: - description: Name of the option. - type: string - description: - description: Description of the option. - type: string - nullable: true - color: - description: Color for the option. - type: string - enum: - - gray - - blue - - green - - yellow - - orange - - red - - pink - - purple - priority: - description: Priority of the option for ordering. - type: integer - required: - - name - - color - - priority - examples: - default: - summary: Update name and description - description: Update the name and description of an issue field - value: - name: Priority - description: Level of importance for the issue - update-single-select-options: - summary: Update single select options - description: Update the options for a single select issue field - value: - name: Status - description: Current status of the issue - options: - - name: Backlog - description: Items waiting to be prioritized - color: gray - priority: 1 - - name: In Progress - description: Currently being worked on - color: blue - priority: 2 - - name: Done - description: Completed work - color: green - priority: 3 - update-name-only: - summary: Update name only - description: Update only the name of an issue field - value: - name: Updated Field Name - responses: - '200': - description: Response - content: - application/json: - schema: *240 - examples: - default: *241 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-fields - delete: - summary: Delete issue field for an organization - description: |- - Deletes an issue field for an organization. - - You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). - - To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and - personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/delete-issue-field - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization - parameters: - - *75 - - *242 - responses: - '204': *191 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-fields - "/orgs/{org}/issue-types": - get: - summary: List issue types for an organization - description: Lists all issue types for an organization. OAuth app tokens and - personal access tokens (classic) need the read:org scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-issue-types - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *243 - examples: - default: - value: - - id: 410 - node_id: IT_kwDNAd3NAZo - name: Task - description: A specific piece of work - created_at: '2024-12-11T14:39:09Z' - updated_at: '2024-12-11T14:39:09Z' - - id: 411 - node_id: IT_kwDNAd3NAZs - name: Bug - description: An unexpected problem or behavior - created_at: '2024-12-11T14:39:09Z' - updated_at: '2024-12-11T14:39:09Z' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-types - post: - summary: Create issue type for an organization - description: |- - Create a new issue type for an organization. - - You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). - - To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and - personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/create-issue-type - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the issue type. - type: string - is_enabled: - description: Whether or not the issue type is enabled at the organization - level. - type: boolean - description: - description: Description of the issue type. - type: string - nullable: true - color: - description: Color for the issue type. - type: string - enum: - - gray - - blue - - green - - yellow - - orange - - red - - pink - - purple - nullable: true - required: - - name - - is_enabled - examples: - default: - value: - name: Epic - description: An issue type for a multi-week tracking of work - is_enabled: true - color: green - responses: - '200': - description: Response - content: - application/json: - schema: *243 - examples: - default: &244 - value: - id: 410 - node_id: IT_kwDNAd3NAZo - name: Task - description: A specific piece of work - created_at: '2024-12-11T14:39:09Z' - updated_at: '2024-12-11T14:39:09Z' - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-types - "/orgs/{org}/issue-types/{issue_type_id}": - put: - summary: Update issue type for an organization - description: |- - Updates an issue type for an organization. - - You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). - - To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and - personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/update-issue-type - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization - parameters: - - *75 - - &245 - name: issue_type_id - description: The unique identifier of the issue type. - in: path - required: true - schema: - type: integer - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the issue type. - type: string - is_enabled: - description: Whether or not the issue type is enabled at the organization - level. - type: boolean - description: - description: Description of the issue type. - type: string - nullable: true - color: - description: Color for the issue type. - type: string - enum: - - gray - - blue - - green - - yellow - - orange - - red - - pink - - purple - nullable: true - required: - - name - - is_enabled - examples: - default: - value: - name: Epic - description: An issue type for a multi-week tracking of work - is_enabled: true - color: green - responses: - '200': - description: Response - content: - application/json: - schema: *243 - examples: - default: *244 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-types - delete: - summary: Delete issue type for an organization - description: |- - Deletes an issue type for an organization. - - You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). - - To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and - personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/delete-issue-type - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization - parameters: - - *75 - - *245 - responses: - '204': - description: Response - '422': *7 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: issue-types - "/orgs/{org}/issues": - get: - summary: List organization issues assigned to the authenticated user - description: |- - List issues in an organization assigned to the authenticated user. - - > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user - parameters: - - *75 - - name: filter - description: Indicates which sorts of issues to return. `assigned` means issues - assigned to you. `created` means issues created by you. `mentioned` means - issues mentioning you. `subscribed` means issues you're subscribed to updates - for. `all` or `repos` means all issues you can see, regardless of participation - or creation. - in: query - required: false - schema: - type: string - enum: - - assigned - - created - - mentioned - - subscribed - - repos - - all - default: assigned - - name: state - description: Indicates the state of the issues to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *246 - - name: type - description: Can be the name of an issue type. - in: query - required: false - schema: - type: string - - name: sort - description: What to sort results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - comments - default: created - - *61 - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: *247 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: issues - subcategory: issues - "/orgs/{org}/members": - get: - summary: List organization members - description: List all users who are members of an organization. If the authenticated - user is also a member of this organization then both concealed and public - members will be returned. - tags: - - orgs - operationId: orgs/list-members - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#list-organization-members - parameters: - - *75 - - name: filter - description: Filter members returned in the list. `2fa_disabled` means that - only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) - enabled will be returned. `2fa_insecure` means that only members with [insecure - 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) - will be returned. These options are only available for organization owners. - in: query - required: false - schema: - type: string - enum: - - 2fa_disabled - - 2fa_insecure - - all - default: all - - name: role - description: Filter members returned by their role. - in: query - required: false - schema: - type: string - enum: - - all - - admin - - member - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/members/{username}": - get: - summary: Check organization membership for a user - description: Check if a user is, publicly or privately, a member of the organization. - tags: - - orgs - operationId: orgs/check-membership-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user - parameters: - - *75 - - *71 - responses: - '204': - description: Response if requester is an organization member and user is - a member - '302': - description: Response if requester is not an organization member - headers: - Location: - example: https://api.github.com/orgs/github/public_members/pezra - schema: - type: string - '404': - description: Not Found if requester is an organization member and user is - not a member - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - delete: - summary: Remove an organization member - description: |- - Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - - > [!NOTE] - > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. - tags: - - orgs - operationId: orgs/remove-member - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#remove-an-organization-member - parameters: - - *75 - - *71 - responses: - '204': - description: Response - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - x-github-breaking-changes: - - changeset: change_remove_member_trade_compliance_response_status - patch: - responses: - '451': *15 - version: '2026-03-10' - "/orgs/{org}/members/{username}/codespaces": - get: - summary: List codespaces for a user in organization - description: |- - Lists the codespaces that a member of an organization has for repositories in that organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-codespaces-for-user-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization - parameters: - - *17 - - *19 - - *75 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - codespaces - properties: - total_count: - type: integer - codespaces: - type: array - items: *248 - examples: - default: *249 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - "/orgs/{org}/members/{username}/codespaces/{codespace_name}": - delete: - summary: Delete a codespace from the organization - description: |- - Deletes a user's codespace. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/delete-from-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization - parameters: - - *75 - - *71 - - &250 - name: codespace_name - in: path - required: true - description: The name of the codespace. - schema: - type: string - responses: - '202': *39 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": - post: - summary: Stop a codespace for an organization user - description: |- - Stops a user's codespace. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/stop-in-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user - parameters: - - *75 - - *71 - - *250 - responses: - '200': - description: Response - content: - application/json: - schema: *248 - examples: - default: &465 - value: - id: 1 - name: monalisa-octocat-hello-world-g4wpq6h95q - environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer/devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - retention_period_minutes: 43200 - retention_expires_at: - web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - recent_folders: [] - template: - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: organizations - "/orgs/{org}/members/{username}/copilot": - get: - summary: Get Copilot seat assignment details for a user - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. - - The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. - For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). - - Only organization owners can view Copilot seat assignment details for members of their organization. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/get-copilot-seat-details-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user - parameters: - - *75 - - *71 - responses: - '200': - description: The user's GitHub Copilot seat details, including usage. - content: - application/json: - schema: *251 - examples: - default: - value: - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - last_authenticated_at: '2021-10-14T00:53:32-06:00' - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': - description: Copilot Business or Enterprise is not enabled for this organization - or the user has a pending organization invitation. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/orgs/{org}/memberships/{username}": - get: - summary: Get organization membership for a user - description: In order to get a user's membership with an organization, the authenticated - user must be an organization member. The `state` parameter in the response - can be used to identify the user's membership status. - tags: - - orgs - operationId: orgs/get-membership-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user - parameters: - - *75 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: &252 - title: Org Membership - description: Org Membership - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/orgs/octocat/memberships/defunkt - state: - type: string - description: The state of the member in the organization. The - `pending` state indicates the user has not yet accepted an invitation. - example: active - enum: - - active - - pending - role: - type: string - description: The user's membership type in the organization. - example: admin - enum: - - admin - - member - - billing_manager - direct_membership: - type: boolean - description: Whether the user has direct membership in the organization. - example: true - enterprise_teams_providing_indirect_membership: - type: array - description: |- - The slugs of the enterprise teams providing the user with indirect membership in the organization. - A limit of 100 enterprise team slugs is returned. - maxItems: 100 - items: - type: string - example: - - ent:team-one - - ent:team-two - organization_url: - type: string - format: uri - example: https://api.github.com/orgs/octocat - organization: *73 - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - permissions: - type: object - properties: - can_create_repository: - type: boolean - required: - - can_create_repository - required: - - state - - role - - organization_url - - url - - organization - - user - examples: - response-if-user-has-an-active-admin-membership-with-organization: &253 - summary: Response if user has an active admin membership with organization - value: - url: https://api.github.com/orgs/octocat/memberships/defunkt - state: active - role: admin - organization_url: https://api.github.com/orgs/octocat - direct_membership: true - enterprise_teams_providing_indirect_membership: - - ent:justice-league - - ent:security-managers - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - put: - summary: Set organization membership for a user - description: "Only authenticated organization owners can add a member to the - organization or update the member's role.\n\n* If the authenticated user - is _adding_ a member to the organization, the invited user will receive an - email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) - will be `pending` until they accept the invitation.\n \n* Authenticated - users can _update_ a user's membership by passing the `role` parameter. If - the authenticated user changes a member's role to `admin`, the affected user - will receive an email notifying them that they've been made an organization - owner. If the authenticated user changes an owner's role to `member`, no email - will be sent.\n\n**Rate limits**\n\nTo prevent abuse, organization owners - are limited to creating 50 organization invitations for an organization within - a 24 hour period. If the organization is more than one month old or on a paid - plan, the limit is 500 invitations per 24 hour period." - tags: - - orgs - operationId: orgs/set-membership-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user - parameters: - - *75 - - *71 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - role: - type: string - description: "The role to give the user in the organization. Can - be one of: \n * `admin` - The user will become an owner of the - organization. \n * `member` - The user will become a non-owner - member of the organization." - enum: - - admin - - member - default: member - examples: - default: - summary: Set an organization membership role for a user - value: - role: member - responses: - '200': - description: Response - content: - application/json: - schema: *252 - examples: - response-if-user-already-had-membership-with-organization: *253 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - x-github-breaking-changes: - - changeset: change_update_user_membership_trade_compliance_response_status - patch: - responses: - '451': *15 - version: '2026-03-10' - delete: - summary: Remove organization membership for a user - description: |- - In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - - If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - - > [!NOTE] - > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. - tags: - - orgs - operationId: orgs/remove-membership-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user - parameters: - - *75 - - *71 - responses: - '204': - description: Response - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/migrations": - get: - summary: List organization migrations - description: |- - Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - - A list of `repositories` is only returned for export migrations. - tags: - - migrations - operationId: migrations/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations - parameters: - - *75 - - *17 - - *19 - - name: exclude - description: Exclude attributes from the API response to improve performance - in: query - schema: - type: array - items: - description: Allowed values that can be passed to the exclude param. - enum: - - repositories - example: repositories - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &254 - title: Migration - description: A migration. - type: object - properties: - id: - type: integer - format: int64 - example: 79 - owner: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - guid: - type: string - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: - type: string - example: pending - lock_repositories: - type: boolean - example: true - exclude_metadata: - type: boolean - exclude_git_data: - type: boolean - exclude_attachments: - type: boolean - exclude_releases: - type: boolean - exclude_owner_projects: - type: boolean - org_metadata_only: - type: boolean - repositories: - type: array - description: The repositories included in the migration. Only - returned for export migrations. - items: *79 - url: - type: string - format: uri - example: https://api.github.com/orgs/octo-org/migrations/79 - created_at: - type: string - format: date-time - example: '2015-07-06T15:33:38-07:00' - updated_at: - type: string - format: date-time - example: '2015-07-06T15:33:38-07:00' - node_id: - type: string - archive_url: - type: string - format: uri - exclude: - description: 'Exclude related items from being returned in the - response in order to improve performance of the request. The - array can include any of: `"repositories"`.' - type: array - items: - description: 'Allowed values that can be passed to the exclude - parameter. The array can include any of: `"repositories"`.' - type: string - required: - - id - - node_id - - owner - - guid - - state - - lock_repositories - - exclude_metadata - - exclude_git_data - - exclude_attachments - - exclude_releases - - exclude_owner_projects - - org_metadata_only - - repositories - - url - - created_at - - updated_at - x-github-breaking-changes: - - changeset: restrict_repo_fields_in_migration_resource - patch: - - op: replace - path: "/properties/repositories" - value: - type: array - description: The repositories included in the migration. Only - returned for export migrations. - items: *66 - version: '2026-03-10' - examples: - default: - value: - - id: 79 - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: pending - lock_repositories: true - exclude_attachments: false - exclude_releases: false - exclude_owner_projects: false - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - url: https://api.github.com/orgs/octo-org/migrations/79 - created_at: '2015-07-06T15:33:38-07:00' - updated_at: '2015-07-06T15:33:38-07:00' - node_id: MDQ6VXNlcjE= - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - post: - summary: Start an organization migration - description: Initiates the generation of a migration archive. - tags: - - migrations - operationId: migrations/start-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - repositories: - type: array - description: A list of arrays indicating which repositories should - be migrated. - items: - type: string - lock_repositories: - type: boolean - example: true - description: Indicates whether repositories should be locked (to - prevent manipulation) while migrating data. - default: false - exclude_metadata: - type: boolean - description: Indicates whether metadata should be excluded and only - git source should be included for the migration. - default: false - exclude_git_data: - type: boolean - description: Indicates whether the repository git data should be - excluded from the migration. - default: false - exclude_attachments: - type: boolean - example: true - description: Indicates whether attachments should be excluded from - the migration (to reduce migration archive file size). - default: false - exclude_releases: - type: boolean - example: true - description: Indicates whether releases should be excluded from - the migration (to reduce migration archive file size). - default: false - exclude_owner_projects: - type: boolean - example: true - description: Indicates whether projects owned by the organization - or users should be excluded. from the migration. - default: false - org_metadata_only: - type: boolean - example: true - description: Indicates whether this should only include organization - metadata (repositories array should be empty and will ignore other - flags). - default: false - exclude: - type: array - description: Exclude related items from being returned in the response - in order to improve performance of the request. - items: - type: string - enum: - - repositories - required: - - repositories - examples: - default: - value: - repositories: - - github/Hello-World - lock_repositories: true - responses: - '201': - description: Response - content: - application/json: - schema: *254 - examples: - default: - value: - id: 79 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: pending - lock_repositories: true - exclude_attachments: false - exclude_releases: false - exclude_owner_projects: false - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - url: https://api.github.com/orgs/octo-org/migrations/79 - created_at: '2015-07-06T15:33:38-07:00' - updated_at: '2015-07-06T15:33:38-07:00' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - "/orgs/{org}/migrations/{migration_id}": - get: - summary: Get an organization migration status - description: |- - Fetches the status of a migration. - - The `state` of a migration can be one of the following values: - - * `pending`, which means the migration hasn't started yet. - * `exporting`, which means the migration is in progress. - * `exported`, which means the migration finished successfully. - * `failed`, which means the migration failed. - tags: - - migrations - operationId: migrations/get-status-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status - parameters: - - *75 - - &255 - name: migration_id - description: The unique identifier of the migration. - in: path - required: true - schema: - type: integer - - name: exclude - description: Exclude attributes from the API response to improve performance - in: query - schema: - type: array - items: - description: Allowed values that can be passed to the exclude param. - enum: - - repositories - example: repositories - type: string - responses: - '200': - description: |- - * `pending`, which means the migration hasn't started yet. - * `exporting`, which means the migration is in progress. - * `exported`, which means the migration finished successfully. - * `failed`, which means the migration failed. - content: - application/json: - schema: *254 - examples: - default: - value: - id: 79 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: exported - lock_repositories: true - exclude_attachments: false - exclude_releases: false - exclude_owner_projects: false - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - url: https://api.github.com/orgs/octo-org/migrations/79 - created_at: '2015-07-06T15:33:38-07:00' - updated_at: '2015-07-06T15:33:38-07:00' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - "/orgs/{org}/migrations/{migration_id}/archive": - get: - summary: Download an organization migration archive - description: Fetches the URL to a migration archive. - tags: - - migrations - operationId: migrations/download-archive-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive - parameters: - - *75 - - *255 - responses: - '302': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - delete: - summary: Delete an organization migration archive - description: Deletes a previous migration archive. Migration archives are automatically - deleted after seven days. - tags: - - migrations - operationId: migrations/delete-archive-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive - parameters: - - *75 - - *255 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": - delete: - summary: Unlock an organization repository - description: Unlocks a repository that was locked for migration. You should - unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) - when the migration is complete and you no longer need the source data. - tags: - - migrations - operationId: migrations/unlock-repo-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository - parameters: - - *75 - - *255 - - &700 - name: repo_name - description: repo_name parameter - in: path - required: true - schema: - type: string - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - "/orgs/{org}/migrations/{migration_id}/repositories": - get: - summary: List repositories in an organization migration - description: List all the repositories for this organization migration. - tags: - - migrations - operationId: migrations/list-repos-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration - parameters: - - *75 - - *255 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: &267 - value: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - has_discussions: false - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - security_and_analysis: - advanced_security: - status: enabled - secret_scanning: - status: enabled - secret_scanning_push_protection: - status: disabled - secret_scanning_non_provider_patterns: - status: disabled - secret_scanning_delegated_alert_dismissal: - status: disabled - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: orgs - x-github-breaking-changes: - - changeset: restrict_repo_fields_in_migration_resource - patch: - responses: - '200': - content: - application/json: - schema: - items: *66 - version: '2026-03-10' - - changeset: restrict_repo_fields_in_migration_resource - patch: - responses: - '200': - content: - application/json: - examples: - version: '2026-03-10' - "/orgs/{org}/organization-roles": - get: - summary: Get all organization roles for an organization - description: |- - Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-org-roles - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - list of organization roles - content: - application/json: - schema: - type: object - properties: - total_count: - type: integer - description: The total number of organization roles available - to the organization. - roles: - type: array - description: The list of organization roles available to the organization. - items: &257 - title: Organization Role - description: Organization roles - type: object - properties: - id: - description: The unique identifier of the role. - type: integer - format: int64 - name: - description: The name of the role. - type: string - description: - description: A short description about who this role is - for or what permissions it grants. - type: string - nullable: true - base_role: - type: string - nullable: true - description: The system role from which this role inherits - permissions. - enum: - - read - - triage - - write - - maintain - - admin - source: - type: string - nullable: true - description: Source answers the question, "where did this - role come from?" - enum: - - Organization - - Enterprise - - Predefined - permissions: - description: A list of permissions included in this role. - type: array - items: - type: string - organization: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - description: The date and time the role was created. - type: string - format: date-time - updated_at: - description: The date and time the role was last updated. - type: string - format: date-time - required: - - id - - name - - permissions - - organization - - created_at - - updated_at - examples: - default: - value: - total_count: 2 - roles: - - id: 8030 - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - organization: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:20:11Z' - - id: 8031 - name: Auditor - description: Permissions to read the organization audit log - permissions: - - read_audit_logs - organization: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:20:11Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/teams/{team_slug}": - delete: - summary: Remove all organization roles for a team - description: |- - Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/revoke-all-org-roles-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team - parameters: - - *75 - - *77 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": - put: - summary: Assign an organization role to a team - description: |- - Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/assign-team-to-org-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team - parameters: - - *75 - - *77 - - &256 - name: role_id - description: The unique identifier of the role. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - '404': - description: Response if the organization, team or role does not exist. - '422': - description: Response if the organization roles feature is not enabled for - the organization, or validation failed. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - delete: - summary: Remove an organization role from a team - description: |- - Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/revoke-org-role-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team - parameters: - - *75 - - *77 - - *256 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/users/{username}": - delete: - summary: Remove all organization roles for a user - description: |- - Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/revoke-all-org-roles-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user - parameters: - - *75 - - *71 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/users/{username}/{role_id}": - put: - summary: Assign an organization role to a user - description: |- - Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/assign-user-to-org-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user - parameters: - - *75 - - *71 - - *256 - responses: - '204': - description: Response - '404': - description: Response if the organization, user or role does not exist. - '422': - description: Response if the organization roles feature is not enabled enabled - for the organization, the validation failed, or the user is not an organization - member. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - delete: - summary: Remove an organization role from a user - description: |- - Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - The authenticated user must be an administrator for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/revoke-org-role-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user - parameters: - - *75 - - *71 - - *256 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/{role_id}": - get: - summary: Get an organization role - description: |- - Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - To use this endpoint, the authenticated user must be one of: - - - An administrator for the organization. - - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/get-org-role - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role - parameters: - - *75 - - *256 - responses: - '200': - description: Response - content: - application/json: - schema: *257 - examples: - default: - value: - id: 8030 - name: Custom Role Manager - description: Permissions to manage custom roles within an org - permissions: - - write_organization_custom_repo_role - - write_organization_custom_org_role - - read_organization_custom_repo_role - - read_organization_custom_org_role - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - created_at: '2022-07-04T22:19:11Z' - updated_at: '2022-07-04T22:20:11Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/{role_id}/teams": - get: - summary: List teams that are assigned to an organization role - description: |- - Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - To use this endpoint, you must be an administrator for the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-org-role-teams - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role - parameters: - - *75 - - *256 - - *17 - - *19 - responses: - '200': - description: Response - List of assigned teams - content: - application/json: - schema: - type: array - description: List of teams assigned to the organization role - items: - title: A Role Assignment for a Team - description: The Relationship a Team has with a role. - type: object - properties: - assignment: - type: string - description: Determines if the team has a direct, indirect, - or mixed relationship to a role - enum: - - direct - - indirect - - mixed - example: direct - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: string - nullable: true - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - title: Team Simple - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: *258 - required: *259 - nullable: true - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to which - this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which this - team belongs - example: 42 - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - type - - parent - examples: - default: *260 - headers: - Link: *67 - '404': - description: Response if the organization or role does not exist. - '422': - description: Response if the organization roles feature is not enabled or - validation failed. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/organization-roles/{role_id}/users": - get: - summary: List users that are assigned to an organization role - description: |- - Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." - - To use this endpoint, you must be an administrator for the organization. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/list-org-role-users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role - parameters: - - *75 - - *256 - - *17 - - *19 - responses: - '200': - description: Response - List of assigned users - content: - application/json: - schema: - type: array - description: List of users assigned to the organization role - items: - title: A Role Assignment for a User - description: The Relationship a User has with a role. - type: object - properties: - assignment: - type: string - description: Determines if the user has a direct, indirect, - or mixed relationship to a role - enum: - - direct - - indirect - - mixed - example: direct - inherited_from: - description: Team the user has gotten the role through - type: array - items: &333 - title: Team Simple - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: *258 - required: *259 - name: - nullable: true - type: string - email: - nullable: true - type: string - login: - type: string - example: octocat - id: - type: integer - example: 1 - node_id: - type: string - example: MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - gravatar_id: - type: string - example: 41d064eb2195891e12d0413f63227ea7 - nullable: true - url: - type: string - format: uri - example: https://api.github.com/users/octocat - html_url: - type: string - format: uri - example: https://github.com/octocat - followers_url: - type: string - format: uri - example: https://api.github.com/users/octocat/followers - following_url: - type: string - example: https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - example: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: - type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: - type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: - type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: - type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: - type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: - type: string - format: uri - example: https://api.github.com/users/octocat/received_events - type: - type: string - example: User - site_admin: - type: boolean - starred_at: - type: string - example: '"2020-07-09T00:17:55Z"' - user_view_type: - type: string - example: public - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - examples: - default: *70 - headers: - Link: *67 - '404': - description: Response if the organization or role does not exist. - '422': - description: Response if the organization roles feature is not enabled or - validation failed. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: organization-roles - "/orgs/{org}/outside_collaborators": - get: - summary: List outside collaborators for an organization - description: List all users who are outside collaborators of an organization. - tags: - - orgs - operationId: orgs/list-outside-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization - parameters: - - *75 - - name: filter - description: Filter the list of outside collaborators. `2fa_disabled` means - that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) - enabled will be returned. `2fa_insecure` means that only outside collaborators - with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) - will be returned. - in: query - required: false - schema: - type: string - enum: - - 2fa_disabled - - 2fa_insecure - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: outside-collaborators - "/orgs/{org}/outside_collaborators/{username}": - put: - summary: Convert an organization member to outside collaborator - description: When an organization member is converted to an outside collaborator, - they'll only have access to the repositories that their current team membership - allows. The user will no longer be a member of the organization. For more - information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". - Converting an organization member to an outside collaborator may be restricted - by enterprise administrators. For more information, see "[Enforcing repository - management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - tags: - - orgs - operationId: orgs/convert-member-to-outside-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator - parameters: - - *75 - - *71 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - async: - type: boolean - description: When set to `true`, the request will be performed asynchronously. - Returns a 202 status code when the job is successfully queued. - default: false - examples: - '202': - summary: Status code 202, asynchronous request - value: - async: true - '204': - summary: Status code 204, synchronous request - value: - responses: - '202': - description: User is getting converted asynchronously - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - '202': - value: - '204': - description: User was converted - '403': - description: Forbidden if user is the last owner of the organization, not - a member of the organization, or if the enterprise enforces a policy for - inviting outside collaborators. For more information, see "[Enforcing - repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: outside-collaborators - delete: - summary: Remove outside collaborator from an organization - description: Removing a user from this list will remove them from all the organization's - repositories. - tags: - - orgs - operationId: orgs/remove-outside-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization - parameters: - - *75 - - *71 - responses: - '204': - description: Response - '422': - description: Unprocessable Entity if user is a member of the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-user-is-a-member-of-the-organization: - value: - message: You cannot specify an organization member to remove as - an outside collaborator. - documentation_url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: outside-collaborators - "/orgs/{org}/packages": - get: - summary: List packages for an organization - description: |- - Lists packages in an organization readable by the user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/list-packages-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#list-packages-for-an-organization - parameters: - - name: package_type - description: The type of supported package. Packages in GitHub's Gradle registry - have the type `maven`. Docker images pushed to GitHub's Container registry - (`ghcr.io`) have the type `container`. You can use the type `docker` to - find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), - even if these have now been migrated to the Container registry. - in: query - required: true - schema: - type: string - enum: - - npm - - maven - - rubygems - - docker - - nuget - - container - - *75 - - &701 - name: visibility - description: |- - The selected visibility of the packages. This parameter is optional and only filters an existing result set. - - The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - in: query - required: false - schema: - type: string - enum: - - public - - private - - internal - - name: page - description: The page number of the results to fetch. For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 1 - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 30 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *261 - examples: - default: *262 - '403': *29 - '401': *25 - '400': &703 - description: The value of `per_page` multiplied by `page` cannot be greater - than 10000. - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/packages/{package_type}/{package_name}": - get: - summary: Get a package for an organization - description: |- - Gets a specific package in an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-package-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization - parameters: - - &263 - name: package_type - description: The type of supported package. Packages in GitHub's Gradle registry - have the type `maven`. Docker images pushed to GitHub's Container registry - (`ghcr.io`) have the type `container`. You can use the type `docker` to - find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), - even if these have now been migrated to the Container registry. - in: path - required: true - schema: - type: string - enum: - - npm - - maven - - rubygems - - docker - - nuget - - container - - &264 - name: package_name - description: The name of the package. - in: path - required: true - schema: - type: string - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *261 - examples: - default: - value: - id: 197 - name: hello_docker - package_type: container - owner: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - version_count: 1 - visibility: private - url: https://api.github.com/orgs/github/packages/container/hello_docker - created_at: '2020-05-19T22:19:11Z' - updated_at: '2020-05-19T22:19:11Z' - html_url: https://github.com/orgs/github/packages/container/package/hello_docker - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - delete: - summary: Delete a package for an organization - description: |- - Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/delete-package-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization - parameters: - - *263 - - *264 - - *75 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/packages/{package_type}/{package_name}/restore": - post: - summary: Restore a package for an organization - description: |- - Restores an entire package in an organization. - - You can restore a deleted package under the following conditions: - - The package was deleted within the last 30 days. - - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/restore-package-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization - parameters: - - *263 - - *264 - - *75 - - name: token - description: package token - schema: - type: string - required: false - in: query - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/packages/{package_type}/{package_name}/versions": - get: - summary: List package versions for a package owned by an organization - description: |- - Lists package versions for a package owned by an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-all-package-versions-for-package-owned-by-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization - parameters: - - *263 - - *264 - - *75 - - *19 - - *17 - - name: state - in: query - required: false - description: The state of the package, either active or deleted. - schema: - type: string - enum: - - active - - deleted - default: active - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &265 - title: Package Version - description: A version of a software package - type: object - properties: - id: - description: Unique identifier of the package version. - type: integer - example: 1 - name: - description: The name of the package version. - type: string - example: latest - url: - type: string - example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 - package_html_url: - type: string - example: https://github.com/orgs/github/packages/container/package/super-linter - html_url: - type: string - example: https://github.com/orgs/github/packages/container/super-linter/786068 - license: - type: string - example: MIT - description: - type: string - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '2014-03-03T18:58:10Z' - deleted_at: - type: string - format: date-time - example: '2014-03-03T18:58:10Z' - metadata: - type: object - title: Package Version Metadata - properties: - package_type: - type: string - example: docker - enum: - - npm - - maven - - rubygems - - docker - - nuget - - container - container: - type: object - title: Container Metadata - properties: - tags: - type: array - items: - type: string - required: - - tags - docker: - type: object - title: Docker Metadata - properties: - tag: - type: array - items: - type: string - required: - - tags - required: - - package_type - required: - - id - - name - - url - - package_html_url - - created_at - - updated_at - examples: - default: - value: - - id: 245301 - name: 1.0.4 - url: https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301 - package_html_url: https://github.com/octo-org/hello-world-npm/packages/43752 - created_at: '2019-11-05T22:49:04Z' - updated_at: '2019-11-05T22:49:04Z' - html_url: https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4 - metadata: - package_type: npm - - id: 209672 - name: 1.0.3 - url: https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672 - package_html_url: https://github.com/octo-org/hello-world-npm/packages/43752 - created_at: '2019-10-29T15:42:11Z' - updated_at: '2019-10-29T15:42:12Z' - html_url: https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3 - metadata: - package_type: npm - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": - get: - summary: Get a package version for an organization - description: |- - Gets a specific package version in an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-package-version-for-organization - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization - parameters: - - *263 - - *264 - - *75 - - &266 - name: package_version_id - description: Unique identifier of the package version. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *265 - examples: - default: - value: - id: 836 - name: sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 - url: https://api.github.com/orgs/github/packages/container/hello_docker/versions/836 - package_html_url: https://github.com/orgs/github/packages/container/package/hello_docker - created_at: '2020-05-19T22:19:11Z' - updated_at: '2020-05-19T22:19:11Z' - html_url: https://github.com/orgs/github/packages/container/hello_docker/836 - metadata: - package_type: container - container: - tags: - - latest - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - delete: - summary: Delete package version for an organization - description: |- - Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/delete-package-version-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization - parameters: - - *263 - - *264 - - *75 - - *266 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": - post: - summary: Restore package version for an organization - description: |- - Restores a specific package version in an organization. - - You can restore a deleted package under the following conditions: - - The package was deleted within the last 30 days. - - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - - The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/restore-package-version-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization - parameters: - - *263 - - *264 - - *75 - - *266 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/orgs/{org}/personal-access-token-requests": - get: - summary: List requests to access organization resources with fine-grained personal - access tokens - description: |- - Lists requests from organization members to access organization resources with a fine-grained personal access token. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/list-pat-grant-requests - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens - parameters: - - *75 - - *17 - - *19 - - &268 - name: sort - description: The property by which to sort the results. - in: query - required: false - schema: - type: string - enum: - - created_at - default: created_at - - *61 - - &269 - name: owner - description: A list of owner usernames to use to filter the results. - in: query - required: false - schema: - type: array - maxItems: 10 - items: - type: string - example: owner[]=octocat1,owner[]=octocat2 - - &270 - name: repository - description: The name of the repository to use to filter the results. - in: query - required: false - schema: - type: string - example: Hello-World - - &271 - name: permission - description: The permission to use to filter the results. - in: query - required: false - schema: - type: string - example: issues_read - - &272 - name: last_used_before - description: 'Only show fine-grained personal access tokens used before the - given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - format: date-time - - &273 - name: last_used_after - description: 'Only show fine-grained personal access tokens used after the - given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - format: date-time - - &274 - name: token_id - description: The ID of the token - in: query - required: false - schema: - type: array - maxItems: 50 - items: - type: string - example: token_id[]=1,token_id[]=2 - responses: - '500': *55 - '422': *15 - '404': *6 - '403': *29 - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Simple Organization Programmatic Access Grant Request - description: Minimal representation of an organization programmatic - access grant request for enumerations - type: object - properties: - id: - type: integer - description: Unique identifier of the request for access via - fine-grained personal access token. The `pat_request_id` used - to review PAT requests. - reason: - type: string - nullable: true - description: Reason for requesting access. - owner: *4 - repository_selection: - type: string - enum: - - none - - all - - subset - description: Type of repository selection requested. - repositories_url: - type: string - description: URL to the list of repositories requested to be - accessed via fine-grained personal access token. Should only - be followed when `repository_selection` is `subset`. - permissions: - type: object - description: Permissions requested, categorized by type of permission. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - created_at: - type: string - description: Date and time when the request for access was created. - token_id: - type: integer - description: Unique identifier of the user's token. This field - can also be found in audit log events and the organization's - settings for their PAT grants. - token_name: - type: string - description: The name given to the user's token. This field - can also be found in an organization's settings page for Active - Tokens. - token_expired: - type: boolean - description: Whether the associated fine-grained personal access - token has expired. - token_expires_at: - type: string - nullable: true - description: Date and time when the associated fine-grained - personal access token expires. - token_last_used_at: - type: string - nullable: true - description: Date and time when the associated fine-grained - personal access token was last used for authentication. - required: - - id - - reason - - owner - - repository_selection - - repositories_url - - permissions - - created_at - - token_id - - token_name - - token_expired - - token_expires_at - - token_last_used_at - examples: - default: - value: - - id: 25381 - reason: I need to access the GitHub API - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository_selection: all - repositories_url: https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories - permissions: - organization: - members: read - repository: - metadata: read - created_at: '2023-05-16T08:47:09.000-07:00' - token_id: 98716 - token_name: Some Token - token_expired: false - token_expires_at: '2023-11-16T08:47:09.000-07:00' - token_last_used_at: - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - post: - summary: Review requests to access organization resources with fine-grained - personal access tokens - description: |- - Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/review-pat-grant-requests-in-bulk - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - pat_request_ids: - type: array - description: Unique identifiers of the requests for access via fine-grained - personal access token. Must be formed of between 1 and 100 `pat_request_id` - values. - items: - type: integer - minItems: 1 - maxItems: 100 - action: - type: string - description: Action to apply to the requests. - enum: - - approve - - deny - reason: - type: string - description: Reason for approving or denying the requests. Max 1024 - characters. - maxLength: 1024 - nullable: true - required: - - action - examples: - '204': - summary: Example of denying a request - value: - pat_request_ids: - - 42 - - 73 - action: deny - reason: Access is too broad. - responses: - '500': *55 - '422': *15 - '404': *6 - '403': *29 - '202': *39 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - "/orgs/{org}/personal-access-token-requests/{pat_request_id}": - post: - summary: Review a request to access organization resources with a fine-grained - personal access token - description: |- - Approves or denies a pending request to access organization resources via a fine-grained personal access token. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/review-pat-grant-request - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token - parameters: - - *75 - - name: pat_request_id - in: path - description: Unique identifier of the request for access via fine-grained - personal access token. - required: true - schema: - type: integer - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - description: Action to apply to the request. - enum: - - approve - - deny - reason: - type: string - description: Reason for approving or denying the request. Max 1024 - characters. - maxLength: 1024 - nullable: true - required: - - action - examples: - '204': - summary: Example of denying a request - value: - action: deny - reason: This request is denied because the access is too broad. - responses: - '500': *55 - '422': *15 - '404': *6 - '403': *29 - '204': *191 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": - get: - summary: List repositories requested to be accessed by a fine-grained personal - access token - description: |- - Lists the repositories a fine-grained personal access token request is requesting access to. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/list-pat-grant-request-repositories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token - parameters: - - *75 - - name: pat_request_id - in: path - description: Unique identifier of the request for access via fine-grained - personal access token. - required: true - schema: - type: integer - - *17 - - *19 - responses: - '500': *55 - '404': *6 - '403': *29 - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - "/orgs/{org}/personal-access-tokens": - get: - summary: List fine-grained personal access tokens with access to organization - resources - description: |- - Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/list-pat-grants - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources - parameters: - - *75 - - *17 - - *19 - - *268 - - *61 - - *269 - - *270 - - *271 - - *272 - - *273 - - *274 - responses: - '500': *55 - '422': *15 - '404': *6 - '403': *29 - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Organization Programmatic Access Grant - description: Minimal representation of an organization programmatic - access grant for enumerations - type: object - properties: - id: - type: integer - description: Unique identifier of the fine-grained personal - access token grant. The `pat_id` used to get details about - an approved fine-grained personal access token. - owner: *4 - repository_selection: - type: string - enum: - - none - - all - - subset - description: Type of repository selection requested. - repositories_url: - type: string - description: URL to the list of repositories the fine-grained - personal access token can access. Only follow when `repository_selection` - is `subset`. - permissions: - type: object - description: Permissions requested, categorized by type of permission. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - access_granted_at: - type: string - description: Date and time when the fine-grained personal access - token was approved to access the organization. - token_id: - type: integer - description: Unique identifier of the user's token. This field - can also be found in audit log events and the organization's - settings for their PAT grants. - token_name: - type: string - description: The name given to the user's token. This field - can also be found in an organization's settings page for Active - Tokens. - token_expired: - type: boolean - description: Whether the associated fine-grained personal access - token has expired. - token_expires_at: - type: string - nullable: true - description: Date and time when the associated fine-grained - personal access token expires. - token_last_used_at: - type: string - nullable: true - description: Date and time when the associated fine-grained - personal access token was last used for authentication. - required: - - id - - owner - - repository_selection - - repositories_url - - permissions - - access_granted_at - - token_id - - token_name - - token_expired - - token_expires_at - - token_last_used_at - examples: - default: - value: - - id: 25381 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository_selection: all - repositories_url: https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories - permissions: - organization: - members: read - repository: - metadata: read - access_granted_at: '2023-05-16T08:47:09.000-07:00' - token_id: 98716 - token_name: Some Token - token_expired: false - token_expires_at: '2023-11-16T08:47:09.000-07:00' - token_last_used_at: - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - post: - summary: Update the access to organization resources via fine-grained personal - access tokens - description: |- - Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/update-pat-accesses - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - description: Action to apply to the fine-grained personal access - token. - enum: - - revoke - pat_ids: - description: The IDs of the fine-grained personal access tokens. - type: array - items: - type: integer - description: Unique identifier of the fine-grained personal access - token. - minItems: 1 - maxItems: 100 - required: - - action - - pat_ids - examples: - '204': - summary: Example of revoking a fine-grained personal access token. - value: - action: revoke - pat_ids: - - 1296269 - - 1296280 - responses: - '500': *55 - '404': *6 - '202': *39 - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - "/orgs/{org}/personal-access-tokens/{pat_id}": - post: - summary: Update the access a fine-grained personal access token has to organization - resources - description: |- - Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/update-pat-access - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources - parameters: - - *75 - - name: pat_id - description: The unique identifier of the fine-grained personal access token. - in: path - required: true - schema: - type: integer - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - description: Action to apply to the fine-grained personal access - token. - enum: - - revoke - required: - - action - examples: - '204': - summary: Example of revoking a fine-grained personal access token. - value: - action: revoke - responses: - '500': *55 - '404': *6 - '204': *191 - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": - get: - summary: List repositories a fine-grained personal access token has access to - description: |- - Lists the repositories a fine-grained personal access token has access to. - - Only GitHub Apps can use this endpoint. - tags: - - orgs - operationId: orgs/list-pat-grant-repositories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to - parameters: - - *75 - - name: pat_id - in: path - description: Unique identifier of the fine-grained personal access token. - required: true - schema: - type: integer - - *17 - - *19 - responses: - '500': *55 - '404': *6 - '403': *29 - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: personal-access-tokens - "/orgs/{org}/private-registries": - get: - summary: List private registries for an organization - description: |2- - - Lists all private registry configurations available at the organization-level without revealing their encrypted - values. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/list-org-private-registries - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - configurations - properties: - total_count: - type: integer - configurations: - type: array - items: &275 - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - example: MAVEN_REPOSITORY_SECRET - type: string - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with - the private registry. - example: monalisa - type: string - nullable: true - replaces_base: - description: Whether this private registry replaces the - base registry (e.g., npmjs.org for npm, rubygems.org for - rubygems). When `true`, Dependabot will only use this - registry and will not fall back to the public registry. - When `false` (default), Dependabot will use this registry - for scoped packages but may fall back to the public registry - for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have - access to the private registry. - enum: - - all - - private - - selected - type: string - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - default: - value: - total_count: 1 - configurations: - - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - headers: - Link: *67 - '400': *14 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - post: - summary: Create a private registry for an organization - description: |2- - - Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/create-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. - type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: string - nullable: true - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. Required when `auth_type` is `token` or `username_password`. - Should be omitted for OIDC auth types. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. Required - when `auth_type` is `token` or `username_password`. Should be - omitted for OIDC auth types. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. You can manage the list - of selected repositories using the [Update a private registry - for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) - endpoint. This field should be omitted if `visibility` is set - to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. Defaults - to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or - `oidc_jfrog` for OIDC authentication. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - required: - - registry_type - - url - - visibility - examples: - org-private-registry-with-private-visibility: - summary: Example of a private registry configuration with private - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - replaces_base: true - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: private - org-private-registry-with-selected-visibility: - summary: Example of a private registry configuration with selected - visibility - value: - registry_type: maven_repository - url: https://maven.pkg.github.com/organization/ - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - org-private-registry-with-oidc-azure: - summary: Example of an OIDC private registry configuration using Azure - value: - registry_type: docker_registry - url: https://myregistry.azurecr.io - auth_type: oidc_azure - visibility: all - tenant_id: 12345678-1234-1234-1234-123456789012 - client_id: abcdef01-2345-6789-abcd-ef0123456789 - responses: - '201': - description: The organization private registry configuration - content: - application/json: - schema: - title: Organization private registry - description: Private registry configuration for an organization - type: object - properties: - name: - description: The name of the private registry configuration. - example: MAVEN_REPOSITORY_SECRET - type: string - registry_type: - description: The registry type. - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - type: string - auth_type: - description: The authentication type for the private registry. - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - type: string - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the - private registry. - example: monalisa - type: string - replaces_base: - description: Whether this private registry replaces the base registry - (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, - Dependabot will only use this registry and will not fall back - to the public registry. When `false` (default), Dependabot will - use this registry for scoped packages but may fall back to the - public registry for other packages. - type: boolean - default: false - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - enum: - - all - - private - - selected - type: string - selected_repository_ids: - type: array - description: An array of repository IDs that can access the organization - private registry when `visibility` is set to `selected`. - items: - type: integer - tenant_id: - description: The tenant ID of the Azure AD application. - type: string - client_id: - description: The client ID of the Azure AD application. - type: string - aws_region: - description: The AWS region. - type: string - account_id: - description: The AWS account ID. - type: string - role_name: - description: The AWS IAM role name. - type: string - domain: - description: The CodeArtifact domain. - type: string - domain_owner: - description: The CodeArtifact domain owner. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. - type: string - audience: - description: The OIDC audience. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - registry_type - - visibility - - created_at - - updated_at - examples: - org-private-registry-with-selected-visibility: &276 - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: private - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - org-private-registry-with-private-visibility: - value: - name: MAVEN_REPOSITORY_SECRET - registry_type: maven_repository - username: monalisa - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/public-key": - get: - summary: Get private registries public key for an organization - description: |2- - - Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - key_id - - key - properties: - key_id: - description: The identifier for the key. - example: '012345678912345678' - type: string - key: - description: The Base64 encoded public key. - example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - type: string - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/private-registries/{secret_name}": - get: - summary: Get a private registry for an organization - description: |2- - - Get the configuration of a single private registry defined for an organization, omitting its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/get-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization - parameters: - - *75 - - *168 - responses: - '200': - description: The specified private registry configuration for the organization - content: - application/json: - schema: *275 - examples: - default: *276 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - patch: - summary: Update a private registry for an organization - description: |2- - - Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/update-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization - parameters: - - *75 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - registry_type: - description: The registry type. - type: string - enum: - - maven_repository - - nuget_feed - - goproxy_server - - npm_registry - - rubygems_server - - cargo_registry - - composer_repository - - docker_registry - - git_source - - helm_registry - - hex_organization - - hex_repository - - pub_repository - - python_index - - terraform_registry - url: - description: The URL of the private registry. - type: string - format: uri - username: - description: The username to use when authenticating with the private - registry. This field should be omitted if the private registry - does not require a username for authentication. - type: string - nullable: true - replaces_base: - description: Whether this private registry should replace the base - registry (e.g., npmjs.org for npm, rubygems.org for rubygems). - When set to `true`, Dependabot will only use this registry and - will not fall back to the public registry. When set to `false` - (default), Dependabot will use this registry for scoped packages - but may fall back to the public registry for other packages. - type: boolean - default: false - encrypted_value: - description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get private registries - public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) - endpoint. - type: string - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - description: The ID of the key you used to encrypt the secret. - type: string - visibility: - description: Which type of organization repositories have access - to the private registry. `selected` means only the repositories - specified by `selected_repository_ids` can access the private - registry. - type: string - enum: - - all - - private - - selected - selected_repository_ids: - description: An array of repository IDs that can access the organization - private registry. You can only provide a list of repository IDs - when `visibility` is set to `selected`. This field should be omitted - if `visibility` is set to `all` or `private`. - type: array - items: - type: integer - auth_type: - description: The authentication type for the private registry. This - field cannot be changed after creation. If provided, it must match - the existing `auth_type` of the configuration. To change the authentication - type, delete and recreate the configuration. - type: string - enum: - - token - - username_password - - oidc_azure - - oidc_aws - - oidc_jfrog - tenant_id: - description: The tenant ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - client_id: - description: The client ID of the Azure AD application. Required - when `auth_type` is `oidc_azure`. - type: string - aws_region: - description: The AWS region. Required when `auth_type` is `oidc_aws`. - type: string - account_id: - description: The AWS account ID. Required when `auth_type` is `oidc_aws`. - type: string - role_name: - description: The AWS IAM role name. Required when `auth_type` is - `oidc_aws`. - type: string - domain: - description: The CodeArtifact domain. Required when `auth_type` - is `oidc_aws`. - type: string - domain_owner: - description: The CodeArtifact domain owner (AWS account ID). Required - when `auth_type` is `oidc_aws`. - type: string - jfrog_oidc_provider_name: - description: The JFrog OIDC provider name. Required when `auth_type` - is `oidc_jfrog`. - type: string - audience: - description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` - auth types. - type: string - identity_mapping_name: - description: The JFrog identity mapping name. Optional for `oidc_jfrog` - auth type. - type: string - examples: - secret-based-update: - summary: Update a secret-based private registry - value: - username: monalisa - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - oidc-azure-update: - summary: Update an OIDC private registry (Azure) - value: - tenant_id: 12345678-1234-1234-1234-123456789012 - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - delete: - summary: Delete a private registry for an organization - description: |2- - - Delete a private registry configuration at the organization-level. - - OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - private-registries - operationId: private-registries/delete-org-private-registry - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization - parameters: - - *75 - - *168 - responses: - '204': - description: Response - '400': *14 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: private-registries - subcategory: organization-configurations - "/orgs/{org}/projectsV2": - get: - summary: List projects for organization - description: List all projects owned by a specific organization accessible by - the authenticated user. - tags: - - projects - operationId: projects/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-projects-for-organization - parameters: - - *75 - - name: q - description: Limit results to projects of the specified type. - in: query - required: false - schema: - type: string - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &277 - title: Projects v2 Project - description: A projects v2 project - type: object - properties: - id: - type: number - description: The unique identifier of the project. - node_id: - type: string - description: The node ID of the project. - owner: *4 - creator: *4 - title: - type: string - description: The project title. - description: - type: string - nullable: true - description: A short description of the project. - public: - type: boolean - description: Whether the project is visible to anyone with access - to the owner. - closed_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - description: The time when the project was closed. - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the project was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the project was last updated. - number: - type: integer - description: The project number. - short_description: - type: string - nullable: true - description: A concise summary of the project. - deleted_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - description: The time when the project was deleted. - deleted_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - state: - type: string - enum: - - open - - closed - description: The current state of the project. - latest_status_update: - title: Projects v2 Status Update - description: An status update belonging to a project - type: object - properties: &792 - id: - type: number - description: The unique identifier of the status update. - node_id: - type: string - description: The node ID of the status update. - project_node_id: - type: string - description: The node ID of the project that this status - update belongs to. - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the status update was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the status update was last updated. - status: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - description: The current status. - start_date: - type: string - format: date - example: '2022-04-28' - description: The start date of the period covered by the - update. - target_date: - type: string - format: date - example: '2022-04-28' - description: The target date associated with the update. - body: - description: Body of the status update - example: The project is off to a great start! - type: string - nullable: true - required: &793 - - id - - node_id - - created_at - - updated_at - nullable: true - is_template: - type: boolean - description: Whether this project is a template - required: - - id - - node_id - - owner - - creator - - title - - description - - public - - closed_at - - created_at - - updated_at - - number - - short_description - - deleted_at - - deleted_by - examples: - default: &278 - value: - id: 2 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - title: My Projects - description: A board to manage my personal projects. - public: true - closed_at: - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - number: 2 - short_description: - deleted_at: - deleted_by: - state: open - latest_status_update: - id: 3 - node_id: PVTSU_lAECAQM - creator: - login: hubot - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: false - body: DONE - start_date: '2025-07-23' - target_date: '2025-07-26' - status: COMPLETE - created_at: '2025-07-11T16:19:28Z' - updated_at: '2025-07-11T16:19:28Z' - is_template: true - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - "/orgs/{org}/projectsV2/{project_number}": - get: - summary: Get project for organization - description: Get a specific organization-owned project. - tags: - - projects - operationId: projects/get-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#get-project-for-organization - parameters: - - &279 - name: project_number - description: The project's number. - in: path - required: true - schema: - type: integer - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *277 - examples: - default: *278 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - "/orgs/{org}/projectsV2/{project_number}/drafts": - post: - summary: Create draft item for organization owned project - description: Create draft issue item for the specified organization owned project. - tags: - - projects - operationId: projects/create-draft-item-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project - parameters: - - *75 - - *279 - requestBody: - required: true - description: Details of the draft item to create in the project. - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The title of the draft issue item to create in the - project. - body: - type: string - description: The body content of the draft issue item to create - in the project. - required: - - title - examples: - title: - summary: Example with Sample Draft Issue Title - value: - title: Sample Draft Issue Title - body: - summary: Example with Sample Draft Issue Title and Body - value: - title: Sample Draft Issue Title - body: This is the body content of the draft issue. - responses: - '201': - description: Response - content: - application/json: - schema: &285 - title: Projects v2 Item - description: An item belonging to a project - type: object - properties: - id: - type: number - description: The unique identifier of the project item. - node_id: - type: string - description: The node ID of the project item. - content: - oneOf: - - *85 - - &482 - title: Pull Request Simple - description: Pull Request Simple - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: - type: integer - format: int64 - example: 1 - node_id: - type: string - example: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347 - diff_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: - type: integer - example: 1347 - state: - type: string - example: open - locked: - type: boolean - example: true - title: - type: string - example: new-feature - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - body: - type: string - example: Please pull these awesome changes - nullable: true - labels: - type: array - items: - type: object - properties: - id: - type: integer - format: int64 - node_id: - type: string - url: - type: string - name: - type: string - description: - type: string - color: - type: string - default: - type: boolean - required: - - id - - node_id - - url - - name - - description - - color - - default - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: *280 - required: *281 - nullable: true - active_lock_reason: - type: string - example: too heated - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - closed_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - merged_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - merge_commit_sha: - type: string - example: e5bd3914e2e596debea16f433f57875b5b90bcd6 - nullable: true - assignee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignees: - type: array - items: *4 - requested_reviewers: - type: array - items: *4 - requested_teams: - type: array - items: *197 - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: *79 - sha: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - label - - ref - - repo - - sha - - user - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: *79 - sha: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - label - - ref - - repo - - sha - - user - _links: - type: object - properties: - comments: &282 - title: Link - description: Hypermedia Link - type: object - properties: - href: - type: string - required: - - href - commits: *282 - statuses: *282 - html: *282 - issue: *282 - review_comments: *282 - review_comment: *282 - self: *282 - required: - - comments - - commits - - statuses - - html - - issue - - review_comments - - review_comment - - self - author_association: *82 - auto_merge: &594 - title: Auto merge - description: The status of auto merging a pull request. - type: object - properties: - enabled_by: *4 - merge_method: - type: string - description: The merge method to use. - enum: - - merge - - squash - - rebase - commit_title: - type: string - description: Title for the merge commit message. - commit_message: - type: string - description: Commit message for the merge commit. - required: - - enabled_by - - merge_method - - commit_title - - commit_message - nullable: true - draft: - description: Indicates whether or not the pull request is - a draft. - example: false - type: boolean - required: - - _links - - assignee - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merge_commit_sha - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - properties: - merge_commit_sha: - required: - - _links - - assignee - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge - version: '2026-03-10' - - changeset: remove_singular_assignee_from_issues_and_pull_requests - patch: - properties: - assignee: - required: - - _links - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge - version: '2026-03-10' - - title: Draft Issue - description: A draft issue in a project - type: object - properties: - id: - type: number - description: The ID of the draft issue - node_id: - type: string - description: The node ID of the draft issue - title: - type: string - description: The title of the draft issue - body: - type: string - description: The body content of the draft issue - nullable: true - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - description: The time the draft issue was created - updated_at: - type: string - format: date-time - description: The time the draft issue was last updated - required: - - id - - node_id - - title - - user - - created_at - - updated_at - description: The content represented by the item. - content_type: &284 - title: Projects v2 Item Content Type - description: The type of content tracked in a project item - type: string - enum: - - Issue - - PullRequest - - DraftIssue - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the item was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the item was last updated. - archived_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - description: The time when the item was archived. - project_url: - type: string - format: uri - description: The URL of the project this item belongs to. - item_url: - type: string - format: uri - description: The URL of the item in the project. - required: - - id - - content_type - - created_at - - updated_at - - archived_at - examples: - draft_issue: &286 - value: - id: 17 - node_id: PVTI_lADOANN5s84ACbL0zgBueEI - content: - id: 38 - node_id: I_kwDOANN5s85FtLts - title: Example Draft Issue - body: This is a draft issue in the project. - created_at: '2022-04-28T12:00:00Z' - updated_at: '2022-04-28T12:00:00Z' - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - content_type: DraftIssue - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2022-04-28T12:00:00Z' - updated_at: '2022-04-28T12:00:00Z' - archived_at: - project_url: https://api.github.com/users/octocat/projectsV2/1 - item_url: https://api.github.com/users/octocat/projectsV2/items/17 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: drafts - "/orgs/{org}/projectsV2/{project_number}/fields": - get: - summary: List project fields for organization - description: List all fields for a specific organization-owned project. - tags: - - projects - operationId: projects/list-fields-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization - parameters: - - *279 - - *75 - - *17 - - *47 - - *48 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &283 - title: Projects v2 Field - description: A field inside a projects v2 project - type: object - properties: - id: - type: integer - description: The unique identifier of the field. - issue_field_id: - type: integer - description: The ID of the issue field. - node_id: - type: string - description: The node ID of the field. - project_url: - type: string - description: The API URL of the project that contains the field. - example: https://api.github.com/projects/1 - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - assignees - - linked_pull_requests - - reviewers - - labels - - milestone - - repository - - title - - text - - single_select - - number - - date - - iteration - - issue_type - - parent_issue - - sub_issues_progress - options: - type: array - description: The options available for single select fields. - items: - title: Projects v2 Single Select Option - description: An option for a single select field - type: object - properties: - id: - type: string - description: The unique identifier of the option. - name: - type: object - description: The display name of the option, in raw text - and HTML formats. - properties: - raw: - type: string - html: - type: string - required: - - raw - - html - description: - type: object - description: The description of the option, in raw text - and HTML formats. - properties: - raw: - type: string - html: - type: string - required: - - raw - - html - color: - type: string - description: The color associated with the option. - required: - - id - - name - - description - - color - configuration: - type: object - description: Configuration for iteration fields. - properties: - start_day: - type: integer - description: The day of the week when the iteration starts. - duration: - type: integer - description: The duration of the iteration in days. - iterations: - type: array - items: - title: Projects v2 Iteration Setting - description: An iteration setting for an iteration field - type: object - properties: - id: - type: string - description: The unique identifier of the iteration - setting. - start_date: - type: string - format: date - description: The start date of the iteration. - duration: - type: integer - description: The duration of the iteration in days. - title: - type: object - properties: - raw: - type: string - html: - type: string - required: - - raw - - html - description: The iteration title, in raw text and - HTML formats. - completed: - type: boolean - description: Whether the iteration has been completed. - required: - - id - - start_date - - duration - - title - - completed - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the field was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the field was last updated. - required: - - id - - name - - data_type - - created_at - - updated_at - - project_url - examples: - default: &722 - value: - - id: 12345 - node_id: PVTF_lADOABCD1234567890 - name: Priority - data_type: single_select - project_url: https://api.github.com/projects/67890 - options: - - id: option_1 - name: - html: Low - raw: Low - color: GREEN - description: - html: Low priority items - raw: Low priority items - - id: option_2 - name: - html: Medium - raw: Medium - color: YELLOW - description: - html: Medium priority items - raw: Medium priority items - - id: option_3 - name: - html: High - raw: High - color: RED - description: - html: High priority items - raw: High priority items - created_at: '2022-04-28T12:00:00Z' - updated_at: '2022-04-28T12:00:00Z' - - id: 67891 - node_id: PVTF_lADOABCD9876543210 - name: Status - data_type: single_select - project_url: https://api.github.com/projects/67890 - options: - - id: option_4 - name: - html: Todo - raw: Todo - color: GRAY - description: - html: Items to be worked on - raw: Items to be worked on - - id: option_5 - name: - html: In Progress - raw: In Progress - color: BLUE - description: - html: Items currently being worked on - raw: Items currently being worked on - - id: option_6 - name: - html: Done - raw: Done - color: GREEN - description: - html: Completed items - raw: Completed items - created_at: '2022-04-29T10:30:00Z' - updated_at: '2022-04-29T10:30:00Z' - - id: 24680 - node_id: PVTF_lADOABCD2468024680 - name: Team notes - data_type: text - project_url: https://api.github.com/projects/67890 - created_at: '2022-05-15T08:00:00Z' - updated_at: '2022-05-15T08:00:00Z' - - id: 13579 - node_id: PVTF_lADOABCD1357913579 - name: Story points - data_type: number - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-01T14:30:00Z' - updated_at: '2022-06-01T14:30:00Z' - - id: 98765 - node_id: PVTF_lADOABCD9876598765 - name: Due date - data_type: date - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-10T09:15:00Z' - updated_at: '2022-06-10T09:15:00Z' - - id: 11223 - node_id: PVTF_lADOABCD1122311223 - name: Sprint - data_type: iteration - project_url: https://api.github.com/projects/67890 - configuration: - duration: 14 - start_day: 1 - iterations: - - id: iter_1 - title: - html: Sprint 1 - raw: Sprint 1 - start_date: '2022-07-01' - duration: 14 - - id: iter_2 - title: - html: Sprint 2 - raw: Sprint 2 - start_date: '2022-07-15' - duration: 14 - created_at: '2022-06-20T16:45:00Z' - updated_at: '2022-06-20T16:45:00Z' - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: fields - post: - summary: Add a field to an organization-owned project. - description: Add a field to an organization-owned project. - tags: - - projects - operationId: projects/add-field-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project - parameters: - - *279 - - *75 - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - issue_field_id: - type: integer - description: The ID of the IssueField to create the field for. - required: - - issue_field_id - additionalProperties: false - - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - text - - number - - date - required: - - name - - data_type - additionalProperties: false - - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - single_select - single_select_options: - type: array - description: The options available for single select fields. At - least one option must be provided when creating a single select - field. - items: &723 - type: object - properties: - name: - type: string - description: The display name of the option. - color: - type: string - description: The color associated with the option. - enum: - - BLUE - - GRAY - - GREEN - - ORANGE - - PINK - - PURPLE - - RED - - YELLOW - description: - type: string - description: The description of the option. - additionalProperties: false - required: - - name - - data_type - - single_select_options - additionalProperties: false - - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - iteration - iteration_configuration: &724 - type: object - description: The configuration for iteration fields. - properties: - start_date: - type: string - format: date - description: The start date of the first iteration. - duration: - type: integer - description: The default duration for iterations in days. - Individual iterations can override this value. - iterations: - type: array - description: Zero or more iterations for the field. - items: - type: object - additionalProperties: false - properties: - title: - type: string - description: The title of the iteration. - start_date: - type: string - format: date - description: The start date of the iteration. - duration: - type: integer - description: The duration of the iteration in days. - required: - - name - - data_type - - iteration_configuration - additionalProperties: false - examples: - text_field: - summary: Create a text field - value: - name: Team notes - data_type: text - number_field: - summary: Create a number field - value: - name: Story points - data_type: number - date_field: - summary: Create a date field - value: - name: Due date - data_type: date - single_select_field: &725 - summary: Create a single select field - value: - name: Priority - data_type: single_select - single_select_options: - - name: - raw: Low - html: Low - color: GREEN - description: - raw: Low priority items - html: Low priority items - - name: - raw: Medium - html: Medium - color: YELLOW - description: - raw: Medium priority items - html: Medium priority items - - name: - raw: High - html: High - color: RED - description: - raw: High priority items - html: High priority items - iteration_field: &726 - summary: Create an iteration field - value: - name: Sprint - data_type: iteration - iteration_configuration: - start_day: 1 - duration: 14 - iterations: - - title: - raw: Sprint 1 - html: Sprint 1 - start_date: '2022-07-01' - duration: 14 - - title: - raw: Sprint 2 - html: Sprint 2 - start_date: '2022-07-15' - duration: 14 - responses: - '201': - description: Response for adding a field to an organization-owned project. - content: - application/json: - schema: *283 - examples: - text_field: &727 - value: - id: 24680 - node_id: PVTF_lADOABCD2468024680 - name: Team notes - data_type: text - project_url: https://api.github.com/projects/67890 - created_at: '2022-05-15T08:00:00Z' - updated_at: '2022-05-15T08:00:00Z' - number_field: &728 - value: - id: 13579 - node_id: PVTF_lADOABCD1357913579 - name: Story points - data_type: number - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-01T14:30:00Z' - updated_at: '2022-06-01T14:30:00Z' - date_field: &729 - value: - id: 98765 - node_id: PVTF_lADOABCD9876598765 - name: Due date - data_type: date - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-10T09:15:00Z' - updated_at: '2022-06-10T09:15:00Z' - single_select_field: &730 - value: - id: 12345 - node_id: PVTF_lADOABCD1234567890 - name: Priority - data_type: single_select - project_url: https://api.github.com/projects/67890 - options: - - id: option_1 - name: - html: Low - raw: Low - color: GREEN - description: - html: Low priority items - raw: Low priority items - - id: option_2 - name: - html: Medium - raw: Medium - color: YELLOW - description: - html: Medium priority items - raw: Medium priority items - - id: option_3 - name: - html: High - raw: High - color: RED - description: - html: High priority items - raw: High priority items - created_at: '2022-04-28T12:00:00Z' - updated_at: '2022-04-28T12:00:00Z' - iteration_field: &731 - value: - id: 11223 - node_id: PVTF_lADOABCD1122311223 - name: Sprint - data_type: iteration - project_url: https://api.github.com/projects/67890 - configuration: - duration: 14 - start_day: 1 - iterations: - - id: iter_1 - title: - html: Sprint 1 - raw: Sprint 1 - start_date: '2022-07-01' - duration: 14 - - id: iter_2 - title: - html: Sprint 2 - raw: Sprint 2 - start_date: '2022-07-15' - duration: 14 - created_at: '2022-06-20T16:45:00Z' - updated_at: '2022-06-20T16:45:00Z' - '304': *37 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: fields - "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": - get: - summary: Get project field for organization - description: Get a specific field for an organization-owned project. - tags: - - projects - operationId: projects/get-field-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization - parameters: - - *279 - - &732 - name: field_id - description: The unique identifier of the field. - in: path - required: true - schema: - type: integer - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *283 - examples: - default: &733 - value: - id: 12345 - node_id: PVTF_lADOABCD1234567890 - name: Priority - data_type: single_select - project_url: https://api.github.com/projects/67890 - options: - - id: option_1 - name: - html: Low - raw: Low - color: GREEN - description: - html: Low priority items - raw: Low priority items - - id: option_2 - name: - html: Medium - raw: Medium - color: YELLOW - description: - html: Medium priority items - raw: Medium priority items - - id: option_3 - name: - html: High - raw: High - color: RED - description: - html: High priority items - raw: High priority items - created_at: '2022-04-28T12:00:00Z' - updated_at: '2022-04-28T12:00:00Z' - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: fields - "/orgs/{org}/projectsV2/{project_number}/items": - get: - summary: List items for an organization owned project - description: List all items for a specific organization-owned project accessible - by the authenticated user. - tags: - - projects - operationId: projects/list-items-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project - parameters: - - *279 - - *75 - - name: q - description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) - for more information. - in: query - required: false - schema: - type: string - - name: fields - description: |- - Limit results to specific fields, by their IDs. If not specified, the title field will be returned. - - Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` - in: query - required: false - schema: - oneOf: - - type: string - - type: array - maxItems: 50 - items: - type: string - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &287 - title: Projects v2 Item - description: An item belonging to a project - type: object - properties: - id: - type: number - description: The unique identifier of the project item. - node_id: - type: string - description: The node ID of the project item. - project_url: - type: string - format: uri - example: https://api.github.com/users/monalisa/2/projectsV2/3 - description: The API URL of the project that contains this item. - content_type: *284 - content: - type: object - additionalProperties: true - nullable: true - description: The content of the item, which varies by content - type. - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the item was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the item was last updated. - archived_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - description: The time when the item was archived. - item_url: - type: string - format: uri - example: https://api.github.com/users/monalisa/2/projectsV2/items/3 - nullable: true - description: The API URL of this item. - fields: - type: array - items: - type: object - additionalProperties: true - description: The fields and values associated with this item. - required: - - id - - content_type - - created_at - - updated_at - - archived_at - examples: - default: &288 - value: - id: 13 - node_id: PVTI_lAAFAQ0 - project_url: https://api.github.com/orgs/github/projectsV2/1 - content: - url: https://api.github.com/repos/github/Hello-World/pulls/6 - id: 10 - node_id: PR_kwABCg - html_url: https://github.com/github/Hello-World/pull/6 - diff_url: https://github.com/github/Hello-World/pull/6.diff - patch_url: https://github.com/github/Hello-World/pull/6.patch - issue_url: https://api.github.com/repos/github/Hello-World/issues/6 - number: 6 - state: open - locked: false - title: Issue title - user: - login: monalisa - id: 161 - node_id: U_kgDMoQ - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - user_view_type: public - site_admin: false - pinned_comment: - body: Issue body - created_at: '2025-08-01T18:44:50Z' - updated_at: '2025-08-06T19:25:18Z' - closed_at: - merged_at: - merge_commit_sha: 98e25bad5878e54d22e5338cbc905dd2deedfa34 - assignee: - login: octocat - id: 175 - node_id: U_kgDMrw - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - user_view_type: public - site_admin: false - assignees: - - login: octocat - id: 175 - node_id: U_kgDMrw - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - user_view_type: public - site_admin: false - requested_reviewers: - - login: monalisa - id: 2 - node_id: U_kgAC - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - user_view_type: public - site_admin: false - requested_teams: [] - labels: - - id: 19 - node_id: LA_kwABEw - url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' - name: 'bug :bug:' - color: efe24f - default: false - description: Something isn't working - - id: 26 - node_id: LA_kwABGg - url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB - name: "fun size \U0001F36B" - color: f29c24 - default: false - description: Extra attention is needed - - id: 33 - node_id: LA_kwABIQ - url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix - name: "\U0001F692 wontfix" - color: 5891ce - default: false - description: This will not be worked on - milestone: - url: https://api.github.com/repos/github/Hello-World/milestones/1 - html_url: https://github.com/github/Hello-World/milestone/1 - labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels - id: 1 - node_id: MI_kwABAQ - number: 1 - title: Open milestone - description: - creator: - login: monalisa - id: 2 - node_id: U_kgAC - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - user_view_type: public - site_admin: false - open_issues: 2 - closed_issues: 1 - state: open - created_at: '2025-08-01T18:44:30Z' - updated_at: '2025-08-06T19:14:15Z' - due_on: - closed_at: - draft: false - commits_url: https://api.github.com/repos/github/Hello-World/pulls/6/commits - review_comments_url: https://api.github.com/repos/github/Hello-World/pulls/6/comments - review_comment_url: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/github/Hello-World/issues/6/comments - statuses_url: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d - head: - label: github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f - ref: branch-2ee3da8fde8a1adfe6d0809a1a414e4f - sha: a3258d3434ecb2058b2784c8eb8610c2e9937a0d - user: - login: github - id: 5 - node_id: O_kgAF - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - user_view_type: public - site_admin: false - repo: - id: 1 - node_id: R_kgAB - name: Hello-World - full_name: github/Hello-World - private: false - owner: - login: github - id: 5 - node_id: O_kgAF - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - user_view_type: public - site_admin: false - html_url: https://github.com/github/Hello-World - description: - fork: false - url: https://api.github.com/repos/github/Hello-World - forks_url: https://api.github.com/repos/github/Hello-World/forks - keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/github/Hello-World/teams - hooks_url: https://api.github.com/repos/github/Hello-World/hooks - issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/github/Hello-World/events - assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/github/Hello-World/tags - blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/github/Hello-World/languages - stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers - contributors_url: https://api.github.com/repos/github/Hello-World/contributors - subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers - subscription_url: https://api.github.com/repos/github/Hello-World/subscription - commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/github/Hello-World/merges - archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/github/Hello-World/downloads - issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/github/Hello-World/deployments - created_at: '2025-08-01T18:44:14Z' - updated_at: '2025-08-01T18:48:38Z' - pushed_at: '2025-08-01T18:44:50Z' - git_url: git://github.localhost/github/Hello-World.git - ssh_url: ssh://git@localhost:3035/github/Hello-World.git - clone_url: https://github.com/github/Hello-World.git - svn_url: https://github.com/github/Hello-World - homepage: - size: 6 - stargazers_count: 0 - watchers_count: 0 - language: - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: false - has_discussions: false - forks_count: 0 - mirror_url: - archived: false - disabled: false - open_issues_count: 3 - license: - allow_forking: true - is_template: false - web_commit_signoff_required: false - topics: [] - visibility: public - forks: 0 - open_issues: 3 - watchers: 0 - default_branch: main - base: - label: github:branch-0f4ceb14cbe39e4786ffbabb776da599 - ref: branch-0f4ceb14cbe39e4786ffbabb776da599 - sha: 9a9f5a8d77bdc2540412900d3c930fe36a82b5ed - user: - login: github - id: 5 - node_id: O_kgAF - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - user_view_type: public - site_admin: false - repo: - id: 1 - node_id: R_kgAB - name: Hello-World - full_name: github/Hello-World - private: false - owner: - login: github - id: 5 - node_id: O_kgAF - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - user_view_type: public - site_admin: false - html_url: https://github.com/github/Hello-World - description: - fork: false - url: https://api.github.com/repos/github/Hello-World - forks_url: https://api.github.com/repos/github/Hello-World/forks - keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/github/Hello-World/teams - hooks_url: https://api.github.com/repos/github/Hello-World/hooks - issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/github/Hello-World/events - assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/github/Hello-World/tags - blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/github/Hello-World/languages - stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers - contributors_url: https://api.github.com/repos/github/Hello-World/contributors - subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers - subscription_url: https://api.github.com/repos/github/Hello-World/subscription - commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/github/Hello-World/merges - archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/github/Hello-World/downloads - issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/github/Hello-World/deployments - created_at: '2025-08-01T18:44:14Z' - updated_at: '2025-08-01T18:48:38Z' - pushed_at: '2025-08-01T18:44:50Z' - git_url: git://github.localhost/github/Hello-World.git - ssh_url: ssh://git@localhost:3035/github/Hello-World.git - clone_url: https://github.com/github/Hello-World.git - svn_url: https://github.com/github/Hello-World - homepage: - size: 6 - stargazers_count: 0 - watchers_count: 0 - language: - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: false - has_discussions: false - forks_count: 0 - mirror_url: - archived: false - disabled: false - open_issues_count: 3 - license: - allow_forking: true - is_template: false - web_commit_signoff_required: false - topics: [] - visibility: public - forks: 0 - open_issues: 3 - watchers: 0 - default_branch: main - _links: - self: - href: https://api.github.com/repos/github/Hello-World/pulls/6 - html: - href: https://github.com/github/Hello-World/pull/6 - issue: - href: https://api.github.com/repos/github/Hello-World/issues/6 - comments: - href: https://api.github.com/repos/github/Hello-World/issues/6/comments - review_comments: - href: https://api.github.com/repos/github/Hello-World/pulls/6/comments - review_comment: - href: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/github/Hello-World/pulls/6/commits - statuses: - href: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d - author_association: MEMBER - auto_merge: - active_lock_reason: - content_type: PullRequest - creator: - login: monalisa - id: 2 - node_id: U_kgAC - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - user_view_type: public - site_admin: false - created_at: '2025-08-01T18:44:51Z' - updated_at: '2025-08-06T19:25:18Z' - archived_at: - item_url: https://api.github.com/orgs/github/projectsV2/1/items/13 - fields: - - id: 1 - name: Title - data_type: title - value: - raw: It seemed to me that any civilization that had so far - lost its head as to need to include a set of detailed instructions - for use in a packet of toothpicks, was no longer a civilization - in which I could live and stay sane. - html: It seemed to me that any civilization that had so far - lost its head as to need to include a set of detailed instructions - for use in a packet of toothpicks, was no longer a civilization - in which I could live and stay sane. - number: 6 - url: https://github.com/5/1/pull/6 - issue_id: 12 - state: open - state_reason: - is_draft: false - - id: 2 - name: Assignees - data_type: assignees - value: - - login: octocat - id: 175 - node_id: U_kgDMrw - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - user_view_type: public - site_admin: false - - id: 3 - name: Status - data_type: single_select - value: - id: '98236657' - name: - raw: Done - html: Done - color: PURPLE - description: - raw: This has been completed - html: This has been completed - - id: 4 - name: Labels - data_type: labels - value: - - id: 19 - node_id: LA_kwABEw - url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' - name: 'bug :bug:' - color: efe24f - default: false - description: Something isn't working - - id: 26 - node_id: LA_kwABGg - url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB - name: "fun size \U0001F36B" - color: f29c24 - default: false - description: Extra attention is needed - - id: 33 - node_id: LA_kwABIQ - url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix - name: "\U0001F692 wontfix" - color: 5891ce - default: false - description: This will not be worked on - - id: 5 - name: Linked pull requests - data_type: linked_pull_requests - value: [] - - id: 6 - name: Milestone - data_type: milestone - value: - url: https://api.github.com/repos/github/Hello-World/milestones/1 - html_url: https://github.com/github/Hello-World/milestone/1 - labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels - id: 1 - node_id: MI_kwABAQ - number: 1 - title: Open milestone - description: - creator: - login: octocat - id: 175 - node_id: U_kgDMrw - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - user_view_type: public - site_admin: false - open_issues: 2 - closed_issues: 1 - state: open - created_at: '2025-08-01T18:44:30Z' - updated_at: '2025-08-06T19:14:15Z' - due_on: - closed_at: - - id: 7 - name: Repository - data_type: repository - value: - id: 1 - node_id: R_kgAB - name: Hello-World - full_name: github/Hello-World - private: false - owner: - login: github - id: 5 - node_id: O_kgAF - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - user_view_type: public - site_admin: false - html_url: https://github.com/github/Hello-World - description: - fork: false - url: https://api.github.com/repos/github/Hello-World - forks_url: https://api.github.com/repos/github/Hello-World/forks - keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/github/Hello-World/teams - hooks_url: https://api.github.com/repos/github/Hello-World/hooks - issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/github/Hello-World/events - assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/github/Hello-World/tags - blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/github/Hello-World/languages - stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers - contributors_url: https://api.github.com/repos/github/Hello-World/contributors - subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers - subscription_url: https://api.github.com/repos/github/Hello-World/subscription - commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/github/Hello-World/merges - archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/github/Hello-World/downloads - issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/github/Hello-World/deployments - - id: 8 - name: Type - data_type: issue_type - value: - - id: 9 - name: Reviewers - data_type: reviewers - value: - - type: ReviewRequest - status: pending - reviewer: - avatarUrl: https://github.com/images/error/octocat_happy.gif - id: 2 - login: monalisa - url: https://github.com/monalisa - name: monalisa - type: User - - id: 10 - name: Parent issue - data_type: parent_issue - value: - - id: 11 - name: Sub-issues progress - data_type: sub_issues_progress - value: - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - post: - summary: Add item to organization owned project - description: Add an issue or pull request item to the specified organization - owned project. - tags: - - projects - operationId: projects/add-item-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project - parameters: - - *75 - - *279 - requestBody: - required: true - description: Details of the item to add to the project. You can specify either - the unique ID or the repository owner, name, and issue/PR number. - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique identifier of the issue or pull request - to add to the project. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type - oneOf: - - required: - - id - - required: - - owner - - repo - - number - examples: - issue_with_id: - summary: Add an issue using its unique ID - value: - type: Issue - id: 3 - pull_request_with_id: - summary: Add a pull request using its unique ID - value: - type: PullRequest - id: 3 - issue_with_nwo: - summary: Add an issue using repository owner, name, and issue number - value: - type: Issue - owner: octocat - repo: hello-world - number: 42 - pull_request_with_nwo: - summary: Add a pull request using repository owner, name, and PR number - value: - type: PullRequest - owner: octocat - repo: hello-world - number: 123 - responses: - '201': - description: Response - content: - application/json: - schema: *285 - examples: - issue_with_id: - summary: Response for adding an issue using its unique ID - value: *286 - pull_request_with_id: - summary: Response for adding a pull request using its unique ID - value: *286 - issue_with_nwo: - summary: Response for adding an issue using repository owner, name, - and issue number - value: *286 - pull_request_with_nwo: - summary: Response for adding a pull request using repository owner, - name, and PR number - value: *286 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": - get: - summary: Get an item for an organization owned project - description: Get a specific item from an organization-owned project. - tags: - - projects - operationId: projects/get-org-item - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project - parameters: - - *279 - - *75 - - &289 - name: item_id - description: The unique identifier of the project item. - in: path - required: true - schema: - type: integer - - name: fields - description: |- - Limit results to specific fields, by their IDs. If not specified, the title field will be returned. - - Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 - in: query - required: false - schema: - oneOf: - - type: string - - type: array - maxItems: 50 - items: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *287 - examples: - default: *288 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - patch: - summary: Update project item for organization - description: Update a specific item in an organization-owned project. - tags: - - projects - operationId: projects/update-item-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#update-project-item-for-organization - parameters: - - *279 - - *75 - - *289 - requestBody: - required: true - description: Field updates to apply to the project item. Only text, number, - date, single select, and iteration fields are supported. - content: - application/json: - schema: - type: object - properties: - fields: - type: array - description: A list of field updates to apply. - items: - type: object - properties: - id: - type: integer - description: The ID of the project field to update. - value: - description: |- - The new value for the field: - - For text, number, and date fields, provide the new value directly. - - For single select and iteration fields, provide the ID of the option or iteration. - - To clear the field, set this to null. - nullable: true - oneOf: - - type: string - - type: number - required: - - id - - value - required: - - fields - examples: - text_field: - summary: Update a text field - value: - fields: - - id: 123 - value: Updated text value - number_field: - summary: Update a number field - value: - fields: - - id: 456 - value: 42.5 - date_field: - summary: Update a date field - value: - fields: - - id: 789 - value: '2023-10-05' - single_select_field: - summary: Update a single select field - value: - fields: - - id: 789 - value: 47fc9ee4 - iteration_field: - summary: Update an iteration field - value: - fields: - - id: 1011 - value: 866ee5b8 - responses: - '200': - description: Response - content: - application/json: - schema: *287 - examples: - text_field: *288 - number_field: *288 - date_field: *288 - single_select_field: *288 - iteration_field: *288 - '401': *25 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - delete: - summary: Delete project item for organization - description: Delete a specific item from an organization-owned project. - tags: - - projects - operationId: projects/delete-item-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization - parameters: - - *279 - - *75 - - *289 - responses: - '204': - description: Response - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - "/orgs/{org}/projectsV2/{project_number}/views": - post: - summary: Create a view for an organization-owned project - description: Create a new view in an organization-owned project. Views allow - you to customize how items in a project are displayed and filtered. - tags: - - projects - operationId: projects/create-view-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project - parameters: - - *75 - - *279 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the view. - example: Sprint Board - layout: - type: string - description: The layout of the view. - enum: - - table - - board - - roadmap - example: board - filter: - type: string - description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) - for more information. - example: is:issue is:open - visible_fields: - type: array - description: |- - `visible_fields` is not applicable to `roadmap` layout views. - For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. - items: - type: integer - example: - - 123 - - 456 - - 789 - required: - - name - - layout - additionalProperties: false - examples: - table_view: - summary: Create a table view - value: - name: All Issues - layout: table - filter: is:issue - visible_fields: - - 123 - - 456 - - 789 - board_view: - summary: Create a board view with filter - value: - name: Sprint Board - layout: board - filter: is:issue is:open label:sprint - visible_fields: - - 123 - - 456 - - 789 - roadmap_view: - summary: Create a roadmap view - value: - name: Product Roadmap - layout: roadmap - responses: - '201': - description: Response for creating a view in an organization-owned project. - content: - application/json: - schema: &714 - title: Projects v2 View - description: A view inside a projects v2 project - type: object - properties: - id: - type: integer - description: The unique identifier of the view. - number: - type: integer - description: The number of the view within the project. - name: - type: string - description: The name of the view. - layout: - type: string - description: The layout of the view. - enum: - - table - - board - - roadmap - node_id: - type: string - description: The node ID of the view. - project_url: - type: string - description: The API URL of the project that contains the view. - example: https://api.github.com/orgs/octocat/projectsV2/1 - html_url: - type: string - format: uri - description: The web URL of the view. - example: https://github.com/orgs/octocat/projects/1/views/1 - creator: - allOf: - - *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the view was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the view was last updated. - filter: - type: string - nullable: true - description: The filter query for the view. - example: is:issue is:open - visible_fields: - type: array - description: The list of field IDs that are visible in the view. - items: - type: integer - sort_by: - type: array - description: The sorting configuration for the view. Each element - is a tuple of [field_id, direction] where direction is "asc" - or "desc". - items: - type: array - minItems: 2 - maxItems: 2 - items: - oneOf: - - type: integer - - type: string - group_by: - type: array - description: The list of field IDs used for horizontal grouping. - items: - type: integer - vertical_group_by: - type: array - description: The list of field IDs used for vertical grouping - (board layout). - items: - type: integer - required: - - id - - number - - name - - layout - - node_id - - project_url - - html_url - - creator - - created_at - - updated_at - - visible_fields - - sort_by - - group_by - - vertical_group_by - examples: - table_view: - summary: Response for creating a table view - value: &290 - value: - id: 1 - number: 1 - name: Sprint Board - layout: board - node_id: PVTV_lADOANN5s84ACbL0zgBueEI - project_url: https://api.github.com/orgs/octocat/projectsV2/1 - html_url: https://github.com/orgs/octocat/projects/1/views/1 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2022-04-28T12:00:00Z' - updated_at: '2022-04-28T12:00:00Z' - filter: is:issue is:open - visible_fields: - - 123 - - 456 - - 789 - sort_by: - - - 123 - - asc - - - 456 - - desc - group_by: - - 123 - vertical_group_by: - - 456 - board_view: - summary: Response for creating a board view with filter - value: *290 - roadmap_view: - summary: Response for creating a roadmap view - value: *290 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - '422': *15 - '503': - description: Service unavailable - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: views - "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": - get: - summary: List items for an organization project view - description: List items in an organization project with the saved view's filter - applied. - tags: - - projects - operationId: projects/list-view-items-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view - parameters: - - *279 - - *75 - - &734 - name: view_number - description: The number that identifies the project view. - in: path - required: true - schema: - type: integer - - name: fields - description: |- - Limit results to specific fields, by their IDs. If not specified, the - title field will be returned. - - Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` - in: query - required: false - schema: - oneOf: - - type: string - - type: array - maxItems: 50 - items: - type: string - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *287 - examples: - default: *288 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - "/orgs/{org}/properties/schema": - get: - summary: Get all custom properties for an organization - description: |- - Gets all custom properties defined for an organization. - Organization members can read these properties. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-get-organization-definitions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &291 - title: Organization Custom Property - description: Custom property defined on an organization - type: object - properties: - property_name: - type: string - description: The name of the property - url: - type: string - format: uri - description: The URL that can be used to fetch, update, or delete - info about this property via the API. - source_type: - type: string - description: The source type of the property - enum: - - organization - - enterprise - example: organization - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - - url - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - values_editable_by: - type: string - nullable: true - enum: - - org_actors - - org_and_repo_actors - example: org_actors - description: Who can edit the values of the property - require_explicit_values: - type: boolean - description: Whether setting properties values is mandatory - required: - - property_name - - value_type - examples: - default: &292 - value: - - property_name: environment - url: https://api.github.com/orgs/github/properties/schema/environment - source_type: organization - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development - values_editable_by: org_actors - require_explicit_values: true - - property_name: service - url: https://api.github.com/orgs/github/properties/schema/service - source_type: organization - value_type: string - - property_name: team - url: https://api.github.com/orgs/github/properties/schema/team - source_type: organization - value_type: string - description: Team owning the repository - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - patch: - summary: Create or update custom properties for an organization - description: |- - Creates new or updates existing custom properties defined for an organization in a batch. - - If the property already exists, the existing property will be replaced with the new values. - Missing optional values will fall back to default values, previous values will be overwritten. - E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. - - To use this endpoint, the authenticated user must be one of: - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - properties: - type: array - description: The array of custom properties to create or update. - items: *291 - minItems: 1 - maxItems: 100 - required: - - properties - examples: - default: - value: - properties: - - property_name: environment - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development - values_editable_by: org_actors - - property_name: service - value_type: string - - property_name: team - value_type: string - description: Team owning the repository - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *291 - examples: - default: *292 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - "/orgs/{org}/properties/schema/{custom_property_name}": - get: - summary: Get a custom property for an organization - description: |- - Gets a custom property that is defined for an organization. - Organization members can read these properties. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-get-organization-definition - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization - parameters: - - *75 - - &293 - name: custom_property_name - description: The custom property name - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *291 - examples: - default: &294 - value: - property_name: environment - url: https://api.github.com/orgs/github/properties/schema/environment - source_type: organization - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - put: - summary: Create or update a custom property for an organization - description: |- - Creates a new or updates an existing custom property that is defined for an organization. - - To use this endpoint, the authenticated user must be one of: - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization - parameters: - - *75 - - *293 - requestBody: - required: true - content: - application/json: - schema: - title: Custom Property Set Payload - description: Custom property set payload - type: object - properties: - value_type: - type: string - example: single_select - enum: - - string - - single_select - - multi_select - - true_false - - url - description: The type of the value for the property - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - nullable: true - description: Default value of the property - description: - type: string - nullable: true - description: Short description of the property - allowed_values: - type: array - items: - type: string - nullable: true - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - values_editable_by: - type: string - nullable: true - enum: - - org_actors - - org_and_repo_actors - example: org_actors - description: Who can edit the values of the property - require_explicit_values: - type: boolean - description: Whether setting properties values is mandatory - required: - - value_type - examples: - default: - value: - value_type: single_select - required: true - default_value: production - description: Prod or dev environment - allowed_values: - - production - - development - responses: - '200': - description: Response - content: - application/json: - schema: *291 - examples: - default: *294 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - delete: - summary: Remove a custom property for an organization - description: |- - Removes a custom property that is defined for an organization. - - To use this endpoint, the authenticated user must be one of: - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-delete-organization-definition - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization - parameters: - - *75 - - *293 - responses: - '204': *191 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - "/orgs/{org}/properties/values": - get: - summary: List custom property values for organization repositories - description: |- - Lists organization repositories with all of their custom property values. - Organization members can read these properties. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-get-organization-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories - parameters: - - *75 - - *17 - - *19 - - name: repository_query - description: Finds repositories in the organization with a query containing - one or more search keywords and qualifiers. Qualifiers allow you to limit - your search to specific areas of GitHub. The REST API supports the same - qualifiers as the web interface for GitHub. To learn more about the format - of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" - for a detailed list of qualifiers. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Organization Repository Custom Property Values - description: List of custom property values for a repository - type: object - properties: - repository_id: - type: integer - example: 1296269 - repository_name: - type: string - example: Hello-World - repository_full_name: - type: string - example: octocat/Hello-World - properties: - type: array - items: &295 - title: Custom Property Value - description: Custom property name and associated value - type: object - properties: - property_name: - type: string - description: The name of the property - value: - oneOf: - - type: string - - type: array - items: - type: string - description: The value assigned to the property - nullable: true - required: - - property_name - - value - description: List of custom property names and associated values - required: - - repository_id - - repository_name - - repository_full_name - - properties - examples: - default: - value: - - repository_id: 1296269 - repository_name: Hello-World - repository_full_name: octocat/Hello-World - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - headers: - Link: *67 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - patch: - summary: Create or update custom property values for organization repositories - description: |- - Create new or update existing custom property values for repositories in a batch that belong to an organization. - Each target repository will have its custom property values updated to match the values provided in the request. - - A maximum of 30 repositories can be updated in a single request. - - Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - - To use this endpoint, the authenticated user must be one of: - - An administrator for the organization. - - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. - tags: - - orgs - operationId: orgs/custom-properties-for-repos-create-or-update-organization-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - repository_names: - type: array - description: The names of repositories that the custom property - values will be applied to. - items: - type: string - minItems: 1 - maxItems: 30 - properties: - type: array - description: List of custom property names and associated values - to apply to the repositories. - items: *295 - required: - - repository_names - - properties - examples: - default: - value: - repository_names: - - Hello-World - - octo-repo - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - responses: - '204': - description: No Content when custom property values are successfully created - or updated - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: custom-properties - "/orgs/{org}/public_members": - get: - summary: List public organization members - description: Members of an organization can choose to have their membership - publicized or not. - tags: - - orgs - operationId: orgs/list-public-members - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#list-public-organization-members - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/orgs/{org}/public_members/{username}": - get: - summary: Check public organization membership for a user - description: Check if the provided user is a public member of the organization. - tags: - - orgs - operationId: orgs/check-public-membership-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user - parameters: - - *75 - - *71 - responses: - '204': - description: Response if user is a public member - '404': - description: Not Found if user is not a public member - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - put: - summary: Set public organization membership for the authenticated user - description: |- - The user can publicize their own membership. (A user cannot publicize the membership for another user.) - - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - tags: - - orgs - operationId: orgs/set-public-membership-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user - parameters: - - *75 - - *71 - responses: - '204': - description: Response - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: orgs - subcategory: members - delete: - summary: Remove public organization membership for the authenticated user - description: Removes the public membership for the authenticated user from the - specified organization, unless public visibility is enforced by default. - tags: - - orgs - operationId: orgs/remove-public-membership-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user - parameters: - - *75 - - *71 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: orgs - subcategory: members - "/orgs/{org}/repos": - get: - summary: List organization repositories - description: |- - Lists repositories for the specified organization. - - > [!NOTE] - > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - tags: - - repos - operationId: repos/list-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-organization-repositories - parameters: - - *75 - - name: type - description: Specifies the types of repositories you want returned. - in: query - required: false - schema: - type: string - enum: - - all - - public - - private - - forks - - sources - - member - default: all - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - pushed - - full_name - default: created - - name: direction - description: 'The order to sort by. Default: `asc` when using `full_name`, - otherwise `desc`.' - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - post: - summary: Create an organization repository - description: |- - Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - - OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - tags: - - repos - operationId: repos/create-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#create-an-organization-repository - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the repository. - description: - type: string - description: A short description of the repository. - homepage: - type: string - description: A URL with more information about the repository. - private: - type: boolean - description: Whether the repository is private. - default: false - visibility: - type: string - description: The visibility of the repository. - enum: - - public - - private - has_issues: - type: boolean - description: Either `true` to enable issues for this repository - or `false` to disable them. - default: true - has_projects: - type: boolean - description: Either `true` to enable projects for this repository - or `false` to disable them. **Note:** If you're creating a repository - in an organization that has disabled repository projects, the - default is `false`, and if you pass `true`, the API returns an - error. - default: true - has_wiki: - type: boolean - description: Either `true` to enable the wiki for this repository - or `false` to disable it. - default: true - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - is_template: - type: boolean - description: Either `true` to make this repo available as a template - repository or `false` to prevent it. - default: false - team_id: - type: integer - description: The id of the team that will be granted access to this - repository. This is only valid when creating a repository in an - organization. - auto_init: - type: boolean - description: Pass `true` to create an initial commit with empty - README. - default: false - gitignore_template: - type: string - description: Desired language or platform [.gitignore template](https://github.com/github/gitignore) - to apply. Use the name of the template without the extension. - For example, "Haskell". - license_template: - type: string - description: Choose an [open source license template](https://choosealicense.com/) - that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) - as the `license_template` string. For example, "mit" or "mpl-2.0". - allow_squash_merge: - type: boolean - description: Either `true` to allow squash-merging pull requests, - or `false` to prevent squash-merging. - default: true - allow_merge_commit: - type: boolean - description: Either `true` to allow merging pull requests with a - merge commit, or `false` to prevent merging pull requests with - merge commits. - default: true - allow_rebase_merge: - type: boolean - description: Either `true` to allow rebase-merging pull requests, - or `false` to prevent rebase-merging. - default: true - allow_auto_merge: - type: boolean - description: Either `true` to allow auto-merge on pull requests, - or `false` to disallow auto-merge. - default: false - delete_branch_on_merge: - type: boolean - description: Either `true` to allow automatically deleting head - branches when pull requests are merged, or `false` to prevent - automatic deletion. **The authenticated user must be an organization - owner to set this property to `true`.** - default: false - use_squash_pr_title_as_default: - type: boolean - description: Either `true` to allow squash-merge commits to use - pull request title, or `false` to use commit message. **This property - is closing down. Please use `squash_merge_commit_title` instead. - default: false - deprecated: true - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - Required when using `squash_merge_commit_message`. - - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - Required when using `merge_commit_message`. - - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - custom_properties: - type: object - description: The custom properties for the new repository. The keys - are the custom property names, and the values are the corresponding - custom property values. - additionalProperties: true - required: - - name - examples: - default: - value: - name: Hello-World - description: This is your first repository - homepage: https://github.com - private: false - has_issues: true - has_projects: true - has_wiki: true - responses: - '201': - description: Response - content: - application/json: - schema: &347 - title: Full Repository - description: Full Repository - type: object - properties: - id: - type: integer - format: int64 - example: 1296269 - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - type: string - example: Hello-World - full_name: - type: string - example: octocat/Hello-World - owner: *4 - private: - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: - type: string - format: uri - example: git:git.example.com/octocat/Hello-World - nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: - type: string - format: uri - example: https://github.com - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - description: The size of the repository, in kilobytes. Size is - calculated hourly. When a repository is initially created, the - size is 0. - type: integer - example: 108 - default_branch: - type: string - example: master - open_issues_count: - type: integer - example: 0 - is_template: - type: boolean - example: true - topics: - type: array - items: - type: string - example: - - octocat - - atom - - electron - - API - has_issues: - type: boolean - example: true - has_projects: - type: boolean - example: true - has_wiki: - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - type: boolean - example: true - has_discussions: - type: boolean - example: true - has_pull_requests: - type: boolean - example: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull requests: - all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - example: all - archived: - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - example: public - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - allow_rebase_merge: - type: boolean - example: true - template_repository: - title: Repository - description: A repository on GitHub. - type: object - properties: *296 - required: *297 - x-github-breaking-changes: *298 - nullable: true - temp_clone_token: - type: string - nullable: true - allow_squash_merge: - type: boolean - example: true - allow_auto_merge: - type: boolean - example: false - delete_branch_on_merge: - type: boolean - example: false - allow_merge_commit: - type: boolean - example: true - allow_update_branch: - type: boolean - example: true - use_squash_pr_title_as_default: - type: boolean - example: false - squash_merge_commit_title: - type: string - example: PR_TITLE - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - example: PR_BODY - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - example: PR_TITLE - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - example: PR_BODY - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_forking: - type: boolean - example: true - web_commit_signoff_required: - type: boolean - example: false - subscribers_count: - type: integer - example: 42 - network_count: - type: integer - example: 0 - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - organization: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - parent: *79 - source: *79 - forks: - type: integer - master_branch: - type: string - open_issues: - type: integer - watchers: - type: integer - anonymous_access_enabled: - description: Whether anonymous git access is allowed. - default: true - type: boolean - code_of_conduct: - title: Code Of Conduct Simple - description: Code of Conduct Simple - type: object - properties: &487 - url: - type: string - format: uri - example: https://api.github.com/repos/github/docs/community/code_of_conduct - key: - type: string - example: citizen_code_of_conduct - name: - type: string - example: Citizen Code of Conduct - html_url: - type: string - nullable: true - format: uri - example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &488 - - url - - key - - name - - html_url - security_and_analysis: *299 - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the - corresponding custom property values. - additionalProperties: true - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_issues - - has_projects - - has_wiki - - has_pages - - has_discussions - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - - network_count - - subscribers_count - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - properties: - use_squash_pr_title_as_default: - version: '2026-03-10' - - changeset: remove_has_downloads - patch: - properties: - has_downloads: - version: '2026-03-10' - examples: - default: &349 - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - language: - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - push: false - admin: false - allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - allow_forking: true - web_commit_signoff_required: false - subscribers_count: 42 - network_count: 0 - organization: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: Organization - site_admin: false - parent: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - source: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World - schema: - type: string - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - x-github-breaking-changes: - - changeset: change_create_repo_trade_compliance_response_status - patch: - responses: - '451': *15 - version: '2026-03-10' - "/orgs/{org}/rulesets": - get: - summary: Get all organization repository rulesets - description: Get all the repository rulesets for an organization. - tags: - - repos - operationId: repos/get-org-rulesets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - parameters: - - *75 - - *17 - - *19 - - &616 - name: targets - description: | - A comma-separated list of rule targets to filter by. - If provided, only rulesets that apply to the specified targets will be returned. - For example, `branch,tag,push`. - in: query - required: false - schema: - type: string - example: branch,tag,push - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &326 - title: Repository ruleset - type: object - description: A set of rules to apply when specified conditions are - met. - required: - - id - - name - - source - - enforcement - properties: - id: - type: integer - description: The ID of the ruleset - name: - type: string - description: The name of the ruleset - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - - repository - source_type: - type: string - description: The type of the source of the ruleset - enum: - - Repository - - Organization - - Enterprise - source: - type: string - description: The name of the source - enforcement: &302 - type: string - description: The enforcement level of the ruleset. `evaluate` - allows admins to test rules before enforcing them. Admins - can view insights on the Rule Insights page (`evaluate` is - only available with GitHub Enterprise). - enum: - - disabled - - active - - evaluate - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: &303 - title: Repository Ruleset Bypass Actor - type: object - description: An actor that can bypass rules in a ruleset - required: - - actor_type - properties: - actor_id: - type: integer - nullable: true - description: The ID of the actor that can bypass a ruleset. - Required for `Integration`, `RepositoryRole`, and `Team` - actor types. If `actor_type` is `OrganizationAdmin`, - `actor_id` is ignored. If `actor_type` is `DeployKey`, - this should be null. `OrganizationAdmin` is not applicable - for personal repositories. - actor_type: - type: string - enum: - - Integration - - OrganizationAdmin - - RepositoryRole - - Team - - DeployKey - description: The type of actor that can bypass a ruleset. - bypass_mode: - type: string - description: When the specified actor can bypass the ruleset. - `pull_request` means that an actor can only bypass rules - on pull requests. `pull_request` is not applicable for - the `DeployKey` actor type. Also, `pull_request` is - only applicable to branch rulesets. When `bypass_mode` - is `exempt`, rules will not be run for that actor and - a bypass audit entry will not be created. - enum: - - always - - pull_request - - exempt - default: always - current_user_can_bypass: - type: string - description: |- - The bypass type of the user making the API request for this ruleset. This field is only returned when - querying the repository-level endpoint. - enum: - - always - - pull_requests_only - - never - - exempt - node_id: - type: string - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - description: The URL of the ruleset - html: - type: object - nullable: true - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - nullable: true - anyOf: - - &300 - title: Repository ruleset conditions for ref names - type: object - description: Parameters for a repository ruleset ref name - condition - properties: - ref_name: - type: object - properties: - include: - type: array - description: Array of ref names or patterns to include. - One of these patterns must match for the condition - to pass. Also accepts `~DEFAULT_BRANCH` to include - the default branch or `~ALL` to include all branches. - items: - type: string - exclude: - type: array - description: Array of ref names or patterns to exclude. - The condition will not pass if any of these patterns - match. - items: - type: string - - &304 - title: Organization ruleset conditions - type: object - description: |- - Conditions for an organization ruleset. - The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. - The push rulesets conditions object does not require the `ref_name` property. - For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. - oneOf: - - type: object - title: repository_name_and_ref_name - description: Conditions to target repositories by name and - refs by name - allOf: - - *300 - - title: Repository ruleset conditions for repository names - type: object - description: Parameters for a repository name condition - properties: - repository_name: - type: object - properties: - include: - type: array - description: Array of repository names or patterns - to include. One of these patterns must match - for the condition to pass. Also accepts `~ALL` - to include all repositories. - items: - type: string - exclude: - type: array - description: Array of repository names or patterns - to exclude. The condition will not pass if any - of these patterns match. - items: - type: string - protected: - type: boolean - description: Whether renaming of target repositories - is prevented. - required: - - repository_name - - type: object - title: repository_id_and_ref_name - description: Conditions to target repositories by id and - refs by name - allOf: - - *300 - - title: Repository ruleset conditions for repository IDs - type: object - description: Parameters for a repository ID condition - properties: - repository_id: - type: object - properties: - repository_ids: - type: array - description: The repository IDs that the ruleset - applies to. One of these IDs must match for - the condition to pass. - items: - type: integer - required: - - repository_id - - type: object - title: repository_property_and_ref_name - description: Conditions to target repositories by property - and refs by name - allOf: - - *300 - - title: Repository ruleset conditions for repository properties - type: object - description: Parameters for a repository property condition - properties: - repository_property: - type: object - properties: - include: - type: array - description: The repository properties and values - to include. All of these properties must match - for the condition to pass. - items: &301 - title: Repository ruleset property targeting - definition - type: object - description: Parameters for a targeting a repository - property - properties: - name: - type: string - description: The name of the repository - property to target - property_values: - type: array - description: The values to match for the - repository property - items: - type: string - source: - type: string - description: The source of the repository - property. Defaults to 'custom' if not - specified. - enum: - - custom - - system - required: - - name - - property_values - exclude: - type: array - description: The repository properties and values - to exclude. The condition will not pass if any - of these properties match. - items: *301 - required: - - repository_property - rules: - type: array - items: &617 - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - &305 - title: creation - description: Only allow users with bypass permission to - create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - - &306 - title: update - description: Only allow users with bypass permission to - update matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - update - parameters: - type: object - properties: - update_allows_fetch_and_merge: - type: boolean - description: Branch can pull changes from its upstream - repository - required: - - update_allows_fetch_and_merge - - &307 - title: deletion - description: Only allow users with bypass permissions to - delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - - &308 - title: required_linear_history - description: Prevent merge commits from being pushed to - matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_linear_history - - &615 - title: merge_queue - description: Merges must be performed via a merge queue. - type: object - required: - - type - properties: - type: - type: string - enum: - - merge_queue - parameters: - type: object - properties: - check_response_timeout_minutes: - type: integer - description: Maximum time for a required status - check to report a conclusion. After this much - time has elapsed, checks that have not reported - a conclusion will be assumed to have failed - minimum: 1 - maximum: 360 - grouping_strategy: - type: string - description: When set to ALLGREEN, the merge commit - created by merge queue for each PR in the group - must pass all required checks to merge. When set - to HEADGREEN, only the commit at the head of the - merge group, i.e. the commit containing changes - from all of the PRs in the group, must pass its - required checks to merge. - enum: - - ALLGREEN - - HEADGREEN - max_entries_to_build: - type: integer - description: Limit the number of queued pull requests - requesting checks and workflow runs at the same - time. - minimum: 0 - maximum: 100 - max_entries_to_merge: - type: integer - description: The maximum number of PRs that will - be merged together in a group. - minimum: 0 - maximum: 100 - merge_method: - type: string - description: Method to use when merging changes - from queued pull requests. - enum: - - MERGE - - SQUASH - - REBASE - min_entries_to_merge: - type: integer - description: The minimum number of PRs that will - be merged together in a group. - minimum: 0 - maximum: 100 - min_entries_to_merge_wait_minutes: - type: integer - description: The time merge queue should wait after - the first PR is added to the queue for the minimum - group size to be met. After this time has elapsed, - the minimum group size will be ignored and a smaller - group will be merged. - minimum: 0 - maximum: 360 - required: - - check_response_timeout_minutes - - grouping_strategy - - max_entries_to_build - - max_entries_to_merge - - merge_method - - min_entries_to_merge - - min_entries_to_merge_wait_minutes - - &309 - title: required_deployments - description: Choose which environments must be successfully - deployed to before refs can be pushed into a ref that - matches this rule. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_deployments - parameters: - type: object - properties: - required_deployment_environments: - type: array - description: The environments that must be successfully - deployed to before branches can be merged. - items: - type: string - required: - - required_deployment_environments - - &310 - title: required_signatures - description: Commits pushed to matching refs must have verified - signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - - &311 - title: pull_request - description: Require all commits be made to a non-target - branch and submitted via a pull request before they can - be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - pull_request - parameters: - type: object - properties: - allowed_merge_methods: - type: array - description: Array of allowed merge methods. Allowed - values include `merge`, `squash`, and `rebase`. - At least one option must be enabled. - items: - type: string - enum: - - merge - - squash - - rebase - dismiss_stale_reviews_on_push: - type: boolean - description: New, reviewable commits pushed will - dismiss previous pull request review approvals. - require_code_owner_review: - type: boolean - description: Require an approving review in pull - requests that modify files that have a designated - code owner. - require_last_push_approval: - type: boolean - description: Whether the most recent reviewable - push must be approved by someone other than the - person who pushed it. - required_approving_review_count: - type: integer - description: The number of approving reviews that - are required before a pull request can be merged. - minimum: 0 - maximum: 10 - required_review_thread_resolution: - type: boolean - description: All conversations on code must be resolved - before a pull request can be merged. - required_reviewers: - type: array - description: |- - > [!NOTE] - > `required_reviewers` is in beta and subject to change. - - A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. - items: - title: RequiredReviewerConfiguration - description: A reviewing team, and file patterns - describing which files they must approve changes - to. - type: object - properties: - file_patterns: - type: array - description: Array of file patterns. Pull - requests which change matching files must - be approved by the specified team. File - patterns use fnmatch syntax. - items: - type: string - minimum_approvals: - type: integer - description: Minimum number of approvals required - from the specified team. If set to zero, - the team will be added to the pull request - but approval is optional. - reviewer: - title: Reviewer - description: A required reviewing team - type: object - properties: - id: - type: integer - description: ID of the reviewer which - must review changes to matching files. - type: - type: string - description: The type of the reviewer - enum: - - Team - required: - - id - - type - required: - - file_patterns - - minimum_approvals - - reviewer - required: - - dismiss_stale_reviews_on_push - - require_code_owner_review - - require_last_push_approval - - required_approving_review_count - - required_review_thread_resolution - - &312 - title: required_status_checks - description: Choose which status checks must pass before - the ref is updated. When enabled, commits must first be - pushed to another ref where the checks pass. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_status_checks - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to - be created if a check would otherwise prohibit - it. - required_status_checks: - type: array - description: Status checks that are required. - items: - title: StatusCheckConfiguration - description: Required status check - type: object - properties: - context: - type: string - description: The status check context name - that must be present on the commit. - integration_id: - type: integer - description: The optional integration ID that - this status check must originate from. - required: - - context - strict_required_status_checks_policy: - type: boolean - description: Whether pull requests targeting a matching - branch must be tested with the latest code. This - setting will not take effect unless at least one - status check is enabled. - required: - - required_status_checks - - strict_required_status_checks_policy - - &313 - title: non_fast_forward - description: Prevent users with push access from force pushing - to refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - non_fast_forward - - &314 - title: commit_message_pattern - description: Parameters to be used for the commit_message_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_message_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule appears when configuring - it. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &315 - title: commit_author_email_pattern - description: Parameters to be used for the commit_author_email_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_author_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule appears when configuring - it. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &316 - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - committer_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule appears when configuring - it. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &317 - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - branch_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule appears when configuring - it. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &318 - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - tag_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule appears when configuring - it. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &319 - title: file_path_restriction - description: Prevent commits that include changes in specified - file and folder paths from being pushed to the commit - graph. This includes absolute paths that contain file - names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_paths - - &320 - title: max_file_path_length - description: Prevent commits that include file paths that - exceed the specified character limit from being pushed - to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed - in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - - &321 - title: file_extension_restriction - description: Prevent commits that include files with specified - file extensions from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - &322 - title: max_file_size - description: Prevent commits with individual files that - exceed the specified limit from being pushed to the commit - graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. - This limit does not apply to Git Large File Storage - (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - - &323 - title: workflows - description: Require all changes made to a targeted branch - to pass the specified workflows before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - workflows - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to - be created if a check would otherwise prohibit - it. - workflows: - type: array - description: Workflows that must pass for this rule - to pass. - items: - title: WorkflowFileReference - description: A workflow that must run for this - rule to pass - type: object - properties: - path: - type: string - description: The path to the workflow file - ref: - type: string - description: The ref (branch or tag) of the - workflow file to use - repository_id: - type: integer - description: The ID of the repository where - the workflow is defined - sha: - type: string - description: The commit SHA of the workflow - file to use - required: - - path - - repository_id - required: - - workflows - - &324 - title: code_scanning - description: Choose which tools must provide code scanning - results before the reference is updated. When configured, - code scanning must be enabled and have results for both - the commit and the reference being updated. - type: object - required: - - type - properties: - type: - type: string - enum: - - code_scanning - parameters: - type: object - properties: - code_scanning_tools: - type: array - description: Tools that must provide code scanning - results for this rule to pass. - items: - title: CodeScanningTool - description: A tool that must provide code scanning - results for this rule to pass. - type: object - properties: - alerts_threshold: - type: string - description: The severity level at which code - scanning results that raise alerts block - a reference update. For more information - on alert severity levels, see "[About code - scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - errors - - errors_and_warnings - - all - security_alerts_threshold: - type: string - description: The severity level at which code - scanning results that raise security alerts - block a reference update. For more information - on security severity levels, see "[About - code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - critical - - high_or_higher - - medium_or_higher - - all - tool: - type: string - description: The name of a code scanning tool - required: - - alerts_threshold - - security_alerts_threshold - - tool - required: - - code_scanning_tools - - &325 - title: copilot_code_review - description: Request Copilot code review for new pull requests - automatically if the author has access to Copilot code - review and their premium requests quota has not reached - the limit. - type: object - required: - - type - properties: - type: - type: string - enum: - - copilot_code_review - parameters: - type: object - properties: - review_draft_pull_requests: - type: boolean - description: Copilot automatically reviews draft - pull requests before they are marked as ready - for review. - review_on_push: - type: boolean - description: Copilot automatically reviews each - new push to the pull request. - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - examples: - default: - value: - - id: 21 - name: super cool ruleset - source_type: Organization - source: my-org - enforcement: enabled - node_id: RRS_lACkVXNlcgQB - _links: - self: - href: https://api.github.com/orgs/my-org/rulesets/21 - html: - href: https://github.com/organizations/my-org/settings/rules/21 - created_at: '2023-07-15T08:43:03Z' - updated_at: '2023-08-23T16:29:47Z' - - id: 432 - name: Another ruleset - source_type: Organization - source: my-org - enforcement: enabled - node_id: RRS_lACkVXNlcgQQ - _links: - self: - href: https://api.github.com/orgs/my-org/rulesets/432 - html: - href: https://github.com/organizations/my-org/settings/rules/432 - created_at: '2023-08-15T08:43:03Z' - updated_at: '2023-09-23T16:29:47Z' - '404': *6 - '500': *55 - post: - summary: Create an organization repository ruleset - description: Create a repository ruleset for an organization. - tags: - - repos - operationId: repos/create-org-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - parameters: - - *75 - requestBody: - description: Request body - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the ruleset. - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - - repository - default: branch - enforcement: *302 - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *304 - rules: - type: array - description: An array of rules within the ruleset. - items: &328 - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - *305 - - *306 - - *307 - - *308 - - *309 - - *310 - - *311 - - *312 - - *313 - - *314 - - *315 - - *316 - - *317 - - *318 - - *319 - - *320 - - *321 - - *322 - - *323 - - *324 - - *325 - required: - - name - - enforcement - examples: - default: - value: - name: super cool ruleset - target: branch - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - repository_name: - include: - - important_repository - - another_important_repository - exclude: - - unimportant_repository - protected: true - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - responses: - '201': - description: Response - content: - application/json: - schema: *326 - examples: - default: &327 - value: - id: 21 - name: super cool ruleset - target: branch - source_type: Organization - source: my-org - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - repository_name: - include: - - important_repository - - another_important_repository - exclude: - - unimportant_repository - protected: true - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - node_id: RRS_lACkVXNlcgQB - _links: - self: - href: https://api.github.com/orgs/my-org/rulesets/21 - html: - href: https://github.com/organizations/my-org/settings/rules/21 - created_at: '2023-08-15T08:43:03Z' - updated_at: '2023-09-23T16:29:47Z' - '404': *6 - '422': *15 - '500': *55 - "/orgs/{org}/rulesets/rule-suites": - get: - summary: List organization rule suites - description: |- - Lists suites of rule evaluations at the organization level. - For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." - tags: - - repos - operationId: repos/get-org-rule-suites - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites - parameters: - - *75 - - &618 - name: ref - description: The name of the ref. Cannot contain wildcard characters. Optionally - prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit - to tags. Omit the prefix to search across all refs. When specified, only - rule evaluations triggered for this ref will be returned. - in: query - schema: - type: string - x-multi-segment: true - - name: repository_name - description: The name of the repository to filter on. - in: query - schema: - type: string - - &619 - name: time_period - description: |- - The time period to filter by. - - For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). - in: query - required: false - schema: - type: string - enum: - - hour - - day - - week - - month - default: day - - &620 - name: actor_name - description: The handle for the GitHub user account to filter on. When specified, - only rule evaluations triggered by this actor will be returned. - in: query - schema: - type: string - - &621 - name: rule_suite_result - description: The rule suite results to filter on. When specified, only suites - with this result will be returned. - in: query - schema: - type: string - enum: - - pass - - fail - - bypass - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: &622 - title: Rule Suites - description: Response - type: array - items: - type: object - properties: - id: - type: integer - description: The unique identifier of the rule insight. - actor_id: - type: integer - description: The number that identifies the user. - actor_name: - type: string - description: The handle for the GitHub user account. - before_sha: - type: string - description: The first commit sha before the push evaluation. - after_sha: - type: string - description: The last commit sha in the push evaluation. - ref: - type: string - description: The ref name that the evaluation ran on. - repository_id: - type: integer - description: The ID of the repository associated with the rule - evaluation. - repository_name: - type: string - description: The name of the repository without the `.git` extension. - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - result: - type: string - enum: - - pass - - fail - - bypass - description: The result of the rule evaluations for rules with - the `active` enforcement status. - evaluation_result: - type: string - enum: - - pass - - fail - - bypass - description: The result of the rule evaluations for rules with - the `active` and `evaluate` enforcement statuses, demonstrating - whether rules would pass or fail if all rules in the rule - suite were `active`. - examples: - default: &623 - value: - - id: 21 - actor_id: 12 - actor_name: octocat - before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d - after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 - ref: refs/heads/i-see-everything - repository_id: 404 - repository_name: octo-repo - pushed_at: '2023-07-06T08:43:03Z' - result: bypass - - id: 25 - actor_id: 11 - actor_name: not-octocat - before_sha: 48994e4e01ccc943624c6231f172702b82b233cc - after_sha: ecfd5a1025fa271a33ca5608d089476a2df3c9a1 - ref: refs/heads/i-am-everything - repository_id: 404 - repository_name: octo-repo - pushed_at: '2023-07-07T08:43:03Z' - result: pass - evaluation_result: fail - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rule-suites - "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": - get: - summary: Get an organization rule suite - description: |- - Gets information about a suite of rule evaluations from within an organization. - For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." - tags: - - repos - operationId: repos/get-org-rule-suite - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite - parameters: - - *75 - - &624 - name: rule_suite_id - description: |- - The unique identifier of the rule suite result. - To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) - for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) - for organizations. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &625 - title: Rule Suite - description: Response - type: object - properties: - id: - type: integer - description: The unique identifier of the rule insight. - actor_id: - type: integer - description: The number that identifies the user. - nullable: true - actor_name: - type: string - description: The handle for the GitHub user account. - nullable: true - before_sha: - type: string - description: The previous commit SHA of the ref. - after_sha: - type: string - description: The new commit SHA of the ref. - ref: - type: string - description: The ref name that the evaluation ran on. - repository_id: - type: integer - description: The ID of the repository associated with the rule - evaluation. - repository_name: - type: string - description: The name of the repository without the `.git` extension. - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - result: - type: string - enum: - - pass - - fail - - bypass - description: The result of the rule evaluations for rules with - the `active` enforcement status. - evaluation_result: - type: string - nullable: true - enum: - - pass - - fail - - bypass - description: The result of the rule evaluations for rules with - the `active` and `evaluate` enforcement statuses, demonstrating - whether rules would pass or fail if all rules in the rule suite - were `active`. Null if no rules with `evaluate` enforcement - status were run. - rule_evaluations: - type: array - description: Details on the evaluated rules. - items: - type: object - properties: - rule_source: - type: object - properties: - type: - type: string - description: The type of rule source. - id: - type: integer - nullable: true - description: The ID of the rule source. - name: - type: string - nullable: true - description: The name of the rule source. - enforcement: - type: string - enum: - - active - - evaluate - - deleted ruleset - description: The enforcement level of this rule source. - result: - type: string - enum: - - pass - - fail - description: The result of the evaluation of the individual - rule. - rule_type: - type: string - description: The type of rule. - details: - type: string - nullable: true - description: The detailed failure message for the rule. - Null if the rule passed. - examples: - default: &626 - value: - id: 21 - actor_id: 12 - actor_name: octocat - before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d - after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 - ref: refs/heads/i-see-everything - repository_id: 404 - repository_name: octo-repo - pushed_at: '2023-07-06T08:43:03Z' - result: bypass - evaluation_result: fail - rule_evaluations: - - rule_source: - type: ruleset - id: 2 - name: Author email must be a GitHub email address - enforcement: active - result: pass - rule_type: commit_author_email_pattern - - rule_source: - type: protected_branch - enforcement: active - result: fail - rule_type: pull_request - details: Changes must be made through a pull request. - - rule_source: - type: ruleset - id: 3 - name: Evaluate commit message pattern - enforcement: evaluate - result: fail - rule_type: commit_message_pattern - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rule-suites - "/orgs/{org}/rulesets/{ruleset_id}": - get: - summary: Get an organization repository ruleset - description: |- - Get a repository ruleset for an organization. - - **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user - making the API request has write access to the ruleset. - tags: - - repos - operationId: repos/get-org-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - parameters: - - *75 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *326 - examples: - default: *327 - '404': *6 - '500': *55 - put: - summary: Update an organization repository ruleset - description: Update a ruleset for an organization. - tags: - - repos - operationId: repos/update-org-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - parameters: - - *75 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - requestBody: - description: Request body - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the ruleset. - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - - repository - enforcement: *302 - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *304 - rules: - description: An array of rules within the ruleset. - type: array - items: *328 - examples: - default: - value: - name: super cool ruleset - target: branch - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - repository_name: - include: - - important_repository - - another_important_repository - exclude: - - unimportant_repository - protected: true - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - responses: - '200': - description: Response - content: - application/json: - schema: *326 - examples: - default: *327 - '404': *6 - '422': *15 - '500': *55 - delete: - summary: Delete an organization repository ruleset - description: Delete a ruleset for an organization. - tags: - - repos - operationId: repos/delete-org-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - parameters: - - *75 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - '404': *6 - '500': *55 - "/orgs/{org}/rulesets/{ruleset_id}/history": - get: - summary: Get organization ruleset history - description: Get the history of an organization ruleset. - tags: - - orgs - operationId: orgs/get-org-ruleset-history - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history - parameters: - - *75 - - *17 - - *19 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &329 - title: Ruleset version - type: object - description: The historical version of a ruleset - required: - - version_id - - actor - - updated_at - properties: - version_id: - type: integer - description: The ID of the previous version of the ruleset - actor: - type: object - description: The actor who updated the ruleset - properties: - id: - type: integer - type: - type: string - updated_at: - type: string - format: date-time - examples: - default: &628 - value: - - version_id: 3 - actor: - id: 1 - type: User - updated_at: '2024-10-23T16:29:47Z' - - version_id: 2 - actor: - id: 2 - type: User - updated_at: '2024-09-23T16:29:47Z' - - version_id: 1 - actor: - id: 1 - type: User - updated_at: '2024-08-23T16:29:47Z' - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": - get: - summary: Get organization ruleset version - description: Get a version of an organization ruleset. - tags: - - orgs - operationId: orgs/get-org-ruleset-version - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version - parameters: - - *75 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - - name: version_id - description: The ID of the version - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &629 - allOf: - - *329 - - type: object - required: - - state - properties: - state: - type: object - description: The state of the ruleset version - examples: - default: - value: - version_id: 3 - actor: - id: 1 - type: User - updated_at: '2024-10-23T16:29:47Z' - state: - id: 21 - name: super cool ruleset - target: branch - source_type: Organization - source: my-org - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - repository_name: - include: - - important_repository - - another_important_repository - exclude: - - unimportant_repository - protected: true - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: rules - "/orgs/{org}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for an organization - description: |- - Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization - parameters: - - *75 - - &630 - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - - &631 - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default - secret patterns are returned. To return generic patterns, pass the token - name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false - schema: - type: string - - &632 - name: exclude_secret_types - in: query - description: A comma-separated list of secret types to exclude from the results. - All default secret patterns are returned except those matching the specified - types. Cannot be combined with the `secret_type` parameter. See "[Supported - secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false - schema: - type: string - - &633 - name: exclude_providers - in: query - description: |- - A comma-separated list of provider slugs to exclude from the results. - Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). - You can find the provider slug in the `provider_slug` field of each alert. - Cannot be combined with the `providers` parameter. - required: false - schema: - type: string - - &634 - name: providers - in: query - description: |- - A comma-separated list of provider slugs to filter by. - Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). - You can find the provider slug in the `provider_slug` field of each alert. - Cannot be combined with the `exclude_providers` parameter. - required: false - schema: - type: string - - &635 - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false - schema: - type: string - - &636 - name: assignee - in: query - description: Filters alerts by assignee. Use `*` to get all assigned alerts, - `none` to get all unassigned alerts, or a GitHub username to get alerts - assigned to a specific user. - required: false - schema: - type: string - examples: - assigned-to-user: - value: octocat - summary: Filter for alerts assigned to the user "octocat" - all-assigned: - value: "*" - summary: Filter for all assigned alerts - all-unassigned: - value: none - summary: Filter for all unassigned alerts - - &637 - name: sort - description: The property to sort the results by. `created` means when the - alert was created. `updated` means when the alert was updated or resolved. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - *61 - - *19 - - *17 - - &638 - name: before - description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). - If specified, the query only searches for events before this cursor. To - receive an initial cursor on your first request, include an empty "before" - query string. - in: query - required: false - schema: - type: string - - &639 - name: after - description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). - If specified, the query only searches for events after this cursor. To - receive an initial cursor on your first request, include an empty "after" - query string. - in: query - required: false - schema: - type: string - - &640 - name: validity - in: query - description: A comma-separated list of validities that, when present, will - return alerts that match the validities in this list. Valid options are - `active`, `inactive`, and `unknown`. - required: false - schema: - type: string - - &641 - name: is_publicly_leaked - in: query - description: A boolean value representing whether or not to filter alerts - by the publicly-leaked tag being present. - required: false - schema: - type: boolean - default: false - - &642 - name: is_multi_repo - in: query - description: A boolean value representing whether or not to filter alerts - by the multi-repo tag being present. - required: false - schema: - type: boolean - default: false - - &643 - name: hide_secret - in: query - description: A boolean value representing whether or not to hide literal secrets - in the results. - required: false - schema: - type: boolean - default: false - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: object - properties: - number: *178 - created_at: *179 - updated_at: - type: string - description: 'The time that the alert was last updated in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - url: *181 - html_url: *182 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - state: &644 - description: Sets the state of the secret scanning alert. You - must provide `resolution` when you set the state to `resolved`. - type: string - enum: - - open - - resolved - resolution: &645 - type: string - description: "**Required when the `state` is `resolved`.** The - reason for resolving the alert." - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - provider: - type: string - description: The provider of the secret that was detected. - nullable: true - provider_slug: - type: string - description: The slug identifier for the provider of the secret - that was detected. Use this value for filtering by provider - with the `providers` or `exclude_providers` parameters. - nullable: true - secret: - type: string - description: The secret that was detected. - repository: *66 - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected - secret. - nullable: true - push_protection_bypassed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection - bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection - bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - resolution_comment: - type: string - description: The comment that was optionally added when this - alert was closed - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: boolean - description: Whether the secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple - repositories in the same organization or enterprise. - nullable: true - is_base64_encoded: - type: boolean - description: A boolean value representing whether or not alert - is base64 encoded - nullable: true - first_location_detected: - description: 'Details on the location where the token was initially - detected. This can be a commit, wiki commit, issue, discussion, - pull request. - - ' - oneOf: &646 - - &648 - description: Represents a 'commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8BIT - ASCII - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit - resource - html_url: - type: string - format: uri - description: The GitHub URL to get the associated commit - resource. - example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - - &649 - description: Represents a 'wiki_commit' secret scanning location - type. This location type shows that a secret was detected - inside a commit to a repository wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in - the file - end_line: - type: number - description: Line number at which the secret ends in the - file - start_column: - type: number - description: The column at which the secret starts within - the start line when the file is interpreted as 8-bit - ASCII. - end_column: - type: number - description: The column at which the secret ends within - the end line when the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki - page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki - commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - - &650 - description: Represents an 'issue_title' secret scanning location - type. This location type shows that a secret was detected - in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - html_url: - type: string - format: uri - description: The GitHub URL for the issue where the secret - was detected. - example: https://github.com/octocat/Hello-World/issues/1 - required: - - issue_title_url - - &651 - description: Represents an 'issue_body' secret scanning location - type. This location type shows that a secret was detected - in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - html_url: - type: string - format: uri - description: The GitHub URL for the issue where the secret - was detected. - example: https://github.com/octocat/Hello-World/issues/1 - required: - - issue_body_url - - &652 - description: Represents an 'issue_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - html_url: - type: string - format: uri - description: The GitHub URL for the issue comment where - the secret was detected. - example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 - required: - - issue_comment_url - - &653 - description: Represents a 'discussion_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - - &654 - description: Represents a 'discussion_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - - &655 - description: Represents a 'discussion_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment - where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - - &656 - description: Represents a 'pull_request_title' secret scanning - location type. This location type shows that a secret was - detected in the title of a pull request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - html_url: - type: string - format: uri - description: The GitHub URL for the pull request where - the secret was detected. - example: https://github.com/octocat/Hello-World/pull/2846 - required: - - pull_request_title_url - - &657 - description: Represents a 'pull_request_body' secret scanning - location type. This location type shows that a secret was - detected in the body of a pull request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where - the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - html_url: - type: string - format: uri - description: The GitHub URL for the pull request where - the secret was detected. - example: https://github.com/octocat/Hello-World/pull/2846 - required: - - pull_request_body_url - - &658 - description: Represents a 'pull_request_comment' secret scanning - location type. This location type shows that a secret was - detected in a comment on a pull request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - html_url: - type: string - format: uri - description: The GitHub URL for the pull request comment - where the secret was detected. - example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 - required: - - pull_request_comment_url - - &659 - description: Represents a 'pull_request_review' secret scanning - location type. This location type shows that a secret was - detected in a review on a pull request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review - where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - html_url: - type: string - format: uri - description: The GitHub URL for the pull request review - where the secret was detected. - example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 - required: - - pull_request_review_url - - &660 - description: Represents a 'pull_request_review_comment' secret - scanning location type. This location type shows that a - secret was detected in a review comment on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review - comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - html_url: - type: string - format: uri - description: The GitHub URL for the pull request review - comment where the secret was detected. - example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 - required: - - pull_request_review_comment_url - nullable: true - has_more_locations: - type: boolean - description: A boolean value representing whether or not the - token in the alert was detected in more than one location. - assigned_to: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - closure_request_comment: - type: string - description: An optional comment from the closure request author. - nullable: true - closure_request_reviewer_comment: - type: string - description: An optional comment from the closure request reviewer. - nullable: true - closure_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - examples: - default: - value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - resolution_comment: Example comment - validity: active - publicly_leaked: false - multi_repo: false - is_base64_encoded: false - first_location_detected: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: secret-scanning - "/orgs/{org}/secret-scanning/pattern-configurations": - get: - summary: List organization pattern configurations - description: |- - Lists the secret scanning pattern configurations for an organization. - - Personal access tokens (classic) need the `read:org` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/list-org-pattern-configs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: push-protection - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Secret scanning pattern configuration - description: A collection of secret scanning patterns and their settings - related to push protection. - type: object - properties: - pattern_config_version: &331 - type: string - description: The version of the entity. This is used to confirm - you're updating the current version of the entity and mitigate - unintentionally overriding someone else's update. - nullable: true - provider_pattern_overrides: - type: array - description: Overrides for partner patterns. - items: &330 - type: object - properties: - token_type: - type: string - description: The ID of the pattern. - custom_pattern_version: - type: string - description: The version of this pattern if it's a custom - pattern. - nullable: true - slug: - type: string - description: The slug of the pattern. - display_name: - type: string - description: The user-friendly name for the pattern. - alert_total: - type: integer - description: The total number of alerts generated by this - pattern. - alert_total_percentage: - type: integer - description: The percentage of all alerts that this pattern - represents, rounded to the nearest integer. - false_positives: - type: integer - description: The number of false positive alerts generated - by this pattern. - false_positive_rate: - type: integer - description: The percentage of alerts from this pattern - that are false positives, rounded to the nearest integer. - bypass_rate: - type: integer - description: The percentage of blocks for this pattern that - were bypassed, rounded to the nearest integer. - default_setting: - type: string - description: The default push protection setting for this - pattern. - enum: - - disabled - - enabled - enterprise_setting: - type: string - description: The push protection setting for this pattern - set at the enterprise level. Only present for partner - patterns when the organization has a parent enterprise. - enum: - - not-set - - disabled - - enabled - nullable: true - setting: - type: string - description: The current push protection setting for this - pattern. If this is `not-set`, then it inherits either - the enterprise setting if it exists or the default setting. - enum: - - not-set - - disabled - - enabled - custom_pattern_overrides: - type: array - description: Overrides for custom patterns defined by the organization. - items: *330 - examples: - default: - value: - pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K - provider_pattern_overrides: - - token_type: GITHUB_PERSONAL_ACCESS_TOKEN - slug: github_personal_access_token_legacy_v2 - display_name: GitHub Personal Access Token (Legacy v2) - alert_total: 15 - alert_total_percentage: 36 - false_positives: 2 - false_positive_rate: 13 - bypass_rate: 13 - default_setting: enabled - setting: enabled - enterprise_setting: enabled - custom_pattern_overrides: - - token_type: cp_2 - custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K - slug: custom-api-key - display_name: Custom API Key - alert_total: 15 - alert_total_percentage: 36 - false_positives: 3 - false_positive_rate: 20 - bypass_rate: 20 - default_setting: disabled - setting: enabled - '403': *29 - '404': *6 - patch: - summary: Update organization pattern configurations - description: |- - Updates the secret scanning pattern configurations for an organization. - - Personal access tokens (classic) need the `write:org` scope to use this endpoint. - tags: - - secret-scanning - operationId: secret-scanning/update-org-pattern-configs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: push-protection - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - pattern_config_version: *331 - provider_pattern_settings: - type: array - description: Pattern settings for provider patterns. - items: - type: object - properties: - token_type: - type: string - description: The ID of the pattern to configure. - push_protection_setting: - type: string - description: Push protection setting to set for the pattern. - enum: - - not-set - - disabled - - enabled - custom_pattern_settings: - type: array - description: Pattern settings for custom patterns. - items: - type: object - properties: - token_type: - type: string - description: The ID of the pattern to configure. - custom_pattern_version: *331 - push_protection_setting: - type: string - description: Push protection setting to set for the pattern. - enum: - - disabled - - enabled - examples: - default: - value: - pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K - provider_pattern_settings: - - token_type: GITHUB_PERSONAL_ACCESS_TOKEN - push_protection_setting: enabled - custom_pattern_settings: - - token_type: cp_2 - custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K - push_protection_setting: enabled - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - pattern_config_version: - type: string - description: The updated pattern configuration version. - examples: - default: - value: - pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K - '400': *14 - '403': *29 - '404': *6 - '409': *54 - '422': *15 - "/orgs/{org}/security-advisories": - get: - summary: List repository security advisories for an organization - description: |- - Lists repository security advisories for an organization. - - The authenticated user must be an owner or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - tags: - - security-advisories - operationId: security-advisories/list-org-repository-advisories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization - parameters: - - *75 - - *61 - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - published - default: created - - *47 - - *48 - - name: per_page - description: The number of advisories to return per page. For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - name: state - description: Filter by the state of the repository advisories. Only advisories - of this state will be returned. - in: query - required: false - schema: - type: string - enum: - - triage - - draft - - published - - closed - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &664 - description: A repository security advisory. - type: object - properties: - ghsa_id: - type: string - description: The GitHub Security Advisory ID. - readOnly: true - cve_id: - type: string - description: The Common Vulnerabilities and Exposures (CVE) - ID. - nullable: true - url: - type: string - format: uri - description: The API URL for the advisory. - readOnly: true - html_url: - type: string - format: uri - description: The URL for the advisory. - readOnly: true - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: string - description: A detailed description of what the advisory entails. - maxLength: 65535 - nullable: true - severity: - type: string - description: The severity of the advisory. - nullable: true - enum: - - critical - - high - - medium - - low - author: - readOnly: true - nullable: true - description: The author of the advisory. - allOf: - - *4 - publisher: - readOnly: true - nullable: true - description: The publisher of the advisory. - allOf: - - *4 - identifiers: - type: array - items: - type: object - properties: - type: - type: string - description: The type of identifier. - enum: - - CVE - - GHSA - value: - type: string - description: The identifier value. - required: - - type - - value - readOnly: true - state: - type: string - description: The state of the advisory. - enum: - - published - - closed - - withdrawn - - draft - - triage - created_at: - type: string - format: date-time - description: The date and time of when the advisory was created, - in ISO 8601 format. - readOnly: true - nullable: true - updated_at: - type: string - format: date-time - description: The date and time of when the advisory was last - updated, in ISO 8601 format. - readOnly: true - nullable: true - published_at: - type: string - format: date-time - description: The date and time of when the advisory was published, - in ISO 8601 format. - readOnly: true - nullable: true - closed_at: - type: string - format: date-time - description: The date and time of when the advisory was closed, - in ISO 8601 format. - readOnly: true - nullable: true - withdrawn_at: - type: string - format: date-time - description: The date and time of when the advisory was withdrawn, - in ISO 8601 format. - readOnly: true - nullable: true - submission: - type: object - nullable: true - readOnly: true - properties: - accepted: - type: boolean - description: Whether a private vulnerability report was - accepted by the repository's administrators. - readOnly: true - required: - - accepted - vulnerabilities: - type: array - nullable: true - items: - description: A product affected by the vulnerability detailed - in a repository security advisory. - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - nullable: true - properties: - ecosystem: *1 - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - - name - vulnerable_version_range: - type: string - description: The range of the package versions affected - by the vulnerability. - nullable: true - patched_versions: - type: string - description: The package version(s) that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected. - nullable: true - items: - type: string - required: - - package - - vulnerable_version_range - - patched_versions - - vulnerable_functions - additionalProperties: false - cvss: - type: object - nullable: true - properties: - vector_string: - type: string - description: The CVSS vector. - nullable: true - score: - type: number - description: The CVSS score. - minimum: 0 - maximum: 10 - nullable: true - readOnly: true - required: - - vector_string - - score - cvss_severities: *63 - cwes: - type: array - nullable: true - items: - type: object - properties: - cwe_id: - type: string - description: The Common Weakness Enumeration (CWE) identifier. - name: - type: string - description: The name of the CWE. - readOnly: true - required: - - cwe_id - - name - readOnly: true - cwe_ids: - type: array - description: A list of only the CWE IDs. - nullable: true - items: - type: string - credits: - type: array - nullable: true - items: - type: object - properties: - login: - type: string - description: The username of the user credited. - type: *332 - credits_detailed: - type: array - nullable: true - items: - description: A credit given to a user for a repository security - advisory. - type: object - properties: - user: *4 - type: *332 - state: - type: string - description: The state of the user's acceptance of the - credit. - enum: - - accepted - - declined - - pending - required: - - user - - type - - state - additionalProperties: false - readOnly: true - collaborating_users: - type: array - description: A list of users that collaborate on the advisory. - nullable: true - items: *4 - collaborating_teams: - type: array - description: A list of teams that collaborate on the advisory. - nullable: true - items: *197 - private_fork: - readOnly: true - nullable: true - description: A temporary private fork of the advisory's repository - for collaborating on a fix. - allOf: - - *66 - required: - - ghsa_id - - cve_id - - url - - html_url - - summary - - description - - severity - - author - - publisher - - identifiers - - state - - created_at - - updated_at - - published_at - - closed_at - - withdrawn_at - - submission - - vulnerabilities - - cvss - - cwes - - cwe_ids - - credits - - credits_detailed - - collaborating_users - - collaborating_teams - - private_fork - additionalProperties: false - x-github-breaking-changes: - - changeset: deprecate_cvss - patch: - properties: - cvss: - required: - - ghsa_id - - cve_id - - url - - html_url - - summary - - description - - severity - - author - - publisher - - identifiers - - state - - created_at - - updated_at - - published_at - - closed_at - - withdrawn_at - - submission - - vulnerabilities - - cwes - - cwe_ids - - credits - - credits_detailed - - collaborating_users - - collaborating_teams - - private_fork - version: '2026-03-10' - examples: - default: &665 - value: - - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: critical - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - publisher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: CVE-2050-00000 - state: published - created_at: '2020-01-01T00:00:00Z' - updated_at: '2020-01-02T00:00:00Z' - published_at: '2020-01-03T00:00:00Z' - closed_at: - withdrawn_at: - submission: - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 9.3 - cwes: - - cwe_id: CWE-123 - name: A CWE - cwe_ids: - - CWE-123 - credits: - - login: octocat - type: analyst - credits_detailed: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: - private_fork: - - ghsa_id: GHSA-1234-5678-9012 - cve_id: CVE-2051-0000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 - html_url: https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: low - author: - login: monauser - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monauser - html_url: https://github.com/monauser - followers_url: https://api.github.com/users/monauser/followers - following_url: https://api.github.com/users/monauser/following{/other_user} - gists_url: https://api.github.com/users/monauser/gists{/gist_id} - starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monauser/subscriptions - organizations_url: https://api.github.com/users/monauser/orgs - repos_url: https://api.github.com/users/monauser/repos - events_url: https://api.github.com/users/monauser/events{/privacy} - received_events_url: https://api.github.com/users/monauser/received_events - type: User - site_admin: false - publisher: - login: monalisa - id: 3 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-1234-5678-9012 - - type: CVE - value: CVE-2051-00000 - state: published - created_at: '2020-01-03T00:00:00Z' - updated_at: '2020-01-04T00:00:00Z' - published_at: '2020-01-04T00:00:00Z' - closed_at: - withdrawn_at: - submission: - accepted: true - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N - score: 1.6 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N - score: 1.6 - cvss_v4: - vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 7.1 - cwes: - - cwe_id: CWE-456 - name: A CWE 2.0 - cwe_ids: - - CWE-456 - credits: - - login: monauser - type: reporter - credits_detailed: - - user: - login: monauser - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/monauser - html_url: https://github.com/monauser - followers_url: https://api.github.com/users/monauser/followers - following_url: https://api.github.com/users/monauser/following{/other_user} - gists_url: https://api.github.com/users/monauser/gists{/gist_id} - starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monauser/subscriptions - organizations_url: https://api.github.com/users/monauser/orgs - repos_url: https://api.github.com/users/monauser/repos - events_url: https://api.github.com/users/monauser/events{/privacy} - received_events_url: https://api.github.com/users/monauser/received_events - type: User - site_admin: false - type: reporter - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: - private_fork: - id: 217723378 - node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= - name: octo-repo-ghsa-1234-5678-9012 - full_name: octo-org/octo-repo-ghsa-1234-5678-9012 - owner: - login: octo-org - id: 6811672 - node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= - avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 - gravatar_id: '' - url: https://api.github.com/users/octo-org - html_url: https://github.com/octo-org - followers_url: https://api.github.com/users/octo-org/followers - following_url: https://api.github.com/users/octo-org/following{/other_user} - gists_url: https://api.github.com/users/octo-org/gists{/gist_id} - starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octo-org/subscriptions - organizations_url: https://api.github.com/users/octo-org/orgs - repos_url: https://api.github.com/users/octo-org/repos - events_url: https://api.github.com/users/octo-org/events{/privacy} - received_events_url: https://api.github.com/users/octo-org/received_events - type: Organization - site_admin: false - private: true - html_url: https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012 - description: - fork: false - url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012 - archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user} - blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha} - branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch} - collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number} - commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha} - compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head} - contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path} - contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors - deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments - downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads - events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events - forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks - git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha} - hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks - issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number} - issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number} - keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id} - labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name} - languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages - merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges - milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number} - notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number} - releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id} - stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers - statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha} - subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers - subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription - tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags - teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams - trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha} - '400': *14 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - "/orgs/{org}/security-managers": - get: - summary: List security manager teams - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. - tags: - - orgs - operationId: orgs/list-security-manager-teams - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *333 - examples: - default: - value: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/organizations/1/team/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/organizations/1/team/1/members{/member} - repositories_url: https://api.github.com/organizations/1/team/1/repos - type: organization - organization_id: 1 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: orgs - subcategory: security-managers - deprecationDate: '2024-12-01' - removalDate: '2026-01-01' - deprecated: true - "/orgs/{org}/security-managers/teams/{team_slug}": - put: - summary: Add a security manager team - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. - tags: - - orgs - operationId: orgs/add-security-manager-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team - parameters: - - *75 - - *77 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: orgs - subcategory: security-managers - deprecationDate: '2024-12-01' - removalDate: '2026-01-01' - deprecated: true - delete: - summary: Remove a security manager team - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. - tags: - - orgs - operationId: orgs/remove-security-manager-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team - parameters: - - *75 - - *77 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: orgs - subcategory: security-managers - deprecationDate: '2024-12-01' - removalDate: '2026-01-01' - deprecated: true - "/orgs/{org}/settings/immutable-releases": - get: - summary: Get immutable releases settings for an organization - description: |- - Gets the immutable releases policy for repositories in an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/get-immutable-releases-settings - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization - parameters: - - *75 - responses: - '200': - description: Immutable releases settings response - content: - application/json: - schema: - title: Check immutable releases organization settings - description: Check immutable releases settings for an organization. - type: object - properties: - enforced_repositories: - type: string - description: The policy that controls how immutable releases are - enforced in the organization. - enum: - - all - - none - - selected - example: all - selected_repositories_url: - type: string - description: The API URL to use to get or set the selected repositories - for immutable releases enforcement, when `enforced_repositories` - is set to `selected`. - required: - - enforced_repositories - examples: - default: - value: - enforced_repositories: all - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - put: - summary: Set immutable releases settings for an organization - description: |- - Sets the immutable releases policy for repositories in an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/set-immutable-releases-settings - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization - parameters: - - *75 - responses: - '204': - description: Response - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - enforced_repositories: - type: string - description: The policy that controls how immutable releases are - enforced in the organization. - enum: - - all - - none - - selected - example: all - selected_repository_ids: - type: array - description: An array of repository ids for which immutable releases - enforcement should be applied. You can only provide a list of - repository ids when the `enforced_repositories` is set to `selected`. - You can add and remove individual repositories using the [Enable - a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) - and [Disable a selected repository for immutable releases in an - organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) - endpoints. - items: - type: integer - required: - - enforced_repositories - examples: - default: - value: - enforced_repositories: all - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - "/orgs/{org}/settings/immutable-releases/repositories": - get: - summary: List selected repositories for immutable releases enforcement - description: |- - List all of the repositories that have been selected for immutable releases enforcement in an organization. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/get-immutable-releases-settings-repositories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement - parameters: - - *75 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - examples: - default: *172 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - put: - summary: Set selected repositories for immutable releases enforcement - description: |- - Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - tags: - - orgs - operationId: orgs/set-immutable-releases-settings-repositories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - type: array - description: An array of repository ids for which immutable releases - enforcement should be applied. You can only provide a list of - repository ids when the `enforced_repositories` is set to `selected`. - You can add and remove individual repositories using the [Enable - a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) - and [Disable a selected repository for immutable releases in an - organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) - endpoints. - items: - type: integer - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - 64780797 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": - put: - summary: Enable a selected repository for immutable releases in an organization - description: |- - Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: orgs/enable-selected-repository-immutable-releases-organization - tags: - - orgs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - delete: - summary: Disable a selected repository for immutable releases in an organization - description: |- - Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - - OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - operationId: orgs/disable-selected-repository-immutable-releases-organization - tags: - - orgs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization - parameters: - - *75 - - *149 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - "/orgs/{org}/settings/network-configurations": - get: - summary: List hosted compute network configurations for an organization - description: |- - Lists all hosted compute network configurations configured in an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. - tags: - - hosted-compute - operationId: hosted-compute/list-network-configurations-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization - parameters: - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - network_configurations - properties: - total_count: - type: integer - network_configurations: - type: array - items: &334 - title: Hosted compute network configuration - description: A hosted compute network configuration. - type: object - properties: - id: - description: The unique identifier of the network configuration. - type: string - example: 123ABC456DEF789 - name: - description: The name of the network configuration. - type: string - example: my-network-configuration - compute_service: - description: The hosted compute service the network configuration - supports. - type: string - enum: - - none - - actions - - codespaces - network_settings_ids: - description: The unique identifier of each network settings - in the configuration. - type: array - items: - type: string - example: 123ABC456DEF789 - failover_network_settings_ids: - description: The unique identifier of each failover network - settings in the configuration. - type: array - items: - type: string - example: 123ABC456DEF789 - failover_network_enabled: - description: Indicates whether the failover network resource - is enabled. - type: boolean - example: true - created_on: - description: The time at which the network configuration - was created, in ISO 8601 format. - type: string - format: date-time - example: '2024-04-26T11:31:07Z' - nullable: true - required: - - id - - name - - created_on - examples: - default: - value: - total_count: 2 - network_configurations: - - id: 123456789ABCDEF - name: My network configuration - compute_service: actions - network_settings_ids: - - 23456789ABDCEF1 - - 3456789ABDCEF12 - created_on: '2022-10-09T23:39:01Z' - - id: 456789ABDCEF123 - name: My other configuration - compute_service: none - network_settings_ids: - - 56789ABDCEF1234 - - 6789ABDCEF12345 - created_on: '2023-04-26T15:23:37Z' - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: network-configurations - post: - summary: Create a hosted compute network configuration for an organization - description: |- - Creates a hosted compute network configuration for an organization. - - OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. - tags: - - hosted-compute - operationId: hosted-compute/create-network-configuration-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the network configuration. Must be between - 1 and 100 characters and may only contain upper and lowercase - letters a-z, numbers 0-9, '.', '-', and '_'. - type: string - compute_service: - description: The hosted compute service to use for the network configuration. - type: string - enum: - - none - - actions - network_settings_ids: - type: array - minItems: 1 - maxItems: 1 - description: A list of identifiers of the network settings resources - to use for the network configuration. Exactly one resource identifier - must be specified in the list. - items: - type: string - failover_network_settings_ids: - type: array - minItems: 0 - maxItems: 1 - description: A list of identifiers of the failover network settings - resources to use for the network configuration. Exactly one resource - identifier must be specified in the list. - items: - type: string - failover_network_enabled: - type: boolean - description: Indicates whether the failover network resource is - enabled. - required: - - name - - network_settings_ids - examples: - default: - value: - name: my-network-configuration - network_settings_ids: - - 23456789ABDCEF1 - compute_service: actions - responses: - '201': - description: Response - content: - application/json: - schema: *334 - examples: - default: &335 - value: - id: 123456789ABCDEF - name: My network configuration - compute_service: actions - network_settings_ids: - - 23456789ABDCEF1 - - 3456789ABDCEF12 - created_on: '2022-10-09T23:39:01Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: network-configurations - "/orgs/{org}/settings/network-configurations/{network_configuration_id}": - get: - summary: Get a hosted compute network configuration for an organization - description: |- - Gets a hosted compute network configuration configured in an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. - tags: - - hosted-compute - operationId: hosted-compute/get-network-configuration-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization - parameters: - - *75 - - &336 - name: network_configuration_id - description: Unique identifier of the hosted compute network configuration. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *334 - examples: - default: *335 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: network-configurations - patch: - summary: Update a hosted compute network configuration for an organization - description: |- - Updates a hosted compute network configuration for an organization. - - OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. - tags: - - hosted-compute - operationId: hosted-compute/update-network-configuration-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization - parameters: - - *75 - - *336 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: Name of the network configuration. Must be between - 1 and 100 characters and may only contain upper and lowercase - letters a-z, numbers 0-9, '.', '-', and '_'. - type: string - compute_service: - description: The hosted compute service to use for the network configuration. - type: string - enum: - - none - - actions - network_settings_ids: - type: array - minItems: 0 - maxItems: 1 - description: A list of identifiers of the network settings resources - to use for the network configuration. Exactly one resource identifier - must be specified in the list. - items: - type: string - failover_network_settings_ids: - type: array - minItems: 0 - maxItems: 1 - description: A list of identifiers of the failover network settings - resources to use for the network configuration. Exactly one resource - identifier must be specified in the list. - items: - type: string - failover_network_enabled: - type: boolean - description: Indicates whether the failover network resource is - enabled. - examples: - default: - value: - name: my-network-configuration - network_settings_ids: - - 23456789ABDCEF1 - compute_service: actions - responses: - '200': - description: Response - content: - application/json: - schema: *334 - examples: - default: *335 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: network-configurations - delete: - summary: Delete a hosted compute network configuration from an organization - description: |- - Deletes a hosted compute network configuration from an organization. - - OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. - tags: - - hosted-compute - operationId: hosted-compute/delete-network-configuration-from-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization - parameters: - - *75 - - *336 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: network-configurations - "/orgs/{org}/settings/network-settings/{network_settings_id}": - get: - summary: Get a hosted compute network settings resource for an organization - description: |- - Gets a hosted compute network settings resource configured for an organization. - - OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. - tags: - - hosted-compute - operationId: hosted-compute/get-network-settings-for-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization - parameters: - - *75 - - name: network_settings_id - description: Unique identifier of the hosted compute network settings. - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Hosted compute network settings resource - description: A hosted compute network settings resource. - type: object - properties: - id: - description: The unique identifier of the network settings resource. - type: string - example: 220F78DACB92BBFBC5E6F22DE1CCF52309D - network_configuration_id: - description: The identifier of the network configuration that - is using this settings resource. - type: string - example: 934E208B3EE0BD60CF5F752C426BFB53562 - name: - description: The name of the network settings resource. - type: string - example: my-network-settings - subnet_id: - description: The subnet this network settings resource is configured - for. - type: string - example: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" - region: - description: The location of the subnet this network settings - resource is configured for. - type: string - example: eastus - required: - - id - - name - - subnet_id - - region - examples: - default: - value: - id: 220F78DACB92BBFBC5E6F22DE1CCF52309D - network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 - name: my_network_settings - subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" - region: eastus - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: network-configurations - "/orgs/{org}/team/{team_slug}/copilot/metrics": - get: - summary: Get Copilot metrics for a team - description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - > [!NOTE] - > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. - - The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. - Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team - parameters: - - *75 - - *77 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 100 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *19 - - name: per_page - description: The number of days of metrics to display per page (max 100). - For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 100 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *337 - examples: - default: *338 - '500': *55 - '403': *29 - '404': *6 - '422': *339 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/orgs/{org}/teams": - get: - summary: List teams - description: Lists all teams in an organization that are visible to the authenticated - user. - tags: - - teams - operationId: teams/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-teams - parameters: - - *75 - - *17 - - *19 - - name: team_type - description: Filter team results by their type. For more information, see - "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" - in: query - required: false - schema: - type: string - enum: - - all - - enterprise - - organization - default: all - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: *260 - headers: - Link: *67 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - post: - summary: Create a team - description: |- - To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)." - - When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". - tags: - - teams - operationId: teams/create - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#create-a-team - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the team. - description: - type: string - description: The description of the team. - maintainers: - type: array - description: List GitHub usernames for organization members who - will become team maintainers. - items: - type: string - repo_names: - type: array - description: The full name (e.g., "organization-name/repository-name") - of repositories to add the team to. - items: - type: string - privacy: - type: string - description: "The level of privacy this team should have. The options - are: \n**For a non-nested team:** \n * `secret` - only visible - to organization owners and members of this team. \n * `closed` - - visible to all members of this organization. \nDefault: `secret` - \ \n**For a parent or child team:** \n * `closed` - visible to - all members of this organization. \nDefault for child team: `closed`" - enum: - - secret - - closed - notification_setting: - type: string - description: "The notification setting the team has chosen. The - options are: \n * `notifications_enabled` - team members receive - notifications when the team is @mentioned. \n * `notifications_disabled` - - no one receives notifications. \nDefault: `notifications_enabled`" - enum: - - notifications_enabled - - notifications_disabled - permission: - type: string - description: "**Closing down notice**. The permission that new repositories - will be added to the team with when none is specified." - enum: - - pull - - push - default: pull - parent_team_id: - type: integer - description: The ID of a team to set as the parent team. - required: - - name - examples: - default: - value: - name: Justice League - description: A great team - permission: push - notification_setting: notifications_enabled - privacy: closed - responses: - '201': - description: Response - content: - application/json: - schema: &340 - title: Full Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - id: - description: Unique identifier of the team - example: 42 - type: integer - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - example: https://api.github.com/organizations/1/team/1 - type: string - format: uri - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - name: - description: Name of the team - example: Developers - type: string - slug: - type: string - example: justice-league - description: - type: string - example: A great team. - nullable: true - privacy: - description: The level of privacy this team should have - type: string - enum: - - closed - - secret - example: closed - notification_setting: - description: The notification setting the team has set - type: string - enum: - - notifications_enabled - - notifications_disabled - example: notifications_enabled - permission: - description: Permission that the team will have for its repositories - example: push - type: string - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - parent: - title: Team Simple - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: *258 - required: *259 - nullable: true - members_count: - type: integer - example: 3 - repos_count: - type: integer - example: 10 - created_at: - type: string - format: date-time - example: '2017-07-14T16:53:42Z' - updated_at: - type: string - format: date-time - example: '2017-08-17T12:37:15Z' - organization: - title: Team Organization - description: Team Organization - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - name: - type: string - example: github - company: - type: string - example: GitHub - blog: - type: string - format: uri - example: https://github.com/blog - location: - type: string - example: San Francisco - email: - type: string - format: email - example: octocat@github.com - twitter_username: - type: string - example: github - nullable: true - is_verified: - type: boolean - example: true - has_organization_projects: - type: boolean - example: true - has_repository_projects: - type: boolean - example: true - public_repos: - type: integer - example: 2 - public_gists: - type: integer - example: 1 - followers: - type: integer - example: 20 - following: - type: integer - example: 0 - html_url: - type: string - format: uri - example: https://github.com/octocat - created_at: - type: string - format: date-time - example: '2008-01-14T04:33:35Z' - type: - type: string - example: Organization - total_private_repos: - type: integer - example: 100 - owned_private_repos: - type: integer - example: 100 - private_gists: - type: integer - example: 81 - nullable: true - disk_usage: - type: integer - example: 10000 - nullable: true - collaborators: - type: integer - example: 8 - nullable: true - billing_email: - type: string - format: email - example: org@example.com - nullable: true - plan: - type: object - properties: - name: - type: string - space: - type: integer - private_repos: - type: integer - filled_seats: - type: integer - seats: - type: integer - required: - - name - - space - - private_repos - default_repository_permission: - type: string - nullable: true - members_can_create_repositories: - type: boolean - example: true - nullable: true - two_factor_requirement_enabled: - type: boolean - example: true - nullable: true - members_allowed_repository_creation_type: - type: string - example: all - members_can_create_public_repositories: - type: boolean - example: true - members_can_create_private_repositories: - type: boolean - example: true - members_can_create_internal_repositories: - type: boolean - example: true - members_can_create_pages: - type: boolean - example: true - members_can_create_public_pages: - type: boolean - example: true - members_can_create_private_pages: - type: boolean - example: true - members_can_fork_private_repositories: - type: boolean - example: false - nullable: true - web_commit_signoff_required: - type: boolean - example: false - updated_at: - type: string - format: date-time - archived_at: - type: string - format: date-time - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - - html_url - - has_organization_projects - - has_repository_projects - - public_repos - - public_gists - - followers - - following - - type - - created_at - - updated_at - - archived_at - ldap_dn: - type: string - description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) - (DN) of the LDAP entry to map to a team. - example: cn=Enterprise Ops,ou=teams,dc=github,dc=com - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to which this - team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which this - team belongs - example: 42 - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - type - - created_at - - updated_at - - members_count - - repos_count - - organization - examples: - default: &341 - value: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - members_count: 3 - repos_count: 10 - created_at: '2017-07-14T16:53:42Z' - updated_at: '2017-08-17T12:37:15Z' - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: github - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - is_verified: true - has_organization_projects: true - has_repository_projects: true - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - html_url: https://github.com/octocat - created_at: '2008-01-14T04:33:35Z' - updated_at: '2017-08-17T12:37:15Z' - type: Organization - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - x-github-breaking-changes: - - changeset: remove_team_permission - patch: - requestBody: - required: true - content: - application/json: - schema: - properties: - permission: - version: '2026-03-10' - "/orgs/{org}/teams/{team_slug}": - get: - summary: Get a team by name - description: |- - Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam NΓ€me"` would become `my-team-name`. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - tags: - - teams - operationId: teams/get-by-name - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#get-a-team-by-name - parameters: - - *75 - - *77 - responses: - '200': - description: Response - content: - application/json: - schema: *340 - examples: - default: *341 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - patch: - summary: Update a team - description: |- - To edit a team, the authenticated user must either be an organization owner or a team maintainer. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - tags: - - teams - operationId: teams/update-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#update-a-team - parameters: - - *75 - - *77 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the team. - description: - type: string - description: The description of the team. - privacy: - type: string - description: "The level of privacy this team should have. Editing - teams without specifying this parameter leaves `privacy` intact. - When a team is nested, the `privacy` for parent teams cannot be - `secret`. The options are: \n**For a non-nested team:** \n * - `secret` - only visible to organization owners and members of - this team. \n * `closed` - visible to all members of this organization. - \ \n**For a parent or child team:** \n * `closed` - visible to - all members of this organization." - enum: - - secret - - closed - notification_setting: - type: string - description: "The notification setting the team has chosen. Editing - teams without specifying this parameter leaves `notification_setting` - intact. The options are: \n * `notifications_enabled` - team members - receive notifications when the team is @mentioned. \n * `notifications_disabled` - - no one receives notifications." - enum: - - notifications_enabled - - notifications_disabled - permission: - type: string - description: "**Closing down notice**. The permission that new repositories - will be added to the team with when none is specified." - enum: - - pull - - push - - admin - default: pull - parent_team_id: - type: integer - description: The ID of a team to set as the parent team. - nullable: true - examples: - default: - value: - name: new team name - description: new team description - privacy: closed - notification_setting: notifications_enabled - responses: - '200': - description: Response when the updated information already exists - content: - application/json: - schema: *340 - examples: - default: *341 - '201': - description: Response - content: - application/json: - schema: *340 - examples: - default: *341 - '404': *6 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - delete: - summary: Delete a team - description: |- - To delete a team, the authenticated user must be an organization owner or team maintainer. - - If you are an organization owner, deleting a parent team will delete all of its child teams as well. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - tags: - - teams - operationId: teams/delete-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#delete-a-team - parameters: - - *75 - - *77 - responses: - '204': - description: Response - '422': &342 - description: Unprocessable entity if you attempt to modify an enterprise - team at the organization level. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - "/orgs/{org}/teams/{team_slug}/invitations": - get: - summary: List pending team invitations - description: |- - The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. - tags: - - teams - operationId: teams/list-pending-invitations-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#list-pending-team-invitations - parameters: - - *75 - - *77 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *237 - examples: - default: *238 - headers: - Link: *67 - '422': *342 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: members - "/orgs/{org}/teams/{team_slug}/members": - get: - summary: List team members - description: |- - Team members will include the members of child teams. - - To list members in a team, the team must be visible to the authenticated user. - tags: - - teams - operationId: teams/list-members-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#list-team-members - parameters: - - *75 - - *77 - - name: role - description: Filters members returned by their role in the team. - in: query - required: false - schema: - type: string - enum: - - member - - maintainer - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: members - "/orgs/{org}/teams/{team_slug}/memberships/{username}": - get: - summary: Get team membership for a user - description: |- - Team members will include the members of child teams. - - To get a user's membership with a team, the team must be visible to the authenticated user. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - - > [!NOTE] - > The response contains the `state` of the membership and the member's `role`. - - The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). - tags: - - teams - operationId: teams/get-membership-for-user-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user - parameters: - - *75 - - *77 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: &343 - title: Team Membership - description: Team Membership - type: object - properties: - url: - type: string - format: uri - role: - description: The role of the user in the team. - enum: - - member - - maintainer - default: member - example: member - type: string - state: - description: The state of the user's membership in the team. - type: string - enum: - - active - - pending - required: - - role - - state - - url - examples: - response-if-user-is-a-team-maintainer: &681 - summary: Response if user is a team maintainer - value: - url: https://api.github.com/teams/1/memberships/octocat - role: maintainer - state: active - '404': - description: if user has no team membership - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: members - put: - summary: Add or update team membership for a user - description: |- - Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. - - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - - An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. - - If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. - tags: - - teams - operationId: teams/add-or-update-membership-for-user-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user - parameters: - - *75 - - *77 - - *71 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - role: - type: string - description: The role that this user should have in the team. - enum: - - member - - maintainer - default: member - examples: - default: - summary: Add or update team membership for an organization member - value: - role: maintainer - responses: - '200': - description: Response - content: - application/json: - schema: *343 - examples: - response-if-users-membership-with-team-is-now-pending: &682 - summary: Response if user's membership with team is now pending - value: - url: https://api.github.com/teams/1/memberships/octocat - role: member - state: pending - '403': - description: Forbidden if team synchronization is set up - '422': - description: Unprocessable Entity if you attempt to add an organization - to a team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: members - delete: - summary: Remove team membership for a user - description: |- - To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. - tags: - - teams - operationId: teams/remove-membership-for-user-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user - parameters: - - *75 - - *77 - - *71 - responses: - '204': - description: Response - '403': - description: Forbidden if team synchronization is set up - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: members - "/orgs/{org}/teams/{team_slug}/repos": - get: - summary: List team repositories - description: |- - Lists a team's repositories visible to the authenticated user. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - tags: - - teams - operationId: teams/list-repos-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-repositories - parameters: - - *75 - - *77 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": - get: - summary: Check team permissions for a repository - description: |- - Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - - You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. - - If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - - If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - tags: - - teams - operationId: teams/check-permissions-for-repo-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository - parameters: - - *75 - - *77 - - *344 - - *345 - responses: - '200': - description: Alternative response with repository permissions - content: - application/json: - schema: &683 - title: Team Repository - description: A team's access to a repository. - type: object - properties: - id: - description: Unique identifier of the repository - example: 42 - type: integer - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the repository. - type: string - example: Team Environment - full_name: - type: string - example: octocat/Hello-World - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - forks: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - required: - - admin - - pull - - push - role_name: - type: string - example: admin - owner: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - private: - description: Whether the repository is private or public. - default: false - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: - type: string - format: uri - example: git:git.example.com/octocat/Hello-World - nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: - type: string - format: uri - example: https://github.com - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - type: integer - example: 108 - default_branch: - description: The default branch of the repository. - type: string - example: master - open_issues_count: - type: integer - example: 0 - is_template: - description: Whether this repository acts as a template that can - be used to generate new repositories. - default: false - type: boolean - example: true - topics: - type: array - items: - type: string - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - archived: - description: Whether the repository is archived. - default: false - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - default: public - type: string - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true - type: boolean - example: true - temp_clone_token: - type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - default: false - type: boolean - example: false - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true - allow_forking: - description: Whether to allow forking this repo - default: false - type: boolean - example: false - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits - default: false - type: boolean - example: false - subscribers_count: - type: integer - network_count: - type: integer - open_issues: - type: integer - watchers: - type: integer - master_branch: - type: string - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - x-github-breaking-changes: - - changeset: remove_has_downloads - patch: - properties: - has_downloads: - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - version: '2026-03-10' - examples: - alternative-response-with-repository-permissions: - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - maintain: false - push: false - triage: false - pull: true - role_name: read - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - '204': - description: Response if team has permission for the repository. This is - the response when the repository media type hasn't been provded in the - Accept header. - '404': - description: Not Found if team does not have permission for the repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - put: - summary: Add or update team repository permissions - description: |- - To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - - For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - tags: - - teams - operationId: teams/add-or-update-repo-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions - parameters: - - *75 - - *77 - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant the team on this repository. - We accept the following permissions to be set: `pull`, `triage`, - `push`, `maintain`, `admin` and you can also specify a custom - repository role name, if the owning organization has defined any. - If no permission is specified, the team''s `permission` attribute - will be used to determine what permission to grant the team on - this repository.' - examples: - default: - summary: Adding a team to an organization repository with the write - role - value: - permission: push - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - delete: - summary: Remove a repository from a team - description: |- - If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - tags: - - teams - operationId: teams/remove-repo-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team - parameters: - - *75 - - *77 - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - "/orgs/{org}/teams/{team_slug}/teams": - get: - summary: List child teams - description: |- - Lists the child teams of the team specified by `{team_slug}`. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - tags: - - teams - operationId: teams/list-child-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-child-teams - parameters: - - *75 - - *77 - - *17 - - *19 - responses: - '200': - description: if child teams exist - content: - application/json: - schema: - type: array - items: *197 - examples: - response-if-child-teams-exist: &684 - value: - - id: 2 - node_id: MDQ6VGVhbTI= - url: https://api.github.com/teams/2 - name: Original Roster - slug: original-roster - description: Started it all. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/2/members{/member} - repositories_url: https://api.github.com/teams/2/repos - parent: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - html_url: https://github.com/orgs/rails/teams/core - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - "/orgs/{org}/{security_product}/{enablement}": - post: - summary: Enable or disable a security feature for an organization - description: |- - > [!WARNING] - > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). - - Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. - tags: - - orgs - operationId: orgs/enable-or-disable-security-product-on-all-org-repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization - parameters: - - *75 - - name: security_product - in: path - description: The security feature to enable or disable. - required: true - schema: - type: string - enum: - - dependency_graph - - dependabot_alerts - - dependabot_security_updates - - advanced_security - - code_scanning_default_setup - - secret_scanning - - secret_scanning_push_protection - - name: enablement - in: path - description: |- - The action to take. - - `enable_all` means to enable the specified security feature for all repositories in the organization. - `disable_all` means to disable the specified security feature for all repositories in the organization. - required: true - schema: - type: string - enum: - - enable_all - - disable_all - requestBody: - required: false - content: - application/json: - schema: - properties: - query_suite: - description: |- - CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. - type: string - enum: - - default - - extended - examples: - default: - value: - responses: - '204': - description: Action started - '422': - description: The action could not be taken due to an in progress enablement, - or a policy is preventing enablement - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: orgs - subcategory: orgs - deprecationDate: '2024-07-22' - removalDate: '2025-07-22' - deprecated: true - "/rate_limit": - get: - summary: Get rate limit status for the authenticated user - description: |- - > [!NOTE] - > Accessing this endpoint does not count against your REST API rate limit. - - Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." - * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." - * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." - * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." - * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." - * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." - - > [!NOTE] - > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - tags: - - rate-limit - operationId: rate-limit/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - title: Rate Limit Overview - description: Rate Limit Overview - type: object - properties: - resources: - type: object - properties: - core: &346 - title: Rate Limit - type: object - properties: - limit: - type: integer - remaining: - type: integer - reset: - type: integer - used: - type: integer - required: - - limit - - remaining - - reset - - used - graphql: *346 - search: *346 - code_search: *346 - source_import: *346 - integration_manifest: *346 - code_scanning_upload: *346 - actions_runner_registration: *346 - scim: *346 - dependency_snapshots: *346 - dependency_sbom: *346 - code_scanning_autofix: *346 - required: - - core - - search - rate: *346 - required: - - rate - - resources - x-github-breaking-changes: - - changeset: remove_rate_limit_rate - patch: - properties: - rate: - required: - - resources - version: '2026-03-10' - examples: - default: - value: - resources: - core: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1691591363 - search: - limit: 30 - used: 12 - remaining: 18 - reset: 1691591091 - graphql: - limit: 5000 - used: 7 - remaining: 4993 - reset: 1691593228 - integration_manifest: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1691594631 - source_import: - limit: 100 - used: 1 - remaining: 99 - reset: 1691591091 - code_scanning_upload: - limit: 500 - used: 1 - remaining: 499 - reset: 1691594631 - actions_runner_registration: - limit: 10000 - used: 0 - remaining: 10000 - reset: 1691594631 - scim: - limit: 15000 - used: 0 - remaining: 15000 - reset: 1691594631 - dependency_snapshots: - limit: 100 - used: 0 - remaining: 100 - reset: 1691591091 - code_search: - limit: 10 - used: 0 - remaining: 10 - reset: 1691591091 - code_scanning_autofix: - limit: 10 - used: 0 - remaining: 10 - reset: 1691591091 - rate: - limit: 5000 - used: 1 - remaining: 4999 - reset: 1372700873 - headers: - X-RateLimit-Limit: - example: 5000 - schema: - type: integer - X-RateLimit-Remaining: - example: 4999 - schema: - type: integer - X-RateLimit-Reset: - example: 1590701888 - schema: - type: integer - format: timestamp - '304': *37 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: rate-limit - subcategory: rate-limit - "/repos/{owner}/{repo}": - get: - summary: Get a repository - description: |- - The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. - - > [!NOTE] - > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. - tags: - - repos - operationId: repos/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#get-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *347 - examples: - default-response: - summary: Default response - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - has_discussions: false - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - push: false - admin: false - allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - allow_forking: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - spdx_id: MIT - url: https://api.github.com/licenses/mit - node_id: MDc6TGljZW5zZW1pdA== - organization: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: Organization - site_admin: false - parent: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - source: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - security_and_analysis: - advanced_security: - status: enabled - secret_scanning: - status: enabled - secret_scanning_push_protection: - status: disabled - secret_scanning_non_provider_patterns: - status: disabled - secret_scanning_delegated_bypass: - status: disabled - secret_scanning_delegated_alert_dismissal: - status: disabled - '403': *29 - '404': *6 - '301': *348 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - patch: - summary: Update a repository - description: "**Note**: To edit a repository's topics, use the [Replace all - repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) - endpoint." - tags: - - repos - operationId: repos/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#update-a-repository - parameters: - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the repository. - description: - type: string - description: A short description of the repository. - homepage: - type: string - description: A URL with more information about the repository. - private: - type: boolean - description: "Either `true` to make the repository private or `false` - to make it public. Default: `false`. \n**Note**: You will get - a `422` error if the organization restricts [changing repository - visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) - to organization owners and a non-owner tries to change the value - of private." - default: false - visibility: - type: string - description: The visibility of the repository. - enum: - - public - - private - security_and_analysis: - type: object - description: |- - Specify which security and analysis features to enable or disable for the repository. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. - - You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - nullable: true - properties: - advanced_security: - type: object - description: |- - Use the `status` property to enable or disable GitHub Advanced Security for this repository. - For more information, see "[About GitHub Advanced - Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." - - For standalone Code Scanning or Secret Protection products, this parameter cannot be used. - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - code_security: - type: object - description: Use the `status` property to enable or disable - GitHub Code Security for this repository. - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning: - type: object - description: Use the `status` property to enable or disable - secret scanning for this repository. For more information, - see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning_push_protection: - type: object - description: Use the `status` property to enable or disable - secret scanning push protection for this repository. For more - information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning_ai_detection: - type: object - description: Use the `status` property to enable or disable - secret scanning AI detection for this repository. For more - information, see "[Responsible detection of generic secrets - with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning_non_provider_patterns: - type: object - description: Use the `status` property to enable or disable - secret scanning non-provider patterns for this repository. - For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning_delegated_alert_dismissal: - type: object - description: Use the `status` property to enable or disable - secret scanning delegated alert dismissal for this repository. - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning_delegated_bypass: - type: object - description: Use the `status` property to enable or disable - secret scanning delegated bypass for this repository. - properties: - status: - type: string - description: Can be `enabled` or `disabled`. - secret_scanning_delegated_bypass_options: - type: object - description: |- - Feature options for secret scanning delegated bypass. - This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. - You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. - properties: - reviewers: - type: array - description: |- - The bypass reviewers for secret scanning delegated bypass. - If you omit this field, the existing set of reviewers is unchanged. - items: - type: object - required: - - reviewer_id - - reviewer_type - properties: - reviewer_id: - type: integer - description: The ID of the team or role selected as - a bypass reviewer - reviewer_type: - type: string - description: The type of the bypass reviewer - enum: - - TEAM - - ROLE - mode: - type: string - description: The bypass mode for the reviewer - enum: - - ALWAYS - - EXEMPT - default: ALWAYS - has_issues: - type: boolean - description: Either `true` to enable issues for this repository - or `false` to disable them. - default: true - has_projects: - type: boolean - description: Either `true` to enable projects for this repository - or `false` to disable them. **Note:** If you're creating a repository - in an organization that has disabled repository projects, the - default is `false`, and if you pass `true`, the API returns an - error. - default: true - has_wiki: - type: boolean - description: Either `true` to enable the wiki for this repository - or `false` to disable it. - default: true - is_template: - type: boolean - description: Either `true` to make this repo available as a template - repository or `false` to prevent it. - default: false - default_branch: - type: string - description: Updates the default branch for this repository. - allow_squash_merge: - type: boolean - description: Either `true` to allow squash-merging pull requests, - or `false` to prevent squash-merging. - default: true - allow_merge_commit: - type: boolean - description: Either `true` to allow merging pull requests with a - merge commit, or `false` to prevent merging pull requests with - merge commits. - default: true - allow_rebase_merge: - type: boolean - description: Either `true` to allow rebase-merging pull requests, - or `false` to prevent rebase-merging. - default: true - allow_auto_merge: - type: boolean - description: Either `true` to allow auto-merge on pull requests, - or `false` to disallow auto-merge. - default: false - delete_branch_on_merge: - type: boolean - description: Either `true` to allow automatically deleting head - branches when pull requests are merged, or `false` to prevent - automatic deletion. - default: false - allow_update_branch: - type: boolean - description: Either `true` to always allow a pull request head branch - that is behind its base branch to be updated even if it is not - required to be up to date before merging, or false otherwise. - default: false - use_squash_pr_title_as_default: - type: boolean - description: Either `true` to allow squash-merge commits to use - pull request title, or `false` to use commit message. **This property - is closing down. Please use `squash_merge_commit_title` instead. - default: false - deprecated: true - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - Required when using `squash_merge_commit_message`. - - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - Required when using `merge_commit_message`. - - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - archived: - type: boolean - description: Whether to archive this repository. `false` will unarchive - a previously archived repository. - default: false - allow_forking: - type: boolean - description: Either `true` to allow private forks, or `false` to - prevent private forks. - default: false - web_commit_signoff_required: - type: boolean - description: Either `true` to require contributors to sign off on - web-based commits, or `false` to not require contributors to sign - off on web-based commits. - default: false - examples: - default: - value: - name: Hello-World - description: This is your first repository - homepage: https://github.com - private: true - has_issues: true - has_projects: true - has_wiki: true - responses: - '200': - description: Response - content: - application/json: - schema: *347 - examples: - default: *349 - '307': &350 - description: Temporary Redirect - content: - application/json: - schema: *3 - '403': *29 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - delete: - summary: Delete a repository - description: |- - Deleting a repository requires admin access. - - If an organization owner has configured the organization to prevent members from deleting organization-owned - repositories, you will get a `403 Forbidden` response. - - OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. - tags: - - repos - operationId: repos/delete - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#delete-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '403': - description: 'If an organization owner has configured the organization to - prevent members from deleting organization-owned repositories, a member - will get this response:' - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - default: - value: - message: Organization members cannot delete repositories. - documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *350 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/actions/artifacts": - get: - summary: List artifacts for a repository - description: |- - Lists all artifacts for a repository. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/list-artifacts-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository - parameters: - - *344 - - *345 - - *17 - - *19 - - &383 - name: name - description: The name field of an artifact. When specified, only artifacts - with this name will be returned. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - artifacts - properties: - total_count: - type: integer - artifacts: - type: array - items: &351 - title: Artifact - description: An artifact - type: object - properties: - id: - type: integer - example: 5 - node_id: - type: string - example: MDEwOkNoZWNrU3VpdGU1 - name: - description: The name of the artifact. - type: string - example: AdventureWorks.Framework - size_in_bytes: - description: The size in bytes of the artifact. - type: integer - example: 12345 - url: - type: string - example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 - archive_download_url: - type: string - example: https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip - expired: - description: Whether or not the artifact has expired. - type: boolean - created_at: - type: string - format: date-time - nullable: true - expires_at: - type: string - format: date-time - nullable: true - updated_at: - type: string - format: date-time - nullable: true - digest: - type: string - description: The SHA256 digest of the artifact. This field - will only be populated on artifacts uploaded with upload-artifact - v4 or newer. For older versions, this field will be null. - nullable: true - example: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c - workflow_run: - type: object - nullable: true - properties: - id: - example: 10 - type: integer - repository_id: - example: 42 - type: integer - head_repository_id: - example: 42 - type: integer - head_branch: - example: main - type: string - head_sha: - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - required: - - id - - node_id - - name - - size_in_bytes - - url - - archive_download_url - - expired - - created_at - - expires_at - - updated_at - examples: - default: &384 - value: - total_count: 2 - artifacts: - - id: 11 - node_id: MDg6QXJ0aWZhY3QxMQ== - name: Rails - size_in_bytes: 556 - url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 - archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip - expired: false - created_at: '2020-01-10T14:59:22Z' - expires_at: '2020-03-21T14:59:22Z' - updated_at: '2020-02-21T14:59:22Z' - digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c - workflow_run: - id: 2332938 - repository_id: 1296269 - head_repository_id: 1296269 - head_branch: main - head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 - - id: 13 - node_id: MDg6QXJ0aWZhY3QxMw== - name: Test output - size_in_bytes: 453 - url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 - archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip - expired: false - created_at: '2020-01-10T14:59:22Z' - expires_at: '2020-03-21T14:59:22Z' - updated_at: '2020-02-21T14:59:22Z' - digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c - workflow_run: - id: 2332942 - repository_id: 1296269 - head_repository_id: 1296269 - head_branch: main - head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: artifacts - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": - get: - summary: Get an artifact - description: |- - Gets a specific artifact for a workflow run. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-artifact - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/artifacts#get-an-artifact - parameters: - - *344 - - *345 - - &352 - name: artifact_id - description: The unique identifier of the artifact. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *351 - examples: - default: - value: - id: 11 - node_id: MDg6QXJ0aWZhY3QxMQ== - name: Rails - size_in_bytes: 556 - url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 - archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip - expired: false - created_at: '2020-01-10T14:59:22Z' - expires_at: '2020-01-21T14:59:22Z' - updated_at: '2020-01-21T14:59:22Z' - digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c - workflow_run: - id: 2332938 - repository_id: 1296269 - head_repository_id: 1296269 - head_branch: main - head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: artifacts - delete: - summary: Delete an artifact - description: |- - Deletes an artifact for a workflow run. - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-artifact - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact - parameters: - - *344 - - *345 - - *352 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: artifacts - "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": - get: - summary: Download an artifact - description: |- - Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - the response header to find the URL for the download. The `:archive_format` must be `zip`. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/download-artifact - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/artifacts#download-an-artifact - parameters: - - *344 - - *345 - - *352 - - name: archive_format - in: path - required: true - schema: - type: string - responses: - '302': - description: Response - headers: - Location: - example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D - schema: - type: string - '410': &546 - description: Gone - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: artifacts - "/repos/{owner}/{repo}/actions/cache/retention-limit": - get: - summary: Get GitHub Actions cache retention limit for a repository - description: |- - Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if - not manually removed or evicted due to size constraints. - - OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-retention-limit-for-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: &353 - title: Actions cache retention limit for a repository - description: GitHub Actions cache retention policy for a repository. - type: object - properties: - max_cache_retention_days: - description: The maximum number of days to keep caches in this - repository. - type: integer - example: 14 - examples: - default: *42 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - put: - summary: Set GitHub Actions cache retention limit for a repository - description: |- - Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if - not manually removed or evicted due to size constraints. - - OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. - tags: - - actions - operationId: actions/set-actions-cache-retention-limit-for-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: *353 - examples: - selected_actions: *42 - responses: - '204': - description: Response - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/repos/{owner}/{repo}/actions/cache/storage-limit": - get: - summary: Get GitHub Actions cache storage limit for a repository - description: |- - Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be - stored before eviction occurs. - - OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-storage-limit-for-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: &354 - title: Actions cache storage limit for a repository - description: GitHub Actions cache storage policy for a repository. - type: object - properties: - max_cache_size_gb: - description: The maximum total cache size for this repository, - in gigabytes. - type: integer - example: 10 - examples: - default: *44 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - put: - summary: Set GitHub Actions cache storage limit for a repository - description: |- - Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be - stored before eviction occurs. - - OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. - tags: - - actions - operationId: actions/set-actions-cache-storage-limit-for-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: *354 - examples: - selected_actions: *44 - responses: - '204': - description: Response - '400': *14 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/repos/{owner}/{repo}/actions/cache/usage": - get: - summary: Get GitHub Actions cache usage for a repository - description: |- - Gets GitHub Actions cache usage for a repository. - The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-usage - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *355 - examples: - default: - value: - full_name: octo-org/Hello-World - active_caches_size_in_bytes: 2322142 - active_caches_count: 3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/repos/{owner}/{repo}/actions/caches": - get: - summary: List GitHub Actions caches for a repository - description: |- - Lists the GitHub Actions caches for a repository. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-actions-cache-list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository - parameters: - - *344 - - *345 - - *17 - - *19 - - &356 - name: ref - description: The full Git reference for narrowing down the cache. The `ref` - for a branch should be formatted as `refs/heads/`. To reference - a pull request use `refs/pull//merge`. - in: query - required: false - schema: - type: string - - name: key - description: An explicit key or prefix for identifying the cache - in: query - required: false - schema: - type: string - - name: sort - description: The property to sort the results by. `created_at` means when - the cache was created. `last_accessed_at` means when the cache was last - accessed. `size_in_bytes` is the size of the cache in bytes. - in: query - required: false - schema: - type: string - enum: - - created_at - - last_accessed_at - - size_in_bytes - default: last_accessed_at - - *61 - responses: - '200': - description: Response - content: - application/json: - schema: &357 - title: Repository actions caches - description: Repository actions caches - type: object - properties: - total_count: - description: Total number of caches - type: integer - example: 2 - actions_caches: - description: Array of caches - type: array - items: - type: object - properties: - id: - type: integer - example: 2 - ref: - type: string - example: refs/heads/main - key: - type: string - example: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b - version: - type: string - example: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 - last_accessed_at: - type: string - format: date-time - example: '2019-01-24T22:45:36.000Z' - created_at: - type: string - format: date-time - example: '2019-01-24T22:45:36.000Z' - size_in_bytes: - type: integer - example: 1024 - required: - - total_count - - actions_caches - examples: - default: &358 - value: - total_count: 1 - actions_caches: - - id: 505 - ref: refs/heads/main - key: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b - version: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 - last_accessed_at: '2019-01-24T22:45:36.000Z' - created_at: '2019-01-24T22:45:36.000Z' - size_in_bytes: 1024 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: cache - delete: - summary: Delete GitHub Actions caches for a repository (using a cache key) - description: |- - Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-actions-cache-by-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key - parameters: - - *344 - - *345 - - name: key - description: A key for identifying the cache. - in: query - required: true - schema: - type: string - - *356 - responses: - '200': - description: Response - content: - application/json: - schema: *357 - examples: - default: *358 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/repos/{owner}/{repo}/actions/caches/{cache_id}": - delete: - summary: Delete a GitHub Actions cache for a repository (using a cache ID) - description: |- - Deletes a GitHub Actions cache for a repository, using a cache ID. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-actions-cache-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id - parameters: - - *344 - - *345 - - name: cache_id - description: The unique identifier of the GitHub Actions cache. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: cache - "/repos/{owner}/{repo}/actions/jobs/{job_id}": - get: - summary: Get a job for a workflow run - description: |- - Gets a specific job in a workflow run. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-job-for-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run - parameters: - - *344 - - *345 - - &359 - name: job_id - description: The unique identifier of the job. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &387 - title: Job - description: Information of a job execution in a workflow run - type: object - properties: - id: - description: The id of the job. - example: 21 - type: integer - run_id: - description: The id of the associated workflow run. - example: 5 - type: integer - run_url: - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5 - run_attempt: - type: integer - description: Attempt number of the associated workflow run, 1 - for first attempt and higher if the workflow was re-run. - example: 1 - node_id: - type: string - example: MDg6Q2hlY2tSdW40 - head_sha: - description: The SHA of the commit that is being run. - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - url: - type: string - example: https://api.github.com/repos/github/hello-world/actions/jobs/21 - html_url: - type: string - example: https://github.com/github/hello-world/runs/4 - nullable: true - status: - description: The phase of the lifecycle that the job is currently - in. - example: queued - type: string - enum: - - queued - - in_progress - - completed - - waiting - - requested - - pending - conclusion: - description: The outcome of the job. - example: success - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - skipped - - timed_out - - action_required - created_at: - description: The time that the job created, in ISO 8601 format. - example: '2019-08-08T08:00:00-07:00' - format: date-time - type: string - started_at: - description: The time that the job started, in ISO 8601 format. - example: '2019-08-08T08:00:00-07:00' - format: date-time - type: string - completed_at: - description: The time that the job finished, in ISO 8601 format. - example: '2019-08-08T08:00:00-07:00' - format: date-time - type: string - nullable: true - name: - description: The name of the job. - example: test-coverage - type: string - steps: - description: Steps in this job. - type: array - items: - type: object - required: - - name - - status - - conclusion - - number - properties: - status: - description: The phase of the lifecycle that the job is - currently in. - example: queued - type: string - enum: - - queued - - in_progress - - completed - conclusion: - description: The outcome of the job. - example: success - type: string - nullable: true - name: - description: The name of the job. - example: test-coverage - type: string - number: - type: integer - example: 1 - started_at: - description: The time that the step started, in ISO 8601 - format. - example: '2019-08-08T08:00:00-07:00' - format: date-time - type: string - nullable: true - completed_at: - description: The time that the job finished, in ISO 8601 - format. - example: '2019-08-08T08:00:00-07:00' - format: date-time - type: string - nullable: true - check_run_url: - type: string - example: https://api.github.com/repos/github/hello-world/check-runs/4 - labels: - type: array - items: - type: string - description: Labels for the workflow job. Specified by the "runs_on" - attribute in the action's workflow file. - example: - - self-hosted - - foo - - bar - runner_id: - type: integer - nullable: true - example: 1 - description: The ID of the runner to which this job has been assigned. - (If a runner hasn't yet been assigned, this will be null.) - runner_name: - type: string - nullable: true - example: my runner - description: The name of the runner to which this job has been - assigned. (If a runner hasn't yet been assigned, this will be - null.) - runner_group_id: - type: integer - nullable: true - example: 2 - description: The ID of the runner group to which this job has - been assigned. (If a runner hasn't yet been assigned, this will - be null.) - runner_group_name: - type: string - nullable: true - example: my runner group - description: The name of the runner group to which this job has - been assigned. (If a runner hasn't yet been assigned, this will - be null.) - workflow_name: - type: string - description: The name of the workflow. - nullable: true - example: Build - head_branch: - type: string - description: The name of the current branch. - nullable: true - example: main - required: - - id - - node_id - - run_id - - run_url - - head_sha - - workflow_name - - head_branch - - name - - url - - html_url - - status - - conclusion - - started_at - - completed_at - - check_run_url - - labels - - runner_id - - runner_name - - runner_group_id - - runner_group_name - - created_at - examples: - default: - value: - id: 399444496 - run_id: 29679449 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 - node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== - head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 - url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 - html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 - status: completed - conclusion: success - started_at: '2020-01-20T17:42:40Z' - completed_at: '2020-01-20T17:44:39Z' - name: build - steps: - - name: Set up job - status: completed - conclusion: success - number: 1 - started_at: '2020-01-20T09:42:40.000-08:00' - completed_at: '2020-01-20T09:42:41.000-08:00' - - name: Run actions/checkout@v2 - status: completed - conclusion: success - number: 2 - started_at: '2020-01-20T09:42:41.000-08:00' - completed_at: '2020-01-20T09:42:45.000-08:00' - - name: Set up Ruby - status: completed - conclusion: success - number: 3 - started_at: '2020-01-20T09:42:45.000-08:00' - completed_at: '2020-01-20T09:42:45.000-08:00' - - name: Run actions/cache@v3 - status: completed - conclusion: success - number: 4 - started_at: '2020-01-20T09:42:45.000-08:00' - completed_at: '2020-01-20T09:42:48.000-08:00' - - name: Install Bundler - status: completed - conclusion: success - number: 5 - started_at: '2020-01-20T09:42:48.000-08:00' - completed_at: '2020-01-20T09:42:52.000-08:00' - - name: Install Gems - status: completed - conclusion: success - number: 6 - started_at: '2020-01-20T09:42:52.000-08:00' - completed_at: '2020-01-20T09:42:53.000-08:00' - - name: Run Tests - status: completed - conclusion: success - number: 7 - started_at: '2020-01-20T09:42:53.000-08:00' - completed_at: '2020-01-20T09:42:59.000-08:00' - - name: Deploy to Heroku - status: completed - conclusion: success - number: 8 - started_at: '2020-01-20T09:42:59.000-08:00' - completed_at: '2020-01-20T09:44:39.000-08:00' - - name: Post actions/cache@v3 - status: completed - conclusion: success - number: 16 - started_at: '2020-01-20T09:44:39.000-08:00' - completed_at: '2020-01-20T09:44:39.000-08:00' - - name: Complete job - status: completed - conclusion: success - number: 17 - started_at: '2020-01-20T09:44:39.000-08:00' - completed_at: '2020-01-20T09:44:39.000-08:00' - check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 - labels: - - self-hosted - - foo - - bar - runner_id: 1 - runner_name: my runner - runner_group_id: 2 - runner_group_name: my runner group - workflow_name: CI - head_branch: main - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-jobs - "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": - get: - summary: Download job logs for a workflow run - description: |- - Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - for `Location:` in the response header to find the URL for the download. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/download-job-logs-for-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run - parameters: - - *344 - - *345 - - *359 - responses: - '302': - description: Response - headers: - Location: - example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-jobs - "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": - post: - summary: Re-run a job from a workflow run - description: |- - Re-run a job and its dependent jobs in a workflow run. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/re-run-job-for-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run - parameters: - - *344 - - *345 - - *359 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - enable_debug_logging: - type: boolean - default: false - description: Whether to enable debug logging for the re-run. - examples: - default: - value: - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/oidc/customization/sub": - get: - summary: Get the customization template for an OIDC subject claim for a repository - description: |- - Gets the customization template for an OpenID Connect (OIDC) subject claim. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-custom-oidc-sub-claim-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Status response - content: - application/json: - schema: - title: Actions OIDC subject customization for a repository - description: Actions OIDC subject customization for a repository - type: object - properties: - use_default: - description: Whether to use the default template or not. If `true`, - the `include_claim_keys` field is ignored. - type: boolean - include_claim_keys: - description: Array of unique strings. Each claim key can only - contain alphanumeric characters and underscores. - type: array - items: - type: string - required: - - use_default - examples: - default: - value: - use_default: false - include_claim_keys: - - repo - - context - '400': *14 - '404': *6 - x-github: - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: oidc - put: - summary: Set the customization template for an OIDC subject claim for a repository - description: |- - Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/set-custom-oidc-sub-claim-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - title: Actions OIDC subject customization for a repository - description: Actions OIDC subject customization for a repository - type: object - required: - - use_default - properties: - use_default: - description: Whether to use the default template or not. If `true`, - the `include_claim_keys` field is ignored. - type: boolean - include_claim_keys: - description: Array of unique strings. Each claim key can only contain - alphanumeric characters and underscores. - type: array - items: - type: string - examples: - default: - value: - use_default: false - include_claim_keys: - - repo - - context - responses: - '201': - description: Empty response - content: - application/json: - schema: *169 - examples: - default: - value: - '404': *6 - '400': *14 - '422': *7 - x-github: - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: oidc - "/repos/{owner}/{repo}/actions/organization-secrets": - get: - summary: List repository organization secrets - description: |- - Lists all organization secrets shared with a repository without revealing their encrypted - values. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-repo-organization-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &389 - title: Actions Secret - description: Set secrets for GitHub Actions. - type: object - properties: - name: - description: The name of the secret. - example: SECRET_TOKEN - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - created_at - - updated_at - examples: - default: &390 - value: - total_count: 2 - secrets: - - name: GH_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - - name: GIST_ID - created_at: '2020-01-10T10:59:22Z' - updated_at: '2020-01-11T11:59:22Z' - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/actions/organization-variables": - get: - summary: List repository organization variables - description: |- - Lists all organization variables shared with a repository. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-repo-organization-variables - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables - parameters: - - *344 - - *345 - - *360 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - variables - properties: - total_count: - type: integer - variables: - type: array - items: &393 - title: Actions Variable - type: object - properties: - name: - description: The name of the variable. - example: USERNAME - type: string - value: - description: The value of the variable. - example: octocat - type: string - created_at: - description: The date and time at which the variable was - created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - example: '2019-01-24T22:45:36.000Z' - updated_at: - description: The date and time at which the variable was - last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - example: '2019-01-24T22:45:36.000Z' - required: - - name - - value - - created_at - - updated_at - examples: - default: &394 - value: - total_count: 2 - variables: - - name: USERNAME - value: octocat - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - - name: EMAIL - value: octocat@github.com - created_at: '2020-01-10T10:59:22Z' - updated_at: '2020-01-11T11:59:22Z' - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repos/{owner}/{repo}/actions/permissions": - get: - summary: Get GitHub Actions permissions for a repository - description: |- - Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-github-actions-permissions-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - enabled: &362 - type: boolean - description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *145 - selected_actions_url: *361 - sha_pinning_required: *146 - required: - - enabled - examples: - default: - value: - enabled: true - allowed_actions: selected - selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions - sha_pinning_required: true - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - put: - summary: Set GitHub Actions permissions for a repository - description: |- - Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-github-actions-permissions-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Response - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - enabled: *362 - allowed_actions: *145 - sha_pinning_required: *146 - required: - - enabled - examples: - default: - value: - enabled: true - allowed_actions: selected - sha_pinning_required: true - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/access": - get: - summary: Get the level of access for workflows outside of the repository - description: |- - Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. - This endpoint only applies to private repositories. - For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-workflow-access-to-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: &363 - type: object - properties: - access_level: - type: string - description: |- - Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the - repository. - - `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. - enum: - - none - - user - - organization - required: - - access_level - examples: - default: &364 - value: - access_level: organization - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: permissions - put: - summary: Set the level of access for workflows outside of the repository - description: |- - Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. - This endpoint only applies to private repositories. - For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/set-workflow-access-to-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: *363 - examples: - default: *364 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": - get: - summary: Get artifact and log retention settings for a repository - description: |- - Gets artifact and log retention settings for a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-artifact-and-log-retention-settings-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *365 - examples: - default: - value: - days: 90 - maximum_allowed_days: 365 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set artifact and log retention settings for a repository - description: |- - Sets artifact and log retention settings for a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-artifact-and-log-retention-settings-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Empty response for successful settings update - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *366 - examples: - default: - summary: Set retention days - value: - days: 90 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": - get: - summary: Get fork PR contributor approval permissions for a repository - description: |- - Gets the fork PR contributor approval policy for a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-fork-pr-contributor-approval-permissions-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *147 - examples: - default: *367 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set fork PR contributor approval permissions for a repository - description: |- - Sets the fork PR contributor approval policy for a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-fork-pr-contributor-approval-permissions-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '404': *6 - '422': *15 - requestBody: - required: true - content: - application/json: - schema: *147 - examples: - default: - summary: Set approval policy to first time contributors - value: - approval_policy: first_time_contributors - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": - get: - summary: Get private repo fork PR workflow settings for a repository - description: |- - Gets the settings for whether workflows from fork pull requests can run on a private repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-private-repo-fork-pr-workflows-settings-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *368 - examples: - default: *148 - '403': *29 - '404': *6 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set private repo fork PR workflow settings for a repository - description: |- - Sets the settings for whether workflows from fork pull requests can run on a private repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-private-repo-fork-pr-workflows-settings-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: *369 - examples: - default: *148 - responses: - '204': - description: Empty response for successful settings update - '404': *6 - '422': *15 - x-github: - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/selected-actions": - get: - summary: Get allowed actions and reusable workflows for a repository - description: |- - Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-allowed-actions-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *150 - examples: - default: *151 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - put: - summary: Set allowed actions and reusable workflows for a repository - description: |- - Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-allowed-actions-repository - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Response - requestBody: - required: false - content: - application/json: - schema: *150 - examples: - selected_actions: *151 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/workflow": - get: - summary: Get default workflow permissions for a repository - description: |- - Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - as well as if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-github-actions-default-workflow-permissions-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *370 - examples: - default: *155 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: permissions - put: - summary: Set default workflow permissions for a repository - description: |- - Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/set-github-actions-default-workflow-permissions-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Success response - '409': - description: Conflict response when changing a setting is prevented by the - owning organization - requestBody: - required: true - content: - application/json: - schema: *371 - examples: - default: *155 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: permissions - "/repos/{owner}/{repo}/actions/runners": - get: - summary: List self-hosted runners for a repository - description: |- - Lists all self-hosted runners configured in a repository. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-self-hosted-runners-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository - parameters: - - name: name - description: The name of a self-hosted runner. - in: query - schema: - type: string - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - runners - properties: - total_count: - type: integer - runners: - type: array - items: *162 - examples: - default: *163 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/downloads": - get: - summary: List runner applications for a repository - description: |- - Lists binaries for the runner application that you can download and run. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-runner-applications-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *372 - examples: - default: *373 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": - post: - summary: Create configuration for a just-in-time runner for a repository - description: |- - Generates a configuration that can be passed to the runner application at startup. - - The authenticated user must have admin access to the repository. - - OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. - tags: - - actions - operationId: actions/generate-runner-jitconfig-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - name - - runner_group_id - - labels - properties: - name: - type: string - description: The name of the new runner. - runner_group_id: - type: integer - description: The ID of the runner group to register the runner to. - labels: - type: array - minItems: 1 - maxItems: 100 - items: - type: string - description: 'The names of the custom labels to add to the runner. - **Minimum items**: 1. **Maximum items**: 100.' - work_folder: - type: string - description: The working directory to be used for job execution, - relative to the runner install directory. - default: _work - examples: - default: - value: - name: New runner - runner_group_id: 1 - labels: - - self-hosted - - X64 - - macOS - - no-gpu - work_folder: _work - responses: - '201': *374 - '404': *6 - '422': *7 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/registration-token": - post: - summary: Create a registration token for a repository - description: |- - Returns a token that you can pass to the `config` script. The token expires after one hour. - - For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - - ``` - ./config.sh --url https://github.com/octo-org --token TOKEN - ``` - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-registration-token-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository - parameters: - - *344 - - *345 - responses: - '201': - description: Response - content: - application/json: - schema: *164 - examples: - default: *375 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/remove-token": - post: - summary: Create a remove token for a repository - description: |- - Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - - For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - - ``` - ./config.sh remove --token TOKEN - ``` - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-remove-token-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository - parameters: - - *344 - - *345 - responses: - '201': - description: Response - content: - application/json: - schema: *164 - examples: - default: *376 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/{runner_id}": - get: - summary: Get a self-hosted runner for a repository - description: |- - Gets a specific self-hosted runner configured in a repository. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-self-hosted-runner-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository - parameters: - - *344 - - *345 - - *161 - responses: - '200': - description: Response - content: - application/json: - schema: *162 - examples: - default: *377 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - delete: - summary: Delete a self-hosted runner from a repository - description: |- - Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-self-hosted-runner-from-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository - parameters: - - *344 - - *345 - - *161 - responses: - '204': - description: Response - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": - get: - summary: List labels for a self-hosted runner for a repository - description: |- - Lists all labels for a self-hosted runner configured in a repository. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-labels-for-self-hosted-runner-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository - parameters: - - *344 - - *345 - - *161 - responses: - '200': *166 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - post: - summary: Add custom labels to a self-hosted runner for a repository - description: |- - Adds custom labels to a self-hosted runner configured in a repository. - - Authenticated users must have admin access to the organization to use this endpoint. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository - parameters: - - *344 - - *345 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - labels - properties: - labels: - type: array - minItems: 1 - maxItems: 100 - description: The names of the custom labels to add to the runner. - items: - type: string - examples: - default: - value: - labels: - - gpu - - accelerated - responses: - '200': *166 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - put: - summary: Set custom labels for a self-hosted runner for a repository - description: |- - Remove all previous custom labels and set the new custom labels for a specific - self-hosted runner configured in a repository. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository - parameters: - - *344 - - *345 - - *161 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - labels - properties: - labels: - type: array - minItems: 0 - maxItems: 100 - description: The names of the custom labels to set for the runner. - You can pass an empty array to remove all custom labels. - items: - type: string - examples: - default: - value: - labels: - - gpu - - accelerated - responses: - '200': *166 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - delete: - summary: Remove all custom labels from a self-hosted runner for a repository - description: |- - Remove all custom labels from a self-hosted runner configured in a - repository. Returns the remaining read-only labels from the runner. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository - parameters: - - *344 - - *345 - - *161 - responses: - '200': *378 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": - delete: - summary: Remove a custom label from a self-hosted runner for a repository - description: |- - Remove a custom label from a self-hosted runner configured - in a repository. Returns the remaining labels from the runner. - - This endpoint returns a `404 Not Found` status if the custom label is not - present on the runner. - - Authenticated users must have admin access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository - parameters: - - *344 - - *345 - - *161 - - *379 - responses: - '200': *166 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runs": - get: - summary: List workflow runs for a repository - description: |- - Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - - This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - tags: - - actions - operationId: actions/list-workflow-runs-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository - parameters: - - *344 - - *345 - - &397 - name: actor - description: Returns someone's workflow runs. Use the login for the user who - created the `push` associated with the check suite or workflow run. - in: query - required: false - schema: - type: string - - &398 - name: branch - description: Returns workflow runs associated with a branch. Use the name - of the branch of the `push`. - in: query - required: false - schema: - type: string - - &399 - name: event - description: Returns workflow run triggered by the event you specify. For - example, `push`, `pull_request` or `issue`. For more information, see "[Events - that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." - in: query - required: false - schema: - type: string - - &400 - name: status - description: Returns workflow runs with the check run `status` or `conclusion` - that you specify. For example, a conclusion can be `success` or a status - can be `in_progress`. Only GitHub Actions can set a status of `waiting`, - `pending`, or `requested`. - in: query - required: false - schema: - type: string - enum: - - completed - - action_required - - cancelled - - failure - - neutral - - skipped - - stale - - success - - timed_out - - in_progress - - queued - - requested - - waiting - - pending - - *17 - - *19 - - &401 - name: created - description: Returns workflow runs created within the given date-time range. - For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - in: query - required: false - schema: - type: string - format: date-time - - &380 - name: exclude_pull_requests - description: If `true` pull requests are omitted from the response (empty - array). - in: query - required: false - schema: - type: boolean - default: false - - &402 - name: check_suite_id - description: Returns workflow runs with the `check_suite_id` that you specify. - in: query - schema: - type: integer - - &403 - name: head_sha - description: Only returns workflow runs that are associated with the specified - `head_sha`. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - workflow_runs - properties: - total_count: - type: integer - workflow_runs: - type: array - items: &381 - title: Workflow Run - description: An invocation of a workflow - type: object - properties: - id: - type: integer - description: The ID of the workflow run. - example: 5 - name: - type: string - description: The name of the workflow run. - nullable: true - example: Build - node_id: - type: string - example: MDEwOkNoZWNrU3VpdGU1 - check_suite_id: - type: integer - description: The ID of the associated check suite. - example: 42 - check_suite_node_id: - type: string - description: The node ID of the associated check suite. - example: MDEwOkNoZWNrU3VpdGU0Mg== - head_branch: - type: string - nullable: true - example: master - head_sha: - description: The SHA of the head commit that points to the - version of the workflow being run. - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - path: - description: The full path of the workflow - example: octocat/octo-repo/.github/workflows/ci.yml@main - type: string - run_number: - type: integer - description: The auto incrementing run number for the workflow - run. - example: 106 - run_attempt: - type: integer - description: Attempt number of the run, 1 for first attempt - and higher if the workflow was re-run. - example: 1 - referenced_workflows: - type: array - nullable: true - items: - title: Referenced workflow - description: A workflow referenced/reused by the initial - caller workflow - type: object - properties: - path: - type: string - sha: - type: string - ref: - type: string - required: - - path - - sha - event: - type: string - example: push - status: - type: string - nullable: true - example: completed - conclusion: - type: string - nullable: true - example: neutral - workflow_id: - type: integer - description: The ID of the parent workflow. - example: 5 - url: - type: string - description: The URL to the workflow run. - example: https://api.github.com/repos/github/hello-world/actions/runs/5 - html_url: - type: string - example: https://github.com/github/hello-world/suites/4 - pull_requests: - description: Pull requests that are open with a `head_sha` - or `head_branch` that matches the workflow run. The returned - pull requests do not necessarily indicate pull requests - that triggered the run. - type: array - nullable: true - items: *90 - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - actor: *4 - triggering_actor: *4 - run_started_at: - type: string - format: date-time - description: The start time of the latest run. Resets on - re-run. - jobs_url: - description: The URL to the jobs for the workflow run. - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs - logs_url: - description: The URL to download the logs for the workflow - run. - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs - check_suite_url: - description: The URL to the associated check suite. - type: string - example: https://api.github.com/repos/github/hello-world/check-suites/12 - artifacts_url: - description: The URL to the artifacts for the workflow run. - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts - cancel_url: - description: The URL to cancel the workflow run. - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel - rerun_url: - description: The URL to rerun the workflow run. - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun - previous_attempt_url: - nullable: true - description: The URL to the previous attempted run of this - workflow, if one exists. - type: string - example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 - workflow_url: - description: The URL to the workflow. - type: string - example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml - head_commit: - title: Simple Commit - description: A commit. - type: object - properties: &425 - id: - type: string - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - tree_id: - type: string - description: SHA for the commit's tree - message: - description: Message describing the purpose of the commit - example: 'Fix #42' - type: string - timestamp: - description: Timestamp of the commit - example: '2014-08-09T08:02:04+12:00' - format: date-time - type: string - author: - type: object - description: Information about the Git author - properties: - name: - description: Name of the commit's author - example: Monalisa Octocat - type: string - email: - description: Git email address of the commit's author - example: monalisa.octocat@example.com - type: string - format: email - required: - - name - - email - nullable: true - committer: - type: object - description: Information about the Git committer - properties: - name: - description: Name of the commit's committer - example: Monalisa Octocat - type: string - email: - description: Git email address of the commit's committer - example: monalisa.octocat@example.com - type: string - format: email - required: - - name - - email - nullable: true - required: &426 - - id - - tree_id - - message - - timestamp - - author - - committer - nullable: true - repository: *160 - head_repository: *160 - head_repository_id: - type: integer - example: 5 - display_title: - type: string - example: Simple Workflow - description: The event-specific title associated with the - run or the run-name if set, or the value of `run-name` - if it is set in the workflow. - required: - - id - - node_id - - head_branch - - run_number - - display_title - - event - - status - - conclusion - - head_sha - - path - - workflow_id - - url - - html_url - - created_at - - updated_at - - head_commit - - head_repository - - repository - - jobs_url - - logs_url - - check_suite_url - - cancel_url - - rerun_url - - artifacts_url - - workflow_url - - pull_requests - examples: - default: &404 - value: - total_count: 1 - workflow_runs: - - id: 30433642 - name: Build - node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== - check_suite_id: 42 - check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== - head_branch: master - head_sha: acb5820ced9479c074f688cc328bf03f341a511d - path: ".github/workflows/build.yml@main" - run_number: 562 - event: push - display_title: Update README.md - status: queued - conclusion: - workflow_id: 159038 - url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 - html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 - pull_requests: [] - created_at: '2020-01-22T19:33:08Z' - updated_at: '2020-01-22T19:33:08Z' - actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - run_attempt: 1 - run_started_at: '2020-01-22T19:33:08Z' - triggering_actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs - logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs - check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 - artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts - cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel - rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun - workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 - head_commit: - id: acb5820ced9479c074f688cc328bf03f341a511d - tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 - message: Create linter.yaml - timestamp: '2020-01-22T19:33:05Z' - author: - name: Octo Cat - email: octocat@github.com - committer: - name: GitHub - email: noreply@github.com - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - head_repository: - id: 217723378 - node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= - name: octo-repo - full_name: octo-org/octo-repo - private: true - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - html_url: https://github.com/octo-org/octo-repo - description: - fork: false - url: https://api.github.com/repos/octo-org/octo-repo - forks_url: https://api.github.com/repos/octo-org/octo-repo/forks - keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} - collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} - teams_url: https://api.github.com/repos/octo-org/octo-repo/teams - hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks - issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} - events_url: https://api.github.com/repos/octo-org/octo-repo/events - assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} - branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} - tags_url: https://api.github.com/repos/octo-org/octo-repo/tags - blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} - git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} - trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} - statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} - languages_url: https://api.github.com/repos/octo-org/octo-repo/languages - stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers - contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors - subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers - subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription - commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} - git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} - comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} - issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} - contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} - compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} - merges_url: https://api.github.com/repos/octo-org/octo-repo/merges - archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads - issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} - pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} - milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} - releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} - deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}": - get: - summary: Get a workflow run - description: |- - Gets a specific workflow run. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/get-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run - parameters: - - *344 - - *345 - - &382 - name: run_id - description: The unique identifier of the workflow run. - in: path - required: true - schema: - type: integer - - *380 - responses: - '200': - description: Response - content: - application/json: - schema: *381 - examples: - default: &385 - value: - id: 30433642 - name: Build - node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== - check_suite_id: 42 - check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== - head_branch: main - head_sha: acb5820ced9479c074f688cc328bf03f341a511d - path: ".github/workflows/build.yml@main" - run_number: 562 - event: push - display_title: Update README.md - status: queued - conclusion: - workflow_id: 159038 - url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 - html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 - pull_requests: [] - created_at: '2020-01-22T19:33:08Z' - updated_at: '2020-01-22T19:33:08Z' - actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - run_attempt: 1 - referenced_workflows: - - path: octocat/Hello-World/.github/workflows/deploy.yml@main - sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db - ref: refs/heads/main - - path: octo-org/octo-repo/.github/workflows/report.yml@v2 - sha: 79e9790903e1c3373b1a3e3a941d57405478a232 - ref: refs/tags/v2 - - path: octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e - sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e - run_started_at: '2020-01-22T19:33:08Z' - triggering_actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs - logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs - check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 - artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts - cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel - rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun - previous_attempt_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 - workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 - head_commit: - id: acb5820ced9479c074f688cc328bf03f341a511d - tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 - message: Create linter.yaml - timestamp: '2020-01-22T19:33:05Z' - author: - name: Octo Cat - email: octocat@github.com - committer: - name: GitHub - email: noreply@github.com - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - head_repository: - id: 217723378 - node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= - name: octo-repo - full_name: octo-org/octo-repo - private: true - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - html_url: https://github.com/octo-org/octo-repo - description: - fork: false - url: https://api.github.com/repos/octo-org/octo-repo - forks_url: https://api.github.com/repos/octo-org/octo-repo/forks - keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} - collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} - teams_url: https://api.github.com/repos/octo-org/octo-repo/teams - hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks - issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} - events_url: https://api.github.com/repos/octo-org/octo-repo/events - assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} - branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} - tags_url: https://api.github.com/repos/octo-org/octo-repo/tags - blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} - git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} - trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} - statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} - languages_url: https://api.github.com/repos/octo-org/octo-repo/languages - stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers - contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors - subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers - subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription - commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} - git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} - comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} - issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} - contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} - compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} - merges_url: https://api.github.com/repos/octo-org/octo-repo/merges - archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads - issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} - pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} - milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} - releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} - deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - delete: - summary: Delete a workflow run - description: |- - Deletes a specific workflow run. - - Anyone with write access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/delete-workflow-run - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run - parameters: - - *344 - - *345 - - *382 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": - get: - summary: Get the review history for a workflow run - description: |- - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/get-reviews-for-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run - parameters: - - *344 - - *345 - - *382 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Environment Approval - description: An entry in the reviews log for environment deployments - type: object - properties: - environments: - description: The list of environments that were approved or - rejected - type: array - items: - type: object - properties: - id: - description: The id of the environment. - example: 56780428 - type: integer - node_id: - type: string - example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= - name: - description: The name of the environment. - example: staging - type: string - url: - type: string - example: https://api.github.com/repos/github/hello-world/environments/staging - html_url: - type: string - example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - created_at: - description: The time that the environment was created, - in ISO 8601 format. - example: '2020-11-23T22:00:40Z' - format: date-time - type: string - updated_at: - description: The time that the environment was last updated, - in ISO 8601 format. - example: '2020-11-23T22:00:40Z' - format: date-time - type: string - state: - description: Whether deployment to the environment(s) was approved - or rejected or pending (with comments) - enum: - - approved - - rejected - - pending - example: approved - type: string - user: *4 - comment: - type: string - description: The comment submitted with the deployment review - example: Ship it! - required: - - environments - - state - - user - - comment - examples: - default: - value: - - state: approved - comment: Ship it! - environments: - - id: 161088068 - node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 - name: staging - url: https://api.github.com/repos/github/hello-world/environments/staging - html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - created_at: '2020-11-23T22:00:40Z' - updated_at: '2020-11-23T22:00:40Z' - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": - post: - summary: Approve a workflow run for a fork pull request - description: |- - Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/approve-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request - parameters: - - *344 - - *345 - - *382 - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": - get: - summary: List workflow run artifacts - description: |- - Lists artifacts for a workflow run. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/list-workflow-run-artifacts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts - parameters: - - *344 - - *345 - - *382 - - *17 - - *19 - - *383 - - *61 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - artifacts - properties: - total_count: - type: integer - artifacts: - type: array - items: *351 - examples: - default: *384 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: artifacts - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": - get: - summary: Get a workflow run attempt - description: |- - Gets a specific workflow run attempt. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/get-workflow-run-attempt - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt - parameters: - - *344 - - *345 - - *382 - - &386 - name: attempt_number - description: The attempt number of the workflow run. - in: path - required: true - schema: - type: integer - - *380 - responses: - '200': - description: Response - content: - application/json: - schema: *381 - examples: - default: *385 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": - get: - summary: List jobs for a workflow run attempt - description: |- - Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/list-jobs-for-workflow-run-attempt - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt - parameters: - - *344 - - *345 - - *382 - - *386 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - jobs - properties: - total_count: - type: integer - jobs: - type: array - items: *387 - examples: - default: &388 - value: - total_count: 1 - jobs: - - id: 399444496 - run_id: 29679449 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 - node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== - head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 - url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 - html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 - status: completed - conclusion: success - started_at: '2020-01-20T17:42:40Z' - completed_at: '2020-01-20T17:44:39Z' - name: build - steps: - - name: Set up job - status: completed - conclusion: success - number: 1 - started_at: '2020-01-20T09:42:40.000-08:00' - completed_at: '2020-01-20T09:42:41.000-08:00' - - name: Run actions/checkout@v2 - status: completed - conclusion: success - number: 2 - started_at: '2020-01-20T09:42:41.000-08:00' - completed_at: '2020-01-20T09:42:45.000-08:00' - - name: Set up Ruby - status: completed - conclusion: success - number: 3 - started_at: '2020-01-20T09:42:45.000-08:00' - completed_at: '2020-01-20T09:42:45.000-08:00' - - name: Run actions/cache@v3 - status: completed - conclusion: success - number: 4 - started_at: '2020-01-20T09:42:45.000-08:00' - completed_at: '2020-01-20T09:42:48.000-08:00' - - name: Install Bundler - status: completed - conclusion: success - number: 5 - started_at: '2020-01-20T09:42:48.000-08:00' - completed_at: '2020-01-20T09:42:52.000-08:00' - - name: Install Gems - status: completed - conclusion: success - number: 6 - started_at: '2020-01-20T09:42:52.000-08:00' - completed_at: '2020-01-20T09:42:53.000-08:00' - - name: Run Tests - status: completed - conclusion: success - number: 7 - started_at: '2020-01-20T09:42:53.000-08:00' - completed_at: '2020-01-20T09:42:59.000-08:00' - - name: Deploy to Heroku - status: completed - conclusion: success - number: 8 - started_at: '2020-01-20T09:42:59.000-08:00' - completed_at: '2020-01-20T09:44:39.000-08:00' - - name: Post actions/cache@v3 - status: completed - conclusion: success - number: 16 - started_at: '2020-01-20T09:44:39.000-08:00' - completed_at: '2020-01-20T09:44:39.000-08:00' - - name: Complete job - status: completed - conclusion: success - number: 17 - started_at: '2020-01-20T09:44:39.000-08:00' - completed_at: '2020-01-20T09:44:39.000-08:00' - check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 - labels: - - self-hosted - - foo - - bar - runner_id: 1 - runner_name: my runner - runner_group_id: 2 - runner_group_name: my runner group - workflow_name: CI - head_branch: main - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-jobs - "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": - get: - summary: Download workflow run attempt logs - description: |- - Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - 1 minute. Look for `Location:` in the response header to find the URL for the download. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/download-workflow-run-attempt-logs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs - parameters: - - *344 - - *345 - - *382 - - *386 - responses: - '302': - description: Response - headers: - Location: - example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": - post: - summary: Cancel a workflow run - description: |- - Cancels a workflow run using its `id`. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/cancel-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run - parameters: - - *344 - - *345 - - *382 - responses: - '202': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": - post: - summary: Review custom deployment protection rules for a workflow run - description: |- - Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - - > [!NOTE] - > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/review-custom-gates-for-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run - parameters: - - *344 - - *345 - - *382 - requestBody: - required: true - content: - application/json: - schema: - anyOf: - - type: object - properties: - environment_name: - type: string - description: The name of the environment to approve or reject. - comment: - type: string - description: Comment associated with the pending deployment protection - rule. **Required when state is not provided.** - required: - - environment_name - - comment - - type: object - properties: - environment_name: - type: string - description: The name of the environment to approve or reject. - state: - type: string - description: Whether to approve or reject deployment to the specified - environments. - enum: - - approved - - rejected - comment: - type: string - description: Optional comment to include with the review. - required: - - environment_name - - state - examples: - default: - value: - environment_name: prod-eus - state: approved - comment: All health checks passed. - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": - post: - summary: Force cancel a workflow run - description: |- - Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/force-cancel-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run - parameters: - - *344 - - *345 - - *382 - responses: - '202': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": - get: - summary: List jobs for a workflow run - description: |- - Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/list-jobs-for-workflow-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run - parameters: - - *344 - - *345 - - *382 - - name: filter - description: Filters jobs by their `completed_at` timestamp. `latest` returns - jobs from the most recent execution of the workflow run. `all` returns all - jobs for a workflow run, including from old executions of the workflow run. - in: query - required: false - schema: - type: string - enum: - - latest - - all - default: latest - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - jobs - properties: - total_count: - type: integer - jobs: - type: array - items: *387 - examples: - default: *388 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-jobs - "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": - get: - summary: Download workflow run logs - description: |- - Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - `Location:` in the response header to find the URL for the download. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/download-workflow-run-logs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs - parameters: - - *344 - - *345 - - *382 - responses: - '302': - description: Response - headers: - Location: - example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - delete: - summary: Delete workflow run logs - description: |- - Deletes all logs for a workflow run. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-workflow-run-logs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs - parameters: - - *344 - - *345 - - *382 - responses: - '204': - description: Response - '403': *29 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": - get: - summary: Get pending deployments for a workflow run - description: |- - Get all deployment environments for a workflow run that are waiting for protection rules to pass. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-pending-deployments-for-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run - parameters: - - *344 - - *345 - - *382 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Pending Deployment - description: Details of a deployment that is waiting for protection - rules to pass - type: object - properties: - environment: - type: object - properties: - id: - description: The id of the environment. - type: integer - format: int64 - example: 56780428 - node_id: - type: string - example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= - name: - description: The name of the environment. - example: staging - type: string - url: - type: string - example: https://api.github.com/repos/github/hello-world/environments/staging - html_url: - type: string - example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - wait_timer: - type: integer - description: The set duration of the wait timer - example: 30 - wait_timer_started_at: - description: The time that the wait timer began. - example: '2020-11-23T22:00:40Z' - format: date-time - type: string - nullable: true - current_user_can_approve: - description: Whether the currently authenticated user can approve - the deployment - type: boolean - example: true - reviewers: - type: array - description: The people or teams that may approve jobs that - reference the environment. You can list up to six users or - teams as reviewers. The reviewers must have at least read - access to the repository. Only one of the required reviewers - needs to approve the job for it to proceed. - items: - type: object - properties: - type: &512 - type: string - description: The type of reviewer. - enum: - - User - - Team - example: User - reviewer: - anyOf: - - *4 - - *197 - required: - - environment - - wait_timer - - wait_timer_started_at - - current_user_can_approve - - reviewers - examples: - default: - value: - - environment: - id: 161088068 - node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 - name: staging - url: https://api.github.com/repos/github/hello-world/environments/staging - html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - wait_timer: 30 - wait_timer_started_at: '2020-11-23T22:00:40Z' - current_user_can_approve: true - reviewers: - - type: User - reviewer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - type: Team - reviewer: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - post: - summary: Review pending deployments for a workflow run - description: |- - Approve or reject pending deployments that are waiting on approval by a required reviewer. - - Required reviewers with read access to the repository contents and deployments can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/review-pending-deployments-for-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run - parameters: - - *344 - - *345 - - *382 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - environment_ids: - type: array - description: The list of environment ids to approve or reject - example: - - 161171787 - - 161171795 - items: - type: integer - example: 161171787 - state: - type: string - description: Whether to approve or reject deployment to the specified - environments. - enum: - - approved - - rejected - example: approved - comment: - type: string - description: A comment to accompany the deployment review - example: Ship it! - required: - - environment_ids - - state - - comment - examples: - default: - value: - environment_ids: - - 161171787 - state: approved - comment: Ship it! - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &507 - title: Deployment - description: A request for a specific ref(branch,sha,tag) to be - deployed - type: object - properties: &754 - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/deployments/1 - id: - description: Unique identifier of the deployment - type: integer - format: int64 - example: 42 - node_id: - type: string - example: MDEwOkRlcGxveW1lbnQx - sha: - type: string - example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - ref: - description: The ref to deploy. This can be a branch, tag, or - sha. - example: topic-branch - type: string - task: - description: Parameter to specify a task to execute - example: deploy - type: string - payload: - oneOf: - - type: object - additionalProperties: true - - type: string - original_environment: - type: string - example: staging - environment: - description: Name for the target deployment environment. - example: production - type: string - description: - type: string - example: Deploy request from hubot - nullable: true - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2012-07-20T01:19:13Z' - updated_at: - type: string - format: date-time - example: '2012-07-20T01:19:13Z' - statuses_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/deployments/1/statuses - repository_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example - transient_environment: - description: 'Specifies if the given environment is will no - longer exist at some point in the future. Default: false.' - example: true - type: boolean - production_environment: - description: 'Specifies if the given environment is one that - end-users directly interact with. Default: false.' - example: true - type: boolean - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - required: &755 - - id - - node_id - - sha - - ref - - task - - environment - - creator - - payload - - description - - statuses_url - - repository_url - - url - - created_at - - updated_at - examples: - default: &508 - value: - - url: https://api.github.com/repos/octocat/example/deployments/1 - id: 1 - node_id: MDEwOkRlcGxveW1lbnQx - sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - ref: topic-branch - task: deploy - payload: {} - original_environment: staging - environment: production - description: Deploy request from hubot - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses - repository_url: https://api.github.com/repos/octocat/example - transient_environment: false - production_environment: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": - post: - summary: Re-run a workflow - description: |- - Re-runs your workflow run using its `id`. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/re-run-workflow - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow - parameters: - - *344 - - *345 - - *382 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - enable_debug_logging: - type: boolean - default: false - description: Whether to enable debug logging for the re-run. - examples: - default: - value: - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": - post: - summary: Re-run failed jobs from a workflow run - description: |- - Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/re-run-workflow-failed-jobs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run - parameters: - - *344 - - *345 - - *382 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - enable_debug_logging: - type: boolean - default: false - description: Whether to enable debug logging for the re-run. - examples: - default: - value: - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": - get: - summary: Get workflow run usage - description: "> [!WARNING] \n> This endpoint is in the process of closing down. - Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints - closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" - for more information.\n\nGets the number of billable minutes and total run - time for a specific workflow run. Billable minutes only apply to workflows - in private repositories that use GitHub-hosted runners. Usage is listed for - each GitHub-hosted runner operating system in milliseconds. Any job re-runs - are also included in the usage. The usage does not include the multiplier - for macOS and Windows runners and is not rounded up to the nearest whole minute. - For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone - with read access to the repository can use this endpoint.\n\nOAuth app tokens - and personal access tokens (classic) need the `repo` scope to use this endpoint - with a private repository." - tags: - - actions - operationId: actions/get-workflow-run-usage - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage - parameters: - - *344 - - *345 - - *382 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Workflow Run Usage - description: Workflow Run Usage - type: object - properties: - billable: - type: object - properties: - UBUNTU: - type: object - required: - - total_ms - - jobs - properties: - total_ms: - type: integer - jobs: - type: integer - job_runs: - type: array - items: - type: object - required: - - job_id - - duration_ms - properties: - job_id: - type: integer - duration_ms: - type: integer - MACOS: - type: object - required: - - total_ms - - jobs - properties: - total_ms: - type: integer - jobs: - type: integer - job_runs: - type: array - items: - type: object - required: - - job_id - - duration_ms - properties: - job_id: - type: integer - duration_ms: - type: integer - WINDOWS: - type: object - required: - - total_ms - - jobs - properties: - total_ms: - type: integer - jobs: - type: integer - job_runs: - type: array - items: - type: object - required: - - job_id - - duration_ms - properties: - job_id: - type: integer - duration_ms: - type: integer - run_duration_ms: - type: integer - required: - - billable - examples: - default: - value: - billable: - UBUNTU: - total_ms: 180000 - jobs: 1 - job_runs: - - job_id: 1 - duration_ms: 180000 - MACOS: - total_ms: 240000 - jobs: 4 - job_runs: - - job_id: 2 - duration_ms: 60000 - - job_id: 3 - duration_ms: 60000 - - job_id: 4 - duration_ms: 60000 - - job_id: 5 - duration_ms: 60000 - WINDOWS: - total_ms: 300000 - jobs: 2 - job_runs: - - job_id: 6 - duration_ms: 150000 - - job_id: 7 - duration_ms: 150000 - run_duration_ms: 500000 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/secrets": - get: - summary: List repository secrets - description: |- - Lists all secrets available in a repository without revealing their encrypted - values. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-repo-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-repository-secrets - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: *389 - examples: - default: *390 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/actions/secrets/public-key": - get: - summary: Get a repository public key - description: |- - Gets your public key, which you need to encrypt secrets. You need to - encrypt a secret before you can create or update secrets. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-repo-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *391 - examples: - default: *392 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/actions/secrets/{secret_name}": - get: - summary: Get a repository secret - description: |- - Gets a single repository secret without revealing its encrypted value. - - The authenticated user must have collaborator access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret - parameters: - - *344 - - *345 - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *389 - examples: - default: &525 - value: - name: GH_TOKEN - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - put: - summary: Create or update a repository secret - description: |- - Creates or updates a repository secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-or-update-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret - parameters: - - *344 - - *345 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get a repository public - key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - required: - - encrypted_value - - key_id - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - delete: - summary: Delete a repository secret - description: |- - Deletes a secret in a repository using the secret name. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret - parameters: - - *344 - - *345 - - *168 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/actions/variables": - get: - summary: List repository variables - description: |- - Lists all repository variables. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-repo-variables - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-repository-variables - parameters: - - *344 - - *345 - - *360 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - variables - properties: - total_count: - type: integer - variables: - type: array - items: *393 - examples: - default: *394 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - post: - summary: Create a repository variable - description: |- - Creates a repository variable that you can reference in a GitHub Actions workflow. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-repo-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#create-a-repository-variable - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - required: - - name - - value - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repos/{owner}/{repo}/actions/variables/{name}": - get: - summary: Get a repository variable - description: |- - Gets a specific variable in a repository. - - The authenticated user must have collaborator access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-repo-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#get-a-repository-variable - parameters: - - *344 - - *345 - - *171 - responses: - '200': - description: Response - content: - application/json: - schema: *393 - examples: - default: &526 - value: - name: USERNAME - value: octocat - created_at: '2021-08-10T14:59:22Z' - updated_at: '2022-01-10T14:59:22Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - patch: - summary: Update a repository variable - description: |- - Updates a repository variable that you can reference in a GitHub Actions workflow. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/update-repo-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#update-a-repository-variable - parameters: - - *344 - - *345 - - *171 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - delete: - summary: Delete a repository variable - description: |- - Deletes a repository variable using the variable name. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-repo-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable - parameters: - - *344 - - *345 - - *171 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repos/{owner}/{repo}/actions/workflows": - get: - summary: List repository workflows - description: |- - Lists the workflows in a repository. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/list-repo-workflows - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflows#list-repository-workflows - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - workflows - properties: - total_count: - type: integer - workflows: - type: array - items: &395 - title: Workflow - description: A GitHub Actions workflow - type: object - properties: - id: - type: integer - example: 5 - node_id: - type: string - example: MDg6V29ya2Zsb3cxMg== - name: - type: string - example: CI - path: - type: string - example: ruby.yaml - state: - type: string - example: active - enum: - - active - - deleted - - disabled_fork - - disabled_inactivity - - disabled_manually - created_at: - type: string - format: date-time - example: '2019-12-06T14:20:20.000Z' - updated_at: - type: string - format: date-time - example: '2019-12-06T14:20:20.000Z' - url: - type: string - example: https://api.github.com/repos/actions/setup-ruby/workflows/5 - html_url: - type: string - example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml - badge_url: - type: string - example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg - deleted_at: - type: string - format: date-time - example: '2019-12-06T14:20:20.000Z' - required: - - id - - node_id - - name - - path - - state - - url - - html_url - - badge_url - - created_at - - updated_at - examples: - default: - value: - total_count: 2 - workflows: - - id: 161335 - node_id: MDg6V29ya2Zsb3cxNjEzMzU= - name: CI - path: ".github/workflows/blank.yaml" - state: active - created_at: '2020-01-08T23:48:37.000-08:00' - updated_at: '2020-01-08T23:50:21.000-08:00' - url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 - html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 - badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg - - id: 269289 - node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== - name: Linter - path: ".github/workflows/linter.yaml" - state: active - created_at: '2020-01-08T23:48:37.000-08:00' - updated_at: '2020-01-08T23:50:21.000-08:00' - url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289 - html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 - badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflows - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": - get: - summary: Get a workflow - description: |- - Gets a specific workflow. You can replace `workflow_id` with the workflow - file name. For example, you could use `main.yaml`. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - actions - operationId: actions/get-workflow - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflows#get-a-workflow - parameters: - - *344 - - *345 - - &396 - name: workflow_id - in: path - description: The ID of the workflow. You can also pass the workflow file name - as a string. - required: true - schema: - oneOf: - - type: integer - - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *395 - examples: - default: - value: - id: 161335 - node_id: MDg6V29ya2Zsb3cxNjEzMzU= - name: CI - path: ".github/workflows/blank.yaml" - state: active - created_at: '2020-01-08T23:48:37.000-08:00' - updated_at: '2020-01-08T23:50:21.000-08:00' - url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 - html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 - badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflows - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": - put: - summary: Disable a workflow - description: |- - Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/disable-workflow - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflows#disable-a-workflow - parameters: - - *344 - - *345 - - *396 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflows - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": - post: - summary: Create a workflow dispatch event - description: |- - You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - - You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/create-workflow-dispatch - tags: - - actions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event - parameters: - - *344 - - *345 - - *396 - responses: - '204': - description: Empty response when `return_run_details` parameter is `false`. - '200': - description: Response including the workflow run ID and URLs when `return_run_details` - parameter is `true`. - content: - application/json: - schema: - title: Workflow Dispatch Response - description: Response containing the workflow run ID and URLs. - type: object - properties: - workflow_run_id: - title: Workflow Run ID - description: The ID of the workflow run. - type: integer - format: int64 - run_url: - type: string - format: uri - description: The URL to the workflow run. - html_url: - type: string - format: uri - required: - - workflow_run_id - - run_url - - html_url - examples: - default: - value: - workflow_run_id: 1 - run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 - html_url: https://github.com/octo-org/octo-repo/actions/runs/1 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ref: - type: string - description: The git reference for the workflow. The reference can - be a branch or tag name. - inputs: - type: object - description: Input keys and values configured in the workflow file. - The maximum number of properties is 25. Any default properties - configured in the workflow file will be used when `inputs` are - omitted. - additionalProperties: true - maxProperties: 25 - return_run_details: - type: boolean - description: Whether the response should include the workflow run - ID and URLs. - required: - - ref - examples: - default: - value: - ref: topic-branch - inputs: - name: Mona the Octocat - home: San Francisco, CA - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflows - x-github-breaking-changes: - - changeset: change_workflow_dispatch_response_status - patch: - - op: remove - path: "/responses/204" - - op: remove - path: "/requestBody/content/application~1json/schema/properties/return_run_details" - version: '2026-03-10' - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": - put: - summary: Enable a workflow - description: |- - Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/enable-workflow - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflows#enable-a-workflow - parameters: - - *344 - - *345 - - *396 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflows - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": - get: - summary: List workflow runs for a workflow - description: |- - List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). - - Anyone with read access to the repository can use this endpoint - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - - This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - tags: - - actions - operationId: actions/list-workflow-runs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow - parameters: - - *344 - - *345 - - *396 - - *397 - - *398 - - *399 - - *400 - - *17 - - *19 - - *401 - - *380 - - *402 - - *403 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - workflow_runs - properties: - total_count: - type: integer - workflow_runs: - type: array - items: *381 - examples: - default: *404 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: workflow-runs - "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": - get: - summary: Get workflow usage - description: "> [!WARNING] \n> This endpoint is in the process of closing down. - Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints - closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" - for more information.\n\nGets the number of billable minutes used by a specific - workflow during the current billing cycle. Billable minutes only apply to - workflows in private repositories that use GitHub-hosted runners. Usage is - listed for each GitHub-hosted runner operating system in milliseconds. Any - job re-runs are also included in the usage. The usage does not include the - multiplier for macOS and Windows runners and is not rounded up to the nearest - whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou - can replace `workflow_id` with the workflow file name. For example, you could - use `main.yaml`.\n\nAnyone with read access to the repository can use this - endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the - `repo` scope to use this endpoint with a private repository." - tags: - - actions - operationId: actions/get-workflow-usage - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/workflows#get-workflow-usage - parameters: - - *344 - - *345 - - *396 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Workflow Usage - description: Workflow Usage - type: object - properties: - billable: - type: object - properties: - UBUNTU: - type: object - properties: - total_ms: - type: integer - MACOS: - type: object - properties: - total_ms: - type: integer - WINDOWS: - type: object - properties: - total_ms: - type: integer - required: - - billable - examples: - default: - value: - billable: - UBUNTU: - total_ms: 180000 - MACOS: - total_ms: 240000 - WINDOWS: - total_ms: 300000 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: actions - subcategory: workflows - "/repos/{owner}/{repo}/activity": - get: - summary: List repository activities - description: |- - Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. - - For more information about viewing repository activity, - see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." - tags: - - repos - operationId: repos/list-activities - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repository-activities - parameters: - - *344 - - *345 - - *61 - - *17 - - *47 - - *48 - - name: ref - description: |- - The Git reference for the activities you want to list. - - The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. - in: query - required: false - schema: - type: string - - name: actor - description: The GitHub username to use to filter by the actor who performed - the activity. - in: query - required: false - schema: - type: string - - name: time_period - description: |- - The time period to filter by. - - For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). - in: query - required: false - schema: - type: string - enum: - - day - - week - - month - - quarter - - year - - name: activity_type - description: |- - The activity type to filter by. - - For example, you can choose to filter by "force_push", to see all force pushes to the repository. - in: query - required: false - schema: - type: string - enum: - - push - - force_push - - branch_creation - - branch_deletion - - pr_merge - - merge_queue_merge - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Activity - description: Activity - type: object - properties: - id: - type: integer - example: 1296269 - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - before: - type: string - example: 6dcb09b5b57875f334f61aebed695e2e4193db5e - description: The SHA of the commit before the activity. - after: - type: string - example: 827efc6d56897b048c772eb4087f854f46256132 - description: The SHA of the commit after the activity. - ref: - type: string - example: refs/heads/main - description: The full Git reference, formatted as `refs/heads/`. - timestamp: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - description: The time when the activity occurred. - activity_type: - type: string - example: force_push - enum: - - push - - force_push - - branch_deletion - - branch_creation - - pr_merge - - merge_queue_merge - description: The type of the activity that was performed. - actor: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - id - - node_id - - before - - after - - ref - - timestamp - - activity_type - - actor - examples: - default: - value: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - before: 6dcb09b5b57875f334f61aebed695e2e4193db5e - after: 827efc6d56897b048c772eb4087f854f46256132 - ref: refs/heads/main - pushed_at: '2011-01-26T19:06:43Z' - push_type: normal - pusher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/assignees": - get: - summary: List assignees - description: Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) - for issues in a repository. - tags: - - issues - operationId: issues/list-assignees - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/assignees#list-assignees - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: assignees - "/repos/{owner}/{repo}/assignees/{assignee}": - get: - summary: Check if a user can be assigned - description: |- - Checks if a user has permission to be assigned to an issue in this repository. - - If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - - Otherwise a `404` status code is returned. - tags: - - issues - operationId: issues/check-user-can-be-assigned - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned - parameters: - - *344 - - *345 - - name: assignee - in: path - required: true - schema: - type: string - responses: - '204': - description: If the `assignee` can be assigned to issues in the repository, - a `204` header with no content is returned. - '404': - description: Otherwise a `404` status code is returned. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: assignees - "/repos/{owner}/{repo}/attestations": - post: - summary: Create an attestation - description: |- - Store an artifact attestation and associate it with a repository. - - The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. - - Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - tags: - - repos - operationId: repos/create-attestation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/attestations#create-an-attestation - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - bundle: - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: {} - additionalProperties: true - dsseEnvelope: - type: object - properties: {} - additionalProperties: true - description: |- - The attestation's Sigstore Bundle. - Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - required: - - bundle - examples: - default: - value: - bundle: - mediaType: application/vnd.dev.sigstore.bundle.v0.3+json - verificationMaterial: - tlogEntries: - - logIndex: '97913980' - logId: - keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= - kindVersion: - kind: dsse - version: 0.0.1 - integratedTime: '1716998992' - inclusionPromise: - signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL - inclusionProof: - logIndex: '93750549' - rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= - treeSize: '93750551' - hashes: - - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= - - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= - - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= - - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= - - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= - - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= - - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= - - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= - - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= - - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= - - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= - - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= - - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= - checkpoint: - envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” - rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n - canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= - timestampVerificationData: {} - certificate: - rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== - dsseEnvelope: - payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 - payloadType: application/vnd.in-toto+json - signatures: - - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== - responses: - '201': - description: response - content: - application/json: - schema: - type: object - properties: - id: - type: integer - description: The ID of the attestation. - examples: - default: - value: - id: 2 - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: attestations - "/repos/{owner}/{repo}/attestations/{subject_digest}": - get: - summary: List attestations - description: |- - List a collection of artifact attestations with a given subject digest that are associated with a repository. - - The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. - - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - tags: - - repos - operationId: repos/list-attestations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/attestations#list-attestations - parameters: - - *344 - - *345 - - *17 - - *47 - - *48 - - name: subject_digest - description: The parameter should be set to the attestation's subject's SHA256 - digest, in the form `sha256:HEX_DIGEST`. - in: path - required: true - schema: - type: string - x-multi-segment: true - - name: predicate_type - description: |- - Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, `release`, or freeform text - for custom predicate types. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - attestations: - type: array - items: - type: object - properties: - bundle: - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: {} - additionalProperties: true - dsseEnvelope: - type: object - properties: {} - additionalProperties: true - description: |- - The attestation's Sigstore Bundle. - Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - repository_id: - type: integer - bundle_url: - type: string - initiator: - type: string - examples: - default: *405 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: attestations - x-github-breaking-changes: - - changeset: remove_bundle - patch: - responses: - '200': - content: - application/json: - schema: - properties: - attestations: - items: - properties: - bundle: - version: '2026-03-10' - "/repos/{owner}/{repo}/autolinks": - get: - summary: Get all autolinks of a repository - description: |- - Gets all autolinks that are configured for a repository. - - Information about autolinks are only available to repository administrators. - tags: - - repos - operationId: repos/list-autolinks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &406 - title: Autolink reference - description: An autolink reference. - type: object - properties: - id: - type: integer - example: 3 - key_prefix: - description: The prefix of a key that is linkified. - example: TICKET- - type: string - url_template: - description: A template for the target URL that is generated - if a key was found. - example: https://example.com/TICKET?query= - type: string - is_alphanumeric: - description: Whether this autolink reference matches alphanumeric - characters. If false, this autolink reference only matches - numeric characters. - example: true - type: boolean - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - key_prefix - - url_template - - is_alphanumeric - examples: - default: - value: - - id: 1 - key_prefix: TICKET- - url_template: https://example.com/TICKET?query= - is_alphanumeric: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: autolinks - post: - summary: Create an autolink reference for a repository - description: Users with admin access to the repository can create an autolink. - tags: - - repos - operationId: repos/create-autolink - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - key_prefix: - type: string - description: This prefix appended by certain characters will generate - a link any time it is found in an issue, pull request, or commit. - url_template: - type: string - description: The URL must contain `` for the reference number. - `` matches different characters depending on the value of - `is_alphanumeric`. - is_alphanumeric: - type: boolean - default: true - description: Whether this autolink reference matches alphanumeric - characters. If true, the `` parameter of the `url_template` - matches alphanumeric characters `A-Z` (case insensitive), `0-9`, - and `-`. If false, this autolink reference only matches numeric - characters. - required: - - key_prefix - - url_template - examples: - default: - value: - key_prefix: TICKET- - url_template: https://example.com/TICKET?query= - is_alphanumeric: true - responses: - '201': - description: response - content: - application/json: - schema: *406 - examples: - default: &407 - value: - id: 1 - key_prefix: TICKET- - url_template: https://example.com/TICKET?query= - is_alphanumeric: true - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/autolinks/1 - schema: - type: string - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: autolinks - "/repos/{owner}/{repo}/autolinks/{autolink_id}": - get: - summary: Get an autolink reference of a repository - description: |- - This returns a single autolink reference by ID that was configured for the given repository. - - Information about autolinks are only available to repository administrators. - tags: - - repos - operationId: repos/get-autolink - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository - parameters: - - *344 - - *345 - - &408 - name: autolink_id - description: The unique identifier of the autolink. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *406 - examples: - default: *407 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: autolinks - delete: - summary: Delete an autolink reference from a repository - description: |- - This deletes a single autolink reference by ID that was configured for the given repository. - - Information about autolinks are only available to repository administrators. - tags: - - repos - operationId: repos/delete-autolink - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository - parameters: - - *344 - - *345 - - *408 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: autolinks - "/repos/{owner}/{repo}/automated-security-fixes": - get: - summary: Check if Dependabot security updates are enabled for a repository - description: Shows whether Dependabot security updates are enabled, disabled - or paused for a repository. The authenticated user must have admin read access - to the repository. For more information, see "[Configuring Dependabot security - updates](https://docs.github.com/articles/configuring-automated-security-fixes)". - tags: - - repos - operationId: repos/check-automated-security-fixes - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response if Dependabot is enabled - content: - application/json: - schema: - title: Check Dependabot security updates - description: Check Dependabot security updates - type: object - properties: - enabled: - type: boolean - example: true - description: Whether Dependabot security updates are enabled for - the repository. - paused: - type: boolean - example: false - description: Whether Dependabot security updates are paused for - the repository. - required: - - enabled - - paused - examples: - default: - value: - enabled: true - paused: false - '404': - description: Not Found if Dependabot is not enabled for the repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - put: - summary: Enable Dependabot security updates - description: Enables Dependabot security updates for a repository. The authenticated - user must have admin access to the repository. For more information, see "[Configuring - Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". - tags: - - repos - operationId: repos/enable-automated-security-fixes - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates - parameters: - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - delete: - summary: Disable Dependabot security updates - description: Disables Dependabot security updates for a repository. The authenticated - user must have admin access to the repository. For more information, see "[Configuring - Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". - tags: - - repos - operationId: repos/disable-automated-security-fixes - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates - parameters: - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/branches": - get: - summary: List branches - description: '' - tags: - - repos - operationId: repos/list-branches - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branches#list-branches - parameters: - - *344 - - *345 - - name: protected - description: Setting to `true` returns only branches protected by branch protections - or rulesets. When set to `false`, only unprotected branches are returned. - Omitting this parameter returns all branches. - in: query - required: false - schema: - type: boolean - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Short Branch - description: Short Branch - type: object - properties: - name: - type: string - commit: - type: object - properties: - sha: - type: string - url: - type: string - format: uri - required: - - sha - - url - protected: - type: boolean - protection: &410 - title: Branch Protection - description: Branch Protection - type: object - properties: - url: - type: string - enabled: - type: boolean - required_status_checks: - title: Protected Branch Required Status Check - description: Protected Branch Required Status Check - type: object - properties: - url: - type: string - enforcement_level: - type: string - contexts: - type: array - items: - type: string - checks: - type: array - items: - type: object - properties: - context: - type: string - app_id: - type: integer - nullable: true - required: - - context - - app_id - contexts_url: - type: string - strict: - type: boolean - required: - - contexts - - checks - enforce_admins: &413 - title: Protected Branch Admin Enforced - description: Protected Branch Admin Enforced - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins - enabled: - type: boolean - example: true - required: - - url - - enabled - required_pull_request_reviews: &415 - title: Protected Branch Pull Request Review - description: Protected Branch Pull Request Review - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions - dismissal_restrictions: - type: object - properties: - users: - description: The list of users with review dismissal - access. - type: array - items: *4 - teams: - description: The list of teams with review dismissal - access. - type: array - items: *197 - apps: - description: The list of apps with review dismissal - access. - type: array - items: *5 - url: - type: string - example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"' - users_url: - type: string - example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"' - teams_url: - type: string - example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams"' - bypass_pull_request_allowances: - type: object - description: Allow specific users, teams, or apps to - bypass pull request requirements. - properties: - users: - description: The list of users allowed to bypass - pull request requirements. - type: array - items: *4 - teams: - description: The list of teams allowed to bypass - pull request requirements. - type: array - items: *197 - apps: - description: The list of apps allowed to bypass - pull request requirements. - type: array - items: *5 - dismiss_stale_reviews: - type: boolean - example: true - require_code_owner_reviews: - type: boolean - example: true - required_approving_review_count: - type: integer - minimum: 0 - maximum: 6 - example: 2 - require_last_push_approval: - description: Whether the most recent push must be approved - by someone other than the person who pushed it. - type: boolean - example: true - default: false - required: - - dismiss_stale_reviews - - require_code_owner_reviews - restrictions: &412 - title: Branch Restriction Policy - description: Branch Restriction Policy - type: object - properties: - url: - type: string - format: uri - users_url: - type: string - format: uri - teams_url: - type: string - format: uri - apps_url: - type: string - format: uri - users: - type: array - items: - type: object - properties: - login: - type: string - id: - type: integer - format: int64 - node_id: - type: string - avatar_url: - type: string - gravatar_id: - type: string - url: - type: string - html_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - organizations_url: - type: string - repos_url: - type: string - events_url: - type: string - received_events_url: - type: string - type: - type: string - site_admin: - type: boolean - user_view_type: - type: string - teams: - type: array - items: *197 - apps: - type: array - items: - type: object - properties: - id: - type: integer - slug: - type: string - node_id: - type: string - owner: - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - url: - type: string - repos_url: - type: string - events_url: - type: string - hooks_url: - type: string - issues_url: - type: string - members_url: - type: string - public_members_url: - type: string - avatar_url: - type: string - description: - type: string - gravatar_id: - type: string - example: '""' - html_url: - type: string - example: '"https://github.com/testorg-ea8ec76d71c3af4b"' - followers_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"' - following_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"' - gists_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"' - starred_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"' - subscriptions_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"' - organizations_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"' - received_events_url: - type: string - example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"' - type: - type: string - example: '"Organization"' - site_admin: - type: boolean - example: false - user_view_type: - type: string - example: public - name: - type: string - client_id: - type: string - description: - type: string - external_url: - type: string - html_url: - type: string - created_at: - type: string - updated_at: - type: string - permissions: - type: object - properties: - metadata: - type: string - contents: - type: string - issues: - type: string - single_file: - type: string - events: - type: array - items: - type: string - required: - - url - - users_url - - teams_url - - apps_url - - users - - teams - - apps - required_linear_history: - type: object - properties: - enabled: - type: boolean - allow_force_pushes: - type: object - properties: - enabled: - type: boolean - allow_deletions: - type: object - properties: - enabled: - type: boolean - block_creations: - type: object - properties: - enabled: - type: boolean - required_conversation_resolution: - type: object - properties: - enabled: - type: boolean - name: - type: string - example: '"branch/with/protection"' - protection_url: - type: string - example: '"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection"' - required_signatures: - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures - enabled: - type: boolean - example: true - required: - - url - - enabled - lock_branch: - type: object - description: Whether to set the branch as read-only. If - this is true, users will not be able to push to the branch. - properties: - enabled: - default: false - type: boolean - allow_fork_syncing: - type: object - description: Whether users can pull changes from upstream - when the branch is locked. Set to `true` to allow fork - syncing. Set to `false` to prevent fork syncing. - properties: - enabled: - default: false - type: boolean - protection_url: - type: string - format: uri - required: - - name - - commit - - protected - examples: - default: - value: - - name: master - commit: - sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc - url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc - protected: true - protection: - required_status_checks: - enforcement_level: non_admins - contexts: - - ci-test - - linter - protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branches - "/repos/{owner}/{repo}/branches/{branch}": - get: - summary: Get a branch - description: '' - tags: - - repos - operationId: repos/get-branch - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branches#get-a-branch - parameters: - - *344 - - *345 - - &411 - name: branch - description: The name of the branch. Cannot contain wildcard characters. To - use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). - in: path - required: true - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - content: - application/json: - schema: &421 - title: Branch With Protection - description: Branch With Protection - type: object - properties: - name: - type: string - commit: &478 - title: Commit - description: Commit - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: - type: string - example: 6dcb09b5b57875f334f61aebed695e2e4193db5e - node_id: - type: string - example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - commit: - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - author: - title: Git User - description: Metaproperties for Git author/committer information. - type: object - properties: &409 - name: - type: string - example: '"Chris Wanstrath"' - email: - type: string - example: '"chris@ozmm.org"' - date: - type: string - format: date-time - example: '"2007-10-29T02:42:39.000-07:00"' - nullable: true - committer: - title: Git User - description: Metaproperties for Git author/committer information. - type: object - properties: *409 - nullable: true - message: - type: string - example: Fix all the bugs - comment_count: - type: integer - example: 0 - tree: - type: object - properties: - sha: - type: string - example: 827efc6d56897b048c772eb4087f854f46256132 - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 - required: - - sha - - url - verification: &532 - title: Verification - type: object - properties: - verified: - type: boolean - reason: - type: string - payload: - type: string - nullable: true - signature: - type: string - nullable: true - verified_at: - type: string - nullable: true - required: - - verified - - reason - - payload - - signature - - verified_at - required: - - author - - committer - - comment_count - - message - - tree - - url - author: - nullable: true - oneOf: - - *4 - - *169 - committer: - nullable: true - oneOf: - - *4 - - *169 - parents: - type: array - items: - type: object - properties: - sha: - type: string - example: 7638417db6d59f3c431d3e1f261cc637155684cd - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd - required: - - sha - - url - stats: - type: object - properties: - additions: - type: integer - deletions: - type: integer - total: - type: integer - files: - type: array - items: &491 - title: Diff Entry - description: Diff Entry - type: object - properties: - sha: - type: string - nullable: true - example: bbcd538c8e72b8c175046e27cc8f907076331401 - filename: - type: string - example: file1.txt - status: - type: string - enum: - - added - - removed - - modified - - renamed - - copied - - changed - - unchanged - example: added - additions: - type: integer - example: 103 - deletions: - type: integer - example: 21 - changes: - type: integer - example: 124 - blob_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt - raw_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt - contents_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e - patch: - type: string - example: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 - +1000,7 @@ module Test" - previous_filename: - type: string - example: file.txt - required: - - additions - - blob_url - - changes - - contents_url - - deletions - - filename - - raw_url - - sha - - status - required: - - url - - sha - - node_id - - html_url - - comments_url - - commit - - author - - committer - - parents - _links: - type: object - properties: - html: - type: string - self: - type: string - format: uri - required: - - html - - self - protected: - type: boolean - protection: *410 - protection_url: - type: string - format: uri - pattern: - type: string - example: '"mas*"' - required_approving_review_count: - type: integer - example: 1 - required: - - name - - commit - - _links - - protection - - protected - - protection_url - examples: - default: - value: - name: main - commit: - sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - node_id: MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk - commit: - author: - name: The Octocat - email: octocat@nowhere.com - date: '2012-03-06T23:06:50Z' - committer: - name: The Octocat - email: octocat@nowhere.com - date: '2012-03-06T23:06:50Z' - message: |- - Merge pull request #6 from Spaceghost/patch-1 - - New line at end of file. - tree: - sha: b4eecafa9be2f2006ce1b709d6857b07069b4608 - url: https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608 - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - comment_count: 77 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - html_url: https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments - author: - login: octocat - id: 583231 - node_id: MDQ6VXNlcjU4MzIzMQ== - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: - login: octocat - id: 583231 - node_id: MDQ6VXNlcjU4MzIzMQ== - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - parents: - - sha: 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e - url: https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e - html_url: https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e - - sha: 762941318ee16e59dabbacb1b4049eec22f0d303 - url: https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303 - html_url: https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303 - _links: - self: https://api.github.com/repos/octocat/Hello-World/branches/main - html: https://github.com/octocat/Hello-World/tree/main - protected: false - protection: - enabled: false - required_status_checks: - enforcement_level: 'off' - contexts: [] - checks: [] - protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *348 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branches - "/repos/{owner}/{repo}/branches/{branch}/protection": - get: - summary: Get branch protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/get-branch-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *410 - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection - required_status_checks: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks - contexts: - - continuous-integration/travis-ci - contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts - enforcement_level: non_admins - enforce_admins: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins - enabled: true - required_pull_request_reviews: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews - dismissal_restrictions: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions - users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users - teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams - users: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - apps: - - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - dismiss_stale_reviews: true - require_code_owner_reviews: true - required_approving_review_count: 2 - require_last_push_approval: true - restrictions: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions - users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users - teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams - apps_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps - users: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - apps: - - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - required_linear_history: - enabled: true - allow_force_pushes: - enabled: true - allow_deletions: - enabled: true - required_conversation_resolution: - enabled: true - lock_branch: - enabled: true - allow_fork_syncing: - enabled: true - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - put: - summary: Update branch protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Protecting a branch requires admin or owner permissions to the repository. - - > [!NOTE] - > Passing new arrays of `users` and `teams` replaces their previous values. - - > [!NOTE] - > The list of users, apps, and teams in total is limited to 100 items. - tags: - - repos - operationId: repos/update-branch-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - required_status_checks: - type: object - description: Require status checks to pass before merging. Set to - `null` to disable. - nullable: true - properties: - strict: - type: boolean - description: Require branches to be up to date before merging. - contexts: - type: array - deprecated: true - description: "**Closing down notice**: The list of status checks - to require in order to merge into this branch. If any of these - checks have recently been set by a particular GitHub App, - they will be required to come from that app in future for - the branch to merge. Use `checks` instead of `contexts` for - more fine-grained control." - items: - type: string - checks: - type: array - description: The list of status checks to require in order to - merge into this branch. - items: - type: object - required: - - context - properties: - context: - type: string - description: The name of the required check - app_id: - type: integer - description: The ID of the GitHub App that must provide - this check. Omit this field to automatically select - the GitHub App that has recently provided this check, - or any app if it was not set by a GitHub App. Pass -1 - to explicitly allow any app to set the status. - required: - - strict - - contexts - enforce_admins: - type: boolean - description: Enforce all configured restrictions for administrators. - Set to `true` to enforce required status checks for repository - administrators. Set to `null` to disable. - nullable: true - required_pull_request_reviews: - type: object - description: Require at least one approving review on a pull request, - before merging. Set to `null` to disable. - nullable: true - properties: - dismissal_restrictions: - type: object - description: Specify which users, teams, and apps can dismiss - pull request reviews. Pass an empty `dismissal_restrictions` - object to disable. User and team `dismissal_restrictions` - are only available for organization-owned repositories. Omit - this parameter for personal repositories. - properties: - users: - type: array - description: The list of user `login`s with dismissal access - items: - type: string - teams: - type: array - description: The list of team `slug`s with dismissal access - items: - type: string - apps: - type: array - description: The list of app `slug`s with dismissal access - items: - type: string - dismiss_stale_reviews: - type: boolean - description: Set to `true` if you want to automatically dismiss - approving reviews when someone pushes a new commit. - require_code_owner_reviews: - type: boolean - description: Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) - review them. - required_approving_review_count: - type: integer - description: Specify the number of reviewers required to approve - pull requests. Use a number between 1 and 6 or 0 to not require - reviewers. - require_last_push_approval: - type: boolean - description: 'Whether the most recent push must be approved - by someone other than the person who pushed it. Default: `false`.' - default: false - bypass_pull_request_allowances: - type: object - description: Allow specific users, teams, or apps to bypass - pull request requirements. - properties: - users: - type: array - description: The list of user `login`s allowed to bypass - pull request requirements. - items: - type: string - teams: - type: array - description: The list of team `slug`s allowed to bypass - pull request requirements. - items: - type: string - apps: - type: array - description: The list of app `slug`s allowed to bypass pull - request requirements. - items: - type: string - restrictions: - type: object - description: Restrict who can push to the protected branch. User, - app, and team `restrictions` are only available for organization-owned - repositories. Set to `null` to disable. - nullable: true - properties: - users: - type: array - description: The list of user `login`s with push access - items: - type: string - teams: - type: array - description: The list of team `slug`s with push access - items: - type: string - apps: - type: array - description: The list of app `slug`s with push access - items: - type: string - required: - - users - - teams - required_linear_history: - type: boolean - description: 'Enforces a linear commit Git history, which prevents - anyone from pushing merge commits to a branch. Set to `true` to - enforce a linear commit history. Set to `false` to disable a linear - commit Git history. Your repository must allow squash merging - or rebase merging before you can enable a linear commit history. - Default: `false`. For more information, see "[Requiring a linear - commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" - in the GitHub Help documentation.' - allow_force_pushes: - type: boolean - description: 'Permits force pushes to the protected branch by anyone - with write access to the repository. Set to `true` to allow force - pushes. Set to `false` or `null` to block force pushes. Default: - `false`. For more information, see "[Enabling force pushes to - a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" - in the GitHub Help documentation."' - nullable: true - allow_deletions: - type: boolean - description: 'Allows deletion of the protected branch by anyone - with write access to the repository. Set to `false` to prevent - deletion of the protected branch. Default: `false`. For more information, - see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" - in the GitHub Help documentation.' - block_creations: - type: boolean - description: 'If set to `true`, the `restrictions` branch protection - settings which limits who can push will also block pushes which - create new branches, unless the push is initiated by a user, team, - or app which has the ability to push. Set to `true` to restrict - new branch creation. Default: `false`.' - required_conversation_resolution: - type: boolean - description: 'Requires all conversations on code to be resolved - before a pull request can be merged into a branch that matches - this rule. Set to `false` to disable. Default: `false`.' - lock_branch: - type: boolean - description: 'Whether to set the branch as read-only. If this is - true, users will not be able to push to the branch. Default: `false`.' - default: false - allow_fork_syncing: - type: boolean - description: 'Whether users can pull changes from upstream when - the branch is locked. Set to `true` to allow fork syncing. Set - to `false` to prevent fork syncing. Default: `false`.' - default: false - required: - - required_status_checks - - enforce_admins - - required_pull_request_reviews - - restrictions - examples: - default: - value: - required_status_checks: - strict: true - contexts: - - continuous-integration/travis-ci - enforce_admins: true - required_pull_request_reviews: - dismissal_restrictions: - users: - - octocat - teams: - - justice-league - dismiss_stale_reviews: true - require_code_owner_reviews: true - required_approving_review_count: 2 - require_last_push_approval: true - bypass_pull_request_allowances: - users: - - octocat - teams: - - justice-league - restrictions: - users: - - octocat - teams: - - justice-league - apps: - - super-ci - required_linear_history: true - allow_force_pushes: true - allow_deletions: true - block_creations: true - required_conversation_resolution: true - lock_branch: true - allow_fork_syncing: true - responses: - '200': - description: Response - content: - application/json: - schema: - title: Protected Branch - description: Branch protections protect branches - type: object - properties: - url: - type: string - format: uri - required_status_checks: &418 - title: Status Check Policy - description: Status Check Policy - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks - strict: - type: boolean - example: true - contexts: - type: array - example: - - continuous-integration/travis-ci - items: - type: string - checks: - type: array - items: - type: object - properties: - context: - type: string - example: continuous-integration/travis-ci - app_id: - type: integer - nullable: true - required: - - context - - app_id - contexts_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts - required: - - url - - contexts_url - - strict - - contexts - - checks - required_pull_request_reviews: - type: object - properties: - url: - type: string - format: uri - dismiss_stale_reviews: - type: boolean - require_code_owner_reviews: - type: boolean - required_approving_review_count: - type: integer - require_last_push_approval: - description: Whether the most recent push must be approved - by someone other than the person who pushed it. - type: boolean - default: false - dismissal_restrictions: - type: object - properties: - url: - type: string - format: uri - users_url: - type: string - format: uri - teams_url: - type: string - format: uri - users: - type: array - items: *4 - teams: - type: array - items: *197 - apps: - type: array - items: *5 - required: - - url - - users_url - - teams_url - - users - - teams - bypass_pull_request_allowances: - type: object - properties: - users: - type: array - items: *4 - teams: - type: array - items: *197 - apps: - type: array - items: *5 - required: - - users - - teams - required: - - url - required_signatures: - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures - enabled: - type: boolean - example: true - required: - - url - - enabled - enforce_admins: - type: object - properties: - url: - type: string - format: uri - enabled: - type: boolean - additionalProperties: false - required: - - url - - enabled - required_linear_history: - type: object - properties: - enabled: - type: boolean - additionalProperties: false - required: - - enabled - allow_force_pushes: - type: object - properties: - enabled: - type: boolean - additionalProperties: false - required: - - enabled - allow_deletions: - type: object - properties: - enabled: - type: boolean - additionalProperties: false - required: - - enabled - restrictions: *412 - required_conversation_resolution: - type: object - properties: - enabled: - type: boolean - additionalProperties: false - block_creations: - type: object - properties: - enabled: - type: boolean - additionalProperties: false - required: - - enabled - lock_branch: - type: object - description: Whether to set the branch as read-only. If this is - true, users will not be able to push to the branch. - properties: - enabled: - default: false - type: boolean - additionalProperties: false - allow_fork_syncing: - type: object - description: Whether users can pull changes from upstream when - the branch is locked. Set to `true` to allow fork syncing. Set - to `false` to prevent fork syncing. - properties: - enabled: - default: false - type: boolean - additionalProperties: false - required: - - url - examples: - default: - value: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection - required_status_checks: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks - strict: true - contexts: - - continuous-integration/travis-ci - contexts_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts - checks: - - context: continuous-integration/travis-ci - app_id: - restrictions: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions - users_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users - teams_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams - apps_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps - users: [] - teams: [] - apps: [] - required_pull_request_reviews: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews - dismiss_stale_reviews: true - require_code_owner_reviews: true - required_approving_review_count: 2 - require_last_push_approval: true - dismissal_restrictions: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions - users_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users - teams_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams - users: [] - teams: [] - apps: [] - required_signatures: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures - enabled: false - enforce_admins: - url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins - enabled: true - required_linear_history: - enabled: true - allow_force_pushes: - enabled: true - allow_deletions: - enabled: true - block_creations: - enabled: true - required_conversation_resolution: - enabled: true - lock_branch: - enabled: true - allow_fork_syncing: - enabled: true - '403': *29 - '422': *7 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - delete: - summary: Delete branch protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/delete-branch-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection - parameters: - - *344 - - *345 - - *411 - responses: - '204': - description: Response - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": - get: - summary: Get admin branch protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/get-admin-branch-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *413 - examples: - default: &414 - value: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins - enabled: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - post: - summary: Set admin branch protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - tags: - - repos - operationId: repos/set-admin-branch-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *413 - examples: - default: *414 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - delete: - summary: Delete admin branch protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - tags: - - repos - operationId: repos/delete-admin-branch-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection - parameters: - - *344 - - *345 - - *411 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": - get: - summary: Get pull request review protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/get-pull-request-review-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *415 - examples: - default: &416 - value: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews - dismissal_restrictions: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions - users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users - teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams - users: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - apps: - - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - dismiss_stale_reviews: true - require_code_owner_reviews: true - required_approving_review_count: 2 - require_last_push_approval: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - patch: - summary: Update pull request review protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - - > [!NOTE] - > Passing new arrays of `users` and `teams` replaces their previous values. - tags: - - repos - operationId: repos/update-pull-request-review-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection - parameters: - - *344 - - *345 - - *411 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - dismissal_restrictions: - type: object - description: Specify which users, teams, and apps can dismiss pull - request reviews. Pass an empty `dismissal_restrictions` object - to disable. User and team `dismissal_restrictions` are only available - for organization-owned repositories. Omit this parameter for personal - repositories. - properties: - users: - type: array - description: The list of user `login`s with dismissal access - items: - type: string - teams: - type: array - description: The list of team `slug`s with dismissal access - items: - type: string - apps: - type: array - description: The list of app `slug`s with dismissal access - items: - type: string - dismiss_stale_reviews: - type: boolean - description: Set to `true` if you want to automatically dismiss - approving reviews when someone pushes a new commit. - require_code_owner_reviews: - type: boolean - description: Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) - have reviewed. - required_approving_review_count: - type: integer - description: Specifies the number of reviewers required to approve - pull requests. Use a number between 1 and 6 or 0 to not require - reviewers. - require_last_push_approval: - type: boolean - description: 'Whether the most recent push must be approved by someone - other than the person who pushed it. Default: `false`' - default: false - bypass_pull_request_allowances: - type: object - description: Allow specific users, teams, or apps to bypass pull - request requirements. - properties: - users: - type: array - description: The list of user `login`s allowed to bypass pull - request requirements. - items: - type: string - teams: - type: array - description: The list of team `slug`s allowed to bypass pull - request requirements. - items: - type: string - apps: - type: array - description: The list of app `slug`s allowed to bypass pull - request requirements. - items: - type: string - examples: - default: - value: - dismissal_restrictions: - users: - - octocat - teams: - - justice-league - apps: - - octoapp - bypass_pull_request_allowances: - users: - - octocat - teams: - - justice-league - apps: - - octoapp - dismiss_stale_reviews: true - require_code_owner_reviews: true - required_approving_review_count: 2 - require_last_push_approval: true - responses: - '200': - description: Response - content: - application/json: - schema: *415 - examples: - default: *416 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - delete: - summary: Delete pull request review protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/delete-pull-request-review-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection - parameters: - - *344 - - *345 - - *411 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": - get: - summary: Get commit signature protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. - - > [!NOTE] - > You must enable branch protection to require signed commits. - tags: - - repos - operationId: repos/get-commit-signature-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *413 - examples: - default: &417 - value: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures - enabled: true - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - post: - summary: Create commit signature protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. - tags: - - repos - operationId: repos/create-commit-signature-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *413 - examples: - default: *417 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - delete: - summary: Delete commit signature protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. - tags: - - repos - operationId: repos/delete-commit-signature-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection - parameters: - - *344 - - *345 - - *411 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": - get: - summary: Get status checks protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/get-status-checks-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *418 - examples: - default: &419 - value: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks - strict: true - contexts: - - continuous-integration/travis-ci - contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - patch: - summary: Update status check protection - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - tags: - - repos - operationId: repos/update-status-check-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection - parameters: - - *344 - - *345 - - *411 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - strict: - type: boolean - description: Require branches to be up to date before merging. - contexts: - type: array - deprecated: true - description: "**Closing down notice**: The list of status checks - to require in order to merge into this branch. If any of these - checks have recently been set by a particular GitHub App, they - will be required to come from that app in future for the branch - to merge. Use `checks` instead of `contexts` for more fine-grained - control." - items: - type: string - checks: - type: array - description: The list of status checks to require in order to merge - into this branch. - items: - type: object - required: - - context - properties: - context: - type: string - description: The name of the required check - app_id: - type: integer - description: The ID of the GitHub App that must provide this - check. Omit this field to automatically select the GitHub - App that has recently provided this check, or any app if - it was not set by a GitHub App. Pass -1 to explicitly allow - any app to set the status. - examples: - default: - value: - strict: true - contexts: - - continuous-integration/travis-ci - responses: - '200': - description: Response - content: - application/json: - schema: *418 - examples: - default: *419 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - delete: - summary: Remove status check protection - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/remove-status-check-protection - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection - parameters: - - *344 - - *345 - - *411 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": - get: - summary: Get all status check contexts - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/get-all-status-check-contexts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: string - examples: - default: - value: - - continuous-integration/travis-ci - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - post: - summary: Add status check contexts - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/add-status-check-contexts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts - parameters: - - *344 - - *345 - - *411 - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - contexts: - type: array - description: The name of the status checks - items: - type: string - required: - - contexts - example: - contexts: - - contexts - - type: array - description: The name of the status checks - items: - type: string - examples: - default: - summary: Example adding status checks to a branch protection rule - value: - contexts: - - continuous-integration/travis-ci - - continuous-integration/jenkins - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: string - examples: - default: - value: - - continuous-integration/travis-ci - - continuous-integration/jenkins - '422': *15 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: contexts - category: branches - subcategory: branch-protection - put: - summary: Set status check contexts - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/set-status-check-contexts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts - parameters: - - *344 - - *345 - - *411 - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - contexts: - type: array - description: The name of the status checks - items: - type: string - required: - - contexts - example: - contexts: - - contexts - - type: array - description: The name of the status checks - items: - type: string - examples: - default: - summary: Example updating status checks for a branch protection rule - value: - contexts: - - continuous-integration/travis-ci - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: string - examples: - default: - value: - - continuous-integration/travis-ci - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: contexts - category: branches - subcategory: branch-protection - delete: - summary: Remove status check contexts - description: Protected branches are available in public repositories with GitHub - Free and GitHub Free for organizations, and in public and private repositories - with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise - Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - tags: - - repos - operationId: repos/remove-status-check-contexts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts - parameters: - - *344 - - *345 - - *411 - requestBody: - content: - application/json: - schema: - oneOf: - - type: object - properties: - contexts: - type: array - description: The name of the status checks - items: - type: string - required: - - contexts - example: - contexts: - - contexts - - type: array - description: The name of the status checks - items: - type: string - examples: - default: - summary: Example removing status checks from a branch protection rule - value: - contexts: - - continuous-integration/jenkins - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: string - examples: - default: - value: - - continuous-integration/travis-ci - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: contexts - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": - get: - summary: Get access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Lists who has access to this protected branch. - - > [!NOTE] - > Users, apps, and teams `restrictions` are only available for organization-owned repositories. - tags: - - repos - operationId: repos/get-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: *412 - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions - users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users - teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams - apps_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps - users: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - apps: - - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - delete: - summary: Delete access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Disables the ability to restrict who can push to this branch. - tags: - - repos - operationId: repos/delete-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions - parameters: - - *344 - - *345 - - *411 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": - get: - summary: Get apps with access to the protected branch - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - tags: - - repos - operationId: repos/get-apps-with-access-to-protected-branch - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *5 - examples: - default: &420 - value: - - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - post: - summary: Add app access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - tags: - - repos - operationId: repos/add-app-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - examples: - default: - value: - apps: - - octoapp - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *5 - examples: - default: *420 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: apps - category: branches - subcategory: branch-protection - put: - summary: Set app access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - tags: - - repos - operationId: repos/set-app-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - examples: - default: - value: - apps: - - octoapp - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *5 - examples: - default: *420 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: apps - category: branches - subcategory: branch-protection - delete: - summary: Remove app access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - tags: - - repos - operationId: repos/remove-app-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - apps: - type: array - description: 'The GitHub Apps that have push access to this branch. - Use the slugified version of the app name. **Note**: The list - of users, apps, and teams in total is limited to 100 items.' - items: - type: string - required: - - apps - example: - apps: - - my-app - examples: - default: - value: - apps: - - my-app - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *5 - examples: - default: *420 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: apps - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": - get: - summary: Get teams with access to the protected branch - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Lists the teams who have push access to this branch. The list includes child teams. - tags: - - repos - operationId: repos/get-teams-with-access-to-protected-branch - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: *260 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - post: - summary: Add team access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Grants the specified teams push access for this branch. You can also give push access to child teams. - tags: - - repos - operationId: repos/add-team-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - teams: - type: array - description: The slug values for teams - items: - type: string - required: - - teams - example: - teams: - - my-team - - type: array - description: The slug values for teams - items: - type: string - examples: - default: - summary: Example adding a team in a branch protection rule - value: - teams: - - justice-league - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: *260 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: teams - category: branches - subcategory: branch-protection - put: - summary: Set team access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. - tags: - - repos - operationId: repos/set-team-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - teams: - type: array - description: The slug values for teams - items: - type: string - required: - - teams - example: - teams: - - justice-league - - type: array - description: The slug values for teams - items: - type: string - examples: - default: - summary: Example replacing a team in a branch protection rule - value: - teams: - - justice-league - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: *260 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: teams - category: branches - subcategory: branch-protection - delete: - summary: Remove team access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Removes the ability of a team to push to this branch. You can also remove push access for child teams. - tags: - - repos - operationId: repos/remove-team-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - content: - application/json: - schema: - oneOf: - - type: object - properties: - teams: - type: array - description: The slug values for teams - items: - type: string - required: - - teams - example: - teams: - - my-team - - type: array - description: The slug values for teams - items: - type: string - examples: - default: - summary: Example removing a team in a branch protection rule - value: - teams: - - octocats - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: *260 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: teams - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": - get: - summary: Get users with access to the protected branch - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Lists the people who have push access to this branch. - tags: - - repos - operationId: repos/get-users-with-access-to-protected-branch - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch - parameters: - - *344 - - *345 - - *411 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branch-protection - post: - summary: Add user access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Grants the specified people push access for this branch. - - | Type | Description | - | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - tags: - - repos - operationId: repos/add-user-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - examples: - default: - summary: Example adding a user in a branch protection rule - value: - users: - - octocat - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: users - category: branches - subcategory: branch-protection - put: - summary: Set user access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. - - | Type | Description | - | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - tags: - - repos - operationId: repos/set-user-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - examples: - default: - summary: Example replacing a user in a branch protection rule - value: - users: - - octocat - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: users - category: branches - subcategory: branch-protection - delete: - summary: Remove user access restrictions - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Removes the ability of a user to push to this branch. - - | Type | Description | - | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - tags: - - repos - operationId: repos/remove-user-access-restrictions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - users: - type: array - description: The username for users - items: - type: string - required: - - users - example: - users: - - mona - examples: - default: - summary: Example removing a user in a branch protection rule - value: - users: - - octocat - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - requestBodyParameterName: users - category: branches - subcategory: branch-protection - "/repos/{owner}/{repo}/branches/{branch}/rename": - post: - summary: Rename a branch - description: |- - Renames a branch in a repository. - - > [!NOTE] - > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". - - The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - - In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. - tags: - - repos - operationId: repos/rename-branch - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branches#rename-a-branch - parameters: - - *344 - - *345 - - *411 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - new_name: - type: string - description: The new name of the branch. - required: - - new_name - examples: - default: - value: - new_name: my_renamed_branch - responses: - '201': - description: Response - content: - application/json: - schema: *421 - examples: - default: - value: - name: master - commit: - sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - node_id: MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA== - commit: - author: - name: The Octocat - date: '2012-03-06T15:06:50-08:00' - email: octocat@nowhere.com - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - message: |- - Merge pull request #6 from Spaceghost/patch-1 - - New line at end of file. - tree: - sha: b4eecafa9be2f2006ce1b709d6857b07069b4608 - url: https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608 - committer: - name: The Octocat - date: '2012-03-06T15:06:50-08:00' - email: octocat@nowhere.com - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - comment_count: 0 - author: - gravatar_id: '' - avatar_url: https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png - url: https://api.github.com/users/octocat - id: 583231 - login: octocat - node_id: MDQ6VXNlcjE= - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - parents: - - sha: 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e - url: https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e - - sha: 762941318ee16e59dabbacb1b4049eec22f0d303 - url: https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303 - url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - committer: - gravatar_id: '' - avatar_url: https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png - url: https://api.github.com/users/octocat - id: 583231 - login: octocat - node_id: MDQ6VXNlcjE= - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - _links: - html: https://github.com/octocat/Hello-World/tree/master - self: https://api.github.com/repos/octocat/Hello-World/branches/master - protected: true - protection: - required_status_checks: - enforcement_level: non_admins - contexts: - - ci-test - - linter - protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branches - "/repos/{owner}/{repo}/check-runs": - post: - summary: Create a check run - description: |- - Creates a new check run for a specific commit in a repository. - - To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. - - In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - - > [!NOTE] - > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - tags: - - checks - operationId: checks/create - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#create-a-check-run - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the check. For example, "code-coverage". - head_sha: - type: string - description: The SHA of the commit. - details_url: - type: string - description: The URL of the integrator's site that has the full - details of the check. If the integrator does not provide this, - then the homepage of the GitHub app is used. - external_id: - type: string - description: A reference for the run on the integrator's system. - status: - type: string - description: The current status of the check run. Only GitHub Actions - can set a status of `waiting`, `pending`, or `requested`. - enum: - - queued - - in_progress - - completed - - waiting - - requested - - pending - default: queued - started_at: - type: string - format: date-time - description: 'The time that the check run began. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - conclusion: - type: string - description: "**Required if you provide `completed_at` or a `status` - of `completed`**. The final conclusion of the check. \n**Note:** - Providing `conclusion` will automatically set the `status` parameter - to `completed`. You cannot change a check run conclusion to `stale`, - only GitHub can set this." - enum: - - action_required - - cancelled - - failure - - neutral - - success - - skipped - - stale - - timed_out - completed_at: - type: string - format: date-time - description: 'The time the check completed. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - output: - type: object - description: Check runs can accept a variety of data in the `output` - object, including a `title` and `summary` and can optionally provide - descriptive details about the run. - properties: - title: - type: string - description: The title of the check run. - summary: - type: string - maxLength: 65535 - description: 'The summary of the check run. This parameter supports - Markdown. **Maximum length**: 65535 characters.' - text: - type: string - maxLength: 65535 - description: 'The details of the check run. This parameter supports - Markdown. **Maximum length**: 65535 characters.' - annotations: - type: array - description: Adds information from your analysis to specific - lines of code. Annotations are visible on GitHub in the **Checks** - and **Files changed** tab of the pull request. The Checks - API limits the number of annotations to a maximum of 50 per - API request. To create more than 50 annotations, you have - to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) - endpoint. Each time you update the check run, annotations - are appended to the list of annotations that already exist - for the check run. GitHub Actions are limited to 10 warning - annotations and 10 error annotations per step. For details - about how you can view annotations on GitHub, see "[About - status checks](https://docs.github.com/articles/about-status-checks#checks)". - maxItems: 50 - items: - type: object - properties: - path: - type: string - description: The path of the file to add an annotation - to. For example, `assets/css/main.css`. - start_line: - type: integer - description: The start line of the annotation. Line numbers - start at 1. - end_line: - type: integer - description: The end line of the annotation. - start_column: - type: integer - description: The start column of the annotation. Annotations - only support `start_column` and `end_column` on the - same line. Omit this parameter if `start_line` and `end_line` - have different values. Column numbers start at 1. - end_column: - type: integer - description: The end column of the annotation. Annotations - only support `start_column` and `end_column` on the - same line. Omit this parameter if `start_line` and `end_line` - have different values. - annotation_level: - type: string - description: The level of the annotation. - enum: - - notice - - warning - - failure - message: - type: string - description: A short description of the feedback for these - lines of code. The maximum size is 64 KB. - title: - type: string - description: The title that represents the annotation. - The maximum size is 255 characters. - raw_details: - type: string - description: Details about this annotation. The maximum - size is 64 KB. - required: - - path - - start_line - - end_line - - annotation_level - - message - images: - type: array - description: Adds images to the output displayed in the GitHub - pull request UI. - items: - type: object - properties: - alt: - type: string - description: The alternative text for the image. - image_url: - type: string - description: The full URL of the image. - caption: - type: string - description: A short image description. - required: - - alt - - image_url - required: - - title - - summary - actions: - type: array - description: Displays a button on GitHub that can be clicked to - alert your app to do additional tasks. For example, a code linting - app can display a button that automatically fixes detected errors. - The button created in this object is displayed after the check - run completes. When a user clicks the button, GitHub sends the - [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) - to your app. Each action includes a `label`, `identifier` and - `description`. A maximum of three actions are accepted. To learn - more about check runs and requested actions, see "[Check runs - and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." - maxItems: 3 - items: - type: object - properties: - label: - type: string - maxLength: 20 - description: The text to be displayed on a button in the web - UI. The maximum size is 20 characters. - description: - type: string - maxLength: 40 - description: A short explanation of what this action would - do. The maximum size is 40 characters. - identifier: - type: string - maxLength: 20 - description: A reference for the action on the integrator's - system. The maximum size is 20 characters. - required: - - label - - description - - identifier - required: - - name - - head_sha - discriminator: - propertyName: status - oneOf: - - properties: - status: - enum: - - completed - required: - - status - - conclusion - additionalProperties: true - - properties: - status: - enum: - - queued - - in_progress - additionalProperties: true - examples: - example-of-in-progress-conclusion: - summary: Example of an in_progress conclusion - value: - name: mighty_readme - head_sha: ce587453ced02b1526dfb4cb910479d431683101 - status: in_progress - external_id: '42' - started_at: '2018-05-04T01:14:52Z' - output: - title: Mighty Readme report - summary: '' - text: '' - example-of-completed-conclusion: - summary: Example of a completed conclusion - value: - name: mighty_readme - head_sha: ce587453ced02b1526dfb4cb910479d431683101 - status: completed - started_at: '2017-11-30T19:39:10Z' - conclusion: success - completed_at: '2017-11-30T19:49:10Z' - output: - title: Mighty Readme report - summary: There are 0 failures, 2 warnings, and 1 notices. - text: You may have some misspelled words on lines 2 and 4. You - also may want to add a section in your README about how to install - your app. - annotations: - - path: README.md - annotation_level: warning - title: Spell Checker - message: Check your spelling for 'banaas'. - raw_details: Do you mean 'bananas' or 'banana'? - start_line: 2 - end_line: 2 - - path: README.md - annotation_level: warning - title: Spell Checker - message: Check your spelling for 'aples' - raw_details: Do you mean 'apples' or 'Naples' - start_line: 4 - end_line: 4 - images: - - alt: Super bananas - image_url: http://example.com/images/42 - actions: - - label: Fix - identifier: fix_errors - description: Allow us to fix these errors for you - responses: - '201': - description: Response - content: - application/json: - schema: &422 - title: CheckRun - description: A check performed on the code of a given code change - type: object - properties: - id: - description: The id of the check. - example: 21 - type: integer - format: int64 - head_sha: - description: The SHA of the commit that is being checked. - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - node_id: - type: string - example: MDg6Q2hlY2tSdW40 - external_id: - type: string - example: '42' - nullable: true - url: - type: string - example: https://api.github.com/repos/github/hello-world/check-runs/4 - html_url: - type: string - example: https://github.com/github/hello-world/runs/4 - nullable: true - details_url: - type: string - example: https://example.com - nullable: true - status: - description: The phase of the lifecycle that the check is currently - in. Statuses of waiting, requested, and pending are reserved - for GitHub Actions check runs. - example: queued - type: string - enum: - - queued - - in_progress - - completed - - waiting - - requested - - pending - conclusion: - type: string - example: neutral - enum: - - success - - failure - - neutral - - cancelled - - skipped - - timed_out - - action_required - nullable: true - started_at: - type: string - format: date-time - example: '2018-05-04T01:14:52Z' - nullable: true - completed_at: - type: string - format: date-time - example: '2018-05-04T01:14:52Z' - nullable: true - output: - type: object - properties: - title: - type: string - nullable: true - summary: - type: string - nullable: true - text: - type: string - nullable: true - annotations_count: - type: integer - annotations_url: - type: string - format: uri - required: - - title - - summary - - text - - annotations_count - - annotations_url - name: - description: The name of the check. - example: test-coverage - type: string - check_suite: - type: object - properties: - id: - type: integer - required: - - id - nullable: true - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - pull_requests: - description: Pull requests that are open with a `head_sha` or - `head_branch` that matches the check. The returned pull requests - do not necessarily indicate pull requests that triggered the - check. - type: array - items: *90 - deployment: &747 - title: Deployment - description: A deployment created as the result of an Actions - check run from a workflow that references an environment - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/deployments/1 - id: - description: Unique identifier of the deployment - example: 42 - type: integer - node_id: - type: string - example: MDEwOkRlcGxveW1lbnQx - task: - description: Parameter to specify a task to execute - example: deploy - type: string - original_environment: - type: string - example: staging - environment: - description: Name for the target deployment environment. - example: production - type: string - description: - type: string - example: Deploy request from hubot - nullable: true - created_at: - type: string - format: date-time - example: '2012-07-20T01:19:13Z' - updated_at: - type: string - format: date-time - example: '2012-07-20T01:19:13Z' - statuses_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/deployments/1/statuses - repository_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example - transient_environment: - description: 'Specifies if the given environment is will no - longer exist at some point in the future. Default: false.' - example: true - type: boolean - production_environment: - description: 'Specifies if the given environment is one that - end-users directly interact with. Default: false.' - example: true - type: boolean - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - required: - - id - - node_id - - task - - environment - - description - - statuses_url - - repository_url - - url - - created_at - - updated_at - required: - - id - - node_id - - head_sha - - name - - url - - html_url - - details_url - - status - - conclusion - - started_at - - completed_at - - external_id - - check_suite - - output - - app - - pull_requests - examples: - example-of-completed-conclusion: - summary: Response for completed conclusion - value: - id: 4 - head_sha: ce587453ced02b1526dfb4cb910479d431683101 - node_id: MDg6Q2hlY2tSdW40 - external_id: '42' - url: https://api.github.com/repos/github/hello-world/check-runs/4 - html_url: https://github.com/github/hello-world/runs/4 - details_url: https://example.com - status: completed - conclusion: neutral - started_at: '2018-05-04T01:14:52Z' - completed_at: '2018-05-04T01:14:52Z' - output: - title: Mighty Readme report - summary: There are 0 failures, 2 warnings, and 1 notice. - text: You may have some misspelled words on lines 2 and 4. You - also may want to add a section in your README about how to - install your app. - annotations_count: 2 - annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations - name: mighty_readme - check_suite: - id: 5 - app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - pull_requests: - - url: https://api.github.com/repos/github/hello-world/pulls/1 - id: 1934 - number: 3956 - head: - ref: say-hello - sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - base: - ref: master - sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - example-of-in-progress-conclusion: - summary: Response for in_progress conclusion - value: - id: 4 - head_sha: ce587453ced02b1526dfb4cb910479d431683101 - node_id: MDg6Q2hlY2tSdW40 - external_id: '42' - url: https://api.github.com/repos/github/hello-world/check-runs/4 - html_url: https://github.com/github/hello-world/runs/4 - details_url: https://example.com - status: in_progress - conclusion: - started_at: '2018-05-04T01:14:52Z' - completed_at: - output: - title: Mighty Readme report - summary: There are 0 failures, 2 warnings, and 1 notice. - text: You may have some misspelled words on lines 2 and 4. You - also may want to add a section in your README about how to - install your app. - annotations_count: 2 - annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations - name: mighty_readme - check_suite: - id: 5 - app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - pull_requests: - - url: https://api.github.com/repos/github/hello-world/pulls/1 - id: 1934 - number: 3956 - head: - ref: say-hello - sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - base: - ref: master - sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - "/repos/{owner}/{repo}/check-runs/{check_run_id}": - get: - summary: Get a check run - description: |- - Gets a single check run using its `id`. - - > [!NOTE] - > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - tags: - - checks - operationId: checks/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#get-a-check-run - parameters: - - *344 - - *345 - - &423 - name: check_run_id - description: The unique identifier of the check run. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *422 - examples: - default: &424 - value: - id: 4 - head_sha: ce587453ced02b1526dfb4cb910479d431683101 - node_id: MDg6Q2hlY2tSdW40 - external_id: '' - url: https://api.github.com/repos/github/hello-world/check-runs/4 - html_url: https://github.com/github/hello-world/runs/4 - details_url: https://example.com - status: completed - conclusion: neutral - started_at: '2018-05-04T01:14:52Z' - completed_at: '2018-05-04T01:14:52Z' - output: - title: Mighty Readme report - summary: There are 0 failures, 2 warnings, and 1 notice. - text: You may have some misspelled words on lines 2 and 4. You - also may want to add a section in your README about how to - install your app. - annotations_count: 2 - annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations - name: mighty_readme - check_suite: - id: 5 - app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - pull_requests: - - url: https://api.github.com/repos/github/hello-world/pulls/1 - id: 1934 - number: 3956 - head: - ref: say-hello - sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - base: - ref: master - sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - patch: - summary: Update a check run - description: |- - Updates a check run for a specific commit in a repository. - - > [!NOTE] - > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - - OAuth apps and personal access tokens (classic) cannot use this endpoint. - tags: - - checks - operationId: checks/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#update-a-check-run - parameters: - - *344 - - *345 - - *423 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the check. For example, "code-coverage". - details_url: - type: string - description: The URL of the integrator's site that has the full - details of the check. - external_id: - type: string - description: A reference for the run on the integrator's system. - started_at: - type: string - format: date-time - description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - status: - type: string - description: The current status of the check run. Only GitHub Actions - can set a status of `waiting`, `pending`, or `requested`. - enum: - - queued - - in_progress - - completed - - waiting - - requested - - pending - conclusion: - type: string - description: "**Required if you provide `completed_at` or a `status` - of `completed`**. The final conclusion of the check. \n**Note:** - Providing `conclusion` will automatically set the `status` parameter - to `completed`. You cannot change a check run conclusion to `stale`, - only GitHub can set this." - enum: - - action_required - - cancelled - - failure - - neutral - - success - - skipped - - stale - - timed_out - completed_at: - type: string - format: date-time - description: 'The time the check completed. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - output: - type: object - description: Check runs can accept a variety of data in the `output` - object, including a `title` and `summary` and can optionally provide - descriptive details about the run. - properties: - title: - type: string - description: "**Required**." - summary: - type: string - description: Can contain Markdown. - maxLength: 65535 - text: - type: string - description: Can contain Markdown. - maxLength: 65535 - annotations: - type: array - description: Adds information from your analysis to specific - lines of code. Annotations are visible in GitHub's pull request - UI. Annotations are visible in GitHub's pull request UI. The - Checks API limits the number of annotations to a maximum of - 50 per API request. To create more than 50 annotations, you - have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) - endpoint. Each time you update the check run, annotations - are appended to the list of annotations that already exist - for the check run. GitHub Actions are limited to 10 warning - annotations and 10 error annotations per step. For details - about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". - maxItems: 50 - items: - type: object - properties: - path: - type: string - description: The path of the file to add an annotation - to. For example, `assets/css/main.css`. - start_line: - type: integer - description: The start line of the annotation. Line numbers - start at 1. - end_line: - type: integer - description: The end line of the annotation. - start_column: - type: integer - description: The start column of the annotation. Annotations - only support `start_column` and `end_column` on the - same line. Omit this parameter if `start_line` and `end_line` - have different values. Column numbers start at 1. - end_column: - type: integer - description: The end column of the annotation. Annotations - only support `start_column` and `end_column` on the - same line. Omit this parameter if `start_line` and `end_line` - have different values. - annotation_level: - type: string - description: The level of the annotation. - enum: - - notice - - warning - - failure - message: - type: string - description: A short description of the feedback for these - lines of code. The maximum size is 64 KB. - title: - type: string - description: The title that represents the annotation. - The maximum size is 255 characters. - raw_details: - type: string - description: Details about this annotation. The maximum - size is 64 KB. - required: - - path - - start_line - - end_line - - annotation_level - - message - images: - type: array - description: Adds images to the output displayed in the GitHub - pull request UI. - items: - type: object - properties: - alt: - type: string - description: The alternative text for the image. - image_url: - type: string - description: The full URL of the image. - caption: - type: string - description: A short image description. - required: - - alt - - image_url - required: - - summary - actions: - type: array - description: Possible further actions the integrator can perform, - which a user may trigger. Each action includes a `label`, `identifier` - and `description`. A maximum of three actions are accepted. To - learn more about check runs and requested actions, see "[Check - runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." - maxItems: 3 - items: - type: object - properties: - label: - type: string - maxLength: 20 - description: The text to be displayed on a button in the web - UI. The maximum size is 20 characters. - description: - type: string - maxLength: 40 - description: A short explanation of what this action would - do. The maximum size is 40 characters. - identifier: - type: string - maxLength: 20 - description: A reference for the action on the integrator's - system. The maximum size is 20 characters. - required: - - label - - description - - identifier - anyOf: - - properties: - status: - enum: - - completed - required: - - conclusion - additionalProperties: true - - properties: - status: - enum: - - queued - - in_progress - additionalProperties: true - examples: - default: - value: - name: mighty_readme - started_at: '2018-05-04T01:14:52Z' - status: completed - conclusion: success - completed_at: '2018-05-04T01:14:52Z' - output: - title: Mighty Readme report - summary: There are 0 failures, 2 warnings, and 1 notices. - text: You may have some misspelled words on lines 2 and 4. You - also may want to add a section in your README about how to install - your app. - annotations: - - path: README.md - annotation_level: warning - title: Spell Checker - message: Check your spelling for 'banaas'. - raw_details: Do you mean 'bananas' or 'banana'? - start_line: 2 - end_line: 2 - - path: README.md - annotation_level: warning - title: Spell Checker - message: Check your spelling for 'aples' - raw_details: Do you mean 'apples' or 'Naples' - start_line: 4 - end_line: 4 - images: - - alt: Super bananas - image_url: http://example.com/images/42 - responses: - '200': - description: Response - content: - application/json: - schema: *422 - examples: - default: *424 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": - get: - summary: List check run annotations - description: |- - Lists annotations for a check run using the annotation `id`. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - tags: - - checks - operationId: checks/list-annotations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#list-check-run-annotations - parameters: - - *344 - - *345 - - *423 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Check Annotation - description: Check Annotation - type: object - properties: - path: - type: string - example: README.md - start_line: - type: integer - example: 2 - end_line: - type: integer - example: 2 - start_column: - type: integer - example: 5 - nullable: true - end_column: - type: integer - example: 10 - nullable: true - annotation_level: - type: string - example: warning - nullable: true - title: - type: string - example: Spell Checker - nullable: true - message: - type: string - example: Check your spelling for 'banaas'. - nullable: true - raw_details: - type: string - example: Do you mean 'bananas' or 'banana'? - nullable: true - blob_href: - type: string - required: - - path - - blob_href - - start_line - - end_line - - start_column - - end_column - - annotation_level - - title - - message - - raw_details - examples: - default: - value: - - path: README.md - start_line: 2 - end_line: 2 - start_column: 5 - end_column: 10 - annotation_level: warning - title: Spell Checker - message: Check your spelling for 'banaas'. - raw_details: Do you mean 'bananas' or 'banana'? - blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": - post: - summary: Rerequest a check run - description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. - - For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - tags: - - checks - operationId: checks/rerequest-run - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run - parameters: - - *344 - - *345 - - *423 - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '403': - description: Forbidden if the check run is not rerequestable or doesn't - belong to the authenticated GitHub App - content: - application/json: - schema: *3 - '422': - description: Validation error if the check run is not rerequestable - content: - application/json: - schema: *3 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - "/repos/{owner}/{repo}/check-suites": - post: - summary: Create a check suite - description: |- - Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". - - > [!NOTE] - > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - - OAuth apps and personal access tokens (classic) cannot use this endpoint. - tags: - - checks - operationId: checks/create-suite - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/suites#create-a-check-suite - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - head_sha: - type: string - description: The sha of the head commit. - required: - - head_sha - examples: - default: - value: - head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 - responses: - '200': - description: Response when the suite already exists - content: - application/json: - schema: &427 - title: CheckSuite - description: A suite of checks performed on the code of a given code - change - type: object - properties: - id: - type: integer - example: 5 - format: int64 - node_id: - type: string - example: MDEwOkNoZWNrU3VpdGU1 - head_branch: - type: string - example: master - nullable: true - head_sha: - description: The SHA of the head commit that is being checked. - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - status: - type: string - description: The phase of the lifecycle that the check suite is - currently in. Statuses of waiting, requested, and pending are - reserved for GitHub Actions check suites. - example: completed - enum: - - queued - - in_progress - - completed - - waiting - - requested - - pending - nullable: true - conclusion: - type: string - example: neutral - enum: - - success - - failure - - neutral - - cancelled - - skipped - - timed_out - - action_required - - startup_failure - - stale - - null - nullable: true - url: - type: string - example: https://api.github.com/repos/github/hello-world/check-suites/5 - nullable: true - before: - type: string - example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 - nullable: true - after: - type: string - example: d6fde92930d4715a2b49857d24b940956b26d2d3 - nullable: true - pull_requests: - type: array - items: *90 - nullable: true - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - repository: *160 - created_at: - type: string - format: date-time - nullable: true - updated_at: - type: string - format: date-time - nullable: true - head_commit: &775 - title: Simple Commit - description: A commit. - type: object - properties: *425 - required: *426 - latest_check_runs_count: - type: integer - check_runs_url: - type: string - rerequestable: - type: boolean - runs_rerequestable: - type: boolean - required: - - id - - node_id - - head_branch - - status - - conclusion - - head_sha - - url - - before - - after - - created_at - - updated_at - - app - - head_commit - - repository - - latest_check_runs_count - - check_runs_url - - pull_requests - examples: - default: &428 - value: - id: 5 - node_id: MDEwOkNoZWNrU3VpdGU1 - head_branch: master - head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 - status: completed - conclusion: neutral - url: https://api.github.com/repos/github/hello-world/check-suites/5 - before: 146e867f55c26428e5f9fade55a9bbf5e95a7912 - after: d6fde92930d4715a2b49857d24b940956b26d2d3 - pull_requests: [] - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - delete_branch_on_merge: true - subscribers_count: 42 - network_count: 0 - head_commit: - id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - message: |- - Merge pull request #6 from Spaceghost/patch-1 - - New line at end of file. - timestamp: '2016-10-10T00:00:00Z' - author: - name: The Octocat - email: octocat@nowhere.com - committer: - name: The Octocat - email: octocat@nowhere.com - latest_check_runs_count: 1 - check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs - '201': - description: Response when the suite was created - content: - application/json: - schema: *427 - examples: - default: *428 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: suites - "/repos/{owner}/{repo}/check-suites/preferences": - patch: - summary: Update repository preferences for check suites - description: |- - Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). - You must have admin permissions in the repository to set preferences for check suites. - tags: - - checks - operationId: checks/set-suites-preferences - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - auto_trigger_checks: - type: array - description: Enables or disables automatic creation of CheckSuite - events upon pushes to the repository. Enabled by default. - items: - type: object - properties: - app_id: - type: integer - description: The `id` of the GitHub App. - setting: - type: boolean - description: Set to `true` to enable automatic creation of - CheckSuite events upon pushes to the repository, or `false` - to disable them. - default: true - required: - - app_id - - setting - examples: - default: - value: - auto_trigger_checks: - - app_id: 4 - setting: false - responses: - '200': - description: Response - content: - application/json: - schema: - title: Check Suite Preference - description: Check suite configuration preferences for a repository. - type: object - required: - - preferences - - repository - properties: - preferences: - type: object - properties: - auto_trigger_checks: - type: array - items: - type: object - properties: - app_id: - type: integer - setting: - type: boolean - required: - - app_id - - setting - repository: *160 - examples: - default: - value: - preferences: - auto_trigger_checks: - - app_id: 2 - setting: true - - app_id: 4 - setting: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: suites - "/repos/{owner}/{repo}/check-suites/{check_suite_id}": - get: - summary: Get a check suite - description: |- - Gets a single check suite using its `id`. - - > [!NOTE] - > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - tags: - - checks - operationId: checks/get-suite - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/suites#get-a-check-suite - parameters: - - *344 - - *345 - - &429 - name: check_suite_id - description: The unique identifier of the check suite. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *427 - examples: - default: *428 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: suites - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": - get: - summary: List check runs in a check suite - description: |- - Lists check runs for a check suite using its `id`. - - > [!NOTE] - > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - tags: - - checks - operationId: checks/list-for-suite - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite - parameters: - - *344 - - *345 - - *429 - - &484 - name: check_name - description: Returns check runs with the specified `name`. - in: query - required: false - schema: - type: string - - &485 - name: status - description: Returns check runs with the specified `status`. - in: query - required: false - schema: - type: string - enum: - - queued - - in_progress - - completed - - name: filter - description: Filters check runs by their `completed_at` timestamp. `latest` - returns the most recent check runs. - in: query - required: false - schema: - type: string - enum: - - latest - - all - default: latest - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - check_runs - properties: - total_count: - type: integer - check_runs: - type: array - items: *422 - examples: - default: &486 - value: - total_count: 1 - check_runs: - - id: 4 - head_sha: ce587453ced02b1526dfb4cb910479d431683101 - node_id: MDg6Q2hlY2tSdW40 - external_id: '' - url: https://api.github.com/repos/github/hello-world/check-runs/4 - html_url: https://github.com/github/hello-world/runs/4 - details_url: https://example.com - status: completed - conclusion: neutral - started_at: '2018-05-04T01:14:52Z' - completed_at: '2018-05-04T01:14:52Z' - output: - title: Mighty Readme report - summary: There are 0 failures, 2 warnings, and 1 notice. - text: You may have some misspelled words on lines 2 and 4. - You also may want to add a section in your README about - how to install your app. - annotations_count: 2 - annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations - name: mighty_readme - check_suite: - id: 5 - app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - pull_requests: - - url: https://api.github.com/repos/github/hello-world/pulls/1 - id: 1934 - number: 3956 - head: - ref: say-hello - sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - base: - ref: master - sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f - repo: - id: 526 - url: https://api.github.com/repos/github/hello-world - name: hello-world - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": - post: - summary: Rerequest a check suite - description: Triggers GitHub to rerequest an existing check suite, without pushing - new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) - event with the action `rerequested`. When a check suite is `rerequested`, - its `status` is reset to `queued` and the `conclusion` is cleared. - tags: - - checks - operationId: checks/rerequest-suite - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite - parameters: - - *344 - - *345 - - *429 - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: suites - "/repos/{owner}/{repo}/code-scanning/alerts": - get: - summary: List code scanning alerts for a repository - description: |- - Lists code scanning alerts. - - The response includes a `most_recent_instance` object. - This provides details of the most recent instance of this alert - for the default branch (or for the specified Git reference if you used `ref` in the request). - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/list-alerts-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository - parameters: - - *344 - - *345 - - *430 - - *431 - - *19 - - *17 - - &448 - name: ref - description: The Git reference for the results you want to list. The `ref` - for a branch can be formatted either as `refs/heads/` or simply - ``. To reference a pull request use `refs/pull//merge`. - in: query - required: false - schema: *432 - - &449 - name: pr - description: The number of the pull request for the results you want to list. - in: query - required: false - schema: - type: integer - - *61 - - *47 - - *48 - - name: sort - description: The property by which to sort the results. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - name: state - description: If specified, only code scanning alerts with this state will - be returned. - in: query - required: false - schema: *433 - - name: severity - description: If specified, only code scanning alerts with this severity will - be returned. - in: query - required: false - schema: *434 - - name: assignees - description: | - Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). - Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: object - properties: - number: *178 - created_at: *179 - updated_at: *180 - url: *181 - html_url: *182 - instances_url: *435 - state: *187 - fixed_at: *183 - dismissed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - dismissed_at: *184 - dismissed_reason: *436 - dismissed_comment: *437 - rule: *438 - tool: *439 - most_recent_instance: *440 - dismissal_approved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignees: - type: array - items: *4 - required: - - number - - created_at - - url - - html_url - - instances_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - - most_recent_instance - examples: - default: - value: - - number: 4 - created_at: '2020-02-13T12:29:18Z' - url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 - html_url: https://github.com/octocat/hello-world/code-scanning/4 - state: open - fixed_at: - dismissed_by: - dismissed_at: - dismissed_reason: - dismissed_comment: - rule: - id: js/zipslip - severity: error - tags: - - security - - external/cwe/cwe-022 - description: Arbitrary file write during zip extraction - name: js/zipslip - tool: - name: CodeQL - guid: - version: 2.4.0 - most_recent_instance: - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: "{}" - state: open - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: spec-main/api-session-spec.ts - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: - - test - instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances - - number: 3 - created_at: '2020-02-13T12:29:18Z' - url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 - html_url: https://github.com/octocat/hello-world/code-scanning/3 - state: dismissed - fixed_at: - dismissed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_at: '2020-02-14T12:29:18Z' - dismissed_reason: false positive - dismissed_comment: This alert is not actually correct, because - there's a sanitizer included in the library. - rule: - id: js/zipslip - severity: error - tags: - - security - - external/cwe/cwe-022 - description: Arbitrary file write during zip extraction - name: js/zipslip - tool: - name: CodeQL - guid: - version: 2.4.0 - most_recent_instance: - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: "{}" - state: open - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: lib/ab12-gen.js - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: [] - instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances - '304': *37 - '403': &441 - description: Response if GitHub Advanced Security is not enabled for this - repository - content: - application/json: - schema: *3 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": - get: - summary: Get a code scanning alert - description: |- - Gets a single code scanning alert. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/get-alert - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert - parameters: - - *344 - - *345 - - &442 - name: alert_number - in: path - description: The number that identifies an alert. You can find this at the - end of the URL for a code scanning alert within GitHub, and in the `number` - field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` - operation. - required: true - schema: *178 - responses: - '200': - description: Response - content: - application/json: - schema: &443 - type: object - properties: - number: *178 - created_at: *179 - updated_at: *180 - url: *181 - html_url: *182 - instances_url: *435 - state: *187 - fixed_at: *183 - dismissed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - dismissed_at: *184 - dismissed_reason: *436 - dismissed_comment: *437 - rule: - type: object - properties: - id: - nullable: true - type: string - description: A unique identifier for the rule used to detect - the alert. - name: - type: string - description: The name of the rule used to detect the alert. - severity: - nullable: true - type: string - description: The severity of the alert. - enum: - - none - - note - - warning - - error - security_severity_level: - nullable: true - type: string - description: The security severity of the alert. - enum: - - low - - medium - - high - - critical - description: - type: string - description: A short description of the rule used to detect - the alert. - full_description: - type: string - description: A description of the rule used to detect the - alert. - tags: - nullable: true - type: array - description: A set of tags applicable for the rule. - items: - type: string - help: - nullable: true - type: string - description: Detailed documentation for the rule as GitHub - Flavored Markdown. - help_uri: - nullable: true - type: string - description: A link to the documentation for the rule used - to detect the alert. - tool: *439 - most_recent_instance: *440 - dismissal_approved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignees: - type: array - items: *4 - required: - - number - - created_at - - url - - html_url - - instances_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - - most_recent_instance - examples: - default: - value: - number: 42 - created_at: '2020-06-19T11:21:34Z' - url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 - html_url: https://github.com/octocat/hello-world/code-scanning/42 - state: dismissed - fixed_at: - dismissed_by: - login: octocat - id: 54933897 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_at: '2020-02-14T12:29:18Z' - dismissed_reason: false positive - dismissed_comment: This alert is not actually correct, because - there's a sanitizer included in the library. - rule: - id: js/zipslip - severity: error - security_severity_level: high - description: Arbitrary file write during zip extraction ("Zip - Slip") - name: js/zipslip - full_description: Extracting files from a malicious zip archive - without validating that the destination file path is within - the destination directory can cause files outside the destination - directory to be overwritten. - tags: - - security - - external/cwe/cwe-022 - help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting - files from a malicious zip archive without validating that - the destination file path is within the destination directory - can cause files outside the destination directory to be overwritten - ...' - help_uri: https://codeql.github.com/ - tool: - name: CodeQL - guid: - version: 2.4.0 - most_recent_instance: - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: "{}" - state: dismissed - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: spec-main/api-session-spec.ts - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: - - test - instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '304': *37 - '403': *441 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - patch: - summary: Update a code scanning alert - description: |- - Updates the status of a single code scanning alert. - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - operationId: code-scanning/update-alert - tags: - - code-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert - parameters: - - *344 - - *345 - - *442 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - state: - description: Sets the state of the code scanning alert. You must - provide `dismissed_reason` when you set the state to `dismissed`. - type: string - enum: - - open - - dismissed - dismissed_reason: *436 - dismissed_comment: *437 - create_request: - type: boolean - description: If `true`, attempt to create an alert dismissal request. - assignees: - description: The list of users to assign to the code scanning alert. - An empty array unassigns all previous assignees from the alert. - type: array - items: - type: string - anyOf: - - required: - - state - - required: - - assignees - examples: - default: - value: - state: dismissed - dismissed_reason: false positive - dismissed_comment: This alert is not actually correct, because there's - a sanitizer included in the library. - create_request: true - responses: - '200': - description: Response - content: - application/json: - schema: *443 - examples: - default: - value: - number: 42 - created_at: '2020-08-25T21:28:36Z' - url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 - html_url: https://github.com/octocat/hello-world/code-scanning/42 - state: dismissed - fixed_at: - dismissed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_at: '2020-09-02T22:34:56Z' - dismissed_reason: false positive - dismissed_comment: This alert is not actually correct, because - there's a sanitizer included in the library. - rule: - id: js/zipslip - severity: error - security_severity_level: high - description: Arbitrary file write during zip extraction ("Zip - Slip") - name: js/zipslip - full_description: Extracting files from a malicious zip archive - without validating that the destination file path is within - the destination directory can cause files outside the destination - directory to be overwritten. - tags: - - security - - external/cwe/cwe-022 - help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting - files from a malicious zip archive without validating that - the destination file path is within the destination directory - can cause files outside the destination directory to be overwritten - ...' - help_uri: https://codeql.github.com/ - tool: - name: CodeQL - guid: - version: 2.4.0 - most_recent_instance: - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: "{}" - state: dismissed - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: spec-main/api-session-spec.ts - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: - - test - instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '400': *14 - '403': &447 - description: Response if the repository is archived or if GitHub Advanced - Security is not enabled for this repository - content: - application/json: - schema: *3 - '404': *6 - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": - get: - summary: Get the status of an autofix for a code scanning alert - description: |- - Gets the status and description of an autofix for a code scanning alert. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/get-autofix - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert - parameters: - - *344 - - *345 - - *442 - responses: - '200': - description: Response - content: - application/json: - schema: &444 - type: object - properties: - status: - type: string - description: The status of an autofix. - enum: - - pending - - error - - success - - outdated - description: - type: string - description: The description of an autofix. - nullable: true - started_at: - type: string - description: 'The start time of an autofix in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - required: - - status - - description - - started_at - examples: - default: &445 - value: - status: success - description: This fixes an XSS vulnerability by escaping the user - input. - started_at: '2024-02-14T12:29:18Z' - '400': &446 - description: Bad Request - content: - application/json: - schema: *3 - examples: - default: - value: - message: The alert_number is not valid - documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert - status: '400' - '403': *441 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - post: - summary: Create an autofix for a code scanning alert - description: |- - Creates an autofix for a code scanning alert. - - If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. - - If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/create-autofix - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert - parameters: - - *344 - - *345 - - *442 - responses: - '200': - description: OK - content: - application/json: - schema: *444 - examples: - default: *445 - '202': - description: Accepted - content: - application/json: - schema: *444 - examples: - default: - value: - status: pending - description: - started_at: '2024-02-14T12:29:18Z' - '400': *446 - '403': - description: Response if the repository is archived, if GitHub Advanced - Security is not enabled for this repository or if rate limit is exceeded - content: - application/json: - schema: *3 - '404': *6 - '422': - description: Unprocessable Entity - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": - post: - summary: Commit an autofix for a code scanning alert - description: |- - Commits an autofix for a code scanning alert. - - If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/commit-autofix - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert - parameters: - - *344 - - *345 - - *442 - requestBody: - required: false - content: - application/json: - schema: - description: Commit an autofix for a code scanning alert - type: object - properties: - target_ref: - description: The Git reference of target branch for the commit. - Branch needs to already exist. For more information, see "[Git - References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - type: string - message: - description: Commit message to be used. - type: string - nullable: true - examples: - default: - value: - target_ref: refs/heads/fix-bug - message: "Let's fix this \U0001FAB2!" - responses: - '201': - description: Created - content: - application/json: - schema: - type: object - properties: - target_ref: - type: string - description: The Git reference of target branch for the commit. - For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - sha: - type: string - description: SHA of commit with autofix. - examples: - default: - value: - target_ref: refs/heads/main - sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *446 - '403': *447 - '404': *6 - '422': - description: Unprocessable Entity - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": - get: - summary: List instances of a code scanning alert - description: |- - Lists all instances of the specified code scanning alert. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/list-alert-instances - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert - parameters: - - *344 - - *345 - - *442 - - *19 - - *17 - - *448 - - *449 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: object - properties: - ref: *432 - analysis_key: *450 - environment: *451 - category: *452 - state: - type: string - description: State of a code scanning alert instance. - nullable: true - enum: - - open - - fixed - commit_sha: - type: string - message: - type: object - properties: - text: - type: string - location: *453 - html_url: - type: string - classifications: - type: array - description: |- - Classifications that have been applied to the file that triggered the alert. - For example identifying it as documentation, or a generated file. - items: *454 - examples: - default: - value: - - ref: refs/heads/main - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: '' - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - state: open - commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 - message: - text: This path depends on a user-provided value. - location: - path: lib/ab12-gen.js - start_line: 917 - end_line: 917 - start_column: 7 - end_column: 18 - classifications: - - library - - ref: refs/pull/3740/merge - analysis_key: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - environment: '' - category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" - state: fixed - commit_sha: b09da05606e27f463a2b49287684b4ae777092f2 - message: - text: This suffix check is missing a length comparison to correctly - handle lastIndexOf returning -1. - location: - path: app/script.js - start_line: 2 - end_line: 2 - start_column: 10 - end_column: 50 - classifications: - - source - '403': *441 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/analyses": - get: - summary: List code scanning analyses for a repository - description: |- - Lists the details of all code scanning analyses for a repository, - starting with the most recent. - The response is paginated and you can use the `page` and `per_page` parameters - to list the analyses you're interested in. - By default 30 analyses are listed per page. - - The `rules_count` field in the response give the number of rules - that were run in the analysis. - For very old analyses this data is not available, - and `0` is returned in this field. - - > [!WARNING] - > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - operationId: code-scanning/list-recent-analyses - tags: - - code-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository - parameters: - - *344 - - *345 - - *430 - - *431 - - *19 - - *17 - - *449 - - name: ref - in: query - description: The Git reference for the analyses you want to list. The `ref` - for a branch can be formatted either as `refs/heads/` or simply - ``. To reference a pull request use `refs/pull//merge`. - required: false - schema: *432 - - name: sarif_id - in: query - description: Filter analyses belonging to the same SARIF upload. - required: false - schema: &455 - type: string - description: An identifier for the upload. - example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *61 - - name: sort - description: The property by which to sort the results. - in: query - required: false - schema: - type: string - enum: - - created - default: created - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &456 - type: object - properties: - ref: *432 - commit_sha: &464 - description: The SHA of the commit to which the analysis you - are uploading relates. - type: string - minLength: 40 - maxLength: 40 - pattern: "^[0-9a-fA-F]+$" - analysis_key: *450 - environment: - type: string - description: Identifies the variable values associated with - the environment in which this analysis was performed. - category: *452 - error: - type: string - example: error reading field xyz - created_at: - type: string - description: 'The time that the analysis was created in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - results_count: - type: integer - description: The total number of results in the analysis. - rules_count: - type: integer - description: The total number of rules used in the analysis. - id: - type: integer - description: Unique identifier for this analysis. - url: - type: string - description: The REST API URL of the analysis resource. - format: uri - readOnly: true - sarif_id: *455 - tool: *439 - deletable: - type: boolean - warning: - type: string - description: Warning generated when processing the analysis - example: 123 results were ignored - required: - - ref - - commit_sha - - analysis_key - - environment - - error - - created_at - - results_count - - rules_count - - id - - url - - sarif_id - - tool - - deletable - - warning - examples: - default: - value: - - ref: refs/heads/main - commit_sha: d99612c3e1f2970085cfbaeadf8f010ef69bad83 - analysis_key: ".github/workflows/codeql-analysis.yml:analyze" - environment: '{"language":"python"}' - error: '' - category: ".github/workflows/codeql-analysis.yml:analyze/language:python" - created_at: '2020-08-27T15:05:21Z' - results_count: 17 - rules_count: 49 - id: 201 - url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201 - sarif_id: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - tool: - name: CodeQL - guid: - version: 2.4.0 - deletable: true - warning: '' - - ref: refs/heads/my-branch - commit_sha: c8cff6510d4d084fb1b4aa13b64b97ca12b07321 - analysis_key: ".github/workflows/shiftleft.yml:build" - environment: "{}" - error: '' - category: ".github/workflows/shiftleft.yml:build/" - created_at: '2020-08-31T22:46:44Z' - results_count: 17 - rules_count: 32 - id: 200 - url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200 - sarif_id: 8981cd8e-b078-4ac3-a3be-1dad7dbd0b582 - tool: - name: Python Security Analysis - guid: - version: 1.2.0 - deletable: true - warning: '' - '403': *441 - '404': *6 - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": - get: - summary: Get a code scanning analysis for a repository - description: |- - Gets a specified code scanning analysis for a repository. - - The default JSON response contains fields that describe the analysis. - This includes the Git reference and commit SHA to which the analysis relates, - the datetime of the analysis, the name of the code scanning tool, - and the number of alerts. - - The `rules_count` field in the default response give the number of rules - that were run in the analysis. - For very old analyses this data is not available, - and `0` is returned in this field. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - operationId: code-scanning/get-analysis - tags: - - code-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository - parameters: - - *344 - - *345 - - name: analysis_id - in: path - description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` - operation. - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *456 - examples: - response: - summary: application/json response - value: - ref: refs/heads/main - commit_sha: c18c69115654ff0166991962832dc2bd7756e655 - analysis_key: ".github/workflows/codeql-analysis.yml:analyze" - environment: '{"language":"javascript"}' - error: '' - category: ".github/workflows/codeql-analysis.yml:analyze/language:javascript" - created_at: '2021-01-13T11:55:49Z' - results_count: 3 - rules_count: 67 - id: 3602840 - url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201 - sarif_id: 47177e22-5596-11eb-80a1-c1e54ef945c6 - tool: - name: CodeQL - guid: - version: 2.4.0 - deletable: true - warning: '' - application/sarif+json: - schema: - type: object - additionalProperties: true - examples: - response: - summary: application/sarif+json response - value: - runs: - - tool: - driver: - name: CodeQL - organization: GitHub - semanticVersion: 1.0.0 - rules: - - id: js/unused-local-variable - name: js/unused-local-variable - results: - - guid: 326aa09f-9af8-13cf-9851-3d0e5183ec38 - message: - text: Unused variable foo. - locations: - - physicalLocation: - artifactLocation: - uri: file1.js - region: - startLine: 1 - ruleId: js/unused-local-variable - properties: - - github/alertNumber: 2 - - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *441 - '404': *6 - '422': - description: Response if analysis could not be processed - content: - application/json: - schema: *3 - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: code-scanning - subcategory: code-scanning - delete: - summary: Delete a code scanning analysis from a repository - description: |- - Deletes a specified code scanning analysis from a repository. - - You can delete one analysis at a time. - To delete a series of analyses, start with the most recent analysis and work backwards. - Conceptually, the process is similar to the undo function in a text editor. - - When you list the analyses for a repository, - one or more will be identified as deletable in the response: - - ``` - "deletable": true - ``` - - An analysis is deletable when it's the most recent in a set of analyses. - Typically, a repository will have multiple sets of analyses - for each enabled code scanning tool, - where a set is determined by a unique combination of analysis values: - - * `ref` - * `tool` - * `category` - - If you attempt to delete an analysis that is not the most recent in a set, - you'll get a 400 response with the message: - - ``` - Analysis specified is not deletable. - ``` - - The response from a successful `DELETE` operation provides you with - two alternative URLs for deleting the next analysis in the set: - `next_analysis_url` and `confirm_delete_url`. - Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - in a set. This is a useful option if you want to preserve at least one analysis - for the specified tool in your repository. - Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - in the 200 response is `null`. - - As an example of the deletion process, - let's imagine that you added a workflow that configured a particular code scanning tool - to analyze the code in a repository. This tool has added 15 analyses: - 10 on the default branch, and another 5 on a topic branch. - You therefore have two separate sets of analyses for this tool. - You've now decided that you want to remove all of the analyses for the tool. - To do this you must make 15 separate deletion requests. - To start, you must find an analysis that's identified as deletable. - Each set of analyses always has one that's identified as deletable. - Having found the deletable analysis for one of the two sets, - delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - Then repeat the process for the second set. - The procedure therefore consists of a nested loop: - - **Outer loop**: - * List the analyses for the repository, filtered by tool. - * Parse this list to find a deletable analysis. If found: - - **Inner loop**: - * Delete the identified analysis. - * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - - The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - operationId: code-scanning/delete-analysis - tags: - - code-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository - parameters: - - *344 - - *345 - - name: analysis_id - in: path - description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` - operation. - required: true - schema: - type: integer - - name: confirm_delete - in: query - description: 'Allow deletion if the specified analysis is the last in a set. - If you attempt to delete the final analysis in a set without setting this - parameter to `true`, you''ll get a 400 response with the message: `Analysis - is last of its type and deletion may result in the loss of historical alert - data. Please specify confirm_delete.`' - required: false - schema: - type: string - nullable: true - responses: - '200': - description: Response - content: - application/json: - schema: - title: Analysis deletion - description: Successful deletion of a code scanning analysis - type: object - properties: - next_analysis_url: - type: string - description: Next deletable analysis in chain, without last analysis - deletion confirmation - format: uri - readOnly: true - nullable: true - confirm_delete_url: - type: string - description: Next deletable analysis in chain, with last analysis - deletion confirmation - format: uri - readOnly: true - nullable: true - required: - - next_analysis_url - - confirm_delete_url - examples: - default-response: - summary: Default response - value: - next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 - confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete - '400': *14 - '403': *447 - '404': *6 - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/codeql/databases": - get: - summary: List CodeQL databases for a repository - description: |- - Lists the CodeQL databases that are available in a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/list-codeql-databases - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &457 - title: CodeQL Database - description: A CodeQL database. - type: object - properties: - id: - type: integer - description: The ID of the CodeQL database. - name: - type: string - description: The name of the CodeQL database. - language: - type: string - description: The language of the CodeQL database. - uploader: *4 - content_type: - type: string - description: The MIME type of the CodeQL database file. - size: - type: integer - description: The size of the CodeQL database file in bytes. - created_at: - type: string - format: date-time - description: The date and time at which the CodeQL database - was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - updated_at: - type: string - format: date-time - description: The date and time at which the CodeQL database - was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - url: - type: string - format: uri - description: The URL at which to download the CodeQL database. - The `Accept` header must be set to the value of the `content_type` - property. - commit_oid: - type: string - description: The commit SHA of the repository at the time the - CodeQL database was created. - nullable: true - required: - - id - - name - - language - - uploader - - content_type - - size - - created_at - - updated_at - - url - examples: - default: - value: - - id: 1 - name: database.zip - language: java - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - content_type: application/zip - size: 1024 - created_at: '2022-09-12T12:14:32Z' - updated_at: '2022-09-12T12:14:32Z' - url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java - commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - - id: 2 - name: database.zip - language: ruby - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - content_type: application/zip - size: 1024 - created_at: '2022-09-12T12:14:32Z' - updated_at: '2022-09-12T12:14:32Z' - url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby - commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *441 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": - get: - summary: Get a CodeQL database for a repository - description: |- - Gets a CodeQL database for a language in a repository. - - By default this endpoint returns JSON metadata about the CodeQL database. To - download the CodeQL database binary content, set the `Accept` header of the request - to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure - your HTTP client is configured to follow redirects or use the `Location` header - to make a second request to get the redirect URL. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/get-codeql-database - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository - parameters: - - *344 - - *345 - - name: language - in: path - description: The language of the CodeQL database. - schema: - type: string - required: true - responses: - '200': - description: Response - content: - application/json: - schema: *457 - examples: - default: - value: - id: 1 - name: database.zip - language: java - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - content_type: application/zip - size: 1024 - created_at: '2022-09-12T12:14:32Z' - updated_at: '2022-09-12T12:14:32Z' - url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java - commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &495 - description: Found - '403': *441 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: code-scanning - subcategory: code-scanning - delete: - summary: Delete a CodeQL database - description: |- - Deletes a CodeQL database for a language in a repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/delete-codeql-database - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database - parameters: - - *344 - - *345 - - name: language - in: path - description: The language of the CodeQL database. - schema: - type: string - required: true - responses: - '204': - description: Response - '403': *447 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": - post: - summary: Create a CodeQL variant analysis - description: |- - Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. - - Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). - - Use the `owner` and `repo` parameters in the URL to specify the controller repository that - will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - code-scanning - operationId: code-scanning/create-variant-analysis - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - language: &458 - type: string - description: The language targeted by the CodeQL query - enum: - - actions - - cpp - - csharp - - go - - java - - javascript - - python - - ruby - - rust - - swift - query_pack: - description: A Base64-encoded tarball containing a CodeQL query - and all its dependencies - type: string - repositories: - type: array - description: List of repository names (in the form `owner/repo-name`) - to run the query against. Precisely one property from `repositories`, - `repository_lists` and `repository_owners` is required. - items: - type: string - repository_lists: - description: List of repository lists to run the query against. - Precisely one property from `repositories`, `repository_lists` - and `repository_owners` is required. - type: array - maxItems: 1 - items: - type: string - repository_owners: - description: List of organization or user names whose repositories - the query should be run against. Precisely one property from `repositories`, - `repository_lists` and `repository_owners` is required. - type: array - maxItems: 1 - items: - type: string - required: - - language - - query_pack - oneOf: - - required: - - repositories - - required: - - repository_lists - - required: - - repository_owners - examples: - repositories_parameter: - summary: Using the "repositories" field. "query_pack" is abridged - for brevity. - value: - language: csharp - query_pack: aGVsbG8= - repositories: - - octocat/Hello-World - - octocat/example - repository_owners: - summary: Using the "repository_owners" field. "query_pack" is abridged. - value: - language: csharp - query_pack: aGVsbG8= - repository_owners: - - octocat - repository_lists: - summary: Using the "repository_lists" field. "query_pack" is abridged. - value: - language: csharp - query_pack: aGVsbG8= - repository_lists: - - top-100-csharp - responses: - '201': - description: Variant analysis submitted for processing - content: - application/json: - schema: &462 - title: Variant Analysis - description: A run of a CodeQL query against one or more repositories. - type: object - properties: - id: - type: integer - description: The ID of the variant analysis. - controller_repo: *66 - actor: *4 - query_language: *458 - query_pack_url: - type: string - description: The download url for the query pack. - created_at: - type: string - format: date-time - description: The date and time at which the variant analysis was - created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - updated_at: - type: string - format: date-time - description: The date and time at which the variant analysis was - last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - completed_at: - type: string - format: date-time - nullable: true - description: The date and time at which the variant analysis was - completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will - be null if the variant analysis has not yet completed or this - information is not available. - status: - type: string - enum: - - in_progress - - succeeded - - failed - - cancelled - actions_workflow_run_id: - type: integer - description: The GitHub Actions workflow run used to execute this - variant analysis. This is only available if the workflow run - has started. - failure_reason: - type: string - enum: - - no_repos_queried - - actions_workflow_run_failed - - internal_error - description: The reason for a failure of the variant analysis. - This is only available if the variant analysis has failed. - scanned_repositories: - type: array - items: - type: object - properties: - repository: &459 - title: Repository Identifier - description: Repository Identifier - type: object - properties: - id: - type: integer - example: 1296269 - description: A unique identifier of the repository. - name: - type: string - example: Hello-World - description: The name of the repository. - full_name: - type: string - example: octocat/Hello-World - description: The full, globally unique, name of the - repository. - private: - type: boolean - description: Whether the repository is private. - stargazers_count: - type: integer - example: 80 - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - required: - - full_name - - id - - name - - private - - stargazers_count - - updated_at - analysis_status: &463 - type: string - description: The new status of the CodeQL variant analysis - repository task. - enum: - - pending - - in_progress - - succeeded - - failed - - canceled - - timed_out - result_count: - type: integer - description: The number of results in the case of a successful - analysis. This is only available for successful analyses. - artifact_size_in_bytes: - type: integer - description: The size of the artifact. This is only available - for successful analyses. - failure_message: - type: string - description: The reason of the failure of this repo task. - This is only available if the repository task has failed. - required: - - repository - - analysis_status - skipped_repositories: - type: object - description: Information about repositories that were skipped - from processing. This information is only available to the user - that initiated the variant analysis. - properties: - access_mismatch_repos: &460 - type: object - properties: - repository_count: - type: integer - description: The total number of repositories that were - skipped for this reason. - example: 2 - repositories: - type: array - description: A list of repositories that were skipped. - This list may not include all repositories that were - skipped. This is only available when the repository - was found and the user has access to it. - items: *459 - required: - - repository_count - - repositories - not_found_repos: - type: object - properties: - repository_count: - type: integer - description: The total number of repositories that were - skipped for this reason. - example: 2 - repository_full_names: - type: array - description: A list of full repository names that were - skipped. This list may not include all repositories - that were skipped. - items: - type: string - required: - - repository_count - - repository_full_names - no_codeql_db_repos: *460 - over_limit_repos: *460 - required: - - access_mismatch_repos - - not_found_repos - - no_codeql_db_repos - - over_limit_repos - required: - - id - - controller_repo - - actor - - query_language - - query_pack_url - - status - examples: - repositories_parameter: - summary: Response for a successful variant analysis submission - value: &461 - summary: Default response - value: - id: 1 - controller_repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - query_language: python - query_pack_url: https://www.example.com - created_at: '2022-09-12T12:14:32Z' - updated_at: '2022-09-12T12:14:32Z' - completed_at: '2022-09-12T13:15:33Z' - status: succeeded - actions_workflow_run_id: 3453588 - scanned_repositories: - - repository: - id: 1296269 - name: Hello-World - full_name: octocat/Hello-World - private: false - analysis_status: succeeded - result_count: 532 - artifact_size_in_bytes: 12345 - skipped_repositories: - access_mismatch_repos: - repository_count: 2 - repositories: - - id: 1 - name: octo-repo1 - full_name: octo-org/octo-repo1 - private: false - - id: 2 - name: octo-repo2 - full_name: octo-org/octo-repo2 - private: false - not_found_repos: - repository_count: 3 - repository_full_names: - - octo-org/octo-repo4 - - octo-org/octo-repo5 - - octo-org/octo-repo6 - no_codeql_db_repos: - repository_count: 2 - repositories: - - id: 7 - name: octo-repo7 - full_name: octo-org/octo-repo7 - private: false - - id: 8 - name: octo-repo8 - full_name: octo-org/octo-repo8 - private: false - over_limit_repos: - repository_count: 2 - repositories: - - id: 9 - name: octo-repo9 - full_name: octo-org/octo-repo9 - private: false - - id: 10 - name: octo-repo10 - full_name: octo-org/octo-repo10 - private: false - repository_owners: - summary: Response for a successful variant analysis submission - value: *461 - repository_lists: - summary: Response for a successful variant analysis submission - value: *461 - '404': *6 - '422': - description: Unable to process variant analysis submission - content: - application/json: - schema: *3 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": - get: - summary: Get the summary of a CodeQL variant analysis - description: |- - Gets the summary of a CodeQL variant analysis. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/get-variant-analysis - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis - parameters: - - *344 - - *345 - - name: codeql_variant_analysis_id - in: path - description: The unique identifier of the variant analysis. - schema: - type: integer - required: true - responses: - '200': - description: Response - content: - application/json: - schema: *462 - examples: - default: *461 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": - get: - summary: Get the analysis status of a repository in a CodeQL variant analysis - description: |- - Gets the analysis status of a repository in a CodeQL variant analysis. - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/get-variant-analysis-repo-task - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis - parameters: - - *344 - - name: repo - in: path - description: The name of the controller repository. - schema: - type: string - required: true - - name: codeql_variant_analysis_id - in: path - description: The ID of the variant analysis. - schema: - type: integer - required: true - - name: repo_owner - in: path - description: The account owner of the variant analysis repository. The name - is not case sensitive. - schema: - type: string - required: true - - name: repo_name - in: path - description: The name of the variant analysis repository. - schema: - type: string - required: true - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - repository: *66 - analysis_status: *463 - artifact_size_in_bytes: - type: integer - description: The size of the artifact. This is only available - for successful analyses. - result_count: - type: integer - description: The number of results in the case of a successful - analysis. This is only available for successful analyses. - failure_message: - type: string - description: The reason of the failure of this repo task. This - is only available if the repository task has failed. - database_commit_sha: - type: string - description: The SHA of the commit the CodeQL database was built - against. This is only available for successful analyses. - source_location_prefix: - type: string - description: The source location prefix to use. This is only available - for successful analyses. - artifact_url: - type: string - description: The URL of the artifact. This is only available for - successful analyses. - required: - - repository - - analysis_status - examples: - default: - summary: Default response - value: - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - analysis_status: succeeded - artifact_size_in_bytes: 12345 - result_count: 532 - database_commit_sha: 2d870c2a717a524627af38fa2da382188a096f90 - source_location_prefix: "/" - artifact_url: https://example.com - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/default-setup": - get: - summary: Get a code scanning default setup configuration - description: |- - Gets a code scanning default setup configuration. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/get-default-setup - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - description: Configuration for code scanning default setup. - type: object - properties: - state: - description: Code scanning default setup has been configured or - not. - type: string - enum: - - configured - - not-configured - languages: - description: Languages to be analyzed. - type: array - items: - type: string - enum: - - actions - - c-cpp - - csharp - - go - - java-kotlin - - javascript-typescript - - javascript - - python - - ruby - - typescript - - swift - runner_type: - description: Runner type to be used. - nullable: true - type: string - enum: - - standard - - labeled - runner_label: - description: Runner label to be used if the runner type is labeled. - nullable: true - type: string - example: code-scanning - query_suite: - description: CodeQL query suite to be used. - type: string - enum: - - default - - extended - threat_model: - description: Threat model to be used for code scanning analysis. - Use `remote` to analyze only network sources and `remote_and_local` - to include local sources like filesystem access, command-line - arguments, database reads, environment variable and standard - input. - type: string - enum: - - remote - - remote_and_local - updated_at: - description: Timestamp of latest configuration update. - nullable: true - type: string - format: date-time - example: '2023-12-06T14:20:20.000Z' - schedule: - description: The frequency of the periodic analysis. - nullable: true - type: string - enum: - - weekly - x-github-breaking-changes: - - changeset: remove_single_js_ts - patch: - properties: - languages: - items: - enum: - - actions - - c-cpp - - csharp - - go - - java-kotlin - - javascript-typescript - - python - - ruby - - swift - version: '2026-03-10' - examples: - default: - value: - state: configured - languages: - - ruby - - python - query_suite: default - threat_model: remote - updated_at: '2023-01-19T11:21:34Z' - schedule: weekly - '403': *441 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - patch: - summary: Update a code scanning default setup configuration - description: |- - Updates a code scanning default setup configuration. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - tags: - - code-scanning - operationId: code-scanning/update-default-setup - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - description: Configuration for code scanning default setup. - type: object - properties: - state: - description: The desired state of code scanning default setup. - type: string - enum: - - configured - - not-configured - runner_type: - description: Runner type to be used. - type: string - enum: - - standard - - labeled - runner_label: - nullable: true - description: Runner label to be used if the runner type is labeled. - type: string - example: code-scanning - query_suite: - description: CodeQL query suite to be used. - type: string - enum: - - default - - extended - threat_model: - description: Threat model to be used for code scanning analysis. - Use `remote` to analyze only network sources and `remote_and_local` - to include local sources like filesystem access, command-line - arguments, database reads, environment variable and standard input. - type: string - enum: - - remote - - remote_and_local - languages: - description: CodeQL languages to be analyzed. - type: array - items: - type: string - enum: - - actions - - c-cpp - - csharp - - go - - java-kotlin - - javascript-typescript - - python - - ruby - - swift - additionalProperties: false - examples: - default: - value: - state: configured - threat_model: remote_and_local - responses: - '200': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '202': - description: Response - content: - application/json: - schema: - description: |- - You can use `run_url` to track the status of the run. This includes a property status and conclusion. - You should not rely on this always being an actions workflow run object. - type: object - properties: - run_id: - description: ID of the corresponding run. - type: integer - run_url: - description: URL of the corresponding run. - type: string - examples: - default: - value: - run_id: 42 - run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *447 - '404': *6 - '409': - description: Response if there is already a validation run in progress with - a different default setup configuration - content: - application/json: - schema: *3 - '422': - description: Response if the configuration change cannot be made because - the repository is not in the required state - content: - application/json: - schema: *3 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/sarifs": - post: - summary: Upload an analysis as SARIF data - description: "Uploads SARIF data containing the results of a code scanning analysis - to make the results available in a repository. For troubleshooting information, - see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere - are two places where you can upload code scanning results.\n - If you upload - to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, - then the results appear as alerts in a pull request check. For more information, - see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - - If you upload to a branch, for example `--ref refs/heads/my-branch`, then - the results appear in the **Security** tab for your repository. For more information, - see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou - must compress the SARIF-formatted analysis data that you want to upload, using - `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip - -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum - number of entries per the following data objects, and an analysis will be - rejected if any of these objects is above its maximum value. For some objects, - there are additional values over which the entries will be ignored while keeping - the most important entries whenever applicable.\nTo get the most out of your - analysis when it includes data above the supported limits, try to optimize - the analysis configuration. For example, for the CodeQL tool, identify and - remove the most noisy queries. For more information, see \"[SARIF results - exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| - **SARIF data** | **Maximum values** | **Additional limits** - \ |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| - Runs per file | 20 | |\n| - Results per run | 25,000 | Only the top 5,000 - results will be included, prioritized by severity. |\n| Rules per - run | 25,000 | |\n| - Tool extensions per run | 100 | |\n| - Thread Flow Locations per result | 10,000 | Only the top 1,000 - Thread Flow Locations will be included, using prioritization. |\n| Location - per result\t | 1,000 | Only 100 locations will be - included. |\n| Tags per rule\t - \ | 20 | Only 10 tags will be included. |\n\n\nThe - `202 Accepted` response includes an `id` value.\nYou can use this ID to check - the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor - more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth - app tokens and personal access tokens (classic) need the `security_events` - scope to use this endpoint with private or public repositories, or the `public_repo` - scope to use this endpoint with only public repositories.\n\nThis endpoint - is limited to 1,000 requests per hour for each user or app installation calling - it." - operationId: code-scanning/upload-sarif - tags: - - code-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - commit_sha: *464 - ref: - type: string - description: |- - The full Git reference, formatted as `refs/heads/`, - `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. - pattern: "^refs/(heads|tags|pull)/.*$" - example: refs/heads/main - sarif: - description: A Base64 string representing the SARIF file to upload. - You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) - and then translate the contents of the file into a Base64 encoding - string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." - type: string - checkout_uri: - description: |- - The base directory used in the analysis, as it appears in the SARIF file. - This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. - example: file:///github/workspace/ - type: string - format: uri - started_at: - description: 'The time that the analysis run began. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - type: string - tool_name: - description: The name of the tool used to generate the code scanning - analysis. If this parameter is not used, the tool name defaults - to "API". If the uploaded SARIF contains a tool GUID, this will - be available for filtering using the `tool_guid` parameter of - operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. - type: string - validate: - description: |- - Whether the SARIF file will be validated according to the code scanning specifications. - This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. - type: boolean - additionalProperties: false - required: - - commit_sha - - ref - - sarif - examples: - default: - value: - commit_sha: 4b6472266afd7b471e86085a6659e8c7f2b119da - ref: refs/heads/master - sarif: H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA - responses: - '202': - description: Response - content: - application/json: - schema: - type: object - properties: - id: *455 - url: - type: string - description: The REST API URL for checking the status of the upload. - format: uri - readOnly: true - examples: - default: - summary: Default response - value: - id: 47177e22-5596-11eb-80a1-c1e54ef945c6 - url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 - '400': - description: Bad Request if the sarif field is invalid - '403': *447 - '404': *6 - '413': - description: Payload Too Large if the sarif field is too large - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": - get: - summary: Get information about a SARIF upload - description: |- - Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - operationId: code-scanning/get-sarif - tags: - - code-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload - parameters: - - *344 - - *345 - - name: sarif_id - description: The SARIF ID obtained after uploading. - in: path - schema: - type: string - required: true - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - processing_status: - type: string - enum: - - pending - - complete - - failed - description: "`pending` files have not yet been processed, while - `complete` means results from the SARIF have been stored. `failed` - files have either not been processed at all, or could only be - partially processed." - analyses_url: - type: string - description: The REST API URL for getting the analyses associated - with the upload. - format: uri - readOnly: true - nullable: true - errors: - type: array - items: - type: string - description: Any errors that ocurred during processing of the - delivery. - readOnly: true - nullable: true - examples: - default: - summary: Default response - value: - processing_status: complete - analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *441 - '404': - description: Not Found if the sarif id does not match any upload - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: code-scanning - subcategory: code-scanning - "/repos/{owner}/{repo}/code-security-configuration": - get: - summary: Get the code security configuration associated with a repository - description: |- - Get the code security configuration that manages a repository's code security settings. - - The authenticated user must be an administrator or security manager for the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - code-security - operationId: code-security/get-configuration-for-repository - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - description: Code security configuration associated with a repository - and attachment status - properties: - status: - type: string - description: The attachment status of the code security configuration - on the repository. - enum: - - attached - - attaching - - detached - - removed - - enforced - - failed - - updating - - removed_by_enterprise - configuration: *49 - examples: - default: - value: - status: attached - configuration: - id: 1325 - target_type: organization - name: octo-org recommended settings - description: This is a code security configuration for octo-org - advanced_security: enabled - dependency_graph: enabled - dependency_graph_autosubmit_action: enabled - dependency_graph_autosubmit_action_options: - labeled_runners: false - dependabot_alerts: enabled - dependabot_security_updates: not_set - code_scanning_default_setup: disabled - code_scanning_delegated_alert_dismissal: disabled - secret_scanning: enabled - secret_scanning_push_protection: disabled - secret_scanning_delegated_bypass: disabled - secret_scanning_validity_checks: disabled - secret_scanning_non_provider_patterns: disabled - secret_scanning_generic_secrets: disabled - secret_scanning_delegated_alert_dismissal: disabled - private_vulnerability_reporting: disabled - enforcement: enforced - url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 - html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 - created_at: '2024-05-01T00:00:00Z' - updated_at: '2024-05-01T00:00:00Z' - '204': *191 - '304': *37 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: code-security - subcategory: configurations - "/repos/{owner}/{repo}/codeowners/errors": - get: - summary: List CODEOWNERS errors - description: |- - List any syntax errors that are detected in the CODEOWNERS - file. - - For more information about the correct CODEOWNERS syntax, - see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - tags: - - repos - operationId: repos/codeowners-errors - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-codeowners-errors - parameters: - - *344 - - *345 - - name: ref - description: 'A branch, tag or commit name used to determine which version - of the CODEOWNERS file to use. Default: the repository''s default branch - (e.g. `main`)' - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: CODEOWNERS errors - description: A list of errors found in a repo's CODEOWNERS file - type: object - properties: - errors: - type: array - items: - type: object - properties: - line: - description: The line number where this errors occurs. - type: integer - example: 7 - column: - description: The column number where this errors occurs. - type: integer - example: 3 - source: - description: The contents of the line where the error occurs. - type: string - example: "* user" - kind: - description: The type of error. - type: string - example: Invalid owner - suggestion: - description: Suggested action to fix the error. This will - usually be `null`, but is provided for some common errors. - type: string - nullable: true - example: The pattern `/` will never match anything, did - you mean `*` instead? - message: - description: A human-readable description of the error, - combining information from multiple fields, laid out for - display in a monospaced typeface (for example, a command-line - setting). - type: string - example: |- - Invalid owner on line 7: - - * user - ^ - path: - description: The path of the file where the error occured. - type: string - example: ".github/CODEOWNERS" - required: - - line - - column - - kind - - message - - path - required: - - errors - examples: - default: - value: - errors: - - line: 3 - column: 1 - kind: Invalid pattern - source: "***/*.rb @monalisa" - suggestion: Did you mean `**/*.rb`? - message: |- - Invalid pattern on line 3: Did you mean `**/*.rb`? - - ***/*.rb @monalisa - ^ - path: ".github/CODEOWNERS" - - line: 7 - column: 7 - kind: Invalid owner - source: "*.txt docs@" - suggestion: - message: |- - Invalid owner on line 7: - - *.txt docs@ - ^ - path: ".github/CODEOWNERS" - '404': - description: Resource not found - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: repos - subcategory: repos - "/repos/{owner}/{repo}/codespaces": - get: - summary: List codespaces in a repository for the authenticated user - description: |- - Lists the codespaces associated to a specified repository and the authenticated user. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-in-repository-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user - parameters: - - *17 - - *19 - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - codespaces - properties: - total_count: - type: integer - codespaces: - type: array - items: *248 - examples: - default: - value: - total_count: 2 - codespaces: - - id: 1 - name: monalisa-octocat-hello-world-g4wpq6h95q - environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer/devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop - recent_folders: [] - - id: 2 - name: monalisa-octocat-hello-world-3f89ada1j3 - environment_id: 526ce4d7-46da-494f-a4f9-cfd25b818719 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer/devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3 - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - web_url: https://monalisa-octocat-hello-world-3f89ada1j3.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop - recent_folders: [] - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - post: - summary: Create a codespace in a repository - description: |- - Creates a codespace owned by the authenticated user in the specified repository. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/create-with-repo-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - nullable: true - properties: - ref: - description: Git ref (typically a branch name) for this codespace - type: string - location: - description: The requested location for a new codespace. Best efforts - are made to respect this upon creation. Assigned by IP if not - provided. - type: string - geo: - description: The geographic area for this codespace. If not specified, - the value is assigned by IP. This property replaces `location`, - which is closing down. - type: string - enum: - - EuropeWest - - SoutheastAsia - - UsEast - - UsWest - client_ip: - description: IP for location auto-detection when proxying a request - type: string - machine: - description: Machine type to use for this codespace - type: string - devcontainer_path: - description: Path to devcontainer.json config to use for this codespace - type: string - multi_repo_permissions_opt_out: - description: Whether to authorize requested permissions from devcontainer.json - type: boolean - working_directory: - description: Working directory for this codespace - type: string - idle_timeout_minutes: - description: Time in minutes before codespace stops from inactivity - type: integer - display_name: - description: Display name for this codespace - type: string - retention_period_minutes: - description: Duration in minutes after codespace has gone idle in - which it will be deleted. Must be integer minutes between 0 and - 43200 (30 days). - type: integer - examples: - default: - value: - ref: main - machine: standardLinux32gb - responses: - '201': - description: Response when the codespace was successfully created - content: - application/json: - schema: *248 - examples: - default: *465 - '202': - description: Response when the codespace creation partially failed but is - being retried in the background - content: - application/json: - schema: *248 - examples: - default: *465 - '400': *14 - '401': *25 - '403': *29 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/repos/{owner}/{repo}/codespaces/devcontainers": - get: - summary: List devcontainer configurations in a repository for the authenticated - user - description: |- - Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files - specify launchpoint configurations for codespaces created within the repository. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user - parameters: - - *17 - - *19 - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - devcontainers - properties: - total_count: - type: integer - devcontainers: - type: array - items: - type: object - required: - - path - properties: - path: - type: string - name: - type: string - display_name: - type: string - examples: - default: - value: - devcontainers: - - path: ".devcontainer/foobar/devcontainer.json" - name: foobar - display_name: foobar - - path: ".devcontainer/devcontainer.json" - name: kitchensink - display_name: kitchensink - - path: ".devcontainer.json" - display_name: Default project configuration - total_count: 3 - '500': *55 - '400': *14 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: codespaces - "/repos/{owner}/{repo}/codespaces/machines": - get: - summary: List available machine types for a repository - description: |- - List the machine types available for a given repository based on its configuration. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/repo-machines-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository - parameters: - - *344 - - *345 - - name: location - description: The location to check for available machines. Assigned by IP - if not provided. - in: query - schema: - type: string - example: WestUs2 - - name: client_ip - description: IP for location auto-detection when proxying a request - in: query - schema: - type: string - - name: ref - description: The branch or commit to check for prebuild availability and devcontainer - restrictions. - in: query - schema: - type: string - example: main - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - machines - properties: - total_count: - type: integer - machines: - type: array - items: &690 - type: object - title: Codespace machine - description: A description of the machine powering a codespace. - properties: *466 - required: *467 - examples: - default: &691 - value: - total_count: 2 - machines: - - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - - name: premiumLinux - display_name: 8 cores, 32 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 34359738368 - cpus: 8 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: machines - "/repos/{owner}/{repo}/codespaces/new": - get: - summary: Get default attributes for a codespace - description: |- - Gets the default attributes for codespaces created by the user with the repository. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/pre-flight-with-repo-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace - parameters: - - *344 - - *345 - - name: ref - description: The branch or commit to check for a default devcontainer path. - If not specified, the default branch will be checked. - in: query - schema: - type: string - example: main - - name: client_ip - description: An alternative IP for default location auto-detection, such as - when proxying a request. - in: query - schema: - type: string - example: 1.2.3.4 - responses: - '200': - description: Response when a user is able to create codespaces from the - repository. - content: - application/json: - schema: - type: object - properties: - billable_owner: *4 - defaults: - type: object - required: - - location - - devcontainer_path - properties: - location: - type: string - devcontainer_path: - type: string - nullable: true - examples: - default: - value: - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - defaults: - location: EastUs - devcontainer_path: ".devcontainer/devcontainer.json" - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: codespaces - "/repos/{owner}/{repo}/codespaces/permissions_check": - get: - summary: Check if permissions defined by a devcontainer have been accepted by - the authenticated user - description: |- - Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/check-permissions-for-devcontainer - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user - parameters: - - *344 - - *345 - - name: ref - description: The git reference that points to the location of the devcontainer - configuration to use for the permission check. The value of `ref` will typically - be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git - References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - in: query - required: true - schema: - type: string - example: master - - name: devcontainer_path - description: Path to the devcontainer.json configuration to use for the permission - check. - in: query - required: true - schema: - type: string - example: ".devcontainer/example/devcontainer.json" - responses: - '200': - description: Response when the permission check is successful - content: - application/json: - schema: - title: Codespaces Permissions Check - description: Permission check result for a given devcontainer config. - type: object - properties: - accepted: - description: Whether the user has accepted the permissions defined - by the devcontainer config - example: true - type: boolean - required: - - accepted - examples: - default: - value: - accepted: true - '401': *25 - '403': *29 - '404': *6 - '422': *15 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: codespaces - "/repos/{owner}/{repo}/codespaces/secrets": - get: - summary: List repository secrets - description: |- - Lists all development environment secrets available in a repository without revealing their encrypted - values. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-repo-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &471 - title: Codespaces Secret - description: Set repository secrets for GitHub Codespaces. - type: object - properties: - name: - description: The name of the secret. - example: SECRET_TOKEN - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - created_at - - updated_at - examples: - default: *468 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: repository-secrets - "/repos/{owner}/{repo}/codespaces/secrets/public-key": - get: - summary: Get a repository public key - description: |- - Gets your public key, which you need to encrypt secrets. You need to - encrypt a secret before you can create or update secrets. - - If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-repo-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *469 - examples: - default: *470 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: repository-secrets - "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": - get: - summary: Get a repository secret - description: |- - Gets a single repository development environment secret without revealing its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret - parameters: - - *344 - - *345 - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *471 - examples: - default: *472 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: repository-secrets - put: - summary: Create or update a repository secret - description: |- - Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. - tags: - - codespaces - operationId: codespaces/create-or-update-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret - parameters: - - *344 - - *345 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get a repository public - key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: repository-secrets - delete: - summary: Delete a repository secret - description: |- - Deletes a development environment secret in a repository using the secret name. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. - tags: - - codespaces - operationId: codespaces/delete-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret - parameters: - - *344 - - *345 - - *168 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: codespaces - subcategory: repository-secrets - "/repos/{owner}/{repo}/collaborators": - get: - summary: List repository collaborators - description: |- - For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. - There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. - - Team members will include the members of child teams. - - The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. - OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - tags: - - repos - operationId: repos/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators - parameters: - - *344 - - *345 - - name: affiliation - description: Filter collaborators returned by their affiliation. `outside` - means all outside collaborators of an organization-owned repository. `direct` - means all collaborators with permissions to an organization-owned repository, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - name: permission - description: Filter collaborators by the permissions they have on the repository. - If not specified, all collaborators will be returned. - in: query - required: false - schema: - type: string - enum: - - pull - - triage - - push - - maintain - - admin - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Collaborator - description: Collaborator - type: object - properties: &473 - login: - type: string - example: octocat - id: - type: integer - format: int64 - example: 1 - email: - nullable: true - type: string - name: - nullable: true - type: string - node_id: - type: string - example: MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - gravatar_id: - type: string - example: 41d064eb2195891e12d0413f63227ea7 - nullable: true - url: - type: string - format: uri - example: https://api.github.com/users/octocat - html_url: - type: string - format: uri - example: https://github.com/octocat - followers_url: - type: string - format: uri - example: https://api.github.com/users/octocat/followers - following_url: - type: string - example: https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - example: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: - type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: - type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: - type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: - type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: - type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: - type: string - format: uri - example: https://api.github.com/users/octocat/received_events - type: - type: string - example: User - site_admin: - type: boolean - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - push - - admin - role_name: - type: string - example: admin - user_view_type: - type: string - example: public - required: &474 - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - - role_name - examples: - default: - value: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - permissions: - pull: true - triage: true - push: true - maintain: false - admin: false - role_name: write - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: collaborators - "/repos/{owner}/{repo}/collaborators/{username}": - get: - summary: Check if a user is a repository collaborator - description: |- - For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - - Team members will include the members of child teams. - - The authenticated user must have push access to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - tags: - - repos - operationId: repos/check-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator - parameters: - - *344 - - *345 - - *71 - responses: - '204': - description: Response if user is a collaborator - '404': - description: Not Found if user is not a collaborator - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: collaborators - put: - summary: Add a repository collaborator - description: |- - Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). - - Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. - - For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: - - ``` - Cannot assign {member} permission of {role name} - ``` - - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - - The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). - - For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. - - **Updating an existing collaborator's permission level** - - The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. - - **Rate limits** - - You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. - tags: - - repos - operationId: repos/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator - parameters: - - *344 - - *345 - - *71 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant the collaborator. **Only valid - on organization-owned repositories.** We accept the following - permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` - and you can also specify a custom repository role name, if the - owning organization has defined any.' - default: push - examples: - new-invitation-is-created: - summary: Add a collaborator with triage permissions - value: - permission: triage - responses: - '201': - description: Response when a new invitation is created - content: - application/json: - schema: &545 - title: Repository Invitation - description: Repository invitations let you manage who you collaborate - with. - type: object - properties: - id: - description: Unique identifier of the repository invitation. - example: 42 - type: integer - format: int64 - repository: *160 - invitee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - inviter: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - permissions: - description: The permission associated with the invitation. - example: read - type: string - enum: - - read - - write - - admin - - triage - - maintain - created_at: - type: string - format: date-time - example: '2016-06-13T14:52:50-05:00' - expired: - description: Whether or not the invitation has expired - type: boolean - url: - description: URL for the repository invitation - example: https://api.github.com/user/repository-invitations/1 - type: string - html_url: - type: string - example: https://github.com/octocat/Hello-World/invitations - node_id: - type: string - required: - - id - - node_id - - permissions - - inviter - - invitee - - repository - - url - - html_url - - created_at - examples: - new-invitation-is-created: - value: - id: 1 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - invitee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - inviter: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - permissions: write - created_at: '2016-06-13T14:52:50-05:00' - url: https://api.github.com/user/repository_invitations/1296269 - html_url: https://github.com/octocat/Hello-World/invitations - '204': - description: |- - Response when: - - an existing collaborator is added as a collaborator - - an organization member is added as an individual collaborator - - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - '422': - description: |- - Response when: - - validation failed, or the endpoint has been spammed - - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts - content: - application/json: - schema: *129 - '403': *29 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: collaborators - delete: - summary: Remove a repository collaborator - description: |- - Removes a collaborator from a repository. - - To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - - This endpoint also: - - Cancels any outstanding invitations sent by the collaborator - - Unassigns the user from any issues - - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - - Unstars the repository - - Updates access permissions to packages - - Removing a user as a collaborator has the following effects on forks: - - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - - If the user had their own fork of the repository, the fork will be deleted. - - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - - > [!NOTE] - > A user can still have access to the repository through organization permissions like base repository permissions. - - Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - - For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - tags: - - repos - operationId: repos/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator - parameters: - - *344 - - *345 - - *71 - responses: - '204': - description: No Content when collaborator was removed from the repository. - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: collaborators - "/repos/{owner}/{repo}/collaborators/{username}/permission": - get: - summary: Get repository permissions for a user - description: |- - Checks the repository permission and role of a collaborator. - - The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. - The `role_name` attribute provides the name of the assigned role, including custom roles. The - `permission` can also be used to determine which base level of access the collaborator has to the repository. - - The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. - There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. - tags: - - repos - operationId: repos/get-collaborator-permission-level - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user - parameters: - - *344 - - *345 - - *71 - responses: - '200': - description: if user has admin permissions - content: - application/json: - schema: - title: Repository Collaborator Permission - description: Repository Collaborator Permission - type: object - properties: - permission: - type: string - role_name: - type: string - example: admin - user: - title: Collaborator - description: Collaborator - type: object - properties: *473 - required: *474 - nullable: true - required: - - permission - - role_name - - user - examples: - response-if-user-has-admin-permissions: - value: - permission: admin - role_name: admin - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: collaborators - "/repos/{owner}/{repo}/comments": - get: - summary: List commit comments for a repository - description: |- - Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - repos - operationId: repos/list-commit-comments-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &475 - title: Commit Comment - description: Commit Comment - type: object - properties: - html_url: - type: string - format: uri - url: - type: string - format: uri - id: - type: integer - node_id: - type: string - body: - type: string - path: - type: string - nullable: true - position: - type: integer - nullable: true - line: - type: integer - nullable: true - commit_id: - type: string - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - author_association: *82 - reactions: *83 - required: - - url - - html_url - - id - - node_id - - user - - position - - line - - path - - commit_id - - body - - author_association - - created_at - - updated_at - examples: - default: &480 - value: - - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 - url: https://api.github.com/repos/octocat/Hello-World/comments/1 - id: 1 - node_id: MDEzOkNvbW1pdENvbW1lbnQx - body: Great stuff - path: file1.txt - position: 4 - line: 14 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - author_association: COLLABORATOR - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: comments - "/repos/{owner}/{repo}/comments/{comment_id}": - get: - summary: Get a commit comment - description: |- - Gets a specified commit comment. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - repos - operationId: repos/get-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/comments#get-a-commit-comment - parameters: - - *344 - - *345 - - *101 - responses: - '200': - description: Response - content: - application/json: - schema: *475 - examples: - default: &481 - value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 - url: https://api.github.com/repos/octocat/Hello-World/comments/1 - id: 1 - node_id: MDEzOkNvbW1pdENvbW1lbnQx - body: Great stuff - path: file1.txt - position: 4 - line: 14 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: COLLABORATOR - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: comments - patch: - summary: Update a commit comment - description: |- - Updates the contents of a specified commit comment. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - repos - operationId: repos/update-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/comments#update-a-commit-comment - parameters: - - *344 - - *345 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The contents of the comment - required: - - body - examples: - default: - value: - body: Nice change - responses: - '200': - description: Response - content: - application/json: - schema: *475 - examples: - default: - value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 - url: https://api.github.com/repos/octocat/Hello-World/comments/1 - id: 1 - node_id: MDEzOkNvbW1pdENvbW1lbnQx - body: Nice change - path: file1.txt - position: 4 - line: 14 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: COLLABORATOR - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: comments - delete: - summary: Delete a commit comment - description: '' - tags: - - repos - operationId: repos/delete-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment - parameters: - - *344 - - *345 - - *101 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: comments - "/repos/{owner}/{repo}/comments/{comment_id}/reactions": - get: - summary: List reactions for a commit comment - description: List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). - tags: - - reactions - operationId: reactions/list-for-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment - parameters: - - *344 - - *345 - - *101 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a commit comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &476 - title: Reaction - description: Reactions to conversations provide a way to help people - express their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - examples: - default: &549 - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - content: heart - created_at: '2016-05-20T20:09:31Z' - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a commit comment - description: Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). - A response with an HTTP `200` status means that you already added the reaction - type to this commit comment. - tags: - - reactions - operationId: reactions/create-for-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment - parameters: - - *344 - - *345 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the commit comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Reaction exists - content: - application/json: - schema: *476 - examples: - default: &477 - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - content: heart - created_at: '2016-05-20T20:09:31Z' - '201': - description: Reaction created - content: - application/json: - schema: *476 - examples: - default: *477 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": - delete: - summary: Delete a commit comment reaction - description: |- - > [!NOTE] - > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - - Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). - tags: - - reactions - operationId: reactions/delete-for-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction - parameters: - - *344 - - *345 - - *101 - - &550 - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/commits": - get: - summary: List commits - description: |- - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - repos - operationId: repos/list-commits - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/commits#list-commits - parameters: - - *344 - - *345 - - name: sha - description: 'SHA or branch to start listing commits from. Default: the repository’s - default branch (usually `main`).' - in: query - required: false - schema: - type: string - - name: path - description: Only commits containing this file path will be returned. - in: query - required: false - schema: - type: string - - name: author - description: GitHub username or email address to use to filter by commit author. - in: query - required: false - schema: - type: string - - name: committer - description: GitHub username or email address to use to filter by commit committer. - in: query - required: false - schema: - type: string - - name: since - description: 'Only show results that were last updated after the given time. - This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must - be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may - be returned.' - in: query - required: false - schema: - type: string - format: date-time - - name: until - description: 'Only commits before this date will be returned. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 - (inclusive) or unexpected results may be returned.' - in: query - required: false - schema: - type: string - format: date-time - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *478 - examples: - default: &601 - value: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - commit: - url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - author: - name: Monalisa Octocat - email: support@github.com - date: '2011-04-14T16:00:49Z' - committer: - name: Monalisa Octocat - email: support@github.com - date: '2011-04-14T16:00:49Z' - message: Fix all the bugs - tree: - url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - comment_count: 0 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - parents: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - headers: - Link: *67 - '500': *55 - '400': *14 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: commits - "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": - get: - summary: List branches for HEAD commit - description: |- - Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - tags: - - repos - operationId: repos/list-branches-for-head-commit - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit - parameters: - - *344 - - *345 - - &479 - name: commit_sha - description: The SHA of the commit. - in: path - required: true - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Branch Short - description: Branch Short - type: object - properties: - name: - type: string - commit: - type: object - properties: - sha: - type: string - url: - type: string - required: - - sha - - url - protected: - type: boolean - required: - - name - - commit - - protected - examples: - default: - value: - - name: branch_5 - commit: - sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc - url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc - protected: false - '422': *15 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: commits - "/repos/{owner}/{repo}/commits/{commit_sha}/comments": - get: - summary: List commit comments - description: |- - Lists the comments for a specified commit. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - repos - operationId: repos/list-comments-for-commit - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/comments#list-commit-comments - parameters: - - *344 - - *345 - - *479 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *475 - examples: - default: *480 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: comments - post: - summary: Create a commit comment - description: |- - Create a comment for a commit using its `:commit_sha`. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - repos - operationId: repos/create-commit-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/comments#create-a-commit-comment - parameters: - - *344 - - *345 - - *479 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The contents of the comment. - path: - type: string - description: Relative path of the file to comment on. - position: - type: integer - description: Line index in the diff to comment on. - line: - type: integer - description: "**Closing down notice**. Use **position** parameter - instead. Line number in the file to comment on." - required: - - body - examples: - default: - value: - body: Great stuff - path: file1.txt - position: 4 - line: 1 - responses: - '201': - description: Response - content: - application/json: - schema: *475 - examples: - default: *481 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/comments/1 - schema: - type: string - '403': *29 - '422': *15 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: comments - "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": - get: - summary: List pull requests associated with a commit - description: |- - Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. - - To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - tags: - - repos - operationId: repos/list-pull-requests-associated-with-commit - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit - parameters: - - *344 - - *345 - - *479 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *482 - examples: - default: &593 - value: - - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: 1 - node_id: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: 1347 - state: open - locked: true - title: Amazing new feature - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Please pull these awesome changes in! - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - active_lock_reason: too heated - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:01:12Z' - closed_at: '2011-01-26T19:01:12Z' - merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - requested_reviewers: - - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - requested_teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - permission: admin - notification_setting: notifications_enabled - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - head: - label: octocat:new-topic - ref: new-topic - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - base: - label: octocat:master - ref: master - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html: - href: https://github.com/octocat/Hello-World/pull/1347 - issue: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347 - comments: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - review_comments: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - statuses: - href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: OWNER - auto_merge: - draft: false - headers: - Link: *67 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: commits - "/repos/{owner}/{repo}/commits/{ref}": - get: - summary: Get a commit - description: |- - Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - - > [!NOTE] - > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - - - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - repos - operationId: repos/get-commit - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/commits#get-a-commit - parameters: - - *344 - - *345 - - *19 - - *17 - - &483 - name: ref - description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), - or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - in: path - required: true - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - content: - application/json: - schema: *478 - examples: - default: &580 - value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - commit: - url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - author: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - committer: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - message: Fix all the bugs - tree: - url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - comment_count: 0 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - parents: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - stats: - additions: 104 - deletions: 4 - total: 108 - files: - - filename: file1.txt - additions: 10 - deletions: 2 - changes: 12 - status: modified - raw_url: https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt - blob_url: https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt - patch: |- - @@ -29,7 +29,7 @@ - ..... - application/vnd.github.diff: - schema: - type: string - examples: - default: &492 - value: | - diff --git a/testfile b/testfile - index 9bdeaeb..912c7ef 100644 - --- a/testfile - +++ b/testfile - @@ -1 +1 @@ - -test - +test change - application/vnd.github.patch: - schema: - type: string - examples: - default: &493 - value: | - From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 - From: Mona Lisa <87831417+monalisa@users.noreply.github.com> - Date: Fri, 6 Mar 2026 11:18:45 +0000 - Subject: [PATCH] Change 'test' to 'test change' in testfile - - --- - testfile | 2 +- - 1 file changed, 1 insertion(+), 1 deletion(-) - - diff --git a/testfile b/testfile - index 9bdeaeb..912c7ef 100644 - --- a/testfile - +++ b/testfile - @@ -1 +1 @@ - -test - +test change - application/vnd.github.sha: - schema: - type: string - examples: - default: - value: ac3282a2725be3b1d4979169a7a311c89066af1c - '422': *15 - '404': *6 - '500': *55 - '503': *121 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: commits - "/repos/{owner}/{repo}/commits/{ref}/check-runs": - get: - summary: List check runs for a Git reference - description: |- - Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - - > [!NOTE] - > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - - If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - tags: - - checks - operationId: checks/list-for-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference - parameters: - - *344 - - *345 - - *483 - - *484 - - *485 - - name: filter - description: Filters check runs by their `completed_at` timestamp. `latest` - returns the most recent check runs. - in: query - required: false - schema: - type: string - enum: - - latest - - all - default: latest - - *17 - - *19 - - name: app_id - in: query - required: false - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - check_runs - properties: - total_count: - type: integer - check_runs: - type: array - items: *422 - examples: - default: *486 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: runs - "/repos/{owner}/{repo}/commits/{ref}/check-suites": - get: - summary: List check suites for a Git reference - description: |- - Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - - > [!NOTE] - > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - tags: - - checks - operationId: checks/list-suites-for-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference - parameters: - - *344 - - *345 - - *483 - - name: app_id - description: Filters check suites by GitHub App `id`. - in: query - required: false - schema: - type: integer - example: 1 - - *484 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - check_suites - properties: - total_count: - type: integer - check_suites: - type: array - items: *427 - examples: - default: - value: - total_count: 1 - check_suites: - - id: 5 - node_id: MDEwOkNoZWNrU3VpdGU1 - head_branch: master - head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 - status: completed - conclusion: neutral - url: https://api.github.com/repos/github/hello-world/check-suites/5 - before: 146e867f55c26428e5f9fade55a9bbf5e95a7912 - after: d6fde92930d4715a2b49857d24b940956b26d2d3 - pull_requests: [] - app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - single_file: write - events: - - push - - pull_request - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - delete_branch_on_merge: true - subscribers_count: 42 - network_count: 0 - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - head_commit: - id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d - message: |- - Merge pull request #6 from Spaceghost/patch-1 - - New line at end of file. - timestamp: '2016-10-10T00:00:00Z' - author: - name: The Octocat - email: octocat@nowhere.com - committer: - name: The Octocat - email: octocat@nowhere.com - latest_check_runs_count: 1 - check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: checks - subcategory: suites - "/repos/{owner}/{repo}/commits/{ref}/status": - get: - summary: Get the combined status for a specific reference - description: |- - Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - - - Additionally, a combined `state` is returned. The `state` is one of: - - * **failure** if any of the contexts report as `error` or `failure` - * **pending** if there are no statuses or a context is `pending` - * **success** if the latest status for all contexts is `success` - tags: - - repos - operationId: repos/get-combined-status-for-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference - parameters: - - *344 - - *345 - - *483 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Combined Commit Status - description: Combined Commit Status - type: object - properties: - state: - type: string - statuses: - type: array - items: - title: Simple Commit Status - type: object - properties: - description: - type: string - nullable: true - id: - type: integer - node_id: - type: string - state: - type: string - context: - type: string - target_url: - type: string - format: uri - nullable: true - required: - type: boolean - nullable: true - avatar_url: - type: string - nullable: true - format: uri - url: - type: string - format: uri - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - description - - id - - node_id - - state - - context - - target_url - - avatar_url - - url - - created_at - - updated_at - sha: - type: string - total_count: - type: integer - repository: *160 - commit_url: - type: string - format: uri - url: - type: string - format: uri - required: - - state - - sha - - total_count - - statuses - - repository - - commit_url - - url - examples: - default: - value: - state: success - statuses: - - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - avatar_url: https://github.com/images/error/hubot_happy.gif - id: 1 - node_id: MDY6U3RhdHVzMQ== - state: success - description: Build has completed successfully - target_url: https://ci.example.com/1000/output - context: continuous-integration/jenkins - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - avatar_url: https://github.com/images/error/other_user_happy.gif - id: 2 - node_id: MDY6U3RhdHVzMg== - state: success - description: Testing has completed successfully - target_url: https://ci.example.com/2000/output - context: security/brakeman - created_at: '2012-08-20T01:19:13Z' - updated_at: '2012-08-20T01:19:13Z' - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - total_count: 2 - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - commit_url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e - url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: statuses - "/repos/{owner}/{repo}/commits/{ref}/statuses": - get: - summary: List commit statuses for a reference - description: |- - Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - - This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - tags: - - repos - operationId: repos/list-commit-statuses-for-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference - parameters: - - *344 - - *345 - - *483 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &669 - title: Status - description: The status of a commit. - type: object - properties: - url: - type: string - avatar_url: - type: string - nullable: true - id: - type: integer - node_id: - type: string - state: - type: string - description: - type: string - nullable: true - target_url: - type: string - nullable: true - context: - type: string - created_at: - type: string - updated_at: - type: string - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - url - - avatar_url - - id - - node_id - - state - - description - - target_url - - context - - created_at - - updated_at - - creator - examples: - default: - value: - - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - avatar_url: https://github.com/images/error/hubot_happy.gif - id: 1 - node_id: MDY6U3RhdHVzMQ== - state: success - description: Build has completed successfully - target_url: https://ci.example.com/1000/output - context: continuous-integration/jenkins - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '301': *348 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: statuses - "/repos/{owner}/{repo}/community/profile": - get: - summary: Get community profile metrics - description: |- - Returns all community profile metrics for a repository. The repository cannot be a fork. - - The returned metrics include an overall health score, the repository description, the presence of documentation, the - detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, - README, and CONTRIBUTING files. - - The `health_percentage` score is defined as a percentage of how many of - the recommended community health files are present. For more information, see - "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." - - `content_reports_enabled` is only returned for organization-owned repositories. - tags: - - repos - operationId: repos/get-community-profile-metrics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Community Profile - description: Community Profile - type: object - properties: - health_percentage: - type: integer - example: 100 - description: - type: string - example: My first repository on GitHub! - nullable: true - documentation: - type: string - example: example.com - nullable: true - files: - type: object - properties: - code_of_conduct: - title: Code Of Conduct Simple - description: Code of Conduct Simple - type: object - properties: *487 - required: *488 - nullable: true - code_of_conduct_file: - title: Community Health File - type: object - properties: &489 - url: - type: string - format: uri - html_url: - type: string - format: uri - required: &490 - - url - - html_url - nullable: true - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - contributing: - title: Community Health File - type: object - properties: *489 - required: *490 - nullable: true - readme: - title: Community Health File - type: object - properties: *489 - required: *490 - nullable: true - issue_template: - title: Community Health File - type: object - properties: *489 - required: *490 - nullable: true - pull_request_template: - title: Community Health File - type: object - properties: *489 - required: *490 - nullable: true - required: - - code_of_conduct - - code_of_conduct_file - - license - - contributing - - readme - - issue_template - - pull_request_template - updated_at: - type: string - format: date-time - example: '2017-02-28T19:09:29Z' - nullable: true - content_reports_enabled: - type: boolean - example: true - required: - - health_percentage - - description - - documentation - - files - - updated_at - examples: - default: - value: - health_percentage: 100 - description: My first repository on GitHub! - documentation: - files: - code_of_conduct: - name: Contributor Covenant - key: contributor_covenant - url: https://api.github.com/codes_of_conduct/contributor_covenant - html_url: https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md - code_of_conduct_file: - url: https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md - html_url: https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md - contributing: - url: https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING - html_url: https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING - issue_template: - url: https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE - html_url: https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE - pull_request_template: - url: https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE - html_url: https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE - license: - name: MIT License - key: mit - spdx_id: MIT - url: https://api.github.com/licenses/mit - html_url: https://github.com/octocat/Hello-World/blob/master/LICENSE - node_id: MDc6TGljZW5zZW1pdA== - readme: - url: https://api.github.com/repos/octocat/Hello-World/contents/README.md - html_url: https://github.com/octocat/Hello-World/blob/master/README.md - updated_at: '2017-02-28T19:09:29Z' - content_reports_enabled: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: community - "/repos/{owner}/{repo}/compare/{basehead}": - get: - summary: Compare two commits - description: |- - Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." - - This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.diff`**: Returns the diff of the commit. - - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - - The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - - When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - - **Working with large comparisons** - - To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: - - - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. - - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. - - For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." - - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - repos - operationId: repos/compare-commits - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/commits#compare-two-commits - parameters: - - *344 - - *345 - - *19 - - *17 - - name: basehead - description: The base branch and head branch to compare. This parameter expects - the format `BASE...HEAD`. Both must be branch names in `repo`. To compare - with a branch that exists in a different repository in the same network - as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. - in: path - required: true - x-multi-segment: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Commit Comparison - description: Commit Comparison - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/compare/master...topic - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/compare/master...topic - permalink_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 - diff_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/compare/master...topic.diff - patch_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *478 - merge_base_commit: *478 - status: - type: string - enum: - - diverged - - ahead - - behind - - identical - example: ahead - ahead_by: - type: integer - example: 4 - behind_by: - type: integer - example: 5 - total_commits: - type: integer - example: 6 - commits: - type: array - items: *478 - files: - type: array - items: *491 - required: - - url - - html_url - - permalink_url - - diff_url - - patch_url - - base_commit - - merge_base_commit - - status - - ahead_by - - behind_by - - total_commits - - commits - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/compare/master...topic - html_url: https://github.com/octocat/Hello-World/compare/master...topic - permalink_url: https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 - diff_url: https://github.com/octocat/Hello-World/compare/master...topic.diff - patch_url: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - commit: - url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - author: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - committer: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - message: Fix all the bugs - tree: - url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - comment_count: 0 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - parents: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - merge_base_commit: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - commit: - url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - author: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - committer: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - message: Fix all the bugs - tree: - url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - comment_count: 0 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - parents: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - status: behind - ahead_by: 1 - behind_by: 2 - total_commits: 1 - commits: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e - comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments - commit: - url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - author: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - committer: - name: Monalisa Octocat - email: mona@github.com - date: '2011-04-14T16:00:49Z' - message: Fix all the bugs - tree: - url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - comment_count: 0 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - parents: - - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - files: - - sha: bbcd538c8e72b8c175046e27cc8f907076331401 - filename: file1.txt - status: added - additions: 103 - deletions: 21 - changes: 124 - blob_url: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt - raw_url: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e - patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ - module Test" - application/vnd.github.diff: - schema: - type: string - examples: - default: *492 - application/vnd.github.patch: - schema: - type: string - examples: - default: *493 - '404': *6 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: commits - "/repos/{owner}/{repo}/contents/{path}": - get: - summary: Get repository content - description: |- - Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - - If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - - If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - - If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - - **Notes**: - - - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). - - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - - If the requested file's size is: - - 1 MB or smaller: All features of this endpoint are supported. - - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - - Greater than 100 MB: This endpoint is not supported. - tags: - - repos - operationId: repos/get-content - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#get-repository-content - parameters: - - *344 - - *345 - - name: path - description: path parameter - in: path - required: true - schema: - type: string - x-multi-segment: true - - name: ref - description: 'The name of the commit/branch/tag. Default: the repository’s - default branch.' - in: query - required: false - schema: - type: string - requestBody: - required: false - content: - application/json: - examples: - response-if-content-is-a-file-github-object: - summary: Content is a file using the object media type - response-if-content-is-a-directory-github-object: - summary: Content is a directory using the object media type - response-if-content-is-a-file: - summary: Content is a file - response-if-content-is-a-directory: - summary: Content is a directory - response-if-content-is-a-symlink: - summary: Content is a symlink - response-if-content-is-a-submodule: - summary: Content is a submodule - responses: - '200': - description: Response - content: - application/vnd.github.object: - schema: - title: Content Tree - description: Content Tree - type: object - properties: - type: - type: string - size: - type: integer - name: - type: string - path: - type: string - sha: - type: string - content: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - entries: - type: array - items: - type: object - properties: - type: - type: string - size: - type: integer - name: - type: string - path: - type: string - sha: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - encoding: - type: string - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - examples: - response-if-content-is-a-file-github-object: &494 - summary: Response if content is a file - value: - type: file - encoding: base64 - size: 5362 - name: README.md - path: README.md - content: IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\nIHdvcmtmbG93Lgo=\n - sha: 3d21ec53a331a6f037a91c368710b99387d012c1 - url: https://api.github.com/repos/octokit/octokit.rb/contents/README.md - git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 - html_url: https://github.com/octokit/octokit.rb/blob/master/README.md - download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md - _links: - git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 - self: https://api.github.com/repos/octokit/octokit.rb/contents/README.md - html: https://github.com/octokit/octokit.rb/blob/master/README.md - response-if-content-is-a-directory-github-object: - summary: Response if content is a directory and the application/vnd.github.v3.object - media type is requested - value: - type: dir - size: 0 - name: src - path: src - sha: 2962be1c94eaae9794b3080790ec9d74b2fa8358 - url: https://api.github.com/repos/octocat/octorepo/contents/src?ref=main - git_url: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - html_url: https://github.com/octocat/octorepo/blob/main/src - download_url: https://raw.githubusercontent.com/octocat/octorepo/main/src - _links: - self: https://api.github.com/repos/octocat/octorepo/contents/src - git: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - html: https://github.com/octocat/octorepo/blob/main/src - entries: - - type: file - size: 625 - name: app.js - path: src/app.js - sha: fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - url: https://api.github.com/repos/octocat/octorepo/contents/src/app.js - git_url: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - html_url: https://github.com/octocat/octorepo/blob/main/src/app.js - download_url: https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js - _links: - self: https://api.github.com/repos/octocat/octorepo/contents/src/app.js - git: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - html: https://github.com/octocat/octorepo/blob/main/src/app.js - - type: dir - size: 0 - name: images - path: src/images - sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - url: https://api.github.com/repos/octocat/octorepo/contents/src/images - git_url: https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - html_url: https://github.com/octocat/octorepo/tree/main/src/images - download_url: - _links: - self: https://api.github.com/repos/octocat/octorepo/contents/src/images - git: https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - html: https://github.com/octocat/octorepo/tree/main/src/images - application/json: - schema: - oneOf: - - title: Content Directory - description: A list of directory items - type: array - items: - type: object - properties: - type: - type: string - enum: - - dir - - file - - submodule - - symlink - size: - type: integer - name: - type: string - path: - type: string - content: - type: string - sha: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - - &606 - title: Content File - description: Content File - type: object - properties: - type: - type: string - enum: - - file - encoding: - type: string - size: - type: integer - name: - type: string - path: - type: string - content: - type: string - sha: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - target: - type: string - example: '"actual/actual.md"' - submodule_git_url: - type: string - example: '"git://example.com/defunkt/dotjs.git"' - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - - content - - encoding - - title: Symlink Content - description: An object describing a symlink - type: object - properties: - type: - type: string - enum: - - symlink - target: - type: string - size: - type: integer - name: - type: string - path: - type: string - sha: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - - target - - title: Submodule Content - description: An object describing a submodule - type: object - properties: - type: - type: string - enum: - - submodule - submodule_git_url: - type: string - format: uri - size: - type: integer - name: - type: string - path: - type: string - sha: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - - submodule_git_url - examples: - response-if-content-is-a-file: *494 - response-if-content-is-a-directory: - summary: Response if content is a directory and the application/json - media type is requested - value: - - type: file - size: 625 - name: octokit.rb - path: lib/octokit.rb - sha: fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - url: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb - git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - html_url: https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb - download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb - _links: - self: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb - git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b - html: https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb - - type: dir - size: 0 - name: octokit - path: lib/octokit - sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - url: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit - git_url: https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - html_url: https://github.com/octokit/octokit.rb/tree/master/lib/octokit - download_url: - _links: - self: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit - git: https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - html: https://github.com/octokit/octokit.rb/tree/master/lib/octokit - response-if-content-is-a-symlink: - summary: Response if content is a symlink and the application/json - media type is requested - value: - type: symlink - target: "/path/to/symlink/target" - size: 23 - name: some-symlink - path: bin/some-symlink - sha: 452a98979c88e093d682cab404a3ec82babebb48 - url: https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink - git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48 - html_url: https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink - download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink - _links: - git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48 - self: https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink - html: https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink - response-if-content-is-a-submodule: - summary: Response if content is a submodule and the application/json - media type is requested - value: - type: submodule - submodule_git_url: git://github.com/jquery/qunit.git - size: 0 - name: qunit - path: test/qunit - sha: 6ca3721222109997540bd6d9ccd396902e0ad2f9 - url: https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master - git_url: https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9 - html_url: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 - download_url: - _links: - git: https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9 - self: https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master - html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 - '404': *6 - '403': *29 - '302': *495 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - x-github-breaking-changes: - - changeset: return_submodule_type_for_submodules_in_directory_lists - patch: - description: |- - Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - - If the content is a directory: The response will be an array of objects, one object for each item in the directory. - - If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - - If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - - **Notes**: - - - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). - - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - - If the requested file's size is: - - 1 MB or smaller: All features of this endpoint are supported. - - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - - Greater than 100 MB: This endpoint is not supported. - version: '2026-03-10' - put: - summary: Create or update file contents - description: |- - Creates a new file or replaces an existing file in a repository. - - > [!NOTE] - > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. - tags: - - repos - operationId: repos/create-or-update-file-contents - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents - parameters: - - *344 - - *345 - - name: path - description: path parameter - in: path - required: true - schema: - type: string - x-multi-segment: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: The commit message. - content: - type: string - description: The new file content, using Base64 encoding. - sha: - type: string - description: "**Required if you are updating a file**. The blob - SHA of the file being replaced." - branch: - type: string - description: 'The branch name. Default: the repository’s default - branch.' - committer: - type: object - description: 'The person that committed the file. Default: the authenticated - user.' - properties: - name: - type: string - description: The name of the author or committer of the commit. - You'll receive a `422` status code if `name` is omitted. - email: - type: string - description: The email of the author or committer of the commit. - You'll receive a `422` status code if `email` is omitted. - date: - type: string - example: '"2013-01-05T13:13:22+05:00"' - required: - - name - - email - author: - type: object - description: 'The author of the file. Default: The `committer` or - the authenticated user if you omit `committer`.' - properties: - name: - type: string - description: The name of the author or committer of the commit. - You'll receive a `422` status code if `name` is omitted. - email: - type: string - description: The email of the author or committer of the commit. - You'll receive a `422` status code if `email` is omitted. - date: - type: string - example: '"2013-01-15T17:13:22+05:00"' - required: - - name - - email - required: - - message - - content - examples: - example-for-creating-a-file: - summary: Example for creating a file - value: - message: my commit message - committer: - name: Monalisa Octocat - email: octocat@github.com - content: bXkgbmV3IGZpbGUgY29udGVudHM= - example-for-updating-a-file: - summary: Example for updating a file - value: - message: a new commit message - committer: - name: Monalisa Octocat - email: octocat@github.com - content: bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz - sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 - responses: - '200': - description: Response - content: - application/json: - schema: &496 - title: File Commit - description: File Commit - type: object - required: - - content - - commit - properties: - content: - type: object - properties: - name: - type: string - path: - type: string - sha: - type: string - size: - type: integer - url: - type: string - html_url: - type: string - git_url: - type: string - download_url: - type: string - type: - type: string - _links: - type: object - properties: - self: - type: string - git: - type: string - html: - type: string - nullable: true - commit: - type: object - properties: - sha: - type: string - node_id: - type: string - url: - type: string - html_url: - type: string - author: - type: object - properties: - date: - type: string - name: - type: string - email: - type: string - committer: - type: object - properties: - date: - type: string - name: - type: string - email: - type: string - message: - type: string - tree: - type: object - properties: - url: - type: string - sha: - type: string - parents: - type: array - items: - type: object - properties: - url: - type: string - html_url: - type: string - sha: - type: string - verification: - type: object - properties: - verified: - type: boolean - reason: - type: string - signature: - type: string - nullable: true - payload: - type: string - nullable: true - verified_at: - type: string - nullable: true - examples: - example-for-updating-a-file: - value: - content: - name: hello.txt - path: notes/hello.txt - sha: a56507ed892d05a37c6d6128c260937ea4d287bd - size: 9 - url: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt - html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt - git_url: https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd - download_url: https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt - type: file - _links: - self: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt - git: https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd - html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt - commit: - sha: 18a43cd8e1e3a79c786e3d808a73d23b6d212b16 - node_id: MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg== - url: https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16 - html_url: https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16 - author: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - committer: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - message: my commit message - tree: - url: https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f - sha: 9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f - parents: - - url: https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6 - html_url: https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6 - sha: da5a433788da5c255edad7979b328b67d79f53f6 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - '201': - description: Response - content: - application/json: - schema: *496 - examples: - example-for-creating-a-file: - value: - content: - name: hello.txt - path: notes/hello.txt - sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 - size: 9 - url: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt - html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt - git_url: https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3 - download_url: https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt - type: file - _links: - self: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt - git: https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3 - html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt - commit: - sha: 7638417db6d59f3c431d3e1f261cc637155684cd - node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd - html_url: https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd - author: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - committer: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - message: my commit message - tree: - url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb - sha: 691272480426f78a0138979dd3ce63b77f706feb - parents: - - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 - html_url: https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5 - sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - '404': *6 - '422': *15 - '409': - description: Conflict - content: - application/json: - schema: - oneOf: - - *3 - - &527 - description: Repository rule violation was detected - type: object - properties: - message: - type: string - documentation_url: - type: string - status: - type: string - metadata: - type: object - properties: - secret_scanning: - type: object - properties: - bypass_placeholders: - type: array - items: - type: object - properties: - placeholder_id: &661 - description: The ID of the push protection bypass - placeholder. This value is returned on any push - protected routes. - type: string - token_type: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - delete: - summary: Delete a file - description: |- - Deletes a file in a repository. - - You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - - The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - - You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - - > [!NOTE] - > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - tags: - - repos - operationId: repos/delete-file - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#delete-a-file - parameters: - - *344 - - *345 - - name: path - description: path parameter - in: path - required: true - schema: - type: string - x-multi-segment: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: The commit message. - sha: - type: string - description: The blob SHA of the file being deleted. - branch: - type: string - description: 'The branch name. Default: the repository’s default - branch' - committer: - type: object - description: object containing information about the committer. - properties: - name: - type: string - description: The name of the author (or committer) of the commit - email: - type: string - description: The email of the author (or committer) of the commit - author: - type: object - description: object containing information about the author. - properties: - name: - type: string - description: The name of the author (or committer) of the commit - email: - type: string - description: The email of the author (or committer) of the commit - required: - - message - - sha - examples: - default: - value: - message: my commit message - committer: - name: Monalisa Octocat - email: octocat@github.com - sha: 329688480d39049927147c162b9d2deaf885005f - responses: - '200': - description: Response - content: - application/json: - schema: *496 - examples: - default: - value: - content: - commit: - sha: 7638417db6d59f3c431d3e1f261cc637155684cd - node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd - html_url: https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd - author: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - committer: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - message: my commit message - tree: - url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb - sha: 691272480426f78a0138979dd3ce63b77f706feb - parents: - - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 - html_url: https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5 - sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - '422': *15 - '404': *6 - '409': *54 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - "/repos/{owner}/{repo}/contributors": - get: - summary: List repository contributors - description: |- - Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance. - - GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. - tags: - - repos - operationId: repos/list-contributors - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repository-contributors - parameters: - - *344 - - *345 - - name: anon - description: Set to `1` or `true` to include anonymous contributors in results. - in: query - required: false - schema: - type: string - - *17 - - *19 - responses: - '200': - description: If repository contains content - content: - application/json: - schema: - type: array - items: - title: Contributor - description: Contributor - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - avatar_url: - type: string - format: uri - gravatar_id: - type: string - nullable: true - url: - type: string - format: uri - html_url: - type: string - format: uri - followers_url: - type: string - format: uri - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - format: uri - organizations_url: - type: string - format: uri - repos_url: - type: string - format: uri - events_url: - type: string - received_events_url: - type: string - format: uri - type: - type: string - site_admin: - type: boolean - contributions: - type: integer - email: - type: string - name: - type: string - user_view_type: - type: string - required: - - contributions - - type - examples: - response-if-repository-contains-content: - value: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - contributions: 32 - headers: - Link: *67 - '204': - description: Response if repository is empty - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/dependabot/alerts": - get: - summary: List Dependabot alerts for a repository - description: OAuth app tokens and personal access tokens (classic) need the - `security_events` scope to use this endpoint. If this endpoint is only used - with public repositories, the token can use the `public_repo` scope instead. - tags: - - dependabot - operationId: dependabot/list-alerts-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository - parameters: - - *344 - - *345 - - *199 - - *200 - - *201 - - *202 - - *203 - - name: manifest - in: query - description: A comma-separated list of full manifest paths. If specified, - only alerts for these manifests will be returned. - schema: - type: string - - *204 - - *497 - - *205 - - *206 - - *207 - - *61 - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &501 - type: object - description: A Dependabot alert. - properties: - number: *178 - state: - type: string - description: The state of the Dependabot alert. - readOnly: true - enum: - - auto_dismissed - - dismissed - - fixed - - open - dependency: - type: object - description: Details for the vulnerable dependency. - readOnly: true - properties: - package: *62 - manifest_path: - type: string - description: The full path to the dependency manifest file, - relative to the root of the repository. - readOnly: true - scope: - type: string - description: The execution scope of the vulnerable dependency. - readOnly: true - nullable: true - enum: - - development - - runtime - relationship: - type: string - description: | - The vulnerable dependency's relationship to your project. - - > [!NOTE] - > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. - readOnly: true - nullable: true - enum: - - unknown - - direct - - transitive - - inconclusive - security_advisory: *498 - security_vulnerability: *65 - url: *181 - html_url: *182 - created_at: *179 - updated_at: *180 - dismissed_at: *184 - dismissed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - dismissed_reason: - type: string - description: The reason that the alert was dismissed. - nullable: true - enum: - - fix_started - - inaccurate - - no_bandwidth - - not_used - - tolerable_risk - dismissed_comment: - type: string - description: An optional comment associated with the alert's - dismissal. - nullable: true - maxLength: 280 - fixed_at: *183 - auto_dismissed_at: *499 - dismissal_request: *500 - assignees: - type: array - description: The users assigned to this alert. - readOnly: true - items: *4 - required: - - number - - state - - dependency - - security_advisory - - security_vulnerability - - url - - html_url - - created_at - - updated_at - - dismissed_at - - dismissed_by - - dismissed_reason - - dismissed_comment - - fixed_at - additionalProperties: false - examples: - default: - value: - - number: 2 - state: dismissed - dependency: - package: - ecosystem: pip - name: django - manifest_path: path/to/requirements.txt - scope: runtime - security_advisory: - ghsa_id: GHSA-rf4j-j272-fj86 - cve_id: CVE-2018-6188 - summary: Django allows remote attackers to obtain potentially - sensitive information by leveraging data exposure from the - confirm_login_allowed() method, as demonstrated by discovering - whether a user account is inactive - description: django.contrib.auth.forms.AuthenticationForm in - Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote - attackers to obtain potentially sensitive information by leveraging - data exposure from the confirm_login_allowed() method, as - demonstrated by discovering whether a user account is inactive. - vulnerabilities: - - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 2.0.0, < 2.0.2" - first_patched_version: - identifier: 2.0.2 - - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 1.11.8, < 1.11.10" - first_patched_version: - identifier: 1.11.10 - severity: high - cvss: - vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N - score: 7.5 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N - score: 7.5 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N - score: 8.7 - epss: - percentage: 0.00045 - percentile: 0.16001e0 - cwes: - - cwe_id: CWE-200 - name: Exposure of Sensitive Information to an Unauthorized - Actor - identifiers: - - type: GHSA - value: GHSA-rf4j-j272-fj86 - - type: CVE - value: CVE-2018-6188 - references: - - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 - - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 - - url: https://usn.ubuntu.com/3559-1/ - - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ - - url: http://www.securitytracker.com/id/1040422 - published_at: '2018-10-03T21:13:54Z' - updated_at: '2022-04-26T18:35:37Z' - withdrawn_at: - security_vulnerability: - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 2.0.0, < 2.0.2" - first_patched_version: - identifier: 2.0.2 - url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 - html_url: https://github.com/octocat/hello-world/security/dependabot/2 - created_at: '2022-06-15T07:43:03Z' - updated_at: '2022-08-23T14:29:47Z' - dismissed_at: '2022-08-23T14:29:47Z' - dismissed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_reason: tolerable_risk - dismissed_comment: This alert is accurate but we use a sanitizer. - fixed_at: - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - number: 1 - state: open - dependency: - package: - ecosystem: pip - name: ansible - manifest_path: path/to/requirements.txt - scope: runtime - security_advisory: - ghsa_id: GHSA-8f4m-hccc-8qph - cve_id: CVE-2021-20191 - summary: Insertion of Sensitive Information into Log File in - ansible - description: A flaw was found in ansible. Credentials, such - as secrets, are being disclosed in console log by default - and not protected by no_log feature when using those modules. - An attacker can take advantage of this information to steal - those credentials. The highest threat from this vulnerability - is to data confidentiality. - vulnerabilities: - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: ">= 2.9.0, < 2.9.18" - first_patched_version: - identifier: 2.9.18 - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: "< 2.8.19" - first_patched_version: - identifier: 2.8.19 - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: ">= 2.10.0, < 2.10.7" - first_patched_version: - identifier: 2.10.7 - severity: medium - cvss: - vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N - score: 5.5 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N - score: 5.5 - cvss_v4: - vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 8.5 - cwes: - - cwe_id: CWE-532 - name: Insertion of Sensitive Information into Log File - identifiers: - - type: GHSA - value: GHSA-8f4m-hccc-8qph - - type: CVE - value: CVE-2021-20191 - references: - - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 - - url: https://access.redhat.com/security/cve/cve-2021-20191 - - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 - published_at: '2021-06-01T17:38:00Z' - updated_at: '2021-08-12T23:06:00Z' - withdrawn_at: - security_vulnerability: - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: "< 2.8.19" - first_patched_version: - identifier: 2.8.19 - url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 - html_url: https://github.com/octocat/hello-world/security/dependabot/1 - created_at: '2022-06-14T15:21:52Z' - updated_at: '2022-06-14T15:21:52Z' - dismissed_at: - dismissed_by: - dismissed_reason: - dismissed_comment: - fixed_at: - assignees: [] - '304': *37 - '400': *14 - '403': *29 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: dependabot - subcategory: alerts - "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": - get: - summary: Get a Dependabot alert - description: OAuth app tokens and personal access tokens (classic) need the - `security_events` scope to use this endpoint. If this endpoint is only used - with public repositories, the token can use the `public_repo` scope instead. - tags: - - dependabot - operationId: dependabot/get-alert - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert - parameters: - - *344 - - *345 - - &502 - name: alert_number - in: path - description: |- - The number that identifies a Dependabot alert in its repository. - You can find this at the end of the URL for a Dependabot alert within GitHub, - or in `number` fields in the response from the - `GET /repos/{owner}/{repo}/dependabot/alerts` operation. - required: true - schema: *178 - responses: - '200': - description: Response - content: - application/json: - schema: *501 - examples: - default: - value: - number: 1 - state: open - dependency: - package: - ecosystem: pip - name: ansible - manifest_path: path/to/requirements.txt - scope: runtime - security_advisory: - ghsa_id: GHSA-8f4m-hccc-8qph - cve_id: CVE-2021-20191 - summary: Insertion of Sensitive Information into Log File in - ansible - description: A flaw was found in ansible. Credentials, such - as secrets, are being disclosed in console log by default - and not protected by no_log feature when using those modules. - An attacker can take advantage of this information to steal - those credentials. The highest threat from this vulnerability - is to data confidentiality. - vulnerabilities: - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: ">= 2.9.0, < 2.9.18" - first_patched_version: - identifier: 2.9.18 - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: "< 2.8.19" - first_patched_version: - identifier: 2.8.19 - - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: ">= 2.10.0, < 2.10.7" - first_patched_version: - identifier: 2.10.7 - severity: medium - cvss: - vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N - score: 5.5 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N - score: 5.5 - cvss_v4: - vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 8.5 - epss: - percentage: 0.00045 - percentile: 0.16001e0 - cwes: - - cwe_id: CWE-532 - name: Insertion of Sensitive Information into Log File - identifiers: - - type: GHSA - value: GHSA-8f4m-hccc-8qph - - type: CVE - value: CVE-2021-20191 - references: - - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 - - url: https://access.redhat.com/security/cve/cve-2021-20191 - - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 - published_at: '2021-06-01T17:38:00Z' - updated_at: '2021-08-12T23:06:00Z' - withdrawn_at: - security_vulnerability: - package: - ecosystem: pip - name: ansible - severity: medium - vulnerable_version_range: "< 2.8.19" - first_patched_version: - identifier: 2.8.19 - url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 - html_url: https://github.com/octocat/hello-world/security/dependabot/1 - created_at: '2022-06-14T15:21:52Z' - updated_at: '2022-06-14T15:21:52Z' - dismissed_at: - dismissed_by: - dismissed_reason: - dismissed_comment: - fixed_at: - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '304': *37 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: dependabot - subcategory: alerts - patch: - summary: Update a Dependabot alert - description: |- - The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - - OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - dependabot - operationId: dependabot/update-alert - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert - parameters: - - *344 - - *345 - - *502 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - state: - type: string - description: |- - The state of the Dependabot alert. - A `dismissed_reason` must be provided when setting the state to `dismissed`. - enum: - - dismissed - - open - dismissed_reason: - type: string - description: "**Required when `state` is `dismissed`.** A reason - for dismissing the alert." - enum: - - fix_started - - inaccurate - - no_bandwidth - - not_used - - tolerable_risk - dismissed_comment: - type: string - description: An optional comment associated with dismissing the - alert. - maxLength: 280 - assignees: - type: array - description: |- - Usernames to assign to this Dependabot Alert. - Pass one or more user logins to _replace_ the set of assignees on this alert. - Send an empty array (`[]`) to clear all assignees from the alert. - items: - type: string - anyOf: - - required: - - state - - required: - - assignees - additionalProperties: false - examples: - default: - value: - state: dismissed - dismissed_reason: tolerable_risk - dismissed_comment: This alert is accurate but we use a sanitizer. - responses: - '200': - description: Response - content: - application/json: - schema: *501 - examples: - default: - value: - number: 2 - state: dismissed - dependency: - package: - ecosystem: pip - name: django - manifest_path: path/to/requirements.txt - scope: runtime - security_advisory: - ghsa_id: GHSA-rf4j-j272-fj86 - cve_id: CVE-2018-6188 - summary: Django allows remote attackers to obtain potentially - sensitive information by leveraging data exposure from the - confirm_login_allowed() method, as demonstrated by discovering - whether a user account is inactive - description: django.contrib.auth.forms.AuthenticationForm in - Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote - attackers to obtain potentially sensitive information by leveraging - data exposure from the confirm_login_allowed() method, as - demonstrated by discovering whether a user account is inactive. - vulnerabilities: - - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 2.0.0, < 2.0.2" - first_patched_version: - identifier: 2.0.2 - - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 1.11.8, < 1.11.10" - first_patched_version: - identifier: 1.11.10 - severity: high - cvss: - vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N - score: 7.5 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N - score: 7.5 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N - score: 8.7 - cwes: - - cwe_id: CWE-200 - name: Exposure of Sensitive Information to an Unauthorized - Actor - identifiers: - - type: GHSA - value: GHSA-rf4j-j272-fj86 - - type: CVE - value: CVE-2018-6188 - references: - - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 - - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 - - url: https://usn.ubuntu.com/3559-1/ - - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ - - url: http://www.securitytracker.com/id/1040422 - published_at: '2018-10-03T21:13:54Z' - updated_at: '2022-04-26T18:35:37Z' - withdrawn_at: - security_vulnerability: - package: - ecosystem: pip - name: django - severity: high - vulnerable_version_range: ">= 2.0.0, < 2.0.2" - first_patched_version: - identifier: 2.0.2 - url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 - html_url: https://github.com/octocat/hello-world/security/dependabot/2 - created_at: '2022-06-15T07:43:03Z' - updated_at: '2022-08-23T14:29:47Z' - dismissed_at: '2022-08-23T14:29:47Z' - dismissed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - dismissed_reason: tolerable_risk - dismissed_comment: This alert is accurate but we use a sanitizer. - fixed_at: - assignees: [] - '400': *14 - '403': *29 - '404': *6 - '409': *54 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - previews: [] - category: dependabot - subcategory: alerts - "/repos/{owner}/{repo}/dependabot/secrets": - get: - summary: List repository secrets - description: |- - Lists all secrets available in a repository without revealing their encrypted - values. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/list-repo-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &505 - title: Dependabot Secret - description: Set secrets for Dependabot. - type: object - properties: - name: - description: The name of the secret. - example: MY_ARTIFACTORY_PASSWORD - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - name - - created_at - - updated_at - examples: - default: - value: - total_count: 2 - secrets: - - name: AZURE_DEVOPS_PAT - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - - name: MY_ARTIFACTORY_PASSWORD - created_at: '2020-01-10T10:59:22Z' - updated_at: '2020-01-11T11:59:22Z' - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/repos/{owner}/{repo}/dependabot/secrets/public-key": - get: - summary: Get a repository public key - description: |- - Gets your public key, which you need to encrypt secrets. You need to - encrypt a secret before you can create or update secrets. Anyone with read access - to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. - tags: - - dependabot - operationId: dependabot/get-repo-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *503 - examples: - default: *504 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": - get: - summary: Get a repository secret - description: |- - Gets a single repository secret without revealing its encrypted value. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/get-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret - parameters: - - *344 - - *345 - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *505 - examples: - default: - value: - name: MY_ARTIFACTORY_PASSWORD - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - put: - summary: Create or update a repository secret - description: |- - Creates or updates a repository secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/create-or-update-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret - parameters: - - *344 - - *345 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get a repository public - key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - delete: - summary: Delete a repository secret - description: |- - Deletes a secret in a repository using the secret name. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - dependabot - operationId: dependabot/delete-repo-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret - parameters: - - *344 - - *345 - - *168 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependabot - subcategory: secrets - "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": - get: - summary: Get a diff of the dependencies between commits - description: Gets the diff of the dependency changes between two commits of - a repository, based on the changes to the dependency manifests made in those - commits. - tags: - - dependency-graph - operationId: dependency-graph/diff-range - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits - parameters: - - *344 - - *345 - - name: basehead - description: The base and head Git revisions to compare. The Git revisions - will be resolved to commit SHAs. Named revisions will be resolved to their - corresponding HEAD commits, and an appropriate merge base will be determined. - This parameter expects the format `{base}...{head}`. - in: path - required: true - schema: - type: string - - name: name - description: The full path, relative to the repository root, of the dependency - manifest file. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Dependency Graph Diff - description: A diff of the dependencies between two commits. - type: array - items: - type: object - properties: - change_type: - type: string - enum: - - added - - removed - manifest: - type: string - example: path/to/package-lock.json - ecosystem: - type: string - example: npm - name: - type: string - example: "@actions/core" - version: - type: string - example: 1.0.0 - package_url: - type: string - nullable: true - example: pkg:/npm/%40actions/core@1.1.0 - license: - type: string - nullable: true - example: MIT - source_repository_url: - type: string - nullable: true - example: https://github.com/github/actions - vulnerabilities: - type: array - items: - type: object - properties: - severity: - type: string - example: critical - advisory_ghsa_id: - type: string - example: GHSA-rf4j-j272-fj86 - advisory_summary: - type: string - example: A summary of the advisory. - advisory_url: - type: string - example: https://github.com/advisories/GHSA-rf4j-j272-fj86 - required: - - severity - - advisory_ghsa_id - - advisory_summary - - advisory_url - scope: - description: Where the dependency is utilized. `development` - means that the dependency is only utilized in the development - environment. `runtime` means that the dependency is utilized - at runtime and in the development environment. - type: string - enum: - - unknown - - runtime - - development - required: - - change_type - - manifest - - ecosystem - - name - - version - - package_url - - license - - source_repository_url - - vulnerabilities - - scope - examples: - default: - value: - - change_type: removed - manifest: package.json - ecosystem: npm - name: helmet - version: 4.6.0 - package_url: pkg:npm/helmet@4.6.0 - license: MIT - source_repository_url: https://github.com/helmetjs/helmet - vulnerabilities: [] - - change_type: added - manifest: package.json - ecosystem: npm - name: helmet - version: 5.0.0 - package_url: pkg:npm/helmet@5.0.0 - license: MIT - source_repository_url: https://github.com/helmetjs/helmet - vulnerabilities: [] - - change_type: added - manifest: Gemfile - ecosystem: rubygems - name: ruby-openid - version: 2.7.0 - package_url: pkg:gem/ruby-openid@2.7.0 - license: - source_repository_url: https://github.com/openid/ruby-openid - vulnerabilities: - - severity: critical - advisory_ghsa_id: GHSA-fqfj-cmh6-hj49 - advisory_summary: Ruby OpenID - advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 - headers: - Link: *67 - '404': *6 - '403': - description: Response for a private repository when GitHub Advanced Security - is not enabled, or if used against a fork - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - category: dependency-graph - subcategory: dependency-review - "/repos/{owner}/{repo}/dependency-graph/sbom": - get: - summary: Export a software bill of materials (SBOM) for a repository. - description: Exports the software bill of materials (SBOM) for a repository - in SPDX JSON format. - tags: - - dependency-graph - operationId: dependency-graph/export-sbom - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Dependency Graph SPDX SBOM - description: A schema for the SPDX JSON format returned by the Dependency - Graph. - type: object - properties: - sbom: - type: object - properties: - SPDXID: - type: string - example: SPDXRef-DOCUMENT - description: The SPDX identifier for the SPDX document. - spdxVersion: - type: string - example: SPDX-2.3 - description: The version of the SPDX specification that this - document conforms to. - comment: - type: string - example: 'Exact versions could not be resolved for some packages. - For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' - description: An optional comment about the SPDX document. - creationInfo: - type: object - properties: - created: - type: string - example: '2021-11-03T00:00:00Z' - description: The date and time the SPDX document was created. - creators: - type: array - items: - type: string - example: GitHub - description: The tools that were used to generate the - SPDX document. - required: - - created - - creators - name: - type: string - example: github/github - description: The name of the SPDX document. - dataLicense: - type: string - example: CC0-1.0 - description: The license under which the SPDX document is - licensed. - documentNamespace: - type: string - example: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 - description: The namespace for the SPDX document. - packages: - type: array - items: - type: object - properties: - SPDXID: - type: string - example: SPDXRef-Package - description: A unique SPDX identifier for the package. - name: - type: string - example: github/github - description: The name of the package. - versionInfo: - type: string - example: 1.0.0 - description: |- - The version of the package. If the package does not have an exact version specified, - a version range is given. - downloadLocation: - type: string - example: NOASSERTION - description: |- - The location where the package can be downloaded, - or NOASSERTION if this has not been determined. - filesAnalyzed: - type: boolean - example: false - description: |- - Whether the package's file content has been subjected to - analysis during the creation of the SPDX document. - licenseConcluded: - type: string - example: MIT - description: The license of the package as determined - while creating the SPDX document. - licenseDeclared: - type: string - example: NOASSERTION - description: |- - The license of the package as declared by its author, or NOASSERTION if this information - was not available when the SPDX document was created. - supplier: - type: string - example: NOASSERTION - description: The distribution source of this package, - or NOASSERTION if this was not determined. - copyrightText: - type: string - example: Copyright (c) 1985 GitHub.com - description: The copyright holders of the package, and - any dates present with those notices, if available. - externalRefs: - type: array - items: - type: object - properties: - referenceCategory: - type: string - example: PACKAGE-MANAGER - description: The category of reference to an external - resource this reference refers to. - referenceLocator: - type: string - example: pkg:gem/rails@6.0.1 - description: A locator for the particular external - resource this reference refers to. - referenceType: - type: string - example: purl - description: The category of reference to an external - resource this reference refers to. - required: - - referenceCategory - - referenceLocator - - referenceType - required: - - SPDXID - - name - - versionInfo - - downloadLocation - - filesAnalyzed - relationships: - type: array - items: - type: object - properties: - relationshipType: - type: string - example: DEPENDS_ON - description: The type of relationship between the two - SPDX elements. - spdxElementId: - type: string - description: The SPDX identifier of the package that - is the source of the relationship. - relatedSpdxElement: - type: string - description: The SPDX identifier of the package that - is the target of the relationship. - required: - - relationshipType - - spdxElementId - - relatedSpdxElement - required: - - SPDXID - - spdxVersion - - creationInfo - - name - - dataLicense - - documentNamespace - - packages - required: - - sbom - examples: - default: - value: - sbom: - SPDXID: SPDXRef-DOCUMENT - spdxVersion: SPDX-2.3 - creationInfo: - created: '2021-09-01T00:00:00Z' - creators: - - 'Tool: GitHub.com-Dependency-Graph' - name: github/example - dataLicense: CC0-1.0 - documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 - packages: - - name: rails - SPDXID: SPDXRef-Package - versionInfo: 1.0.0 - downloadLocation: NOASSERTION - filesAnalyzed: false - licenseConcluded: MIT - licenseDeclared: MIT - copyrightText: Copyright (c) 1985 GitHub.com - externalRefs: - - referenceCategory: PACKAGE-MANAGER - referenceType: purl - referenceLocator: pkg:gem/rails@1.0.0 - - name: github/example - SPDXID: SPDXRef-Repository - versionInfo: main - downloadLocation: NOASSERTION - filesAnalyzed: false - externalRefs: - - referenceCategory: PACKAGE-MANAGER - referenceType: purl - referenceLocator: pkg:github/example@main - relationships: - - relationshipType: DEPENDS_ON - spdxElementId: SPDXRef-Repository - relatedSpdxElement: SPDXRef-Package - - relationshipType: DESCRIBES - spdxElementId: SPDXRef-DOCUMENT - relatedSpdxElement: SPDXRef-Repository - headers: - Link: *67 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - category: dependency-graph - subcategory: sboms - "/repos/{owner}/{repo}/dependency-graph/snapshots": - post: - summary: Create a snapshot of dependencies for a repository - description: |- - Create a new snapshot of a repository's dependencies. - - The authenticated user must have access to the repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - dependency-graph - operationId: dependency-graph/create-repository-snapshot - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - title: snapshot - description: Create a new snapshot of a repository's dependencies. - type: object - properties: - version: - description: The version of the repository snapshot submission. - type: integer - job: - type: object - properties: - id: - type: string - description: The external ID of the job. - example: 5622a2b0-63f6-4732-8c34-a1ab27e102a11 - correlator: - type: string - description: Correlator provides a key that is used to group - snapshots submitted over time. Only the "latest" submitted - snapshot for a given combination of `job.correlator` and `detector.name` - will be considered when calculating a repository's current - dependencies. Correlator should be as unique as it takes to - distinguish all detection runs for a given "wave" of CI workflow - you run. If you're using GitHub Actions, a good default value - for this could be the environment variables GITHUB_WORKFLOW - and GITHUB_JOB concatenated together. If you're using a build - matrix, then you'll also need to add additional key(s) to - distinguish between each submission inside a matrix variation. - example: yourworkflowname_yourjobname - html_url: - type: string - description: The url for the job. - example: http://example.com/build - required: - - id - - correlator - additionalProperties: false - sha: - description: 'The commit SHA associated with this dependency snapshot. - Maximum length: 40 characters.' - type: string - example: ddc951f4b1293222421f2c8df679786153acf689 - minLength: 40 - maxLength: 40 - ref: - description: The repository branch that triggered this snapshot. - type: string - pattern: "^refs/" - example: refs/heads/main - detector: - type: object - description: A description of the detector used. - properties: - name: - type: string - description: The name of the detector used. - example: docker buildtime detector - version: - type: string - description: The version of the detector used. - example: 1.0.0 - url: - type: string - description: The url of the detector used. - example: http://example.com/docker-buildtimer-detector - required: - - name - - version - - url - additionalProperties: false - metadata: &506 - title: metadata - description: User-defined metadata to store domain-specific information - limited to 8 keys with scalar values. - type: object - maxProperties: 8 - additionalProperties: - nullable: true - anyOf: - - type: string - - type: number - - type: boolean - manifests: - type: object - description: A collection of package manifests, which are a collection - of related dependencies declared in a file or representing a logical - group of dependencies. - additionalProperties: - type: object - properties: - name: - type: string - description: The name of the manifest. - example: package-lock.json - file: - type: object - properties: - source_location: - type: string - description: The path of the manifest file relative to - the root of the Git repository. - example: "/src/build/package-lock.json" - additionalProperties: false - metadata: *506 - resolved: - type: object - description: A collection of resolved package dependencies. - additionalProperties: - type: object - properties: - package_url: - type: string - description: Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec - for more details. - example: pkg:/npm/%40actions/http-client@1.0.11 - pattern: "^pkg" - metadata: *506 - relationship: - type: string - description: A notation of whether a dependency is requested - directly by this manifest or is a dependency of another - dependency. - example: direct - enum: - - direct - - indirect - scope: - type: string - description: A notation of whether the dependency is - required for the primary build artifact (runtime) - or is only used for development. Future versions of - this specification may allow for more granular scopes. - example: runtime - enum: - - runtime - - development - dependencies: - type: array - description: Array of package-url (PURLs) of direct - child dependencies. - example: "@actions/http-client" - items: - type: string - additionalProperties: false - required: - - name - additionalProperties: false - scanned: - type: string - format: date-time - description: The time at which the snapshot was scanned. - example: '2020-06-13T14:52:50-05:00' - required: - - detector - - version - - ref - - sha - - job - - scanned - additionalProperties: false - examples: - example-of-a-dependency-submission: - value: - version: 0 - sha: ce587453ced02b1526dfb4cb910479d431683101 - ref: refs/heads/main - job: - correlator: yourworkflowname_youractionname - id: yourrunid - detector: - name: octo-detector - version: 0.0.1 - url: https://github.com/octo-org/octo-repo - scanned: '2022-06-14T20:25:00Z' - manifests: - package-lock.json: - name: package-lock.json - file: - source_location: src/package-lock.json - resolved: - "@actions/core": - package_url: pkg:/npm/%40actions/core@1.1.9 - dependencies: - - "@actions/http-client" - "@actions/http-client": - package_url: pkg:/npm/%40actions/http-client@1.0.7 - dependencies: - - tunnel - tunnel: - package_url: pkg:/npm/tunnel@0.0.6 - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - required: - - id - - created_at - - result - - message - properties: - id: - type: integer - description: ID of the created snapshot. - created_at: - type: string - description: The time at which the snapshot was created. - result: - type: string - description: Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" - indicates that the snapshot was successfully created and the - repository's dependencies were updated. "ACCEPTED" indicates - that the snapshot was successfully created, but the repository's - dependencies were not updated. "INVALID" indicates that the - snapshot was malformed. - message: - type: string - description: A message providing further details about the result, - such as why the dependencies were not updated. - examples: - example-of-a-dependency-submission: - value: - id: 12345 - created_at: '2018-05-04T01:14:52Z' - message: Dependency results for the repo have been successfully - updated. - result: SUCCESS - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: dependency-graph - subcategory: dependency-submission - "/repos/{owner}/{repo}/deployments": - get: - summary: List deployments - description: 'Simple filtering of deployments is available via query parameters:' - tags: - - repos - operationId: repos/list-deployments - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/deployments#list-deployments - parameters: - - *344 - - *345 - - name: sha - description: The SHA recorded at creation time. - in: query - required: false - schema: - type: string - default: none - - name: ref - description: The name of the ref. This can be a branch, tag, or SHA. - in: query - required: false - schema: - type: string - default: none - - name: task - description: The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). - in: query - required: false - schema: - type: string - default: none - - name: environment - description: The name of the environment that was deployed to (e.g., `staging` - or `production`). - in: query - required: false - schema: - type: string - default: none - nullable: true - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *507 - examples: - default: *508 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: deployments - post: - summary: Create a deployment - description: |- - Deployments offer a few configurable parameters with certain defaults. - - The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them - before we merge a pull request. - - The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - makes it easier to track which environments have requested deployments. The default environment is `production`. - - The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - return a failure response. - - By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` - state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - not require any contexts or create any commit statuses, the deployment will always succeed. - - The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - field that will be passed on when a deployment event is dispatched. - - The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - application with debugging enabled. - - Merged branch response: - - You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - a deployment. This auto-merge happens when: - * Auto-merge option is enabled in the repository - * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * There are no merge conflicts - - If there are no new commits in the base branch, a new request to create a deployment should give a successful - response. - - Merge conflict response: - - This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - - Failed commit status checks: - - This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - tags: - - repos - operationId: repos/create-deployment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/deployments#create-a-deployment - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ref: - type: string - description: The ref to deploy. This can be a branch, tag, or SHA. - task: - type: string - description: Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). - default: deploy - auto_merge: - type: boolean - description: Attempts to automatically merge the default branch - into the requested ref, if it's behind the default branch. - default: true - required_contexts: - type: array - description: The [status](https://docs.github.com/rest/commits/statuses) - contexts to verify against commit status checks. If you omit this - parameter, GitHub verifies all unique contexts before creating - a deployment. To bypass checking entirely, pass an empty array. - Defaults to all unique contexts. - items: - type: string - payload: - oneOf: - - type: object - additionalProperties: true - - type: string - description: JSON payload with extra information about the deployment. - default: '' - environment: - type: string - description: Name for the target deployment environment (e.g., `production`, - `staging`, `qa`). - default: production - description: - type: string - description: Short description of the deployment. - default: '' - nullable: true - transient_environment: - type: boolean - description: 'Specifies if the given environment is specific to - the deployment and will no longer exist at some point in the future. - Default: `false`' - default: false - production_environment: - type: boolean - description: 'Specifies if the given environment is one that end-users - directly interact with. Default: `true` when `environment` is - `production` and `false` otherwise.' - required: - - ref - examples: - simple-example: - summary: Simple example - value: - ref: topic-branch - payload: '{ "deploy": "migrate" }' - description: Deploy request from hubot - advanced-example: - summary: Advanced example - value: - ref: topic-branch - auto_merge: false - payload: '{ "deploy": "migrate" }' - description: Deploy request from hubot - required_contexts: - - ci/janky - - security/brakeman - responses: - '201': - description: Response - content: - application/json: - schema: *507 - examples: - simple-example: - summary: Simple example - value: - url: https://api.github.com/repos/octocat/example/deployments/1 - id: 1 - node_id: MDEwOkRlcGxveW1lbnQx - sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - ref: topic-branch - task: deploy - payload: {} - original_environment: staging - environment: production - description: Deploy request from hubot - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses - repository_url: https://api.github.com/repos/octocat/example - transient_environment: false - production_environment: true - '202': - description: Merged branch response - content: - application/json: - schema: - type: object - properties: - message: - type: string - examples: - merged-branch-response: - value: - message: Auto-merged master into topic-branch on deployment. - '409': - description: Conflict when there is a merge conflict or the commit's status - checks failed - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: deployments - "/repos/{owner}/{repo}/deployments/{deployment_id}": - get: - summary: Get a deployment - description: '' - tags: - - repos - operationId: repos/get-deployment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/deployments#get-a-deployment - parameters: - - *344 - - *345 - - &509 - name: deployment_id - description: deployment_id parameter - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *507 - examples: - default: - value: - url: https://api.github.com/repos/octocat/example/deployments/1 - id: 1 - node_id: MDEwOkRlcGxveW1lbnQx - sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d - ref: topic-branch - task: deploy - payload: {} - original_environment: staging - environment: production - description: Deploy request from hubot - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses - repository_url: https://api.github.com/repos/octocat/example - transient_environment: false - production_environment: true - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: deployments - delete: - summary: Delete a deployment - description: |- - If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. - - To set a deployment as inactive, you must: - - * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * Mark the active deployment as inactive by adding any non-successful deployment status. - - For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - tags: - - repos - operationId: repos/delete-deployment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment - parameters: - - *344 - - *345 - - *509 - responses: - '204': - description: Response - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: deployments - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": - get: - summary: List deployment statuses - description: 'Users with pull access can view deployment statuses for a deployment:' - tags: - - repos - operationId: repos/list-deployment-statuses - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses - parameters: - - *344 - - *345 - - *509 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &510 - title: Deployment Status - description: The status of a deployment. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 - id: - type: integer - format: int64 - example: 1 - node_id: - type: string - example: MDE2OkRlcGxveW1lbnRTdGF0dXMx - state: - description: The state of the status. - enum: - - error - - failure - - inactive - - pending - - success - - queued - - in_progress - example: success - type: string - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - description: - description: A short description of the status. - default: '' - type: string - maxLength: 140 - example: Deployment finished successfully. - environment: - description: The environment of the deployment that the status - is for. - default: '' - type: string - example: production - target_url: - description: 'Closing down notice: the URL to associate with - this status.' - default: '' - type: string - format: uri - example: https://example.com/deployment/42/output - created_at: - type: string - format: date-time - example: '2012-07-20T01:19:13Z' - updated_at: - type: string - format: date-time - example: '2012-07-20T01:19:13Z' - deployment_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/deployments/42 - repository_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example - environment_url: - description: The URL for accessing your environment. - default: '' - type: string - format: uri - example: https://staging.example.com/ - log_url: - description: The URL to associate with this status. - default: '' - type: string - format: uri - example: https://example.com/deployment/42/output - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - required: - - id - - node_id - - state - - creator - - description - - deployment_url - - target_url - - repository_url - - url - - created_at - - updated_at - examples: - default: - value: - - url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 - id: 1 - node_id: MDE2OkRlcGxveW1lbnRTdGF0dXMx - state: success - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - description: Deployment finished successfully. - environment: production - target_url: https://example.com/deployment/42/output - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - deployment_url: https://api.github.com/repos/octocat/example/deployments/42 - repository_url: https://api.github.com/repos/octocat/example - environment_url: https://test-branch.lab.acme.com - log_url: https://example.com/deployment/42/output - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: statuses - post: - summary: Create a deployment status - description: |- - Users with `push` access can create deployment statuses for a given deployment. - - OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. - tags: - - repos - operationId: repos/create-deployment-status - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status - parameters: - - *344 - - *345 - - *509 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - state: - type: string - description: The state of the status. When you set a transient deployment - to `inactive`, the deployment will be shown as `destroyed` in - GitHub. - enum: - - error - - failure - - inactive - - in_progress - - queued - - pending - - success - target_url: - type: string - description: |- - The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. - - > [!NOTE] - > It's recommended to use the `log_url` parameter, which replaces `target_url`. - default: '' - log_url: - type: string - description: 'The full URL of the deployment''s output. This parameter - replaces `target_url`. We will continue to accept `target_url` - to support legacy uses, but we recommend replacing `target_url` - with `log_url`. Setting `log_url` will automatically set `target_url` - to the same value. Default: `""`' - default: '' - description: - type: string - description: A short description of the status. The maximum description - length is 140 characters. - default: '' - environment: - type: string - description: Name for the target deployment environment, which can - be changed when setting a deploy status. For example, `production`, - `staging`, or `qa`. If not defined, the environment of the previous - status on the deployment will be used, if it exists. Otherwise, - the environment of the deployment will be used. - environment_url: - type: string - description: 'Sets the URL for accessing your environment. Default: - `""`' - default: '' - auto_inactive: - type: boolean - description: 'Adds a new `inactive` status to all prior non-transient, - non-production environment deployments with the same repository - and `environment` name as the created status''s deployment. An - `inactive` status is only added to deployments that had a `success` - state. Default: `true`' - required: - - state - examples: - default: - value: - environment: production - state: success - log_url: https://example.com/deployment/42/output - description: Deployment finished successfully. - responses: - '201': - description: Response - content: - application/json: - schema: *510 - examples: - default: &511 - value: - url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 - id: 1 - node_id: MDE2OkRlcGxveW1lbnRTdGF0dXMx - state: success - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - description: Deployment finished successfully. - environment: production - target_url: https://example.com/deployment/42/output - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - deployment_url: https://api.github.com/repos/octocat/example/deployments/42 - repository_url: https://api.github.com/repos/octocat/example - environment_url: https://test-branch.lab.acme.com - log_url: https://example.com/deployment/42/output - headers: - Location: - example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 - schema: - type: string - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: statuses - "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": - get: - summary: Get a deployment status - description: 'Users with pull access can view a deployment status for a deployment:' - tags: - - repos - operationId: repos/get-deployment-status - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status - parameters: - - *344 - - *345 - - *509 - - name: status_id - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *510 - examples: - default: *511 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: statuses - "/repos/{owner}/{repo}/dispatches": - post: - summary: Create a repository dispatch event - description: |- - You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." - - The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - - This input example shows how you can use the `client_payload` as a test to debug your workflow. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/create-dispatch-event - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - required: - - event_type - properties: - event_type: - type: string - description: A custom webhook event name. Must be 100 characters - or fewer. - minLength: 1 - maxLength: 100 - client_payload: - type: object - description: JSON payload with extra information about the webhook - event that your action or workflow may use. The maximum number - of top-level properties is 10. The total size of the JSON payload - must be less than 64KB. - additionalProperties: true - maxProperties: 10 - examples: - default: - value: - event_type: on-demand-test - client_payload: - unit: false - integration: true - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/environments": - get: - summary: List environments - description: |- - Lists the environments for a repository. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/get-all-environments - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/environments#list-environments - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of environments in this repository - example: 5 - type: integer - environments: - type: array - items: &513 - title: Environment - description: Details of a deployment environment - type: object - properties: - id: - description: The id of the environment. - example: 56780428 - type: integer - format: int64 - node_id: - type: string - example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= - name: - description: The name of the environment. - example: staging - type: string - url: - type: string - example: https://api.github.com/repos/github/hello-world/environments/staging - html_url: - type: string - example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - created_at: - description: The time that the environment was created, - in ISO 8601 format. - example: '2020-11-23T22:00:40Z' - format: date-time - type: string - updated_at: - description: The time that the environment was last updated, - in ISO 8601 format. - example: '2020-11-23T22:00:40Z' - format: date-time - type: string - protection_rules: - type: array - description: Built-in deployment protection rules for the - environment. - items: - anyOf: - - type: object - properties: - id: - type: integer - example: 3515 - node_id: - type: string - example: MDQ6R2F0ZTM1MTU= - type: - type: string - example: wait_timer - wait_timer: &515 - type: integer - example: 30 - description: The amount of time to delay a job after - the job is initially triggered. The time (in minutes) - must be an integer between 0 and 43,200 (30 days). - required: - - id - - node_id - - type - - type: object - properties: - id: - type: integer - example: 3755 - node_id: - type: string - example: MDQ6R2F0ZTM3NTU= - prevent_self_review: - type: boolean - example: false - description: Whether deployments to this environment - can be approved by the user who created the deployment. - type: - type: string - example: required_reviewers - reviewers: - type: array - description: The people or teams that may approve - jobs that reference the environment. You can list - up to six users or teams as reviewers. The reviewers - must have at least read access to the repository. - Only one of the required reviewers needs to approve - the job for it to proceed. - items: - type: object - properties: - type: *512 - reviewer: - anyOf: - - *4 - - *197 - required: - - id - - node_id - - type - - type: object - properties: - id: - type: integer - example: 3515 - node_id: - type: string - example: MDQ6R2F0ZTM1MTU= - type: - type: string - example: branch_policy - required: - - id - - node_id - - type - deployment_branch_policy: &516 - type: object - description: The type of deployment branch policy for this - environment. To allow all branches to deploy, set to `null`. - properties: - protected_branches: - type: boolean - description: Whether only branches with branch protection - rules can deploy to this environment. If `protected_branches` - is `true`, `custom_branch_policies` must be `false`; - if `protected_branches` is `false`, `custom_branch_policies` - must be `true`. - custom_branch_policies: - type: boolean - description: Whether only branches that match the specified - name patterns can deploy to this environment. If - `custom_branch_policies` is `true`, `protected_branches` - must be `false`; if `custom_branch_policies` is `false`, - `protected_branches` must be `true`. - nullable: true - required: - - protected_branches - - custom_branch_policies - required: - - id - - node_id - - name - - url - - html_url - - created_at - - updated_at - examples: - default: - value: - total_count: 1 - environments: - - id: 161088068 - node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 - name: staging - url: https://api.github.com/repos/github/hello-world/environments/staging - html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - created_at: '2020-11-23T22:00:40Z' - updated_at: '2020-11-23T22:00:40Z' - protection_rules: - - id: 3736 - node_id: MDQ6R2F0ZTM3MzY= - type: wait_timer - wait_timer: 30 - - id: 3755 - node_id: MDQ6R2F0ZTM3NTU= - prevent_self_review: false - type: required_reviewers - reviewers: - - type: User - reviewer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - type: Team - reviewer: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - id: 3756 - node_id: MDQ6R2F0ZTM3NTY= - type: branch_policy - deployment_branch_policy: - protected_branches: false - custom_branch_policies: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: environments - "/repos/{owner}/{repo}/environments/{environment_name}": - get: - summary: Get an environment - description: |- - > [!NOTE] - > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/get-environment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/environments#get-an-environment - parameters: - - *344 - - *345 - - &514 - name: environment_name - in: path - required: true - description: The name of the environment. The name must be URL encoded. For - example, any slashes in the name must be replaced with `%2F`. - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *513 - examples: - default: &517 - value: - id: 161088068 - node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 - name: staging - url: https://api.github.com/repos/github/hello-world/environments/staging - html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging - created_at: '2020-11-23T22:00:40Z' - updated_at: '2020-11-23T22:00:40Z' - protection_rules: - - id: 3736 - node_id: MDQ6R2F0ZTM3MzY= - type: wait_timer - wait_timer: 30 - - id: 3755 - node_id: MDQ6R2F0ZTM3NTU= - prevent_self_review: false - type: required_reviewers - reviewers: - - type: User - reviewer: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - type: Team - reviewer: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - id: 3756 - node_id: MDQ6R2F0ZTM3NTY= - type: branch_policy - deployment_branch_policy: - protected_branches: false - custom_branch_policies: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: environments - put: - summary: Create or update an environment - description: |- - Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." - - > [!NOTE] - > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - - > [!NOTE] - > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/create-or-update-environment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment - parameters: - - *344 - - *345 - - *514 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - wait_timer: *515 - prevent_self_review: - type: boolean - example: false - description: Whether or not a user who created the job is prevented - from approving their own job. - reviewers: - type: array - nullable: true - description: The people or teams that may review jobs that reference - the environment. You can list up to six users or teams as reviewers. - The reviewers must have at least read access to the repository. - Only one of the required reviewers needs to approve the job for - it to proceed. - items: - type: object - properties: - type: *512 - id: - type: integer - description: The id of the user or team who can review the - deployment - example: 4532992 - deployment_branch_policy: *516 - additionalProperties: false - examples: - default: - value: - wait_timer: 30 - prevent_self_review: false - reviewers: - - type: User - id: 1 - - type: Team - id: 1 - deployment_branch_policy: - protected_branches: false - custom_branch_policies: true - responses: - '200': - description: Response - content: - application/json: - schema: *513 - examples: - default: *517 - '422': - description: Validation error when the environment name is invalid or when - `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` - are set to the same value - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: environments - delete: - summary: Delete an environment - description: OAuth app tokens and personal access tokens (classic) need the - `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/delete-an-environment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/environments#delete-an-environment - parameters: - - *344 - - *345 - - *514 - responses: - '204': - description: Default response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: environments - "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": - get: - summary: List deployment branch policies - description: |- - Lists the deployment branch policies for an environment. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/list-deployment-branch-policies - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies - parameters: - - *344 - - *345 - - *514 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of deployment branch policies for the - environment. - type: integer - example: 2 - branch_policies: - type: array - items: &518 - title: Deployment branch policy - description: Details of a deployment branch or tag policy. - type: object - properties: - id: - description: The unique identifier of the branch or tag - policy. - type: integer - example: 361471 - node_id: - type: string - example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= - name: - description: The name pattern that branches or tags must - match in order to deploy to the environment. - type: string - example: release/* - type: - description: Whether this rule targets a branch or tag. - type: string - example: branch - enum: - - branch - - tag - required: - - total_count - - branch_policies - examples: - default: - value: - total_count: 2 - branch_policies: - - id: 361471 - node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= - name: release/* - - id: 361472 - node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI= - name: main - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: branch-policies - post: - summary: Create a deployment branch policy - description: |- - Creates a deployment branch or tag policy for an environment. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/create-deployment-branch-policy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy - parameters: - - *344 - - *345 - - *514 - requestBody: - required: true - content: - application/json: - schema: - title: Deployment branch and tag policy name pattern - type: object - properties: - name: - description: |- - The name pattern that branches or tags must match in order to deploy to the environment. - - Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. - For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). - type: string - example: release/* - type: - description: Whether this rule targets a branch or tag - type: string - example: branch - enum: - - branch - - tag - required: - - name - examples: - example-wildcard: - summary: Example of a wildcard name pattern - value: - name: release/* - example-single-branch: - summary: Example of a single branch name pattern - value: - name: main - type: branch - example-single-tag: - summary: Example of a single tag name pattern - value: - name: v1 - type: tag - responses: - '200': - description: Response - content: - application/json: - schema: *518 - examples: - example-wildcard: &519 - value: - id: 364662 - node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= - name: release/* - example-single-branch: - value: - id: 364663 - node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= - name: main - example-single-tag: - value: - id: 364663 - node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= - name: v1 - type: tag - '404': - description: Not Found or `deployment_branch_policy.custom_branch_policies` - property for the environment is set to false - '303': - description: Response if the same branch name pattern already exists - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: branch-policies - "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": - get: - summary: Get a deployment branch policy - description: |- - Gets a deployment branch or tag policy for an environment. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/get-deployment-branch-policy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy - parameters: - - *344 - - *345 - - *514 - - &520 - name: branch_policy_id - in: path - required: true - description: The unique identifier of the branch policy. - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *518 - examples: - default: *519 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: branch-policies - put: - summary: Update a deployment branch policy - description: |- - Updates a deployment branch or tag policy for an environment. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/update-deployment-branch-policy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy - parameters: - - *344 - - *345 - - *514 - - *520 - requestBody: - required: true - content: - application/json: - schema: - title: Deployment branch policy name pattern - type: object - properties: - name: - description: |- - The name pattern that branches must match in order to deploy to the environment. - - Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. - For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). - type: string - example: release/* - required: - - name - examples: - default: - value: - name: release/* - responses: - '200': - description: Response - content: - application/json: - schema: *518 - examples: - default: *519 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: branch-policies - delete: - summary: Delete a deployment branch policy - description: |- - Deletes a deployment branch or tag policy for an environment. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/delete-deployment-branch-policy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy - parameters: - - *344 - - *345 - - *514 - - *520 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: branch-policies - "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": - get: - summary: Get all deployment protection rules for an environment - description: |- - Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/get-all-deployment-protection-rules - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment - parameters: - - *514 - - *345 - - *344 - responses: - '200': - description: List of deployment protection rules - content: - application/json: - schema: - type: object - properties: - total_count: - description: The number of enabled custom deployment protection - rules for this environment - type: integer - example: 10 - custom_deployment_protection_rules: - type: array - items: &521 - title: Deployment protection rule - description: Deployment protection rule - type: object - properties: - id: - type: integer - example: 3515 - description: The unique identifier for the deployment protection - rule. - node_id: - type: string - example: MDQ6R2F0ZTM1MTU= - description: The node ID for the deployment protection rule. - enabled: - type: boolean - example: true - description: Whether the deployment protection rule is enabled - for the environment. - app: &522 - title: Custom deployment protection rule app - description: A GitHub App that is providing a custom deployment - protection rule. - type: object - properties: - id: - type: integer - example: 3515 - description: The unique identifier of the deployment - protection rule integration. - slug: - type: string - example: my-custom-app - description: The slugified name of the deployment protection - rule integration. - integration_url: - type: string - example: https://api.github.com/apps/custom-app-slug - description: The URL for the endpoint to get details - about the app. - node_id: - type: string - example: MDQ6R2F0ZTM1MTU= - description: The node ID for the deployment protection - rule integration. - required: - - id - - slug - - integration_url - - node_id - required: - - id - - node_id - - enabled - - app - example: - value: - - total_count: 2 - - custom_deployment_protection_rules: - - id: 3 - node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv - enabled: true - app: - id: 1 - node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy - slug: a-custom-app - integration_url: https://api.github.com/apps/a-custom-app - - id: 4 - node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 - enabled: true - app: - id: 1 - node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy - slug: another-custom-app - integration_url: https://api.github.com/apps/another-custom-app - examples: - default: - value: - total_count: 2 - custom_deployment_protection_rules: - - id: 3 - node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv - enabled: true - app: - id: 1 - node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy - slug: a-custom-app - integration_url: https://api.github.com/apps/a-custom-app - - id: 4 - node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 - enabled: true - app: - id: 1 - node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy - slug: another-custom-app - integration_url: https://api.github.com/apps/another-custom-app - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: protection-rules - post: - summary: Create a custom deployment protection rule on an environment - description: |- - Enable a custom deployment protection rule for an environment. - - The authenticated user must have admin or owner permissions to the repository to use this endpoint. - - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/create-deployment-protection-rule - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment - parameters: - - *514 - - *345 - - *344 - requestBody: - content: - application/json: - schema: - type: object - properties: - integration_id: - type: integer - description: The ID of the custom app that will be enabled on the - environment. - examples: - default: - value: - integration_id: 5 - required: true - responses: - '201': - description: The enabled custom deployment protection rule - content: - application/json: - schema: *521 - examples: - default: &523 - value: - id: 3 - node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv - enabled: true - app: - id: 1 - node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy - slug: a-custom-app - integration_url: https://api.github.com/apps/a-custom-app - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: protection-rules - "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": - get: - summary: List custom deployment rule integrations available for an environment - description: |- - Gets all custom deployment protection rule integrations that are available for an environment. - - The authenticated user must have admin or owner permissions to the repository to use this endpoint. - - For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - - For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/list-custom-deployment-rule-integrations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment - parameters: - - *514 - - *345 - - *344 - - *19 - - *17 - responses: - '200': - description: A list of custom deployment rule integrations available for - this environment. - content: - application/json: - schema: - type: object - properties: - total_count: - description: The total number of custom deployment protection - rule integrations available for this environment. - type: integer - example: 35 - available_custom_deployment_protection_rule_integrations: - type: array - items: *522 - examples: - default: - value: - - total_count: 2 - - available_custom_deployment_protection_rule_integrations: - - id: 1 - node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy - slug: a-custom-app - integration_url: https://api.github.com/apps/a-custom-app - - id: 2 - node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy - slug: another-custom-app - integration_url: https://api.github.com/apps/another-custom-app - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: protection-rules - "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": - get: - summary: Get a custom deployment protection rule - description: |- - Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - - For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/get-custom-deployment-protection-rule - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule - parameters: - - *344 - - *345 - - *514 - - &524 - name: protection_rule_id - description: The unique identifier of the protection rule. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *521 - examples: - default: *523 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: protection-rules - delete: - summary: Disable a custom protection rule for an environment - description: |- - Disables a custom deployment protection rule for an environment. - - The authenticated user must have admin or owner permissions to the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/disable-deployment-protection-rule - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment - parameters: - - *514 - - *345 - - *344 - - *524 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deployments - subcategory: protection-rules - "/repos/{owner}/{repo}/environments/{environment_name}/secrets": - get: - summary: List environment secrets - description: |- - Lists all secrets available in an environment without revealing their - encrypted values. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-environment-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-environment-secrets - parameters: - - *344 - - *345 - - *514 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: *389 - examples: - default: *390 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": - get: - summary: Get an environment public key - description: |- - Get the public key for an environment, which you need to encrypt environment - secrets. You need to encrypt a secret before you can create or update secrets. - - Anyone with read access to the repository can use this endpoint. - - If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-environment-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key - parameters: - - *344 - - *345 - - *514 - responses: - '200': - description: Response - content: - application/json: - schema: *391 - examples: - default: *392 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": - get: - summary: Get an environment secret - description: |- - Gets a single environment secret without revealing its encrypted value. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret - parameters: - - *344 - - *345 - - *514 - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *389 - examples: - default: *525 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - put: - summary: Create or update an environment secret - description: |- - Creates or updates an environment secret with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-or-update-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret - parameters: - - *344 - - *345 - - *514 - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get an environment public - key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - required: - - encrypted_value - - key_id - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - delete: - summary: Delete an environment secret - description: |- - Deletes a secret in an environment using the secret name. - - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret - parameters: - - *344 - - *345 - - *514 - - *168 - responses: - '204': - description: Default response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repos/{owner}/{repo}/environments/{environment_name}/variables": - get: - summary: List environment variables - description: |- - Lists all environment variables. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/list-environment-variables - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-environment-variables - parameters: - - *344 - - *345 - - *514 - - *360 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - variables - properties: - total_count: - type: integer - variables: - type: array - items: *393 - examples: - default: *394 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - post: - summary: Create an environment variable - description: |- - Create an environment variable that you can reference in a GitHub Actions workflow. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/create-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#create-an-environment-variable - parameters: - - *344 - - *345 - - *514 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - required: - - name - - value - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": - get: - summary: Get an environment variable - description: |- - Gets a specific variable in an environment. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/get-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#get-an-environment-variable - parameters: - - *344 - - *345 - - *514 - - *171 - responses: - '200': - description: Response - content: - application/json: - schema: *393 - examples: - default: *526 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - patch: - summary: Update an environment variable - description: |- - Updates an environment variable that you can reference in a GitHub Actions workflow. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/update-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#update-an-environment-variable - parameters: - - *344 - - *345 - - *171 - - *514 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - delete: - summary: Delete an environment variable - description: |- - Deletes an environment variable using the variable name. - - Authenticated users must have collaborator access to a repository to create, update, or read variables. - - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - actions - operationId: actions/delete-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable - parameters: - - *344 - - *345 - - *171 - - *514 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repos/{owner}/{repo}/events": - get: - summary: List repository events - description: |- - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-repo-events - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-repository-events - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - 200-response: - value: - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22237752260' - type: WatchEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - action: started - public: true - created_at: '2022-06-08T23:29:25Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/repos/{owner}/{repo}/forks": - get: - summary: List forks - description: '' - tags: - - repos - operationId: repos/list-forks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/forks#list-forks - parameters: - - *344 - - *345 - - name: sort - description: The sort order. `stargazers` will sort by star count. - in: query - required: false - schema: - type: string - enum: - - newest - - oldest - - stargazers - - watchers - default: newest - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: - value: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: true - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - delete_branch_on_merge: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - spdx_id: MIT - url: https://api.github.com/licenses/mit - node_id: MDc6TGljZW5zZW1pdA== - headers: - Link: *67 - '400': *14 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: forks - post: - summary: Create a fork - description: |- - Create a fork for the authenticated user. - - > [!NOTE] - > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - - > [!NOTE] - > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - tags: - - repos - operationId: repos/create-fork - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/forks#create-a-fork - parameters: - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - organization: - type: string - description: Optional parameter to specify the organization name - if forking into an organization. - name: - type: string - description: When forking from an existing repository, a new name - for the fork. - default_branch_only: - type: boolean - description: When forking from an existing repository, fork with - only the default branch. - examples: - default: - value: - organization: octocat - name: Hello-World - default_branch_only: true - responses: - '202': - description: Response - content: - application/json: - schema: *347 - examples: - default: *349 - '400': *14 - '422': *15 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: forks - "/repos/{owner}/{repo}/git/blobs": - post: - summary: Create a blob - description: '' - tags: - - git - operationId: git/create-blob - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/blobs#create-a-blob - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The new blob's content. - encoding: - type: string - description: The encoding used for `content`. Currently, `"utf-8"` - and `"base64"` are supported. - default: utf-8 - required: - - content - examples: - default: - value: - content: Content of the blob - encoding: utf-8 - responses: - '201': - description: Response - content: - application/json: - schema: - title: Short Blob - description: Short Blob - type: object - properties: - url: - type: string - sha: - type: string - required: - - url - - sha - examples: - default: - value: - url: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 - sha: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 - headers: - Location: - example: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 - schema: - type: string - '404': *6 - '409': *54 - '403': *29 - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - *129 - - *527 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: blobs - "/repos/{owner}/{repo}/git/blobs/{file_sha}": - get: - summary: Get a blob - description: |- - The `content` in the response will always be Base64 encoded. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw blob data. - - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - - **Note** This endpoint supports blobs up to 100 megabytes in size. - tags: - - git - operationId: git/get-blob - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/blobs#get-a-blob - parameters: - - *344 - - *345 - - name: file_sha - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Blob - description: Blob - type: object - properties: - content: - type: string - encoding: - type: string - url: - type: string - format: uri - sha: - type: string - size: - type: integer - nullable: true - node_id: - type: string - highlighted_content: - type: string - required: - - sha - - url - - node_id - - size - - content - - encoding - examples: - default: - value: - content: Q29udGVudCBvZiB0aGUgYmxvYg== - encoding: base64 - url: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 - sha: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 - size: 19 - node_id: Q29udGVudCBvZiB0aGUgYmxvYg== - '404': *6 - '422': *15 - '403': *29 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: blobs - "/repos/{owner}/{repo}/git/commits": - post: - summary: Create a commit - description: |- - Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - git - operationId: git/create-commit - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/commits#create-a-commit - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: The commit message - tree: - type: string - description: The SHA of the tree object this commit points to - parents: - type: array - description: The full SHAs of the commits that were the parents - of this commit. If omitted or empty, the commit will be written - as a root commit. For a single parent, an array of one SHA should - be provided; for a merge commit, an array of more than one should - be provided. - items: - type: string - author: - type: object - description: Information about the author of the commit. By default, - the `author` will be the authenticated user and the current date. - See the `author` and `committer` object below for details. - properties: - name: - type: string - description: The name of the author (or committer) of the commit - email: - type: string - description: The email of the author (or committer) of the commit - date: - type: string - format: date-time - description: 'Indicates when this commit was authored (or committed). - This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - required: - - name - - email - committer: - type: object - description: Information about the person who is making the commit. - By default, `committer` will use the information set in `author`. - See the `author` and `committer` object below for details. - properties: - name: - type: string - description: The name of the author (or committer) of the commit - email: - type: string - description: The email of the author (or committer) of the commit - date: - type: string - format: date-time - description: 'Indicates when this commit was authored (or committed). - This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`.' - signature: - type: string - description: The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) - of the commit. GitHub adds the signature to the `gpgsig` header - of the created commit. For a commit signature to be verifiable - by Git or GitHub, it must be an ASCII-armored detached PGP signature - over the string commit as it would be written to the object database. - To pass a `signature` parameter, you need to first manually create - a valid PGP signature, which can be complicated. You may find - it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) - to create signed commits. - required: - - message - - tree - examples: - default: - value: - message: my commit message - author: - name: Mona Octocat - email: octocat@github.com - date: '2008-07-09T16:13:30+12:00' - parents: - - 7d1b31e74ee336d15cbd21741bc88a537ed063a0 - tree: 827efc6d56897b048c772eb4087f854f46256132 - signature: | - -----BEGIN PGP SIGNATURE----- - - iQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv - 7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI - DkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n - 2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA - OQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k - nrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU - +NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB - jHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ - 3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+ - UpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr - X11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp - eSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc= - =5Io4 - -----END PGP SIGNATURE----- - responses: - '201': - description: Response - content: - application/json: - schema: &528 - title: Git Commit - description: Low-level Git commit operations within a repository - type: object - properties: - sha: - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - node_id: - type: string - url: - type: string - format: uri - author: - description: Identifying information for the git-user - type: object - properties: - date: - description: Timestamp of the commit - example: '2014-08-09T08:02:04+12:00' - format: date-time - type: string - email: - type: string - description: Git email address of the user - example: monalisa.octocat@example.com - name: - description: Name of the git user - example: Monalisa Octocat - type: string - required: - - email - - name - - date - committer: - description: Identifying information for the git-user - type: object - properties: - date: - description: Timestamp of the commit - example: '2014-08-09T08:02:04+12:00' - format: date-time - type: string - email: - type: string - description: Git email address of the user - example: monalisa.octocat@example.com - name: - description: Name of the git user - example: Monalisa Octocat - type: string - required: - - email - - name - - date - message: - description: Message describing the purpose of the commit - example: 'Fix #42' - type: string - tree: - type: object - properties: - sha: - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - url: - type: string - format: uri - required: - - sha - - url - parents: - type: array - items: - type: object - properties: - sha: - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - url: - type: string - format: uri - html_url: - type: string - format: uri - required: - - sha - - url - - html_url - verification: - type: object - properties: - verified: - type: boolean - reason: - type: string - signature: - type: string - nullable: true - payload: - type: string - nullable: true - verified_at: - type: string - nullable: true - required: - - verified - - reason - - signature - - payload - - verified_at - html_url: - type: string - format: uri - required: - - sha - - node_id - - url - - html_url - - author - - committer - - tree - - message - - parents - - verification - examples: - default: - value: - sha: 7638417db6d59f3c431d3e1f261cc637155684cd - node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd - author: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - committer: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - message: my commit message - tree: - url: https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132 - sha: 827efc6d56897b048c772eb4087f854f46256132 - parents: - - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0 - sha: 7d1b31e74ee336d15cbd21741bc88a537ed063a0 - html_url: https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0 - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd - schema: - type: string - '422': *15 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: commits - "/repos/{owner}/{repo}/git/commits/{commit_sha}": - get: - summary: Get a commit object - description: |- - Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - - To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - git - operationId: git/get-commit - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/commits#get-a-commit-object - parameters: - - *344 - - *345 - - *479 - responses: - '200': - description: Response - content: - application/json: - schema: *528 - examples: - default: - value: - sha: 7638417db6d59f3c431d3e1f261cc637155684cd - node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd - html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd - author: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - committer: - date: '2014-11-07T22:01:45Z' - name: Monalisa Octocat - email: octocat@github.com - message: added readme, because im a good github citizen - tree: - url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb - sha: 691272480426f78a0138979dd3ce63b77f706feb - parents: - - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 - sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 - html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: commits - "/repos/{owner}/{repo}/git/matching-refs/{ref}": - get: - summary: List matching references - description: |- - Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - - When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - - > [!NOTE] - > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - - If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - tags: - - git - operationId: git/list-matching-refs - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/refs#list-matching-references - parameters: - - *344 - - *345 - - &529 - name: ref - description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - in: path - required: true - example: heads/feature-a - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &530 - title: Git Reference - description: Git references within a repository - type: object - properties: - ref: - type: string - node_id: - type: string - url: - type: string - format: uri - object: - type: object - properties: - type: - type: string - sha: - description: SHA for the reference - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - minLength: 40 - maxLength: 40 - url: - type: string - format: uri - required: - - type - - sha - - url - required: - - ref - - node_id - - url - - object - examples: - default: - value: - - ref: refs/heads/feature-a - node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE= - url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a - object: - type: commit - sha: aa218f56b14c9653891f9e74264a383fa43fefbd - url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd - - ref: refs/heads/feature-b - node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI= - url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b - object: - type: commit - sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac - url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac - headers: - Link: *67 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: refs - "/repos/{owner}/{repo}/git/ref/{ref}": - get: - summary: Get a reference - description: |- - Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - - > [!NOTE] - > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - tags: - - git - operationId: git/get-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/refs#get-a-reference - parameters: - - *344 - - *345 - - *529 - responses: - '200': - description: Response - content: - application/json: - schema: *530 - examples: - default: &531 - value: - ref: refs/heads/featureA - node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== - url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA - object: - type: commit - sha: aa218f56b14c9653891f9e74264a383fa43fefbd - url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: refs - "/repos/{owner}/{repo}/git/refs": - post: - summary: Create a reference - description: Creates a reference for your repository. You are unable to create - new references for empty repositories, even if the commit SHA-1 hash used - exists. Empty repositories are repositories without branches. - tags: - - git - operationId: git/create-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/refs#create-a-reference - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - ref: - type: string - description: 'The name of the fully qualified reference (ie: `refs/heads/master`). - If it doesn''t start with ''refs'' and have at least two slashes, - it will be rejected.' - sha: - type: string - description: The SHA1 value for this reference. - required: - - ref - - sha - examples: - default: - value: - ref: refs/heads/featureA - sha: aa218f56b14c9653891f9e74264a383fa43fefbd - responses: - '201': - description: Response - content: - application/json: - schema: *530 - examples: - default: *531 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA - schema: - type: string - '422': *15 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: refs - "/repos/{owner}/{repo}/git/refs/{ref}": - patch: - summary: Update a reference - description: Updates the provided reference to point to a new SHA. For more - information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - tags: - - git - operationId: git/update-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/refs#update-a-reference - parameters: - - *344 - - *345 - - *529 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - sha: - type: string - description: The SHA1 value to set this reference to - force: - type: boolean - description: Indicates whether to force the update or to make sure - the update is a fast-forward update. Leaving this out or setting - it to `false` will make sure you're not overwriting work. - default: false - required: - - sha - examples: - default: - value: - sha: aa218f56b14c9653891f9e74264a383fa43fefbd - force: true - responses: - '200': - description: Response - content: - application/json: - schema: *530 - examples: - default: *531 - '422': *15 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: refs - delete: - summary: Delete a reference - description: Deletes the provided reference. - tags: - - git - operationId: git/delete-ref - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/refs#delete-a-reference - parameters: - - *344 - - *345 - - *529 - responses: - '204': - description: Response - '422': - description: Validation failed, an attempt was made to delete the default - branch, or the endpoint has been spammed. - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: refs - "/repos/{owner}/{repo}/git/tags": - post: - summary: Create a tag object - description: |- - Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - git - operationId: git/create-tag - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/tags#create-a-tag-object - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tag: - type: string - description: The tag's name. This is typically a version (e.g., - "v0.0.1"). - message: - type: string - description: The tag message. - object: - type: string - description: The SHA of the git object this is tagging. - type: - type: string - description: The type of the object we're tagging. Normally this - is a `commit` but it can also be a `tree` or a `blob`. - enum: - - commit - - tree - - blob - tagger: - type: object - description: An object with information about the individual creating - the tag. - properties: - name: - type: string - description: The name of the author of the tag - email: - type: string - description: The email of the author of the tag - date: - type: string - format: date-time - description: 'When this object was tagged. This is a timestamp - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - required: - - name - - email - required: - - tag - - message - - object - - type - examples: - default: - value: - tag: v0.0.1 - message: initial version - object: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c - type: commit - tagger: - name: Monalisa Octocat - email: octocat@github.com - date: '2011-06-17T14:53:35-07:00' - responses: - '201': - description: Response - content: - application/json: - schema: &533 - title: Git Tag - description: Metadata for a Git tag - type: object - properties: - node_id: - type: string - example: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== - tag: - description: Name of the tag - example: v0.0.1 - type: string - sha: - type: string - example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac - url: - description: URL for the tag - example: https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac - type: string - format: uri - message: - description: Message describing the purpose of the tag - example: Initial public release - type: string - tagger: - type: object - properties: - date: - type: string - email: - type: string - name: - type: string - required: - - date - - email - - name - object: - type: object - properties: - sha: - type: string - type: - type: string - url: - type: string - format: uri - required: - - sha - - type - - url - verification: *532 - required: - - sha - - url - - node_id - - tagger - - object - - tag - - message - examples: - default: &534 - value: - node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== - tag: v0.0.1 - sha: 940bd336248efae0f9ee5bc7b2d5c985887b16ac - url: https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac - message: initial version - tagger: - name: Monalisa Octocat - email: octocat@github.com - date: '2014-11-07T22:01:45Z' - object: - type: commit - sha: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c - url: https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c - verification: - verified: false - reason: unsigned - signature: - payload: - verified_at: - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac - schema: - type: string - '422': *15 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: tags - "/repos/{owner}/{repo}/git/tags/{tag_sha}": - get: - summary: Get a tag - description: |- - **Signature verification object** - - The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: - - | Name | Type | Description | - | ---- | ---- | ----------- | - | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - | `signature` | `string` | The signature that was extracted from the commit. | - | `payload` | `string` | The value that was signed. | - | `verified_at` | `string` | The date the signature was verified by GitHub. | - - These are the possible values for `reason` in the `verification` object: - - | Value | Description | - | ----- | ----------- | - | `expired_key` | The key that made the signature is expired. | - | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - | `gpgverify_error` | There was an error communicating with the signature verification service. | - | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - | `unsigned` | The object does not include a signature. | - | `unknown_signature_type` | A non-PGP signature was found in the commit. | - | `no_user` | No user was associated with the `committer` email address in the commit. | - | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - | `unknown_key` | The key that made the signature has not been registered with any user's account. | - | `malformed_signature` | There was an error parsing the signature. | - | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - | `valid` | None of the above errors applied, so the signature is considered to be verified. | - tags: - - git - operationId: git/get-tag - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/tags#get-a-tag - parameters: - - *344 - - *345 - - name: tag_sha - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *533 - examples: - default: *534 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: tags - "/repos/{owner}/{repo}/git/trees": - post: - summary: Create a tree - description: |- - The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - - If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." - - Returns an error if you try to delete a file that does not exist. - tags: - - git - operationId: git/create-tree - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/trees#create-a-tree - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tree: - type: array - description: Objects (of `path`, `mode`, `type`, and `sha`) specifying - a tree structure. - items: - type: object - properties: - path: - type: string - description: The file referenced in the tree. - mode: - type: string - description: The file mode; one of `100644` for file (blob), - `100755` for executable (blob), `040000` for subdirectory - (tree), `160000` for submodule (commit), or `120000` for - a blob that specifies the path of a symlink. - enum: - - '100644' - - '100755' - - '040000' - - '160000' - - '120000' - type: - type: string - description: Either `blob`, `tree`, or `commit`. - enum: - - blob - - tree - - commit - sha: - type: string - description: "The SHA1 checksum ID of the object in the tree. - Also called `tree.sha`. If the value is `null` then the - file will be deleted. \n \n**Note:** Use either `tree.sha` - or `content` to specify the contents of the entry. Using - both `tree.sha` and `content` will return an error." - nullable: true - content: - type: string - description: "The content you want this file to have. GitHub - will write this blob out and use that SHA for this entry. - Use either this, or `tree.sha`. \n \n**Note:** Use either - `tree.sha` or `content` to specify the contents of the entry. - Using both `tree.sha` and `content` will return an error." - base_tree: - type: string - description: |- - The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - required: - - tree - examples: - default: - value: - base_tree: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 - tree: - - path: file.rb - mode: '100644' - type: blob - sha: 44b4fc6d56897b048c772eb4087f854f46256132 - responses: - '201': - description: Response - content: - application/json: - schema: &535 - title: Git Tree - description: The hierarchy between files in a Git repository. - type: object - properties: - sha: - type: string - url: - type: string - format: uri - truncated: - type: boolean - tree: - description: Objects specifying a tree structure - type: array - items: - type: object - required: - - path - - mode - - type - - sha - properties: - path: - type: string - example: test/file.rb - mode: - type: string - example: '040000' - type: - type: string - example: tree - sha: - type: string - example: 23f6827669e43831def8a7ad935069c8bd418261 - size: - type: integer - example: 12 - url: - type: string - example: https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 - example: - - path: file.rb - mode: '100644' - type: blob - size: 30 - sha: 44b4fc6d56897b048c772eb4087f854f46256132 - url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 - required: - - sha - - tree - - truncated - examples: - default: - value: - sha: cd8274d15fa3ae2ab983129fb037999f264ba9a7 - url: https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 - tree: - - path: file.rb - mode: '100644' - type: blob - size: 132 - sha: 7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b - url: https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b - truncated: true - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 - schema: - type: string - '422': *15 - '404': *6 - '403': *29 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: trees - "/repos/{owner}/{repo}/git/trees/{tree_sha}": - get: - summary: Get a tree - description: |- - Returns a single tree using the SHA1 value or ref name for that tree. - - If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - - > [!NOTE] - > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - tags: - - git - operationId: git/get-tree - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/git/trees#get-a-tree - parameters: - - *344 - - *345 - - name: tree_sha - description: The SHA1 value or ref (branch or tag) name of the tree. - in: path - required: true - schema: - type: string - x-multi-segment: true - - name: recursive - description: 'Setting this parameter to any value returns the objects or subtrees - referenced by the tree specified in `:tree_sha`. For example, setting `recursive` - to any of the following will enable returning objects or subtrees: `0`, - `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively - returning objects or subtrees.' - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *535 - examples: - default-response: - summary: Default response - value: - sha: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 - url: https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312 - tree: - - path: file.rb - mode: '100644' - type: blob - size: 30 - sha: 44b4fc6d56897b048c772eb4087f854f46256132 - url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 - - path: subdir - mode: '040000' - type: tree - sha: f484d249c660418515fb01c2b9662073663c242e - url: https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e - - path: exec_file - mode: '100755' - type: blob - size: 75 - sha: 45b983be36b73c0788dc9cbcb76cbb80fc7bb057 - url: https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057 - truncated: false - response-recursively-retrieving-a-tree: - summary: Response recursively retrieving a tree - value: - sha: fc6274d15fa3ae2ab983129fb037999f264ba9a7 - url: https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7 - tree: - - path: subdir/file.txt - mode: '100644' - type: blob - size: 132 - sha: 7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b - url: https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b - truncated: false - '422': *15 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: git - subcategory: trees - "/repos/{owner}/{repo}/hooks": - get: - summary: List repository webhooks - description: Lists webhooks for a repository. `last response` may return null - if there have not been any deliveries within 30 days. - tags: - - repos - operationId: repos/list-webhooks - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &536 - title: Webhook - description: Webhooks for repositories. - type: object - properties: - type: - type: string - id: - description: Unique identifier of the webhook. - example: 42 - type: integer - name: - description: The name of a valid service, use 'web' for a webhook. - example: web - type: string - active: - description: Determines whether the hook is actually triggered - on pushes. - type: boolean - example: true - events: - description: 'Determines what events the hook is triggered for. - Default: [''push''].' - type: array - items: - type: string - example: - - push - - pull_request - config: *12 - updated_at: - type: string - format: date-time - example: '2011-09-06T20:39:23Z' - created_at: - type: string - format: date-time - example: '2011-09-06T17:26:27Z' - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks/1 - test_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test - ping_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings - deliveries_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &784 - title: Hook Response - type: object - properties: - code: - type: integer - nullable: true - status: - type: string - nullable: true - message: - type: string - nullable: true - required: - - code - - status - - message - required: - - id - - url - - type - - name - - active - - events - - config - - ping_url - - created_at - - updated_at - - last_response - - test_url - examples: - default: - value: - - type: Repository - id: 12345678 - name: web - active: true - events: - - push - - pull_request - config: - content_type: json - insecure_ssl: '0' - url: https://example.com/webhook - updated_at: '2019-06-03T00:57:16Z' - created_at: '2019-06-03T00:57:16Z' - url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 - test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test - ping_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings - deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries - last_response: - code: - status: unused - message: - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - post: - summary: Create a repository webhook - description: |- - Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - share the same `config` as long as those webhooks do not have any `events` that overlap. - tags: - - repos - operationId: repos/create-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook - parameters: - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - name: - type: string - description: 'Use `web` to create a webhook. Default: `web`. This - parameter only accepts the value `web`.' - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - events: - type: array - description: Determines what [events](https://docs.github.com/webhooks/event-payloads) - the hook is triggered for. - default: - - push - items: - type: string - active: - type: boolean - description: Determines if notifications are sent when the webhook - is triggered. Set to `true` to send notifications. - default: true - additionalProperties: false - examples: - default: - value: - name: web - active: true - events: - - push - - pull_request - config: - url: https://example.com/webhook - content_type: json - insecure_ssl: '0' - responses: - '201': - description: Response - content: - application/json: - schema: *536 - examples: - default: &537 - value: - type: Repository - id: 12345678 - name: web - active: true - events: - - push - - pull_request - config: - content_type: json - insecure_ssl: '0' - url: https://example.com/webhook - updated_at: '2019-06-03T00:57:16Z' - created_at: '2019-06-03T00:57:16Z' - url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 - test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test - ping_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings - deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries - last_response: - code: - status: unused - message: - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 - schema: - type: string - '404': *6 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}": - get: - summary: Get a repository webhook - description: Returns a webhook configured in a repository. To get only the webhook - `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - tags: - - repos - operationId: repos/get-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - responses: - '200': - description: Response - content: - application/json: - schema: *536 - examples: - default: *537 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - patch: - summary: Update a repository webhook - description: Updates a webhook configured in a repository. If you previously - had a `secret` set, you must provide the same `secret` or set a new `secret` - or the secret will be removed. If you are only updating individual webhook - `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - tags: - - repos - operationId: repos/update-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - config: *12 - events: - type: array - description: Determines what [events](https://docs.github.com/webhooks/event-payloads) - the hook is triggered for. This replaces the entire array of events. - default: - - push - items: - type: string - add_events: - type: array - description: Determines a list of events to be added to the list - of events that the Hook triggers for. - items: - type: string - remove_events: - type: array - description: Determines a list of events to be removed from the - list of events that the Hook triggers for. - items: - type: string - active: - type: boolean - description: Determines if notifications are sent when the webhook - is triggered. Set to `true` to send notifications. - default: true - examples: - default: - value: - active: true - add_events: - - pull_request - responses: - '200': - description: Response - content: - application/json: - schema: *536 - examples: - default: *537 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - delete: - summary: Delete a repository webhook - description: |- - Delete a webhook for an organization. - - The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. - tags: - - repos - operationId: repos/delete-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}/config": - get: - summary: Get a webhook configuration for a repository - description: |- - Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - - OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/get-webhook-config-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository - parameters: - - *344 - - *345 - - *216 - responses: - '200': - description: Response - content: - application/json: - schema: *12 - examples: - default: *13 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - patch: - summary: Update a webhook configuration for a repository - description: |- - Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - - OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/update-webhook-config-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository - parameters: - - *344 - - *345 - - *216 - requestBody: - required: false - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - examples: - default: - summary: Example of updating content type and URL - value: - content_type: json - url: https://example.com/webhook - responses: - '200': - description: Response - content: - application/json: - schema: *12 - examples: - default: *13 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": - get: - summary: List deliveries for a repository webhook - description: Returns a list of webhook deliveries for a webhook configured in - a repository. - tags: - - repos - operationId: repos/list-webhook-deliveries - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - - *17 - - *217 - - *218 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *219 - examples: - default: *220 - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": - get: - summary: Get a delivery for a repository webhook - description: Returns a delivery for a webhook configured in a repository. - tags: - - repos - operationId: repos/get-webhook-delivery - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - - *16 - responses: - '200': - description: Response - content: - application/json: - schema: *221 - examples: - default: *222 - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": - post: - summary: Redeliver a delivery for a repository webhook - description: Redeliver a webhook delivery for a webhook configured in a repository. - tags: - - repos - operationId: repos/redeliver-webhook-delivery - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - - *16 - responses: - '202': *39 - '400': *14 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}/pings": - post: - summary: Ping a repository webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - to be sent to the hook. - tags: - - repos - operationId: repos/ping-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook - parameters: - - *344 - - *345 - - *216 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/hooks/{hook_id}/tests": - post: - summary: Test the push repository webhook - description: |- - This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - - > [!NOTE] - > Previously `/repos/:owner/:repo/hooks/:hook_id/test` - tags: - - repos - operationId: repos/test-push-webhook - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook - parameters: - - *344 - - *345 - - *216 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: webhooks - "/repos/{owner}/{repo}/immutable-releases": - get: - summary: Check if immutable releases are enabled for a repository - description: |- - Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being - enforced by the repository owner. The authenticated user must have admin read access to the repository. - tags: - - repos - operationId: repos/check-immutable-releases - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response if immutable releases are enabled - content: - application/json: - schema: - title: Check immutable releases - description: Check immutable releases - type: object - properties: - enabled: - type: boolean - example: true - description: Whether immutable releases are enabled for the repository. - enforced_by_owner: - type: boolean - example: false - description: Whether immutable releases are enforced by the repository - owner. - required: - - enabled - - enforced_by_owner - examples: - default: - value: - enabled: true - enforced_by_owner: false - '404': - description: Not Found if immutable releases are not enabled for the repository - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - put: - summary: Enable immutable releases - description: Enables immutable releases for a repository. The authenticated - user must have admin access to the repository. - tags: - - repos - operationId: repos/enable-immutable-releases - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#enable-immutable-releases - parameters: - - *344 - - *345 - responses: - '204': *191 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - delete: - summary: Disable immutable releases - description: Disables immutable releases for a repository. The authenticated - user must have admin access to the repository. - tags: - - repos - operationId: repos/disable-immutable-releases - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#disable-immutable-releases - parameters: - - *344 - - *345 - responses: - '204': *191 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/import": - get: - summary: Get an import status - description: |- - View the progress of an import. - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - - **Import status** - - This section includes details about the possible values of the `status` field of the Import Progress response. - - An import that does not have errors will progress through these steps: - - * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. - * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). - * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. - * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * `complete` - the import is complete, and the repository is ready on GitHub. - - If there are problems, you will see one of these in the `status` field: - - * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL. - * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - - **The project_choices field** - - When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. - - **Git LFS related fields** - - This section includes details about Git LFS related fields that may be present in the Import Progress response. - - * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. - * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. - * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. - * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. - tags: - - migrations - operationId: migrations/get-import-status - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: &538 - title: Import - description: A repository import from an external source. - type: object - properties: - vcs: - type: string - nullable: true - use_lfs: - type: boolean - vcs_url: - description: The URL of the originating repository. - type: string - svc_root: - type: string - tfvc_project: - type: string - status: - type: string - enum: - - auth - - error - - none - - detecting - - choose - - auth_failed - - importing - - mapping - - waiting_to_push - - pushing - - complete - - setup - - unknown - - detection_found_multiple - - detection_found_nothing - - detection_needs_auth - status_text: - type: string - nullable: true - failed_step: - type: string - nullable: true - error_message: - type: string - nullable: true - import_percent: - type: integer - nullable: true - commit_count: - type: integer - nullable: true - push_percent: - type: integer - nullable: true - has_large_files: - type: boolean - large_files_size: - type: integer - large_files_count: - type: integer - project_choices: - type: array - items: - type: object - properties: - vcs: - type: string - tfvc_project: - type: string - human_name: - type: string - message: - type: string - authors_count: - type: integer - nullable: true - url: - type: string - format: uri - html_url: - type: string - format: uri - authors_url: - type: string - format: uri - repository_url: - type: string - format: uri - svn_root: - type: string - required: - - vcs - - vcs_url - - status - - url - - repository_url - - html_url - - authors_url - examples: - default: &541 - value: - vcs: subversion - use_lfs: true - vcs_url: http://svn.mycompany.com/svn/myproject - status: complete - status_text: Done - has_large_files: true - large_files_size: 132331036 - large_files_count: 1 - authors_count: 4 - url: https://api.github.com/repos/octocat/socm/import - html_url: https://import.github.com/octocat/socm/import - authors_url: https://api.github.com/repos/octocat/socm/import/authors - repository_url: https://api.github.com/repos/octocat/socm - '404': *6 - '503': &539 - description: Unavailable due to service under maintenance. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - put: - summary: Start an import - description: |- - Start a source import to a GitHub repository using GitHub Importer. - Importing into a GitHub repository with GitHub Actions enabled is not supported and will - return a status `422 Unprocessable Entity` response. - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/start-import - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#start-an-import - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - vcs_url: - type: string - description: The URL of the originating repository. - vcs: - type: string - description: The originating VCS type. Without this parameter, the - import job will take additional time to detect the VCS type before - beginning the import. This detection step will be reflected in - the response. - enum: - - subversion - - git - - mercurial - - tfvc - vcs_username: - type: string - description: If authentication is required, the username to provide - to `vcs_url`. - vcs_password: - type: string - description: If authentication is required, the password to provide - to `vcs_url`. - tfvc_project: - type: string - description: For a tfvc import, the name of the project that is - being imported. - required: - - vcs_url - examples: - default: - value: - vcs: subversion - vcs_url: http://svn.mycompany.com/svn/myproject - vcs_username: octocat - vcs_password: secret - responses: - '201': - description: Response - content: - application/json: - schema: *538 - examples: - default: - value: - vcs: subversion - use_lfs: true - vcs_url: http://svn.mycompany.com/svn/myproject - status: importing - status_text: Importing... - has_large_files: false - large_files_size: 0 - large_files_count: 0 - authors_count: 0 - commit_count: 1042 - url: https://api.github.com/repos/octocat/socm/import - html_url: https://import.github.com/octocat/socm/import - authors_url: https://api.github.com/repos/octocat/socm/import/authors - repository_url: https://api.github.com/repos/octocat/socm - headers: - Location: - example: https://api.github.com/repos/spraints/socm/import - schema: - type: string - '422': *15 - '404': *6 - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - patch: - summary: Update an import - description: |- - An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API - request. If no parameters are provided, the import will be restarted. - - Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will - have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. - You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/update-import - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#update-an-import - parameters: - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - vcs_username: - type: string - description: The username to provide to the originating repository. - vcs_password: - type: string - description: The password to provide to the originating repository. - vcs: - type: string - description: The type of version control system you are migrating - from. - enum: - - subversion - - tfvc - - git - - mercurial - example: '"git"' - tfvc_project: - type: string - description: For a tfvc import, the name of the project that is - being imported. - example: '"project1"' - nullable: true - examples: - example-1: - summary: Update authentication for an import - value: - vcs_username: octocat - vcs_password: secret - example-2: - summary: Updating the project choice - value: - vcs: tfvc - tfvc_project: project1 - human_name: project1 (tfs) - example-3: - summary: Restarting an import - responses: - '200': - description: Response - content: - application/json: - schema: *538 - examples: - example-1: - summary: Example 1 - value: - vcs: subversion - use_lfs: true - vcs_url: http://svn.mycompany.com/svn/myproject - status: detecting - url: https://api.github.com/repos/octocat/socm/import - html_url: https://import.github.com/octocat/socm/import - authors_url: https://api.github.com/repos/octocat/socm/import/authors - repository_url: https://api.github.com/repos/octocat/socm - example-2: - summary: Example 2 - value: - vcs: tfvc - use_lfs: true - vcs_url: http://tfs.mycompany.com/tfs/myproject - tfvc_project: project1 - status: importing - status_text: Importing... - has_large_files: false - large_files_size: 0 - large_files_count: 0 - authors_count: 0 - commit_count: 1042 - url: https://api.github.com/repos/octocat/socm/import - html_url: https://import.github.com/octocat/socm/import - authors_url: https://api.github.com/repos/octocat/socm/import/authors - repository_url: https://api.github.com/repos/octocat/socm - example-3: - summary: Response - value: - vcs: subversion - use_lfs: true - vcs_url: http://svn.mycompany.com/svn/myproject - status: importing - status_text: Importing... - has_large_files: false - large_files_size: 0 - large_files_count: 0 - authors_count: 0 - commit_count: 1042 - url: https://api.github.com/repos/octocat/socm/import - html_url: https://import.github.com/octocat/socm/import - authors_url: https://api.github.com/repos/octocat/socm/import/authors - repository_url: https://api.github.com/repos/octocat/socm - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - delete: - summary: Cancel an import - description: |- - Stop an import for a repository. - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/cancel-import - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - "/repos/{owner}/{repo}/import/authors": - get: - summary: Get commit authors - description: |- - Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. - - This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/get-commit-authors - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors - parameters: - - *344 - - *345 - - &712 - name: since - description: A user ID. Only return users with an ID greater than this ID. - in: query - required: false - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &540 - title: Porter Author - description: Porter Author - type: object - properties: - id: - type: integer - remote_id: - type: string - remote_name: - type: string - email: - type: string - name: - type: string - url: - type: string - format: uri - import_url: - type: string - format: uri - required: - - id - - remote_id - - remote_name - - email - - name - - url - - import_url - examples: - default: - value: - - id: 2268557 - remote_id: nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef - remote_name: nobody - email: hubot@github.com - name: Hubot - url: https://api.github.com/repos/octocat/socm/import/authors/2268557 - import_url: https://api.github.com/repos/octocat/socm/import - - id: 2268558 - remote_id: svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef - remote_name: svner - email: svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef - name: svner - url: https://api.github.com/repos/octocat/socm/import/authors/2268558 - import_url: https://api.github.com/repos/octocat/socm/import - - id: 2268559 - remote_id: svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef - remote_name: svner@example.com - email: svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef - name: svner@example.com - url: https://api.github.com/repos/octocat/socm/import/authors/2268559 - import_url: https://api.github.com/repos/octocat/socm/import - '404': *6 - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - "/repos/{owner}/{repo}/import/authors/{author_id}": - patch: - summary: Map a commit author - description: |- - Update an author's identity for the import. Your application can continue updating authors any time before you push - new commits to the repository. - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/map-commit-author - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author - parameters: - - *344 - - *345 - - name: author_id - in: path - required: true - schema: - type: integer - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - email: - type: string - description: The new Git author email. - name: - type: string - description: The new Git author name. - additionalProperties: false - examples: - default: - value: - email: hubot@github.com - name: Hubot the Robot - responses: - '200': - description: Response - content: - application/json: - schema: *540 - examples: - default: - value: - id: 2268557 - remote_id: nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef - remote_name: nobody - email: hubot@github.com - name: Hubot - url: https://api.github.com/repos/octocat/socm/import/authors/2268557 - import_url: https://api.github.com/repos/octocat/socm/import - '422': *15 - '404': *6 - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - "/repos/{owner}/{repo}/import/large_files": - get: - summary: Get large files - description: |- - List files larger than 100MB found during the import - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/get-large-files - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#get-large-files - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Porter Large File - description: Porter Large File - type: object - properties: - ref_name: - type: string - path: - type: string - oid: - type: string - size: - type: integer - required: - - oid - - path - - ref_name - - size - examples: - default: - value: - - ref_name: refs/heads/master - path: foo/bar/1 - oid: d3d9446802a44259755d38e6d163e820 - size: 10485760 - - ref_name: refs/heads/master - path: foo/bar/2 - oid: 6512bd43d9caa6e02c990b0a82652dca - size: 11534336 - - ref_name: refs/heads/master - path: foo/bar/3 - oid: c20ad4d76fe97759aa27a0c99bff6710 - size: 12582912 - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - "/repos/{owner}/{repo}/import/lfs": - patch: - summary: Update Git LFS preference - description: |- - You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability - is powered by [Git LFS](https://git-lfs.com). - - You can learn more about our LFS feature and working with large files [on our help - site](https://docs.github.com/repositories/working-with-files/managing-large-files). - - > [!WARNING] - > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - tags: - - migrations - operationId: migrations/set-lfs-preference - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - use_lfs: - type: string - description: Whether to store large files during the import. `opt_in` - means large files will be stored using Git LFS. `opt_out` means - large files will be removed during the import. - enum: - - opt_in - - opt_out - required: - - use_lfs - examples: - default: - value: - use_lfs: opt_in - responses: - '200': - description: Response - content: - application/json: - schema: *538 - examples: - default: *541 - '422': *15 - '503': *539 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: migrations - subcategory: source-imports - deprecationDate: '2023-10-12' - removalDate: '2024-04-12' - deprecated: true - "/repos/{owner}/{repo}/installation": - get: - summary: Get a repository installation for the authenticated app - description: |- - Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-repo-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *22 - examples: - default: *542 - '301': *348 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - "/repos/{owner}/{repo}/interaction-limits": - get: - summary: Get interaction restrictions for a repository - description: Shows which type of GitHub user can interact with this repository - and when the restriction expires. If there are no restrictions, you will see - an empty response. - tags: - - interactions - operationId: interactions/get-restrictions-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - anyOf: - - *235 - - type: object - properties: {} - additionalProperties: false - examples: - default: &544 - value: - limit: collaborators_only - origin: repository - expires_at: '2018-08-17T04:18:39Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: interactions - subcategory: repos - put: - summary: Set interaction restrictions for a repository - description: Temporarily restricts interactions to a certain type of GitHub - user within the given repository. You must have owner or admin access to set - these restrictions. If an interaction limit is set for the user or organization - that owns this repository, you will receive a `409 Conflict` response and - will not be able to use this endpoint to change the interaction limit for - a single repository. - tags: - - interactions - operationId: interactions/set-restrictions-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: *543 - examples: - default: - summary: Example request body - value: - limit: collaborators_only - expiry: one_day - responses: - '200': - description: Response - content: - application/json: - schema: *235 - examples: - default: *544 - '409': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: interactions - subcategory: repos - delete: - summary: Remove interaction restrictions for a repository - description: Removes all interaction restrictions from the given repository. - You must have owner or admin access to remove restrictions. If the interaction - limit is set for the user or organization that owns this repository, you will - receive a `409 Conflict` response and will not be able to use this endpoint - to change the interaction limit for a single repository. - tags: - - interactions - operationId: interactions/remove-restrictions-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '409': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: interactions - subcategory: repos - "/repos/{owner}/{repo}/invitations": - get: - summary: List repository invitations - description: When authenticating as a user with admin rights to a repository, - this endpoint will list all currently open repository invitations. - tags: - - repos - operationId: repos/list-invitations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *545 - examples: - default: &705 - value: - - id: 1 - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - invitee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - inviter: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - permissions: write - created_at: '2016-06-13T14:52:50-05:00' - url: https://api.github.com/user/repository_invitations/1296269 - html_url: https://github.com/octocat/Hello-World/invitations - node_id: MDQ6VXNlcjE= - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: invitations - "/repos/{owner}/{repo}/invitations/{invitation_id}": - patch: - summary: Update a repository invitation - description: '' - tags: - - repos - operationId: repos/update-invitation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation - parameters: - - *344 - - *345 - - *239 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permissions: - type: string - description: The permissions that the associated user will have - on the repository. Valid values are `read`, `write`, `maintain`, - `triage`, and `admin`. - enum: - - read - - write - - maintain - - triage - - admin - examples: - default: - summary: Example request body - value: - permissions: write - responses: - '200': - description: Response - content: - application/json: - schema: *545 - examples: - default: - value: - id: 1 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - invitee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - inviter: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - permissions: write - created_at: '2016-06-13T14:52:50-05:00' - expired: false - url: https://api.github.com/user/repository_invitations/1296269 - html_url: https://github.com/octocat/Hello-World/invitations - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: invitations - delete: - summary: Delete a repository invitation - description: '' - tags: - - repos - operationId: repos/delete-invitation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation - parameters: - - *344 - - *345 - - *239 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: collaborators - subcategory: invitations - "/repos/{owner}/{repo}/issues": - get: - summary: List repository issues - description: |- - List issues in a repository. Only open issues will be listed. - - > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#list-repository-issues - parameters: - - *344 - - *345 - - name: milestone - description: If an `integer` is passed, it should refer to a milestone by - its `number` field. If the string `*` is passed, issues with any milestone - are accepted. If the string `none` is passed, issues without milestones - are returned. - in: query - required: false - schema: - type: string - - name: state - description: Indicates the state of the issues to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - name: assignee - description: Can be the name of a user. Pass in `none` for issues with no - assigned user, and `*` for issues assigned to any user. - in: query - required: false - schema: - type: string - - name: type - description: Can be the name of an issue type. If the string `*` is passed, - issues with any type are accepted. If the string `none` is passed, issues - without type are returned. - in: query - required: false - schema: - type: string - - name: creator - description: The user that created the issue. - in: query - required: false - schema: - type: string - - name: mentioned - description: A user that's mentioned in the issue. - in: query - required: false - schema: - type: string - - *246 - - name: sort - description: What to sort results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - comments - default: created - - *61 - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: &558 - value: - - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - closed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - author_association: COLLABORATOR - state_reason: completed - headers: - Link: *67 - '301': *348 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - post: - summary: Create an issue - description: |- - Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/create - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#create-an-issue - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - oneOf: - - type: string - - type: integer - description: The title of the issue. - body: - type: string - description: The contents of the issue. - assignee: - type: string - description: 'Login for the user that this issue should be assigned - to. _NOTE: Only users with push access can set the assignee for - new issues. The assignee is silently dropped otherwise. **This - field is closing down.**_' - nullable: true - milestone: - oneOf: - - type: string - - type: integer - description: 'The `number` of the milestone to associate this - issue with. _NOTE: Only users with push access can set the milestone - for new issues. The milestone is silently dropped otherwise._' - nullable: true - labels: - type: array - description: 'Labels to associate with this issue. _NOTE: Only users - with push access can set labels for new issues. Labels are silently - dropped otherwise._' - items: - oneOf: - - type: string - - type: object - properties: - id: - type: integer - name: - type: string - description: - type: string - nullable: true - color: - type: string - nullable: true - assignees: - type: array - description: 'Logins for Users to assign to this issue. _NOTE: Only - users with push access can set assignees for new issues. Assignees - are silently dropped otherwise._' - items: - type: string - type: - type: string - description: 'The name of the issue type to associate with this - issue. _NOTE: Only users with push access can set the type for - new issues. The type is silently dropped otherwise._' - nullable: true - example: Epic - required: - - title - examples: - default: - value: - title: Found a bug - body: I'm having a problem with this. - assignees: - - octocat - milestone: 1 - labels: - - bug - responses: - '201': - description: Response - content: - application/json: - schema: *85 - examples: - default: &555 - value: - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - closed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - author_association: COLLABORATOR - state_reason: completed - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - schema: - type: string - '400': *14 - '403': *29 - '422': *15 - '503': *121 - '404': *6 - '410': *546 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - x-github-breaking-changes: - - changeset: remove_singular_assignee_from_issues_and_pull_requests - patch: - requestBody: - content: - application/json: - schema: - properties: - assignee: - version: '2026-03-10' - "/repos/{owner}/{repo}/issues/comments": - get: - summary: List issue comments for a repository - description: |- - You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - - By default, issue comments are ordered by ascending ID. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-comments-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository - parameters: - - *344 - - *345 - - *109 - - name: direction - description: Either `asc` or `desc`. Ignored without the `sort` parameter. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *547 - examples: - default: &557 - value: - - id: 1 - node_id: MDEyOklzc3VlQ29tbWVudDE= - url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 - html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 - body: Me too - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - author_association: COLLABORATOR - headers: - Link: *67 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - "/repos/{owner}/{repo}/issues/comments/{comment_id}": - get: - summary: Get an issue comment - description: |- - You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/get-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#get-an-issue-comment - parameters: - - *344 - - *345 - - *101 - responses: - '200': - description: Response - content: - application/json: - schema: *547 - examples: - default: &548 - value: - id: 1 - node_id: MDEyOklzc3VlQ29tbWVudDE= - url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 - html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 - body: Me too - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - author_association: COLLABORATOR - pin: - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - patch: - summary: Update an issue comment - description: |- - You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/update-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#update-an-issue-comment - parameters: - - *344 - - *345 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The contents of the comment. - required: - - body - examples: - default: - value: - body: Me too - responses: - '200': - description: Response - content: - application/json: - schema: *547 - examples: - default: *548 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - delete: - summary: Delete an issue comment - description: You can use the REST API to delete comments on issues and pull - requests. Every pull request is an issue, but not every issue is a pull request. - tags: - - issues - operationId: issues/delete-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment - parameters: - - *344 - - *345 - - *101 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": - put: - summary: Pin an issue comment - description: |- - You can use the REST API to pin comments on issues. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/pin-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment - parameters: - - *344 - - *345 - - *101 - responses: - '200': - description: Response - content: - application/json: - schema: *547 - examples: - default: - value: - id: 1 - node_id: MDEyOklzc3VlQ29tbWVudDE= - url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 - html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 - body: Me too - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - author_association: COLLABORATOR - pin: - pinned_at: '2021-01-01T00:00:00Z' - pinned_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '401': *25 - '403': *29 - '404': *6 - '410': *546 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - delete: - summary: Unpin an issue comment - description: You can use the REST API to unpin comments on issues. - tags: - - issues - operationId: issues/unpin-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment - parameters: - - *344 - - *345 - - *101 - responses: - '204': - description: Response - '401': *25 - '403': *29 - '404': *6 - '410': *546 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": - get: - summary: List reactions for an issue comment - description: List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). - tags: - - reactions - operationId: reactions/list-for-issue-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment - parameters: - - *344 - - *345 - - *101 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to an issue comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *476 - examples: - default: *549 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for an issue comment - description: Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). - A response with an HTTP `200` status means that you already added the reaction - type to this issue comment. - tags: - - reactions - operationId: reactions/create-for-issue-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment - parameters: - - *344 - - *345 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the issue comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Reaction exists - content: - application/json: - schema: *476 - examples: - default: *477 - '201': - description: Reaction created - content: - application/json: - schema: *476 - examples: - default: *477 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": - delete: - summary: Delete an issue comment reaction - description: |- - > [!NOTE] - > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - - Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). - tags: - - reactions - operationId: reactions/delete-for-issue-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction - parameters: - - *344 - - *345 - - *101 - - *550 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/issues/events": - get: - summary: List issue events for a repository - description: Lists events for a repository. - tags: - - issues - operationId: issues/list-events-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &554 - title: Issue Event - description: Issue Event - type: object - properties: - id: - type: integer - format: int64 - example: 1 - node_id: - type: string - example: MDEwOklzc3VlRXZlbnQx - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/events/1 - actor: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - event: - type: string - example: closed - commit_id: - type: string - example: 6dcb09b5b57875f334f61aebed695e2e4193db5e - nullable: true - commit_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - issue: - title: Issue - description: Issues are a great way to keep track of tasks, - enhancements, and bugs for your projects. - type: object - properties: *551 - required: *552 - x-github-breaking-changes: *553 - nullable: true - label: - title: Issue Event Label - description: Issue Event Label - type: object - properties: - name: - type: string - nullable: true - color: - type: string - nullable: true - required: - - name - - color - assignee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assigner: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - review_requester: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - requested_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - requested_team: *197 - dismissed_review: - title: Issue Event Dismissed Review - type: object - properties: - state: - type: string - review_id: - type: integer - dismissal_message: - type: string - nullable: true - dismissal_commit_id: - type: string - nullable: true - required: - - state - - review_id - - dismissal_message - milestone: - title: Issue Event Milestone - description: Issue Event Milestone - type: object - properties: - title: - type: string - required: - - title - project_card: - title: Issue Event Project Card - description: Issue Event Project Card - type: object - properties: - url: - type: string - format: uri - id: - type: integer - project_url: - type: string - format: uri - project_id: - type: integer - column_name: - type: string - previous_column_name: - type: string - required: - - url - - id - - project_url - - project_id - - column_name - rename: - title: Issue Event Rename - description: Issue Event Rename - type: object - properties: - from: - type: string - to: - type: string - required: - - from - - to - author_association: *82 - lock_reason: - type: string - nullable: true - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - examples: - default: - value: - - id: 1 - node_id: MDEwOklzc3VlRXZlbnQx - url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 - actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - event: closed - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - created_at: '2011-04-14T16:00:49Z' - issue: - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - author_association: COLLABORATOR - state_reason: completed - headers: - Link: *67 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: events - "/repos/{owner}/{repo}/issues/events/{event_id}": - get: - summary: Get an issue event - description: Gets a single event by the event id. - tags: - - issues - operationId: issues/get-event - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/events#get-an-issue-event - parameters: - - *344 - - *345 - - name: event_id - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *554 - examples: - default: - value: - id: 1 - node_id: MDEwOklzc3VlRXZlbnQx - url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 - actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - event: closed - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - created_at: '2011-04-14T16:00:49Z' - issue: - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - performed_via_github_app: - id: 1 - slug: octoapp - node_id: MDExOkludGVncmF0aW9uMQ== - owner: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - name: Octocat App - description: '' - external_url: https://example.com - html_url: https://github.com/apps/octoapp - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - permissions: - metadata: read - contents: read - issues: write - events: - - push - - pull_request - comments: 0 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - author_association: COLLABORATOR - state_reason: completed - '404': *6 - '410': *546 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: events - "/repos/{owner}/{repo}/issues/{issue_number}": - get: - summary: Get an issue - description: |- - The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If - the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe - to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. - - > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#get-an-issue - parameters: - - *344 - - *345 - - &556 - name: issue_number - description: The number that identifies the issue. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: - summary: Issue - value: *555 - pinned_comment: - summary: Issue with pinned comment - value: - value: - id: 1 - node_id: MDU6SXNzdWUx - url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - repository_url: https://api.github.com/repos/octocat/Hello-World - labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events - html_url: https://github.com/octocat/Hello-World/issues/1347 - number: 1347 - state: open - title: Found a bug - body: I'm having a problem with this. - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pinned_comment: - id: 1 - node_id: MDEyOklzc3VlQ29tbWVudDE= - url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 - html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 - body: Me too - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - pin: - pinned_at: '2021-01-01T00:00:00Z' - pinned_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - author_association: COLLABORATOR - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - locked: true - active_lock_reason: too heated - comments: 1 - pull_request: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - closed_at: - created_at: '2011-04-22T13:33:48Z' - updated_at: '2011-04-22T13:33:48Z' - closed_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - author_association: COLLABORATOR - state_reason: completed - '301': *348 - '404': *6 - '410': *546 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - patch: - summary: Update an issue - description: |- - Issue owners and users with push access or Triage role can edit an issue. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#update-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - oneOf: - - type: string - - type: integer - description: The title of the issue. - nullable: true - body: - type: string - description: The contents of the issue. - nullable: true - assignee: - type: string - nullable: true - description: Username to assign to this issue. **This field is closing - down.** - state: - type: string - description: The open or closed state of the issue. - enum: - - open - - closed - state_reason: - type: string - enum: - - completed - - not_planned - - duplicate - - reopened - nullable: true - description: The reason for the state change. Ignored unless `state` - is changed. - example: not_planned - milestone: - oneOf: - - type: string - - type: integer - description: The `number` of the milestone to associate this issue - with or use `null` to remove the current milestone. Only users - with push access can set the milestone for issues. Without push - access to the repository, milestone changes are silently dropped. - nullable: true - labels: - type: array - description: Labels to associate with this issue. Pass one or more - labels to _replace_ the set of labels on this issue. Send an empty - array (`[]`) to clear all labels from the issue. Only users with - push access can set labels for issues. Without push access to - the repository, label changes are silently dropped. - items: - oneOf: - - type: string - - type: object - properties: - id: - type: integer - name: - type: string - description: - type: string - nullable: true - color: - type: string - nullable: true - assignees: - type: array - description: Usernames to assign to this issue. Pass one or more - user logins to _replace_ the set of assignees on this issue. Send - an empty array (`[]`) to clear all assignees from the issue. Only - users with push access can set assignees for new issues. Without - push access to the repository, assignee changes are silently dropped. - items: - type: string - issue_field_values: - type: array - description: An array of issue field values to set on this issue. - Each field value must include the field ID and the value to set. - Only users with push access can set field values for issues - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - value: - oneOf: - - type: string - - type: number - description: The value to set for the field - required: - - field_id - - value - additionalProperties: false - type: - type: string - description: The name of the issue type to associate with this issue - or use `null` to remove the current issue type. Only users with - push access can set the type for issues. Without push access to - the repository, type changes are silently dropped. - nullable: true - example: Epic - examples: - default: - value: - title: Found a bug - body: I'm having a problem with this. - assignees: - - octocat - milestone: 1 - state: open - labels: - - bug - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - '422': *15 - '503': *121 - '403': *29 - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - x-github-breaking-changes: - - changeset: remove_singular_assignee_from_issues_and_pull_requests - patch: - requestBody: - content: - application/json: - schema: - properties: - assignee: - version: '2026-03-10' - "/repos/{owner}/{repo}/issues/{issue_number}/assignees": - post: - summary: Add assignees to an issue - description: Adds up to 10 assignees to an issue. Users already assigned to - an issue are not replaced. - tags: - - issues - operationId: issues/add-assignees - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - assignees: - type: array - description: 'Usernames of people to assign this issue to. _NOTE: - Only users with push access can add assignees to an issue. Assignees - are silently ignored otherwise._' - items: - type: string - examples: - default: - value: - assignees: - - hubot - - other_user - responses: - '201': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: assignees - delete: - summary: Remove assignees from an issue - description: Removes one or more assignees from an issue. - tags: - - issues - operationId: issues/remove-assignees - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - content: - application/json: - schema: - type: object - properties: - assignees: - type: array - description: 'Usernames of assignees to remove from an issue. _NOTE: - Only users with push access can remove assignees from an issue. - Assignees are silently ignored otherwise._' - items: - type: string - examples: - default: - value: - assignees: - - hubot - - other_user - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: assignees - "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": - get: - summary: Check if a user can be assigned to a issue - description: |- - Checks if a user has permission to be assigned to a specific issue. - - If the `assignee` can be assigned to this issue, a `204` status code with no content is returned. - - Otherwise a `404` status code is returned. - tags: - - issues - operationId: issues/check-user-can-be-assigned-to-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue - parameters: - - *344 - - *345 - - *556 - - name: assignee - in: path - required: true - schema: - type: string - responses: - '204': - description: Response if `assignee` can be assigned to `issue_number` - '404': - description: Response if `assignee` can not be assigned to `issue_number` - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: assignees - "/repos/{owner}/{repo}/issues/{issue_number}/comments": - get: - summary: List issue comments - description: |- - You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - - Issue comments are ordered by ascending ID. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-comments - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#list-issue-comments - parameters: - - *344 - - *345 - - *556 - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *547 - examples: - default: *557 - headers: - Link: *67 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - post: - summary: Create an issue comment - description: |- - You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). - Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/create-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/comments#create-an-issue-comment - parameters: - - *344 - - *345 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The contents of the comment. - required: - - body - examples: - default: - value: - body: Me too - responses: - '201': - description: Response - content: - application/json: - schema: *547 - examples: - default: *548 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 - schema: - type: string - '403': *29 - '410': *546 - '422': *15 - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: comments - "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": - get: - summary: List dependencies an issue is blocked by - description: |- - You can use the REST API to list the dependencies an issue is blocked by. - - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-dependencies-blocked-by - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: *558 - headers: - Link: *67 - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-dependencies - post: - summary: Add a dependency an issue is blocked by - description: |- - You can use the REST API to add a 'blocked by' relationship to an issue. - - Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) - and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). - - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/add-blocked-by-dependency - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by - parameters: - - *344 - - *345 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_id: - type: integer - description: The id of the issue that blocks the current issue - required: - - issue_id - examples: - default: - value: - issue_id: 1 - responses: - '201': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by - schema: - type: string - '301': *348 - '403': *29 - '410': *546 - '422': *15 - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-dependencies - "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": - delete: - summary: Remove dependency an issue is blocked by - description: |- - You can use the REST API to remove a dependency that an issue is blocked by. - - Removing content too quickly using this endpoint may result in secondary rate limiting. - For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) - and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). - - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/remove-dependency-blocked-by - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by - parameters: - - *344 - - *345 - - *556 - - name: issue_id - in: path - description: The id of the blocking issue to remove as a dependency - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - '301': *348 - '400': *14 - '401': *25 - '403': *29 - '404': *6 - '410': *546 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-dependencies - "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": - get: - summary: List dependencies an issue is blocking - description: |- - You can use the REST API to list the dependencies an issue is blocking. - - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-dependencies-blocking - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: *558 - headers: - Link: *67 - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-dependencies - "/repos/{owner}/{repo}/issues/{issue_number}/events": - get: - summary: List issue events - description: Lists all events for an issue. - tags: - - issues - operationId: issues/list-events - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/events#list-issue-events - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Issue Event for Issue - description: Issue Event for Issue - anyOf: - - &561 - title: Labeled Issue Event - description: Labeled Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - label: - type: object - properties: - name: - type: string - color: - type: string - required: - - name - - color - required: - - label - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &562 - title: Unlabeled Issue Event - description: Unlabeled Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - label: - type: object - properties: - name: - type: string - color: - type: string - required: - - name - - color - required: - - label - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - title: Assigned Issue Event - description: Assigned Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: *5 - assignee: *4 - assigner: *4 - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - assignee - - assigner - - title: Unassigned Issue Event - description: Unassigned Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - assignee: *4 - assigner: *4 - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - assignee - - assigner - - &563 - title: Milestoned Issue Event - description: Milestoned Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - milestone: - type: object - properties: - title: - type: string - required: - - title - required: - - milestone - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &564 - title: Demilestoned Issue Event - description: Demilestoned Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - milestone: - type: object - properties: - title: - type: string - required: - - title - required: - - milestone - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &565 - title: Renamed Issue Event - description: Renamed Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - rename: - type: object - properties: - from: - type: string - to: - type: string - required: - - from - - to - required: - - rename - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &566 - title: Review Requested Issue Event - description: Review Requested Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - review_requester: *4 - requested_team: *197 - requested_reviewer: *4 - required: - - review_requester - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &567 - title: Review Request Removed Issue Event - description: Review Request Removed Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - review_requester: *4 - requested_team: *197 - requested_reviewer: *4 - required: - - review_requester - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &568 - title: Review Dismissed Issue Event - description: Review Dismissed Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - dismissed_review: - type: object - properties: - state: - type: string - review_id: - type: integer - dismissal_message: - nullable: true - type: string - dismissal_commit_id: - type: string - required: - - state - - review_id - - dismissal_message - required: - - dismissed_review - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &569 - title: Locked Issue Event - description: Locked Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - lock_reason: - type: string - example: '"off-topic"' - nullable: true - required: - - lock_reason - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &570 - title: Added to Project Issue Event - description: Added to Project Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - project_card: - type: object - properties: - id: - type: integer - url: - type: string - format: uri - project_id: - type: integer - project_url: - type: string - format: uri - column_name: - type: string - previous_column_name: - type: string - required: - - id - - url - - project_id - - project_url - - column_name - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &571 - title: Moved Column in Project Issue Event - description: Moved Column in Project Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - project_card: - type: object - properties: - id: - type: integer - url: - type: string - format: uri - project_id: - type: integer - project_url: - type: string - format: uri - column_name: - type: string - previous_column_name: - type: string - required: - - id - - url - - project_id - - project_url - - column_name - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &572 - title: Removed from Project Issue Event - description: Removed from Project Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - project_card: - type: object - properties: - id: - type: integer - url: - type: string - format: uri - project_id: - type: integer - project_url: - type: string - format: uri - column_name: - type: string - previous_column_name: - type: string - required: - - id - - url - - project_id - - project_url - - column_name - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - &573 - title: Converted Note to Issue Issue Event - description: Converted Note to Issue Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: *5 - project_card: - type: object - properties: - id: - type: integer - url: - type: string - format: uri - project_id: - type: integer - project_url: - type: string - format: uri - column_name: - type: string - previous_column_name: - type: string - required: - - id - - url - - project_id - - project_url - - column_name - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - examples: - default: - value: - - id: 1 - node_id: MDEwOklzc3VlRXZlbnQx - url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 - actor: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - event: closed - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e - created_at: '2011-04-14T16:00:49Z' - performed_via_github_app: - label: - name: label - color: red - headers: - Link: *67 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: events - "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values": - get: - summary: List issue field values for an issue - description: Lists all issue field values for an issue. - tags: - - issues - operationId: issues/list-issue-field-values-for-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *559 - examples: - default: &675 - value: - - issue_field_id: 1 - node_id: IFT_GDKND - data_type: text - value: DRI - - issue_field_id: 2 - node_id: IFSS_SADMS - data_type: single_select - value: 1 - single_select_option: - id: 1 - name: High - color: red - - issue_field_id: 3 - node_id: IFN_POINTS - data_type: number - value: 42 - - issue_field_id: 4 - node_id: IFD_DUEDATE - data_type: date - value: '2025-12-25' - headers: - Link: *67 - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repos/{owner}/{repo}/issues/{issue_number}/labels": - get: - summary: List labels for an issue - description: Lists all labels for an issue. - tags: - - issues - operationId: issues/list-labels-on-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *84 - examples: - default: &560 - value: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - - id: 208045947 - node_id: MDU6TGFiZWwyMDgwNDU5NDc= - url: https://api.github.com/repos/octocat/Hello-World/labels/enhancement - name: enhancement - description: New feature or request - color: a2eeef - default: false - headers: - Link: *67 - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - post: - summary: Add labels to an issue - description: Adds labels to an issue. - tags: - - issues - operationId: issues/add-labels - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - labels: - type: array - minItems: 1 - description: The names of the labels to add to the issue's existing - labels. You can also pass an `array` of labels directly, but - GitHub recommends passing an object with the `labels` key. To - replace all of the labels for an issue, use "[Set labels for - an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." - items: - type: string - - type: array - items: - type: string - - type: array - items: - type: object - properties: - name: - type: string - required: - - name - examples: - default: - value: - labels: - - bug - - enhancement - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *84 - examples: - default: *560 - '301': *348 - '404': *6 - '410': *546 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - put: - summary: Set labels for an issue - description: Removes any previous labels and sets the new labels for an issue. - tags: - - issues - operationId: issues/set-labels - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - labels: - type: array - minItems: 1 - description: The names of the labels to set for the issue. The - labels you set replace any existing labels. You can pass an - empty array to remove all labels. Alternatively, you can pass - a single label as a `string` or an `array` of labels directly, - but GitHub recommends passing an object with the `labels` key. - You can also add labels to the existing labels for an issue. - For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." - items: - type: string - - type: array - minItems: 1 - items: - type: string - - type: object - properties: - labels: - type: array - minItems: 1 - items: - type: object - properties: - name: - type: string - required: - - name - - type: array - minItems: 1 - items: - type: object - properties: - name: - type: string - required: - - name - - type: string - examples: - default: - value: - labels: - - bug - - enhancement - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *84 - examples: - default: *560 - '301': *348 - '404': *6 - '410': *546 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - delete: - summary: Remove all labels from an issue - description: Removes all labels from an issue. - tags: - - issues - operationId: issues/remove-all-labels - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue - parameters: - - *344 - - *345 - - *556 - responses: - '204': - description: Response - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": - delete: - summary: Remove a label from an issue - description: Removes the specified label from the issue, and returns the remaining - labels on the issue. This endpoint returns a `404 Not Found` status if the - label does not exist. - tags: - - issues - operationId: issues/remove-label - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue - parameters: - - *344 - - *345 - - *556 - - name: name - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *84 - examples: - default: - value: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - "/repos/{owner}/{repo}/issues/{issue_number}/lock": - put: - summary: Lock an issue - description: |- - Users with push access can lock an issue or pull request's conversation. - - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - tags: - - issues - operationId: issues/lock - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#lock-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - lock_reason: - type: string - description: "The reason for locking the issue or pull request conversation. - Lock will fail if you don't use one of these reasons: \n * `off-topic` - \ \n * `too heated` \n * `resolved` \n * `spam`" - enum: - - off-topic - - too heated - - resolved - - spam - examples: - default: - summary: Example of locking an issue as off-topic - value: - lock_reason: off-topic - responses: - '204': - description: Response - '403': *29 - '410': *546 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - delete: - summary: Unlock an issue - description: Users with push access can unlock an issue's conversation. - tags: - - issues - operationId: issues/unlock - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#unlock-an-issue - parameters: - - *344 - - *345 - - *556 - responses: - '204': - description: Response - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issues - "/repos/{owner}/{repo}/issues/{issue_number}/parent": - get: - summary: Get parent issue - description: |- - You can use the REST API to get the parent issue of a sub-issue. - - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/get-parent - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue - parameters: - - *344 - - *345 - - *556 - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - '301': *348 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: sub-issues - "/repos/{owner}/{repo}/issues/{issue_number}/reactions": - get: - summary: List reactions for an issue - description: List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). - tags: - - reactions - operationId: reactions/list-for-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue - parameters: - - *344 - - *345 - - *556 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to an issue. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *476 - examples: - default: *549 - headers: - Link: *67 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for an issue - description: Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). - A response with an HTTP `200` status means that you already added the reaction - type to this issue. - tags: - - reactions - operationId: reactions/create-for-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the issue. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: *476 - examples: - default: *477 - '201': - description: Response - content: - application/json: - schema: *476 - examples: - default: *477 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": - delete: - summary: Delete an issue reaction - description: |- - > [!NOTE] - > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - - Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). - tags: - - reactions - operationId: reactions/delete-for-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction - parameters: - - *344 - - *345 - - *556 - - *550 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": - delete: - summary: Remove sub-issue - description: |- - You can use the REST API to remove a sub-issue from an issue. - Removing content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/remove-sub-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - sub_issue_id: - type: integer - description: The id of the sub-issue to remove - required: - - sub_issue_id - examples: - default: - value: - sub_issue_id: 6 - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue - schema: - type: string - '400': *14 - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: sub-issues - "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": - get: - summary: List sub-issues - description: |- - You can use the REST API to list the sub-issues on an issue. - - This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-sub-issues - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: *558 - headers: - Link: *67 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: sub-issues - post: - summary: Add sub-issue - description: |- - You can use the REST API to add sub-issues to issues. - - Creating content too quickly using this endpoint may result in secondary rate limiting. - For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/add-sub-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - sub_issue_id: - type: integer - description: The id of the sub-issue to add. The sub-issue must - belong to the same repository owner as the parent issue - replace_parent: - type: boolean - description: Option that, when true, instructs the operation to - replace the sub-issues current parent issue - required: - - sub_issue_id - examples: - default: - value: - sub_issue_id: 1 - responses: - '201': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 - schema: - type: string - '403': *29 - '410': *546 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: sub-issues - "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": - patch: - summary: Reprioritize sub-issue - description: You can use the REST API to reprioritize a sub-issue to a different - position in the parent list. - tags: - - issues - operationId: issues/reprioritize-sub-issue - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue - parameters: - - *344 - - *345 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - sub_issue_id: - type: integer - description: The id of the sub-issue to reprioritize - after_id: - type: integer - description: The id of the sub-issue to be prioritized after (either - positional argument after OR before should be specified). - before_id: - type: integer - description: The id of the sub-issue to be prioritized before (either - positional argument after OR before should be specified). - required: - - sub_issue_id - examples: - default: - value: - sub_issue_id: 6 - after_id: 5 - responses: - '200': - description: Response - content: - application/json: - schema: *85 - examples: - default: *555 - '403': *29 - '404': *6 - '422': *7 - '503': *121 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: sub-issues - "/repos/{owner}/{repo}/issues/{issue_number}/timeline": - get: - summary: List timeline events for an issue - description: List all timeline events for an issue. - tags: - - issues - operationId: issues/list-events-for-timeline - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue - parameters: - - *344 - - *345 - - *556 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Timeline Event - description: Timeline Event - type: object - anyOf: - - *561 - - *562 - - *563 - - *564 - - *565 - - *566 - - *567 - - *568 - - *569 - - *570 - - *571 - - *572 - - *573 - - title: Timeline Comment Event - description: Timeline Comment Event - type: object - properties: - event: - type: string - actor: *4 - id: - description: Unique identifier of the issue comment - example: 42 - type: integer - node_id: - type: string - url: - description: URL for the issue comment - example: https://api.github.com/repositories/42/issues/comments/1 - type: string - format: uri - body: - description: Contents of the issue comment - example: What version of Safari were you using when you observed - this bug? - type: string - body_text: - type: string - body_html: - type: string - html_url: - type: string - format: uri - user: *4 - created_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - updated_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - issue_url: - type: string - format: uri - author_association: *82 - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - reactions: *83 - pin: - title: Pinned Issue Comment - description: Context around who pinned an issue comment and - when it was pinned. - type: object - properties: *574 - required: *575 - nullable: true - required: - - event - - actor - - id - - node_id - - html_url - - issue_url - - author_association - - user - - url - - created_at - - updated_at - - title: Timeline Cross Referenced Event - description: Timeline Cross Referenced Event - type: object - properties: - event: - type: string - actor: *4 - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - source: - type: object - properties: - type: - type: string - issue: *85 - required: - - event - - created_at - - updated_at - - source - - title: Timeline Committed Event - description: Timeline Committed Event - type: object - properties: - event: - type: string - sha: - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - node_id: - type: string - url: - type: string - format: uri - author: - description: Identifying information for the git-user - type: object - properties: - date: - description: Timestamp of the commit - example: '2014-08-09T08:02:04+12:00' - format: date-time - type: string - email: - type: string - description: Git email address of the user - example: monalisa.octocat@example.com - name: - description: Name of the git user - example: Monalisa Octocat - type: string - required: - - email - - name - - date - committer: - description: Identifying information for the git-user - type: object - properties: - date: - description: Timestamp of the commit - example: '2014-08-09T08:02:04+12:00' - format: date-time - type: string - email: - type: string - description: Git email address of the user - example: monalisa.octocat@example.com - name: - description: Name of the git user - example: Monalisa Octocat - type: string - required: - - email - - name - - date - message: - description: Message describing the purpose of the commit - example: 'Fix #42' - type: string - tree: - type: object - properties: - sha: - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - url: - type: string - format: uri - required: - - sha - - url - parents: - type: array - items: - type: object - properties: - sha: - description: SHA for the commit - example: 7638417db6d59f3c431d3e1f261cc637155684cd - type: string - url: - type: string - format: uri - html_url: - type: string - format: uri - required: - - sha - - url - - html_url - verification: - type: object - properties: - verified: - type: boolean - reason: - type: string - signature: - type: string - nullable: true - payload: - type: string - nullable: true - verified_at: - type: string - nullable: true - required: - - verified - - reason - - signature - - payload - - verified_at - html_url: - type: string - format: uri - required: - - sha - - node_id - - url - - html_url - - author - - committer - - tree - - message - - parents - - verification - - title: Timeline Reviewed Event - description: Timeline Reviewed Event - type: object - properties: - event: - type: string - id: - description: Unique identifier of the review - example: 42 - type: integer - node_id: - type: string - example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: *4 - body: - nullable: true - description: The text of the review. - example: This looks great. - type: string - state: - type: string - example: CHANGES_REQUESTED - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - type: object - properties: - html: - type: object - properties: - href: - type: string - required: - - href - pull_request: - type: object - properties: - href: - type: string - required: - - href - required: - - html - - pull_request - submitted_at: - type: string - format: date-time - updated_at: - type: string - nullable: true - format: date-time - commit_id: - description: A commit SHA for the review. - example: 54bb654c9e6025347f57900a4a5c2313a96b8035 - type: string - body_html: - type: string - body_text: - type: string - author_association: *82 - required: - - event - - id - - node_id - - user - - body - - state - - commit_id - - html_url - - pull_request_url - - _links - - author_association - - title: Timeline Line Commented Event - description: Timeline Line Commented Event - type: object - properties: - event: - type: string - node_id: - type: string - comments: - type: array - items: &595 - title: Pull Request Review Comment - description: Pull Request Review Comments are comments on - a portion of the Pull Request's diff. - type: object - properties: - url: - description: URL for the pull request review comment - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - type: string - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: integer - format: int64 - example: 42 - nullable: true - id: - description: The ID of the pull request review comment. - type: integer - format: int64 - example: 1 - node_id: - description: The node ID of the pull request review - comment. - type: string - example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - example: "@@ -16,33 +16,40 @@ public class Connection - : IConnection..." - path: - description: The relative path of the file to which - the comment applies. - example: config/database.yaml - type: string - position: - description: The line index in the diff to which the - comment applies. This field is closing down; use `line` - instead. - example: 1 - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. This field is closing - down; use `original_line` instead. - example: 4 - type: integer - commit_id: - description: The SHA of the commit to which the comment - applies. - example: 6dcb09b5b57875f334f61aebed695e2e4193db5e - type: string - original_commit_id: - description: The SHA of the original commit to which - the comment applies. - example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - type: string - in_reply_to_id: - description: The comment ID to reply to. - example: 8 - type: integer - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - body: - description: The text of the comment. - example: We should probably include a check for null - values here. - type: string - created_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - updated_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *82 - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - required: - - href - html: - type: object - properties: - href: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - required: - - href - pull_request: - type: object - properties: - href: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - required: - - href - required: - - self - - html - - pull_request - start_line: - type: integer - description: The first line of the range for a multi-line - comment. - example: 2 - nullable: true - original_start_line: - type: integer - description: The first line of the range for a multi-line - comment. - example: 2 - nullable: true - start_side: - type: string - description: The side of the first line of the range - for a multi-line comment. - enum: - - LEFT - - RIGHT - default: RIGHT - nullable: true - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - example: 2 - type: integer - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - example: 2 - type: integer - side: - description: The side of the diff to which the comment - applies. The side of the last line of the range for - a multi-line comment - enum: - - LEFT - - RIGHT - default: RIGHT - type: string - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - reactions: *83 - body_html: - type: string - example: '"

comment body

"' - body_text: - type: string - example: '"comment body"' - required: - - url - - id - - node_id - - pull_request_review_id - - diff_hunk - - path - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - title: Timeline Commit Commented Event - description: Timeline Commit Commented Event - type: object - properties: - event: - type: string - node_id: - type: string - commit_id: - type: string - comments: - type: array - items: *475 - - title: Timeline Assigned Issue Event - description: Timeline Assigned Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - assignee: *4 - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - assignee - - title: Timeline Unassigned Issue Event - description: Timeline Unassigned Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - assignee: *4 - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - - assignee - - title: State Change Issue Event - description: State Change Issue Event - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - actor: *4 - event: - type: string - commit_id: - type: string - nullable: true - commit_url: - type: string - nullable: true - created_at: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - state_reason: - type: string - nullable: true - required: - - id - - node_id - - url - - actor - - event - - commit_id - - commit_url - - created_at - - performed_via_github_app - examples: - default: - value: - - id: 6430295168 - node_id: LOE_lADODwFebM5HwC0kzwAAAAF_RoSA - url: https://api.github.com/repos/github/roadmap/issues/events/6430295168 - actor: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/github - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: Organization - site_admin: false - event: locked - commit_id: - commit_url: - created_at: '2022-04-13T20:49:13Z' - lock_reason: - performed_via_github_app: - - id: 6430296748 - node_id: LE_lADODwFebM5HwC0kzwAAAAF_Roqs - url: https://api.github.com/repos/github/roadmap/issues/events/6430296748 - actor: - login: github-product-roadmap - id: 67656570 - node_id: MDQ6VXNlcjY3NjU2NTcw - avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 - gravatar_id: '' - url: https://api.github.com/users/github-product-roadmap - html_url: https://github.com/github-product-roadmap - followers_url: https://api.github.com/users/github-product-roadmap/followers - following_url: https://api.github.com/users/github-product-roadmap/following{/other_user} - gists_url: https://api.github.com/users/github-product-roadmap/gists{/gist_id} - starred_url: https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions - organizations_url: https://api.github.com/users/github-product-roadmap/orgs - repos_url: https://api.github.com/users/github-product-roadmap/repos - events_url: https://api.github.com/users/github-product-roadmap/events{/privacy} - received_events_url: https://api.github.com/users/github-product-roadmap/received_events - type: User - site_admin: false - event: labeled - commit_id: - commit_url: - created_at: '2022-04-13T20:49:34Z' - label: - name: beta - color: 99dd88 - performed_via_github_app: - - id: 6635165802 - node_id: RTE_lADODwFebM5HwC0kzwAAAAGLfJhq - url: https://api.github.com/repos/github/roadmap/issues/events/6635165802 - actor: - login: github-product-roadmap - id: 67656570 - node_id: MDQ6VXNlcjY3NjU2NTcw - avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 - gravatar_id: '' - url: https://api.github.com/users/github-product-roadmap - html_url: https://github.com/github-product-roadmap - followers_url: https://api.github.com/users/github-product-roadmap/followers - following_url: https://api.github.com/users/github-product-roadmap/following{/other_user} - gists_url: https://api.github.com/users/github-product-roadmap/gists{/gist_id} - starred_url: https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions - organizations_url: https://api.github.com/users/github-product-roadmap/orgs - repos_url: https://api.github.com/users/github-product-roadmap/repos - events_url: https://api.github.com/users/github-product-roadmap/events{/privacy} - received_events_url: https://api.github.com/users/github-product-roadmap/received_events - type: User - site_admin: false - event: renamed - commit_id: - commit_url: - created_at: '2022-05-18T19:29:01Z' - rename: - from: 'Secret scanning: dry-runs for enterprise-level custom - patterns (cloud)' - to: 'Secret scanning: dry-runs for enterprise-level custom patterns' - performed_via_github_app: - - url: https://api.github.com/repos/github/roadmap/issues/comments/1130876857 - html_url: https://github.com/github/roadmap/issues/493#issuecomment-1130876857 - issue_url: https://api.github.com/repos/github/roadmap/issues/493 - id: 1130876857 - node_id: IC_kwDODwFebM5DZ8-5 - user: - login: octocat - id: 94867353 - node_id: U_kgDOBaePmQ - avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - created_at: '2022-05-19T00:52:15Z' - updated_at: '2022-05-19T00:52:15Z' - author_association: COLLABORATOR - body: "\U0001F6A2 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/" - reactions: - url: https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions - total_count: 0 - "+1": 0 - "-1": 0 - laugh: 0 - hooray: 0 - confused: 0 - heart: 0 - rocket: 0 - eyes: 0 - performed_via_github_app: - event: commented - actor: - login: octocat - id: 94867353 - node_id: U_kgDOBaePmQ - avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - headers: - Link: *67 - '404': *6 - '410': *546 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: timeline - "/repos/{owner}/{repo}/keys": - get: - summary: List deploy keys - description: '' - tags: - - repos - operationId: repos/list-deploy-keys - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &576 - title: Deploy Key - description: An SSH key granting access to a single repository. - type: object - properties: - id: - type: integer - key: - type: string - url: - type: string - title: - type: string - verified: - type: boolean - created_at: - type: string - read_only: - type: boolean - added_by: - type: string - nullable: true - last_used: - nullable: true - type: string - format: date-time - enabled: - type: boolean - required: - - id - - key - - url - - title - - verified - - created_at - - read_only - examples: - default: - value: - - id: 1 - key: ssh-rsa AAA... - url: https://api.github.com/repos/octocat/Hello-World/keys/1 - title: octocat@octomac - verified: true - created_at: '2014-12-10T15:53:42Z' - read_only: true - added_by: octocat - last_used: '2022-01-10T15:53:42Z' - enabled: true - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deploy-keys - subcategory: deploy-keys - post: - summary: Create a deploy key - description: You can create a read-only deploy key. - tags: - - repos - operationId: repos/create-deploy-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: A name for the key. - key: - type: string - description: The contents of the key. - read_only: - type: boolean - description: "If `true`, the key will only be able to read repository - contents. Otherwise, the key will be able to read and write. \n - \ \nDeploy keys with write access can perform the same actions - as an organization member with admin access, or a collaborator - on a personal repository. For more information, see \"[Repository - permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" - and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"" - required: - - key - examples: - default: - value: - title: octocat@octomac - key: ssh-rsa AAA... - read_only: true - responses: - '201': - description: Response - content: - application/json: - schema: *576 - examples: - default: &577 - value: - id: 1 - key: ssh-rsa AAA... - url: https://api.github.com/repos/octocat/Hello-World/keys/1 - title: octocat@octomac - verified: true - created_at: '2014-12-10T15:53:42Z' - read_only: true - added_by: octocat - last_used: '2022-01-10T15:53:42Z' - enabled: true - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/keys/1 - schema: - type: string - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deploy-keys - subcategory: deploy-keys - "/repos/{owner}/{repo}/keys/{key_id}": - get: - summary: Get a deploy key - description: '' - tags: - - repos - operationId: repos/get-deploy-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key - parameters: - - *344 - - *345 - - &578 - name: key_id - description: The unique identifier of the key. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *576 - examples: - default: *577 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deploy-keys - subcategory: deploy-keys - delete: - summary: Delete a deploy key - description: Deploy keys are immutable. If you need to update a key, remove - the key and create a new one instead. - tags: - - repos - operationId: repos/delete-deploy-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key - parameters: - - *344 - - *345 - - *578 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: deploy-keys - subcategory: deploy-keys - "/repos/{owner}/{repo}/labels": - get: - summary: List labels for a repository - description: Lists all labels for a repository. - tags: - - issues - operationId: issues/list-labels-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *84 - examples: - default: *560 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - post: - summary: Create a label - description: Creates a label for the specified repository with the given name - and color. The name and color parameters are required. The color must be a - valid [hexadecimal color code](http://www.color-hex.com/). - tags: - - issues - operationId: issues/create-label - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#create-a-label - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the label. Emoji can be added to label - names, using either native emoji or colon-style markup. For example, - typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png - ":strawberry:"). For a full list of available emoji and codes, - see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." - color: - type: string - description: The [hexadecimal color code](http://www.color-hex.com/) - for the label, without the leading `#`. - description: - type: string - description: A short description of the label. Must be 100 characters - or fewer. - required: - - name - examples: - default: - value: - name: bug - description: Something isn't working - color: f29513 - responses: - '201': - description: Response - content: - application/json: - schema: *84 - examples: - default: &579 - value: - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/labels/bug - schema: - type: string - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - "/repos/{owner}/{repo}/labels/{name}": - get: - summary: Get a label - description: Gets a label using the given name. - tags: - - issues - operationId: issues/get-label - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#get-a-label - parameters: - - *344 - - *345 - - name: name - in: path - required: true - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *84 - examples: - default: *579 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - patch: - summary: Update a label - description: Updates a label using the given label name. - tags: - - issues - operationId: issues/update-label - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#update-a-label - parameters: - - *344 - - *345 - - name: name - in: path - required: true - schema: - type: string - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - new_name: - type: string - description: The new name of the label. Emoji can be added to label - names, using either native emoji or colon-style markup. For example, - typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png - ":strawberry:"). For a full list of available emoji and codes, - see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." - color: - type: string - description: The [hexadecimal color code](http://www.color-hex.com/) - for the label, without the leading `#`. - description: - type: string - description: A short description of the label. Must be 100 characters - or fewer. - examples: - default: - value: - new_name: 'bug :bug:' - description: Small bug fix required - color: b01f26 - responses: - '200': - description: Response - content: - application/json: - schema: *84 - examples: - default: - value: - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: 'https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:' - name: 'bug :bug:' - description: Small bug fix required - color: b01f26 - default: true - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - delete: - summary: Delete a label - description: Deletes a label using the given label name. - tags: - - issues - operationId: issues/delete-label - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#delete-a-label - parameters: - - *344 - - *345 - - name: name - in: path - required: true - schema: - type: string - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - "/repos/{owner}/{repo}/languages": - get: - summary: List repository languages - description: Lists languages for the specified repository. The value shown for - each language is the number of bytes of code written in that language. - tags: - - repos - operationId: repos/list-languages - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repository-languages - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Language - description: Language - type: object - additionalProperties: - type: integer - examples: - default: - value: - C: 78769 - Python: 7769 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/license": - get: - summary: Get the license for a repository - description: |- - This method returns the contents of the repository's license file, if one is detected. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - tags: - - licenses - operationId: licenses/get-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository - parameters: - - *344 - - *345 - - *448 - responses: - '200': - description: Response - content: - application/json: - schema: - title: License Content - description: License Content - type: object - properties: - name: - type: string - path: - type: string - sha: - type: string - size: - type: integer - url: - type: string - format: uri - html_url: - type: string - format: uri - nullable: true - git_url: - type: string - format: uri - nullable: true - download_url: - type: string - format: uri - nullable: true - type: - type: string - content: - type: string - encoding: - type: string - _links: - type: object - properties: - git: - type: string - format: uri - nullable: true - html: - type: string - format: uri - nullable: true - self: - type: string - format: uri - required: - - git - - html - - self - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - required: - - _links - - git_url - - html_url - - download_url - - name - - path - - sha - - size - - type - - url - - content - - encoding - - license - examples: - default: - value: - name: LICENSE - path: LICENSE - sha: 401c59dcc4570b954dd6d345e76199e1f4e76266 - size: 1077 - url: https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master - html_url: https://github.com/benbalter/gman/blob/master/LICENSE - git_url: https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 - download_url: https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true - type: file - content: | - VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu - IEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv - ZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0 - aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls - ZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg - d2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh - dGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg - cHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg - Y29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z - IHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK - c3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv - dmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj - ZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50 - aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ - UyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL - SU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ - TUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG - SVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO - R0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ - UklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF - UyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G - IENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP - VVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU - SEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K - encoding: base64 - _links: - self: https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master - git: https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 - html: https://github.com/benbalter/gman/blob/master/LICENSE - license: - key: mit - name: MIT License - spdx_id: MIT - url: https://api.github.com/licenses/mit - node_id: MDc6TGljZW5zZW1pdA== - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: licenses - subcategory: licenses - "/repos/{owner}/{repo}/merge-upstream": - post: - summary: Sync a fork branch with the upstream repository - description: Sync a branch of a forked repository to keep it up-to-date with - the upstream repository. - tags: - - repos - operationId: repos/merge-upstream - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - branch: - type: string - description: The name of the branch which should be updated to match - upstream. - required: - - branch - examples: - default: - value: - branch: main - responses: - '200': - description: The branch has been successfully synced with the upstream repository - content: - application/json: - schema: - title: Merged upstream - description: Results of a successful merge upstream request - type: object - properties: - message: - type: string - merge_type: - type: string - enum: - - merge - - fast-forward - - none - base_branch: - type: string - examples: - default: - value: - message: Successfully fetched and fast-forwarded from upstream - defunkt:main - merge_type: fast-forward - base_branch: defunkt:main - '409': - description: The branch could not be synced because of a merge conflict - '422': - description: The branch could not be synced for some other reason - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branches - "/repos/{owner}/{repo}/merges": - post: - summary: Merge a branch - description: '' - tags: - - repos - operationId: repos/merge - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/branches/branches#merge-a-branch - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - base: - type: string - description: The name of the base branch that the head will be merged - into. - head: - type: string - description: The head to merge. This can be a branch name or a commit - SHA1. - commit_message: - type: string - description: Commit message to use for the merge commit. If omitted, - a default message will be used. - required: - - base - - head - examples: - default: - value: - base: master - head: cool_feature - commit_message: Shipped cool_feature! - responses: - '201': - description: Successful Response (The resulting merge commit) - content: - application/json: - schema: *478 - examples: - default: *580 - '204': - description: Response when already merged - '404': - description: Not Found when the base or head does not exist - '409': - description: Conflict when there is a merge conflict - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: branches - subcategory: branches - "/repos/{owner}/{repo}/milestones": - get: - summary: List milestones - description: Lists milestones for a repository. - tags: - - issues - operationId: issues/list-milestones - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/milestones#list-milestones - parameters: - - *344 - - *345 - - name: state - description: The state of the milestone. Either `open`, `closed`, or `all`. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - name: sort - description: What to sort results by. Either `due_on` or `completeness`. - in: query - required: false - schema: - type: string - enum: - - due_on - - completeness - default: due_on - - name: direction - description: The direction of the sort. Either `asc` or `desc`. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: asc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &581 - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: *280 - required: *281 - examples: - default: - value: - - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: milestones - post: - summary: Create a milestone - description: Creates a milestone. - tags: - - issues - operationId: issues/create-milestone - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/milestones#create-a-milestone - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The title of the milestone. - state: - type: string - description: The state of the milestone. Either `open` or `closed`. - enum: - - open - - closed - default: open - description: - type: string - description: A description of the milestone. - due_on: - type: string - format: date-time - description: 'The milestone due date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' - required: - - title - examples: - default: - value: - title: v1.0 - state: open - description: Tracking milestone for version 1.0 - due_on: '2012-10-09T23:39:01Z' - responses: - '201': - description: Response - content: - application/json: - schema: *581 - examples: - default: &582 - value: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/milestones/1 - schema: - type: string - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: milestones - "/repos/{owner}/{repo}/milestones/{milestone_number}": - get: - summary: Get a milestone - description: Gets a milestone using the given milestone number. - tags: - - issues - operationId: issues/get-milestone - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/milestones#get-a-milestone - parameters: - - *344 - - *345 - - &583 - name: milestone_number - description: The number that identifies the milestone. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *581 - examples: - default: *582 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: milestones - patch: - summary: Update a milestone - description: '' - tags: - - issues - operationId: issues/update-milestone - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/milestones#update-a-milestone - parameters: - - *344 - - *345 - - *583 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The title of the milestone. - state: - type: string - description: The state of the milestone. Either `open` or `closed`. - enum: - - open - - closed - default: open - description: - type: string - description: A description of the milestone. - due_on: - type: string - format: date-time - description: 'The milestone due date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' - examples: - default: - value: - title: v1.0 - state: open - description: Tracking milestone for version 1.0 - due_on: '2012-10-09T23:39:01Z' - responses: - '200': - description: Response - content: - application/json: - schema: *581 - examples: - default: *582 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: milestones - delete: - summary: Delete a milestone - description: Deletes a milestone using the given milestone number. - tags: - - issues - operationId: issues/delete-milestone - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/milestones#delete-a-milestone - parameters: - - *344 - - *345 - - *583 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: milestones - "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": - get: - summary: List labels for issues in a milestone - description: Lists labels for issues in a milestone. - tags: - - issues - operationId: issues/list-labels-for-milestone - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone - parameters: - - *344 - - *345 - - *583 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *84 - examples: - default: *560 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: labels - "/repos/{owner}/{repo}/notifications": - get: - summary: List repository notifications for the authenticated user - description: Lists all notifications for the current user in the specified repository. - tags: - - activity - operationId: activity/list-repo-notifications-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user - parameters: - - *344 - - *345 - - *584 - - *585 - - *92 - - *586 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *112 - examples: - default: *587 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - put: - summary: Mark repository notifications as read - description: Marks all notifications in a repository as "read" for the current - user. If the number of notifications is too large to complete in one request, - you will receive a `202 Accepted` status and GitHub will run an asynchronous - process to mark notifications as "read." To check whether any "unread" notifications - remain, you can use the [List repository notifications for the authenticated - user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) - endpoint and pass the query parameter `all=false`. - tags: - - activity - operationId: activity/mark-repo-notifications-as-read - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read - parameters: - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - last_read_at: - type: string - format: date-time - description: 'Describes the last point that notifications were checked. - Anything updated since this time will not be marked as read. If - you omit this parameter, all notifications are marked as read. - This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) - format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.' - examples: - default: - value: - last_read_at: '2019-01-01T00:00:00Z' - responses: - '202': - description: Response - content: - application/json: - schema: - type: object - properties: - message: - type: string - url: - type: string - examples: - default: - value: - message: Unread notifications couldn't be marked in a single request. - Notifications are being marked as read in the background. - '205': - description: Reset Content - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: notifications - "/repos/{owner}/{repo}/pages": - get: - summary: Get a GitHub Pages site - description: |- - Gets information about a GitHub Pages site. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/get-pages - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: &588 - title: GitHub Pages - description: The configuration for GitHub Pages for a repository. - type: object - properties: - url: - type: string - description: The API address for accessing this Page resource. - format: uri - example: https://api.github.com/repos/github/hello-world/pages - status: - type: string - description: The status of the most recent build of the Page. - example: built - enum: - - built - - building - - errored - nullable: true - cname: - description: The Pages site's custom domain - example: example.com - type: string - nullable: true - protected_domain_state: - type: string - description: The state if the domain is verified - example: pending - nullable: true - enum: - - pending - - verified - - unverified - pending_domain_unverified_at: - type: string - description: The timestamp when a pending domain becomes unverified. - nullable: true - format: date-time - custom_404: - type: boolean - description: Whether the Page has a custom 404 page. - example: false - default: false - html_url: - type: string - description: The web address the Page can be accessed from. - format: uri - example: https://example.com - build_type: - type: string - description: The process in which the Page will be built. - example: legacy - nullable: true - enum: - - legacy - - workflow - source: - title: Pages Source Hash - type: object - properties: - branch: - type: string - path: - type: string - required: - - branch - - path - public: - type: boolean - description: Whether the GitHub Pages site is publicly visible. - If set to `true`, the site is accessible to anyone on the internet. - If set to `false`, the site will only be accessible to users - who have at least `read` access to the repository that published - the site. - example: true - https_certificate: - title: Pages Https Certificate - type: object - properties: - state: - type: string - enum: - - new - - authorization_created - - authorization_pending - - authorized - - authorization_revoked - - issued - - uploaded - - approved - - errored - - bad_authz - - destroy_pending - - dns_changed - example: approved - description: - type: string - example: Certificate is approved - domains: - type: array - items: - type: string - description: Array of the domain set and its alternate name - (if it is configured) - example: - - example.com - - www.example.com - expires_at: - type: string - format: date - required: - - state - - description - - domains - https_enforced: - type: boolean - description: Whether https is enabled on the domain - example: true - required: - - url - - status - - cname - - custom_404 - - public - examples: - default: &589 - value: - url: https://api.github.com/repos/github/developer.github.com/pages - status: built - cname: developer.github.com - custom_404: false - html_url: https://developer.github.com - source: - branch: master - path: "/" - public: true - pending_domain_unverified_at: '2024-04-30T19:33:31Z' - protected_domain_state: verified - https_certificate: - state: approved - description: Certificate is approved - domains: - - developer.github.com - expires_at: '2021-05-22' - https_enforced: true - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - post: - summary: Create a GitHub Pages site - description: |- - Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - - The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/create-pages-site - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - description: The source branch and directory used to publish your Pages - site. - nullable: true - properties: - build_type: - type: string - description: The process in which the Page will be built. Possible - values are `"legacy"` and `"workflow"`. - enum: - - legacy - - workflow - source: - type: object - description: The source branch and directory used to publish your - Pages site. - properties: - branch: - type: string - description: The repository branch used to publish your site's - source files. - path: - type: string - description: 'The repository directory that includes the source - files for the Pages site. Allowed paths are `/` or `/docs`. - Default: `/`' - enum: - - "/" - - "/docs" - default: "/" - required: - - branch - anyOf: - - required: - - source - - required: - - build_type - examples: - default: - value: - source: - branch: main - path: "/docs" - responses: - '201': - description: Response - content: - application/json: - schema: *588 - examples: - default: *589 - '422': *15 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - put: - summary: Update information about a GitHub Pages site - description: |- - Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - - The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/update-information-about-pages-site - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - cname: - type: string - description: Specify a custom domain for the repository. Sending - a `null` value will remove the custom domain. For more about custom - domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." - nullable: true - https_enforced: - type: boolean - description: Specify whether HTTPS should be enforced for the repository. - build_type: - type: string - description: The process by which the GitHub Pages site will be - built. `workflow` means that the site is built by a custom GitHub - Actions workflow. `legacy` means that the site is built by GitHub - when changes are pushed to a specific branch. - enum: - - legacy - - workflow - source: - anyOf: - - type: string - description: Update the source for the repository. Must include - the branch name, and may optionally specify the subdirectory - `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master - /docs"`. - enum: - - gh-pages - - master - - master /docs - - type: object - description: Update the source for the repository. Must include - the branch name and path. - properties: - branch: - type: string - description: The repository branch used to publish your site's - source files. - path: - type: string - description: The repository directory that includes the source - files for the Pages site. Allowed paths are `/` or `/docs`. - enum: - - "/" - - "/docs" - required: - - branch - - path - anyOf: - - required: - - build_type - - required: - - source - - required: - - cname - - required: - - public - - required: - - https_enforced - examples: - default: - value: - cname: octocatblog.com - source: - branch: main - path: "/" - responses: - '204': - description: Response - '422': *15 - '400': *14 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - delete: - summary: Delete a GitHub Pages site - description: |- - Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - - The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/delete-pages-site - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '422': *15 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/builds": - get: - summary: List GitHub Pages builds - description: |- - Lists builts of a GitHub Pages site. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/list-pages-builds - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &590 - title: Page Build - description: Page Build - type: object - properties: - url: - type: string - format: uri - status: - type: string - error: - type: object - properties: - message: - type: string - nullable: true - required: - - message - pusher: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - commit: - type: string - duration: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - url - - status - - error - - pusher - - commit - - duration - - created_at - - updated_at - examples: - default: - value: - - url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 - status: built - error: - message: - pusher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - commit: 351391cdcb88ffae71ec3028c91f375a8036a26b - duration: 2104 - created_at: '2014-02-10T19:00:49Z' - updated_at: '2014-02-10T19:00:51Z' - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - post: - summary: Request a GitHub Pages build - description: |- - You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - - Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - tags: - - repos - operationId: repos/request-pages-build - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build - parameters: - - *344 - - *345 - responses: - '201': - description: Response - content: - application/json: - schema: - title: Page Build Status - description: Page Build Status - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/github/hello-world/pages/builds/latest - status: - type: string - example: queued - required: - - url - - status - examples: - default: - value: - url: https://api.github.com/repos/github/developer.github.com/pages/builds/latest - status: queued - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/builds/latest": - get: - summary: Get latest Pages build - description: |- - Gets information about the single most recent build of a GitHub Pages site. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/get-latest-pages-build - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#get-latest-pages-build - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *590 - examples: - default: &591 - value: - url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 - status: built - error: - message: - pusher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - commit: 351391cdcb88ffae71ec3028c91f375a8036a26b - duration: 2104 - created_at: '2014-02-10T19:00:49Z' - updated_at: '2014-02-10T19:00:51Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/builds/{build_id}": - get: - summary: Get GitHub Pages build - description: |- - Gets information about a GitHub Pages build. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/get-pages-build - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build - parameters: - - *344 - - *345 - - name: build_id - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *590 - examples: - default: *591 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/deployments": - post: - summary: Create a GitHub Pages deployment - description: |- - Create a GitHub Pages deployment for a repository. - - The authenticated user must have write permission to the repository. - tags: - - repos - operationId: repos/create-pages-deployment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - description: The object used to create GitHub Pages deployment - properties: - artifact_id: - type: number - description: The ID of an artifact that contains the .zip or .tar - of static assets to deploy. The artifact belongs to the repository. - Either `artifact_id` or `artifact_url` are required. - artifact_url: - type: string - description: The URL of an artifact that contains the .zip or .tar - of static assets to deploy. The artifact belongs to the repository. - Either `artifact_id` or `artifact_url` are required. - environment: - type: string - description: The target environment for this GitHub Pages deployment. - default: github-pages - pages_build_version: - type: string - description: A unique string that represents the version of the - build for this deployment. - default: GITHUB_SHA - oidc_token: - type: string - description: The OIDC token issued by GitHub Actions certifying - the origin of the deployment. - required: - - pages_build_version - - oidc_token - examples: - default: - value: - artifact_url: https://downloadcontent/ - environment: github-pages - pages_build_version: 4fd754f7e594640989b406850d0bc8f06a121251 - oidc_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA - responses: - '200': - description: Response - content: - application/json: - schema: - title: GitHub Pages - description: The GitHub Pages deployment status. - type: object - properties: - id: - oneOf: - - type: integer - - type: string - description: The ID of the GitHub Pages deployment. This is the - Git SHA of the deployed commit. - status_url: - type: string - description: The URI to monitor GitHub Pages deployment status. - format: uri - example: https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 - page_url: - type: string - description: The URI to the deployed GitHub Pages. - format: uri - example: hello-world.github.io - preview_url: - type: string - description: The URI to the deployed GitHub Pages preview. - format: uri - example: monalisa-1231a2312sa32-23sda74.drafts.github.io - required: - - id - - status_url - - page_url - examples: - default: - value: - id: 4fd754f7e594640989b406850d0bc8f06a121251 - status_url: https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status - page_url: developer.github.com - '400': *14 - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": - get: - summary: Get the status of a GitHub Pages deployment - description: |- - Gets the current status of a GitHub Pages deployment. - - The authenticated user must have read permission for the GitHub Pages site. - tags: - - repos - operationId: repos/get-pages-deployment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment - parameters: - - *344 - - *345 - - &592 - name: pages_deployment_id - description: The ID of the Pages deployment. You can also give the commit - SHA of the deployment. - in: path - required: true - schema: - oneOf: - - type: integer - - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: GitHub Pages deployment status - type: object - properties: - status: - type: string - description: The current status of the deployment. - enum: - - deployment_in_progress - - syncing_files - - finished_file_sync - - updating_pages - - purging_cdn - - deployment_cancelled - - deployment_failed - - deployment_content_failed - - deployment_attempt_error - - deployment_lost - - succeed - examples: - default: - value: - status: succeed - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": - post: - summary: Cancel a GitHub Pages deployment - description: |- - Cancels a GitHub Pages deployment. - - The authenticated user must have write permissions for the GitHub Pages site. - tags: - - repos - operationId: repos/cancel-pages-deployment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment - parameters: - - *344 - - *345 - - *592 - responses: - '204': *191 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/pages/health": - get: - summary: Get a DNS health check for GitHub Pages - description: |- - Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. - - The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. - - The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - repos - operationId: repos/get-pages-health-check - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Pages Health Check Status - description: Pages Health Check Status - type: object - properties: - domain: - type: object - properties: - host: - type: string - uri: - type: string - nameservers: - type: string - dns_resolves: - type: boolean - is_proxied: - type: boolean - nullable: true - is_cloudflare_ip: - type: boolean - nullable: true - is_fastly_ip: - type: boolean - nullable: true - is_old_ip_address: - type: boolean - nullable: true - is_a_record: - type: boolean - nullable: true - has_cname_record: - type: boolean - nullable: true - has_mx_records_present: - type: boolean - nullable: true - is_valid_domain: - type: boolean - is_apex_domain: - type: boolean - should_be_a_record: - type: boolean - nullable: true - is_cname_to_github_user_domain: - type: boolean - nullable: true - is_cname_to_pages_dot_github_dot_com: - type: boolean - nullable: true - is_cname_to_fastly: - type: boolean - nullable: true - is_pointed_to_github_pages_ip: - type: boolean - nullable: true - is_non_github_pages_ip_present: - type: boolean - nullable: true - is_pages_domain: - type: boolean - is_served_by_pages: - type: boolean - nullable: true - is_valid: - type: boolean - reason: - type: string - nullable: true - responds_to_https: - type: boolean - enforces_https: - type: boolean - https_error: - type: string - nullable: true - is_https_eligible: - type: boolean - nullable: true - caa_error: - type: string - nullable: true - alt_domain: - type: object - nullable: true - properties: - host: - type: string - uri: - type: string - nameservers: - type: string - dns_resolves: - type: boolean - is_proxied: - type: boolean - nullable: true - is_cloudflare_ip: - type: boolean - nullable: true - is_fastly_ip: - type: boolean - nullable: true - is_old_ip_address: - type: boolean - nullable: true - is_a_record: - type: boolean - nullable: true - has_cname_record: - type: boolean - nullable: true - has_mx_records_present: - type: boolean - nullable: true - is_valid_domain: - type: boolean - is_apex_domain: - type: boolean - should_be_a_record: - type: boolean - nullable: true - is_cname_to_github_user_domain: - type: boolean - nullable: true - is_cname_to_pages_dot_github_dot_com: - type: boolean - nullable: true - is_cname_to_fastly: - type: boolean - nullable: true - is_pointed_to_github_pages_ip: - type: boolean - nullable: true - is_non_github_pages_ip_present: - type: boolean - nullable: true - is_pages_domain: - type: boolean - is_served_by_pages: - type: boolean - nullable: true - is_valid: - type: boolean - reason: - type: string - nullable: true - responds_to_https: - type: boolean - enforces_https: - type: boolean - https_error: - type: string - nullable: true - is_https_eligible: - type: boolean - nullable: true - caa_error: - type: string - nullable: true - examples: - default: - value: - domain: - host: example.com - uri: http://example.com/ - nameservers: default - dns_resolves: true - is_proxied: false - is_cloudflare_ip: false - is_fastly_ip: false - is_old_ip_address: false - is_a_record: true - has_cname_record: false - has_mx_records_present: false - is_valid_domain: true - is_apex_domain: true - should_be_a_record: true - is_cname_to_github_user_domain: false - is_cname_to_pages_dot_github_dot_com: false - is_cname_to_fastly: false - is_pointed_to_github_pages_ip: true - is_non_github_pages_ip_present: false - is_pages_domain: false - is_served_by_pages: true - is_valid: true - reason: - responds_to_https: true - enforces_https: true - https_error: - is_https_eligible: true - caa_error: - alt_domain: - host: www.example.com - uri: http://www.example.com/ - nameservers: default - dns_resolves: true - is_proxied: false - is_cloudflare_ip: false - is_fastly_ip: false - is_old_ip_address: false - is_a_record: true - has_cname_record: false - has_mx_records_present: false - is_valid_domain: true - is_apex_domain: true - should_be_a_record: true - is_cname_to_github_user_domain: false - is_cname_to_pages_dot_github_dot_com: false - is_cname_to_fastly: false - is_pointed_to_github_pages_ip: true - is_non_github_pages_ip_present: false - is_pages_domain: false - is_served_by_pages: true - is_valid: true - reason: - responds_to_https: true - enforces_https: true - https_error: - is_https_eligible: true - caa_error: - '202': - description: Empty response - content: - application/json: - schema: *169 - examples: - default: - value: - '400': - description: Custom domains are not available for GitHub Pages - '422': - description: There isn't a CNAME for this page - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pages - subcategory: pages - "/repos/{owner}/{repo}/private-vulnerability-reporting": - get: - summary: Check if private vulnerability reporting is enabled for a repository - description: Returns a boolean indicating whether or not private vulnerability - reporting is enabled for the repository. For more information, see "[Evaluating - the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". - tags: - - repos - operationId: repos/check-private-vulnerability-reporting - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Private vulnerability reporting status - content: - application/json: - schema: - type: object - properties: - enabled: - type: boolean - description: Whether or not private vulnerability reporting is - enabled for the repository. - required: - - enabled - examples: - default: - value: - enabled: true - '422': *14 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - put: - summary: Enable private vulnerability reporting for a repository - description: Enables private vulnerability reporting for a repository. The authenticated - user must have admin access to the repository. For more information, see "[Privately - reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." - tags: - - repos - operationId: repos/enable-private-vulnerability-reporting - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': *191 - '422': *14 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - delete: - summary: Disable private vulnerability reporting for a repository - description: Disables private vulnerability reporting for a repository. The - authenticated user must have admin access to the repository. For more information, - see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". - tags: - - repos - operationId: repos/disable-private-vulnerability-reporting - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': *191 - '422': *14 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/properties/values": - get: - summary: Get all custom property values for a repository - description: |- - Gets all custom property values that are set for a repository. - Users with read access to the repository can use this endpoint. - tags: - - repos - operationId: repos/custom-properties-for-repos-get-repository-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *295 - examples: - default: - value: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: custom-properties - patch: - summary: Create or update custom property values for a repository - description: |- - Create new or update existing custom property values for a repository. - Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - - Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. - tags: - - repos - operationId: repos/custom-properties-for-repos-create-or-update-repository-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - properties: - type: array - description: A list of custom property names and associated values - to apply to the repositories. - items: *295 - required: - - properties - examples: - default: - value: - properties: - - property_name: environment - value: production - - property_name: service - value: web - - property_name: team - value: octocat - responses: - '204': - description: No Content when custom property values are successfully created - or updated - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: custom-properties - "/repos/{owner}/{repo}/pulls": - get: - summary: List pull requests - description: |- - Lists pull requests in a specified repository. - - Draft pull requests are available in public repositories with GitHub - Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing - plans, and in public and private repositories with GitHub Team and GitHub Enterprise - Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) - in the GitHub Help documentation. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#list-pull-requests - parameters: - - *344 - - *345 - - name: state - description: Either `open`, `closed`, or `all` to filter by state. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - name: head - description: 'Filter pulls by head user or head organization and branch name - in the format of `user:ref-name` or `organization:ref-name`. For example: - `github:new-script-format` or `octocat:test-branch`.' - in: query - required: false - schema: - type: string - - name: base - description: 'Filter pulls by base branch name. Example: `gh-pages`.' - in: query - required: false - schema: - type: string - - name: sort - description: What to sort results by. `popularity` will sort by the number - of comments. `long-running` will sort by date created and will limit the - results to pull requests that have been open for more than a month and have - had activity within the past month. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - popularity - - long-running - default: created - - name: direction - description: 'The direction of the sort. Default: `desc` when sort is `created` - or sort is not specified, otherwise `asc`.' - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *482 - examples: - default: *593 - headers: - Link: *67 - '304': *37 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - post: - summary: Create a pull request - description: |- - Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/create - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The title of the new pull request. Required unless - `issue` is specified. - head: - type: string - description: 'The name of the branch where your changes are implemented. - For cross-repository pull requests in the same network, namespace - `head` with a user like this: `username:branch`.' - head_repo: - type: string - description: The name of the repository where the changes in the - pull request were made. This field is required for cross-repository - pull requests if both repositories are owned by the same organization. - format: repo.nwo - example: octo-org/octo-repo - base: - type: string - description: The name of the branch you want the changes pulled - into. This should be an existing branch on the current repository. - You cannot submit a pull request to one repository that requests - a merge to a base of another repository. - body: - type: string - description: The contents of the pull request. - maintainer_can_modify: - type: boolean - description: Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) - the pull request. - draft: - type: boolean - description: Indicates whether the pull request is a draft. See - "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" - in the GitHub Help documentation to learn more. - issue: - type: integer - format: int64 - example: 1 - description: An issue in the repository to convert to a pull request. - The issue title, body, and comments will become the title, body, - and comments on the new pull request. Required unless `title` - is specified. - required: - - head - - base - examples: - default: - value: - title: Amazing new feature - body: Please pull these awesome changes in! - head: octocat:new-feature - base: master - responses: - '201': - description: Response - content: - application/json: - schema: &597 - type: object - title: Pull Request - description: Pull requests let you tell others about changes you've - pushed to a repository on GitHub. Once a pull request is sent, interested - parties can review the set of changes, discuss potential modifications, - and even push follow-up commits if necessary. - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: - type: integer - format: int64 - example: 1 - node_id: - type: string - example: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347 - diff_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: - description: Number uniquely identifying the pull request within - its repository. - example: 42 - type: integer - state: - description: State of this Pull Request. Either `open` or `closed`. - enum: - - open - - closed - example: open - type: string - locked: - type: boolean - example: true - title: - description: The title of the pull request. - example: Amazing new feature - type: string - user: *4 - body: - type: string - example: Please pull these awesome changes - nullable: true - labels: - type: array - items: - type: object - properties: - id: - type: integer - format: int64 - node_id: - type: string - url: - type: string - name: - type: string - description: - type: string - nullable: true - color: - type: string - default: - type: boolean - required: - - id - - node_id - - url - - name - - description - - color - - default - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: *280 - required: *281 - nullable: true - active_lock_reason: - type: string - example: too heated - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - closed_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - merged_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - merge_commit_sha: - type: string - example: e5bd3914e2e596debea16f433f57875b5b90bcd6 - nullable: true - assignee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignees: - type: array - items: *4 - requested_reviewers: - type: array - items: *4 - requested_teams: - type: array - items: *333 - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: *79 - sha: - type: string - user: *4 - required: - - label - - ref - - repo - - sha - - user - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: *79 - sha: - type: string - user: *4 - required: - - label - - ref - - repo - - sha - - user - _links: - type: object - properties: - comments: *282 - commits: *282 - statuses: *282 - html: *282 - issue: *282 - review_comments: *282 - review_comment: *282 - self: *282 - required: - - comments - - commits - - statuses - - html - - issue - - review_comments - - review_comment - - self - author_association: *82 - auto_merge: *594 - draft: - description: Indicates whether or not the pull request is a draft. - example: false - type: boolean - merged: - type: boolean - mergeable: - type: boolean - example: true - nullable: true - rebaseable: - type: boolean - example: true - nullable: true - mergeable_state: - type: string - example: clean - merged_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - comments: - type: integer - example: 10 - review_comments: - type: integer - example: 0 - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - example: true - type: boolean - commits: - type: integer - example: 3 - additions: - type: integer - example: 100 - deletions: - type: integer - example: 3 - changed_files: - type: integer - example: 5 - required: - - _links - - assignee - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merge_commit_sha - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge - - additions - - changed_files - - comments - - commits - - deletions - - mergeable - - mergeable_state - - merged - - maintainer_can_modify - - merged_by - - review_comments - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - properties: - merge_commit_sha: - required: - - _links - - assignee - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge - - additions - - changed_files - - comments - - commits - - deletions - - mergeable - - mergeable_state - - merged - - maintainer_can_modify - - merged_by - - review_comments - version: '2026-03-10' - - changeset: remove_singular_assignee_from_issues_and_pull_requests - patch: - properties: - assignee: - required: - - _links - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge - - additions - - changed_files - - comments - - commits - - deletions - - mergeable - - mergeable_state - - merged - - maintainer_can_modify - - merged_by - - review_comments - version: '2026-03-10' - examples: - default: &598 - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: 1 - node_id: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: 1347 - state: open - locked: true - title: Amazing new feature - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Please pull these awesome changes in! - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - active_lock_reason: too heated - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:01:12Z' - closed_at: '2011-01-26T19:01:12Z' - merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - requested_reviewers: - - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - requested_teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - head: - label: octocat:new-topic - ref: new-topic - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - has_discussions: false - archived: false - disabled: false - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_merge_commit: true - allow_forking: true - forks: 123 - open_issues: 123 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - watchers: 123 - base: - label: octocat:master - ref: master - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - has_discussions: false - archived: false - disabled: false - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_merge_commit: true - forks: 123 - open_issues: 123 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - watchers: 123 - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html: - href: https://github.com/octocat/Hello-World/pull/1347 - issue: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347 - comments: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - review_comments: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - statuses: - href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: OWNER - auto_merge: - draft: false - merged: false - mergeable: true - rebaseable: true - mergeable_state: clean - merged_by: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - comments: 10 - review_comments: 0 - maintainer_can_modify: true - commits: 3 - additions: 100 - deletions: 3 - changed_files: 5 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - schema: - type: string - '403': *29 - '422': *15 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - "/repos/{owner}/{repo}/pulls/comments": - get: - summary: List review comments in a repository - description: |- - Lists review comments for all pull requests in a repository. By default, - review comments are in ascending order by ID. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list-review-comments-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository - parameters: - - *344 - - *345 - - name: sort - in: query - required: false - schema: - type: string - enum: - - created - - updated - - created_at - - name: direction - description: The direction to sort results. Ignored without `sort` parameter. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *595 - examples: - default: &600 - value: - - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - pull_request_review_id: 42 - id: 10 - node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - path: file1.txt - position: 1 - original_position: 4 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - in_reply_to_id: 8 - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Great stuff! - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: NONE - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - html: - href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1 - start_line: 1 - original_start_line: 1 - start_side: RIGHT - line: 2 - original_line: 2 - side: RIGHT - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: comments - "/repos/{owner}/{repo}/pulls/comments/{comment_id}": - get: - summary: Get a review comment for a pull request - description: |- - Provides details for a specified review comment. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/get-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request - parameters: - - *344 - - *345 - - *101 - responses: - '200': - description: Response - content: - application/json: - schema: *595 - examples: - default: &596 - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - pull_request_review_id: 42 - id: 10 - node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - path: file1.txt - position: 1 - original_position: 4 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - in_reply_to_id: 8 - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Great stuff! - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: NONE - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - html: - href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1 - start_line: 1 - original_start_line: 1 - start_side: RIGHT - line: 2 - original_line: 2 - side: RIGHT - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: comments - patch: - summary: Update a review comment for a pull request - description: |- - Edits the content of a specified review comment. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/update-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request - parameters: - - *344 - - *345 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The text of the reply to the review comment. - required: - - body - examples: - default: - value: - body: I like this too! - responses: - '200': - description: Response - content: - application/json: - schema: *595 - examples: - default: *596 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: comments - delete: - summary: Delete a review comment for a pull request - description: Deletes a review comment. - tags: - - pulls - operationId: pulls/delete-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request - parameters: - - *344 - - *345 - - *101 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: comments - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": - get: - summary: List reactions for a pull request review comment - description: List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - tags: - - reactions - operationId: reactions/list-for-pull-request-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment - parameters: - - *344 - - *345 - - *101 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a pull request review comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *476 - examples: - default: *549 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a pull request review comment - description: Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - A response with an HTTP `200` status means that you already added the reaction - type to this pull request review comment. - tags: - - reactions - operationId: reactions/create-for-pull-request-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment - parameters: - - *344 - - *345 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the pull request review comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Reaction exists - content: - application/json: - schema: *476 - examples: - default: *477 - '201': - description: Reaction created - content: - application/json: - schema: *476 - examples: - default: *477 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": - delete: - summary: Delete a pull request comment reaction - description: |- - > [!NOTE] - > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - - Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - tags: - - reactions - operationId: reactions/delete-for-pull-request-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction - parameters: - - *344 - - *345 - - *101 - - *550 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/pulls/{pull_number}": - get: - summary: Get a pull request - description: |- - Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - Lists details of a pull request by providing its number. - - When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - - The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - - The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - - * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - - Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - tags: - - pulls - operationId: pulls/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request - parameters: - - *344 - - *345 - - &599 - name: pull_number - description: The number that identifies the pull request. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) - to fetch diff and patch formats. - content: - application/json: - schema: *597 - examples: - default: *598 - '304': *37 - '404': *6 - '406': - description: Unacceptable - content: - application/json: - schema: *3 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - patch: - summary: Update a pull request - description: |- - Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The title of the pull request. - body: - type: string - description: The contents of the pull request. - state: - type: string - description: State of this Pull Request. Either `open` or `closed`. - enum: - - open - - closed - base: - type: string - description: The name of the branch you want your changes pulled - into. This should be an existing branch on the current repository. - You cannot update the base branch on a pull request to point to - another repository. - maintainer_can_modify: - type: boolean - description: Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) - the pull request. - examples: - default: - value: - title: new title - body: updated body - state: open - base: master - responses: - '200': - description: Response - content: - application/json: - schema: *597 - examples: - default: *598 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": - post: - summary: Create a codespace from a pull request - description: |- - Creates a codespace owned by the authenticated user for the specified pull request. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/create-with-pr-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: true - content: - application/json: - schema: - type: object - nullable: true - properties: - location: - description: The requested location for a new codespace. Best efforts - are made to respect this upon creation. Assigned by IP if not - provided. - type: string - geo: - description: The geographic area for this codespace. If not specified, - the value is assigned by IP. This property replaces `location`, - which is closing down. - type: string - enum: - - EuropeWest - - SoutheastAsia - - UsEast - - UsWest - client_ip: - description: IP for location auto-detection when proxying a request - type: string - machine: - description: Machine type to use for this codespace - type: string - devcontainer_path: - description: Path to devcontainer.json config to use for this codespace - type: string - multi_repo_permissions_opt_out: - description: Whether to authorize requested permissions from devcontainer.json - type: boolean - working_directory: - description: Working directory for this codespace - type: string - idle_timeout_minutes: - description: Time in minutes before codespace stops from inactivity - type: integer - display_name: - description: Display name for this codespace - type: string - retention_period_minutes: - description: Duration in minutes after codespace has gone idle in - which it will be deleted. Must be integer minutes between 0 and - 43200 (30 days). - type: integer - examples: - default: - value: - repository_id: 1 - ref: main - responses: - '201': - description: Response when the codespace was successfully created - content: - application/json: - schema: *248 - examples: - default: *465 - '202': - description: Response when the codespace creation partially failed but is - being retried in the background - content: - application/json: - schema: *248 - examples: - default: *465 - '401': *25 - '403': *29 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/repos/{owner}/{repo}/pulls/{pull_number}/comments": - get: - summary: List review comments on a pull request - description: |- - Lists all review comments for a specified pull request. By default, review comments - are in ascending order by ID. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list-review-comments - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *109 - - name: direction - description: The direction to sort results. Ignored without `sort` parameter. - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *595 - examples: - default: *600 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: comments - post: - summary: Create a review comment for a pull request - description: |- - Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." - - If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - - The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/create-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The text of the review comment. - commit_id: - type: string - description: The SHA of the commit needing a comment. Not using - the latest commit SHA may render your comment outdated if a subsequent - commit modifies the line you specify as the `position`. - path: - type: string - description: The relative path to the file that necessitates a comment. - position: - type: integer - description: '**This parameter is closing down. Use `line` instead**. - The position in the diff where you want to add a review comment. - Note this value is not the same as the line number in the file. - The position value equals the number of lines down from the first - "@@" hunk header in the file you want to add a comment. The line - just below the "@@" line is position 1, the next line is position - 2, and so on. The position in the diff continues to increase through - lines of whitespace and additional hunks until the beginning of - a new file.' - deprecated: true - x-github: - deprecationDate: '2022-11-01' - side: - type: string - description: In a split diff view, the side of the diff that the - pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use - `LEFT` for deletions that appear in red. Use `RIGHT` for additions - that appear in green or unchanged lines that appear in white and - are shown for context. For a multi-line comment, side represents - whether the last line of the comment range is a deletion or addition. - For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" - in the GitHub Help documentation. - enum: - - LEFT - - RIGHT - line: - type: integer - description: "**Required unless using `subject_type:file`**. The - line of the blob in the pull request diff that the comment applies - to. For a multi-line comment, the last line of the range that - your comment applies to." - start_line: - type: integer - description: '**Required when using multi-line comments unless using - `in_reply_to`**. The `start_line` is the first line in the pull - request diff that your multi-line comment applies to. To learn - more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" - in the GitHub Help documentation.' - start_side: - type: string - description: '**Required when using multi-line comments unless using - `in_reply_to`**. The `start_side` is the starting side of the - diff that the comment applies to. Can be `LEFT` or `RIGHT`. To - learn more about multi-line comments, see "[Commenting on a pull - request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" - in the GitHub Help documentation. See `side` in this table for - additional context.' - enum: - - LEFT - - RIGHT - - side - in_reply_to: - type: integer - example: 2 - description: The ID of the review comment to reply to. To find the - ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). - When specified, all parameters other than `body` in the request - body are ignored. - subject_type: - type: string - description: The level at which the comment is targeted. - enum: - - line - - file - required: - - body - - commit_id - - path - examples: - example-for-a-multi-line-comment: - summary: Example for a multi-line comment - value: - body: Great stuff! - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - path: file1.txt - start_line: 1 - start_side: RIGHT - line: 2 - side: RIGHT - responses: - '201': - description: Response - content: - application/json: - schema: *595 - examples: - example-for-a-multi-line-comment: - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - pull_request_review_id: 42 - id: 10 - node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - path: file1.txt - position: 1 - original_position: 4 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - in_reply_to_id: 8 - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Great stuff! - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: NONE - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - html: - href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1 - start_line: 1 - original_start_line: 1 - start_side: RIGHT - line: 2 - original_line: 2 - side: RIGHT - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - schema: - type: string - '422': *15 - '403': *29 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: comments - "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": - post: - summary: Create a reply for a review comment - description: |- - Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/create-reply-for-review-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment - parameters: - - *344 - - *345 - - *599 - - *101 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The text of the review comment. - required: - - body - examples: - default: - value: - body: Great stuff! - responses: - '201': - description: Response - content: - application/json: - schema: *595 - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - pull_request_review_id: 42 - id: 10 - node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - path: file1.txt - position: 1 - original_position: 4 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - in_reply_to_id: 426899381 - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Great stuff! - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: NONE - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - html: - href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1 - start_line: 1 - original_start_line: 1 - start_side: RIGHT - line: 2 - original_line: 2 - side: RIGHT - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - schema: - type: string - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: false - category: pulls - subcategory: comments - "/repos/{owner}/{repo}/pulls/{pull_number}/commits": - get: - summary: List commits on a pull request - description: |- - Lists a maximum of 250 commits for a pull request. To receive a complete - commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) - endpoint. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list-commits - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *478 - examples: - default: *601 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/files": - get: - summary: List pull requests files - description: |- - Lists the files in a specified pull request. - - > [!NOTE] - > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list-files - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files - parameters: - - *344 - - *345 - - *599 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *491 - examples: - default: - value: - - sha: bbcd538c8e72b8c175046e27cc8f907076331401 - filename: file1.txt - status: added - additions: 103 - deletions: 21 - changes: 124 - blob_url: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt - raw_url: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e - patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ - module Test" - headers: - Link: *67 - '422': *15 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/merge": - get: - summary: Check if a pull request has been merged - description: Checks if a pull request has been merged into the base branch. - The HTTP status of the response indicates whether or not the pull request - has been merged; the response body is empty. - tags: - - pulls - operationId: pulls/check-if-merged - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged - parameters: - - *344 - - *345 - - *599 - responses: - '204': - description: Response if pull request has been merged - '404': - description: Not Found if pull request has not been merged - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - put: - summary: Merge a pull request - description: |- - Merges a pull request into the base branch. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - pulls - operationId: pulls/merge - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - commit_title: - type: string - description: Title for the automatic commit message. - commit_message: - type: string - description: Extra detail to append to automatic commit message. - sha: - type: string - description: SHA that pull request head must match to allow merge. - merge_method: - type: string - description: The merge method to use. - enum: - - merge - - squash - - rebase - examples: - response-if-merge-was-successful: - value: - commit_title: Expand enum - commit_message: Add a new value to the merge_method enum - responses: - '200': - description: if merge was successful - content: - application/json: - schema: - title: Pull Request Merge Result - description: Pull Request Merge Result - type: object - properties: - sha: - type: string - merged: - type: boolean - message: - type: string - required: - - merged - - message - - sha - examples: - response-if-merge-was-successful: - value: - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - merged: true - message: Pull Request successfully merged - '405': - description: Method Not Allowed if merge cannot be performed - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-merge-cannot-be-performed: - value: - message: Pull Request is not mergeable - '409': - description: Conflict if sha was provided and pull request head did not - match - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-sha-was-provided-and-pull-request-head-did-not-match: - value: - message: Head branch was modified. Review and try the merge again. - '422': *15 - '403': *29 - '404': *6 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": - get: - summary: Get all requested reviewers for a pull request - description: Gets the users or teams whose review is requested for a pull request. - Once a requested reviewer submits a review, they are no longer considered - a requested reviewer. Their review will instead be returned by the [List reviews - for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) - operation. - tags: - - pulls - operationId: pulls/list-requested-reviewers - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Pull Request Review Request - description: Pull Request Review Request - type: object - properties: - users: - type: array - items: *4 - teams: - type: array - items: *197 - required: - - users - - teams - examples: - default: - value: - users: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: review-requests - post: - summary: Request reviewers for a pull request - description: |- - Requests reviews for a pull request from a given set of users and/or teams. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - pulls - operationId: pulls/request-reviewers - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - reviewers: - type: array - description: An array of user `login`s that will be requested. - items: - type: string - team_reviewers: - type: array - description: An array of team `slug`s that will be requested. - items: - type: string - anyOf: - - required: - - reviewers - - required: - - team_reviewers - examples: - default: - value: - reviewers: - - octocat - - hubot - - other_user - team_reviewers: - - justice-league - responses: - '201': - description: Response - content: - application/json: - schema: *482 - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: 1 - node_id: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: 1347 - state: open - locked: true - title: Amazing new feature - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Please pull these awesome changes in! - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - active_lock_reason: too heated - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:01:12Z' - closed_at: '2011-01-26T19:01:12Z' - merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - requested_reviewers: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - requested_teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - head: - label: octocat:new-topic - ref: new-topic - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - base: - label: octocat:master - ref: master - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html: - href: https://github.com/octocat/Hello-World/pull/1347 - issue: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347 - comments: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - review_comments: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - statuses: - href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: OWNER - auto_merge: - draft: false - '422': - description: Unprocessable Entity if user is not a collaborator - '403': *29 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: review-requests - delete: - summary: Remove requested reviewers from a pull request - description: Removes review requests from a pull request for a given set of - users and/or teams. - tags: - - pulls - operationId: pulls/remove-requested-reviewers - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - reviewers: - type: array - description: An array of user `login`s that will be removed. - items: - type: string - team_reviewers: - type: array - description: An array of team `slug`s that will be removed. - items: - type: string - required: - - reviewers - examples: - default: - value: - reviewers: - - octocat - - hubot - - other_user - team_reviewers: - - justice-league - responses: - '200': - description: Response - content: - application/json: - schema: *482 - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - id: 1 - node_id: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: 1347 - state: open - locked: true - title: Amazing new feature - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Please pull these awesome changes in! - labels: - - id: 208045946 - node_id: MDU6TGFiZWwyMDgwNDU5NDY= - url: https://api.github.com/repos/octocat/Hello-World/labels/bug - name: bug - description: Something isn't working - color: f29513 - default: true - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - active_lock_reason: too heated - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:01:12Z' - closed_at: '2011-01-26T19:01:12Z' - merged_at: '2011-01-26T19:01:12Z' - merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assignees: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - login: hubot - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/hubot_happy.gif - gravatar_id: '' - url: https://api.github.com/users/hubot - html_url: https://github.com/hubot - followers_url: https://api.github.com/users/hubot/followers - following_url: https://api.github.com/users/hubot/following{/other_user} - gists_url: https://api.github.com/users/hubot/gists{/gist_id} - starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/hubot/subscriptions - organizations_url: https://api.github.com/users/hubot/orgs - repos_url: https://api.github.com/users/hubot/repos - events_url: https://api.github.com/users/hubot/events{/privacy} - received_events_url: https://api.github.com/users/hubot/received_events - type: User - site_admin: true - requested_reviewers: - - login: other_user - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/other_user_happy.gif - gravatar_id: '' - url: https://api.github.com/users/other_user - html_url: https://github.com/other_user - followers_url: https://api.github.com/users/other_user/followers - following_url: https://api.github.com/users/other_user/following{/other_user} - gists_url: https://api.github.com/users/other_user/gists{/gist_id} - starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/other_user/subscriptions - organizations_url: https://api.github.com/users/other_user/orgs - repos_url: https://api.github.com/users/other_user/repos - events_url: https://api.github.com/users/other_user/events{/privacy} - received_events_url: https://api.github.com/users/other_user/received_events - type: User - site_admin: false - requested_teams: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - head: - label: octocat:new-topic - ref: new-topic - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - base: - label: octocat:master - ref: master - sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - html: - href: https://github.com/octocat/Hello-World/pull/1347 - issue: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347 - comments: - href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - review_comments: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - commits: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - statuses: - href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - author_association: OWNER - auto_merge: - draft: false - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: review-requests - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": - get: - summary: List reviews for a pull request - description: |- - Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list-reviews - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *17 - - *19 - responses: - '200': - description: The list of reviews returns in chronological order. - content: - application/json: - schema: - type: array - items: &602 - title: Pull Request Review - description: Pull Request Reviews are reviews on pull requests. - type: object - properties: - id: - description: Unique identifier of the review - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - body: - description: The text of the review. - example: This looks great. - type: string - state: - type: string - example: CHANGES_REQUESTED - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - type: object - properties: - html: - type: object - properties: - href: - type: string - required: - - href - pull_request: - type: object - properties: - href: - type: string - required: - - href - required: - - html - - pull_request - submitted_at: - type: string - format: date-time - commit_id: - description: A commit SHA for the review. If the commit object - was garbage collected or forcibly deleted, then it no longer - exists in Git and this value will be `null`. - example: 54bb654c9e6025347f57900a4a5c2313a96b8035 - type: string - nullable: true - body_html: - type: string - body_text: - type: string - author_association: *82 - required: - - id - - node_id - - user - - body - - state - - commit_id - - html_url - - pull_request_url - - _links - - author_association - examples: - default: - value: - - id: 80 - node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Here is the body for the review. - state: APPROVED - html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - html: - href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/12 - submitted_at: '2019-11-17T17:43:43Z' - commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 - author_association: COLLABORATOR - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - post: - summary: Create a review for a pull request - description: |- - Creates a review on a specified pull request. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - - > [!NOTE] - > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. - - The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/create-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - commit_id: - type: string - description: The SHA of the commit that needs a review. Not using - the latest commit SHA may render your review comment outdated - if a subsequent commit modifies the line you specify as the `position`. - Defaults to the most recent commit in the pull request when you - do not specify a value. - body: - type: string - description: "**Required** when using `REQUEST_CHANGES` or `COMMENT` - for the `event` parameter. The body text of the pull request review." - event: - type: string - description: 'The review action you want to perform. The review - actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By - leaving this blank, you set the review action state to `PENDING`, - which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) - when you are ready.' - enum: - - APPROVE - - REQUEST_CHANGES - - COMMENT - comments: - type: array - description: Use the following table to specify the location, destination, - and contents of the draft review comment. - items: - type: object - properties: - path: - type: string - description: The relative path to the file that necessitates - a review comment. - position: - type: integer - description: The position in the diff where you want to add - a review comment. Note this value is not the same as the - line number in the file. The `position` value equals the - number of lines down from the first "@@" hunk header in - the file you want to add a comment. The line just below - the "@@" line is position 1, the next line is position 2, - and so on. The position in the diff continues to increase - through lines of whitespace and additional hunks until the - beginning of a new file. - body: - type: string - description: Text of the review comment. - line: - type: integer - example: 28 - side: - type: string - example: RIGHT - start_line: - type: integer - example: 26 - start_side: - type: string - example: LEFT - required: - - path - - body - examples: - default: - value: - commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 - body: This is close to perfect! Please address the suggested inline - change. - event: REQUEST_CHANGES - comments: - - path: file.md - position: 6 - body: Please add more information here, and fix this typo. - responses: - '200': - description: Response - content: - application/json: - schema: *602 - examples: - default: &604 - value: - id: 80 - node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: This is close to perfect! Please address the suggested inline - change. - state: CHANGES_REQUESTED - html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - html: - href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/12 - submitted_at: '2019-11-17T17:43:43Z' - commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 - author_association: COLLABORATOR - '422': *7 - '403': *29 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": - get: - summary: Get a review for a pull request - description: |- - Retrieves a pull request review by its ID. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/get-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - - &603 - name: review_id - description: The unique identifier of the review. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *602 - examples: - default: &605 - value: - id: 80 - node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Here is the body for the review. - state: APPROVED - html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - html: - href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/12 - submitted_at: '2019-11-17T17:43:43Z' - commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 - author_association: COLLABORATOR - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - put: - summary: Update a review for a pull request - description: |- - Updates the contents of a specified review summary comment. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/update-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *603 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The body text of the pull request review. - required: - - body - examples: - default: - value: - body: This is close to perfect! Please address the suggested inline - change. And add more about this. - responses: - '200': - description: Response - content: - application/json: - schema: *602 - examples: - default: - value: - id: 80 - node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: This is close to perfect! Please address the suggested inline - change. And add more about this. - state: CHANGES_REQUESTED - html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - html: - href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/12 - submitted_at: '2019-11-17T17:43:43Z' - commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 - author_association: COLLABORATOR - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - delete: - summary: Delete a pending review for a pull request - description: |- - Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/delete-pending-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *603 - responses: - '200': - description: Response - content: - application/json: - schema: *602 - examples: - default: *604 - '422': *7 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": - get: - summary: List comments for a pull request review - description: |- - Lists comments for a specific pull request review. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/list-comments-for-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review - parameters: - - *344 - - *345 - - *599 - - *603 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Legacy Review Comment - description: Legacy Review Comment - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - pull_request_review_id: - type: integer - format: int64 - example: 42 - nullable: true - id: - type: integer - format: int64 - example: 10 - node_id: - type: string - example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: - type: string - example: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - path: - type: string - example: file1.txt - position: - type: integer - example: 1 - nullable: true - original_position: - type: integer - example: 4 - commit_id: - type: string - example: 6dcb09b5b57875f334f61aebed695e2e4193db5e - original_commit_id: - type: string - example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - in_reply_to_id: - type: integer - example: 8 - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - body: - type: string - example: Great stuff - created_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - updated_at: - type: string - format: date-time - example: '2011-04-14T16:00:49Z' - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *82 - _links: - type: object - properties: - self: *282 - html: *282 - pull_request: *282 - required: - - self - - html - - pull_request - body_text: - type: string - body_html: - type: string - reactions: *83 - side: - description: The side of the first line of the range for a multi-line - comment. - enum: - - LEFT - - RIGHT - default: RIGHT - type: string - start_side: - type: string - description: The side of the first line of the range for a multi-line - comment. - enum: - - LEFT - - RIGHT - default: RIGHT - nullable: true - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - example: 2 - type: integer - original_line: - description: The original line of the blob to which the comment - applies. The last line of the range for a multi-line comment - example: 2 - type: integer - start_line: - description: The first line of the range for a multi-line comment. - example: 2 - type: integer - nullable: true - original_start_line: - description: The original first line of the range for a multi-line - comment. - example: 2 - type: integer - nullable: true - subject_type: - description: The level at which the comment is targeted, can - be a diff line or a file. - type: string - enum: - - line - - file - required: - - id - - node_id - - url - - body - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - pull_request_review_id - - html_url - - pull_request_url - - _links - - author_association - - created_at - - updated_at - examples: - default: - value: - - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - pull_request_review_id: 42 - id: 10 - node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw - diff_hunk: "@@ -16,33 +16,40 @@ public class Connection : IConnection..." - path: file1.txt - position: 1 - original_position: 4 - commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e - original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 - in_reply_to_id: 8 - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Great stuff! - created_at: '2011-04-14T16:00:49Z' - updated_at: '2011-04-14T16:00:49Z' - html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: NONE - _links: - self: - href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 - html: - href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/1 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": - put: - summary: Dismiss a review for a pull request - description: |- - Dismisses a specified review on a pull request. - - > [!NOTE] - > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/dismiss-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *603 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: The message for the pull request review dismissal - event: - type: string - example: '"DISMISS"' - enum: - - DISMISS - required: - - message - examples: - default: - value: - message: You are dismissed - event: DISMISS - responses: - '200': - description: Response - content: - application/json: - schema: *602 - examples: - default: - value: - id: 80 - node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - body: Here is the body for the review. - state: DISMISSED - html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 - _links: - html: - href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 - pull_request: - href: https://api.github.com/repos/octocat/Hello-World/pulls/12 - submitted_at: '2019-11-17T17:43:43Z' - commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 - author_association: COLLABORATOR - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": - post: - summary: Submit a review for a pull request - description: |- - Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - pulls - operationId: pulls/submit-review - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request - parameters: - - *344 - - *345 - - *599 - - *603 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The body text of the pull request review - event: - type: string - description: 'The review action you want to perform. The review - actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When - you leave this blank, the API returns _HTTP 422 (Unrecognizable - entity)_ and sets the review action state to `PENDING`, which - means you will need to re-submit the pull request review using - a review action.' - enum: - - APPROVE - - REQUEST_CHANGES - - COMMENT - required: - - event - examples: - default: - value: - body: Here is the body for the review. - event: REQUEST_CHANGES - responses: - '200': - description: Response - content: - application/json: - schema: *602 - examples: - default: *605 - '404': *6 - '422': *7 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: reviews - "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": - put: - summary: Update a pull request branch - description: |- - Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. - tags: - - pulls - operationId: pulls/update-branch - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch - parameters: - - *344 - - *345 - - *599 - requestBody: - required: false - content: - application/json: - schema: - type: object - nullable: true - properties: - expected_head_sha: - type: string - description: 'The expected SHA of the pull request''s HEAD ref. - This is the most recent commit on the pull request''s branch. - If the expected SHA does not match the pull request''s HEAD, you - will receive a `422 Unprocessable Entity` status. You can use - the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" - endpoint to find the most recent commit SHA. Default: SHA of the - pull request''s current HEAD ref.' - examples: - default: - value: - expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e - responses: - '202': - description: Response - content: - application/json: - schema: - type: object - properties: - message: - type: string - url: - type: string - examples: - default: - value: - message: Updating pull request branch. - url: https://github.com/repos/octocat/Hello-World/pulls/53 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: pulls - subcategory: pulls - "/repos/{owner}/{repo}/readme": - get: - summary: Get a repository README - description: |- - Gets the preferred README for a repository. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - tags: - - repos - operationId: repos/get-readme - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#get-a-repository-readme - parameters: - - *344 - - *345 - - name: ref - description: 'The name of the commit/branch/tag. Default: the repository’s - default branch.' - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *606 - examples: - default: &607 - value: - type: file - encoding: base64 - size: 5362 - name: README.md - path: README.md - content: encoded content ... - sha: 3d21ec53a331a6f037a91c368710b99387d012c1 - url: https://api.github.com/repos/octokit/octokit.rb/contents/README.md - git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 - html_url: https://github.com/octokit/octokit.rb/blob/master/README.md - download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md - _links: - git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 - self: https://api.github.com/repos/octokit/octokit.rb/contents/README.md - html: https://github.com/octokit/octokit.rb/blob/master/README.md - '304': *37 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - "/repos/{owner}/{repo}/readme/{dir}": - get: - summary: Get a repository README for a directory - description: |- - Gets the README from a repository directory. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - tags: - - repos - operationId: repos/get-readme-in-directory - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory - parameters: - - *344 - - *345 - - name: dir - description: The alternate path to look for a README file - in: path - required: true - schema: - type: string - x-multi-segment: true - - name: ref - description: 'The name of the commit/branch/tag. Default: the repository’s - default branch.' - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *606 - examples: - default: *607 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - "/repos/{owner}/{repo}/releases": - get: - summary: List releases - description: |- - This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags). - - Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - tags: - - repos - operationId: repos/list-releases - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#list-releases - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *608 - examples: - default: - value: - - url: https://api.github.com/repos/octocat/Hello-World/releases/1 - html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 - assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets - upload_url: https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label} - tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0 - zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0 - id: 1 - node_id: MDc6UmVsZWFzZTE= - tag_name: v1.0.0 - target_commitish: master - name: v1.0.0 - body: Description of the release - draft: false - prerelease: false - immutable: false - created_at: '2013-02-27T19:35:32Z' - published_at: '2013-02-27T19:35:32Z' - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assets: - - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 - browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip - id: 1 - node_id: MDEyOlJlbGVhc2VBc3NldDE= - name: example.zip - label: short description - state: uploaded - content_type: application/zip - size: 1024 - digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 - download_count: 42 - created_at: '2013-02-27T19:35:32Z' - updated_at: '2013-02-27T19:35:32Z' - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - post: - summary: Create a release - description: |- - Users with push access to the repository can create a release. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - repos - operationId: repos/create-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#create-a-release - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tag_name: - type: string - description: The name of the tag. - target_commitish: - type: string - description: 'Specifies the commitish value that determines where - the Git tag is created from. Can be any branch or commit SHA. - Unused if the Git tag already exists. Default: the repository''s - default branch.' - name: - type: string - description: The name of the release. - body: - type: string - description: Text describing the contents of the tag. - draft: - type: boolean - description: "`true` to create a draft (unpublished) release, `false` - to create a published one." - default: false - prerelease: - type: boolean - description: "`true` to identify the release as a prerelease. `false` - to identify the release as a full release." - default: false - discussion_category_name: - type: string - description: If specified, a discussion of the specified category - is created and linked to the release. The value must be a category - that already exists in the repository. For more information, see - "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." - generate_release_notes: - type: boolean - description: Whether to automatically generate the name and body - for this release. If `name` is specified, the specified name will - be used; otherwise, a name will be automatically generated. If - `body` is specified, the body will be pre-pended to the automatically - generated notes. - default: false - make_latest: - type: string - description: Specifies whether this release should be set as the - latest release for the repository. Drafts and prereleases cannot - be set as latest. Defaults to `true` for newly published releases. - `legacy` specifies that the latest release should be determined - based on the release creation date and higher semantic version. - enum: - - 'true' - - 'false' - - legacy - default: 'true' - required: - - tag_name - examples: - default: - value: - tag_name: v1.0.0 - target_commitish: master - name: v1.0.0 - body: Description of the release - draft: false - prerelease: false - generate_release_notes: false - responses: - '201': - description: Response - content: - application/json: - schema: *608 - examples: - default: &612 - value: - url: https://api.github.com/repos/octocat/Hello-World/releases/1 - html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 - assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets - upload_url: https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label} - tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0 - zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0 - discussion_url: https://github.com/octocat/Hello-World/discussions/90 - id: 1 - node_id: MDc6UmVsZWFzZTE= - tag_name: v1.0.0 - target_commitish: master - name: v1.0.0 - body: Description of the release - draft: false - prerelease: false - immutable: false - created_at: '2013-02-27T19:35:32Z' - published_at: '2013-02-27T19:35:32Z' - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assets: - - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 - browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip - id: 1 - node_id: MDEyOlJlbGVhc2VBc3NldDE= - name: example.zip - label: short description - state: uploaded - content_type: application/zip - size: 1024 - digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 - download_count: 42 - created_at: '2013-02-27T19:35:32Z' - updated_at: '2013-02-27T19:35:32Z' - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/releases/1 - schema: - type: string - '404': - description: Not Found if the discussion category name is invalid - content: - application/json: - schema: *3 - '422': *15 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - "/repos/{owner}/{repo}/releases/assets/{asset_id}": - get: - summary: Get a release asset - description: "To download the asset's binary content:\n\n- If within a browser, - fetch the location specified in the `browser_download_url` key provided in - the response.\n- Alternatively, set the `Accept` header of the request to - \n [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - \n The API will either redirect the client to the location, or stream it - directly if possible.\n API clients should handle both a `200` or `302` response." - tags: - - repos - operationId: repos/get-release-asset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/assets#get-a-release-asset - parameters: - - *344 - - *345 - - &610 - name: asset_id - description: The unique identifier of the asset. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *609 - examples: - default: &611 - value: - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 - browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip - id: 1 - node_id: MDEyOlJlbGVhc2VBc3NldDE= - name: example.zip - label: short description - state: uploaded - content_type: application/zip - size: 1024 - digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 - download_count: 42 - created_at: '2013-02-27T19:35:32Z' - updated_at: '2013-02-27T19:35:32Z' - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': *6 - '302': *495 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: assets - patch: - summary: Update a release asset - description: Users with push access to the repository can edit a release asset. - tags: - - repos - operationId: repos/update-release-asset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/assets#update-a-release-asset - parameters: - - *344 - - *345 - - *610 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The file name of the asset. - label: - type: string - description: An alternate short description of the asset. Used in - place of the filename. - state: - type: string - example: '"uploaded"' - examples: - default: - value: - name: foo-1.0.0-osx.zip - label: Mac binary - responses: - '200': - description: Response - content: - application/json: - schema: *609 - examples: - default: *611 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: assets - delete: - summary: Delete a release asset - description: '' - tags: - - repos - operationId: repos/delete-release-asset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/assets#delete-a-release-asset - parameters: - - *344 - - *345 - - *610 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: assets - "/repos/{owner}/{repo}/releases/generate-notes": - post: - summary: Generate release notes content for a release - description: Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). - The body content will be markdown formatted and contain information like the - changes since last release and users who contributed. The generated release - notes are not saved anywhere. They are intended to be generated and used when - creating a new release. - tags: - - repos - operationId: repos/generate-release-notes - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - tag_name: - type: string - description: The tag name for the release. This can be an existing - tag or a new one. - target_commitish: - type: string - description: Specifies the commitish value that will be the target - for the release's tag. Required if the supplied tag_name does - not reference an existing tag. Ignored if the tag_name already - exists. - previous_tag_name: - type: string - description: The name of the previous tag to use as the starting - point for the release notes. Use to manually specify the range - for the set of changes considered as part this release. - configuration_file_path: - type: string - description: Specifies a path to a file in the repository containing - configuration settings used for generating the release notes. - If unspecified, the configuration file located in the repository - at '.github/release.yml' or '.github/release.yaml' will be used. - If that is not present, the default configuration will be used. - required: - - tag_name - examples: - default: - value: - tag_name: v1.0.0 - target_commitish: main - previous_tag_name: v0.9.2 - configuration_file_path: ".github/custom_release_config.yml" - responses: - '200': - description: Name and body of generated release notes - content: - application/json: - schema: - title: Generated Release Notes Content - description: Generated name and body describing a release - type: object - properties: - name: - description: The generated name of the release - type: string - example: Release v1.0.0 is now available! - body: - description: The generated body describing the contents of the - release supporting markdown formatting - type: string - required: - - name - - body - examples: - default: - value: - name: Release v1.0.0 is now available! - body: "##Changes in Release v1.0.0 ... ##Contributors @monalisa" - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - "/repos/{owner}/{repo}/releases/latest": - get: - summary: Get the latest release - description: |- - View the latest published full release for the repository. - - The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - tags: - - repos - operationId: repos/get-latest-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#get-the-latest-release - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: *608 - examples: - default: *612 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - "/repos/{owner}/{repo}/releases/tags/{tag}": - get: - summary: Get a release by tag name - description: Get a published release with the specified tag. - tags: - - repos - operationId: repos/get-release-by-tag - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name - parameters: - - *344 - - *345 - - name: tag - description: tag parameter - in: path - required: true - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - content: - application/json: - schema: *608 - examples: - default: *612 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - "/repos/{owner}/{repo}/releases/{release_id}": - get: - summary: Get a release - description: |- - Gets a public release with the specified release ID. - - > [!NOTE] - > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - tags: - - repos - operationId: repos/get-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#get-a-release - parameters: - - *344 - - *345 - - &613 - name: release_id - description: The unique identifier of the release. - in: path - required: true - schema: - type: integer - responses: - '200': - description: '**Note:** This returns an `upload_url` key corresponding to - the endpoint for uploading release assets. This key is a hypermedia resource. - For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' - content: - application/json: - schema: *608 - examples: - default: *612 - '401': - description: Unauthorized - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - patch: - summary: Update a release - description: Users with push access to the repository can edit a release. - tags: - - repos - operationId: repos/update-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#update-a-release - parameters: - - *344 - - *345 - - *613 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - tag_name: - type: string - description: The name of the tag. - target_commitish: - type: string - description: 'Specifies the commitish value that determines where - the Git tag is created from. Can be any branch or commit SHA. - Unused if the Git tag already exists. Default: the repository''s - default branch.' - name: - type: string - description: The name of the release. - body: - type: string - description: Text describing the contents of the tag. - draft: - type: boolean - description: "`true` makes the release a draft, and `false` publishes - the release." - prerelease: - type: boolean - description: "`true` to identify the release as a prerelease, `false` - to identify the release as a full release." - make_latest: - type: string - description: Specifies whether this release should be set as the - latest release for the repository. Drafts and prereleases cannot - be set as latest. Defaults to `true` for newly published releases. - `legacy` specifies that the latest release should be determined - based on the release creation date and higher semantic version. - enum: - - 'true' - - 'false' - - legacy - default: 'true' - discussion_category_name: - type: string - description: If specified, a discussion of the specified category - is created and linked to the release. The value must be a category - that already exists in the repository. If there is already a discussion - linked to the release, this parameter is ignored. For more information, - see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." - examples: - default: - value: - tag_name: v1.0.0 - target_commitish: master - name: v1.0.0 - body: Description of the release - draft: false - prerelease: false - responses: - '200': - description: Response - content: - application/json: - schema: *608 - examples: - default: *612 - '404': - description: Not Found if the discussion category name is invalid - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - delete: - summary: Delete a release - description: Users with push access to the repository can delete a release. - tags: - - repos - operationId: repos/delete-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/releases#delete-a-release - parameters: - - *344 - - *345 - - *613 - responses: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: releases - "/repos/{owner}/{repo}/releases/{release_id}/assets": - get: - summary: List release assets - description: '' - tags: - - repos - operationId: repos/list-release-assets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/assets#list-release-assets - parameters: - - *344 - - *345 - - *613 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *609 - examples: - default: - value: - - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 - browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip - id: 1 - node_id: MDEyOlJlbGVhc2VBc3NldDE= - name: example.zip - label: short description - state: uploaded - content_type: application/zip - size: 1024 - digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 - download_count: 42 - created_at: '2013-02-27T19:35:32Z' - updated_at: '2013-02-27T19:35:32Z' - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: assets - post: - summary: Upload a release asset - description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) - to determine which URL to access. The endpoint you call to upload release - assets is specific to your release. Use the `upload_url` returned in\nthe - response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) - to upload a release asset.\n\nYou need to use an HTTP client which supports - [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to - this endpoint.\n\nMost libraries will set the required `Content-Length` header - automatically. Use the required `Content-Type` header to provide the media - type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). - For example: \n\n`application/zip`\n\nGitHub expects the asset data in its - raw binary form, rather than JSON. You will send the raw binary content of - the asset as the request body. Everything else about the endpoint is the same - as the rest of the API. For example,\nyou'll still need to pass your authentication - to be able to upload an asset.\n\nWhen an upstream failure occurs, you will - receive a `502 Bad Gateway` status. This may leave an empty asset with a state - of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames - asset filenames that have special characters, non-alphanumeric characters, - and leading or trailing periods. The \"[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint - lists the renamed filenames. For more information and help, contact [GitHub - Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To - find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` - endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). - \n* If you upload an asset with the same filename as another uploaded asset, - you'll receive an error and must delete the old file before you can re-upload - the new asset." - tags: - - repos - operationId: repos/upload-release-asset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/releases/assets#upload-a-release-asset - servers: - - url: https://uploads.github.com - description: The URL origin (protocol + host name + port) is included in `upload_url` - returned in the response of the "Create a release" endpoint - parameters: - - *344 - - *345 - - *613 - - name: name - in: query - required: true - schema: - type: string - - name: label - in: query - schema: - type: string - requestBody: - required: false - content: - application/octet-stream: - schema: - type: string - format: binary - description: The raw file data - examples: - default: - value: "@example.zip" - responses: - '201': - description: Response for successful upload - content: - application/json: - schema: *609 - examples: - response-for-successful-upload: - value: - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 - browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip - id: 1 - node_id: MDEyOlJlbGVhc2VBc3NldDE= - name: example.zip - label: short description - state: uploaded - content_type: application/zip - size: 1024 - digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 - download_count: 42 - created_at: '2013-02-27T19:35:32Z' - updated_at: '2013-02-27T19:35:32Z' - uploader: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '422': - description: Response if you upload an asset with the same filename as another - uploaded asset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: releases - subcategory: assets - "/repos/{owner}/{repo}/releases/{release_id}/reactions": - get: - summary: List reactions for a release - description: List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). - tags: - - reactions - operationId: reactions/list-for-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release - parameters: - - *344 - - *345 - - *613 - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a release. - in: query - required: false - schema: - type: string - enum: - - "+1" - - laugh - - heart - - hooray - - rocket - - eyes - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *476 - examples: - default: *549 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a release - description: 'Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). - A response with a `Status: 200 OK` means that you already added the reaction - type to this release.' - tags: - - reactions - operationId: reactions/create-for-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release - parameters: - - *344 - - *345 - - *613 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the release. - enum: - - "+1" - - laugh - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Reaction exists - content: - application/json: - schema: *476 - examples: - default: *477 - '201': - description: Reaction created - content: - application/json: - schema: *476 - examples: - default: *477 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": - delete: - summary: Delete a release reaction - description: |- - > [!NOTE] - > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - - Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). - tags: - - reactions - operationId: reactions/delete-for-release - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction - parameters: - - *344 - - *345 - - *613 - - *550 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/repos/{owner}/{repo}/rules/branches/{branch}": - get: - summary: Get rules for a branch - description: |- - Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - enforcement statuses are not returned. - tags: - - repos - operationId: repos/get-branch-rules - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch - parameters: - - *344 - - *345 - - *411 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Repository Rule - type: object - description: A repository rule with ruleset details. - oneOf: - - allOf: - - *305 - - &614 - title: repository ruleset data for rule - description: User-defined metadata to store domain-specific - information limited to 8 keys with scalar values. - properties: - ruleset_source_type: - type: string - description: The type of source for the ruleset that includes - this rule. - enum: - - Repository - - Organization - ruleset_source: - type: string - description: The name of the source of the ruleset that - includes this rule. - ruleset_id: - type: integer - description: The ID of the ruleset that includes this rule. - - allOf: - - *306 - - *614 - - allOf: - - *307 - - *614 - - allOf: - - *308 - - *614 - - allOf: - - *615 - - *614 - - allOf: - - *309 - - *614 - - allOf: - - *310 - - *614 - - allOf: - - *311 - - *614 - - allOf: - - *312 - - *614 - - allOf: - - *313 - - *614 - - allOf: - - *314 - - *614 - - allOf: - - *315 - - *614 - - allOf: - - *316 - - *614 - - allOf: - - *317 - - *614 - - allOf: - - *318 - - *614 - - allOf: - - *319 - - *614 - - allOf: - - *320 - - *614 - - allOf: - - *321 - - *614 - - allOf: - - *322 - - *614 - - allOf: - - *323 - - *614 - - allOf: - - *324 - - *614 - - allOf: - - *325 - - *614 - examples: - default: - value: - - type: commit_message_pattern - ruleset_source_type: Repository - ruleset_source: monalisa/my-repo - ruleset_id: 42 - parameters: - operator: starts_with - pattern: issue - - type: commit_author_email_pattern - ruleset_source_type: Organization - ruleset_source: my-org - ruleset_id: 73 - parameters: - operator: contains - pattern: github - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - "/repos/{owner}/{repo}/rulesets": - get: - summary: Get all repository rulesets - description: Get all the rulesets for a repository. - tags: - - repos - operationId: repos/get-repo-rulesets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#get-all-repository-rulesets - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - parameters: - - *344 - - *345 - - *17 - - *19 - - name: includes_parents - description: Include rulesets configured at higher levels that apply to this - repository - in: query - required: false - schema: - type: boolean - default: true - - *616 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *326 - examples: - default: - value: - - id: 42 - name: super cool ruleset - source_type: Repository - source: monalisa/my-repo - enforcement: enabled - node_id: RRS_lACkVXNlcgQB - _links: - self: - href: https://api.github.com/repos/monalisa/my-repo/rulesets/42 - html: - href: https://github.com/monalisa/my-repo/rules/42 - created_at: '2023-07-15T08:43:03Z' - updated_at: '2023-08-23T16:29:47Z' - - id: 314 - name: Another ruleset - source_type: Repository - source: monalisa/my-repo - enforcement: enabled - node_id: RRS_lACkVXNlcgQQ - _links: - self: - href: https://api.github.com/repos/monalisa/my-repo/rulesets/314 - html: - href: https://github.com/monalisa/my-repo/rules/314 - created_at: '2023-08-15T08:43:03Z' - updated_at: '2023-09-23T16:29:47Z' - '404': *6 - '500': *55 - post: - summary: Create a repository ruleset - description: Create a ruleset for a repository. - tags: - - repos - operationId: repos/create-repo-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#create-a-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - parameters: - - *344 - - *345 - requestBody: - description: Request body - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the ruleset. - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - default: branch - enforcement: *302 - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *300 - rules: - type: array - description: An array of rules within the ruleset. - items: *617 - required: - - name - - enforcement - examples: - default: - value: - name: super cool ruleset - target: branch - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - responses: - '201': - description: Response - content: - application/json: - schema: *326 - examples: - default: &627 - value: - id: 42 - name: super cool ruleset - target: branch - source_type: Repository - source: monalisa/my-repo - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - node_id: RRS_lACkVXNlcgQB - _links: - self: - href: https://api.github.com/repos/monalisa/my-repo/rulesets/42 - html: - href: https://github.com/monalisa/my-repo/rules/42 - created_at: '2023-07-15T08:43:03Z' - updated_at: '2023-08-23T16:29:47Z' - '404': *6 - '422': *15 - '500': *55 - "/repos/{owner}/{repo}/rulesets/rule-suites": - get: - summary: List repository rule suites - description: |- - Lists suites of rule evaluations at the repository level. - For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." - tags: - - repos - operationId: repos/get-repo-rule-suites - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites - parameters: - - *344 - - *345 - - *618 - - *619 - - *620 - - *621 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: *622 - examples: - default: *623 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rule-suites - "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": - get: - summary: Get a repository rule suite - description: |- - Gets information about a suite of rule evaluations from within a repository. - For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." - tags: - - repos - operationId: repos/get-repo-rule-suite - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite - parameters: - - *344 - - *345 - - *624 - responses: - '200': - description: Response - content: - application/json: - schema: *625 - examples: - default: *626 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rule-suites - "/repos/{owner}/{repo}/rulesets/{ruleset_id}": - get: - summary: Get a repository ruleset - description: |- - Get a ruleset for a repository. - - **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user - making the API request has write access to the ruleset. - tags: - - repos - operationId: repos/get-repo-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#get-a-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - parameters: - - *344 - - *345 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - - name: includes_parents - description: Include rulesets configured at higher levels that apply to this - repository - in: query - required: false - schema: - type: boolean - default: true - responses: - '200': - description: Response - content: - application/json: - schema: *326 - examples: - default: *627 - '404': *6 - '500': *55 - put: - summary: Update a repository ruleset - description: Update a ruleset for a repository. - tags: - - repos - operationId: repos/update-repo-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#update-a-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - parameters: - - *344 - - *345 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - requestBody: - description: Request body - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the ruleset. - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - enforcement: *302 - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: *303 - conditions: *300 - rules: - description: An array of rules within the ruleset. - type: array - items: *617 - examples: - default: - value: - name: super cool ruleset - target: branch - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - responses: - '200': - description: Response - content: - application/json: - schema: *326 - examples: - default: *627 - '404': *6 - '422': *15 - '500': *55 - delete: - summary: Delete a repository ruleset - description: Delete a ruleset for a repository. - tags: - - repos - operationId: repos/delete-repo-ruleset - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - parameters: - - *344 - - *345 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - responses: - '204': - description: Response - '404': *6 - '500': *55 - "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": - get: - summary: Get repository ruleset history - description: Get the history of a repository ruleset. - tags: - - repos - operationId: repos/get-repo-ruleset-history - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history - parameters: - - *344 - - *345 - - *17 - - *19 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *329 - examples: - default: *628 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": - get: - summary: Get repository ruleset version - description: Get a version of a repository ruleset. - tags: - - repos - operationId: repos/get-repo-ruleset-version - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version - parameters: - - *344 - - *345 - - name: ruleset_id - description: The ID of the ruleset. - in: path - required: true - schema: - type: integer - - name: version_id - description: The ID of the version - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *629 - examples: - default: - value: - version_id: 3 - actor: - id: 1 - type: User - updated_at: '2024-10-23T16:29:47Z' - state: - id: 42 - name: super cool ruleset - target: branch - source_type: Repository - source: monalisa/my-repo - enforcement: active - bypass_actors: - - actor_id: 234 - actor_type: Team - bypass_mode: always - conditions: - ref_name: - include: - - refs/heads/main - - refs/heads/master - exclude: - - refs/heads/dev* - rules: - - type: commit_author_email_pattern - parameters: - operator: contains - pattern: github - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: rules - "/repos/{owner}/{repo}/secret-scanning/alerts": - get: - summary: List secret scanning alerts for a repository - description: |- - Lists secret scanning alerts for an eligible repository, from newest to oldest. - - The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository - parameters: - - *344 - - *345 - - *630 - - *631 - - *632 - - *633 - - *634 - - *635 - - *636 - - *637 - - *61 - - *19 - - *17 - - *638 - - *639 - - *640 - - *641 - - *642 - - *643 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &647 - type: object - properties: - number: *178 - created_at: *179 - updated_at: - type: string - description: 'The time that the alert was last updated in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - url: *181 - html_url: *182 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - state: *644 - resolution: *645 - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - resolution_comment: - type: string - description: An optional comment to resolve an alert. - nullable: true - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - provider: - type: string - description: The provider of the secret that was detected. - nullable: true - provider_slug: - type: string - description: The slug identifier for the provider of the secret - that was detected. Use this value for filtering by provider - with the `providers` or `exclude_providers` parameters. - nullable: true - secret: - type: string - description: The secret that was detected. - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected - secret. - nullable: true - push_protection_bypassed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection - bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection - bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: boolean - description: Whether the detected secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple - repositories under the same organization or enterprise. - nullable: true - is_base64_encoded: - type: boolean - description: A boolean value representing whether or not alert - is base64 encoded - nullable: true - first_location_detected: - description: 'Details on the location where the token was initially - detected. This can be a commit, wiki commit, issue, discussion, - pull request. - - ' - oneOf: *646 - nullable: true - has_more_locations: - type: boolean - description: A boolean value representing whether or not the - token in the alert was detected in more than one location. - assigned_to: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - closure_request_comment: - type: string - description: An optional comment from the closure request author. - nullable: true - closure_request_reviewer_comment: - type: string - description: An optional comment from the closure request reviewer. - nullable: true - closure_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - examples: - default: - value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - resolution_comment: Example comment - validity: inactive - publicly_leaked: false - multi_repo: false - is_base64_encoded: false - first_location_detected: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - has_more_locations: true - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '404': - description: Repository is public or secret scanning is disabled for the - repository - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: secret-scanning - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": - get: - summary: Get a secret scanning alert - description: |- - Gets a single secret scanning alert detected in an eligible repository. - - The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - secret-scanning - operationId: secret-scanning/get-alert - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert - parameters: - - *344 - - *345 - - *442 - - *643 - responses: - '200': - description: Response - content: - application/json: - schema: *647 - examples: - default: - value: - number: 42 - created_at: '2020-11-06T18:18:30Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 - html_url: https://github.com/owner/private-repo/security/secret-scanning/42 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations - state: open - resolution: - resolved_at: - resolved_by: - secret_type: mailchimp_api_key - secret_type_display_name: Mailchimp API Key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - push_protection_bypassed_by: - push_protection_bypassed: false - push_protection_bypassed_at: - push_protection_bypass_request_reviewer: - push_protection_bypass_request_reviewer_comment: - push_protection_bypass_request_comment: - push_protection_bypass_request_html_url: - resolution_comment: - validity: unknown - publicly_leaked: false - multi_repo: false - '304': *37 - '404': - description: Repository is public, or secret scanning is disabled for the - repository, or the resource is not found - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: secret-scanning - patch: - summary: Update a secret scanning alert - description: |- - Updates the status of a secret scanning alert in an eligible repository. - - You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. - - The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - operationId: secret-scanning/update-alert - tags: - - secret-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert - parameters: - - *344 - - *345 - - *442 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - state: *644 - resolution: *645 - resolution_comment: - description: An optional comment when closing or reopening an alert. - Cannot be updated or deleted. - type: string - nullable: true - assignee: - description: The username of the user to assign to the alert. Set - to `null` to unassign the alert. - type: string - nullable: true - anyOf: - - required: - - state - - required: - - assignee - - required: - - validity - examples: - default: - value: - state: resolved - resolution: false_positive - assign: - summary: Assign alert to a user - value: - assignee: octocat - unassign: - summary: Unassign alert - value: - assignee: - responses: - '200': - description: Response - content: - application/json: - schema: *647 - examples: - default: - value: - number: 42 - created_at: '2020-11-06T18:18:30Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 - html_url: https://github.com/owner/private-repo/security/secret-scanning/42 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations - state: resolved - resolution: used_in_tests - resolved_at: '2020-11-16T22:42:07Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: mailchimp_api_key - secret_type_display_name: Mailchimp API Key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - push_protection_bypassed: false - push_protection_bypassed_by: - push_protection_bypassed_at: - push_protection_bypass_request_reviewer: - push_protection_bypass_request_reviewer_comment: - push_protection_bypass_request_comment: - push_protection_bypass_request_html_url: - resolution_comment: Example comment - validity: unknown - publicly_leaked: false - multi_repo: false - assigned_to: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://alambic.github.com/avatars/u/1? - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '400': - description: Bad request, resolution comment is invalid or the resolution - was not changed. - '404': - description: Repository is public, or secret scanning is disabled for the - repository, or the resource is not found - '422': - description: State does not match the resolution or resolution comment, - or assignee does not have write access to the repository - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: secret-scanning - subcategory: secret-scanning - "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": - get: - summary: List locations for a secret scanning alert - description: |- - Lists all locations for a given secret scanning alert for an eligible repository. - - The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - secret-scanning - operationId: secret-scanning/list-locations-for-alert - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert - parameters: - - *344 - - *345 - - *442 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: List of locations where the secret was detected - items: &806 - type: object - properties: - type: - type: string - enum: - - commit - - wiki_commit - - issue_title - - issue_body - - issue_comment - - discussion_title - - discussion_body - - discussion_comment - - pull_request_title - - pull_request_body - - pull_request_comment - - pull_request_review - - pull_request_review_comment - description: The location type. Because secrets may be found - in different types of resources (ie. code, comments, issues, - pull requests, discussions), this field identifies the type - of resource where the secret was found. - example: commit - details: - oneOf: - - *648 - - *649 - - *650 - - *651 - - *652 - - *653 - - *654 - - *655 - - *656 - - *657 - - *658 - - *659 - - *660 - examples: - default: - value: - - type: commit - details: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - - type: wiki_commit - details: - path: "/example/Home.md" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - - type: issue_title - details: - issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - - type: issue_body - details: - issue_body_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 - - type: issue_comment - details: - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - - type: discussion_title - details: - discussion_title_url: https://github.com/community/community/discussions/39082 - - type: discussion_body - details: - discussion_body_url: https://github.com/community/community/discussions/39082#discussion-4566270 - - type: discussion_comment - details: - discussion_comment_url: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - - type: pull_request_title - details: - pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - - type: pull_request_body - details: - pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - - type: pull_request_comment - details: - pull_request_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898 - - type: pull_request_review - details: - pull_request_review_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - - type: pull_request_review_comment - details: - pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - headers: - Link: *67 - '404': - description: Repository is public, or secret scanning is disabled for the - repository, or the resource is not found - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: secret-scanning - "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": - post: - summary: Create a push protection bypass - description: |- - Creates a bypass for a previously push protected secret. - - The authenticated user must be the original author of the committed secret. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: secret-scanning/create-push-protection-bypass - tags: - - secret-scanning - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - reason: &662 - description: The reason for bypassing push protection. - type: string - enum: - - false_positive - - used_in_tests - - will_fix_later - placeholder_id: *661 - required: - - reason - - placeholder_id - examples: - default: - value: - reason: will_fix_later - placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - reason: *662 - expire_at: - type: string - format: date-time - description: 'The time that the bypass will expire in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - token_type: - type: string - description: The token type this bypass is for. - examples: - default: - value: - reason: will_fix_later - expire_at: '2020-11-06T18:18:30Z' - token_type: mailchimp_api_key - '403': - description: User does not have enough permissions to perform this action. - '404': - description: Placeholder ID not found, or push protection is disabled on - this repository. - '422': - description: Bad request, input data missing or incorrect. - '503': *121 - x-github: - enabledForGitHubApps: true - githubCloudOnly: false - category: secret-scanning - subcategory: secret-scanning - "/repos/{owner}/{repo}/secret-scanning/scan-history": - get: - summary: Get secret scanning scan history for a repository - description: |- - Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. - - > [!NOTE] - > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." - - OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - tags: - - secret-scanning - operationId: secret-scanning/get-scan-history - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository - parameters: - - *344 - - *345 - responses: - '404': - description: Repository does not have GitHub Advanced Security or secret - scanning enabled - '503': *121 - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - incremental_scans: - type: array - items: &663 - description: Information on a single scan performed by secret - scanning on the repository - type: object - properties: - type: - type: string - description: The type of scan - status: - type: string - description: The state of the scan. Either "completed", - "running", or "pending" - completed_at: - type: string - format: date-time - description: The time that the scan was completed. Empty - if the scan is running - nullable: true - started_at: - type: string - format: date-time - description: The time that the scan was started. Empty if - the scan is pending - nullable: true - pattern_update_scans: - type: array - items: *663 - backfill_scans: - type: array - items: *663 - custom_pattern_backfill_scans: - type: array - items: - allOf: - - *663 - - type: object - properties: - pattern_name: - type: string - description: Name of the custom pattern for custom pattern - scans - pattern_scope: - type: string - description: Level at which the custom pattern is defined, - one of "repository", "organization", or "enterprise" - examples: - default: - value: - incremental_scans: - - type: git - status: completed - completed_at: '2024-10-07T02:47:00Z' - backfill_scans: - - type: git - status: completed - started_at: '2024-10-07T02:47:00Z' - completed_at: '2024-10-07T02:50:00Z' - - type: issue - status: completed - started_at: '2024-10-07T02:47:00Z' - completed_at: '2024-10-07T02:49:00Z' - - type: discussion - status: completed - started_at: '2024-10-07T02:47:00Z' - completed_at: '2024-10-07T02:48:00Z' - pattern_update_scans: - - type: discussion - status: in_progress - started_at: '2024-10-07T02:47:00Z' - completed_at: '2024-10-07T02:51:00Z' - custom_pattern_backfill_scans: - - type: git - status: completed - started_at: '2024-10-07T02:47:00Z' - completed_at: '2024-10-07T02:55:00Z' - pattern_slug: my-custom-pattern - pattern_scope: enterprise - - type: git - status: completed - started_at: '2024-10-07T02:47:00Z' - completed_at: '2024-10-07T02:55:00Z' - pattern_slug: my-custom-pattern - pattern_scope: organization - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: secret-scanning - subcategory: secret-scanning - "/repos/{owner}/{repo}/security-advisories": - get: - summary: List repository security advisories - description: |- - Lists security advisories in a repository. - - The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. - tags: - - security-advisories - operationId: security-advisories/list-repository-advisories - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories - parameters: - - *344 - - *345 - - *61 - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - published - default: created - - *47 - - *48 - - name: per_page - description: The number of advisories to return per page. For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - - name: state - description: Filter by state of the repository advisories. Only advisories - of this state will be returned. - in: query - required: false - schema: - type: string - enum: - - triage - - draft - - published - - closed - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *664 - examples: - default: *665 - '400': *14 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - post: - summary: Create a repository security advisory - description: |- - Creates a new repository security advisory. - - In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - tags: - - security-advisories - operationId: security-advisories/create-repository-advisory - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: string - description: A detailed description of what the advisory impacts. - maxLength: 65535 - cve_id: - type: string - description: The Common Vulnerabilities and Exposures (CVE) ID. - nullable: true - vulnerabilities: - type: array - description: A product affected by the vulnerability detailed in - a repository security advisory. - items: - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - properties: - ecosystem: *1 - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - vulnerable_version_range: - type: string - description: The range of the package versions affected by - the vulnerability. - nullable: true - patched_versions: - type: string - description: The package version(s) that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected. - nullable: true - items: - type: string - required: - - package - additionalProperties: false - cwe_ids: - type: array - description: A list of Common Weakness Enumeration (CWE) IDs. - nullable: true - items: - type: string - credits: - type: array - description: A list of users receiving credit for their participation - in the security advisory. - nullable: true - items: - type: object - properties: - login: - type: string - description: The username of the user credited. - type: *332 - required: - - login - - type - additionalProperties: false - severity: - type: string - description: The severity of the advisory. You must choose between - setting this field or `cvss_vector_string`. - nullable: true - enum: - - critical - - high - - medium - - low - cvss_vector_string: - type: string - description: The CVSS vector that calculates the severity of the - advisory. You must choose between setting this field or `severity`. - nullable: true - start_private_fork: - type: boolean - description: Whether to create a temporary private fork of the repository - to collaborate on a fix. - default: false - required: - - summary - - description - - vulnerabilities - additionalProperties: false - examples: - default: - value: - summary: A new important advisory - description: A more in-depth description of what the problem is. - severity: high - cve_id: - vulnerabilities: - - package: - name: a-package - ecosystem: npm - vulnerable_version_range: "< 1.0.0" - patched_versions: 1.0.0 - vulnerable_functions: - - important_function - cwe_ids: - - CWE-1101 - - CWE-20 - credits: - - login: monalisa - type: reporter - - login: octocat - type: analyst - withVectorString: - value: - summary: A new important advisory - description: A more in-depth description of what the problem is. - cvss_vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L - cve_id: - vulnerabilities: - - package: - name: a-package - ecosystem: npm - vulnerable_version_range: "< 1.0.0" - patched_versions: 1.0.0 - vulnerable_functions: - - important_function - cwe_ids: - - CWE-1101 - - CWE-20 - credits: - - login: monalisa - type: reporter - - login: octocat - type: analyst - minimal: - value: - summary: A new important advisory - description: A more in-depth description of what the problem is. - vulnerabilities: - - package: - ecosystem: npm - responses: - '201': - description: Response - content: - application/json: - schema: *664 - examples: - default: &667 - value: - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh - summary: A short summary of the advisory. - description: A detailed description of what the advisory entails. - severity: critical - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - publisher: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: CVE-2050-00000 - state: published - created_at: '2020-01-01T00:00:00Z' - updated_at: '2020-01-02T00:00:00Z' - published_at: '2020-01-03T00:00:00Z' - closed_at: - withdrawn_at: - submission: - vulnerabilities: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - cvss: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 - cvss_severities: - cvss_v3: - vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H - score: 9.8 - cvss_v4: - vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N - score: 9.3 - cwes: - - cwe_id: CWE-123 - name: A CWE - cwe_ids: - - CWE-123 - credits: - - login: octocat - type: analyst - credits_detailed: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: analyst - state: accepted - collaborating_users: - - login: octokitten - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: - private_fork: - id: 217723378 - node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= - name: octo-repo-ghsa-abcd-1234-efgh - full_name: octo-org/octo-repo-ghsa-abcd-1234-efgh - owner: - login: octo-org - id: 6811672 - node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= - avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 - gravatar_id: '' - url: https://api.github.com/users/octo-org - html_url: https://github.com/octo-org - followers_url: https://api.github.com/users/octo-org/followers - following_url: https://api.github.com/users/octo-org/following{/other_user} - gists_url: https://api.github.com/users/octo-org/gists{/gist_id} - starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octo-org/subscriptions - organizations_url: https://api.github.com/users/octo-org/orgs - repos_url: https://api.github.com/users/octo-org/repos - events_url: https://api.github.com/users/octo-org/events{/privacy} - received_events_url: https://api.github.com/users/octo-org/received_events - type: Organization - site_admin: false - private: true - html_url: https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh - description: - fork: false - url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh - archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user} - blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha} - branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch} - collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number} - commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha} - compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head} - contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path} - contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors - deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments - downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads - events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events - forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks - git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha} - hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks - issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number} - issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number} - keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id} - labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name} - languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages - merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges - milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number} - notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number} - releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id} - stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers - statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha} - subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers - subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription - tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags - teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams - trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - "/repos/{owner}/{repo}/security-advisories/reports": - post: - summary: Privately report a security vulnerability - description: |- - Report a security vulnerability to the maintainers of the repository. - See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. - tags: - - security-advisories - operationId: security-advisories/create-private-vulnerability-report - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: string - description: A detailed description of what the advisory impacts. - maxLength: 65535 - vulnerabilities: - type: array - description: An array of products affected by the vulnerability - detailed in a repository security advisory. - nullable: true - items: - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - properties: - ecosystem: *1 - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - vulnerable_version_range: - type: string - description: The range of the package versions affected by - the vulnerability. - nullable: true - patched_versions: - type: string - description: The package version(s) that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected. - nullable: true - items: - type: string - required: - - package - additionalProperties: false - cwe_ids: - type: array - description: A list of Common Weakness Enumeration (CWE) IDs. - nullable: true - items: - type: string - severity: - type: string - description: The severity of the advisory. You must choose between - setting this field or `cvss_vector_string`. - nullable: true - enum: - - critical - - high - - medium - - low - cvss_vector_string: - type: string - description: The CVSS vector that calculates the severity of the - advisory. You must choose between setting this field or `severity`. - nullable: true - start_private_fork: - type: boolean - description: Whether to create a temporary private fork of the repository - to collaborate on a fix. - default: false - required: - - summary - - description - additionalProperties: false - examples: - default: - value: - summary: A newly discovered vulnerability - description: A more in-depth description of what the problem is. - severity: high - vulnerabilities: - - package: - name: a-package - ecosystem: npm - vulnerable_version_range: "< 1.0.0" - patched_versions: 1.0.0 - vulnerable_functions: - - important_function - cwe_ids: - - CWE-123 - responses: - '201': - description: Response - content: - application/json: - schema: *664 - examples: - default: - value: - ghsa_id: GHSA-abcd-1234-efgh - cve_id: CVE-2050-00000 - url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh - html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh - summary: A newly discovered vulnerability - description: A more in-depth description of what the problem is. - severity: high - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - publisher: - identifiers: - - type: GHSA - value: GHSA-abcd-1234-efgh - - type: CVE - value: - state: triage - created_at: '2020-01-01T00:00:00Z' - updated_at: '2020-01-02T00:00:00Z' - published_at: - closed_at: - withdrawn_at: - submission: - accepted: false - vulnerabilities: - - package: - ecosystem: npm - name: a-package - vulnerable_version_range: "< 1.0.0" - patched_versions: 1.0.0 - vulnerable_functions: - - important_function - cvss: - cvss_severities: - cvss_v3: - cvss_v4: - cwes: - - cwe_id: CWE-123 - name: A CWE - cwe_ids: - - CWE-123 - credits: - - login: octocat - type: finder - credits_detailed: - - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - type: finder - state: accepted - collaborating_users: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - collaborating_teams: - - name: Justice League - id: 1 - node_id: MDQ6VGVhbTE= - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - permission: admin - parent: - private_fork: - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": - get: - summary: Get a repository security advisory - description: |- - Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - - Anyone can access any published security advisory on a public repository. - - The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a - collaborator on the security advisory. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. - tags: - - security-advisories - operationId: security-advisories/get-repository-advisory - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory - parameters: - - *344 - - *345 - - *666 - responses: - '200': - description: Response - content: - application/json: - schema: *664 - examples: - default: *667 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - patch: - summary: Update a repository security advisory - description: |- - Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - - In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, - or a collaborator on the repository security advisory. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - tags: - - security-advisories - operationId: security-advisories/update-repository-advisory - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory - parameters: - - *344 - - *345 - - *666 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - summary: - type: string - description: A short summary of the advisory. - maxLength: 1024 - description: - type: string - description: A detailed description of what the advisory impacts. - maxLength: 65535 - cve_id: - type: string - description: The Common Vulnerabilities and Exposures (CVE) ID. - nullable: true - vulnerabilities: - type: array - description: A product affected by the vulnerability detailed in - a repository security advisory. - items: - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - properties: - ecosystem: *1 - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - vulnerable_version_range: - type: string - description: The range of the package versions affected by - the vulnerability. - nullable: true - patched_versions: - type: string - description: The package version(s) that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected. - nullable: true - items: - type: string - required: - - package - additionalProperties: false - cwe_ids: - type: array - description: A list of Common Weakness Enumeration (CWE) IDs. - nullable: true - items: - type: string - credits: - type: array - description: A list of users receiving credit for their participation - in the security advisory. - nullable: true - items: - type: object - properties: - login: - type: string - description: The username of the user credited. - type: *332 - required: - - login - - type - additionalProperties: false - severity: - type: string - description: The severity of the advisory. You must choose between - setting this field or `cvss_vector_string`. - nullable: true - enum: - - critical - - high - - medium - - low - cvss_vector_string: - type: string - description: The CVSS vector that calculates the severity of the - advisory. You must choose between setting this field or `severity`. - nullable: true - state: - type: string - description: The state of the advisory. - enum: - - published - - closed - - draft - collaborating_users: - type: array - description: A list of usernames who have been granted write access - to the advisory. - nullable: true - items: - type: string - collaborating_teams: - type: array - description: A list of team slugs which have been granted write - access to the advisory. - nullable: true - items: - type: string - additionalProperties: false - examples: - default: - summary: Updating the severity and state. - value: - severity: critical - state: published - add_credit: - summary: To add a credit to an advisory, send the whole array of values. - value: - credits: - - login: monauser - type: remediation_developer - update_vvrs: - summary: To add vulnerable versions, include existing versions in - the array. - value: - - package: - ecosystem: pip - name: a-package - vulnerable_version_range: ">= 1.0.0, < 1.0.1" - patched_versions: 1.0.1 - vulnerable_functions: - - function1 - - package: - ecosystem: pip - name: another-package - vulnerable_version_range: ">= 1.0.0, < 1.0.2" - patched_versions: 1.0.2 - vulnerable_functions: - - function2 - invalid_state_transition: - summary: Example of an invalid state transition, from `published` - to `draft`. - value: - state: draft - update_severity_with_cvss_set: - summary: Severity cannot be updated when the CVSS is already set. - value: - severity: low - responses: - '200': - description: Response - content: - application/json: - schema: *664 - examples: - default: *667 - add_credit: *667 - '403': *29 - '404': *6 - '422': - description: Validation failed, or the endpoint has been spammed. - content: - application/json: - schema: *129 - examples: - invalid_state_transition: - value: - message: Invalid state transition from `published` to `draft`. - update_severity_with_cvss_set: - value: - message: Cannot update severity value when CVSS is set. - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": - post: - summary: Request a CVE for a repository security advisory - description: |- - If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." - - You may request a CVE for public repositories, but cannot do so for private repositories. - - In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. - - OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - tags: - - security-advisories - operationId: security-advisories/create-repository-advisory-cve-request - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory - parameters: - - *344 - - *345 - - *666 - responses: - '202': *39 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": - post: - summary: Create a temporary private fork - description: |- - Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. - - > [!NOTE] - > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. - tags: - - security-advisories - operationId: security-advisories/create-fork - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork - parameters: - - *344 - - *345 - - *666 - responses: - '202': - description: Response - content: - application/json: - schema: *347 - examples: - default: *349 - '400': *14 - '422': *15 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: security-advisories - subcategory: repository-advisories - "/repos/{owner}/{repo}/stargazers": - get: - summary: List stargazers - description: |- - Lists the people that have starred the repository. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - tags: - - activity - operationId: activity/list-stargazers-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/starring#list-stargazers - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - anyOf: - - type: array - items: *4 - - type: array - items: - title: Stargazer - description: Stargazer - type: object - properties: - starred_at: - type: string - format: date-time - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - required: - - starred_at - - user - examples: - default-response: - summary: Default response - value: - - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - alternative-response-with-star-creation-timestamps: - summary: Alternative response with star creation timestamps - value: - - starred_at: '2011-01-16T19:06:43Z' - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: starring - "/repos/{owner}/{repo}/stats/code_frequency": - get: - summary: Get the weekly commit activity - description: |- - Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - - > [!NOTE] - > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. - tags: - - repos - operationId: repos/get-code-frequency-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity - parameters: - - *344 - - *345 - responses: - '200': - description: Returns a weekly aggregate of the number of additions and deletions - pushed to a repository. - content: - application/json: - schema: - type: array - items: &668 - title: Code Frequency Stat - description: Code Frequency Stat - type: array - items: - type: integer - examples: - default: - value: - - - 1302998400 - - 1124 - - -435 - '202': *39 - '204': *191 - '422': - description: Repository contains more than 10,000 commits - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: statistics - "/repos/{owner}/{repo}/stats/commit_activity": - get: - summary: Get the last year of commit activity - description: Returns the last year of commit activity grouped by week. The `days` - array is a group of commits per day, starting on `Sunday`. - tags: - - repos - operationId: repos/get-commit-activity-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Commit Activity - description: Commit Activity - type: object - properties: - days: - type: array - example: - - 0 - - 3 - - 26 - - 20 - - 39 - - 1 - - 0 - items: - type: integer - total: - type: integer - example: 89 - week: - type: integer - example: 1336280400 - required: - - days - - total - - week - examples: - default: - value: - - days: - - 0 - - 3 - - 26 - - 20 - - 39 - - 1 - - 0 - total: 89 - week: 1336280400 - '202': *39 - '204': *191 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: statistics - "/repos/{owner}/{repo}/stats/contributors": - get: - summary: Get all contributor commit activity - description: |2- - - Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - - * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * `a` - Number of additions - * `d` - Number of deletions - * `c` - Number of commits - - > [!NOTE] - > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. - tags: - - repos - operationId: repos/get-contributors-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Contributor Activity - description: Contributor Activity - type: object - properties: - author: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - total: - type: integer - example: 135 - weeks: - type: array - example: - - w: '1367712000' - a: 6898 - d: 77 - c: 10 - items: - type: object - properties: - w: - type: integer - a: - type: integer - d: - type: integer - c: - type: integer - required: - - author - - total - - weeks - examples: - default: - value: - - author: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - total: 135 - weeks: - - w: 1367712000 - a: 6898 - d: 77 - c: 10 - '202': *39 - '204': *191 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: statistics - "/repos/{owner}/{repo}/stats/participation": - get: - summary: Get the weekly commit count - description: |- - Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - - The array order is oldest week (index 0) to most recent week. - - The most recent week is seven days ago at UTC midnight to today at UTC midnight. - tags: - - repos - operationId: repos/get-participation-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count - parameters: - - *344 - - *345 - responses: - '200': - description: The array order is oldest week (index 0) to most recent week. - content: - application/json: - schema: - title: Participation Stats - type: object - properties: - all: - type: array - items: - type: integer - owner: - type: array - items: - type: integer - required: - - all - - owner - examples: - default: - value: - all: - - 11 - - 21 - - 15 - - 2 - - 8 - - 1 - - 8 - - 23 - - 17 - - 21 - - 11 - - 10 - - 33 - - 91 - - 38 - - 34 - - 22 - - 23 - - 32 - - 3 - - 43 - - 87 - - 71 - - 18 - - 13 - - 5 - - 13 - - 16 - - 66 - - 27 - - 12 - - 45 - - 110 - - 117 - - 13 - - 8 - - 18 - - 9 - - 19 - - 26 - - 39 - - 12 - - 20 - - 31 - - 46 - - 91 - - 45 - - 10 - - 24 - - 9 - - 29 - - 7 - owner: - - 3 - - 2 - - 3 - - 0 - - 2 - - 0 - - 5 - - 14 - - 7 - - 9 - - 1 - - 5 - - 0 - - 48 - - 19 - - 2 - - 0 - - 1 - - 10 - - 2 - - 23 - - 40 - - 35 - - 8 - - 8 - - 2 - - 10 - - 6 - - 30 - - 0 - - 2 - - 9 - - 53 - - 104 - - 3 - - 3 - - 10 - - 4 - - 7 - - 11 - - 21 - - 4 - - 4 - - 22 - - 26 - - 63 - - 11 - - 2 - - 14 - - 1 - - 10 - - 3 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: statistics - "/repos/{owner}/{repo}/stats/punch_card": - get: - summary: Get the hourly commit count for each day - description: |- - Each array contains the day number, hour number, and number of commits: - - * `0-6`: Sunday - Saturday - * `0-23`: Hour of day - * Number of commits - - For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - tags: - - repos - operationId: repos/get-punch-card-stats - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day - parameters: - - *344 - - *345 - responses: - '200': - description: For example, `[2, 14, 25]` indicates that there were 25 total - commits, during the 2:00pm hour on Tuesdays. All times are based on the - time zone of individual commits. - content: - application/json: - schema: - type: array - items: *668 - examples: - default: - value: - - - 0 - - 0 - - 5 - - - 0 - - 1 - - 43 - - - 0 - - 2 - - 21 - '204': *191 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: statistics - "/repos/{owner}/{repo}/statuses/{sha}": - post: - summary: Create a commit status - description: |- - Users with push access in a repository can create commit statuses for a given SHA. - - Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - tags: - - repos - operationId: repos/create-commit-status - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/commits/statuses#create-a-commit-status - parameters: - - *344 - - *345 - - name: sha - in: path - required: true - schema: - type: string - x-multi-segment: true - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - state: - type: string - description: The state of the status. - enum: - - error - - failure - - pending - - success - target_url: - type: string - nullable: true - description: "The target URL to associate with this status. This - URL will be linked from the GitHub UI to allow users to easily - see the source of the status. \nFor example, if your continuous - integration system is posting build status, you would want to - provide the deep link for the build output for this specific SHA: - \ \n`http://ci.example.com/user/repo/build/sha`" - description: - type: string - nullable: true - description: A short description of the status. - context: - type: string - description: A string label to differentiate this status from the - status of other systems. This field is case-insensitive. - default: default - required: - - state - examples: - default: - value: - state: success - target_url: https://example.com/build/status - description: The build succeeded! - context: continuous-integration/jenkins - responses: - '201': - description: Response - content: - application/json: - schema: *669 - examples: - default: - value: - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - avatar_url: https://github.com/images/error/hubot_happy.gif - id: 1 - node_id: MDY6U3RhdHVzMQ== - state: success - description: Build has completed successfully - target_url: https://ci.example.com/1000/output - context: continuous-integration/jenkins - created_at: '2012-07-20T01:19:13Z' - updated_at: '2012-07-20T01:19:13Z' - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: commits - subcategory: statuses - "/repos/{owner}/{repo}/subscribers": - get: - summary: List watchers - description: Lists the people watching the specified repository. - tags: - - activity - operationId: activity/list-watchers-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/watching#list-watchers - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: watching - "/repos/{owner}/{repo}/subscription": - get: - summary: Get a repository subscription - description: Gets information about whether the authenticated user is subscribed - to the repository. - tags: - - activity - operationId: activity/get-repo-subscription - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription - parameters: - - *344 - - *345 - responses: - '200': - description: if you subscribe to the repository - content: - application/json: - schema: &670 - title: Repository Invitation - description: Repository invitations let you manage who you collaborate - with. - type: object - properties: - subscribed: - description: Determines if notifications should be received from - this repository. - type: boolean - example: true - ignored: - description: Determines if all notifications should be blocked - from this repository. - type: boolean - reason: - type: string - nullable: true - created_at: - type: string - format: date-time - example: '2012-10-06T21:34:12Z' - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example/subscription - repository_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/example - required: - - created_at - - ignored - - reason - - subscribed - - url - - repository_url - examples: - response-if-you-subscribe-to-the-repository: - value: - subscribed: true - ignored: false - reason: - created_at: '2012-10-06T21:34:12Z' - url: https://api.github.com/repos/octocat/example/subscription - repository_url: https://api.github.com/repos/octocat/example - '404': - description: Not Found if you don't subscribe to the repository - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: watching - put: - summary: Set a repository subscription - description: If you would like to watch a repository, set `subscribed` to `true`. - If you would like to ignore notifications made within a repository, set `ignored` - to `true`. If you would like to stop watching a repository, [delete the repository's - subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) - completely. - tags: - - activity - operationId: activity/set-repo-subscription - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription - parameters: - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - subscribed: - type: boolean - description: Determines if notifications should be received from - this repository. - ignored: - type: boolean - description: Determines if all notifications should be blocked from - this repository. - examples: - default: - value: - subscribed: true - ignored: false - responses: - '200': - description: Response - content: - application/json: - schema: *670 - examples: - default: - value: - subscribed: true - ignored: false - reason: - created_at: '2012-10-06T21:34:12Z' - url: https://api.github.com/repos/octocat/example/subscription - repository_url: https://api.github.com/repos/octocat/example - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: watching - delete: - summary: Delete a repository subscription - description: This endpoint should only be used to stop watching a repository. - To control whether or not you wish to receive notifications from a repository, - [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). - tags: - - activity - operationId: activity/delete-repo-subscription - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription - parameters: - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: watching - "/repos/{owner}/{repo}/tags": - get: - summary: List repository tags - description: '' - tags: - - repos - operationId: repos/list-tags - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repository-tags - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Tag - description: Tag - type: object - properties: - name: - type: string - example: v0.1 - commit: - type: object - properties: - sha: - type: string - url: - type: string - format: uri - required: - - sha - - url - zipball_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/zipball/v0.1 - tarball_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/tarball/v0.1 - node_id: - type: string - required: - - name - - node_id - - commit - - zipball_url - - tarball_url - examples: - default: - value: - - name: v0.1 - commit: - sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc - url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc - zipball_url: https://github.com/octocat/Hello-World/zipball/v0.1 - tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 - node_id: MDQ6VXNlcjE= - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/tarball/{ref}": - get: - summary: Download a repository archive (tar) - description: |- - Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually - `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use - the `Location` header to make a second `GET` request. - - > [!NOTE] - > For private repositories, these links are temporary and expire after five minutes. - tags: - - repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar - operationId: repos/download-tarball-archive - parameters: - - *344 - - *345 - - name: ref - in: path - required: true - x-multi-segment: true - schema: - type: string - responses: - '302': - description: Response - headers: - Location: - example: https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - "/repos/{owner}/{repo}/teams": - get: - summary: List repository teams - description: |- - Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - - For a public repository, a team is listed only if that team added the public repository explicitly. - - OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. - tags: - - repos - operationId: repos/list-teams - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repository-teams - parameters: - - *344 - - *345 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *197 - examples: - default: *260 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/topics": - get: - summary: Get all repository topics - description: '' - tags: - - repos - operationId: repos/get-all-topics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#get-all-repository-topics - parameters: - - *344 - - *345 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: &671 - title: Topic - description: A topic aggregates entities that are related to a subject. - type: object - properties: - names: - type: array - items: - type: string - required: - - names - examples: - default: &672 - value: - names: - - octocat - - atom - - electron - - api - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - put: - summary: Replace all repository topics - description: '' - tags: - - repos - operationId: repos/replace-all-topics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - names: - type: array - description: An array of topics to add to the repository. Pass one - or more topics to _replace_ the set of existing topics. Send an - empty array (`[]`) to clear all topics from the repository. **Note:** - Topic `names` will be saved as lowercase. - items: - type: string - required: - - names - examples: - default: - value: - names: - - octocat - - atom - - electron - - api - responses: - '200': - description: Response - content: - application/json: - schema: *671 - examples: - default: *672 - '404': *6 - '422': *7 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/traffic/clones": - get: - summary: Get repository clones - description: Get the total number of clones and breakdown per day or week for - the last 14 days. Timestamps are aligned to UTC midnight of the beginning - of the day or week. Week begins on Monday. - tags: - - repos - operationId: repos/get-clones - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/traffic#get-repository-clones - parameters: - - *344 - - *345 - - &673 - name: per - description: The time frame to display results for. - in: query - required: false - schema: - type: string - enum: - - day - - week - default: day - responses: - '200': - description: Response - content: - application/json: - schema: - title: Clone Traffic - description: Clone Traffic - type: object - properties: - count: - type: integer - example: 173 - uniques: - type: integer - example: 128 - clones: - type: array - items: &674 - title: Traffic - type: object - properties: - timestamp: - type: string - format: date-time - uniques: - type: integer - count: - type: integer - required: - - timestamp - - uniques - - count - required: - - uniques - - count - - clones - examples: - default: - value: - count: 173 - uniques: 128 - clones: - - timestamp: '2016-10-10T00:00:00Z' - count: 2 - uniques: 1 - - timestamp: '2016-10-11T00:00:00Z' - count: 17 - uniques: 16 - - timestamp: '2016-10-12T00:00:00Z' - count: 21 - uniques: 15 - - timestamp: '2016-10-13T00:00:00Z' - count: 8 - uniques: 7 - - timestamp: '2016-10-14T00:00:00Z' - count: 5 - uniques: 5 - - timestamp: '2016-10-15T00:00:00Z' - count: 2 - uniques: 2 - - timestamp: '2016-10-16T00:00:00Z' - count: 8 - uniques: 7 - - timestamp: '2016-10-17T00:00:00Z' - count: 26 - uniques: 15 - - timestamp: '2016-10-18T00:00:00Z' - count: 19 - uniques: 17 - - timestamp: '2016-10-19T00:00:00Z' - count: 19 - uniques: 14 - - timestamp: '2016-10-20T00:00:00Z' - count: 19 - uniques: 15 - - timestamp: '2016-10-21T00:00:00Z' - count: 9 - uniques: 7 - - timestamp: '2016-10-22T00:00:00Z' - count: 5 - uniques: 5 - - timestamp: '2016-10-23T00:00:00Z' - count: 6 - uniques: 5 - - timestamp: '2016-10-24T00:00:00Z' - count: 7 - uniques: 5 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: traffic - "/repos/{owner}/{repo}/traffic/popular/paths": - get: - summary: Get top referral paths - description: Get the top 10 popular contents over the last 14 days. - tags: - - repos - operationId: repos/get-top-paths - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Content Traffic - description: Content Traffic - type: object - properties: - path: - type: string - example: "/github/hubot" - title: - type: string - example: 'github/hubot: A customizable life embetterment robot.' - count: - type: integer - example: 3542 - uniques: - type: integer - example: 2225 - required: - - path - - title - - uniques - - count - examples: - default: - value: - - path: "/github/hubot" - title: 'github/hubot: A customizable life embetterment robot.' - count: 3542 - uniques: 2225 - - path: "/github/hubot/blob/master/docs/scripting.md" - title: hubot/scripting.md at master Β· github/hubot Β· GitHub - count: 1707 - uniques: 804 - - path: "/github/hubot/tree/master/docs" - title: hubot/docs at master Β· github/hubot Β· GitHub - count: 685 - uniques: 435 - - path: "/github/hubot/tree/master/src" - title: hubot/src at master Β· github/hubot Β· GitHub - count: 577 - uniques: 347 - - path: "/github/hubot/blob/master/docs/index.md" - title: hubot/index.md at master Β· github/hubot Β· GitHub - count: 379 - uniques: 259 - - path: "/github/hubot/blob/master/docs/adapters.md" - title: hubot/adapters.md at master Β· github/hubot Β· GitHub - count: 354 - uniques: 201 - - path: "/github/hubot/tree/master/examples" - title: hubot/examples at master Β· github/hubot Β· GitHub - count: 340 - uniques: 260 - - path: "/github/hubot/blob/master/docs/deploying/heroku.md" - title: hubot/heroku.md at master Β· github/hubot Β· GitHub - count: 324 - uniques: 217 - - path: "/github/hubot/blob/master/src/robot.coffee" - title: hubot/robot.coffee at master Β· github/hubot Β· GitHub - count: 293 - uniques: 191 - - path: "/github/hubot/blob/master/LICENSE.md" - title: hubot/LICENSE.md at master Β· github/hubot Β· GitHub - count: 281 - uniques: 222 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: traffic - "/repos/{owner}/{repo}/traffic/popular/referrers": - get: - summary: Get top referral sources - description: Get the top 10 referrers over the last 14 days. - tags: - - repos - operationId: repos/get-top-referrers - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources - parameters: - - *344 - - *345 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Referrer Traffic - description: Referrer Traffic - type: object - properties: - referrer: - type: string - example: Google - count: - type: integer - example: 4 - uniques: - type: integer - example: 3 - required: - - referrer - - uniques - - count - examples: - default: - value: - - referrer: Google - count: 4 - uniques: 3 - - referrer: stackoverflow.com - count: 2 - uniques: 2 - - referrer: eggsonbread.com - count: 1 - uniques: 1 - - referrer: yandex.ru - count: 1 - uniques: 1 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: traffic - "/repos/{owner}/{repo}/traffic/views": - get: - summary: Get page views - description: Get the total number of views and breakdown per day or week for - the last 14 days. Timestamps are aligned to UTC midnight of the beginning - of the day or week. Week begins on Monday. - tags: - - repos - operationId: repos/get-views - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/metrics/traffic#get-page-views - parameters: - - *344 - - *345 - - *673 - responses: - '200': - description: Response - content: - application/json: - schema: - title: View Traffic - description: View Traffic - type: object - properties: - count: - type: integer - example: 14850 - uniques: - type: integer - example: 3782 - views: - type: array - items: *674 - required: - - uniques - - count - - views - examples: - default: - value: - count: 14850 - uniques: 3782 - views: - - timestamp: '2016-10-10T00:00:00Z' - count: 440 - uniques: 143 - - timestamp: '2016-10-11T00:00:00Z' - count: 1308 - uniques: 414 - - timestamp: '2016-10-12T00:00:00Z' - count: 1486 - uniques: 452 - - timestamp: '2016-10-13T00:00:00Z' - count: 1170 - uniques: 401 - - timestamp: '2016-10-14T00:00:00Z' - count: 868 - uniques: 266 - - timestamp: '2016-10-15T00:00:00Z' - count: 495 - uniques: 157 - - timestamp: '2016-10-16T00:00:00Z' - count: 524 - uniques: 175 - - timestamp: '2016-10-17T00:00:00Z' - count: 1263 - uniques: 412 - - timestamp: '2016-10-18T00:00:00Z' - count: 1402 - uniques: 417 - - timestamp: '2016-10-19T00:00:00Z' - count: 1394 - uniques: 424 - - timestamp: '2016-10-20T00:00:00Z' - count: 1492 - uniques: 448 - - timestamp: '2016-10-21T00:00:00Z' - count: 1153 - uniques: 332 - - timestamp: '2016-10-22T00:00:00Z' - count: 566 - uniques: 168 - - timestamp: '2016-10-23T00:00:00Z' - count: 675 - uniques: 184 - - timestamp: '2016-10-24T00:00:00Z' - count: 614 - uniques: 237 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: metrics - subcategory: traffic - "/repos/{owner}/{repo}/transfer": - post: - summary: Transfer a repository - description: A transfer request will need to be accepted by the new owner when - transferring a personal repository to another user. The response will contain - the original `owner`, and the transfer will continue asynchronously. For more - details on the requirements to transfer personal and organization-owned repositories, - see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - tags: - - repos - operationId: repos/transfer - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#transfer-a-repository - parameters: - - *344 - - *345 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - new_owner: - type: string - description: The username or organization name the repository will - be transferred to. - new_name: - type: string - description: The new name to be given to the repository. - team_ids: - type: array - description: ID of the team or teams to add to the repository. Teams - can only be added to organization-owned repositories. - items: - type: integer - required: - - new_owner - examples: - default: - value: - new_owner: github - team_ids: - - 12 - - 345 - new_name: octorepo - responses: - '202': - description: Response - content: - application/json: - schema: *160 - examples: - default: - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - allow_forking: true - subscribers_count: 42 - network_count: 0 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/vulnerability-alerts": - get: - summary: Check if vulnerability alerts are enabled for a repository - description: Shows whether dependency alerts are enabled or disabled for a repository. - The authenticated user must have admin read access to the repository. For - more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". - tags: - - repos - operationId: repos/check-vulnerability-alerts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository - parameters: - - *344 - - *345 - responses: - '204': - description: Response if repository is enabled with vulnerability alerts - '404': - description: Not Found if repository is not enabled with vulnerability alerts - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - put: - summary: Enable vulnerability alerts - description: Enables dependency alerts and the dependency graph for a repository. - The authenticated user must have admin access to the repository. For more - information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". - tags: - - repos - operationId: repos/enable-vulnerability-alerts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts - parameters: - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - delete: - summary: Disable vulnerability alerts - description: |- - Disables dependency alerts and the dependency graph for a repository. - The authenticated user must have admin access to the repository. For more information, - see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". - tags: - - repos - operationId: repos/disable-vulnerability-alerts - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts - parameters: - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repos/{owner}/{repo}/zipball/{ref}": - get: - summary: Download a repository archive (zip) - description: |- - Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually - `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use - the `Location` header to make a second `GET` request. - - > [!NOTE] - > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. - tags: - - repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip - operationId: repos/download-zipball-archive - parameters: - - *344 - - *345 - - name: ref - in: path - required: true - x-multi-segment: true - schema: - type: string - responses: - '302': - description: Response - headers: - Location: - example: https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: contents - "/repos/{template_owner}/{template_repo}/generate": - post: - summary: Create a repository using a template - description: |- - Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - - OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - tags: - - repos - operationId: repos/create-using-template - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template - parameters: - - name: template_owner - description: The account owner of the template repository. The name is not - case sensitive. - in: path - required: true - schema: - type: string - - name: template_repo - description: The name of the template repository without the `.git` extension. - The name is not case sensitive. - in: path - required: true - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - owner: - type: string - description: The organization or person who will own the new repository. - To create a new repository in an organization, the authenticated - user must be a member of the specified organization. - name: - type: string - description: The name of the new repository. - description: - type: string - description: A short description of the new repository. - include_all_branches: - type: boolean - description: 'Set to `true` to include the directory structure and - files from all branches in the template repository, and not just - the default branch. Default: `false`.' - default: false - private: - type: boolean - description: Either `true` to create a new private repository or - `false` to create a new public one. - default: false - required: - - name - examples: - default: - value: - owner: octocat - name: Hello-World - description: This is your first repository - include_all_branches: false - private: false - responses: - '201': - description: Response - content: - application/json: - schema: *347 - examples: - default: *349 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World - schema: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repositories": - get: - summary: List public repositories - description: |- - Lists all public repositories in the order that they were created. - - Note: - - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. - tags: - - repos - operationId: repos/list-public - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-public-repositories - parameters: - - name: since - description: A repository ID. Only return repositories with an ID greater - than this ID. - in: query - required: false - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: - value: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks - headers: - Link: - example: ; rel="next" - schema: - type: string - '422': *15 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values": - post: - summary: Add issue field values to an issue - description: |- - Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. - Adding an empty array will clear all existing field values for the issue. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/add-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue - parameters: - - *149 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to add to this issue. - Each field value must include the field ID and the value to set. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Add multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Add a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after adding - the new values - items: *559 - examples: - default: *675 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *121 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - put: - summary: Set issue field values for an issue - description: |- - Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. - - This endpoint supports the following field data types: - - **`text`**: String values for text fields - - **`single_select`**: Option names for single-select fields (must match an existing option name) - - **`number`**: Numeric values for number fields - - **`date`**: ISO 8601 date strings for date fields - - This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. - - Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/set-issue-field-values - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue - parameters: - - *149 - - *556 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - issue_field_values: - type: array - description: An array of issue field values to set for this issue. - Each field value must include the field ID and the value to set. - All existing field values will be replaced. - items: - type: object - properties: - field_id: - type: integer - description: The ID of the issue field to set - example: 123 - value: - oneOf: - - type: string - description: The value to set for text, single_select, or - date fields - - type: number - description: The value to set for number fields - description: |- - The value to set for the field. The type depends on the field's data type: - - For text fields: provide a string value - - For single_select fields: provide the option name as a string (must match an existing option) - - For number fields: provide a numeric value - - For date fields: provide an ISO 8601 date string - example: Critical - required: - - field_id - - value - additionalProperties: false - maxItems: 25 - examples: - default: - summary: Set multiple field values - value: - issue_field_values: - - field_id: 123 - value: Critical - - field_id: 456 - value: 5 - - field_id: 789 - value: '2024-12-31' - single-field: - summary: Set a single field value - value: - issue_field_values: - - field_id: 123 - value: High Priority - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - description: The current issue field values for this issue after setting - the new values - items: *559 - examples: - default: *675 - '400': *14 - '403': *29 - '404': *6 - '422': *15 - '503': *121 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}": - delete: - summary: Delete an issue field value from an issue - description: |- - Remove a specific custom field value from an issue. - - Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. - - If the specified field does not have a value set on the issue, this operation will return a `404` error. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - tags: - - issues - operationId: issues/delete-issue-field-value - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue - parameters: - - *149 - - *556 - - *242 - responses: - '204': - description: Issue field value deleted successfully - '403': *29 - '404': *6 - '422': *15 - '503': *121 - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: issues - subcategory: issue-field-values - "/search/code": - get: - summary: Search code - description: |- - Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - 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](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - - `q=addClass+in:file+language:js+repo:jquery/jquery` - - 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. - - Considerations for code search: - - Due to the complexity of searching code, there are a few restrictions on how searches are performed: - - * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * Only files smaller than 384 KB are searchable. - * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - - This endpoint requires you to authenticate and limits you to 10 requests per minute. - tags: - - search - operationId: search/code - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-code - parameters: - - name: q - description: The query contains one or more search keywords and qualifiers. - Qualifiers allow you to limit your search to specific areas of GitHub. The - REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" - for a detailed list of qualifiers. - in: query - required: true - schema: - type: string - - name: sort - deprecated: true - description: "**This field is closing down.** Sorts the results of your query. - Can only be `indexed`, which indicates how recently a file has been indexed - by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)" - in: query - required: false - schema: - type: string - enum: - - indexed - - name: order - description: "**This field is closing down.** Determines whether the first - search result returned is the highest number of matches (`desc`) or lowest - number of matches (`asc`). This parameter is ignored unless you provide - `sort`. " - in: query - deprecated: true - required: false - schema: - type: string - enum: - - desc - - asc - default: desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: Code Search Result Item - description: Code Search Result Item - type: object - properties: - name: - type: string - path: - type: string - sha: - type: string - url: - type: string - format: uri - git_url: - type: string - format: uri - html_url: - type: string - format: uri - repository: *160 - score: - type: number - file_size: - type: integer - language: - type: string - nullable: true - last_modified_at: - type: string - format: date-time - line_numbers: - type: array - items: - type: string - example: - - 73..77 - - 77..78 - text_matches: &676 - title: Search Result Text Matches - type: array - items: - type: object - properties: - object_url: - type: string - object_type: - nullable: true - type: string - property: - type: string - fragment: - type: string - matches: - type: array - items: - type: object - properties: - text: - type: string - indices: - type: array - items: - type: integer - required: - - score - - name - - path - - sha - - git_url - - html_url - - url - - repository - examples: - default: - value: - total_count: 7 - incomplete_results: false - items: - - name: classes.js - path: src/attributes/classes.js - sha: d7212f9dee2dcc18f084d7df8f417b80846ded5a - url: https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4 - git_url: https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a - html_url: https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js - repository: - id: 167174 - node_id: MDEwOlJlcG9zaXRvcnkxNjcxNzQ= - name: jquery - full_name: jquery/jquery - owner: - login: jquery - id: 70142 - node_id: MDQ6VXNlcjcwMTQy - avatar_url: https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png - gravatar_id: '' - url: https://api.github.com/users/jquery - html_url: https://github.com/jquery - followers_url: https://api.github.com/users/jquery/followers - following_url: https://api.github.com/users/jquery/following{/other_user} - gists_url: https://api.github.com/users/jquery/gists{/gist_id} - starred_url: https://api.github.com/users/jquery/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/jquery/subscriptions - organizations_url: https://api.github.com/users/jquery/orgs - repos_url: https://api.github.com/users/jquery/repos - events_url: https://api.github.com/users/jquery/events{/privacy} - received_events_url: https://api.github.com/users/jquery/received_events - type: Organization - site_admin: false - private: false - html_url: https://github.com/jquery/jquery - description: jQuery JavaScript Library - fork: false - url: https://api.github.com/repos/jquery/jquery - forks_url: https://api.github.com/repos/jquery/jquery/forks - keys_url: https://api.github.com/repos/jquery/jquery/keys{/key_id} - collaborators_url: https://api.github.com/repos/jquery/jquery/collaborators{/collaborator} - teams_url: https://api.github.com/repos/jquery/jquery/teams - hooks_url: https://api.github.com/repos/jquery/jquery/hooks - issue_events_url: https://api.github.com/repos/jquery/jquery/issues/events{/number} - events_url: https://api.github.com/repos/jquery/jquery/events - assignees_url: https://api.github.com/repos/jquery/jquery/assignees{/user} - branches_url: https://api.github.com/repos/jquery/jquery/branches{/branch} - tags_url: https://api.github.com/repos/jquery/jquery/tags - blobs_url: https://api.github.com/repos/jquery/jquery/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/jquery/jquery/git/tags{/sha} - git_refs_url: https://api.github.com/repos/jquery/jquery/git/refs{/sha} - trees_url: https://api.github.com/repos/jquery/jquery/git/trees{/sha} - statuses_url: https://api.github.com/repos/jquery/jquery/statuses/{sha} - languages_url: https://api.github.com/repos/jquery/jquery/languages - stargazers_url: https://api.github.com/repos/jquery/jquery/stargazers - contributors_url: https://api.github.com/repos/jquery/jquery/contributors - subscribers_url: https://api.github.com/repos/jquery/jquery/subscribers - subscription_url: https://api.github.com/repos/jquery/jquery/subscription - commits_url: https://api.github.com/repos/jquery/jquery/commits{/sha} - git_commits_url: https://api.github.com/repos/jquery/jquery/git/commits{/sha} - comments_url: https://api.github.com/repos/jquery/jquery/comments{/number} - issue_comment_url: https://api.github.com/repos/jquery/jquery/issues/comments/{number} - contents_url: https://api.github.com/repos/jquery/jquery/contents/{+path} - compare_url: https://api.github.com/repos/jquery/jquery/compare/{base}...{head} - merges_url: https://api.github.com/repos/jquery/jquery/merges - archive_url: https://api.github.com/repos/jquery/jquery/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/jquery/jquery/downloads - issues_url: https://api.github.com/repos/jquery/jquery/issues{/number} - pulls_url: https://api.github.com/repos/jquery/jquery/pulls{/number} - milestones_url: https://api.github.com/repos/jquery/jquery/milestones{/number} - notifications_url: https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/jquery/jquery/labels{/name} - deployments_url: http://api.github.com/repos/octocat/Hello-World/deployments - releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} - score: 1 - '304': *37 - '503': *121 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/search/commits": - get: - summary: Search commits - description: |- - Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match - metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - - `q=repo:octocat/Spoon-Knife+css` - tags: - - search - operationId: search/commits - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-commits - parameters: - - name: q - description: The query contains one or more search keywords and qualifiers. - Qualifiers allow you to limit your search to specific areas of GitHub. The - REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" - for a detailed list of qualifiers. - in: query - required: true - schema: - type: string - - name: sort - description: 'Sorts the results of your query by `author-date` or `committer-date`. - Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' - in: query - required: false - schema: - type: string - enum: - - author-date - - committer-date - - &677 - name: order - description: Determines whether the first search result returned is the highest - number of matches (`desc`) or lowest number of matches (`asc`). This parameter - is ignored unless you provide `sort`. - in: query - required: false - schema: - type: string - enum: - - desc - - asc - default: desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: Commit Search Result Item - description: Commit Search Result Item - type: object - properties: - url: - type: string - format: uri - sha: - type: string - html_url: - type: string - format: uri - comments_url: - type: string - format: uri - commit: - type: object - properties: - author: - type: object - properties: - name: - type: string - email: - type: string - date: - type: string - format: date-time - required: - - name - - email - - date - committer: - title: Git User - description: Metaproperties for Git author/committer - information. - type: object - properties: *409 - nullable: true - comment_count: - type: integer - message: - type: string - tree: - type: object - properties: - sha: - type: string - url: - type: string - format: uri - required: - - sha - - url - url: - type: string - format: uri - verification: *532 - required: - - author - - committer - - comment_count - - message - - tree - - url - author: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - committer: - title: Git User - description: Metaproperties for Git author/committer information. - type: object - properties: *409 - nullable: true - parents: - type: array - items: - type: object - properties: - url: - type: string - html_url: - type: string - sha: - type: string - repository: *160 - score: - type: number - node_id: - type: string - text_matches: *676 - required: - - sha - - node_id - - url - - html_url - - author - - committer - - parents - - comments_url - - commit - - repository - - score - examples: - default: - value: - total_count: 1 - incomplete_results: false - items: - - url: https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f - sha: bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f - html_url: https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f - comments_url: https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments - commit: - url: https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f - author: - date: '2014-02-04T14:38:36-08:00' - name: The Octocat - email: octocat@nowhere.com - committer: - date: '2014-02-12T15:18:55-08:00' - name: The Octocat - email: octocat@nowhere.com - message: Create styles.css and updated README - tree: - url: https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68 - sha: a639e96f9038797fba6e0469f94a4b0cc459fa68 - comment_count: 8 - author: - login: octocat - id: 583231 - node_id: MDQ6VXNlcjU4MzIzMQ== - avatar_url: https://avatars.githubusercontent.com/u/583231?v=3 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - committer: {} - parents: - - url: https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4 - html_url: https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4 - sha: a30c19e3f13765a3b48829788bc1cb8b4e95cee4 - repository: - id: 1300192 - node_id: MDEwOlJlcG9zaXRvcnkxMzAwMTky - name: Spoon-Knife - full_name: octocat/Spoon-Knife - owner: - login: octocat - id: 583231 - node_id: MDQ6VXNlcjU4MzIzMQ== - avatar_url: https://avatars.githubusercontent.com/u/583231?v=3 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Spoon-Knife - description: This repo is for demonstration purposes only. - fork: false - url: https://api.github.com/repos/octocat/Spoon-Knife - forks_url: https://api.github.com/repos/octocat/Spoon-Knife/forks - keys_url: https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id} - collaborators_url: https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator} - teams_url: https://api.github.com/repos/octocat/Spoon-Knife/teams - hooks_url: https://api.github.com/repos/octocat/Spoon-Knife/hooks - issue_events_url: https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number} - events_url: https://api.github.com/repos/octocat/Spoon-Knife/events - assignees_url: https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user} - branches_url: https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch} - tags_url: https://api.github.com/repos/octocat/Spoon-Knife/tags - blobs_url: https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha} - git_refs_url: https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha} - trees_url: https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha} - statuses_url: https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha} - languages_url: https://api.github.com/repos/octocat/Spoon-Knife/languages - stargazers_url: https://api.github.com/repos/octocat/Spoon-Knife/stargazers - contributors_url: https://api.github.com/repos/octocat/Spoon-Knife/contributors - subscribers_url: https://api.github.com/repos/octocat/Spoon-Knife/subscribers - subscription_url: https://api.github.com/repos/octocat/Spoon-Knife/subscription - commits_url: https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha} - git_commits_url: https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha} - comments_url: https://api.github.com/repos/octocat/Spoon-Knife/comments{/number} - issue_comment_url: https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number} - contents_url: https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path} - compare_url: https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head} - merges_url: https://api.github.com/repos/octocat/Spoon-Knife/merges - archive_url: https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/octocat/Spoon-Knife/downloads - issues_url: https://api.github.com/repos/octocat/Spoon-Knife/issues{/number} - pulls_url: https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number} - milestones_url: https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/octocat/Spoon-Knife/labels{/name} - releases_url: https://api.github.com/repos/octocat/Spoon-Knife/releases{/id} - deployments_url: https://api.github.com/repos/octocat/Spoon-Knife/deployments - score: 1 - node_id: MDQ6VXNlcjU4MzIzMQ== - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/search/issues": - get: - summary: Search issues and pull requests - description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - - `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - - This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - - > [!NOTE] - > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - tags: - - search - operationId: search/issues-and-pull-requests - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-issues-and-pull-requests - parameters: - - name: q - description: The query contains one or more search keywords and qualifiers. - Qualifiers allow you to limit your search to specific areas of GitHub. The - REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" - for a detailed list of qualifiers. - in: query - required: true - schema: - type: string - - name: sort - description: 'Sorts the results of your query by the number of `comments`, - `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, - `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort - results by how recently the items were `created` or `updated`, Default: - [best match](https://docs.github.com/rest/search/search#ranking-search-results)' - in: query - required: false - schema: - type: string - enum: - - comments - - reactions - - reactions-+1 - - reactions--1 - - reactions-smile - - reactions-thinking_face - - reactions-heart - - reactions-tada - - interactions - - created - - updated - - *677 - - *17 - - *19 - - name: advanced_search - description: |- - Set to `true` to use advanced search. - Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` - in: query - required: false - schema: - type: string - - name: search_type - description: |- - The type of search to perform on issues. When not specified, the default is lexical search. - - - `semantic` β€” performs a pure semantic (vector) search using embedding-based understanding. - - `hybrid` β€” combines semantic search with lexical search for best results. - - Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. - Only applies to issue searches (`/search/issues`). - in: query - required: false - schema: - type: string - enum: - - semantic - - hybrid - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - - search_type - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: Issue Search Result Item - description: Issue Search Result Item - type: object - properties: - url: - type: string - format: uri - repository_url: - type: string - format: uri - labels_url: - type: string - comments_url: - type: string - format: uri - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - node_id: - type: string - number: - type: integer - title: - type: string - locked: - type: boolean - active_lock_reason: - type: string - nullable: true - assignees: - type: array - items: *4 - nullable: true - user: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - labels: - type: array - items: - type: object - properties: - id: - type: integer - format: int64 - node_id: - type: string - url: - type: string - name: - type: string - color: - type: string - default: - type: boolean - description: - type: string - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - type: string - state_reason: - type: string - nullable: true - assignee: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: *280 - required: *281 - nullable: true - comments: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - closed_at: - type: string - format: date-time - nullable: true - text_matches: *676 - pull_request: - type: object - properties: - merged_at: - type: string - format: date-time - nullable: true - diff_url: - type: string - format: uri - nullable: true - html_url: - type: string - format: uri - nullable: true - patch_url: - type: string - format: uri - nullable: true - url: - type: string - format: uri - nullable: true - required: - - diff_url - - html_url - - patch_url - - url - body: - type: string - score: - type: number - author_association: *82 - draft: - type: boolean - repository: *79 - body_html: - type: string - body_text: - type: string - timeline_url: - type: string - format: uri - type: *243 - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. - They can be installed directly on organizations and user - accounts and granted access to specific repositories. - They come with granular permissions and built-in webhooks. - GitHub apps are first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - reactions: *83 - required: - - assignee - - closed_at - - comments - - comments_url - - events_url - - html_url - - id - - node_id - - labels - - labels_url - - milestone - - number - - repository_url - - state - - locked - - title - - url - - user - - author_association - - created_at - - updated_at - - score - x-github-breaking-changes: - - changeset: remove_singular_assignee_from_issues_and_pull_requests - patch: - properties: - assignee: - required: - - closed_at - - comments - - comments_url - - events_url - - html_url - - id - - node_id - - labels - - labels_url - - milestone - - number - - repository_url - - state - - locked - - title - - url - - user - - author_association - - created_at - - updated_at - - score - version: '2026-03-10' - search_type: - type: string - description: The type of search that was performed. Possible values - are `lexical`, `semantic`, or `hybrid`. - enum: - - lexical - - semantic - - hybrid - lexical_fallback_reason: - type: array - description: When a semantic or hybrid search falls back to lexical - search, this field contains the reasons for the fallback. Only - present when a fallback occurred. - items: - type: string - enum: - - no_text_terms - - quoted_text - - non_issue_target - - or_boolean_not_supported - - no_accessible_repos - - server_error - - only_non_semantic_fields_requested - examples: - default: - summary: Hybrid search response - value: - total_count: 280 - incomplete_results: false - search_type: hybrid - items: - - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 - repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit - labels_url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name} - comments_url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments - events_url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events - html_url: https://github.com/batterseapower/pinyin-toolkit/issues/132 - id: 35802 - node_id: MDU6SXNzdWUzNTgwMg== - number: 132 - title: Line Number Indexes Beyond 20 Not Displayed - user: - login: Nick3C - id: 90254 - node_id: MDQ6VXNlcjkwMjU0 - avatar_url: https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png - gravatar_id: '' - url: https://api.github.com/users/Nick3C - html_url: https://github.com/Nick3C - followers_url: https://api.github.com/users/Nick3C/followers - following_url: https://api.github.com/users/Nick3C/following{/other_user} - gists_url: https://api.github.com/users/Nick3C/gists{/gist_id} - starred_url: https://api.github.com/users/Nick3C/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Nick3C/subscriptions - organizations_url: https://api.github.com/users/Nick3C/orgs - repos_url: https://api.github.com/users/Nick3C/repos - events_url: https://api.github.com/users/Nick3C/events{/privacy} - received_events_url: https://api.github.com/users/Nick3C/received_events - type: User - site_admin: true - labels: - - id: 4 - node_id: MDU6TGFiZWw0 - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug - name: bug - color: ff0000 - state: open - assignee: - milestone: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 - html_url: https://github.com/octocat/Hello-World/milestones/v1.0 - labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels - id: 1002604 - node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== - number: 1 - state: open - title: v1.0 - description: Tracking milestone for version 1.0 - creator: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - open_issues: 4 - closed_issues: 8 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - closed_at: '2013-02-12T13:22:01Z' - due_on: '2012-10-09T23:39:01Z' - comments: 15 - created_at: '2009-07-12T20:10:41Z' - updated_at: '2009-07-19T09:23:43Z' - closed_at: - pull_request: - url: https://api/github.com/repos/octocat/Hello-World/pull/1347 - html_url: https://github.com/octocat/Hello-World/pull/1347 - diff_url: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 - body: "..." - score: 1 - locked: true - author_association: COLLABORATOR - state_reason: completed - lexical-fallback: - summary: Hybrid search with lexical fallback - description: When a hybrid or semantic search falls back to lexical, - the response includes search_type set to "lexical" and lexical_fallback_reason - listing the reasons. Items are the same shape as the default example. - value: - total_count: 280 - incomplete_results: false - search_type: lexical - lexical_fallback_reason: - - quoted_text - items: - - "..." - '503': *121 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/search/labels": - get: - summary: Search labels - description: |- - Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - - `q=bug+defect+enhancement&repository_id=64778136` - - The labels that best match the query appear first in the search results. - tags: - - search - operationId: search/labels - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-labels - parameters: - - name: repository_id - description: The id of the repository. - in: query - required: true - schema: - type: integer - - name: q - description: The search keywords. This endpoint does not accept qualifiers - in the query. To learn more about the format of the query, see [Constructing - a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - in: query - required: true - schema: - type: string - - name: sort - description: 'Sorts the results of your query by when the label was `created` - or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' - in: query - required: false - schema: - type: string - enum: - - created - - updated - - *677 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: Label Search Result Item - description: Label Search Result Item - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - format: uri - name: - type: string - color: - type: string - default: - type: boolean - description: - type: string - nullable: true - score: - type: number - text_matches: *676 - required: - - id - - node_id - - url - - name - - color - - default - - description - - score - examples: - default: - value: - total_count: 2 - incomplete_results: false - items: - - id: 418327088 - node_id: MDU6TGFiZWw0MTgzMjcwODg= - url: https://api.github.com/repos/octocat/linguist/labels/enhancement - name: enhancement - color: 84b6eb - default: true - description: New feature or request. - score: 1 - - id: 418327086 - node_id: MDU6TGFiZWw0MTgzMjcwODY= - url: https://api.github.com/repos/octocat/linguist/labels/bug - name: bug - color: ee0701 - default: true - description: Something isn't working. - score: 1 - '304': *37 - '404': *6 - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/search/repositories": - get: - summary: Search repositories - description: |- - Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - - `q=tetris+language:assembly&sort=stars&order=desc` - - This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - tags: - - search - operationId: search/repos - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-repositories - parameters: - - name: q - description: The query contains one or more search keywords and qualifiers. - Qualifiers allow you to limit your search to specific areas of GitHub. The - REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" - for a detailed list of qualifiers. - in: query - required: true - schema: - type: string - - name: sort - description: 'Sorts the results of your query by number of `stars`, `forks`, - or `help-wanted-issues` or how recently the items were `updated`. Default: - [best match](https://docs.github.com/rest/search/search#ranking-search-results)' - in: query - required: false - schema: - type: string - enum: - - stars - - forks - - help-wanted-issues - - updated - - *677 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: Repo Search Result Item - description: Repo Search Result Item - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - owner: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - private: - type: boolean - html_url: - type: string - format: uri - description: - type: string - nullable: true - fork: - type: boolean - url: - type: string - format: uri - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - pushed_at: - type: string - format: date-time - homepage: - type: string - format: uri - nullable: true - size: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - language: - type: string - nullable: true - forks_count: - type: integer - open_issues_count: - type: integer - master_branch: - type: string - default_branch: - type: string - score: - type: number - forks_url: - type: string - format: uri - keys_url: - type: string - collaborators_url: - type: string - teams_url: - type: string - format: uri - hooks_url: - type: string - format: uri - issue_events_url: - type: string - events_url: - type: string - format: uri - assignees_url: - type: string - branches_url: - type: string - tags_url: - type: string - format: uri - blobs_url: - type: string - git_tags_url: - type: string - git_refs_url: - type: string - trees_url: - type: string - statuses_url: - type: string - languages_url: - type: string - format: uri - stargazers_url: - type: string - format: uri - contributors_url: - type: string - format: uri - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - commits_url: - type: string - git_commits_url: - type: string - comments_url: - type: string - issue_comment_url: - type: string - contents_url: - type: string - compare_url: - type: string - merges_url: - type: string - format: uri - archive_url: - type: string - downloads_url: - type: string - format: uri - issues_url: - type: string - pulls_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - labels_url: - type: string - releases_url: - type: string - deployments_url: - type: string - format: uri - git_url: - type: string - ssh_url: - type: string - clone_url: - type: string - svn_url: - type: string - format: uri - forks: - type: integer - open_issues: - type: integer - watchers: - type: integer - topics: - type: array - items: - type: string - mirror_url: - type: string - format: uri - nullable: true - has_issues: - type: boolean - has_projects: - type: boolean - has_pages: - type: boolean - has_wiki: - type: boolean - has_downloads: - type: boolean - has_discussions: - type: boolean - has_pull_requests: - type: boolean - pull_request_creation_policy: - description: 'The policy controlling who can create pull - requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - archived: - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, - or internal.' - type: string - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - text_matches: *676 - temp_clone_token: - type: string - allow_merge_commit: - type: boolean - allow_squash_merge: - type: boolean - allow_rebase_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_forking: - type: boolean - is_template: - type: boolean - web_commit_signoff_required: - type: boolean - example: false - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - - score - examples: - default: - value: - total_count: 40 - incomplete_results: false - items: - - id: 3081286 - node_id: MDEwOlJlcG9zaXRvcnkzMDgxMjg2 - name: Tetris - full_name: dtrupenn/Tetris - owner: - login: dtrupenn - id: 872147 - node_id: MDQ6VXNlcjg3MjE0Nw== - avatar_url: https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png - gravatar_id: '' - url: https://api.github.com/users/dtrupenn - received_events_url: https://api.github.com/users/dtrupenn/received_events - type: User - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - site_admin: true - private: false - html_url: https://github.com/dtrupenn/Tetris - description: A C implementation of Tetris using Pennsim through - LC4 - fork: false - url: https://api.github.com/repos/dtrupenn/Tetris - created_at: '2012-01-01T00:31:50Z' - updated_at: '2013-01-05T17:58:47Z' - pushed_at: '2012-01-01T00:37:02Z' - homepage: https://github.com - size: 524 - stargazers_count: 1 - watchers_count: 1 - language: Assembly - forks_count: 0 - open_issues_count: 0 - master_branch: master - default_branch: master - score: 1 - archive_url: https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/dtrupenn/Tetris/assignees{/user} - blobs_url: https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha} - branches_url: https://api.github.com/repos/dtrupenn/Tetris/branches{/branch} - collaborators_url: https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator} - comments_url: https://api.github.com/repos/dtrupenn/Tetris/comments{/number} - commits_url: https://api.github.com/repos/dtrupenn/Tetris/commits{/sha} - compare_url: https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head} - contents_url: https://api.github.com/repos/dtrupenn/Tetris/contents/{+path} - contributors_url: https://api.github.com/repos/dtrupenn/Tetris/contributors - deployments_url: https://api.github.com/repos/dtrupenn/Tetris/deployments - downloads_url: https://api.github.com/repos/dtrupenn/Tetris/downloads - events_url: https://api.github.com/repos/dtrupenn/Tetris/events - forks_url: https://api.github.com/repos/dtrupenn/Tetris/forks - git_commits_url: https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha} - git_refs_url: https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha} - git_tags_url: https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha} - git_url: git:github.com/dtrupenn/Tetris.git - issue_comment_url: https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number} - issue_events_url: https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number} - issues_url: https://api.github.com/repos/dtrupenn/Tetris/issues{/number} - keys_url: https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id} - labels_url: https://api.github.com/repos/dtrupenn/Tetris/labels{/name} - languages_url: https://api.github.com/repos/dtrupenn/Tetris/languages - merges_url: https://api.github.com/repos/dtrupenn/Tetris/merges - milestones_url: https://api.github.com/repos/dtrupenn/Tetris/milestones{/number} - notifications_url: https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/dtrupenn/Tetris/pulls{/number} - releases_url: https://api.github.com/repos/dtrupenn/Tetris/releases{/id} - ssh_url: git@github.com:dtrupenn/Tetris.git - stargazers_url: https://api.github.com/repos/dtrupenn/Tetris/stargazers - statuses_url: https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha} - subscribers_url: https://api.github.com/repos/dtrupenn/Tetris/subscribers - subscription_url: https://api.github.com/repos/dtrupenn/Tetris/subscription - tags_url: https://api.github.com/repos/dtrupenn/Tetris/tags - teams_url: https://api.github.com/repos/dtrupenn/Tetris/teams - trees_url: https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha} - clone_url: https://github.com/dtrupenn/Tetris.git - mirror_url: git:git.example.com/dtrupenn/Tetris - hooks_url: https://api.github.com/repos/dtrupenn/Tetris/hooks - svn_url: https://svn.github.com/dtrupenn/Tetris - forks: 1 - open_issues: 1 - watchers: 1 - has_issues: true - has_projects: true - has_pages: true - has_wiki: true - has_downloads: true - archived: true - disabled: true - visibility: private - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - '503': *121 - '422': *15 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/search/topics": - get: - summary: Search topics - description: |- - Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. - - When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - - `q=ruby+is:featured` - - This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - tags: - - search - operationId: search/topics - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-topics - parameters: - - name: q - description: The query contains one or more search keywords and qualifiers. - Qualifiers allow you to limit your search to specific areas of GitHub. The - REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - in: query - required: true - schema: - type: string - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: Topic Search Result Item - description: Topic Search Result Item - type: object - properties: - name: - type: string - display_name: - type: string - nullable: true - short_description: - type: string - nullable: true - description: - type: string - nullable: true - created_by: - type: string - nullable: true - released: - type: string - nullable: true - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - featured: - type: boolean - curated: - type: boolean - score: - type: number - repository_count: - type: integer - nullable: true - logo_url: - type: string - format: uri - nullable: true - text_matches: *676 - related: - type: array - nullable: true - items: - type: object - properties: - topic_relation: - type: object - properties: - id: - type: integer - name: - type: string - topic_id: - type: integer - relation_type: - type: string - aliases: - type: array - nullable: true - items: - type: object - properties: - topic_relation: - type: object - properties: - id: - type: integer - name: - type: string - topic_id: - type: integer - relation_type: - type: string - required: - - name - - display_name - - short_description - - description - - created_by - - released - - created_at - - updated_at - - featured - - curated - - score - examples: - default: - value: - total_count: 6 - incomplete_results: false - items: - - name: ruby - display_name: Ruby - short_description: Ruby is a scripting language designed for - simplified object-oriented programming. - description: Ruby was developed byΒ Yukihiro "Matz" MatsumotoΒ in - 1995 with the intent of having an easily readable programming - language. It is integrated with the Rails framework to create - dynamic web-applications. Ruby's syntax is similar to that - of Perl and Python. - created_by: Yukihiro Matsumoto - released: December 21, 1995 - created_at: '2016-11-28T22:03:59Z' - updated_at: '2017-10-30T18:16:32Z' - featured: true - curated: true - score: 1 - - name: rails - display_name: Rails - short_description: Ruby on Rails (Rails) is a web application - framework written in Ruby. - description: Ruby on Rails (Rails) is a web application framework - written in Ruby. It is meant to help simplify the building - of complex websites. - created_by: David Heinemeier Hansson - released: December 13 2005 - created_at: '2016-12-09T17:03:50Z' - updated_at: '2017-10-30T16:20:19Z' - featured: true - curated: true - score: 1 - - name: python - display_name: Python - short_description: Python is a dynamically typed programming - language. - description: Python is a dynamically typed programming language - designed by Guido Van Rossum. Much like the programming language - Ruby, Python was designed to be easily read by programmers. - Because of its large following and many libraries, Python - can be implemented and used to do anything from webpages to - scientific research. - created_by: Guido van Rossum - released: February 20, 1991 - created_at: '2016-12-07T00:07:02Z' - updated_at: '2017-10-27T22:45:43Z' - featured: true - curated: true - score: 1 - - name: jekyll - display_name: Jekyll - short_description: Jekyll is a simple, blog-aware static site - generator. - description: Jekyll is a blog-aware, site generator written - in Ruby. It takes raw text files, runs it through a renderer - and produces a publishable static website. - created_by: Tom Preston-Werner - released: '2008' - created_at: '2016-12-16T21:53:08Z' - updated_at: '2017-10-27T19:00:24Z' - featured: true - curated: true - score: 1 - - name: sass - display_name: Sass - short_description: Sass is a stable extension to classic CSS. - description: Sass is a stylesheet language with a main implementation - in Ruby. It is an extension of CSS that makes improvements - to the old stylesheet format, such as being able to declare - variables and using a cleaner nesting syntax. - created_by: Hampton Catlin, Natalie Weizenbaum, Chris Eppstein - released: November 28, 2006 - created_at: '2016-12-16T21:53:45Z' - updated_at: '2018-01-16T16:30:40Z' - featured: true - curated: true - score: 1 - - name: homebrew - display_name: Homebrew - short_description: Homebrew is a package manager for macOS. - description: Homebrew is a package manager for Apple's macOS - operating system. It simplifies the installation of software - and is popular in the Ruby on Rails community. - created_by: Max Howell - released: '2009' - created_at: '2016-12-17T20:30:44Z' - updated_at: '2018-02-06T16:14:56Z' - featured: true - curated: true - score: 1 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/search/users": - get: - summary: Search users - description: |- - Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - - When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - - For example, if you're looking for a list of popular users, you might try this query: - - `q=tom+repos:%3E42+followers:%3E1000` - - This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - - This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." - tags: - - search - operationId: search/users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/search/search#search-users - parameters: - - name: q - description: The query contains one or more search keywords and qualifiers. - Qualifiers allow you to limit your search to specific areas of GitHub. The - REST API supports the same qualifiers as the web interface for GitHub. To - learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). - See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" - for a detailed list of qualifiers. - in: query - required: true - schema: - type: string - - name: sort - description: 'Sorts the results of your query by number of `followers` or - `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' - in: query - required: false - schema: - type: string - enum: - - followers - - repositories - - joined - - *677 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - incomplete_results - - items - properties: - total_count: - type: integer - incomplete_results: - type: boolean - items: - type: array - items: - title: User Search Result Item - description: User Search Result Item - type: object - properties: - login: - type: string - id: - type: integer - format: int64 - node_id: - type: string - avatar_url: - type: string - format: uri - gravatar_id: - type: string - nullable: true - url: - type: string - format: uri - html_url: - type: string - format: uri - followers_url: - type: string - format: uri - subscriptions_url: - type: string - format: uri - organizations_url: - type: string - format: uri - repos_url: - type: string - format: uri - received_events_url: - type: string - format: uri - type: - type: string - score: - type: number - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - events_url: - type: string - public_repos: - type: integer - public_gists: - type: integer - followers: - type: integer - following: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - name: - type: string - nullable: true - bio: - type: string - nullable: true - email: - type: string - format: email - nullable: true - location: - type: string - nullable: true - site_admin: - type: boolean - hireable: - type: boolean - nullable: true - text_matches: *676 - blog: - type: string - nullable: true - company: - type: string - nullable: true - suspended_at: - type: string - format: date-time - nullable: true - user_view_type: - type: string - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - - score - examples: - default: - value: - total_count: 12 - incomplete_results: false - items: - - login: mojombo - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png - gravatar_id: '' - url: https://api.github.com/users/mojombo - html_url: https://github.com/mojombo - followers_url: https://api.github.com/users/mojombo/followers - subscriptions_url: https://api.github.com/users/mojombo/subscriptions - organizations_url: https://api.github.com/users/mojombo/orgs - repos_url: https://api.github.com/users/mojombo/repos - received_events_url: https://api.github.com/users/mojombo/received_events - type: User - score: 1 - following_url: https://api.github.com/users/mojombo/following{/other_user} - gists_url: https://api.github.com/users/mojombo/gists{/gist_id} - starred_url: https://api.github.com/users/mojombo/starred{/owner}{/repo} - events_url: https://api.github.com/users/mojombo/events{/privacy} - site_admin: true - '304': *37 - '503': *121 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: search - subcategory: search - "/teams/{team_id}": - get: - summary: Get a team (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. - tags: - - teams - operationId: teams/get-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#get-a-team-legacy - parameters: - - &680 - name: team_id - description: The unique identifier of the team. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *340 - examples: - default: *341 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - patch: - summary: Update a team (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. - - To edit a team, the authenticated user must either be an organization owner or a team maintainer. - - > [!NOTE] - > With nested teams, the `privacy` for parent teams cannot be `secret`. - tags: - - teams - operationId: teams/update-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#update-a-team-legacy - parameters: - - *680 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the team. - description: - type: string - description: The description of the team. - privacy: - type: string - description: "The level of privacy this team should have. Editing - teams without specifying this parameter leaves `privacy` intact. - The options are: \n**For a non-nested team:** \n * `secret` - - only visible to organization owners and members of this team. - \ \n * `closed` - visible to all members of this organization. - \ \n**For a parent or child team:** \n * `closed` - visible to - all members of this organization." - enum: - - secret - - closed - notification_setting: - type: string - description: "The notification setting the team has chosen. Editing - teams without specifying this parameter leaves `notification_setting` - intact. The options are: \n * `notifications_enabled` - team members - receive notifications when the team is @mentioned. \n * `notifications_disabled` - - no one receives notifications." - enum: - - notifications_enabled - - notifications_disabled - permission: - type: string - description: "**Closing down notice**. The permission that new repositories - will be added to the team with when none is specified." - enum: - - pull - - push - - admin - default: pull - parent_team_id: - type: integer - description: The ID of a team to set as the parent team. - nullable: true - required: - - name - examples: - default: - value: - name: new team name - description: new team description - privacy: closed - notification_setting: notifications_enabled - responses: - '200': - description: Response when the updated information already exists - content: - application/json: - schema: *340 - examples: - default: *341 - '201': - description: Response - content: - application/json: - schema: *340 - examples: - default: *341 - '404': *6 - '422': *15 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Delete a team (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. - - To delete a team, the authenticated user must be an organization owner or team maintainer. - - If you are an organization owner, deleting a parent team will delete all of its child teams as well. - tags: - - teams - operationId: teams/delete-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy - parameters: - - *680 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/invitations": - get: - summary: List pending team invitations (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. - - The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - tags: - - teams - operationId: teams/list-pending-invitations-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy - parameters: - - *680 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *237 - examples: - default: *238 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - "/teams/{team_id}/members": - get: - summary: List team members (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. - - Team members will include the members of child teams. - tags: - - teams - operationId: teams/list-members-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#list-team-members-legacy - parameters: - - *680 - - name: role - description: Filters members returned by their role in the team. - in: query - required: false - schema: - type: string - enum: - - member - - maintainer - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - "/teams/{team_id}/members/{username}": - get: - summary: Get team member (Legacy) - description: |- - The "Get team member" endpoint (described below) is closing down. - - We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - - To list members in a team, the team must be visible to the authenticated user. - tags: - - teams - operationId: teams/get-member-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#get-team-member-legacy - parameters: - - *680 - - *71 - responses: - '204': - description: if user is a member - '404': - description: if user is not a member - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - put: - summary: Add team member (Legacy) - description: |- - The "Add team member" endpoint (described below) is closing down. - - We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - - > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - tags: - - teams - operationId: teams/add-member-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#add-team-member-legacy - parameters: - - *680 - - *71 - responses: - '204': - description: Response - '404': - description: Not Found if team synchronization is set up - '422': - description: Unprocessable Entity if you attempt to add an organization - to a team or you attempt to add a user to a team when they are not a member - of at least one other team in the same organization - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - delete: - summary: Remove team member (Legacy) - description: |- - The "Remove team member" endpoint (described below) is closing down. - - We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - - > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - tags: - - teams - operationId: teams/remove-member-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#remove-team-member-legacy - parameters: - - *680 - - *71 - responses: - '204': - description: Response - '404': - description: Not Found if team synchronization is setup - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - "/teams/{team_id}/memberships/{username}": - get: - summary: Get team membership for a user (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. - - Team members will include the members of child teams. - - To get a user's membership with a team, the team must be visible to the authenticated user. - - **Note:** - The response contains the `state` of the membership and the member's `role`. - - The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). - tags: - - teams - operationId: teams/get-membership-for-user-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy - parameters: - - *680 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: *343 - examples: - response-if-user-is-a-team-maintainer: *681 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - put: - summary: Add or update team membership for a user (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - - > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - - If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - - If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - tags: - - teams - operationId: teams/add-or-update-membership-for-user-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy - parameters: - - *680 - - *71 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - role: - type: string - description: The role that this user should have in the team. - enum: - - member - - maintainer - default: member - examples: - default: - summary: Assign the member role for a user in a team - value: - role: member - responses: - '200': - description: Response - content: - application/json: - schema: *343 - examples: - response-if-users-membership-with-team-is-now-pending: *682 - '403': - description: Forbidden if team synchronization is set up - '422': - description: Unprocessable Entity if you attempt to add an organization - to a team - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - delete: - summary: Remove team membership for a user (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. - - Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - - To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - - > [!NOTE] - > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - tags: - - teams - operationId: teams/remove-membership-for-user-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy - parameters: - - *680 - - *71 - responses: - '204': - description: Response - '403': - description: if team synchronization is set up - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: members - deprecated: true - "/teams/{team_id}/repos": - get: - summary: List team repositories (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. - tags: - - teams - operationId: teams/list-repos-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy - parameters: - - *680 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/repos/{owner}/{repo}": - get: - summary: Check team permissions for a repository (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - - > [!NOTE] - > Repositories inherited through a parent team will also be checked. - - You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: - tags: - - teams - operationId: teams/check-permissions-for-repo-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy - parameters: - - *680 - - *344 - - *345 - responses: - '200': - description: Alternative response with extra repository information - content: - application/json: - schema: *683 - examples: - alternative-response-with-extra-repository-information: - value: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - maintain: false - push: false - triage: false - pull: true - role_name: read - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - '204': - description: Response if repository is managed by this team - '404': - description: Not Found if repository is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team repository permissions (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - - To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - tags: - - teams - operationId: teams/add-or-update-repo-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy - parameters: - - *680 - - *344 - - *345 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: The permission to grant the team on this repository. - If no permission is specified, the team's `permission` attribute - will be used to determine what permission to grant the team on - this repository. - enum: - - pull - - push - - admin - examples: - default: - summary: Example of setting permission to pull - value: - permission: push - responses: - '204': - description: Response - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a repository from a team (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. - - If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - tags: - - teams - operationId: teams/remove-repo-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy - parameters: - - *680 - - *344 - - *345 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/teams": - get: - summary: List child teams (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. - tags: - - teams - operationId: teams/list-child-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy - parameters: - - *680 - - *17 - - *19 - responses: - '200': - description: if child teams exist - content: - application/json: - schema: - type: array - items: *197 - examples: - response-if-child-teams-exist: *684 - headers: - Link: *67 - '404': *6 - '403': *29 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - "/user": - get: - summary: Get the authenticated user - description: OAuth app tokens and personal access tokens (classic) need the - `user` scope in order for the response to include private profile information. - tags: - - users - operationId: users/get-authenticated - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/users#get-the-authenticated-user - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - oneOf: - - &686 - title: Private User - description: Private User - type: object - properties: - login: - type: string - example: octocat - id: - type: integer - format: int64 - example: 1 - user_view_type: - type: string - node_id: - type: string - example: MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - gravatar_id: - type: string - example: 41d064eb2195891e12d0413f63227ea7 - nullable: true - url: - type: string - format: uri - example: https://api.github.com/users/octocat - html_url: - type: string - format: uri - example: https://github.com/octocat - followers_url: - type: string - format: uri - example: https://api.github.com/users/octocat/followers - following_url: - type: string - example: https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - example: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: - type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: - type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: - type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: - type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: - type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: - type: string - format: uri - example: https://api.github.com/users/octocat/received_events - type: - type: string - example: User - site_admin: - type: boolean - name: - type: string - example: monalisa octocat - nullable: true - company: - type: string - example: GitHub - nullable: true - blog: - type: string - example: https://github.com/blog - nullable: true - location: - type: string - example: San Francisco - nullable: true - email: - type: string - format: email - example: octocat@github.com - nullable: true - notification_email: - type: string - format: email - example: octocat@github.com - nullable: true - hireable: - type: boolean - nullable: true - bio: - type: string - example: There once was... - nullable: true - twitter_username: - type: string - example: monalisa - nullable: true - public_repos: - type: integer - example: 2 - public_gists: - type: integer - example: 1 - followers: - type: integer - example: 20 - following: - type: integer - example: 0 - created_at: - type: string - format: date-time - example: '2008-01-14T04:33:35Z' - updated_at: - type: string - format: date-time - example: '2008-01-14T04:33:35Z' - private_gists: - type: integer - example: 81 - total_private_repos: - type: integer - example: 100 - owned_private_repos: - type: integer - example: 100 - disk_usage: - type: integer - example: 10000 - collaborators: - type: integer - example: 8 - two_factor_authentication: - type: boolean - example: true - plan: - type: object - properties: - collaborators: - type: integer - name: - type: string - space: - type: integer - private_repos: - type: integer - required: - - collaborators - - name - - space - - private_repos - business_plus: - type: boolean - ldap_dn: - type: string - required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - - id - - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - - bio - - blog - - company - - email - - followers - - following - - hireable - - location - - name - - public_gists - - public_repos - - created_at - - updated_at - - collaborators - - disk_usage - - owned_private_repos - - private_gists - - total_private_repos - - two_factor_authentication - - *685 - examples: - response-with-public-and-private-profile-information: - summary: Response with public and private profile information - value: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - name: monalisa octocat - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - hireable: false - bio: There once was... - twitter_username: monatheoctocat - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - created_at: '2008-01-14T04:33:35Z' - updated_at: '2008-01-14T04:33:35Z' - private_gists: 81 - total_private_repos: 100 - owned_private_repos: 100 - disk_usage: 10000 - collaborators: 8 - two_factor_authentication: true - plan: - name: Medium - space: 400 - private_repos: 20 - collaborators: 0 - response-with-public-profile-information: - summary: Response with public profile information - value: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - name: monalisa octocat - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - hireable: false - bio: There once was... - twitter_username: monatheoctocat - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - created_at: '2008-01-14T04:33:35Z' - updated_at: '2008-01-14T04:33:35Z' - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: users - patch: - summary: Update the authenticated user - description: "**Note:** If your email is set to private and you send an `email` - parameter as part of this request to update your profile, your privacy settings - are still enforced: the email address will not be displayed on your public - profile or via the API." - tags: - - users - operationId: users/update-authenticated - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/users#update-the-authenticated-user - parameters: [] - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - description: The new name of the user. - type: string - example: Omar Jahandar - email: - description: The publicly visible email address of the user. - type: string - example: omar@example.com - blog: - description: The new blog URL of the user. - type: string - example: blog.example.com - twitter_username: - description: The new Twitter username of the user. - type: string - example: therealomarj - nullable: true - company: - description: The new company of the user. - type: string - example: Acme corporation - location: - description: The new location of the user. - type: string - example: Berlin, Germany - hireable: - description: The new hiring availability of the user. - type: boolean - bio: - description: The new short biography of the user. - type: string - examples: - default: - summary: Example of updating blog and name - value: - blog: https://github.com/blog - name: monalisa octocat - responses: - '200': - description: Response - content: - application/json: - schema: *686 - examples: - default: - value: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - name: monalisa octocat - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - hireable: false - bio: There once was... - twitter_username: monatheoctocat - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - created_at: '2008-01-14T04:33:35Z' - updated_at: '2008-01-14T04:33:35Z' - private_gists: 81 - total_private_repos: 100 - owned_private_repos: 100 - disk_usage: 10000 - collaborators: 8 - two_factor_authentication: true - plan: - name: Medium - space: 400 - private_repos: 20 - collaborators: 0 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: users - "/user/blocks": - get: - summary: List users blocked by the authenticated user - description: List the users you've blocked on your personal account. - tags: - - users - operationId: users/list-blocked-by-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: blocking - "/user/blocks/{username}": - get: - summary: Check if a user is blocked by the authenticated user - description: Returns a 204 if the given user is blocked by the authenticated - user. Returns a 404 if the given user is not blocked by the authenticated - user, or if the given user account has been identified as spam by GitHub. - tags: - - users - operationId: users/check-blocked - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user - parameters: - - *71 - responses: - '204': - description: If the user is blocked - '404': - description: If the user is not blocked - content: - application/json: - schema: *3 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: blocking - put: - summary: Block a user - description: Blocks the given user and returns a 204. If the authenticated user - cannot block the given user a 422 is returned. - tags: - - users - operationId: users/block - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/blocking#block-a-user - parameters: - - *71 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: blocking - delete: - summary: Unblock a user - description: Unblocks the given user and returns a 204. - tags: - - users - operationId: users/unblock - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/blocking#unblock-a-user - parameters: - - *71 - responses: - '204': - description: Response - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: blocking - "/user/codespaces": - get: - summary: List codespaces for the authenticated user - description: |- - Lists the authenticated user's codespaces. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user - parameters: - - *17 - - *19 - - name: repository_id - description: ID of the Repository to filter on - in: query - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - codespaces - properties: - total_count: - type: integer - codespaces: - type: array - items: *248 - examples: - default: *249 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - post: - summary: Create a codespace for the authenticated user - description: |- - Creates a new codespace, owned by the authenticated user. - - This endpoint requires either a `repository_id` OR a `pull_request` but not both. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - required: - - repository_id - properties: - repository_id: - description: Repository id for this codespace - type: integer - ref: - description: Git ref (typically a branch name) for this codespace - type: string - location: - description: The requested location for a new codespace. Best - efforts are made to respect this upon creation. Assigned by - IP if not provided. - type: string - geo: - description: The geographic area for this codespace. If not specified, - the value is assigned by IP. This property replaces `location`, - which is closing down. - type: string - enum: - - EuropeWest - - SoutheastAsia - - UsEast - - UsWest - client_ip: - description: IP for location auto-detection when proxying a request - type: string - machine: - description: Machine type to use for this codespace - type: string - devcontainer_path: - description: Path to devcontainer.json config to use for this - codespace - type: string - multi_repo_permissions_opt_out: - description: Whether to authorize requested permissions from devcontainer.json - type: boolean - working_directory: - description: Working directory for this codespace - type: string - idle_timeout_minutes: - description: Time in minutes before codespace stops from inactivity - type: integer - display_name: - description: Display name for this codespace - type: string - retention_period_minutes: - description: Duration in minutes after codespace has gone idle - in which it will be deleted. Must be integer minutes between - 0 and 43200 (30 days). - type: integer - - type: object - required: - - pull_request - properties: - pull_request: - required: - - pull_request_number - - repository_id - description: Pull request number for this codespace - type: object - properties: - pull_request_number: - description: Pull request number - type: integer - repository_id: - description: Repository id for this codespace - type: integer - location: - description: The requested location for a new codespace. Best - efforts are made to respect this upon creation. Assigned by - IP if not provided. - type: string - geo: - description: The geographic area for this codespace. If not specified, - the value is assigned by IP. This property replaces `location`, - which is closing down. - type: string - enum: - - EuropeWest - - SoutheastAsia - - UsEast - - UsWest - machine: - description: Machine type to use for this codespace - type: string - devcontainer_path: - description: Path to devcontainer.json config to use for this - codespace - type: string - working_directory: - description: Working directory for this codespace - type: string - idle_timeout_minutes: - description: Time in minutes before codespace stops from inactivity - type: integer - examples: - default: - value: - repository_id: 1 - ref: main - geo: UsWest - responses: - '201': - description: Response when the codespace was successfully created - content: - application/json: - schema: *248 - examples: - default: *465 - '202': - description: Response when the codespace creation partially failed but is - being retried in the background - content: - application/json: - schema: *248 - examples: - default: *465 - '401': *25 - '403': *29 - '404': *6 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/user/codespaces/secrets": - get: - summary: List secrets for the authenticated user - description: |- - Lists all development environment secrets available for a user's codespaces without revealing their - encrypted values. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-secrets-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: &687 - title: Codespaces Secret - description: Secrets for a GitHub Codespace. - type: object - properties: - name: - description: The name of the secret - example: SECRET_NAME - type: string - created_at: - description: The date and time at which the secret was created, - in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - updated_at: - description: The date and time at which the secret was last - updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. - type: string - format: date-time - visibility: - description: The type of repositories in the organization - that the secret is visible to - enum: - - all - - private - - selected - type: string - selected_repositories_url: - description: The API URL at which the list of repositories - this secret is visible to can be retrieved - type: string - format: uri - example: https://api.github.com/user/secrets/SECRET_NAME/repositories - required: - - name - - created_at - - updated_at - - visibility - - selected_repositories_url - examples: - default: *468 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - "/user/codespaces/secrets/public-key": - get: - summary: Get public key for the authenticated user - description: |- - Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-public-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user - responses: - '200': - description: Response - content: - application/json: - schema: - title: CodespacesUserPublicKey - description: The public key used for setting user Codespaces' Secrets. - type: object - properties: - key_id: - description: The identifier for the key. - type: string - example: '1234567' - key: - description: The Base64 encoded public key. - type: string - example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= - required: - - key_id - - key - examples: - default: - value: - key_id: '012345678912345678' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - "/user/codespaces/secrets/{secret_name}": - get: - summary: Get a secret for the authenticated user - description: |- - Gets a development environment secret available to a user's codespaces without revealing its encrypted value. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user - parameters: - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: *687 - examples: - default: - value: - name: CODESPACE_GH_SECRET - created_at: '2019-08-10T14:59:22Z' - updated_at: '2020-01-10T14:59:22Z' - visibility: selected - selected_repositories_url: https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - put: - summary: Create or update a secret for the authenticated user - description: |- - Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/create-or-update-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user - parameters: - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get the public key for - the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - selected_repository_ids: - type: array - description: An array of repository ids that can access the user - secret. You can manage the list of selected repositories using - the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), - [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), - and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) - endpoints. - items: - anyOf: - - type: integer - - type: string - required: - - key_id - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - selected_repository_ids: - - '1234567' - - '2345678' - responses: - '201': - description: Response after successfully creating a secret - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response after successfully updating a secret - '422': *15 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - delete: - summary: Delete a secret for the authenticated user - description: |- - Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/delete-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user - parameters: - - *168 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - "/user/codespaces/secrets/{secret_name}/repositories": - get: - summary: List selected repositories for a user secret - description: |- - List the repositories that have been granted the ability to use a user's development environment secret. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/list-repositories-for-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret - parameters: - - *168 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repositories: - type: array - items: *160 - examples: - default: *198 - '401': *25 - '403': *29 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - put: - summary: Set selected repositories for a user secret - description: |- - Select the repositories that will use a user's development environment secret. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/set-repositories-for-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret - parameters: - - *168 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - selected_repository_ids: - type: array - description: An array of repository ids for which a codespace can - access the secret. You can manage the list of selected repositories - using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), - [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), - and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) - endpoints. - items: - type: integer - required: - - selected_repository_ids - examples: - default: - value: - selected_repository_ids: - - '1296269' - - '1296280' - responses: - '204': - description: No Content when repositories were added to the selected list - '401': *25 - '403': *29 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": - put: - summary: Add a selected repository to a user secret - description: |- - Adds a repository to the selected repositories for a user's development environment secret. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/add-repository-for-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret - parameters: - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: No Content when repository was added to the selected list - '401': *25 - '403': *29 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - delete: - summary: Remove a selected repository from a user secret - description: |- - Removes a repository from the selected repositories for a user's development environment secret. - - The authenticated user must have Codespaces access to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/remove-repository-for-secret-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret - parameters: - - *168 - - name: repository_id - in: path - required: true - schema: - type: integer - responses: - '204': - description: No Content when repository was removed from the selected list - '401': *25 - '403': *29 - '404': *6 - '500': *55 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: secrets - "/user/codespaces/{codespace_name}": - get: - summary: Get a codespace for the authenticated user - description: |- - Gets information about a user's codespace. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user - parameters: - - *250 - responses: - '200': - description: Response - content: - application/json: - schema: *248 - examples: - default: *465 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - patch: - summary: Update a codespace for the authenticated user - description: |- - Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. - - If you specify a new machine type it will be applied the next time your codespace is started. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/update-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user - parameters: - - *250 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - machine: - description: A valid machine to transition this codespace to. - type: string - display_name: - description: Display name for this codespace - type: string - recent_folders: - description: Recently opened folders inside the codespace. It is - currently used by the clients to determine the folder path to - load the codespace in. - type: array - items: - type: string - examples: - default: - value: - machine: standardLinux - responses: - '200': - description: Response - content: - application/json: - schema: *248 - examples: - default: *465 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - delete: - summary: Delete a codespace for the authenticated user - description: |- - Deletes a user's codespace. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/delete-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user - parameters: - - *250 - responses: - '202': *39 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/user/codespaces/{codespace_name}/exports": - post: - summary: Export a codespace for the authenticated user - description: |- - Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. - - If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/export-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user - parameters: - - *250 - responses: - '202': - description: Response - content: - application/json: - schema: &688 - type: object - title: Fetches information about an export of a codespace. - description: An export of a codespace. Also, latest export details - for a codespace can be fetched with id = latest - properties: - state: - type: string - description: State of the latest export - nullable: true - example: succeeded | failed | in_progress - completed_at: - description: Completion time of the last export operation - type: string - format: date-time - nullable: true - example: '2021-01-01T19:01:12Z' - branch: - type: string - description: Name of the exported branch - nullable: true - example: codespace-monalisa-octocat-hello-world-g4wpq6h95q - sha: - type: string - description: Git commit SHA of the exported branch - nullable: true - example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 - id: - type: string - description: Id for the export details - example: latest - export_url: - type: string - description: Url for fetching export details - example: https://api.github.com/user/codespaces/:name/exports/latest - html_url: - type: string - nullable: true - description: Web url for the exported branch - example: https://github.com/octocat/hello-world/tree/:branch - examples: - default: &689 - value: - state: succeeded - completed_at: '2022-01-01T14:59:22Z' - branch: codespace-monalisa-octocat-hello-world-g4wpq6h95q - sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 - id: latest - export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *55 - '401': *25 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/user/codespaces/{codespace_name}/exports/{export_id}": - get: - summary: Get details about a codespace export - description: |- - Gets information about an export of a codespace. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/get-export-details-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export - parameters: - - *250 - - name: export_id - in: path - required: true - description: The ID of the export operation, or `latest`. Currently only `latest` - is currently supported. - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *688 - examples: - default: *689 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/user/codespaces/{codespace_name}/machines": - get: - summary: List machine types for a codespace - description: |- - List the machine types a codespace can transition to use. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/codespace-machines-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace - parameters: - - *250 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - machines - properties: - total_count: - type: integer - machines: - type: array - items: *690 - examples: - default: *691 - '304': *37 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: machines - "/user/codespaces/{codespace_name}/publish": - post: - summary: Create a repository from an unpublished codespace - description: |- - Publishes an unpublished codespace, creating a new repository and assigning it to the codespace. - - The codespace's token is granted write permissions to the repository, allowing the user to push their changes. - - This will fail for a codespace that is already published, meaning it has an associated repository. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/publish-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace - parameters: - - *250 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - description: A name for the new repository. - type: string - private: - description: Whether the new repository should be private. - type: boolean - default: false - examples: - default: - value: - repository: monalisa-octocat-hello-world-g4wpq6h95q - private: false - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - title: Codespace - description: A codespace. - properties: - id: - type: integer - format: int64 - example: 1 - name: - description: Automatically generated name of this codespace. - type: string - example: monalisa-octocat-hello-world-g4wpq6h95q - display_name: - description: Display name for this codespace. - type: string - example: bookish space pancake - nullable: true - environment_id: - description: UUID identifying this codespace's environment. - type: string - example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 - nullable: true - owner: *4 - billable_owner: *4 - repository: *347 - machine: - type: object - title: Codespace machine - description: A description of the machine powering a codespace. - properties: *466 - required: *467 - nullable: true - devcontainer_path: - description: Path to devcontainer.json from repo root used to - create Codespace. - type: string - example: ".devcontainer/example/devcontainer.json" - nullable: true - prebuild: - description: Whether the codespace was created from a prebuild. - type: boolean - example: false - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - last_used_at: - description: Last known time this codespace was started. - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - state: - description: State of this codespace. - enum: - - Unknown - - Created - - Queued - - Provisioning - - Available - - Awaiting - - Unavailable - - Deleted - - Moved - - Shutdown - - Archived - - Starting - - ShuttingDown - - Failed - - Exporting - - Updating - - Rebuilding - example: Available - type: string - url: - description: API URL for this codespace. - type: string - format: uri - git_status: - description: Details about the codespace's git repository. - type: object - properties: - ahead: - description: The number of commits the local repository is - ahead of the remote. - type: integer - example: 0 - behind: - description: The number of commits the local repository is - behind the remote. - type: integer - example: 0 - has_unpushed_changes: - description: Whether the local repository has unpushed changes. - type: boolean - has_uncommitted_changes: - description: Whether the local repository has uncommitted - changes. - type: boolean - ref: - description: The current branch (or SHA if in detached HEAD - state) of the local repository. - type: string - example: main - location: - description: The initally assigned location of a new codespace. - enum: - - EastUs - - SouthEastAsia - - WestEurope - - WestUs2 - example: WestUs2 - type: string - idle_timeout_minutes: - description: The number of minutes of inactivity after which this - codespace will be automatically stopped. - type: integer - example: 60 - nullable: true - web_url: - description: URL to access this codespace on the web. - type: string - format: uri - machines_url: - description: API URL to access available alternate machine types - for this codespace. - type: string - format: uri - start_url: - description: API URL to start this codespace. - type: string - format: uri - stop_url: - description: API URL to stop this codespace. - type: string - format: uri - publish_url: - description: API URL to publish this codespace to a new repository. - type: string - format: uri - nullable: true - pulls_url: - description: API URL for the Pull Request associated with this - codespace, if any. - type: string - format: uri - nullable: true - recent_folders: - type: array - items: - type: string - runtime_constraints: - type: object - properties: - allowed_port_privacy_settings: - description: The privacy settings a user can select from when - forwarding a port. - type: array - items: - type: string - nullable: true - pending_operation: - description: Whether or not a codespace has a pending async operation. - This would mean that the codespace is temporarily unavailable. - The only thing that you can do with a codespace in this state - is delete it. - type: boolean - nullable: true - pending_operation_disabled_reason: - description: Text to show user when codespace is disabled by a - pending operation - type: string - nullable: true - idle_timeout_notice: - description: Text to show user when codespace idle timeout minutes - has been overriden by an organization policy - type: string - nullable: true - retention_period_minutes: - description: Duration in minutes after codespace has gone idle - in which it will be deleted. Must be integer minutes between - 0 and 43200 (30 days). - type: integer - example: 60 - nullable: true - retention_expires_at: - description: When a codespace will be auto-deleted based on the - "retention_period_minutes" and "last_used_at" - type: string - format: date-time - example: '2011-01-26T20:01:12Z' - nullable: true - required: - - id - - name - - environment_id - - owner - - billable_owner - - repository - - machine - - prebuild - - created_at - - updated_at - - last_used_at - - state - - url - - git_status - - location - - idle_timeout_minutes - - web_url - - machines_url - - start_url - - stop_url - - pulls_url - - recent_folders - examples: - default: - value: - id: 1 - name: monalisa-octocat-hello-world-g4wpq6h95q - environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - billable_owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - language: - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - push: false - admin: false - allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - allow_forking: true - subscribers_count: 42 - network_count: 0 - organization: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: Organization - site_admin: false - parent: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - source: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - machine: - name: standardLinux - display_name: 4 cores, 16 GB RAM, 64 GB storage - operating_system: linux - storage_in_bytes: 68719476736 - memory_in_bytes: 17179869184 - cpus: 4 - prebuild: false - devcontainer_path: ".devcontainer/devcontainer.json" - created_at: '2021-10-14T00:53:30-06:00' - updated_at: '2021-10-14T00:53:32-06:00' - last_used_at: '2021-10-14T00:53:30-06:00' - state: Available - url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q - git_status: - ahead: 0 - behind: 0 - has_unpushed_changes: false - has_uncommitted_changes: false - ref: main - location: WestUs2 - idle_timeout_minutes: 60 - retention_period_minutes: 43200 - retention_expires_at: - web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev - machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines - start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start - stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 - recent_folders: [] - template: - '401': *25 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - category: codespaces - subcategory: codespaces - "/user/codespaces/{codespace_name}/start": - post: - summary: Start a codespace for the authenticated user - description: |- - Starts a user's codespace. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/start-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user - parameters: - - *250 - responses: - '200': - description: Response - content: - application/json: - schema: *248 - examples: - default: *465 - '304': *37 - '500': *55 - '400': *14 - '401': *25 - '402': - description: Payment required - content: - application/json: - schema: *3 - '403': *29 - '404': *6 - '409': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/user/codespaces/{codespace_name}/stop": - post: - summary: Stop a codespace for the authenticated user - description: |- - Stops a user's codespace. - - OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - tags: - - codespaces - operationId: codespaces/stop-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user - parameters: - - *250 - responses: - '200': - description: Response - content: - application/json: - schema: *248 - examples: - default: *465 - '500': *55 - '401': *25 - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: codespaces - subcategory: codespaces - "/user/docker/conflicts": - get: - summary: Get list of conflicting packages during Docker migration for authenticated-user - description: |- - Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - tags: - - packages - operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *261 - examples: - default: &702 - value: - - id: 197 - name: hello_docker - package_type: container - owner: - login: octocat - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.octocatusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: User - site_admin: false - version_count: 1 - visibility: private - url: https://api.github.com/orgs/github/packages/container/hello_docker - created_at: '2020-05-19T22:19:11Z' - updated_at: '2020-05-19T22:19:11Z' - html_url: https://github.com/orgs/github/packages/container/package/hello_docker - - id: 198 - name: goodbye_docker - package_type: container - owner: - login: github - id: 9919 - node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= - avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/github - followers_url: https://api.github.com/users/github/followers - following_url: https://api.github.com/users/github/following{/other_user} - gists_url: https://api.github.com/users/github/gists{/gist_id} - starred_url: https://api.github.com/users/github/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/github/subscriptions - organizations_url: https://api.github.com/users/github/orgs - repos_url: https://api.github.com/users/github/repos - events_url: https://api.github.com/users/github/events{/privacy} - received_events_url: https://api.github.com/users/github/received_events - type: User - site_admin: false - version_count: 2 - visibility: private - url: https://api.github.com/user/octocat/packages/container/goodbye_docker - created_at: '2020-05-20T22:19:11Z' - updated_at: '2020-05-20T22:19:11Z' - html_url: https://github.com/user/octocat/packages/container/package/goodbye_docker - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/email/visibility": - patch: - summary: Set primary email visibility for the authenticated user - description: Sets the visibility for your primary email addresses. - tags: - - users - operationId: users/set-primary-email-visibility-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - visibility: - description: Denotes whether an email is publicly visible. - type: string - enum: - - public - - private - required: - - visibility - type: object - examples: - default: - summary: Example setting the primary email address to private - value: - visibility: private - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &692 - title: Email - description: Email - type: object - properties: - email: - type: string - format: email - example: octocat@github.com - primary: - type: boolean - example: true - verified: - type: boolean - example: true - visibility: - type: string - example: public - nullable: true - required: - - email - - primary - - verified - - visibility - examples: - default: - value: - - email: octocat@github.com - primary: true - verified: true - visibility: private - '304': *37 - '404': *6 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: emails - "/user/emails": - get: - summary: List email addresses for the authenticated user - description: |- - Lists all of your email addresses, and specifies which one is visible - to the public. - - OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - tags: - - users - operationId: users/list-emails-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *692 - examples: - default: &704 - value: - - email: octocat@github.com - verified: true - primary: true - visibility: public - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: emails - post: - summary: Add an email address for the authenticated user - description: OAuth app tokens and personal access tokens (classic) need the - `user` scope to use this endpoint. - tags: - - users - operationId: users/add-email-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user - parameters: [] - requestBody: - required: false - content: - application/json: - schema: - oneOf: - - type: object - properties: - emails: - description: Adds one or more email addresses to your GitHub account. - Must contain at least one email address. **Note:** Alternatively, - you can pass a single email address or an `array` of emails - addresses directly, but we recommend that you pass an object - using the `emails` key. - type: array - items: - type: string - example: username@example.com - minItems: 1 - example: [] - required: - - emails - example: - emails: - - octocat@github.com - - mona@github.com - - type: array - items: - type: string - example: username@example.com - minItems: 1 - - type: string - examples: - default: - summary: Example adding multiple email addresses - value: - emails: - - octocat@github.com - - mona@github.com - - octocat@octocat.org - responses: - '201': - description: Response - content: - application/json: - schema: - type: array - items: *692 - examples: - default: - value: - - email: octocat@octocat.org - primary: false - verified: false - visibility: public - - email: octocat@github.com - primary: false - verified: false - visibility: - - email: mona@github.com - primary: false - verified: false - visibility: - '422': *15 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: emails - delete: - summary: Delete an email address for the authenticated user - description: OAuth app tokens and personal access tokens (classic) need the - `user` scope to use this endpoint. - tags: - - users - operationId: users/delete-email-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user - parameters: [] - requestBody: - content: - application/json: - schema: - oneOf: - - type: object - description: Deletes one or more email addresses from your GitHub - account. Must contain at least one email address. **Note:** Alternatively, - you can pass a single email address or an `array` of emails addresses - directly, but we recommend that you pass an object using the `emails` - key. - properties: - emails: - description: Email addresses associated with the GitHub user account. - type: array - items: - type: string - example: username@example.com - minItems: 1 - example: - emails: - - octocat@github.com - - mona@github.com - required: - - emails - - type: array - items: - type: string - example: username@example.com - minItems: 1 - - type: string - examples: - default: - summary: Example deleting multiple email accounts - value: - emails: - - octocat@github.com - - mona@github.com - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: emails - "/user/followers": - get: - summary: List followers of the authenticated user - description: Lists the people following the authenticated user. - tags: - - users - operationId: users/list-followers-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: followers - "/user/following": - get: - summary: List the people the authenticated user follows - description: Lists the people who the authenticated user follows. - tags: - - users - operationId: users/list-followed-by-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: followers - "/user/following/{username}": - get: - summary: Check if a person is followed by the authenticated user - description: '' - tags: - - users - operationId: users/check-person-is-followed-by-authenticated - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user - parameters: - - *71 - responses: - '204': - description: if the person is followed by the authenticated user - '404': - description: if the person is not followed by the authenticated user - content: - application/json: - schema: *3 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: followers - put: - summary: Follow a user - description: |- - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - - OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - tags: - - users - operationId: users/follow - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#follow-a-user - parameters: - - *71 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: followers - delete: - summary: Unfollow a user - description: OAuth app tokens and personal access tokens (classic) need the - `user:follow` scope to use this endpoint. - tags: - - users - operationId: users/unfollow - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#unfollow-a-user - parameters: - - *71 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: followers - "/user/gpg_keys": - get: - summary: List GPG keys for the authenticated user - description: |- - Lists the current user's GPG keys. - - OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - tags: - - users - operationId: users/list-gpg-keys-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &693 - title: GPG Key - description: A unique encryption key - type: object - properties: - id: - type: integer - format: int64 - example: 3 - name: - type: string - example: Octocat's GPG Key - nullable: true - primary_key_id: - type: integer - nullable: true - key_id: - type: string - example: 3262EFF25BA0D270 - public_key: - type: string - example: xsBNBFayYZ... - emails: - type: array - example: - - email: octocat@users.noreply.github.com - verified: true - items: - type: object - properties: - email: - type: string - verified: - type: boolean - subkeys: - type: array - example: - - id: 4 - primary_key_id: 3 - key_id: 4A595D4C72EE49C7 - public_key: zsBNBFayYZ... - emails: [] - can_sign: false - can_encrypt_comms: true - can_encrypt_storage: true - can_certify: false - created_at: '2016-03-24T11:31:04-06:00' - expires_at: - revoked: false - items: - type: object - properties: - id: - type: integer - format: int64 - primary_key_id: - type: integer - key_id: - type: string - public_key: - type: string - emails: - type: array - items: - type: object - properties: - email: - type: string - verified: - type: boolean - subkeys: - type: array - items: {} - can_sign: - type: boolean - can_encrypt_comms: - type: boolean - can_encrypt_storage: - type: boolean - can_certify: - type: boolean - created_at: - type: string - expires_at: - type: string - nullable: true - raw_key: - type: string - nullable: true - revoked: - type: boolean - can_sign: - type: boolean - example: true - can_encrypt_comms: - type: boolean - can_encrypt_storage: - type: boolean - can_certify: - type: boolean - example: true - created_at: - type: string - format: date-time - example: '2016-03-24T11:31:04-06:00' - expires_at: - type: string - format: date-time - nullable: true - revoked: - type: boolean - example: true - raw_key: - type: string - nullable: true - required: - - id - - primary_key_id - - key_id - - raw_key - - public_key - - created_at - - expires_at - - can_sign - - can_encrypt_comms - - can_encrypt_storage - - can_certify - - emails - - subkeys - - revoked - examples: - default: &720 - value: - - id: 3 - name: Octocat's GPG Key - primary_key_id: 2 - key_id: 3262EFF25BA0D270 - public_key: xsBNBFayYZ... - emails: - - email: octocat@users.noreply.github.com - verified: true - subkeys: - - id: 4 - primary_key_id: 3 - key_id: 4A595D4C72EE49C7 - public_key: zsBNBFayYZ... - emails: [] - can_sign: false - can_encrypt_comms: true - can_encrypt_storage: true - can_certify: false - created_at: '2016-03-24T11:31:04-06:00' - expires_at: '2016-03-24T11:31:04-07:00' - revoked: false - can_sign: true - can_encrypt_comms: false - can_encrypt_storage: false - can_certify: true - created_at: '2016-03-24T11:31:04-06:00' - expires_at: '2016-03-24T11:31:04-07:00' - revoked: false - raw_key: string - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: gpg-keys - post: - summary: Create a GPG key for the authenticated user - description: |- - Adds a GPG key to the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - operationId: users/create-gpg-key-for-authenticated-user - tags: - - users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: A descriptive name for the new key. - type: string - armored_public_key: - description: A GPG key in ASCII-armored format. - type: string - type: object - required: - - armored_public_key - examples: - default: - value: - name: Octocat's GPG Key - armored_public_key: |- - -----BEGIN PGP PUBLIC KEY BLOCK----- - Version: GnuPG v1 - - mQINBFnZ2ZIBEADQ2Z7Z7 - -----END PGP PUBLIC KEY BLOCK----- - responses: - '201': - description: Response - content: - application/json: - schema: *693 - examples: - default: &694 - value: - id: 3 - name: Octocat's GPG Key - primary_key_id: 2 - key_id: 3262EFF25BA0D270 - public_key: xsBNBFayYZ... - emails: - - email: octocat@users.noreply.github.com - verified: true - subkeys: - - id: 4 - primary_key_id: 3 - key_id: 4A595D4C72EE49C7 - public_key: zsBNBFayYZ... - emails: [] - can_sign: false - can_encrypt_comms: true - can_encrypt_storage: true - can_certify: false - created_at: '2016-03-24T11:31:04-06:00' - expires_at: '2016-03-24T11:31:04-07:00' - revoked: false - can_sign: true - can_encrypt_comms: false - can_encrypt_storage: false - can_certify: true - created_at: '2016-03-24T11:31:04-06:00' - expires_at: '2016-03-24T11:31:04-07:00' - revoked: false - raw_key: '"-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG - v2\n\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\nIts/HFYRLiFgDLmTlxo=\n=+OzK\n-----END - PGP PUBLIC KEY BLOCK-----"' - '422': *15 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: gpg-keys - "/user/gpg_keys/{gpg_key_id}": - get: - summary: Get a GPG key for the authenticated user - description: |- - View extended details for a single GPG key. - - OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - tags: - - users - operationId: users/get-gpg-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user - parameters: - - &695 - name: gpg_key_id - description: The unique identifier of the GPG key. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *693 - examples: - default: *694 - '404': *6 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: gpg-keys - delete: - summary: Delete a GPG key for the authenticated user - description: |- - Removes a GPG key from the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. - tags: - - users - operationId: users/delete-gpg-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user - parameters: - - *695 - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: gpg-keys - "/user/installations": - get: - summary: List app installations accessible to the user access token - description: |- - Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - - The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - - You can find the permissions for the installation under the `permissions` key. - tags: - - apps - operationId: apps/list-installations-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token - parameters: - - *17 - - *19 - responses: - '200': - description: You can find the permissions for the installation under the - `permissions` key. - content: - application/json: - schema: - type: object - required: - - total_count - - installations - properties: - total_count: - type: integer - installations: - type: array - items: *22 - examples: - default: - value: - total_count: 2 - installations: - - id: 1 - account: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - single_file_name: config.yaml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - repository_selection: all - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - app_slug: github-actions - suspended_at: - suspended_by: - - id: 3 - account: - login: octocat - id: 2 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - access_tokens_url: https://api.github.com/app/installations/1/access_tokens - repositories_url: https://api.github.com/installation/repositories - html_url: https://github.com/organizations/github/settings/installations/1 - app_id: 1 - target_id: 1 - target_type: Organization - permissions: - checks: write - metadata: read - contents: read - events: - - push - - pull_request - single_file_name: config.yaml - has_multiple_single_files: true - single_file_paths: - - config.yml - - ".github/issue_TEMPLATE.md" - repository_selection: all - created_at: '2017-07-08T16:18:44-04:00' - updated_at: '2017-07-08T16:18:44-04:00' - app_slug: github-actions - suspended_at: - suspended_by: - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: installations - "/user/installations/{installation_id}/repositories": - get: - summary: List repositories accessible to the user access token - description: |- - List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - - The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - - The access the user has to each repository is included in the hash under the `permissions` key. - tags: - - apps - operationId: apps/list-installation-repos-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token - parameters: - - *23 - - *17 - - *19 - responses: - '200': - description: The access the user has to each repository is included in the - hash under the `permissions` key. - content: - application/json: - schema: - type: object - required: - - total_count - - repositories - properties: - total_count: - type: integer - repository_selection: - type: string - repositories: - type: array - items: - allOf: - - *79 - examples: - default: *152 - headers: - Link: *67 - '404': *6 - '403': *29 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: installations - "/user/installations/{installation_id}/repositories/{repository_id}": - put: - summary: Add a repository to an app installation - description: |- - Add a single repository to an installation. The authenticated user must have admin access to the repository. - - This endpoint only works for PATs (classic) with the `repo` scope. - tags: - - apps - operationId: apps/add-repo-to-installation-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation - parameters: - - *23 - - *149 - responses: - '204': - description: Response - '403': *29 - '304': *37 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: installations - delete: - summary: Remove a repository from an app installation - description: |- - Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - - This endpoint only works for PATs (classic) with the `repo` scope. - tags: - - apps - operationId: apps/remove-repo-from-installation-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation - parameters: - - *23 - - *149 - responses: - '204': - description: Response - '403': *29 - '304': *37 - '404': *6 - '422': - description: Returned when the application is installed on `all` repositories - in the organization, or if this request would remove the last repository - that the application has access to in the organization. - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: installations - "/user/interaction-limits": - get: - summary: Get interaction restrictions for your public repositories - description: Shows which type of GitHub user can interact with your public repositories - and when the restriction expires. - tags: - - interactions - operationId: interactions/get-restrictions-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories - responses: - '200': - description: Default response - content: - application/json: - schema: - anyOf: - - *235 - - type: object - properties: {} - additionalProperties: false - examples: - default: *236 - '204': - description: Response when there are no restrictions - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: interactions - subcategory: user - put: - summary: Set interaction restrictions for your public repositories - description: Temporarily restricts which type of GitHub user can interact with - your public repositories. Setting the interaction limit at the user level - will overwrite any interaction limits that are set for individual repositories - owned by the user. - tags: - - interactions - operationId: interactions/set-restrictions-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories - requestBody: - required: true - content: - application/json: - schema: *543 - examples: - default: - value: - limit: collaborators_only - expiry: one_month - responses: - '200': - description: Response - content: - application/json: - schema: *235 - examples: - default: - value: - limit: collaborators_only - origin: user - expires_at: '2018-08-17T04:18:39Z' - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: interactions - subcategory: user - delete: - summary: Remove interaction restrictions from your public repositories - description: Removes any interaction restrictions from your public repositories. - tags: - - interactions - operationId: interactions/remove-restrictions-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: interactions - subcategory: user - "/user/issues": - get: - summary: List user account issues assigned to the authenticated user - description: |- - List issues across owned and member repositories assigned to the authenticated user. - - > [!NOTE] - > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - tags: - - issues - operationId: issues/list-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user - parameters: - - name: filter - description: Indicates which sorts of issues to return. `assigned` means issues - assigned to you. `created` means issues created by you. `mentioned` means - issues mentioning you. `subscribed` means issues you're subscribed to updates - for. `all` or `repos` means all issues you can see, regardless of participation - or creation. - in: query - required: false - schema: - type: string - enum: - - assigned - - created - - mentioned - - subscribed - - repos - - all - default: assigned - - name: state - description: Indicates the state of the issues to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - *246 - - name: sort - description: What to sort results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - comments - default: created - - *61 - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *85 - examples: - default: *247 - headers: - Link: *67 - '404': *6 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: issues - subcategory: issues - "/user/keys": - get: - summary: List public SSH keys for the authenticated user - description: |- - Lists the public SSH keys for the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - tags: - - users - operationId: users/list-public-ssh-keys-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &696 - title: Key - description: Key - type: object - properties: - key: - type: string - id: - type: integer - format: int64 - url: - type: string - title: - type: string - created_at: - type: string - format: date-time - verified: - type: boolean - read_only: - type: boolean - last_used: - nullable: true - type: string - format: date-time - required: - - key - - id - - url - - title - - created_at - - verified - - read_only - examples: - default: - value: - - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - id: 2 - url: https://api.github.com/user/keys/2 - title: ssh-rsa AAAAB3NzaC1yc2EAAA - created_at: '2020-06-11T21:31:57Z' - verified: false - read_only: false - - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 - id: 3 - url: https://api.github.com/user/keys/3 - title: ssh-rsa AAAAB3NzaC1yc2EAAB - created_at: '2020-07-11T21:31:57Z' - verified: false - read_only: false - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: keys - post: - summary: Create a public SSH key for the authenticated user - description: |- - Adds a public SSH key to the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. - operationId: users/create-public-ssh-key-for-authenticated-user - tags: - - users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - title: - description: A descriptive name for the new key. - type: string - example: Personal MacBook Air - key: - description: The public SSH key to add to your GitHub account. - type: string - pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " - required: - - key - type: object - examples: - default: - value: - title: ssh-rsa AAAAB3NzaC1yc2EAAA - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - responses: - '201': - description: Response - content: - application/json: - schema: *696 - examples: - default: &697 - value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - id: 2 - url: https://api.github.com/user/keys/2 - title: ssh-rsa AAAAB3NzaC1yc2EAAA - created_at: '2020-06-11T21:31:57Z' - verified: false - read_only: false - '422': *15 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: keys - "/user/keys/{key_id}": - get: - summary: Get a public SSH key for the authenticated user - description: |- - View extended details for a single public SSH key. - - OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - tags: - - users - operationId: users/get-public-ssh-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user - parameters: - - *578 - responses: - '200': - description: Response - content: - application/json: - schema: *696 - examples: - default: *697 - '404': *6 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: keys - delete: - summary: Delete a public SSH key for the authenticated user - description: |- - Removes a public SSH key from the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. - tags: - - users - operationId: users/delete-public-ssh-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user - parameters: - - *578 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: keys - "/user/marketplace_purchases": - get: - summary: List subscriptions for the authenticated user - description: Lists the active subscriptions for the authenticated user. - tags: - - apps - operationId: apps/list-subscriptions-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &698 - title: User Marketplace Purchase - description: User Marketplace Purchase - type: object - properties: - billing_cycle: - type: string - example: monthly - next_billing_date: - type: string - format: date-time - example: '2017-11-11T00:00:00Z' - nullable: true - unit_count: - type: integer - nullable: true - on_free_trial: - type: boolean - example: true - free_trial_ends_on: - type: string - format: date-time - example: '2017-11-11T00:00:00Z' - nullable: true - updated_at: - type: string - format: date-time - example: '2017-11-02T01:12:12Z' - nullable: true - account: - title: Marketplace Account - type: object - properties: - url: - type: string - format: uri - id: - type: integer - type: - type: string - node_id: - type: string - login: - type: string - email: - type: string - nullable: true - format: email - organization_billing_email: - type: string - nullable: true - format: email - required: - - url - - id - - type - - login - plan: *103 - required: - - billing_cycle - - next_billing_date - - unit_count - - updated_at - - on_free_trial - - free_trial_ends_on - - account - - plan - examples: - default: &699 - value: - - billing_cycle: monthly - next_billing_date: '2017-11-11T00:00:00Z' - unit_count: - on_free_trial: true - free_trial_ends_on: '2017-11-11T00:00:00Z' - updated_at: '2017-11-02T01:12:12Z' - account: - login: github - id: 4 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - email: - organization_billing_email: billing@github.com - type: Organization - plan: - url: https://api.github.com/marketplace_listing/plans/1313 - accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts - id: 1313 - number: 3 - name: Pro - description: A professional-grade CI solution - monthly_price_in_cents: 1099 - yearly_price_in_cents: 11870 - price_model: FLAT_RATE - has_free_trial: true - unit_name: - state: published - bullets: - - Up to 25 private repositories - - 11 concurrent builds - headers: - Link: *67 - '304': *37 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/user/marketplace_purchases/stubbed": - get: - summary: List subscriptions for the authenticated user (stubbed) - description: Lists the active subscriptions for the authenticated user. - tags: - - apps - operationId: apps/list-subscriptions-for-authenticated-user-stubbed - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *698 - examples: - default: *699 - headers: - Link: *67 - '304': *37 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: marketplace - "/user/memberships/orgs": - get: - summary: List organization memberships for the authenticated user - description: Lists all of the authenticated user's organization memberships. - tags: - - orgs - operationId: orgs/list-memberships-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user - parameters: - - name: state - description: Indicates the state of the memberships to return. If not specified, - the API returns both active and pending memberships. - in: query - required: false - schema: - type: string - enum: - - active - - pending - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *252 - examples: - default: - value: - - url: https://api.github.com/orgs/octocat/memberships/defunkt - state: active - role: admin - organization_url: https://api.github.com/orgs/octocat - direct_membership: true - enterprise_teams_providing_indirect_membership: [] - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - - url: https://api.github.com/orgs/invitocat/memberships/defunkt - state: pending - role: admin - organization_url: https://api.github.com/orgs/invitocat - direct_membership: false - enterprise_teams_providing_indirect_membership: - - ent:justice-league - - ent:security-managers - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/user/memberships/orgs/{org}": - get: - summary: Get an organization membership for the authenticated user - description: If the authenticated user is an active or pending member of the - organization, this endpoint will return the user's membership. If the authenticated - user is not affiliated with the organization, a `404` is returned. This endpoint - will return a `403` if the request is made by a GitHub App that is blocked - by the organization. - tags: - - orgs - operationId: orgs/get-membership-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user - parameters: - - *75 - responses: - '200': - description: Response - content: - application/json: - schema: *252 - examples: - default: - value: - url: https://api.github.com/orgs/invitocat/memberships/defunkt - state: pending - role: admin - organization_url: https://api.github.com/orgs/invitocat - direct_membership: true - enterprise_teams_providing_indirect_membership: - - ent:justice-league - - ent:security-managers - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - patch: - summary: Update an organization membership for the authenticated user - description: Converts the authenticated user to an active member of the organization, - if that user has a pending invitation from the organization. - tags: - - orgs - operationId: orgs/update-membership-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user - parameters: - - *75 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - state: - type: string - description: The state that the membership should be in. Only `"active"` - will be accepted. - enum: - - active - required: - - state - examples: - default: - value: - state: active - responses: - '200': - description: Response - content: - application/json: - schema: *252 - examples: - default: - value: - url: https://api.github.com/orgs/octocat/memberships/defunkt - state: active - role: admin - organization_url: https://api.github.com/orgs/octocat - direct_membership: true - enterprise_teams_providing_indirect_membership: - - ent:justice-league - - ent:security-managers - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - user: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: members - "/user/migrations": - get: - summary: List user migrations - description: Lists all migrations a user has started. - tags: - - migrations - operationId: migrations/list-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#list-user-migrations - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *254 - examples: - default: - value: - - id: 79 - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: pending - lock_repositories: true - exclude_attachments: false - exclude_releases: false - exclude_owner_projects: false - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - url: https://api.github.com/orgs/octo-org/migrations/79 - created_at: '2015-07-06T15:33:38-07:00' - updated_at: '2015-07-06T15:33:38-07:00' - node_id: MDQ6VXNlcjE= - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - post: - summary: Start a user migration - description: Initiates the generation of a user migration archive. - tags: - - migrations - operationId: migrations/start-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#start-a-user-migration - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - lock_repositories: - description: Lock the repositories being migrated at the start of - the migration - example: true - readOnly: false - type: boolean - exclude_metadata: - description: Indicates whether metadata should be excluded and only - git source should be included for the migration. - example: true - readOnly: false - type: boolean - exclude_git_data: - description: Indicates whether the repository git data should be - excluded from the migration. - example: true - readOnly: false - type: boolean - exclude_attachments: - description: Do not include attachments in the migration - example: true - readOnly: false - type: boolean - exclude_releases: - description: Do not include releases in the migration - example: true - readOnly: false - type: boolean - exclude_owner_projects: - description: Indicates whether projects owned by the organization - or users should be excluded. - example: true - readOnly: false - type: boolean - org_metadata_only: - type: boolean - example: true - description: Indicates whether this should only include organization - metadata (repositories array should be empty and will ignore other - flags). - default: false - exclude: - description: Exclude attributes from the API response to improve - performance - example: - - repositories - readOnly: false - type: array - items: - description: Allowed values that can be passed to the exclude - param. - enum: - - repositories - example: repositories - type: string - repositories: - type: array - items: - description: Repository path, owner and name - example: acme/widgets - type: string - required: - - repositories - type: object - examples: - default: - value: - repositories: - - octocat/Hello-World - lock_repositories: true - responses: - '201': - description: Response - content: - application/json: - schema: *254 - examples: - default: - value: - id: 79 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: pending - lock_repositories: true - exclude_attachments: false - exclude_releases: false - exclude_owner_projects: false - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - url: https://api.github.com/orgs/octo-org/migrations/79 - created_at: '2015-07-06T15:33:38-07:00' - updated_at: '2015-07-06T15:33:38-07:00' - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - "/user/migrations/{migration_id}": - get: - summary: Get a user migration status - description: |- - Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: - - * `pending` - the migration hasn't started yet. - * `exporting` - the migration is in progress. - * `exported` - the migration finished successfully. - * `failed` - the migration failed. - - Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). - tags: - - migrations - operationId: migrations/get-status-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status - parameters: - - *255 - - name: exclude - in: query - required: false - schema: - type: array - items: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *254 - examples: - default: - value: - id: 79 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - state: exported - lock_repositories: true - exclude_attachments: false - exclude_releases: false - exclude_owner_projects: false - org_metadata_only: false - repositories: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - url: https://api.github.com/orgs/octo-org/migrations/79 - created_at: '2015-07-06T15:33:38-07:00' - updated_at: '2015-07-06T15:33:38-07:00' - '404': *6 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - "/user/migrations/{migration_id}/archive": - get: - summary: Download a user migration archive - description: |- - Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - - * attachments - * bases - * commit\_comments - * issue\_comments - * issue\_events - * issues - * milestones - * organizations - * projects - * protected\_branches - * pull\_request\_reviews - * pull\_requests - * releases - * repositories - * review\_comments - * schema - * users - - The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - tags: - - migrations - operationId: migrations/get-archive-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive - parameters: - - *255 - responses: - '302': - description: Response - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - delete: - summary: Delete a user migration archive - description: Deletes a previous migration archive. Downloadable migration archives - are automatically deleted after seven days. Migration metadata, which is returned - in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) - and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) - endpoints, will continue to be available even after an archive is deleted. - tags: - - migrations - operationId: migrations/delete-archive-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive - parameters: - - *255 - responses: - '204': - description: Response - '404': *6 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - "/user/migrations/{migration_id}/repos/{repo_name}/lock": - delete: - summary: Unlock a user repository - description: Unlocks a repository. You can lock repositories when you [start - a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). - Once the migration is complete you can unlock each repository to begin using - it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) - if you no longer need the source data. Returns a status of `404 Not Found` - if the repository is not locked. - tags: - - migrations - operationId: migrations/unlock-repo-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository - parameters: - - *255 - - *700 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - "/user/migrations/{migration_id}/repositories": - get: - summary: List repositories for a user migration - description: Lists all the repositories for this user migration. - tags: - - migrations - operationId: migrations/list-repos-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration - parameters: - - *255 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: migrations - subcategory: users - x-github-breaking-changes: - - changeset: restrict_repo_fields_in_migration_resource - patch: - responses: - '200': - content: - application/json: - schema: - items: *66 - version: '2026-03-10' - - changeset: restrict_repo_fields_in_migration_resource - patch: - responses: - '200': - content: - application/json: - examples: - version: '2026-03-10' - "/user/orgs": - get: - summary: List organizations for the authenticated user - description: |- - List organizations for the authenticated user. - - For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. - - > [!NOTE] - > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. - tags: - - orgs - operationId: orgs/list-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *73 - examples: - default: *116 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: orgs - subcategory: orgs - "/user/packages": - get: - summary: List packages for the authenticated user's namespace - description: |- - Lists packages owned by the authenticated user within the user's namespace. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/list-packages-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace - parameters: - - name: package_type - description: The type of supported package. Packages in GitHub's Gradle registry - have the type `maven`. Docker images pushed to GitHub's Container registry - (`ghcr.io`) have the type `container`. You can use the type `docker` to - find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), - even if these have now been migrated to the Container registry. - in: query - required: true - schema: - type: string - enum: - - npm - - maven - - rubygems - - docker - - nuget - - container - - *701 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *261 - examples: - default: *702 - '400': *703 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/packages/{package_type}/{package_name}": - get: - summary: Get a package for the authenticated user - description: |- - Gets a specific package for a package owned by the authenticated user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-package-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user - parameters: - - *263 - - *264 - responses: - '200': - description: Response - content: - application/json: - schema: *261 - examples: - default: &721 - value: - id: 40201 - name: octo-name - package_type: rubygems - owner: - login: octocat - id: 209477 - node_id: MDQ6VXNlcjIwOTQ3Nw== - avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - version_count: 3 - visibility: public - url: https://api.github.com/users/octocat/packages/rubygems/octo-name - created_at: '2019-10-20T14:17:14Z' - updated_at: '2019-10-20T14:17:14Z' - repository: - id: 216219492 - node_id: MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI= - name: octo-name-repo - full_name: octocat/octo-name-repo - private: false - owner: - login: octocat - id: 209477 - node_id: MDQ6VXNlcjIwOTQ3Nw== - avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: true - html_url: https://github.com/octocat/octo-name-repo - description: Project for octocats - fork: false - url: https://api.github.com/repos/octocat/octo-name-repo - forks_url: https://api.github.com/repos/octocat/octo-name-repo/forks - keys_url: https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id} - collaborators_url: https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator} - teams_url: https://api.github.com/repos/octocat/octo-name-repo/teams - hooks_url: https://api.github.com/repos/octocat/octo-name-repo/hooks - issue_events_url: https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number} - events_url: https://api.github.com/repos/octocat/octo-name-repo/events - assignees_url: https://api.github.com/repos/octocat/octo-name-repo/assignees{/user} - branches_url: https://api.github.com/repos/octocat/octo-name-repo/branches{/branch} - tags_url: https://api.github.com/repos/octocat/octo-name-repo/tags - blobs_url: https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha} - git_refs_url: https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha} - trees_url: https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha} - statuses_url: https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha} - languages_url: https://api.github.com/repos/octocat/octo-name-repo/languages - stargazers_url: https://api.github.com/repos/octocat/octo-name-repo/stargazers - contributors_url: https://api.github.com/repos/octocat/octo-name-repo/contributors - subscribers_url: https://api.github.com/repos/octocat/octo-name-repo/subscribers - subscription_url: https://api.github.com/repos/octocat/octo-name-repo/subscription - commits_url: https://api.github.com/repos/octocat/octo-name-repo/commits{/sha} - git_commits_url: https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha} - comments_url: https://api.github.com/repos/octocat/octo-name-repo/comments{/number} - issue_comment_url: https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number} - contents_url: https://api.github.com/repos/octocat/octo-name-repo/contents/{+path} - compare_url: https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head} - merges_url: https://api.github.com/repos/octocat/octo-name-repo/merges - archive_url: https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/octocat/octo-name-repo/downloads - issues_url: https://api.github.com/repos/octocat/octo-name-repo/issues{/number} - pulls_url: https://api.github.com/repos/octocat/octo-name-repo/pulls{/number} - milestones_url: https://api.github.com/repos/octocat/octo-name-repo/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/octocat/octo-name-repo/labels{/name} - releases_url: https://api.github.com/repos/octocat/octo-name-repo/releases{/id} - deployments_url: https://api.github.com/repos/octocat/octo-name-repo/deployments - html_url: https://github.com/octocat/octo-name-repo/packages/40201 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - delete: - summary: Delete a package for the authenticated user - description: |- - Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/delete-package-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user - parameters: - - *263 - - *264 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/packages/{package_type}/{package_name}/restore": - post: - summary: Restore a package for the authenticated user - description: |- - Restores a package owned by the authenticated user. - - You can restore a deleted package under the following conditions: - - The package was deleted within the last 30 days. - - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/restore-package-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user - parameters: - - *263 - - *264 - - name: token - description: package token - schema: - type: string - required: false - in: query - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/packages/{package_type}/{package_name}/versions": - get: - summary: List package versions for a package owned by the authenticated user - description: |- - Lists package versions for a package owned by the authenticated user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user - parameters: - - *263 - - *264 - - *19 - - *17 - - name: state - in: query - required: false - description: The state of the package, either active or deleted. - schema: - type: string - enum: - - active - - deleted - default: active - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *265 - examples: - default: - value: - - id: 45763 - name: sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9 - url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763 - package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker - created_at: '2020-09-11T21:56:40Z' - updated_at: '2021-02-05T21:32:32Z' - html_url: https://github.com/users/octocat/packages/container/hello_docker/45763 - metadata: - package_type: container - container: - tags: - - latest - - id: 881 - name: sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 - url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/881 - package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker - created_at: '2020-05-21T22:22:20Z' - updated_at: '2021-02-05T21:32:32Z' - html_url: https://github.com/users/octocat/packages/container/hello_docker/881 - metadata: - package_type: container - container: - tags: [] - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": - get: - summary: Get a package version for the authenticated user - description: |- - Gets a specific package version for a package owned by the authenticated user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-package-version-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user - parameters: - - *263 - - *264 - - *266 - responses: - '200': - description: Response - content: - application/json: - schema: *265 - examples: - default: - value: - id: 214 - name: sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a - url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/214 - package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker - created_at: '2020-05-15T03:46:45Z' - updated_at: '2020-05-15T03:46:45Z' - html_url: https://github.com/users/octocat/packages/container/hello_docker/214 - metadata: - package_type: container - container: - tags: - - 1.13.6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - delete: - summary: Delete a package version for the authenticated user - description: |- - Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - - The authenticated user must have admin permissions in the organization to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/delete-package-version-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user - parameters: - - *263 - - *264 - - *266 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": - post: - summary: Restore a package version for the authenticated user - description: |- - Restores a package version owned by the authenticated user. - - You can restore a deleted package version under the following conditions: - - The package was deleted within the last 30 days. - - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/restore-package-version-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user - parameters: - - *263 - - *264 - - *266 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/user/public_emails": - get: - summary: List public email addresses for the authenticated user - description: |- - Lists your publicly visible email address, which you can set with the - [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - endpoint. - - OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - tags: - - users - operationId: users/list-public-emails-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *692 - examples: - default: *704 - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: emails - "/user/repos": - get: - summary: List repositories for the authenticated user - description: |- - Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - - The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - tags: - - repos - operationId: repos/list-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user - parameters: - - name: visibility - description: Limit results to repositories with the specified visibility. - in: query - required: false - schema: - type: string - enum: - - all - - public - - private - default: all - - name: affiliation - description: "Comma-separated list of values. Can include: \n * `owner`: - Repositories that are owned by the authenticated user. \n * `collaborator`: - Repositories that the user has been added to as a collaborator. \n * `organization_member`: - Repositories that the user has access to through being a member of an organization. - This includes every repository on every team that the user is on." - in: query - required: false - schema: - type: string - default: owner,collaborator,organization_member - - name: type - description: Limit results to repositories of the specified type. Will cause - a `422` error if used in the same request as **visibility** or **affiliation**. - in: query - required: false - schema: - type: string - enum: - - all - - owner - - public - - private - - member - default: all - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - pushed - - full_name - default: full_name - - name: direction - description: 'The order to sort by. Default: `asc` when using `full_name`, - otherwise `desc`.' - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *17 - - *19 - - name: since - description: 'Only show repositories updated after the given time. This is - a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - format: date-time - - name: before - description: 'Only show repositories updated before the given time. This is - a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - `YYYY-MM-DDTHH:MM:SSZ`.' - in: query - required: false - schema: - type: string - format: date-time - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *79 - examples: - default: &711 - summary: Default response - value: - - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - headers: - Link: *67 - '422': *15 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: repos - subcategory: repos - post: - summary: Create a repository for the authenticated user - description: |- - Creates a new repository for the authenticated user. - - OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - tags: - - repos - operationId: repos/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: The name of the repository. - type: string - example: Team Environment - description: - description: A short description of the repository. - type: string - homepage: - description: A URL with more information about the repository. - type: string - private: - description: Whether the repository is private. - default: false - type: boolean - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_discussions: - description: Whether discussions are enabled. - default: false - type: boolean - example: true - team_id: - description: The id of the team that will be granted access to this - repository. This is only valid when creating a repository in an - organization. - type: integer - auto_init: - description: Whether the repository is initialized with a minimal - README. - default: false - type: boolean - gitignore_template: - description: The desired language or platform to apply to the .gitignore. - example: Haskell - type: string - license_template: - description: The license keyword of the open source license for - this repository. - example: mit - type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - default: false - type: boolean - example: false - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - Required when using `squash_merge_commit_message`. - - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - Required when using `merge_commit_message`. - - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - is_template: - description: Whether this repository acts as a template that can - be used to generate new repositories. - default: false - type: boolean - example: true - required: - - name - type: object - examples: - default: - value: - name: Hello-World - description: This is your first repo! - homepage: https://github.com - private: false - is_template: true - responses: - '201': - description: Response - content: - application/json: - schema: *347 - examples: - default: *349 - headers: - Location: - example: https://api.github.com/repos/octocat/Hello-World - schema: - type: string - '401': *25 - '304': *37 - '404': *6 - '403': *29 - '422': *15 - '400': *14 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: repos - subcategory: repos - x-github-breaking-changes: - - changeset: change_create_repo_trade_compliance_response_status - patch: - responses: - '451': *15 - version: '2026-03-10' - "/user/repository_invitations": - get: - summary: List repository invitations for the authenticated user - description: When authenticating as a user, this endpoint will list all currently - open repository invitations for that user. - tags: - - repos - operationId: repos/list-invitations-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *545 - examples: - default: *705 - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: collaborators - subcategory: invitations - "/user/repository_invitations/{invitation_id}": - patch: - summary: Accept a repository invitation - description: '' - tags: - - repos - operationId: repos/accept-invitation-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation - parameters: - - *239 - responses: - '204': - description: Response - '403': *29 - '409': *54 - '404': *6 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: collaborators - subcategory: invitations - x-github-breaking-changes: - - changeset: change_accept_repository_invitation_response_status - patch: - responses: - '451': *15 - version: '2026-03-10' - delete: - summary: Decline a repository invitation - description: '' - tags: - - repos - operationId: repos/decline-invitation-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation - parameters: - - *239 - responses: - '204': - description: Response - '409': *54 - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: collaborators - subcategory: invitations - "/user/social_accounts": - get: - summary: List social accounts for the authenticated user - description: Lists all of your social accounts. - tags: - - users - operationId: users/list-social-accounts-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &706 - title: Social account - description: Social media account - type: object - properties: - provider: - type: string - example: linkedin - url: - type: string - example: https://www.linkedin.com/company/github/ - required: - - provider - - url - examples: - default: &707 - value: - - provider: twitter - url: https://twitter.com/github - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: social-accounts - post: - summary: Add social accounts for the authenticated user - description: |- - Add one or more social accounts to the authenticated user's profile. - - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - tags: - - users - operationId: users/add-social-account-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - account_urls: - description: Full URLs for the social media profiles to add. - type: array - items: - type: string - example: https://twitter.com/github - example: [] - required: - - account_urls - example: - account_urls: - - https://www.linkedin.com/company/github/ - - https://twitter.com/github - examples: - default: - summary: Adding multiple social accounts - value: - account_urls: - - https://facebook.com/GitHub - - https://www.youtube.com/@GitHub - responses: - '201': - description: Response - content: - application/json: - schema: - type: array - items: *706 - examples: - default: *707 - '422': *15 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: social-accounts - delete: - summary: Delete social accounts for the authenticated user - description: |- - Deletes one or more social accounts from the authenticated user's profile. - - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - tags: - - users - operationId: users/delete-social-account-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - account_urls: - description: Full URLs for the social media profiles to delete. - type: array - items: - type: string - example: https://twitter.com/github - example: [] - required: - - account_urls - example: - account_urls: - - https://www.linkedin.com/company/github/ - - https://twitter.com/github - examples: - default: - summary: Deleting multiple social accounts - value: - account_urls: - - https://facebook.com/GitHub - - https://www.youtube.com/@GitHub - responses: - '204': - description: Response - '422': *15 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: social-accounts - "/user/ssh_signing_keys": - get: - summary: List SSH signing keys for the authenticated user - description: |- - Lists the SSH signing keys for the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - tags: - - users - operationId: users/list-ssh-signing-keys-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &708 - title: SSH Signing Key - description: A public SSH key used to sign Git commits - type: object - properties: - key: - type: string - id: - type: integer - title: - type: string - created_at: - type: string - format: date-time - required: - - key - - id - - title - - created_at - examples: - default: &739 - value: - - id: 2 - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - title: ssh-rsa AAAAB3NzaC1yc2EAAA - created_at: '2020-06-11T21:31:57Z' - - id: 3 - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 - title: ssh-rsa AAAAB3NzaC1yc2EAAB - created_at: '2020-07-11T21:31:57Z' - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - previews: [] - category: users - subcategory: ssh-signing-keys - post: - summary: Create a SSH signing key for the authenticated user - description: |- - Creates an SSH signing key for the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. - operationId: users/create-ssh-signing-key-for-authenticated-user - tags: - - users - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - title: - description: A descriptive name for the new key. - type: string - example: Personal MacBook Air - key: - description: The public SSH key to add to your GitHub account. For - more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." - type: string - pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) - |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com " - required: - - key - type: object - examples: - default: - value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - title: ssh-rsa AAAAB3NzaC1yc2EAAA - responses: - '201': - description: Response - content: - application/json: - schema: *708 - examples: - default: &709 - value: - id: 2 - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - title: ssh-rsa AAAAB3NzaC1yc2EAAA - created_at: '2020-06-11T21:31:57Z' - '422': *15 - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: ssh-signing-keys - "/user/ssh_signing_keys/{ssh_signing_key_id}": - get: - summary: Get an SSH signing key for the authenticated user - description: |- - Gets extended details for an SSH signing key. - - OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - tags: - - users - operationId: users/get-ssh-signing-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user - parameters: - - &710 - name: ssh_signing_key_id - description: The unique identifier of the SSH signing key. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *708 - examples: - default: *709 - '404': *6 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: ssh-signing-keys - delete: - summary: Delete an SSH signing key for the authenticated user - description: |- - Deletes an SSH signing key from the authenticated user's GitHub account. - - OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. - tags: - - users - operationId: users/delete-ssh-signing-key-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user - parameters: - - *710 - responses: - '204': - description: Response - '304': *37 - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: ssh-signing-keys - "/user/starred": - get: - summary: List repositories starred by the authenticated user - description: |- - Lists repositories the authenticated user has starred. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - tags: - - activity - operationId: activity/list-repos-starred-by-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user - parameters: - - &740 - name: sort - description: The property to sort the results by. `created` means when the - repository was starred. `updated` means when the repository was last pushed - to. - in: query - required: false - schema: - type: string - enum: - - created - - updated - default: created - - *61 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *79 - examples: - default-response: *711 - application/vnd.github.v3.star+json: - schema: - type: array - items: &741 - title: Starred Repository - description: Starred Repository - type: object - properties: - starred_at: - type: string - format: date-time - repo: *79 - required: - - starred_at - - repo - examples: - alternative-response-with-star-creation-timestamps: - summary: Alternative response with star creation timestamps - value: - - starred_at: '2011-01-16T19:06:43Z' - repo: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World - full_name: octocat/Hello-World - owner: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - private: false - html_url: https://github.com/octocat/Hello-World - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World - archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads - events_url: https://api.github.com/repos/octocat/Hello-World/events - forks_url: https://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World/languages - merges_url: https://api.github.com/repos/octocat/Hello-World/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: git@github.com:octocat/Hello-World.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World/tags - teams_url: https://api.github.com/repos/octocat/Hello-World/teams - trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - template_repository: - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: starring - "/user/starred/{owner}/{repo}": - get: - summary: Check if a repository is starred by the authenticated user - description: Whether the authenticated user has starred the repository. - tags: - - activity - operationId: activity/check-repo-is-starred-by-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user - parameters: - - *344 - - *345 - responses: - '204': - description: Response if this repository is starred by you - '404': - description: Not Found if this repository is not starred by you - content: - application/json: - schema: *3 - '401': *25 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: starring - put: - summary: Star a repository for the authenticated user - description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - tags: - - activity - operationId: activity/star-repo-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '403': *29 - '404': *6 - '401': *25 - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: starring - delete: - summary: Unstar a repository for the authenticated user - description: Unstar a repository that the authenticated user has previously - starred. - tags: - - activity - operationId: activity/unstar-repo-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user - parameters: - - *344 - - *345 - responses: - '204': - description: Response - '404': *6 - '401': *25 - '304': *37 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: starring - "/user/subscriptions": - get: - summary: List repositories watched by the authenticated user - description: Lists repositories the authenticated user is watching. - tags: - - activity - operationId: activity/list-watched-repos-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: watching - "/user/teams": - get: - summary: List teams for the authenticated user - description: |- - List all of the teams across all of the organizations to which the authenticated - user belongs. - - OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. - - When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. - tags: - - teams - operationId: teams/list-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user - parameters: - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *340 - examples: - default: - value: - - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - members_count: 3 - repos_count: 10 - created_at: '2017-07-14T16:53:42Z' - updated_at: '2017-08-17T12:37:15Z' - organization: - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization - name: github - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - is_verified: true - has_organization_projects: true - has_repository_projects: true - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - html_url: https://github.com/octocat - created_at: '2008-01-14T04:33:35Z' - updated_at: '2017-08-17T12:37:15Z' - type: Organization - headers: - Link: *67 - '304': *37 - '404': *6 - '403': *29 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: teams - subcategory: teams - "/user/{account_id}": - get: - summary: Get a user using their ID - description: |- - Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. - - If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). - - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). - tags: - - users - operationId: users/get-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/users#get-a-user-using-their-id - parameters: - - *105 - responses: - '200': - description: Response - content: - application/json: - schema: - oneOf: - - *686 - - *685 - examples: - default-response: &715 - summary: Default response - value: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - name: monalisa octocat - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - hireable: false - bio: There once was... - twitter_username: monatheoctocat - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - created_at: '2008-01-14T04:33:35Z' - updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &716 - summary: Response with GitHub plan information - value: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - name: monalisa octocat - company: GitHub - blog: https://github.com/blog - location: San Francisco - email: octocat@github.com - hireable: false - bio: There once was... - twitter_username: monatheoctocat - public_repos: 2 - public_gists: 1 - followers: 20 - following: 0 - created_at: '2008-01-14T04:33:35Z' - updated_at: '2008-01-14T04:33:35Z' - plan: - name: pro - space: 976562499 - collaborators: 0 - private_repos: 9999 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: users - "/user/{user_id}/projectsV2/{project_number}/drafts": - post: - summary: Create draft item for user owned project - description: Create draft issue item for the specified user owned project. - tags: - - projects - operationId: projects/create-draft-item-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project - parameters: - - &713 - name: user_id - description: The unique identifier of the user. - in: path - required: true - schema: - type: string - - *279 - requestBody: - required: true - description: Details of the draft item to create in the project. - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The title of the draft issue item to create in the - project. - body: - type: string - description: The body content of the draft issue item to create - in the project. - required: - - title - examples: - title: - summary: Example with Sample Draft Issue Title - value: - title: Sample Draft Issue Title - body: - summary: Example with Sample Draft Issue Title and Body - value: - title: Sample Draft Issue Title - body: This is the body content of the draft issue. - responses: - '201': - description: Response - content: - application/json: - schema: *285 - examples: - draft_issue: *286 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: drafts - "/users": - get: - summary: List users - description: |- - Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. - - Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - tags: - - users - operationId: users/list - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/users#list-users - parameters: - - *712 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: - example: ; rel="next" - schema: - type: string - '304': *37 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: users - "/users/{user_id}/projectsV2/{project_number}/views": - post: - summary: Create a view for a user-owned project - description: Create a new view in a user-owned project. Views allow you to customize - how items in a project are displayed and filtered. - tags: - - projects - operationId: projects/create-view-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project - parameters: - - *713 - - *279 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the view. - example: Sprint Board - layout: - type: string - description: The layout of the view. - enum: - - table - - board - - roadmap - example: board - filter: - type: string - description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) - for more information. - example: is:issue is:open - visible_fields: - type: array - description: |- - `visible_fields` is not applicable to `roadmap` layout views. - For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. - items: - type: integer - example: - - 123 - - 456 - - 789 - required: - - name - - layout - additionalProperties: false - examples: - table_view: - summary: Create a table view - value: - name: All Issues - layout: table - filter: is:issue - visible_fields: - - 123 - - 456 - - 789 - board_view: - summary: Create a board view with filter - value: - name: Sprint Board - layout: board - filter: is:issue is:open label:sprint - visible_fields: - - 123 - - 456 - - 789 - roadmap_view: - summary: Create a roadmap view - value: - name: Product Roadmap - layout: roadmap - responses: - '201': - description: Response for creating a view in a user-owned project. - content: - application/json: - schema: *714 - examples: - table_view: - summary: Response for creating a table view - value: *290 - board_view: - summary: Response for creating a board view with filter - value: *290 - roadmap_view: - summary: Response for creating a roadmap view - value: *290 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - '422': *15 - '503': - description: Service unavailable - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects - subcategory: views - "/users/{username}": - get: - summary: Get a user - description: |- - Provides publicly available information about someone with a GitHub account. - - If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). - - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). - tags: - - users - operationId: users/get-by-username - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/users#get-a-user - parameters: - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: - oneOf: - - *686 - - *685 - examples: - default-response: *715 - response-with-git-hub-plan-information: *716 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: users - "/users/{username}/attestations/bulk-list": - post: - summary: List attestations by bulk subject digests - description: |- - List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. - - The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - tags: - - users - operationId: users/list-attestations-bulk - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests - parameters: - - *17 - - *47 - - *48 - - *71 - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - subject_digests: - type: array - items: - type: string - description: List of subject digests to fetch attestations for. - minItems: 1 - maxItems: 1024 - predicate_type: - type: string - description: |- - Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, `release`, or freeform text - for custom predicate types. - required: - - subject_digests - examples: - default: *717 - withPredicateType: *718 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - attestations_subject_digests: - type: object - additionalProperties: - nullable: true - type: array - items: - type: object - properties: - bundle: - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: {} - additionalProperties: true - dsseEnvelope: - type: object - properties: {} - additionalProperties: true - description: The bundle of the attestation. - repository_id: - type: integer - bundle_url: - type: string - description: Mapping of subject digest to bundles. - page_info: - type: object - properties: - has_next: - type: boolean - description: Indicates whether there is a next page. - has_previous: - type: boolean - description: Indicates whether there is a previous page. - next: - type: string - description: The cursor to the next page. - previous: - type: string - description: The cursor to the previous page. - description: Information about the current page. - examples: - default: *719 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: attestations - x-github-breaking-changes: - - changeset: remove_bundle - patch: - responses: - '200': - content: - application/json: - schema: - properties: - attestations_subject_digests: - additionalProperties: - items: - properties: - bundle: - version: '2026-03-10' - "/users/{username}/attestations/delete-request": - post: - summary: Delete attestations in bulk - description: Delete artifact attestations in bulk by either subject digests - or unique ID. - tags: - - users - operationId: users/delete-attestations-bulk - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk - parameters: - - *71 - requestBody: - required: true - content: - application/json: - schema: - type: object - oneOf: - - properties: - subject_digests: - type: array - items: - type: string - description: List of subject digests associated with the artifact - attestations to delete. - minItems: 1 - maxItems: 1024 - required: - - subject_digests - - properties: - attestation_ids: - type: array - items: - type: integer - description: List of unique IDs associated with the artifact attestations - to delete. - minItems: 1 - maxItems: 1024 - required: - - attestation_ids - description: The request body must include either `subject_digests` - or `attestation_ids`, but not both. - examples: - by-subject-digests: - summary: Delete by subject digests - value: - subject_digests: - - sha256:abc123 - - sha512:def456 - by-attestation-ids: - summary: Delete by attestation IDs - value: - attestation_ids: - - 111 - - 222 - responses: - '200': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: attestations - "/users/{username}/attestations/digest/{subject_digest}": - delete: - summary: Delete attestations by subject digest - description: Delete an artifact attestation by subject digest. - tags: - - users - operationId: users/delete-attestations-by-subject-digest - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest - parameters: - - *71 - - name: subject_digest - description: Subject Digest - in: path - required: true - schema: - type: string - x-multi-segment: true - responses: - '200': - description: Response - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: attestations - "/users/{username}/attestations/{attestation_id}": - delete: - summary: Delete attestations by ID - description: Delete an artifact attestation by unique ID that is associated - with a repository owned by a user. - tags: - - users - operationId: users/delete-attestations-by-id - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id - parameters: - - *71 - - name: attestation_id - description: Attestation ID - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - '204': - description: Response - '403': *29 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: attestations - "/users/{username}/attestations/{subject_digest}": - get: - summary: List attestations - description: |- - List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. - - The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. - - **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). - tags: - - users - operationId: users/list-attestations - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/attestations#list-attestations - parameters: - - *17 - - *47 - - *48 - - *71 - - name: subject_digest - description: Subject Digest - in: path - required: true - schema: - type: string - x-multi-segment: true - - name: predicate_type - description: |- - Optional filter for fetching attestations with a given predicate type. - This option accepts `provenance`, `sbom`, `release`, or freeform text - for custom predicate types. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - attestations: - type: array - items: - type: object - properties: - bundle: - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: {} - additionalProperties: true - dsseEnvelope: - type: object - properties: {} - additionalProperties: true - description: |- - The attestation's Sigstore Bundle. - Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - repository_id: - type: integer - bundle_url: - type: string - initiator: - type: string - examples: - default: *405 - '201': - description: Response - content: - application/json: - schema: *169 - examples: - default: - value: - '204': - description: Response - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: attestations - x-github-breaking-changes: - - changeset: remove_bundle - patch: - responses: - '200': - content: - application/json: - schema: - properties: - attestations: - items: - properties: - bundle: - version: '2026-03-10' - "/users/{username}/docker/conflicts": - get: - summary: Get list of conflicting packages during Docker migration for user - description: |- - Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - tags: - - packages - operationId: packages/list-docker-migration-conflicting-packages-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user - parameters: - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *261 - examples: - default: *702 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/events": - get: - summary: List events for the authenticated user - description: |- - If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). - - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-events-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - default: - value: - - id: '22249084947' - type: WatchEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - action: started - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: false - created_at: '2022-06-07T07:50:26Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/users/{username}/events/orgs/{org}": - get: - summary: List organization events for the authenticated user - description: |- - This is the user's organization dashboard. You must be authenticated as the user to view this. - - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-org-events-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user - parameters: - - *71 - - *75 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - default: - value: - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octo-org/octo-repo - url: https://api.github.com/repos/octo-org/octo-repo - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: false - created_at: '2022-06-09T12:47:28Z' - org: - id: 9919 - login: octo-org - gravatar_id: '' - url: https://api.github.com/orgs/octo-org - avatar_url: https://avatars.githubusercontent.com/u/9919? - - id: '22196946742' - type: CreateEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octo-org/octo-repo - url: https://api.github.com/repos/octo-org/octo-repo - payload: - ref: master - ref_type: repository - full_ref: refs/heads/master - master_branch: master - description: - pusher_type: user - public: false - created_at: '2022-06-07T07:50:26Z' - org: - id: 9919 - login: octo-org - gravatar_id: '' - url: https://api.github.com/orgs/octo-org - avatar_url: https://avatars.githubusercontent.com/u/9919? - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: activity - subcategory: events - "/users/{username}/events/public": - get: - summary: List public events for a user - description: |- - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-public-events-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - default: - value: - - id: '22249084947' - type: WatchEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - action: started - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-08T23:29:25Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/users/{username}/followers": - get: - summary: List followers of a user - description: Lists the people following the specified user. - tags: - - users - operationId: users/list-followers-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#list-followers-of-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: followers - "/users/{username}/following": - get: - summary: List the people a user follows - description: Lists the people who the specified user follows. - tags: - - users - operationId: users/list-following-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *70 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: followers - "/users/{username}/following/{target_user}": - get: - summary: Check if a user follows another user - description: '' - tags: - - users - operationId: users/check-following-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user - parameters: - - *71 - - name: target_user - in: path - required: true - schema: - type: string - responses: - '204': - description: if the user follows the target user - '404': - description: if the user does not follow the target user - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: followers - "/users/{username}/gists": - get: - summary: List gists for a user - description: 'Lists public gists for the specified user:' - tags: - - gists - operationId: gists/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user - parameters: - - *71 - - *92 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *93 - examples: - default: *94 - headers: - Link: *67 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: gists - subcategory: gists - "/users/{username}/gpg_keys": - get: - summary: List GPG keys for a user - description: Lists the GPG keys for a user. This information is accessible by - anyone. - tags: - - users - operationId: users/list-gpg-keys-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *693 - examples: - default: *720 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: gpg-keys - "/users/{username}/hovercard": - get: - summary: Get contextual information for a user - description: |- - Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - - The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - tags: - - users - operationId: users/get-context-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user - parameters: - - *71 - - name: subject_type - description: Identifies which additional information you'd like to receive - about the person's hovercard. Can be `organization`, `repository`, `issue`, - `pull_request`. **Required** when using `subject_id`. - in: query - required: false - schema: - type: string - enum: - - organization - - repository - - issue - - pull_request - - name: subject_id - description: Uses the ID for the `subject_type` you specified. **Required** - when using `subject_type`. - in: query - required: false - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - title: Hovercard - description: Hovercard - type: object - properties: - contexts: - type: array - items: - type: object - properties: - message: - type: string - octicon: - type: string - required: - - message - - octicon - required: - - contexts - examples: - default: - value: - contexts: - - message: Owns this repository - octicon: repo - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: users - subcategory: users - "/users/{username}/installation": - get: - summary: Get a user installation for the authenticated app - description: |- - Enables an authenticated GitHub App to find the user’s installation information. - - You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - tags: - - apps - operationId: apps/get-user-installation - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app - parameters: - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: *22 - examples: - default: *542 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: apps - subcategory: apps - "/users/{username}/keys": - get: - summary: List public keys for a user - description: Lists the _verified_ public SSH keys for a user. This is accessible - by anyone. - tags: - - users - operationId: users/list-public-keys-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - title: Key Simple - description: Key Simple - type: object - properties: - id: - type: integer - key: - type: string - created_at: - type: string - format: date-time - last_used: - nullable: true - type: string - format: date-time - required: - - key - - id - examples: - default: - value: - - id: 1 - key: ssh-rsa AAA... - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: keys - "/users/{username}/orgs": - get: - summary: List organizations for a user - description: |- - List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. - - This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - tags: - - orgs - operationId: orgs/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *73 - examples: - default: *116 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: orgs - subcategory: orgs - "/users/{username}/packages": - get: - summary: List packages for a user - description: |- - Lists all packages in a user's namespace for which the requesting user has access. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/list-packages-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#list-packages-for-a-user - parameters: - - name: package_type - description: The type of supported package. Packages in GitHub's Gradle registry - have the type `maven`. Docker images pushed to GitHub's Container registry - (`ghcr.io`) have the type `container`. You can use the type `docker` to - find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), - even if these have now been migrated to the Container registry. - in: query - required: true - schema: - type: string - enum: - - npm - - maven - - rubygems - - docker - - nuget - - container - - *701 - - *71 - - *19 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *261 - examples: - default: *702 - '403': *29 - '401': *25 - '400': *703 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/packages/{package_type}/{package_name}": - get: - summary: Get a package for a user - description: |- - Gets a specific package metadata for a public package owned by a user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-package-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user - parameters: - - *263 - - *264 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: *261 - examples: - default: *721 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - delete: - summary: Delete a package for a user - description: |- - Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/delete-package-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user - parameters: - - *263 - - *264 - - *71 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/packages/{package_type}/{package_name}/restore": - post: - summary: Restore a package for a user - description: |- - Restores an entire package for a user. - - You can restore a deleted package under the following conditions: - - The package was deleted within the last 30 days. - - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/restore-package-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user - parameters: - - *263 - - *264 - - *71 - - name: token - description: package token - schema: - type: string - required: false - in: query - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/packages/{package_type}/{package_name}/versions": - get: - summary: List package versions for a package owned by a user - description: |- - Lists package versions for a public package owned by a specified user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-all-package-versions-for-package-owned-by-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user - parameters: - - *263 - - *264 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *265 - examples: - default: - value: - - id: 3497268 - name: 0.3.0 - url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268 - package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 - license: MIT - created_at: '2020-08-31T15:22:11Z' - updated_at: '2020-08-31T15:22:12Z' - description: Project for octocats - html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0 - metadata: - package_type: rubygems - - id: 387039 - name: 0.2.0 - url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039 - package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 - license: MIT - created_at: '2019-12-01T20:49:29Z' - updated_at: '2019-12-01T20:49:30Z' - description: Project for octocats - html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 - metadata: - package_type: rubygems - - id: 169770 - name: 0.1.0 - url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770 - package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 - license: MIT - created_at: '2019-10-20T14:17:14Z' - updated_at: '2019-10-20T14:17:15Z' - html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0 - metadata: - package_type: rubygems - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": - get: - summary: Get a package version for a user - description: |- - Gets a specific package version for a public package owned by a specified user. - - OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/get-package-version-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user - parameters: - - *263 - - *264 - - *266 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: *265 - examples: - default: - value: - id: 387039 - name: 0.2.0 - url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039 - package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 - license: MIT - created_at: '2019-12-01T20:49:29Z' - updated_at: '2019-12-01T20:49:30Z' - description: Octo-name client for Ruby - html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 - metadata: - package_type: rubygems - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - delete: - summary: Delete package version for a user - description: |- - Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/delete-package-version-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user - parameters: - - *263 - - *264 - - *71 - - *266 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": - post: - summary: Restore package version for a user - description: |- - Restores a specific package version for a user. - - You can restore a deleted package under the following conditions: - - The package was deleted within the last 30 days. - - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - - OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - tags: - - packages - operationId: packages/restore-package-version-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user - parameters: - - *263 - - *264 - - *71 - - *266 - responses: - '204': - description: Response - '404': *6 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: packages - subcategory: packages - "/users/{username}/projectsV2": - get: - summary: List projects for user - description: List all projects owned by a specific user accessible by the authenticated - user. - tags: - - projects - operationId: projects/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-projects-for-user - parameters: - - *71 - - name: q - description: Limit results to projects of the specified type. - in: query - required: false - schema: - type: string - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *277 - examples: - default: *278 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - "/users/{username}/projectsV2/{project_number}": - get: - summary: Get project for user - description: Get a specific user-owned project. - tags: - - projects - operationId: projects/get-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#get-project-for-user - parameters: - - *279 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: *277 - examples: - default: *278 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - "/users/{username}/projectsV2/{project_number}/fields": - get: - summary: List project fields for user - description: List all fields for a specific user-owned project. - tags: - - projects - operationId: projects/list-fields-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user - parameters: - - *279 - - *71 - - *17 - - *47 - - *48 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *283 - examples: - default: *722 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: fields - post: - summary: Add field to user owned project - description: Add a field to a specified user owned project. - tags: - - projects - operationId: projects/add-field-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project - parameters: - - *71 - - *279 - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - text - - number - - date - required: - - name - - data_type - additionalProperties: false - - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - single_select - single_select_options: - type: array - description: The options available for single select fields. At - least one option must be provided when creating a single select - field. - items: *723 - required: - - name - - data_type - - single_select_options - additionalProperties: false - - type: object - properties: - name: - type: string - description: The name of the field. - data_type: - type: string - description: The field's data type. - enum: - - iteration - iteration_configuration: *724 - required: - - name - - data_type - - iteration_configuration - additionalProperties: false - examples: - text_field: - summary: Create a text field - value: - name: Team notes - data_type: text - number_field: - summary: Create a number field - value: - name: Story points - data_type: number - date_field: - summary: Create a date field - value: - name: Due date - data_type: date - single_select_field: *725 - iteration_field: *726 - responses: - '201': - description: Response - content: - application/json: - schema: *283 - examples: - text_field: *727 - number_field: *728 - date_field: *729 - single_select_field: *730 - iteration_field: *731 - '304': *37 - '403': *29 - '401': *25 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: fields - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": - get: - summary: Get project field for user - description: Get a specific field for a user-owned project. - tags: - - projects - operationId: projects/get-field-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/fields#get-project-field-for-user - parameters: - - *279 - - *732 - - *71 - responses: - '200': - description: Response - content: - application/json: - schema: *283 - examples: - default: *733 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: fields - "/users/{username}/projectsV2/{project_number}/items": - get: - summary: List items for a user owned project - description: List all items for a specific user-owned project accessible by - the authenticated user. - tags: - - projects - operationId: projects/list-items-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project - parameters: - - *279 - - *71 - - *47 - - *48 - - *17 - - name: q - description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) - for more information. - in: query - required: false - schema: - type: string - - name: fields - description: |- - Limit results to specific fields, by their IDs. If not specified, the title field will be returned. - - Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` - in: query - required: false - schema: - oneOf: - - type: string - - type: array - maxItems: 50 - items: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *287 - examples: - default: *288 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - post: - summary: Add item to user owned project - description: Add an issue or pull request item to the specified user owned project. - tags: - - projects - operationId: projects/add-item-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project - parameters: - - *71 - - *279 - requestBody: - required: true - description: Details of the item to add to the project. You can specify either - the unique ID or the repository owner, name, and issue/PR number. - content: - application/json: - schema: - type: object - additionalProperties: false - properties: - type: - type: string - enum: - - Issue - - PullRequest - description: The type of item to add to the project. Must be either - Issue or PullRequest. - id: - type: integer - description: The unique identifier of the issue or pull request - to add to the project. - owner: - type: string - description: The repository owner login. - repo: - type: string - description: The repository name. - number: - type: integer - description: The issue or pull request number. - required: - - type - oneOf: - - required: - - id - - required: - - owner - - repo - - number - examples: - issue_with_id: - summary: Add an issue using its unique ID - value: - type: Issue - id: 3 - pull_request_with_id: - summary: Add a pull request using its unique ID - value: - type: PullRequest - id: 3 - issue_with_nwo: - summary: Add an issue using repository owner, name, and issue number - value: - type: Issue - owner: octocat - repo: hello-world - number: 42 - pull_request_with_nwo: - summary: Add a pull request using repository owner, name, and PR number - value: - type: PullRequest - owner: octocat - repo: hello-world - number: 123 - responses: - '201': - description: Response - content: - application/json: - schema: *285 - examples: - issue_with_id: - summary: Response for adding an issue using its unique ID - value: *286 - pull_request_with_id: - summary: Response for adding a pull request using its unique ID - value: *286 - issue_with_nwo: - summary: Response for adding an issue using repository owner, name, - and issue number - value: *286 - pull_request_with_nwo: - summary: Response for adding a pull request using repository owner, - name, and PR number - value: *286 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - "/users/{username}/projectsV2/{project_number}/items/{item_id}": - get: - summary: Get an item for a user owned project - description: Get a specific item from a user-owned project. - tags: - - projects - operationId: projects/get-user-item - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project - parameters: - - *279 - - *71 - - *289 - - name: fields - description: |- - Limit results to specific fields, by their IDs. If not specified, the title field will be returned. - - Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 - in: query - required: false - schema: - oneOf: - - type: string - - type: array - maxItems: 50 - items: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: *287 - examples: - default: *288 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - patch: - summary: Update project item for user - description: Update a specific item in a user-owned project. - tags: - - projects - operationId: projects/update-item-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#update-project-item-for-user - parameters: - - *279 - - *71 - - *289 - requestBody: - required: true - description: Field updates to apply to the project item. Only text, number, - date, single select, and iteration fields are supported. - content: - application/json: - schema: - type: object - properties: - fields: - type: array - description: A list of field updates to apply. - items: - type: object - properties: - id: - type: integer - description: The ID of the project field to update. - value: - description: |- - The new value for the field: - - For text, number, and date fields, provide the new value directly. - - For single select and iteration fields, provide the ID of the option or iteration. - - To clear the field, set this to null. - nullable: true - oneOf: - - type: string - - type: number - required: - - id - - value - required: - - fields - examples: - text_field: - summary: Update a text field - value: - fields: - - id: 123 - value: Updated text value - number_field: - summary: Update a number field - value: - fields: - - id: 456 - value: 42.5 - date_field: - summary: Update a date field - value: - fields: - - id: 789 - value: '2023-10-05' - single_select_field: - summary: Update a single select field - value: - fields: - - id: 789 - value: 47fc9ee4 - iteration_field: - summary: Update an iteration field - value: - fields: - - id: 1011 - value: 866ee5b8 - responses: - '200': - description: Response - content: - application/json: - schema: *287 - examples: - text_field: *288 - number_field: *288 - date_field: *288 - single_select_field: *288 - iteration_field: *288 - '401': *25 - '403': *29 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - delete: - summary: Delete project item for user - description: Delete a specific item from a user-owned project. - tags: - - projects - operationId: projects/delete-item-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#delete-project-item-for-user - parameters: - - *279 - - *71 - - *289 - responses: - '204': - description: Response - '403': *29 - '401': *25 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: items - "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": - get: - summary: List items for a user project view - description: List items in a user project with the saved view's filter applied. - tags: - - projects - operationId: projects/list-view-items-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view - parameters: - - *279 - - *71 - - *734 - - name: fields - description: |- - Limit results to specific fields, by their IDs. If not specified, the - title field will be returned. - - Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` - in: query - required: false - schema: - oneOf: - - type: string - - type: array - maxItems: 50 - items: - type: string - - *47 - - *48 - - *17 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *287 - examples: - default: *288 - headers: - Link: *67 - '304': *37 - '403': *29 - '401': *25 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: projects - subcategory: items - "/users/{username}/received_events": - get: - summary: List events received by the authenticated user - description: |- - These are events that you've received by watching repositories and following users. If you are authenticated as the - given user, you will see private events. Otherwise, you'll only see public events. - - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-received-events-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - default: - value: - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22196946742' - type: CreateEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - ref: master - ref_type: repository - full_ref: refs/heads/master - master_branch: master - description: - pusher_type: user - public: false - created_at: '2022-06-07T07:50:26Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/users/{username}/received_events/public": - get: - summary: List public events received by a user - description: |- - > [!NOTE] - > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - tags: - - activity - operationId: activity/list-received-public-events-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *111 - examples: - default: - value: - - id: '22249084964' - type: PushEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - repository_id: 1296269 - push_id: 10115855396 - ref: refs/heads/master - head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - before: 883efe034920928c47fe18598c01249d1a9fdabd - public: true - created_at: '2022-06-09T12:47:28Z' - - id: '22196946742' - type: CreateEvent - actor: - id: 583231 - login: octocat - display_login: octocat - gravatar_id: '' - url: https://api.github.com/users/octocat - avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 - repo: - id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World - payload: - ref: master - ref_type: repository - full_ref: refs/heads/master - master_branch: master - description: - pusher_type: user - public: false - created_at: '2022-06-07T07:50:26Z' - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: events - "/users/{username}/repos": - get: - summary: List repositories for a user - description: Lists public repositories for the specified user. - tags: - - repos - operationId: repos/list-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user - parameters: - - *71 - - name: type - description: Limit results to repositories of the specified type. - in: query - required: false - schema: - type: string - enum: - - all - - owner - - member - default: owner - - name: sort - description: The property to sort the results by. - in: query - required: false - schema: - type: string - enum: - - created - - updated - - pushed - - full_name - default: full_name - - name: direction - description: 'The order to sort by. Default: `asc` when using `full_name`, - otherwise `desc`.' - in: query - required: false - schema: - type: string - enum: - - asc - - desc - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - "/users/{username}/settings/billing/premium_request/usage": - get: - summary: Get billing premium request usage report for a user - description: |- - Gets a report of premium request usage for a user. - - **Note:** Only data from the past 24 months is accessible via this endpoint. - tags: - - billing - operationId: billing/get-github-billing-premium-request-usage-report-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user - parameters: - - *71 - - *123 - - *125 - - *124 - - *735 - - *126 - responses: - '200': - description: Response when getting a billing premium request usage report - content: - application/json: - schema: - type: object - properties: - timePeriod: - type: object - properties: - year: - type: integer - description: The year for the usage report. - month: - type: integer - description: The month for the usage report. - day: - type: integer - description: The day for the usage report. - required: - - year - user: - type: string - description: The unique identifier of the user. - product: - type: string - description: The product for the usage report. - model: - type: string - description: The model for the usage report. - usageItems: - type: array - items: - type: object - properties: - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - model: - type: string - description: Model name. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossQuantity: - type: number - description: Gross quantity of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountQuantity: - type: number - description: Discount quantity of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netQuantity: - type: number - description: Net quantity of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - required: - - product - - sku - - model - - unitType - - pricePerUnit - - grossQuantity - - grossAmount - - discountQuantity - - discountAmount - - netQuantity - - netAmount - required: - - timePeriod - - user - - usageItems - examples: - default: - value: - timePeriod: - year: 2025 - user: monalisa - usageItems: - - product: Copilot - sku: Copilot Premium Request - model: GPT-5 - unitType: requests - pricePerUnit: 0.04 - grossQuantity: 100 - grossAmount: 4.0 - discountQuantity: 0 - discountAmount: 0.0 - netQuantity: 100 - netAmount: 4.0 - '400': *14 - '403': *29 - '404': *6 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: usage - "/users/{username}/settings/billing/usage": - get: - summary: Get billing usage report for a user - description: |- - Gets a report of the total usage for a user. - - **Note:** This endpoint is only available to users with access to the enhanced billing platform. - tags: - - billing - operationId: billing/get-github-billing-usage-report-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user - parameters: - - *71 - - *123 - - *736 - - *124 - responses: - '200': - description: Response when getting a billing usage report - content: - application/json: - schema: - type: object - properties: - usageItems: - type: array - items: - type: object - properties: - date: - type: string - description: Date of the usage line item. - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - quantity: - type: integer - description: Quantity of the usage line item. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - repositoryName: - type: string - description: Name of the repository. - required: - - date - - product - - sku - - quantity - - unitType - - pricePerUnit - - grossAmount - - discountAmount - - netAmount - examples: - default: - value: - usageItems: - - date: '2023-08-01' - product: Actions - sku: Actions Linux - quantity: 100 - unitType: minutes - pricePerUnit: 0.008 - grossAmount: 0.8 - discountAmount: 0 - netAmount: 0.8 - repositoryName: user/example - '400': *14 - '403': *29 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: usage - "/users/{username}/settings/billing/usage/summary": - get: - summary: Get billing usage summary for a user - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Gets a summary report of usage for a user. - - **Note:** Only data from the past 24 months is accessible via this endpoint. - tags: - - billing - operationId: billing/get-github-billing-usage-summary-report-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user - parameters: - - *71 - - *123 - - *125 - - *124 - - *737 - - *126 - - *738 - responses: - '200': - description: Response when getting a billing usage summary - content: - application/json: - schema: - type: object - properties: - timePeriod: - type: object - properties: - year: - type: integer - description: The year for the usage report. - month: - type: integer - description: The month for the usage report. - day: - type: integer - description: The day for the usage report. - required: - - year - user: - type: string - description: The unique identifier of the user. - repository: - type: string - description: The name of the repository for the usage report. - product: - type: string - description: The product for the usage report. - sku: - type: string - description: The SKU for the usage report. - usageItems: - type: array - items: - type: object - properties: - product: - type: string - description: Product name. - sku: - type: string - description: SKU name. - unitType: - type: string - description: Unit type of the usage line item. - pricePerUnit: - type: number - description: Price per unit of the usage line item. - grossQuantity: - type: number - description: Gross quantity of the usage line item. - grossAmount: - type: number - description: Gross amount of the usage line item. - discountQuantity: - type: number - description: Discount quantity of the usage line item. - discountAmount: - type: number - description: Discount amount of the usage line item. - netQuantity: - type: number - description: Net quantity of the usage line item. - netAmount: - type: number - description: Net amount of the usage line item. - required: - - product - - sku - - unitType - - pricePerUnit - - grossQuantity - - grossAmount - - discountQuantity - - discountAmount - - netQuantity - - netAmount - required: - - timePeriod - - user - - usageItems - examples: - default: - value: - timePeriod: - year: 2025 - user: monalisa - usageItems: - - product: Actions - sku: actions_linux - unitType: minutes - pricePerUnit: 0.008 - grossQuantity: 1000 - grossAmount: 8.0 - discountQuantity: 0 - discountAmount: 0.0 - netQuantity: 1000 - netAmount: 8.0 - '400': *14 - '403': *29 - '404': *6 - '500': *55 - '503': *121 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: billing - subcategory: usage - "/users/{username}/social_accounts": - get: - summary: List social accounts for a user - description: Lists social media accounts for a user. This endpoint is accessible - by anyone. - tags: - - users - operationId: users/list-social-accounts-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *706 - examples: - default: *707 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: social-accounts - "/users/{username}/ssh_signing_keys": - get: - summary: List SSH signing keys for a user - description: Lists the SSH signing keys for a user. This operation is accessible - by anyone. - tags: - - users - operationId: users/list-ssh-signing-keys-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *708 - examples: - default: *739 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: users - subcategory: ssh-signing-keys - "/users/{username}/starred": - get: - summary: List repositories starred by a user - description: |- - Lists repositories a user has starred. - - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - - - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - tags: - - activity - operationId: activity/list-repos-starred-by-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user - parameters: - - *71 - - *740 - - *61 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - anyOf: - - type: array - items: *741 - - type: array - items: *79 - examples: - default-response: *711 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: starring - "/users/{username}/subscriptions": - get: - summary: List repositories watched by a user - description: Lists repositories a user is watching. - tags: - - activity - operationId: activity/list-repos-watched-by-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user - parameters: - - *71 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *160 - examples: - default: *267 - headers: - Link: *67 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: activity - subcategory: watching - "/versions": - get: - summary: Get all API versions - description: Get all supported GitHub API versions. - tags: - - meta - operationId: meta/get-all-versions - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/meta/meta#get-all-api-versions - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - type: string - format: date - example: '2021-01-01' - examples: - default: - value: - - '2021-01-01' - - '2021-06-01' - - '2022-01-01' - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: meta - subcategory: meta - "/zen": - get: - summary: Get the Zen of GitHub - description: Get a random sentence from the Zen of GitHub - tags: - - meta - operationId: meta/get-zen - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/meta/meta#get-the-zen-of-github - responses: - '200': - description: Response - content: - text/plain: - schema: - type: string - examples: - default: - summary: Example response - value: Responsive is better than fast - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: meta - subcategory: meta -x-webhooks: - branch-protection-configuration-disabled: - post: - summary: |- - This event occurs when there is a change to branch protection configurations for a repository. - For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." - For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: All branch protections were disabled for a repository. - operationId: branch-protection-configuration/disabled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: branch_protection_configuration - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: branch protection configuration disabled event - type: object - properties: - action: - type: string - enum: - - disabled - enterprise: &742 - title: Enterprise - description: |- - An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - on an enterprise account or an organization that's part of an enterprise account. For more information, - see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." - type: object - properties: - description: - description: A short description of the enterprise. - type: string - nullable: true - html_url: - type: string - format: uri - example: https://github.com/enterprises/octo-business - website_url: - description: The enterprise's website URL. - type: string - nullable: true - format: uri - id: - description: Unique identifier of the enterprise - example: 42 - type: integer - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the enterprise. - type: string - example: Octo Business - slug: - description: The slug url identifier for the enterprise. - type: string - example: octo-business - created_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:01:12Z' - updated_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:14:43Z' - avatar_url: - type: string - format: uri - required: - - id - - node_id - - name - - slug - - html_url - - created_at - - updated_at - - avatar_url - installation: &743 - title: Simple Installation - description: |- - The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - for and sent to a GitHub App. For more information, - see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." - type: object - properties: - id: - description: The ID of the installation. - type: integer - example: 1 - node_id: - description: The global node ID of the installation. - type: string - example: MDQ6VXNlcjU4MzIzMQ== - required: - - id - - node_id - organization: &744 - title: Organization Simple - description: |- - A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - organization, or when the event occurs from activity in a repository owned by an organization. - type: object - properties: - login: - type: string - example: github - id: - type: integer - example: 1 - node_id: - type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - example: https://api.github.com/orgs/github - repos_url: - type: string - format: uri - example: https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - example: https://api.github.com/orgs/github/events - hooks_url: - type: string - example: https://api.github.com/orgs/github/hooks - issues_url: - type: string - example: https://api.github.com/orgs/github/issues - members_url: - type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - example: https://github.com/images/error/octocat_happy.gif - description: - type: string - example: A great organization - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - repository: &745 - title: Repository - description: |- - The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - when the event occurs from activity in a repository. - type: object - properties: &777 - id: - description: Unique identifier of the repository - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the repository. - type: string - example: Team Environment - full_name: - type: string - example: octocat/Hello-World - license: - title: License Simple - description: License Simple - type: object - properties: *88 - required: *89 - nullable: true - organization: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - forks: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - required: - - admin - - pull - - push - owner: *4 - private: - description: Whether the repository is private or public. - default: false - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: - type: string - format: uri - example: git:git.example.com/octocat/Hello-World - nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: - type: string - format: uri - example: https://github.com - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - description: The size of the repository, in kilobytes. Size - is calculated hourly. When a repository is initially created, - the size is 0. - type: integer - example: 108 - default_branch: - description: The default branch of the repository. - type: string - example: master - open_issues_count: - type: integer - example: 0 - is_template: - description: Whether this repository acts as a template that - can be used to generate new repositories. - default: false - type: boolean - example: true - topics: - type: array - items: - type: string - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - has_discussions: - description: Whether discussions are enabled. - default: false - type: boolean - example: true - has_pull_requests: - description: Whether pull requests are enabled. - default: true - type: boolean - example: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull requests: - all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - archived: - description: Whether the repository is archived. - default: false - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or - internal.' - default: public - type: string - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true - type: boolean - example: true - template_repository: - nullable: true - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - owner: - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - avatar_url: - type: string - gravatar_id: - type: string - url: - type: string - html_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - organizations_url: - type: string - repos_url: - type: string - events_url: - type: string - received_events_url: - type: string - type: - type: string - site_admin: - type: boolean - private: - type: boolean - html_url: - type: string - description: - type: string - fork: - type: boolean - url: - type: string - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - downloads_url: - type: string - events_url: - type: string - forks_url: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - pulls_url: - type: string - releases_url: - type: string - ssh_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - clone_url: - type: string - mirror_url: - type: string - hooks_url: - type: string - svn_url: - type: string - homepage: - type: string - language: - type: string - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - type: integer - default_branch: - type: string - open_issues_count: - type: integer - is_template: - type: boolean - topics: - type: array - items: - type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - archived: - type: boolean - disabled: - type: boolean - visibility: - type: string - pushed_at: - type: string - created_at: - type: string - updated_at: - type: string - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - allow_rebase_merge: - type: boolean - temp_clone_token: - type: string - allow_squash_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_update_branch: - type: boolean - use_squash_pr_title_as_default: - type: boolean - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer - temp_clone_token: - type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull - requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - default: false - type: boolean - example: false - allow_update_branch: - description: Whether or not a pull request head branch that - is behind its base branch can always be updated even if it - is not required to be up to date before merging. - default: false - type: boolean - example: false - use_squash_pr_title_as_default: - type: boolean - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead. - default: false - deprecated: true - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true - allow_forking: - description: Whether to allow forking this repo - type: boolean - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - default: false - type: boolean - subscribers_count: - type: integer - network_count: - type: integer - open_issues: - type: integer - watchers: - type: integer - master_branch: - type: string - starred_at: - type: string - example: '"2020-07-09T00:17:42Z"' - anonymous_access_enabled: - type: boolean - description: Whether anonymous git access is enabled for this - repository - required: &778 - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - node_id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - x-github-breaking-changes: &779 - - changeset: remove_use_squash_pr_title_as_default - patch: - properties: - use_squash_pr_title_as_default: - template_repository: - properties: - use_squash_pr_title_as_default: - version: '2026-03-10' - - changeset: deprecate_beta_media_type - patch: - properties: - master_branch: - version: '2026-03-10' - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: branch_protection_configuration - supported-webhook-types: - - repository - - organization - - app - branch-protection-configuration-enabled: - post: - summary: |- - This event occurs when there is a change to branch protection configurations for a repository. - For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." - For information about using the APIs to manage branch protection rules, see "[Branch protection rule](https://docs.github.com/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: All branch protections were enabled for a repository. - operationId: branch-protection-configuration/enabled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: branch_protection_configuration - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: branch protection configuration enabled event - type: object - properties: - action: - type: string - enum: - - enabled - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: branch_protection_configuration - supported-webhook-types: - - repository - - organization - - app - branch-protection-rule-created: - post: - summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: A branch protection rule was created. - operationId: branch-protection-rule/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: branch_protection_rule - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: branch protection rule created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - rule: &746 - title: branch protection rule - description: The branch protection rule. Includes a `name` and all - the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or - `everyone`. Actor and build lists are arrays of strings. - type: object - properties: - admin_enforced: - type: boolean - allow_deletions_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: - type: array - items: - type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean - created_at: - type: string - format: date-time - dismiss_stale_reviews_on_push: - type: boolean - id: - type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - lock_branch_enforcement_level: - description: The enforcement level of the branch lock setting. - `off` means the branch is not locked, `non_admins` means the - branch is read-only for non_admins, and `everyone` means the - branch is read-only for everyone. - type: string - enum: - - 'off' - - non_admins - - everyone - lock_allows_fork_sync: - description: Whether users can pull changes from upstream when - the branch is locked. Set to `true` to allow users to pull - changes from upstream when the branch is locked. This setting - is only applicable for forks. - type: boolean - merge_queue_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - name: - type: string - pull_request_reviews_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: - type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by - someone other than the person who pushed it - type: boolean - required_approving_review_count: - type: integer - required_conversation_resolution_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: - type: boolean - updated_at: - type: string - format: date-time - required: - - id - - repository_id - - name - - created_at - - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - lock_branch_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: *4 - required: - - action - - rule - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: branch_protection_rule - supported-webhook-types: - - repository - - organization - - app - branch-protection-rule-deleted: - post: - summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: A branch protection rule was deleted. - operationId: branch-protection-rule/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: branch_protection_rule - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: branch protection rule deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - rule: *746 - sender: *4 - required: - - action - - rule - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: branch_protection_rule - supported-webhook-types: - - repository - - organization - - app - branch-protection-rule-edited: - post: - summary: |- - This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/rest/branches/branch-protection)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - description: A branch protection rule was edited. - operationId: branch-protection-rule/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: branch_protection_rule - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: branch protection rule edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: If the action was `edited`, the changes to the rule. - type: object - properties: - admin_enforced: - type: object - properties: - from: - type: boolean - nullable: true - required: - - from - authorized_actor_names: - type: object - properties: - from: - type: array - items: - type: string - required: - - from - authorized_actors_only: - type: object - properties: - from: - type: boolean - nullable: true - required: - - from - authorized_dismissal_actors_only: - type: object - properties: - from: - type: boolean - nullable: true - required: - - from - linear_history_requirement_enforcement_level: - type: object - properties: - from: - type: string - enum: - - 'off' - - non_admins - - everyone - required: - - from - lock_branch_enforcement_level: - type: object - properties: - from: - type: string - enum: - - 'off' - - non_admins - - everyone - required: - - from - lock_allows_fork_sync: - type: object - properties: - from: - type: boolean - nullable: true - required: - - from - pull_request_reviews_enforcement_level: - type: object - properties: - from: - type: string - enum: - - 'off' - - non_admins - - everyone - required: - - from - require_last_push_approval: - type: object - properties: - from: - type: boolean - nullable: true - required: - - from - required_status_checks: - type: object - properties: - from: - type: array - items: - type: string - required: - - from - required_status_checks_enforcement_level: - type: object - properties: - from: - type: string - enum: - - 'off' - - non_admins - - everyone - required: - - from - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - rule: *746 - sender: *4 - required: - - action - - rule - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: branch_protection_rule - supported-webhook-types: - - repository - - organization - - app - check-run-completed: - post: - summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. - - For activity relating to check suites, use the `check-suite` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: A check run was completed, and a conclusion is available. - operationId: check-run/completed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Check Run Completed Event - type: object - properties: - action: - type: string - enum: - - completed - check_run: &748 - title: CheckRun - description: A check performed on the code of a given code change - type: object - properties: - app: *5 - check_suite: - description: A suite of checks performed on the code of a given - code change - type: object - properties: - after: - example: d6fde92930d4715a2b49857d24b940956b26d2d3 - type: string - nullable: true - app: *5 - before: - example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 - type: string - nullable: true - conclusion: - example: neutral - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - skipped - - timed_out - - action_required - - stale - - startup_failure - created_at: - type: string - format: date-time - head_branch: - example: master - type: string - nullable: true - head_sha: - description: The SHA of the head commit that is being checked. - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - id: - example: 5 - type: integer - node_id: - example: MDEwOkNoZWNrU3VpdGU1 - type: string - pull_requests: - type: array - items: *90 - repository: *160 - status: - example: completed - type: string - enum: - - queued - - in_progress - - completed - - pending - - waiting - updated_at: - type: string - format: date-time - url: - example: https://api.github.com/repos/github/hello-world/check-suites/5 - type: string - completed_at: - example: '2018-05-04T01:14:52Z' - type: string - nullable: true - format: date-time - conclusion: - example: neutral - type: string - nullable: true - enum: - - waiting - - pending - - startup_failure - - stale - - success - - failure - - neutral - - cancelled - - skipped - - timed_out - - action_required - deployment: *747 - details_url: - example: https://example.com - type: string - external_id: - example: '42' - type: string - head_sha: - description: The SHA of the commit that is being checked. - example: '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' - type: string - html_url: - example: https://github.com/github/hello-world/runs/4 - type: string - id: - description: The id of the check. - example: 21 - type: integer - name: - description: The name of the check. - example: test-coverage - type: string - node_id: - example: MDg6Q2hlY2tSdW40 - type: string - output: - type: object - properties: - annotations_count: - type: integer - annotations_url: - type: string - format: uri - summary: - type: string - nullable: true - text: - type: string - nullable: true - title: - type: string - nullable: true - required: - - title - - summary - - text - - annotations_count - - annotations_url - pull_requests: - type: array - items: *90 - started_at: - example: '2018-05-04T01:14:52Z' - type: string - format: date-time - status: - description: The phase of the lifecycle that the check is currently - in. - example: queued - type: string - enum: - - queued - - in_progress - - completed - - pending - url: - example: https://api.github.com/repos/github/hello-world/check-runs/4 - type: string - required: - - id - - node_id - - head_sha - - name - - url - - html_url - - details_url - - status - - conclusion - - started_at - - completed_at - - external_id - - check_suite - - output - - app - - pull_requests - installation: *743 - enterprise: *742 - organization: *744 - repository: *745 - sender: *4 - required: - - check_run - - repository - - sender - examples: - default: - value: - action: completed - check_run: - id: 128620228 - node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - external_id: '' - url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 - html_url: https://github.com/Codertocat/Hello-World/runs/128620228 - details_url: https://octocoders.github.io - status: completed - conclusion: success - started_at: '2019-05-15T15:21:12Z' - completed_at: '2019-05-15T15:21:45Z' - output: - title: - summary: - text: - annotations_count: 0 - annotations_url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations - name: Octocoders-linter - check_suite: - id: 118578147 - node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= - head_branch: changes - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - status: completed - conclusion: - url: https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 - before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 - after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - deployment: - url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 - id: 326191728 - node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= - task: deploy - original_environment: lab - environment: lab - description: - created_at: '2021-02-18T08:22:48Z' - updated_at: '2021-02-18T09:47:16Z' - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses - repository_url: https://api.github.com/repos/Codertocat/Hello-World - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - created_at: '2019-05-15T15:20:31Z' - updated_at: '2019-05-15T15:20:31Z' - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - repository: - id: 186853002 - node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= - name: Hello-World - full_name: Codertocat/Hello-World - private: false - owner: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - html_url: https://github.com/Codertocat/Hello-World - description: - fork: false - url: https://api.github.com/repos/Codertocat/Hello-World - forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks - keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams - hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks - issue_events_url: https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/Codertocat/Hello-World/events - assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags - blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages - stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers - contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors - subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription - commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/Codertocat/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges - archive_url: https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads - issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments - created_at: '2019-05-15T15:19:25Z' - updated_at: '2019-05-15T15:21:03Z' - pushed_at: '2019-05-15T15:20:57Z' - git_url: git://github.com/Codertocat/Hello-World.git - ssh_url: git@github.com:Codertocat/Hello-World.git - clone_url: https://github.com/Codertocat/Hello-World.git - svn_url: https://github.com/Codertocat/Hello-World - homepage: - size: 0 - stargazers_count: 0 - watchers_count: 0 - language: Ruby - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: true - forks_count: 1 - mirror_url: - archived: false - disabled: false - open_issues_count: 2 - license: - forks: 1 - open_issues: 2 - watchers: 0 - default_branch: master - is_template: false - sender: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - application/x-www-form-urlencoded: - schema: - title: Check Run Completed Event - description: The check_run.completed webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.completed JSON - payload. The decoded payload is a JSON object. - type: string - required: - - payload - examples: - default: - value: - payload: "%7B%22action%22%3A%22completed%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: check_run - supported-webhook-types: - - repository - - organization - - app - check-run-created: - post: - summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. - - For activity relating to check suites, use the `check-suite` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: A new check run was created. - operationId: check-run/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Check Run Created Event - type: object - properties: - action: - type: string - enum: - - created - check_run: *748 - installation: *743 - enterprise: *742 - organization: *744 - repository: *745 - sender: *4 - required: - - check_run - - repository - - sender - examples: - default: - value: - action: created - check_run: - id: 128620228 - node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - external_id: '' - url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 - html_url: https://github.com/Codertocat/Hello-World/runs/128620228 - details_url: https://octocoders.github.io - status: queued - conclusion: - started_at: '2019-05-15T15:21:12Z' - completed_at: - output: - title: - summary: - text: - annotations_count: 0 - annotations_url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations - name: Octocoders-linter - check_suite: - id: 118578147 - node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= - head_branch: changes - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - status: queued - conclusion: - url: https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 - before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 - after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - deployment: - url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 - id: 326191728 - node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= - task: deploy - original_environment: lab - environment: lab - description: - created_at: '2021-02-18T08:22:48Z' - updated_at: '2021-02-18T09:47:16Z' - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses - repository_url: https://api.github.com/repos/Codertocat/Hello-World - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - created_at: '2019-05-15T15:20:31Z' - updated_at: '2019-05-15T15:20:31Z' - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - repository: - id: 186853002 - node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= - name: Hello-World - full_name: Codertocat/Hello-World - private: false - owner: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - html_url: https://github.com/Codertocat/Hello-World - description: - fork: false - url: https://api.github.com/repos/Codertocat/Hello-World - forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks - keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams - hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks - issue_events_url: https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/Codertocat/Hello-World/events - assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags - blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages - stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers - contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors - subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription - commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/Codertocat/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges - archive_url: https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads - issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments - created_at: '2019-05-15T15:19:25Z' - updated_at: '2019-05-15T15:21:03Z' - pushed_at: '2019-05-15T15:20:57Z' - git_url: git://github.com/Codertocat/Hello-World.git - ssh_url: git@github.com:Codertocat/Hello-World.git - clone_url: https://github.com/Codertocat/Hello-World.git - svn_url: https://github.com/Codertocat/Hello-World - homepage: - size: 0 - stargazers_count: 0 - watchers_count: 0 - language: Ruby - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: true - forks_count: 1 - mirror_url: - archived: false - disabled: false - open_issues_count: 2 - license: - forks: 1 - open_issues: 2 - watchers: 0 - default_branch: master - is_template: false - sender: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - application/x-www-form-urlencoded: - schema: - title: Check Run Created Event - description: The check_run.created webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.created JSON - payload. The decoded payload is a JSON object. - type: string - required: - - payload - examples: - default: - value: - payload: "%7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: check_run - supported-webhook-types: - - repository - - organization - - app - check-run-requested-action: - post: - summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. - - For activity relating to check suites, use the `check-suite` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: A check run completed, and someone requested a followup action - that your app provides. Only the GitHub App someone requests to perform an - action will receive the `requested_action` payload. For more information, - see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)." - operationId: check-run/requested-action - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Check Run Requested Action Event - type: object - properties: - action: - type: string - enum: - - requested_action - check_run: *748 - installation: *743 - enterprise: *742 - organization: *744 - repository: *745 - requested_action: - description: The action requested by the user. - type: object - properties: - identifier: - description: The integrator reference of the action requested - by the user. - type: string - sender: *4 - required: - - action - - check_run - - repository - - sender - examples: - default: - value: - action: requested_action - check_run: - id: 128620228 - node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - external_id: '' - url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 - html_url: https://github.com/Codertocat/Hello-World/runs/128620228 - details_url: https://octocoders.github.io - status: queued - conclusion: - started_at: '2019-05-15T15:21:12Z' - completed_at: - output: - title: - summary: - text: - annotations_count: 0 - annotations_url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations - name: Octocoders-linter - check_suite: - id: 118578147 - node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= - head_branch: changes - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - status: queued - conclusion: - url: https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 - before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 - after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - created_at: '2019-05-15T15:20:31Z' - updated_at: '2019-05-15T15:20:31Z' - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - deployment: - url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 - id: 326191728 - node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= - task: deploy - original_environment: lab - environment: lab - description: - created_at: '2021-02-18T08:22:48Z' - updated_at: '2021-02-18T09:47:16Z' - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses - repository_url: https://api.github.com/repos/Codertocat/Hello-World - requested_action: - identifier: lgtm|1234 - repository: - id: 186853002 - node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= - name: Hello-World - full_name: Codertocat/Hello-World - private: false - owner: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - html_url: https://github.com/Codertocat/Hello-World - description: - fork: false - url: https://api.github.com/repos/Codertocat/Hello-World - forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks - keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams - hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks - issue_events_url: https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/Codertocat/Hello-World/events - assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags - blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages - stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers - contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors - subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription - commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/Codertocat/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges - archive_url: https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads - issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments - created_at: '2019-05-15T15:19:25Z' - updated_at: '2019-05-15T15:21:03Z' - pushed_at: '2019-05-15T15:20:57Z' - git_url: git://github.com/Codertocat/Hello-World.git - ssh_url: git@github.com:Codertocat/Hello-World.git - clone_url: https://github.com/Codertocat/Hello-World.git - svn_url: https://github.com/Codertocat/Hello-World - homepage: - size: 0 - stargazers_count: 0 - watchers_count: 0 - language: Ruby - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: true - forks_count: 1 - mirror_url: - archived: false - disabled: false - open_issues_count: 2 - license: - forks: 1 - open_issues: 2 - watchers: 0 - default_branch: master - sender: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - application/x-www-form-urlencoded: - schema: - title: Check Run Requested Action Event - description: The check_run.requested_action webhook encoded with URL - encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.requested_action - JSON payload. The decoded payload is a JSON object. - type: string - required: - - payload - examples: - default: - value: - payload: "%7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: check_run - supported-webhook-types: - - repository - - organization - - app - check-run-rerequested: - post: - summary: |- - This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/rest/checks/runs)" in the REST API documentation. - - For activity relating to check suites, use the `check-suite` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run a check run. Only the GitHub App that - someone requests to re-run the check will receive the `rerequested` payload. - operationId: check-run/rerequested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Check Run Re-Requested Event - type: object - properties: - action: - type: string - enum: - - rerequested - check_run: *748 - installation: *743 - enterprise: *742 - organization: *744 - repository: *745 - sender: *4 - required: - - check_run - - repository - - sender - examples: - default: - value: - action: rerequested - check_run: - id: 128620228 - node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - external_id: '' - url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 - html_url: https://github.com/Codertocat/Hello-World/runs/128620228 - details_url: https://octocoders.github.io - status: completed - conclusion: success - started_at: '2019-05-15T15:21:12Z' - completed_at: '2019-05-15T15:21:45Z' - output: - title: - summary: - text: - annotations_count: 0 - annotations_url: https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations - name: Octocoders-linter - check_suite: - id: 118578147 - node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= - head_branch: changes - head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - status: completed - conclusion: - url: https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 - before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 - after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - deployment: - url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 - id: 326191728 - node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= - task: deploy - original_environment: lab - environment: lab - description: - created_at: '2021-02-18T08:22:48Z' - updated_at: '2021-02-18T09:47:16Z' - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses - repository_url: https://api.github.com/repos/Codertocat/Hello-World - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - created_at: '2019-05-15T15:20:31Z' - updated_at: '2019-05-15T15:20:31Z' - app: - id: 29310 - node_id: MDM6QXBwMjkzMTA= - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - name: octocoders-linter - description: '' - external_url: https://octocoders.github.io - html_url: https://github.com/apps/octocoders-linter - created_at: '2019-04-19T19:36:24Z' - updated_at: '2019-04-19T19:36:56Z' - permissions: - administration: write - checks: write - contents: write - deployments: write - issues: write - members: write - metadata: read - organization_administration: write - organization_hooks: write - organization_plan: read - organization_projects: write - organization_user_blocking: write - pages: write - pull_requests: write - repository_hooks: write - repository_projects: write - statuses: write - vulnerability_alerts: read - events: [] - pull_requests: - - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 - id: 279147437 - number: 2 - head: - ref: changes - sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - base: - ref: master - sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e - repo: - id: 186853002 - url: https://api.github.com/repos/Codertocat/Hello-World - name: Hello-World - repository: - id: 186853002 - node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= - name: Hello-World - full_name: Codertocat/Hello-World - private: false - owner: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - html_url: https://github.com/Codertocat/Hello-World - description: - fork: false - url: https://api.github.com/repos/Codertocat/Hello-World - forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks - keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams - hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks - issue_events_url: https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/Codertocat/Hello-World/events - assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags - blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages - stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers - contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors - subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers - subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription - commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/Codertocat/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges - archive_url: https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads - issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments - created_at: '2019-05-15T15:19:25Z' - updated_at: '2019-05-15T15:21:03Z' - pushed_at: '2019-05-15T15:20:57Z' - git_url: git://github.com/Codertocat/Hello-World.git - ssh_url: git@github.com:Codertocat/Hello-World.git - clone_url: https://github.com/Codertocat/Hello-World.git - svn_url: https://github.com/Codertocat/Hello-World - homepage: - size: 0 - stargazers_count: 0 - watchers_count: 0 - language: Ruby - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: true - forks_count: 1 - mirror_url: - archived: false - disabled: false - open_issues_count: 2 - license: - forks: 1 - open_issues: 2 - watchers: 0 - default_branch: master - is_template: false - sender: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - application/x-www-form-urlencoded: - schema: - title: Check Run Re-Requested Event - description: The check_run.rerequested webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.rerequested JSON - payload. The decoded payload is a JSON object. - type: string - required: - - payload - examples: - default: - value: - payload: "%7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: check_run - supported-webhook-types: - - repository - - organization - - app - check-suite-completed: - post: - summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: All check runs in a check suite have completed, and a conclusion - is available. - operationId: check-suite/completed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_suite - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: check_suite completed event - type: object - properties: - action: - type: string - enum: - - completed - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). - type: object - properties: - after: - type: string - nullable: true - app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - merge_group - - pull_request_review_thread - - workflow_job - - merge_queue_entry - - security_and_analysis - - projects_v2_item - - secret_scanning_alert_location - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - client_id: - description: The client ID of the GitHub app - type: string - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: - type: string - nullable: true - check_runs_url: - type: string - format: uri - conclusion: - description: The summary conclusion for all check runs that - are part of the check suite. This value will be `null` until - the check run has `completed`. - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - - skipped - - startup_failure - created_at: - type: string - format: date-time - head_branch: - description: The head branch name the changes are on. - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. - type: string - id: - type: integer - latest_check_runs_count: - type: integer - node_id: - type: string - pull_requests: - description: An array of pull requests that match this check - suite. A pull request matches a check suite if they have the - same `head_sha` and `head_branch`. When the check suite's - `head_branch` is in a forked repository it will be `null` - and the `pull_requests` array will be empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: - type: boolean - runs_rerequestable: - type: boolean - status: - description: The summary status for all check runs that are - part of the check suite. Can be `requested`, `in_progress`, - or `completed`. - type: string - nullable: true - enum: - - requested - - in_progress - - completed - - queued - - null - - pending - updated_at: - type: string - format: date-time - url: - description: URL that points to the check suite API resource. - type: string - format: uri - required: - - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - check_suite - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: check_suite - supported-webhook-types: - - repository - - organization - - app - check-suite-requested: - post: - summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to run a check suite. By default, check suites - are automatically created when you create a check run. For more information, - see [the GraphQL API documentation for creating a check run](https://docs.github.com/graphql/reference/mutations#createcheckrun) - or "[Create a check run](https://docs.github.com/rest/checks/runs#create-a-check-run)" - in the REST API documentation. - operationId: check-suite/requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_suite - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: check_suite requested event - type: object - properties: - action: - type: string - enum: - - requested - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). - type: object - properties: - after: - type: string - nullable: true - app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - workflow_job - - merge_queue_entry - - security_and_analysis - - secret_scanning_alert_location - - projects_v2_item - - merge_group - - repository_import - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - client_id: - description: Client ID of the GitHub app - type: string - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - artifact_metadata: - type: string - enum: - - read - - write - attestations: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - copilot_requests: - type: string - enum: - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - merge_queues: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - models: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: - type: string - nullable: true - check_runs_url: - type: string - format: uri - conclusion: - description: The summary conclusion for all check runs that - are part of the check suite. This value will be `null` until - the check run has completed. - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - - skipped - created_at: - type: string - format: date-time - head_branch: - description: The head branch name the changes are on. - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. - type: string - id: - type: integer - latest_check_runs_count: - type: integer - node_id: - type: string - pull_requests: - description: An array of pull requests that match this check - suite. A pull request matches a check suite if they have the - same `head_sha` and `head_branch`. When the check suite's - `head_branch` is in a forked repository it will be `null` - and the `pull_requests` array will be empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: - type: boolean - runs_rerequestable: - type: boolean - status: - description: The summary status for all check runs that are - part of the check suite. Can be `requested`, `in_progress`, - or `completed`. - type: string - nullable: true - enum: - - requested - - in_progress - - completed - - queued - - null - updated_at: - type: string - format: date-time - url: - description: URL that points to the check suite API resource. - type: string - format: uri - required: - - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - check_suite - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: check_suite - supported-webhook-types: - - repository - - organization - - app - check-suite-rerequested: - post: - summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. - - > [!NOTE] - > The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run the check runs in a check suite. For - more information, see [the GraphQL API documentation for creating a check - suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) - or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" - in the REST API documentation. - operationId: check-suite/rerequested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: check_suite - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: check_suite rerequested event - type: object - properties: - action: - type: string - enum: - - rerequested - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). - type: object - properties: - after: - type: string - nullable: true - app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - client_id: - description: The Client ID for the GitHub app - type: string - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - artifact_metadata: - type: string - enum: - - read - - write - attestations: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - copilot_requests: - type: string - enum: - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - merge_queues: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - models: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: - type: string - nullable: true - check_runs_url: - type: string - format: uri - conclusion: - description: The summary conclusion for all check runs that - are part of the check suite. This value will be `null` until - the check run has completed. - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - created_at: - type: string - format: date-time - head_branch: - description: The head branch name the changes are on. - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. - type: string - id: - type: integer - latest_check_runs_count: - type: integer - node_id: - type: string - pull_requests: - description: An array of pull requests that match this check - suite. A pull request matches a check suite if they have the - same `head_sha` and `head_branch`. When the check suite's - `head_branch` is in a forked repository it will be `null` - and the `pull_requests` array will be empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: - type: boolean - runs_rerequestable: - type: boolean - status: - description: The summary status for all check runs that are - part of the check suite. Can be `requested`, `in_progress`, - or `completed`. - type: string - nullable: true - enum: - - requested - - in_progress - - completed - - queued - - null - updated_at: - type: string - format: date-time - url: - description: URL that points to the check suite API resource. - type: string - format: uri - required: - - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - check_suite - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: check_suite - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-appeared-in-branch: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously created code scanning alert appeared in another branch. - This can happen when a branch is merged into or created from a branch with - a pre-existing code scanning alert. - operationId: code-scanning-alert/appeared-in-branch - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert appeared_in_branch event - type: object - properties: - action: - type: string - enum: - - appeared_in_branch - alert: - description: The code scanning alert involved in the event. - type: object - properties: - assignees: - type: array - items: *4 - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - nullable: true - format: date-time - dismissed_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - dismissed_comment: *437 - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: string - nullable: true - enum: - - false positive - - won't fix - - used in tests - - null - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts - found outside the default branch will return a `null` value - until they are dismissed or fixed. - nullable: true - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: &749 - description: The commit SHA of the code scanning alert. When the - action is `reopened_by_user` or `closed_by_user`, the event was - triggered by the `sender` and this value will be empty. - type: string - enterprise: *742 - installation: *743 - organization: *744 - ref: &750 - description: The Git reference of the code scanning alert. When - the action is `reopened_by_user` or `closed_by_user`, the event - was triggered by the `sender` and this value will be empty. - type: string - repository: *745 - sender: *4 - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-closed-by-user: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone closed a code scanning alert. - operationId: code-scanning-alert/closed-by-user - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert closed_by_user event - type: object - properties: - action: - type: string - enum: - - closed_by_user - alert: - description: The code scanning alert involved in the event. - type: object - properties: - assignees: - type: array - items: *4 - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - format: date-time - dismissed_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - dismissed_comment: *437 - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: string - nullable: true - enum: - - false positive - - won't fix - - used in tests - - null - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - full_description: - type: string - help: - type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used - to detect the alert. - type: string - nullable: true - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - name: - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - tags: - type: array - nullable: true - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - dismissed - - fixed - tool: - type: object - properties: - guid: - type: string - nullable: true - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - url: - type: string - format: uri - dismissal_approved_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: *749 - enterprise: *742 - installation: *743 - organization: *744 - ref: *750 - repository: *745 - sender: *4 - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-created: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A code scanning alert was created in a repository. - operationId: code-scanning-alert/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - nullable: true - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - dismissed_by: - nullable: true - dismissed_comment: *437 - dismissed_reason: - description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' - nullable: true - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - instances_url: - type: string - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - full_description: - type: string - help: - type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used - to detect the alert. - type: string - nullable: true - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - name: - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - tags: - type: array - nullable: true - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts - found outside the default branch will return a `null` value - until they are dismissed or fixed. - type: string - nullable: true - enum: - - open - - dismissed - tool: - type: object - nullable: true - properties: - guid: - type: string - nullable: true - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - updated_at: - type: string - nullable: true - url: - type: string - format: uri - dismissal_approved_by: - nullable: true - assignees: - type: array - items: *4 - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: *749 - enterprise: *742 - installation: *743 - organization: *744 - ref: *750 - repository: *745 - sender: *4 - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-fixed: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A code scanning alert was fixed in a branch by a commit. - operationId: code-scanning-alert/fixed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert fixed event - type: object - properties: - action: - type: string - enum: - - fixed - alert: - description: The code scanning alert involved in the event. - type: object - properties: - assignees: - type: array - items: *4 - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - nullable: true - format: date-time - dismissed_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - dismissed_comment: *437 - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: string - nullable: true - enum: - - false positive - - won't fix - - used in tests - - null - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - instances_url: - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - full_description: - type: string - help: - type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used - to detect the alert. - type: string - nullable: true - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - name: - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - tags: - type: array - nullable: true - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts - found outside the default branch will return a `null` value - until they are dismissed or fixed. - nullable: true - type: string - enum: - - fixed - tool: - type: object - properties: - guid: - type: string - nullable: true - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: *749 - enterprise: *742 - installation: *743 - organization: *744 - ref: *750 - repository: *745 - sender: *4 - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-reopened: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously fixed code scanning alert reappeared in a branch. - operationId: code-scanning-alert/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: - description: The code scanning alert involved in the event. - type: object - properties: - assignees: - type: array - items: *4 - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - nullable: true - dismissed_by: - type: object - nullable: true - dismissed_comment: *437 - dismissed_reason: - description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' - type: string - nullable: true - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - instances_url: - type: string - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - full_description: - type: string - help: - type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used - to detect the alert. - type: string - nullable: true - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - name: - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - tags: - type: array - nullable: true - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts - found outside the default branch will return a `null` value - until they are dismissed or fixed. - nullable: true - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - guid: - type: string - nullable: true - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - updated_at: - type: string - nullable: true - url: - type: string - format: uri - dismissal_approved_by: - nullable: true - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the - action is `reopened_by_user` or `closed_by_user`, the event was - triggered by the `sender` and this value will be empty. - type: string - nullable: true - enterprise: *742 - installation: *743 - organization: *744 - ref: - description: The Git reference of the code scanning alert. When - the action is `reopened_by_user` or `closed_by_user`, the event - was triggered by the `sender` and this value will be empty. - type: string - nullable: true - repository: *745 - sender: *4 - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-reopened-by-user: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone reopened a code scanning alert. - operationId: code-scanning-alert/reopened-by-user - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert reopened_by_user event - type: object - properties: - action: - type: string - enum: - - reopened_by_user - alert: - description: The code scanning alert involved in the event. - type: object - properties: - assignees: - type: array - items: *4 - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - dismissed_by: - nullable: true - dismissed_comment: *437 - dismissed_reason: - description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' - nullable: true - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts - found outside the default branch will return a `null` value - until they are dismissed or fixed. - nullable: true - type: string - enum: - - open - - fixed - tool: - type: object - properties: - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: *749 - enterprise: *742 - installation: *743 - organization: *744 - ref: *750 - repository: *745 - sender: *4 - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - code-scanning-alert-updated-assignment: - post: - summary: |- - This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: The assignees list of a code scanning alert has been updated. - operationId: code-scanning-alert/updated-assignment - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: code_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: code_scanning_alert updated_assignment event - type: object - properties: - action: - type: string - enum: - - updated_assignment - alert: - description: The code scanning alert involved in the event. - type: object - properties: - assignees: - type: array - items: *4 - created_at: - description: 'The time that the alert was created in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - nullable: true - format: date-time - dismissed_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - dismissed_comment: *437 - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: string - nullable: true - enum: - - false positive - - won't fix - - used in tests - - null - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the - analysis was executed. For example, in GitHub Actions - this includes the workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the - analysis was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with - the environment in which the analysis that generated this - alert instance was performed, such as the language that - was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect - the alert. - type: string - id: - description: A unique identifier for the rule used to detect - the alert. - type: string - severity: - description: The severity of the alert. - type: string - nullable: true - enum: - - none - - note - - warning - - error - - null - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts - found outside the default branch will return a `null` value - until they are dismissed or fixed. - nullable: true - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - name: - description: The name of the tool used to generate the code - scanning analysis alert. - type: string - version: - description: The version of the tool used to detect the - alert. - type: string - nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: code_scanning_alert - supported-webhook-types: - - repository - - organization - - app - commit-comment-created: - post: - summary: |- - This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/rest/commits/comments)" in the REST API documentation. - - For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: Someone commented on a commit. - operationId: commit-comment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: commit_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: commit_comment created event - type: object - properties: - action: - description: The action performed. Can be `created`. - type: string - enum: - - created - comment: - description: The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) - resource. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - html_url: - type: string - format: uri - id: - description: The ID of the commit comment. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - nullable: true - node_id: - description: The node ID of the commit comment. - type: string - path: - description: The relative path of the file to which the comment - applies. - type: string - nullable: true - position: - description: The line index in the diff to which the comment - applies. - type: integer - nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - html_url - - id - - node_id - - user - - position - - line - - path - - commit_id - - created_at - - updated_at - - author_association - - body - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - comment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: commit_comment - supported-webhook-types: - - repository - - organization - - app - create: - post: - summary: |- - This event occurs when a Git branch or tag is created. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - - **Notes**: - - This event will not occur when more than three tags are created at once. - - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. - operationId: create - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#create - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: create - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: create event - type: object - properties: - description: - description: The repository's current description. - type: string - nullable: true - enterprise: *742 - installation: *743 - master_branch: - description: The name of the repository's default branch (usually - `main`). - type: string - organization: *744 - pusher_type: &751 - description: The pusher type for the event. Can be either `user` - or a deploy key. - type: string - ref: &752 - description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) - resource. - type: string - ref_type: - description: The type of Git ref object created in the repository. - type: string - enum: - - tag - - branch - repository: *745 - sender: *4 - required: - - ref - - ref_type - - master_branch - - description - - pusher_type - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: create - supported-webhook-types: - - repository - - organization - - app - custom-property-created: - post: - summary: |- - This event occurs when there is activity relating to a custom property. - - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A new custom property was created. - operationId: custom-property/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: custom_property - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: custom property created event - type: object - properties: - action: - type: string - enum: - - created - definition: *291 - enterprise: *742 - installation: *743 - organization: *744 - sender: *4 - required: - - action - - definition - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: custom_property - supported-webhook-types: - - business - - organization - - app - custom-property-deleted: - post: - summary: |- - This event occurs when there is activity relating to a custom property. - - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was deleted. - operationId: custom-property/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: custom_property - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: custom property deleted event - type: object - properties: - action: - type: string - enum: - - deleted - definition: - type: object - properties: - property_name: - type: string - description: The name of the property that was deleted. - required: - - property_name - enterprise: *742 - installation: *743 - organization: *744 - sender: *4 - required: - - action - - definition - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: custom_property - supported-webhook-types: - - business - - organization - - app - custom-property-promoted-to-enterprise: - post: - summary: |- - This event occurs when there is activity relating to a custom property. - - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was promoted to an enterprise. - operationId: custom-property/promote-to-enterprise - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: custom_property - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: custom property promoted to business event - type: object - properties: - action: - type: string - enum: - - promote_to_enterprise - definition: *291 - enterprise: *742 - installation: *743 - organization: *744 - sender: *4 - required: - - action - - definition - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: custom_property - supported-webhook-types: - - business - - organization - - app - custom-property-updated: - post: - summary: |- - This event occurs when there is activity relating to a custom property. - - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was updated. - operationId: custom-property/updated - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: custom_property - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: custom property updated event - type: object - properties: - action: - type: string - enum: - - updated - definition: *291 - enterprise: *742 - installation: *743 - organization: *744 - sender: *4 - required: - - action - - definition - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: custom_property - supported-webhook-types: - - business - - organization - - app - custom-property-values-updated: - post: - summary: |- - This event occurs when there is activity relating to custom property values for a repository. - - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/rest/repos/custom-properties)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: The custom property values of a repository were updated. - operationId: custom-property-values/updated - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: custom_property_values - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Custom property values updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: *742 - installation: *743 - repository: *745 - organization: *744 - sender: *4 - new_property_values: - type: array - description: The new custom property values for the repository. - items: *295 - old_property_values: - type: array - description: The old custom property values for the repository. - items: *295 - required: - - action - - repository - - organization - - new_property_values - - old_property_values - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: custom-property-values - supported-webhook-types: - - repository - - organization - - app - delete: - post: - summary: |- - This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including - branch and tag deletions, use the [`push`](#push) webhook event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - - > [!NOTE] - > This event will not occur when more than three tags are deleted at once. - operationId: delete - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: delete - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: delete event - type: object - properties: - enterprise: *742 - installation: *743 - organization: *744 - pusher_type: *751 - ref: *752 - ref_type: - description: The type of Git ref object deleted in the repository. - type: string - enum: - - tag - - branch - repository: *745 - sender: *4 - required: - - ref - - ref_type - - pusher_type - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: delete - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-assignees-changed: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: The assignees for a Dependabot alert were updated. - operationId: dependabot-alert/assignees-changed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert assignees changed event - type: object - properties: - action: - type: string - enum: - - assignees_changed - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-auto-dismissed: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A Dependabot alert was automatically closed by a Dependabot auto-triage - rule. - operationId: dependabot-alert/auto-dismissed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert auto-dismissed event - type: object - properties: - action: - type: string - enum: - - auto_dismissed - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-auto-reopened: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A Dependabot alert, that had been automatically closed by a Dependabot - auto-triage rule, was automatically reopened because the alert metadata or - rule changed. - operationId: dependabot-alert/auto-reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert auto-reopened event - type: object - properties: - action: - type: string - enum: - - auto_reopened - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-created: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A manifest file change introduced a vulnerable dependency, or a - GitHub Security Advisory was published and an existing dependency was found - to be vulnerable. - operationId: dependabot-alert/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-dismissed: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A Dependabot alert was manually closed. - operationId: dependabot-alert/dismissed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert dismissed event - type: object - properties: - action: - type: string - enum: - - dismissed - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-fixed: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A manifest file change removed a vulnerability. - operationId: dependabot-alert/fixed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert fixed event - type: object - properties: - action: - type: string - enum: - - fixed - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-reintroduced: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A manifest file change introduced a vulnerable dependency that - had previously been fixed. - operationId: dependabot-alert/reintroduced - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert reintroduced event - type: object - properties: - action: - type: string - enum: - - reintroduced - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - dependabot-alert-reopened: - post: - summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. - description: A Dependabot alert was manually reopened. - operationId: dependabot-alert/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: dependabot_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Dependabot alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: *501 - installation: *743 - organization: *744 - enterprise: *742 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: dependabot_alert - supported-webhook-types: - - repository - - organization - - app - deploy-key-created: - post: - summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was created. - operationId: deploy-key/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deploy_key - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: deploy_key created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - key: &753 - description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) - resource. - type: object - properties: - added_by: - type: string - nullable: true - created_at: - type: string - id: - type: integer - key: - type: string - last_used: - type: string - nullable: true - read_only: - type: boolean - title: - type: string - url: - type: string - format: uri - verified: - type: boolean - enabled: - type: boolean - required: - - id - - key - - url - - title - - verified - - created_at - - read_only - organization: *744 - repository: *745 - sender: *4 - required: - - action - - key - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deploy_key - supported-webhook-types: - - repository - - organization - - app - deploy-key-deleted: - post: - summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was deleted. - operationId: deploy-key/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deploy_key - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: deploy_key deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - key: *753 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - key - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deploy_key - supported-webhook-types: - - repository - - organization - - app - deployment-created: - post: - summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment status, use the `deployment_status` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment was created. - operationId: deployment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deployment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: deployment created event - type: object - properties: - action: - type: string - enum: - - created - deployment: - title: Deployment - description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - type: object - properties: - created_at: - type: string - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - environment: - type: string - id: - type: integer - node_id: - type: string - original_environment: - type: string - payload: - oneOf: - - type: object - - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - workflow_job - - pull_request_review_thread - - merge_queue_entry - - secret_scanning_alert_location - - merge_group - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow: &759 - title: Workflow - type: object - nullable: true - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - created_at: - type: string - format: date-time - display_title: - type: string - event: - type: string - head_branch: - type: string - head_commit: - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - run_attempt - - run_started_at - - display_title - required: - - action - - deployment - - workflow - - workflow_run - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deployment - supported-webhook-types: - - repository - - organization - - app - deployment-protection-rule-requested: - post: - summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments). - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment protection rule was requested for an environment. - operationId: deployment-protection-rule/requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deployment_protection_rule - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: deployment protection rule requested event - type: object - properties: - action: - type: string - enum: - - requested - environment: - description: The name of the environment that has the deployment - protection rule. - type: string - event: - description: The event that triggered the deployment protection - rule. - type: string - sha: - description: The commit SHA that triggered the workflow. Always - populated from the check suite, regardless of whether a deployment - is created. - type: string - ref: - description: The ref (branch or tag) that triggered the workflow. - Always populated from the check suite, regardless of whether a - deployment is created. - type: string - deployment_callback_url: - description: The URL to review the deployment protection rule. - type: string - format: uri - deployment: - title: Deployment - description: A request for a specific ref(branch,sha,tag) to be - deployed - type: object - properties: *754 - required: *755 - nullable: true - pull_requests: - type: array - items: *597 - repository: *745 - organization: *744 - installation: *743 - sender: *4 - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deployment_protection_rule - supported-webhook-types: - - app - deployment-review-approved: - post: - summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was approved. - operationId: deployment-review/approved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deployment_review - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - approved - approver: &756 - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - comment: - type: string - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - reviewers: &757 - type: array - items: - type: object - properties: - reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - type: - type: string - enum: - - User - sender: *4 - since: - type: string - workflow_job_run: &758 - type: object - properties: - conclusion: - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - nullable: true - status: - type: string - updated_at: - type: string - required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_job_runs: - type: array - items: - type: object - properties: - conclusion: - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - status: - type: string - updated_at: - type: string - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - created_at: - type: string - format: date-time - display_title: - type: string - event: - type: string - head_branch: - type: string - head_commit: - type: object - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - repository - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deployment_review - supported-webhook-types: - - app - deployment-review-rejected: - post: - summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was rejected. - operationId: deployment-review/rejected - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deployment_review - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - rejected - approver: *756 - comment: - type: string - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - reviewers: *757 - sender: *4 - since: - type: string - workflow_job_run: *758 - workflow_job_runs: - type: array - items: - type: object - properties: - conclusion: - type: string - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - status: - type: string - updated_at: - type: string - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - head_commit: - type: object - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - display_title: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - repository - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deployment_review - supported-webhook-types: - - app - deployment-review-requested: - post: - summary: |- - This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment review was requested. - operationId: deployment-review/requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deployment_review - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - requested - enterprise: *742 - environment: - type: string - installation: *743 - organization: *744 - repository: *745 - requestor: &764 - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - reviewers: - type: array - items: - type: object - properties: - reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - id - type: - type: string - enum: - - User - - Team - sender: *4 - since: - type: string - workflow_job_run: - type: object - properties: - conclusion: - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - status: - type: string - updated_at: - type: string - required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - head_commit: - type: object - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - display_title: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - workflow_job_run - - environment - - reviewers - - requestor - - repository - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deployment_review - supported-webhook-types: - - app - deployment-status-created: - post: - summary: |- - This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment creation, use the `deployment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - - > [!NOTE] - > A webhook event is not fired for deployment statuses with an `inactive` state. - description: A new deployment status was created. - operationId: deployment-status/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_status - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: deployment_status - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: deployment_status created event - type: object - properties: - action: - type: string - enum: - - created - check_run: - type: object - nullable: true - properties: - completed_at: - type: string - nullable: true - format: date-time - conclusion: - description: The result of the completed check run. This value - will be `null` until the check run has completed. - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - - null - details_url: - type: string - format: uri - external_id: - type: string - head_sha: - description: The SHA of the commit that is being checked. - type: string - html_url: - type: string - format: uri - id: - description: The id of the check. - type: integer - name: - description: The name of the check run. - type: string - node_id: - type: string - started_at: - type: string - format: date-time - status: - description: The current status of the check run. Can be `queued`, - `in_progress`, or `completed`. - type: string - enum: - - queued - - in_progress - - completed - - waiting - - pending - url: - type: string - format: uri - required: - - id - - name - - node_id - - head_sha - - external_id - - url - - html_url - - details_url - - status - - conclusion - - started_at - - completed_at - deployment: - title: Deployment - description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - type: object - properties: - created_at: - type: string - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - environment: - type: string - id: - type: integer - node_id: - type: string - original_environment: - type: string - payload: - oneOf: - - type: string - - type: object - nullable: true - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - merge_queue_entry - - workflow_job - - pull_request_review_thread - - secret_scanning_alert_location - - merge_group - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to - the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - repository_url: - type: string - format: uri - state: - description: The new state. Can be `pending`, `success`, `failure`, - or `error`. - type: string - target_url: - description: The optional link added to the status. - type: string - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - state - - creator - - description - - environment - - target_url - - created_at - - updated_at - - deployment_url - - repository_url - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow: *759 - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - - startup_failure - created_at: - type: string - format: date-time - display_title: - type: string - event: - type: string - head_branch: - type: string - head_commit: - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - deployment_status - - deployment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: deployment_status - supported-webhook-types: - - repository - - organization - - app - discussion-answered: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on the discussion was marked as the answer. - operationId: discussion/answered - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion answered event - type: object - properties: - action: - type: string - enum: - - answered - answer: &762 - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer - created_at: - type: string - format: date-time - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - answer - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-category-changed: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: The category of a discussion was changed. - operationId: discussion/category-changed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion category changed event - type: object - properties: - action: - type: string - enum: - - category_changed - changes: - type: object - properties: - category: - type: object - properties: - from: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - required: - - from - required: - - category - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-closed: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was closed. - operationId: discussion/closed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussions - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion closed event - type: object - properties: - action: - type: string - enum: - - closed - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-comment-created: - post: - summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was created. - operationId: discussion-comment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion_comment created event - type: object - properties: - action: - type: string - enum: - - created - comment: &761 - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer - created_at: - type: string - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - type: integer - nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - - reactions - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - comment - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion_comment - supported-webhook-types: - - repository - - organization - - app - discussion-comment-deleted: - post: - summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was deleted. - operationId: discussion-comment/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion_comment deleted event - type: object - properties: - action: - type: string - enum: - - deleted - comment: *761 - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - comment - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion_comment - supported-webhook-types: - - repository - - organization - - app - discussion-comment-edited: - post: - summary: |- - This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on a discussion was edited. - operationId: discussion-comment/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - type: string - required: - - from - required: - - body - comment: *761 - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - comment - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion_comment - supported-webhook-types: - - repository - - organization - - app - discussion-created: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was created. - operationId: discussion/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion created event - type: object - properties: - action: - type: string - enum: - - created - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-deleted: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was deleted. - operationId: discussion/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion deleted event - type: object - properties: - action: - type: string - enum: - - deleted - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-edited: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: The title or body on a discussion was edited, or the category of - the discussion was changed. - operationId: discussion/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - type: string - required: - - from - title: - type: object - properties: - from: - type: string - required: - - from - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-labeled: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A label was added to a discussion. - operationId: discussion/labeled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion labeled event - type: object - properties: - action: - type: string - enum: - - labeled - discussion: *760 - enterprise: *742 - installation: *743 - label: &763 - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - label - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-locked: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was locked. - operationId: discussion/locked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion locked event - type: object - properties: - action: - type: string - enum: - - locked - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-pinned: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was pinned. - operationId: discussion/pinned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion pinned event - type: object - properties: - action: - type: string - enum: - - pinned - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-reopened: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was reopened. - operationId: discussion/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussions - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion reopened event - type: object - properties: - action: - type: string - enum: - - reopened - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-transferred: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was transferred to another repository. - operationId: discussion/transferred - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - new_discussion: *760 - new_repository: *745 - required: - - new_discussion - - new_repository - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-unanswered: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A comment on the discussion was unmarked as the answer. - operationId: discussion/unanswered - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion unanswered event - type: object - properties: - action: - type: string - enum: - - unanswered - discussion: *760 - old_answer: *762 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - old_answer - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-unlabeled: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A label was removed from a discussion. - operationId: discussion/unlabeled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion unlabeled event - type: object - properties: - action: - type: string - enum: - - unlabeled - discussion: *760 - enterprise: *742 - installation: *743 - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - label - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-unlocked: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was unlocked. - operationId: discussion/unlocked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion unlocked event - type: object - properties: - action: - type: string - enum: - - unlocked - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - discussion-unpinned: - post: - summary: |- - This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#discussion). - - For activity relating to a comment on a discussion, use the `discussion_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission. - - > [!NOTE] - > Webhook events for GitHub Discussions are currently in public preview and subject to change. - description: A discussion was unpinned. - operationId: discussion/unpinned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: discussion - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: discussion unpinned event - type: object - properties: - action: - type: string - enum: - - unpinned - discussion: *760 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - discussion - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: discussion - supported-webhook-types: - - repository - - organization - - app - fork: - post: - summary: |- - This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/rest/repos/forks)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: fork - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#fork - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: fork - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: fork event - description: A user forks a repository. - type: object - properties: - enterprise: *742 - forkee: - description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) - resource. - allOf: - - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - - type: object - properties: - allow_forking: - type: boolean - archive_url: - type: string - archived: - type: boolean - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - clone_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - created_at: - type: string - default_branch: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - disabled: - type: boolean - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - enum: - - true - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_pages: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - homepage: - type: string - nullable: true - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - language: - nullable: true - languages_url: - type: string - license: - type: object - nullable: true - merges_url: - type: string - milestones_url: - type: string - mirror_url: - nullable: true - name: - type: string - node_id: - type: string - notifications_url: - type: string - open_issues: - type: integer - open_issues_count: - type: integer - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - public: - type: boolean - pulls_url: - type: string - pushed_at: - type: string - releases_url: - type: string - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - svn_url: - type: string - tags_url: - type: string - teams_url: - type: string - topics: - type: array - items: - nullable: true - trees_url: - type: string - updated_at: - type: string - url: - type: string - visibility: - type: string - watchers: - type: integer - watchers_count: - type: integer - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - forkee - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: fork - supported-webhook-types: - - business - - repository - - organization - - app - github-app-authorization-revoked: - post: - summary: |- - This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - - A GitHub App receives this webhook by default and cannot unsubscribe from this event. - - Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - description: Someone revoked their authorization of a GitHub App. - operationId: github-app-authorization/revoked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#github_app_authorization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: github_app_authorization - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: github_app_authorization revoked event - type: object - properties: - action: - type: string - enum: - - revoked - sender: *4 - required: - - action - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: github_app_authorization - supported-webhook-types: - - app - gollum: - post: - summary: |- - This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/communities/documenting-your-project-with-wikis/about-wikis)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: gollum - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#gollum - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: gollum - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: gollum event - type: object - properties: - enterprise: *742 - installation: *743 - organization: *744 - pages: - description: The pages that were updated. - type: array - items: - type: object - properties: - action: - description: The action that was performed on the page. Can - be `created` or `edited`. - type: string - enum: - - created - - edited - html_url: - description: Points to the HTML wiki page. - type: string - format: uri - page_name: - description: The name of the page. - type: string - sha: - description: The latest commit SHA of the page. - type: string - summary: - type: string - nullable: true - title: - description: The current page title. - type: string - required: - - page_name - - title - - summary - - action - - sha - - html_url - repository: *745 - sender: *4 - required: - - pages - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: gollum - supported-webhook-types: - - repository - - organization - - app - installation-created: - post: - summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: Someone installed a GitHub App on a user or organization account. - operationId: installation/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *22 - organization: *744 - repositories: &765 - description: An array of repository objects that the installation - can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: *745 - requester: *764 - sender: *4 - required: - - action - - installation - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation - supported-webhook-types: - - app - installation-deleted: - post: - summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: Someone uninstalled a GitHub App from their user or organization - account. - operationId: installation/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *22 - organization: *744 - repositories: *765 - repository: *745 - requester: - nullable: true - sender: *4 - required: - - action - - installation - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation - supported-webhook-types: - - app - installation-new-permissions-accepted: - post: - summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: Someone granted new permissions to a GitHub App. - operationId: installation/new-permissions-accepted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation new_permissions_accepted event - type: object - properties: - action: - type: string - enum: - - new_permissions_accepted - enterprise: *742 - installation: *22 - organization: *744 - repositories: *765 - repository: *745 - requester: - nullable: true - sender: *4 - required: - - action - - installation - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation - supported-webhook-types: - - app - installation-repositories-added: - post: - summary: |- - This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: A GitHub App installation was granted access to one or more repositories. - operationId: installation-repositories/added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation_repositories - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation_repositories added event - type: object - properties: - action: - type: string - enum: - - added - enterprise: *742 - installation: *22 - organization: *744 - repositories_added: &766 - description: An array of repository objects, which were added to - the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repositories_removed: - description: An array of repository objects, which were removed - from the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - repository: *745 - repository_selection: &767 - description: Describe whether all repositories have been selected - or there's a selection involved - type: string - enum: - - all - - selected - requester: *764 - sender: *4 - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation_repositories - supported-webhook-types: - - app - installation-repositories-removed: - post: - summary: |- - This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: Access to one or more repositories was revoked for a GitHub App - installation. - operationId: installation-repositories/removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation_repositories - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation_repositories removed event - type: object - properties: - action: - type: string - enum: - - removed - enterprise: *742 - installation: *22 - organization: *744 - repositories_added: *766 - repositories_removed: - description: An array of repository objects, which were removed - from the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: *745 - repository_selection: *767 - requester: *764 - sender: *4 - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation_repositories - supported-webhook-types: - - app - installation-suspend: - post: - summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: Someone blocked access by a GitHub App to their user or organization - account. - operationId: installation/suspend - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation suspend event - type: object - properties: - action: - type: string - enum: - - suspend - enterprise: *742 - installation: *22 - organization: *744 - repositories: *765 - repository: *745 - requester: - nullable: true - sender: *4 - required: - - action - - installation - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation - supported-webhook-types: - - app - installation-target-renamed: - post: - summary: This event occurs when there is activity relating to the user or organization - account that a GitHub App is installed on. For more information, see "[About - apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." - For information about the APIs to manage GitHub Apps, see [the GraphQL API - documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" - in the REST API documentation. - description: Somebody renamed the user or organization account that a GitHub - App is installed on. - operationId: installation-target/renamed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_target - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation_target - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - account: - type: object - properties: - archived_at: - type: string - nullable: true - avatar_url: - type: string - created_at: - type: string - description: - nullable: true - events_url: - type: string - followers: - type: integer - followers_url: - type: string - following: - type: integer - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - has_organization_projects: - type: boolean - has_repository_projects: - type: boolean - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_verified: - type: boolean - issues_url: - type: string - login: - type: string - members_url: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - public_gists: - type: integer - public_members_url: - type: string - public_repos: - type: integer - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - slug: - type: string - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - updated_at: - type: string - url: - type: string - website_url: - nullable: true - user_view_type: - type: string - required: - - id - - node_id - - avatar_url - - html_url - action: - type: string - enum: - - renamed - changes: - type: object - properties: - login: - type: object - properties: - from: - type: string - required: - - from - slug: - type: object - properties: - from: - type: string - required: - - from - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - target_type: - type: string - required: - - action - - target_type - - account - - changes - - installation - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation_target - supported-webhook-types: - - app - installation-unsuspend: - post: - summary: |- - This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event. - - For more information about GitHub Apps, see "[About apps](https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#app) or "[Apps](https://docs.github.com/rest/apps)" in the REST API documentation. - description: A GitHub App that was blocked from accessing a user or organization - account was given access the account again. - operationId: installation/unsuspend - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: installation - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: installation unsuspend event - type: object - properties: - action: - type: string - enum: - - unsuspend - enterprise: *742 - installation: *22 - organization: *744 - repositories: *765 - repository: *745 - requester: - nullable: true - sender: *4 - required: - - action - - installation - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: installation - supported-webhook-types: - - app - issue-comment-created: - post: - summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was created. - operationId: issue-comment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issue_comment created event - type: object - properties: - action: - type: string - enum: - - created - comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *80 - required: *81 - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - pin: - title: Pinned Issue Comment - description: Context around who pinned an issue comment and - when it was pinned. - type: object - properties: *574 - required: *575 - nullable: true - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions - enterprise: *742 - installation: *743 - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - reminder - - pull_request_review_thread - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - labels - - state - - locked - - assignee - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - comment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue_comment - supported-webhook-types: - - repository - - organization - - app - issue-comment-deleted: - post: - summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was deleted. - operationId: issue-comment/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issue_comment deleted event - type: object - properties: - action: - type: string - enum: - - deleted - comment: &768 - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: *5 - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - pin: - title: Pinned Issue Comment - description: Context around who pinned an issue comment and - when it was pinned. - type: object - properties: *574 - required: *575 - nullable: true - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions - enterprise: *742 - installation: *743 - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - labels - - state - - locked - - assignee - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - comment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue_comment - supported-webhook-types: - - repository - - organization - - app - issue-comment-edited: - post: - summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue or pull request was edited. - operationId: issue-comment/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issue_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: &798 - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - comment: *768 - enterprise: *742 - installation: *743 - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - reminder - - pull_request_review_thread - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - labels - - state - - locked - - assignee - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - issue - - comment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue_comment - supported-webhook-types: - - repository - - organization - - app - issue-comment-pinned: - post: - summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue was pinned. - operationId: issue-comment/pinned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issue_comment pinned event - type: object - properties: - action: - type: string - enum: - - pinned - comment: *768 - enterprise: *742 - installation: *743 - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - labels - - state - - locked - - assignee - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - comment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue_comment - supported-webhook-types: - - repository - - organization - - app - issue-comment-unpinned: - post: - summary: |- - This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - - For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A comment on an issue was unpinned. - operationId: issue-comment/unpinned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issue_comment unpinned event - type: object - properties: - action: - type: string - enum: - - unpinned - comment: *768 - enterprise: *742 - installation: *743 - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - labels - - state - - locked - - assignee - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - comment - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue_comment - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocked-by-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocked by another issue. - operationId: issue-dependencies/blocked-by-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_dependencies - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: blocked by issue added event - type: object - properties: - action: - type: string - enum: - - blocked_by_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: *85 - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: *85 - blocking_issue_repo: *79 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - organization - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocked-by-removed: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocked by relationship between an issue and another issue - was removed. - operationId: issue-dependencies/blocked-by-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_dependencies - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: blocked by issue removed event - type: object - properties: - action: - type: string - enum: - - blocked_by_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: *85 - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: *85 - blocking_issue_repo: *79 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - organization - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocking-added: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: An issue was marked as blocking another issue. - operationId: issue-dependencies/blocking-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_dependencies - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: blocking issue added event - type: object - properties: - action: - type: string - enum: - - blocking_added - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: *85 - blocked_issue_repo: *79 - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: *85 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - organization - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issue-dependencies-blocking-removed: - post: - summary: |- - This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: The blocking relationship between an issue and another issue was - removed. - operationId: issue-dependencies/blocking-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issue_dependencies - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: blocking issue removed event - type: object - properties: - action: - type: string - enum: - - blocking_removed - blocked_issue_id: - description: The ID of the blocked issue. - type: number - blocked_issue: *85 - blocked_issue_repo: *79 - blocking_issue_id: - description: The ID of the blocking issue. - type: number - blocking_issue: *85 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - organization - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issue-dependencies - supported-webhook-types: - - repository - - organization - - app - issues-assigned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues assigned event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - assigned - assignee: *764 - enterprise: *742 - installation: *743 - issue: &771 - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - reminder - - pull_request_review_thread - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-closed: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed - enterprise: *742 - installation: *743 - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps - are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - security_and_analysis - - reminder - - pull_request_review_thread - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - type: object - nullable: true - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: object - nullable: true - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - enum: - - closed - - open - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - state - - closed_at - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-deleted: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - reminder - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-demilestoned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - assignees: - type: array - items: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - milestone: &769 - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-edited: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - type: *243 - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-labeled: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues labeled event - type: object - properties: - action: - type: string - enum: - - labeled - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - reminder - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - type: *243 - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-locked: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues locked event - type: object - properties: - action: - type: string - enum: - - locked - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - locked - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - assignees: - type: array - items: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - enum: - - true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - reminder - - security_and_analysis - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - type: *243 - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-milestoned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues milestoned event - type: object - properties: - action: - type: string - enum: - - milestoned - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - assignees: - type: array - items: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - reminder - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - milestone: *769 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - milestone - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-opened: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues opened event - type: object - properties: - action: - type: string - enum: - - opened - changes: - type: object - properties: - old_issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - nullable: true - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. - They can be installed directly on organizations and user - accounts and granted access to specific repositories. - They come with granular permissions and built-in webhooks. - GitHub apps are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - type: *243 - required: - - id - - number - old_repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for - the repository. The keys are the custom property names, - and the values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_discussions: - description: Whether the repository has discussions enabled. - type: boolean - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull - requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require commit signoff. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - required: - - old_issue - - old_repository - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - security_and_analysis - - pull_request_review_thread - - reminder - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-pinned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues pinned event - type: object - properties: - action: - type: string - enum: - - pinned - enterprise: *742 - installation: *743 - issue: &770 - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-reopened: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues reopened event - type: object - properties: - action: - type: string - enum: - - reopened - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - milestone - - node_id - - number - - reactions - - repository_url - - state - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - assignees: - type: array - items: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - reminder - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - type: *243 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-transferred: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - new_issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. - They can be installed directly on organizations and user - accounts and granted access to specific repositories. - They come with granular permissions and built-in webhooks. - GitHub apps are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - new_repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for - the repository. The keys are the custom property names, - and the values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull - requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off - on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - required: - - new_issue - - new_repository - enterprise: *742 - installation: *743 - issue: *770 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-typed: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was added to an issue. - operationId: issues/typed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues typed event - type: object - properties: - action: - type: string - enum: - - typed - enterprise: *742 - installation: *743 - issue: *771 - type: *243 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - type - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-unassigned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues unassigned event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - unassigned - assignee: &801 - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - enterprise: *742 - installation: *743 - issue: *771 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-unlabeled: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues unlabeled event - type: object - properties: - action: - type: string - enum: - - unlabeled - enterprise: *742 - installation: *743 - issue: *771 - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-unlocked: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues unlocked event - type: object - properties: - action: - type: string - enum: - - unlocked - enterprise: *742 - installation: *743 - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - required: - - active_lock_reason - - assignees - - author_association - - body - - closed_at - - comments - - comments_url - - created_at - - events_url - - html_url - - id - - labels_url - - locked - - milestone - - node_id - - number - - reactions - - repository_url - - title - - updated_at - - url - - user - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - assignees: - type: array - items: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - required: - - id - - node_id - - url - - name - - color - - default - - description - nullable: true - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - labels_url: - type: string - format: uri-template - locked: - type: boolean - enum: - - false - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - repository_url: - type: string - format: uri - pinned_comment: - title: Issue Comment - description: Comments provide a way for people to collaborate - on an issue. - type: object - properties: *86 - required: *87 - nullable: true - sub_issues_summary: *678 - issue_dependencies_summary: *679 - issue_field_values: - type: array - items: *559 - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - type: *243 - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-unpinned: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues unpinned event - type: object - properties: - action: - type: string - enum: - - unpinned - enterprise: *742 - installation: *743 - issue: *770 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - issues-untyped: - post: - summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - - For activity relating to a comment on an issue, use the `issue_comment` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue type was removed from an issue. - operationId: issues/untyped - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: issues untyped event - type: object - properties: - action: - type: string - enum: - - untyped - enterprise: *742 - installation: *743 - issue: *771 - type: *243 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - issue - - type - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: issues - supported-webhook-types: - - repository - - organization - - app - label-created: - post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: label - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: label created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - label - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: label - supported-webhook-types: - - repository - - organization - - app - label-deleted: - post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: label - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: label deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - label - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: label - supported-webhook-types: - - repository - - organization - - app - label-edited: - post: - summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: label - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: label edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the label if the action was `edited`. - type: object - properties: - color: - type: object - properties: - from: - description: The previous version of the color if the action - was `edited`. - type: string - required: - - from - description: - type: object - properties: - from: - description: The previous version of the description if - the action was `edited`. - type: string - required: - - from - name: - type: object - properties: - from: - description: The previous version of the name if the action - was `edited`. - type: string - required: - - from - enterprise: *742 - installation: *743 - label: *763 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - label - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: label - supported-webhook-types: - - repository - - organization - - app - marketplace-purchase-cancelled: - post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: marketplace_purchase - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: marketplace_purchase cancelled event - type: object - properties: - action: - type: string - enum: - - cancelled - effective_date: - type: string - enterprise: *742 - installation: *743 - marketplace_purchase: &772 - title: Marketplace Purchase - type: object - required: - - account - - billing_cycle - - free_trial_ends_on - - next_billing_date - - on_free_trial - - plan - - unit_count - properties: - account: - type: object - required: - - type - - id - - node_id - - login - - organization_billing_email - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - properties: - bullets: - type: array - items: - type: string - nullable: true - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - unit_count: - type: integer - organization: *744 - previous_marketplace_purchase: &773 - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - repository: *745 - sender: *4 - required: - - action - - effective_date - - sender - - marketplace_purchase - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: marketplace_purchase - supported-webhook-types: - - marketplace - marketplace-purchase-changed: - post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: marketplace_purchase - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: marketplace_purchase changed event - type: object - properties: - action: - type: string - enum: - - changed - effective_date: - type: string - enterprise: *742 - installation: *743 - marketplace_purchase: *772 - organization: *744 - previous_marketplace_purchase: - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - nullable: true - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - repository: *745 - sender: *4 - required: - - action - - effective_date - - sender - - marketplace_purchase - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: marketplace_purchase - supported-webhook-types: - - marketplace - marketplace-purchase-pending-change: - post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: marketplace_purchase - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: marketplace_purchase pending_change event - type: object - properties: - action: - type: string - enum: - - pending_change - effective_date: - type: string - enterprise: *742 - installation: *743 - marketplace_purchase: *772 - organization: *744 - previous_marketplace_purchase: - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - repository: *745 - sender: *4 - required: - - action - - effective_date - - sender - - marketplace_purchase - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: marketplace_purchase - supported-webhook-types: - - marketplace - marketplace-purchase-pending-change-cancelled: - post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: marketplace_purchase - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: marketplace_purchase pending_change_cancelled event - type: object - properties: - action: - type: string - enum: - - pending_change_cancelled - effective_date: - type: string - enterprise: *742 - installation: *743 - marketplace_purchase: - title: Marketplace Purchase - type: object - required: - - account - - billing_cycle - - free_trial_ends_on - - next_billing_date - - on_free_trial - - plan - - unit_count - properties: - account: - type: object - required: - - type - - id - - node_id - - login - - organization_billing_email - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - unit_count: - type: integer - organization: *744 - previous_marketplace_purchase: *773 - repository: *745 - sender: *4 - required: - - action - - effective_date - - sender - - marketplace_purchase - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: marketplace_purchase - supported-webhook-types: - - marketplace - marketplace-purchase-purchased: - post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: marketplace_purchase - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: marketplace_purchase purchased event - type: object - properties: - action: - type: string - enum: - - purchased - effective_date: - type: string - enterprise: *742 - installation: *743 - marketplace_purchase: *772 - organization: *744 - previous_marketplace_purchase: *773 - repository: *745 - sender: *4 - required: - - action - - effective_date - - sender - - marketplace_purchase - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: marketplace_purchase - supported-webhook-types: - - marketplace - member-added: - post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: member - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: member added event - type: object - properties: - action: - type: string - enum: - - added - changes: - type: object - properties: - permission: - description: |- - This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - assigned to the collaborator, use the `role_name` field instead, which will provide the full - role name, including custom roles. - type: object - properties: - to: - type: string - enum: - - write - - admin - - read - required: - - to - role_name: - description: The role assigned to the collaborator. - type: object - properties: - to: - type: string - required: - - to - enterprise: *742 - installation: *743 - member: *764 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - member - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: member - supported-webhook-types: - - business - - repository - - organization - - app - member-edited: - post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: member - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: member edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the collaborator permissions - type: object - properties: - old_permission: - type: object - properties: - from: - description: The previous permissions of the collaborator - if the action was edited. - type: string - required: - - from - permission: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - nullable: true - enterprise: *742 - installation: *743 - member: *764 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - member - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: member - supported-webhook-types: - - business - - repository - - organization - - app - member-removed: - post: - summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: member - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: member removed event - type: object - properties: - action: - type: string - enum: - - removed - enterprise: *742 - installation: *743 - member: *764 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - member - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: member - supported-webhook-types: - - business - - repository - - organization - - app - membership-added: - post: - summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: membership - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: membership added event - type: object - properties: - action: - type: string - enum: - - added - enterprise: *742 - installation: *743 - member: *764 - organization: *744 - repository: *745 - scope: - description: The scope of the membership. Currently, can only be - `team`. - type: string - enum: - - team - sender: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - team: &774 - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications - when their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to which - this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which - this team belongs - example: 42 - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - - type - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to which - this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which this - team belongs - example: 42 - required: - - name - - id - required: - - action - - scope - - member - - sender - - team - - organization - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: membership - supported-webhook-types: - - organization - - business - - app - membership-removed: - post: - summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: membership - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: membership removed event - type: object - properties: - action: - type: string - enum: - - removed - enterprise: *742 - installation: *743 - member: *764 - organization: *744 - repository: *745 - scope: - description: The scope of the membership. Currently, can only be - `team`. - type: string - enum: - - team - - organization - sender: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - team: *774 - required: - - action - - scope - - member - - sender - - team - - organization - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: membership - supported-webhook-types: - - organization - - business - - app - merge-group-checks-requested: - post: - summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. - - When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. - operationId: merge-group/checks-requested - tags: - - merge-queue - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: merge_group - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - checks_requested - installation: *743 - merge_group: &776 - type: object - title: Merge Group - description: A group of pull requests that the merge queue has grouped - together to be merged. - properties: - head_sha: - description: The SHA of the merge group. - type: string - head_ref: - description: The full ref of the merge group. - type: string - base_sha: - description: The SHA of the merge group's parent commit. - type: string - base_ref: - description: The full ref of the branch the merge group will - be merged into. - type: string - head_commit: *775 - required: - - head_sha - - head_ref - - base_sha - - base_ref - - head_commit - organization: *744 - repository: *745 - sender: *4 - required: - - action - - merge_group - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: merge_group - supported-webhook-types: - - app - merge-group-destroyed: - post: - summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - 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. - - 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. - operationId: merge-group/destroyed - tags: - - merge-queue - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: merge_group - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - destroyed - reason: - type: string - 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 - installation: *743 - merge_group: *776 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - merge_group - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: merge_group - supported-webhook-types: - - app - meta-deleted: - post: - summary: |- - This event occurs when there is activity relating to a webhook itself. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. - description: The webhook was deleted. - operationId: meta/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: meta - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: meta deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - hook: - description: 'The deleted webhook. This will contain different keys - based on the type of webhook it is: repository, organization, - business, app, or GitHub Marketplace.' - type: object - properties: - active: - type: boolean - config: - type: object - properties: - content_type: - type: string - enum: - - json - - form - insecure_ssl: - type: string - secret: - type: string - url: - type: string - format: uri - required: - - content_type - - insecure_ssl - - url - created_at: - type: string - events: - description: '' - type: array - items: - type: string - enum: - - "*" - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - create - - delete - - deployment - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - meta - - milestone - - organization - - org_block - - package - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - pull_request_review_thread - - push - - registry_package - - release - - repository - - repository_import - - repository_vulnerability_alert - - secret_scanning_alert - - secret_scanning_alert_location - - security_and_analysis - - star - - status - - team - - team_add - - watch - - workflow_job - - workflow_run - - repository_dispatch - - projects_v2_item - minItems: 1 - id: - type: integer - name: - type: string - type: - type: string - updated_at: - type: string - required: - - type - - id - - name - - active - - events - - config - - updated_at - - created_at - hook_id: - description: The id of the modified webhook. - type: integer - installation: *743 - organization: *744 - repository: - title: Repository - description: |- - The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - when the event occurs from activity in a repository. - type: object - properties: *777 - required: *778 - x-github-breaking-changes: *779 - nullable: true - sender: *4 - required: - - action - - hook_id - - hook - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: meta - supported-webhook-types: - - marketplace - - business - - repository - - organization - - app - milestone-closed: - post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was closed. - operationId: milestone/closed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: milestone - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: milestone closed event - type: object - properties: - action: - type: string - enum: - - closed - enterprise: *742 - installation: *743 - milestone: *769 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - milestone - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: milestone - supported-webhook-types: - - repository - - organization - - app - milestone-created: - post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was created. - operationId: milestone/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: milestone - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: milestone created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - milestone: &780 - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: *744 - repository: *745 - sender: *4 - required: - - action - - milestone - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: milestone - supported-webhook-types: - - repository - - organization - - app - milestone-deleted: - post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was deleted. - operationId: milestone/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: milestone - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: milestone deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - milestone: *769 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - milestone - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: milestone - supported-webhook-types: - - repository - - organization - - app - milestone-edited: - post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was edited. - operationId: milestone/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: milestone - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: milestone edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the milestone if the action was `edited`. - type: object - properties: - description: - type: object - properties: - from: - description: The previous version of the description if - the action was `edited`. - type: string - required: - - from - due_on: - type: object - properties: - from: - description: The previous version of the due date if the - action was `edited`. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title if the action - was `edited`. - type: string - required: - - from - enterprise: *742 - installation: *743 - milestone: *769 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - milestone - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: milestone - supported-webhook-types: - - repository - - organization - - app - milestone-opened: - post: - summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was opened. - operationId: milestone/opened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: milestone - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: milestone opened event - type: object - properties: - action: - type: string - enum: - - opened - enterprise: *742 - installation: *743 - milestone: *780 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - milestone - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: milestone - supported-webhook-types: - - repository - - organization - - app - org-block-blocked: - post: - summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. - - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A user was blocked from the organization. - operationId: org-block/blocked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: org_block - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: org_block blocked event - type: object - properties: - action: - type: string - enum: - - blocked - blocked_user: *764 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - blocked_user - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: org_block - supported-webhook-types: - - organization - - business - - app - org-block-unblocked: - post: - summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. - - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A previously blocked user was unblocked from the organization. - operationId: org-block/unblocked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: org_block - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: org_block unblocked event - type: object - properties: - action: - type: string - enum: - - unblocked - blocked_user: *764 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - blocked_user - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: org_block - supported-webhook-types: - - organization - - business - - app - organization-deleted: - post: - summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization was deleted. - operationId: organization/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: organization - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: organization deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - membership: &781 - title: Membership - description: The membership between the user and the organization. - Not present when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - direct_membership: - type: boolean - description: Whether the user has direct membership in the organization. - example: true - enterprise_teams_providing_indirect_membership: - type: array - description: |- - The slugs of the enterprise teams providing the user with indirect membership in the organization. - A limit of 100 enterprise team slugs is returned. - maxItems: 100 - items: - type: string - example: - - ent:team-one - - ent:team-two - state: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: *744 - repository: *745 - sender: *4 - required: - - action - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: organization - supported-webhook-types: - - organization - - business - - app - organization-member-added: - post: - summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member accepted an invitation to join an organization. - operationId: organization/member-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: organization - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: organization member_added event - type: object - properties: - action: - type: string - enum: - - member_added - enterprise: *742 - installation: *743 - membership: *781 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - membership - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: organization - supported-webhook-types: - - organization - - business - - app - organization-member-invited: - post: - summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member was invited to join the organization. - operationId: organization/member-invited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: organization - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: organization member_invited event - type: object - properties: - action: - type: string - enum: - - member_invited - enterprise: *742 - installation: *743 - invitation: - description: The invitation for the user or email if the action - is `member_invited`. - type: object - properties: - created_at: - type: string - format: date-time - email: - type: string - nullable: true - failed_at: - type: string - nullable: true - format: date-time - failed_reason: - type: string - nullable: true - id: - type: number - invitation_teams_url: - type: string - format: uri - inviter: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - login: - type: string - nullable: true - node_id: - type: string - role: - type: string - team_count: - type: number - invitation_source: - type: string - required: - - id - - node_id - - login - - email - - role - - created_at - - failed_at - - failed_reason - - inviter - - team_count - - invitation_teams_url - organization: *744 - repository: *745 - sender: *4 - user: *764 - required: - - action - - invitation - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: organization - supported-webhook-types: - - organization - - business - - app - organization-member-removed: - post: - summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member was removed from the organization. - operationId: organization/member-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: organization - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: organization member_removed event - type: object - properties: - action: - type: string - enum: - - member_removed - enterprise: *742 - installation: *743 - membership: *781 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - membership - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: organization - supported-webhook-types: - - organization - - business - - app - organization-renamed: - post: - summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name of an organization was changed. - operationId: organization/renamed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: organization - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: organization renamed event - type: object - properties: - action: - type: string - enum: - - renamed - changes: - type: object - properties: - login: - type: object - properties: - from: - type: string - enterprise: *742 - installation: *743 - membership: *781 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: organization - supported-webhook-types: - - organization - - business - - app - package-published: - post: - summary: This event occurs when there is activity relating to GitHub Packages. - For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." - For information about the APIs to manage GitHub Packages, see [the GraphQL - API documentation](https://docs.github.com/graphql/reference/objects#package) - or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - description: A package was published to a registry. - operationId: package/published - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#package - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: package - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: package published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: *742 - installation: *743 - organization: *744 - package: - description: Information about the package. - type: object - properties: - created_at: - type: string - nullable: true - description: - type: string - nullable: true - ecosystem: - type: string - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - namespace: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - package_type: - type: string - package_version: - type: object - nullable: true - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - body: - oneOf: - - type: string - - type: object - body_html: - type: string - container_metadata: - type: object - nullable: true - properties: - labels: - type: object - nullable: true - manifest: - type: object - nullable: true - tag: - type: object - properties: - digest: - type: string - name: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - npm_metadata: - type: object - nullable: true - properties: - name: - type: string - version: - type: string - npm_user: - type: string - author: - type: object - nullable: true - bugs: - type: object - nullable: true - dependencies: - type: object - dev_dependencies: - type: object - peer_dependencies: - type: object - optional_dependencies: - type: object - description: - type: string - dist: - type: object - nullable: true - git_head: - type: string - homepage: - type: string - license: - type: string - main: - type: string - repository: - type: object - nullable: true - scripts: - type: object - id: - type: string - node_version: - type: string - npm_version: - type: string - has_shrinkwrap: - type: boolean - maintainers: - type: array - items: - type: object - contributors: - type: array - items: - type: object - engines: - type: object - keywords: - type: array - items: - type: string - files: - type: array - items: - type: string - bin: - type: object - man: - type: object - directories: - type: object - nullable: true - os: - type: array - items: - type: string - cpu: - type: array - items: - type: string - readme: - type: string - installation_command: - type: string - release_id: - type: integer - commit_oid: - type: string - published_via_actions: - type: boolean - deleted_by_id: - type: integer - nuget_metadata: - type: array - nullable: true - items: - type: object - properties: - id: - oneOf: - - type: integer - - type: string - name: - type: string - value: - oneOf: - - type: boolean - - type: string - - type: integer - - type: object - properties: - url: - type: string - branch: - type: string - commit: - type: string - type: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - format: uri - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - nullable: true - size: - type: integer - state: - type: string - nullable: true - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - created_at: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true - prerelease: - type: boolean - published_at: - type: string - tag_name: - type: string - target_commitish: - type: string - url: - type: string - format: uri - required: - - url - - html_url - - id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: &782 - title: Ruby Gems metadata - type: object - properties: - name: - type: string - description: - type: string - readme: - type: string - homepage: - type: string - version_info: - type: object - properties: - version: - type: string - platform: - type: string - metadata: - type: object - additionalProperties: - type: string - repo: - type: string - dependencies: - type: array - items: - type: object - additionalProperties: - type: string - commit_oid: - type: string - source_url: - type: string - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - summary - - name - - description - - html_url - - metadata - - package_files - - installation_command - registry: - type: object - nullable: true - properties: - about_url: - type: string - format: uri - name: - type: string - type: - type: string - url: - type: string - format: uri - vendor: - type: string - required: - - about_url - - name - - type - - url - - vendor - updated_at: - type: string - nullable: true - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: *745 - sender: *4 - required: - - action - - package - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: package - supported-webhook-types: - - repository - - organization - package-updated: - post: - summary: This event occurs when there is activity relating to GitHub Packages. - For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." - For information about the APIs to manage GitHub Packages, see [the GraphQL - API documentation](https://docs.github.com/graphql/reference/objects#package) - or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - description: A previously published package was updated. - operationId: package/updated - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#package - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: package - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: package updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: *742 - installation: *743 - organization: *744 - package: - description: Information about the package. - type: object - properties: - created_at: - type: string - description: - type: string - nullable: true - ecosystem: - type: string - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - namespace: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - package_type: - type: string - package_version: - type: object - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - body: - type: string - body_html: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - format: uri - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - size: - type: integer - state: - type: string - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - created_at: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - prerelease: - type: boolean - published_at: - type: string - tag_name: - type: string - target_commitish: - type: string - url: - type: string - format: uri - required: - - url - - html_url - - id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: *782 - source_url: - type: string - format: uri - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - summary - - name - - description - - body - - body_html - - html_url - - target_commitish - - target_oid - - created_at - - updated_at - - metadata - - package_files - - author - - installation_command - registry: - type: object - nullable: true - properties: - about_url: - type: string - format: uri - name: - type: string - type: - type: string - url: - type: string - format: uri - vendor: - type: string - required: - - about_url - - name - - type - - url - - vendor - updated_at: - type: string - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: *745 - sender: *4 - required: - - action - - package - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: package - supported-webhook-types: - - repository - - organization - page-build: - post: - summary: |- - This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/rest/pages)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. - operationId: page-build - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: page_build - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: page_build event - type: object - properties: - build: - description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) - itself. - type: object - properties: - commit: - type: string - nullable: true - created_at: - type: string - duration: - type: integer - error: - type: object - properties: - message: - type: string - nullable: true - required: - - message - pusher: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - status: - type: string - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - status - - error - - pusher - - commit - - duration - - created_at - - updated_at - enterprise: *742 - id: - type: integer - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - id - - build - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: page_build - supported-webhook-types: - - repository - - organization - - app - personal-access-token-request-approved: - post: - summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - description: A fine-grained personal access token request was approved. - operationId: personal-access-token-request/approved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Github-Event - in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: integration - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: personal_access_token_request approved event - type: object - properties: - action: - type: string - enum: - - approved - personal_access_token_request: &783 - title: Personal Access Token Request - description: Details of a Personal Access Token Request. - type: object - properties: - id: - type: integer - description: Unique identifier of the request for access via - fine-grained personal access token. Used as the `pat_request_id` - parameter in the list and review API calls. - owner: *4 - permissions_added: - type: object - description: New requested permissions, categorized by type - of permission. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - permissions_upgraded: - type: object - description: Requested permissions that elevate access for a - previously approved request for access, categorized by type - of permission. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - permissions_result: - type: object - description: Permissions requested, categorized by type of permission. - This field incorporates `permissions_added` and `permissions_upgraded`. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - repository_selection: - type: string - description: Type of repository selection requested. - enum: - - none - - all - - subset - repository_count: - description: The number of repositories the token is requesting - access to. This field is only populated when `repository_selection` - is `subset`. - type: integer - nullable: true - repositories: - type: array - description: An array of repository objects the token is requesting - access to. This field is only populated when `repository_selection` - is `subset`. - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - nullable: true - created_at: - type: string - description: Date and time when the request for access was created. - token_id: - type: integer - description: Unique identifier of the user's token. This field - can also be found in audit log events and the organization's - settings for their PAT grants. - token_name: - type: string - description: The name given to the user's token. This field - can also be found in an organization's settings page for Active - Tokens. - token_expired: - type: boolean - description: Whether the associated fine-grained personal access - token has expired. - token_expires_at: - type: string - description: Date and time when the associated fine-grained - personal access token expires. - nullable: true - token_last_used_at: - type: string - description: Date and time when the associated fine-grained - personal access token was last used for authentication. - nullable: true - required: - - id - - owner - - permissions_added - - permissions_upgraded - - permissions_result - - repository_selection - - repository_count - - repositories - - created_at - - token_id - - token_name - - token_expired - - token_expires_at - - token_last_used_at - enterprise: *742 - organization: *744 - sender: *4 - installation: *743 - required: - - action - - personal_access_token_request - - organization - - sender - - installation - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: personal_access_token_request - supported-webhook-types: - - app - - organization - personal-access-token-request-cancelled: - post: - summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - description: A fine-grained personal access token request was cancelled by the - requester. - operationId: personal-access-token-request/cancelled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Github-Event - in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: integration - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: personal_access_token_request cancelled event - type: object - properties: - action: - type: string - enum: - - cancelled - personal_access_token_request: *783 - enterprise: *742 - organization: *744 - sender: *4 - installation: *743 - required: - - action - - personal_access_token_request - - organization - - sender - - installation - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: personal_access_token_request - supported-webhook-types: - - app - - organization - personal-access-token-request-created: - post: - summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - description: A fine-grained personal access token request was created. - operationId: personal-access-token-request/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Github-Event - in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: integration - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: personal_access_token_request created event - type: object - properties: - action: - type: string - enum: - - created - personal_access_token_request: *783 - enterprise: *742 - organization: *744 - sender: *4 - installation: *743 - required: - - action - - personal_access_token_request - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: personal_access_token_request - supported-webhook-types: - - app - - organization - personal-access-token-request-denied: - post: - summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. - description: A fine-grained personal access token request was denied. - operationId: personal-access-token-request/denied - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Github-Event - in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: integration - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: personal_access_token_request denied event - type: object - properties: - action: - type: string - enum: - - denied - personal_access_token_request: *783 - organization: *744 - enterprise: *742 - sender: *4 - installation: *743 - required: - - action - - personal_access_token_request - - organization - - sender - - installation - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: personal_access_token_request - supported-webhook-types: - - app - - organization - ping: - post: - summary: This event occurs when you create a new webhook. The ping event is - a confirmation from GitHub that you configured the webhook correctly. - operationId: ping - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: ping - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - hook: - title: Webhook - description: The webhook that is being pinged - type: object - properties: - active: - description: Determines whether the hook is actually triggered - for the events it subscribes to. - type: boolean - app_id: - description: Only included for GitHub Apps. When you register - a new GitHub App, GitHub sends a ping event to the webhook - URL you specified during registration. The GitHub App ID sent - in this field is required for authenticating an app. - type: integer - config: - type: object - properties: - content_type: *9 - insecure_ssl: *11 - secret: *10 - url: *8 - created_at: - type: string - format: date-time - deliveries_url: - type: string - format: uri - events: - description: 'Determines what events the hook is triggered for. - Default: [''push''].' - type: array - items: - type: string - id: - description: Unique identifier of the webhook. - type: integer - last_response: *784 - name: - description: The type of webhook. The only valid value is 'web'. - type: string - enum: - - web - ping_url: - type: string - format: uri - test_url: - type: string - format: uri - type: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - id - - type - - name - - active - - events - - config - - created_at - - updated_at - hook_id: - description: The ID of the webhook that triggered the ping. - type: integer - organization: *744 - repository: *745 - sender: *4 - zen: - description: Random string of GitHub zen. - type: string - examples: - default: - value: - zen: Anything added dilutes everything else. - hook_id: 109948940 - hook: - type: Repository - id: 109948940 - name: web - active: true - events: - - "*" - config: - content_type: json - url: https://smee.io/**************** - insecure_ssl: '0' - updated_at: '2019-05-15T15:20:49Z' - created_at: '2019-05-15T15:20:49Z' - url: https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940 - test_url: https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test - ping_url: https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings - last_response: - code: - status: unused - message: - repository: - id: 186853261 - node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE= - name: Hello-World - full_name: Octocoders/Hello-World - private: false - owner: - login: Octocoders - id: 38302899 - node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 - avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 - gravatar_id: '' - url: https://api.github.com/users/Octocoders - html_url: https://github.com/Octocoders - followers_url: https://api.github.com/users/Octocoders/followers - following_url: https://api.github.com/users/Octocoders/following{/other_user} - gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} - starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Octocoders/subscriptions - organizations_url: https://api.github.com/users/Octocoders/orgs - repos_url: https://api.github.com/users/Octocoders/repos - events_url: https://api.github.com/users/Octocoders/events{/privacy} - received_events_url: https://api.github.com/users/Octocoders/received_events - type: Organization - site_admin: false - html_url: https://github.com/Octocoders/Hello-World - description: - fork: true - url: https://api.github.com/repos/Octocoders/Hello-World - forks_url: https://api.github.com/repos/Octocoders/Hello-World/forks - keys_url: https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id} - collaborators_url: https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator} - teams_url: https://api.github.com/repos/Octocoders/Hello-World/teams - hooks_url: https://api.github.com/repos/Octocoders/Hello-World/hooks - issue_events_url: https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number} - events_url: https://api.github.com/repos/Octocoders/Hello-World/events - assignees_url: https://api.github.com/repos/Octocoders/Hello-World/assignees{/user} - branches_url: https://api.github.com/repos/Octocoders/Hello-World/branches{/branch} - tags_url: https://api.github.com/repos/Octocoders/Hello-World/tags - blobs_url: https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha} - git_refs_url: https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha} - trees_url: https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha} - statuses_url: https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha} - languages_url: https://api.github.com/repos/Octocoders/Hello-World/languages - stargazers_url: https://api.github.com/repos/Octocoders/Hello-World/stargazers - contributors_url: https://api.github.com/repos/Octocoders/Hello-World/contributors - subscribers_url: https://api.github.com/repos/Octocoders/Hello-World/subscribers - subscription_url: https://api.github.com/repos/Octocoders/Hello-World/subscription - commits_url: https://api.github.com/repos/Octocoders/Hello-World/commits{/sha} - git_commits_url: https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha} - comments_url: https://api.github.com/repos/Octocoders/Hello-World/comments{/number} - issue_comment_url: https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number} - contents_url: https://api.github.com/repos/Octocoders/Hello-World/contents/{+path} - compare_url: https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head} - merges_url: https://api.github.com/repos/Octocoders/Hello-World/merges - archive_url: https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/Octocoders/Hello-World/downloads - issues_url: https://api.github.com/repos/Octocoders/Hello-World/issues{/number} - pulls_url: https://api.github.com/repos/Octocoders/Hello-World/pulls{/number} - milestones_url: https://api.github.com/repos/Octocoders/Hello-World/milestones{/number} - notifications_url: https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/Octocoders/Hello-World/labels{/name} - releases_url: https://api.github.com/repos/Octocoders/Hello-World/releases{/id} - deployments_url: https://api.github.com/repos/Octocoders/Hello-World/deployments - created_at: '2019-05-15T15:20:42Z' - updated_at: '2019-05-15T15:20:45Z' - pushed_at: '2019-05-15T15:20:33Z' - git_url: git://github.com/Octocoders/Hello-World.git - ssh_url: git@github.com:Octocoders/Hello-World.git - clone_url: https://github.com/Octocoders/Hello-World.git - svn_url: https://github.com/Octocoders/Hello-World - homepage: - size: 0 - stargazers_count: 0 - watchers_count: 0 - language: Ruby - has_issues: false - has_projects: true - has_downloads: true - has_wiki: true - has_pages: false - forks_count: 0 - mirror_url: - archived: false - disabled: false - open_issues_count: 0 - license: - forks: 0 - open_issues: 0 - watchers: 0 - default_branch: master - sender: - login: Codertocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/Codertocat - html_url: https://github.com/Codertocat - followers_url: https://api.github.com/users/Codertocat/followers - following_url: https://api.github.com/users/Codertocat/following{/other_user} - gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} - starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/Codertocat/subscriptions - organizations_url: https://api.github.com/users/Codertocat/orgs - repos_url: https://api.github.com/users/Codertocat/repos - events_url: https://api.github.com/users/Codertocat/events{/privacy} - received_events_url: https://api.github.com/users/Codertocat/received_events - type: User - site_admin: false - application/x-www-form-urlencoded: - schema: - description: The webhooks ping payload encoded with URL encoding. - type: object - properties: - payload: - description: A URL-encoded string of the ping JSON payload. The - decoded payload is a JSON object. - type: string - required: - - payload - examples: - default: - value: - payload: "%7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: ping - supported-webhook-types: - - repository - - organization - - app - - business - - marketplace - project-card-converted: - post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note in a project (classic) was converted to an issue. - operationId: project-card/converted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_card - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_card converted event - type: object - properties: - action: - type: string - enum: - - converted - changes: - type: object - properties: - note: - type: object - properties: - from: - type: string - required: - - from - required: - - note - enterprise: *742 - installation: *743 - organization: *744 - project_card: &785 - title: Project Card - type: object - properties: - after_id: - type: integer - nullable: true - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at - repository: *745 - sender: *4 - required: - - action - - changes - - project_card - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_card - supported-webhook-types: - - repository - - organization - - app - project-card-created: - post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card was added to a project (classic). - operationId: project-card/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_card - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_card created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - project_card: *785 - repository: *745 - sender: *4 - required: - - action - - project_card - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_card - supported-webhook-types: - - repository - - organization - - app - project-card-deleted: - post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a project (classic) was deleted. - operationId: project-card/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_card - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_card deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - project_card: - title: Project Card - type: object - properties: - after_id: - type: integer - nullable: true - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - nullable: true - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at - repository: - title: Repository - description: |- - The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - when the event occurs from activity in a repository. - type: object - properties: *777 - required: *778 - x-github-breaking-changes: *779 - nullable: true - sender: *4 - required: - - action - - project_card - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_card - supported-webhook-types: - - repository - - organization - - app - project-card-edited: - post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note on a project (classic) was edited. - operationId: project-card/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_card - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_card edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - note: - type: object - properties: - from: - type: string - nullable: true - required: - - from - required: - - note - enterprise: *742 - installation: *743 - organization: *744 - project_card: *785 - repository: *745 - sender: *4 - required: - - action - - changes - - project_card - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_card - supported-webhook-types: - - repository - - organization - - app - project-card-moved: - post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a project (classic) was moved to another column or to - another position in its column. - operationId: project-card/moved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_card - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_card moved event - type: object - properties: - action: - type: string - enum: - - moved - changes: - type: object - properties: - column_id: - type: object - properties: - from: - type: integer - required: - - from - required: - - column_id - enterprise: *742 - installation: *743 - organization: *744 - project_card: - allOf: - - title: Project Card - type: object - properties: - after_id: - type: integer - nullable: true - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at - - type: object - properties: - after_id: - type: number - nullable: true - archived: - type: boolean - column_id: - type: integer - column_url: - type: string - created_at: - type: string - creator: - type: object - nullable: true - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - id: - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - updated_at: - type: string - url: - type: string - required: - - after_id - repository: *745 - sender: *4 - required: - - action - - project_card - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_card - supported-webhook-types: - - repository - - organization - - app - project-closed: - post: - summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/closed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project closed event - type: object - properties: - action: - type: string - enum: - - closed - enterprise: *742 - installation: *743 - organization: *744 - project: &787 - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - repository: *745 - sender: *4 - required: - - action - - project - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project - supported-webhook-types: - - repository - - organization - - app - project-column-created: - post: - summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a project (classic). - operationId: project-column/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_column - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_column created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - project_column: &786 - title: Project Column - type: object - properties: - after_id: - type: integer - nullable: true - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at - repository: *745 - sender: *4 - required: - - action - - project_column - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_column - supported-webhook-types: - - repository - - organization - - app - project-column-deleted: - post: - summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a project (classic). - operationId: project-column/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_column - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_column deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - project_column: *786 - repository: - title: Repository - description: |- - The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - when the event occurs from activity in a repository. - type: object - properties: *777 - required: *778 - x-github-breaking-changes: *779 - nullable: true - sender: *4 - required: - - action - - project_column - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_column - supported-webhook-types: - - repository - - organization - - app - project-column-edited: - post: - summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a project (classic) was changed. - operationId: project-column/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_column - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_column edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - name: - type: object - properties: - from: - type: string - required: - - from - enterprise: *742 - installation: *743 - organization: *744 - project_column: *786 - repository: *745 - sender: *4 - required: - - action - - changes - - project_column - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_column - supported-webhook-types: - - repository - - organization - - app - project-column-moved: - post: - summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a project (classic). - operationId: project-column/moved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project_column - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project_column moved event - type: object - properties: - action: - type: string - enum: - - moved - enterprise: *742 - installation: *743 - organization: *744 - project_column: *786 - repository: *745 - sender: *4 - required: - - action - - project_column - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project_column - supported-webhook-types: - - repository - - organization - - app - project-created: - post: - summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was created. - operationId: project/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - project: *787 - repository: *745 - sender: *4 - required: - - action - - project - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project - supported-webhook-types: - - repository - - organization - - app - project-deleted: - post: - summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was deleted. - operationId: project/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - project: *787 - repository: - title: Repository - description: |- - The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - when the event occurs from activity in a repository. - type: object - properties: *777 - required: *778 - x-github-breaking-changes: *779 - nullable: true - sender: *4 - required: - - action - - project - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project - supported-webhook-types: - - repository - - organization - - app - project-edited: - post: - summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a project (classic) was changed. - operationId: project/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the project if the action was `edited`. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action - was `edited`. - type: string - required: - - from - name: - type: object - properties: - from: - description: The changes to the project if the action was - `edited`. - type: string - required: - - from - enterprise: *742 - installation: *743 - organization: *744 - project: *787 - repository: *745 - sender: *4 - required: - - action - - project - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project - supported-webhook-types: - - repository - - organization - - app - project-reopened: - post: - summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: project reopened event - type: object - properties: - action: - type: string - enum: - - reopened - enterprise: *742 - installation: *743 - organization: *744 - project: *787 - repository: *745 - sender: *4 - required: - - action - - project - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: project - supported-webhook-types: - - repository - - organization - - app - projects-v2-closed: - post: - summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was closed. - operationId: projects-v2/closed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Project Closed Event - type: object - properties: - action: - type: string - enum: - - closed - installation: *743 - organization: *744 - projects_v2: *277 - sender: *4 - required: - - action - - projects_v2 - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2 - supported-webhook-types: - - organization - projects-v2-created: - post: - summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was created. - operationId: projects-v2/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - description: A project was created - type: object - properties: - action: - type: string - enum: - - created - installation: *743 - organization: *744 - projects_v2: *277 - sender: *4 - required: - - action - - projects_v2 - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2 - supported-webhook-types: - - organization - projects-v2-deleted: - post: - summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was deleted. - operationId: projects-v2/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Project Deleted Event - type: object - properties: - action: - type: string - enum: - - deleted - installation: *743 - organization: *744 - projects_v2: *277 - sender: *4 - required: - - action - - projects_v2 - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2 - supported-webhook-types: - - organization - projects-v2-edited: - post: - summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The title, description, or README of a project in the organization - was changed. - operationId: projects-v2/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Project Edited Event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - description: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - nullable: true - public: - type: object - properties: - from: - type: boolean - to: - type: boolean - short_description: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - nullable: true - title: - type: object - properties: - from: - type: string - to: - type: string - installation: *743 - organization: *744 - projects_v2: *277 - sender: *4 - required: - - action - - projects_v2 - - organization - - sender - - changes - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2 - supported-webhook-types: - - organization - projects-v2-item-archived: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item on an organization project was archived. For more information, - see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/archived - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Archived Event - type: object - properties: - action: - type: string - enum: - - archived - changes: &791 - type: object - properties: - archived_at: - type: object - properties: - from: - type: string - nullable: true - format: date-time - to: - type: string - nullable: true - format: date-time - installation: *743 - organization: *744 - projects_v2_item: &788 - title: Projects v2 Item - description: An item belonging to a project - type: object - properties: - id: - type: number - description: The unique identifier of the project item. - node_id: - type: string - description: The node ID of the project item. - project_node_id: - type: string - description: The node ID of the project that contains this item. - content_node_id: - type: string - description: The node ID of the content represented by this - item. - content_type: *284 - creator: *4 - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the item was created. - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - description: The time when the item was last updated. - archived_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - description: The time when the item was archived. - required: - - id - - content_node_id - - content_type - - created_at - - updated_at - - archived_at - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - - changes - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-item-converted: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A draft issue in an organization project was converted to an issue. - operationId: projects-v2-item/converted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Converted Event - type: object - properties: - action: - type: string - enum: - - converted - changes: - type: object - properties: - content_type: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - installation: *743 - organization: *744 - projects_v2_item: *788 - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - - changes - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-item-created: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was added to a project in the organization. - operationId: projects-v2-item/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Created Event - type: object - properties: - action: - type: string - enum: - - created - installation: *743 - organization: *744 - projects_v2_item: *788 - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-item-deleted: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An item was deleted from a project in the organization. - operationId: projects-v2-item/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Deleted Event - type: object - properties: - action: - type: string - enum: - - deleted - installation: *743 - organization: *744 - projects_v2_item: *788 - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-item-edited: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The values or state of an item in an organization project were - changed. For example, the value of a field was updated, the body of a draft - issue was changed, or a draft issue was converted to an issue. - operationId: projects-v2-item/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Edited Event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: |- - The changes made to the item may involve modifications in the item's fields and draft issue body. - It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. - oneOf: - - type: object - properties: - field_value: - type: object - properties: - field_node_id: - type: string - field_type: - type: string - field_name: - type: string - project_number: - type: integer - from: - nullable: true - oneOf: - - type: string - - type: integer - - &789 - title: Projects v2 Single Select Option - description: An option for a single select field - type: object - properties: - id: - type: string - description: The unique identifier of the option. - name: - type: string - description: The display name of the option. - color: - type: string - nullable: true - description: The color associated with the option. - description: - type: string - nullable: true - description: A short description of the option. - required: - - id - - name - - &790 - title: Projects v2 Iteration Setting - description: An iteration setting for an iteration field - type: object - properties: - id: - type: string - description: The unique identifier of the iteration - setting. - title: - type: string - description: The iteration title. - title_html: - type: string - description: The iteration title, rendered as HTML. - duration: - type: number - nullable: true - description: The duration of the iteration in days. - start_date: - type: string - nullable: true - description: The start date of the iteration. - completed: - type: boolean - description: Whether the iteration has been completed. - required: - - id - - title - to: - nullable: true - oneOf: - - type: string - - type: integer - - *789 - - *790 - required: - - field_value - - type: object - properties: - body: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - nullable: true - required: - - body - installation: *743 - organization: *744 - projects_v2_item: *788 - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-item-reordered: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: The position of an item in an organization project was changed. - For example, an item was moved above or below another item in the table or - board layout. - operationId: projects-v2-item/reordered - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Reordered Event - type: object - properties: - action: - type: string - enum: - - reordered - changes: - type: object - properties: - previous_projects_v2_item_node_id: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - nullable: true - installation: *743 - organization: *744 - projects_v2_item: *788 - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - - changes - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-item-restored: - post: - summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: An archived item on an organization project was restored from the - archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)." - operationId: projects-v2-item/restored - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-item - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Item Restored Event - type: object - properties: - action: - type: string - enum: - - restored - changes: *791 - installation: *743 - organization: *744 - projects_v2_item: *788 - sender: *4 - required: - - action - - projects_v2_item - - organization - - sender - - changes - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_item - supported-webhook-types: - - organization - projects-v2-reopened: - post: - summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > Webhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A project in the organization was reopened. - operationId: projects-v2/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Project Reopened Event - type: object - properties: - action: - type: string - enum: - - reopened - installation: *743 - organization: *744 - projects_v2: *277 - sender: *4 - required: - - action - - projects_v2 - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2 - supported-webhook-types: - - organization - projects-v2-status-update-created: - post: - summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was added to a project in the organization. - operationId: projects-v2-status-update/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-status-update - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Status Update Created Event - type: object - properties: - action: - type: string - enum: - - created - installation: *743 - organization: *744 - projects_v2_status_update: &794 - title: Projects v2 Status Update - description: An status update belonging to a project - type: object - properties: *792 - required: *793 - sender: *4 - required: - - action - - projects_v2_status_update - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_status_update - supported-webhook-types: - - organization - projects-v2-status-update-deleted: - post: - summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was removed from a project in the organization. - operationId: projects-v2-status-update/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-status-update - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Status Update Deleted Event - type: object - properties: - action: - type: string - enum: - - deleted - installation: *743 - organization: *744 - projects_v2_status_update: *794 - sender: *4 - required: - - action - - projects_v2_status_update - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_status_update - supported-webhook-types: - - organization - projects-v2-status-update-edited: - post: - summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - - For activity relating to a project, use the `projects_v2` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - - > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was edited on a project in the organization. - operationId: projects-v2-status-update/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: project-v2-status-update - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Projects v2 Status Update Edited Event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - type: string - nullable: true - to: - type: string - nullable: true - status: - type: object - properties: - from: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - to: - type: string - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - nullable: true - start_date: - type: object - properties: - from: - type: string - format: date - nullable: true - to: - type: string - format: date - nullable: true - target_date: - type: object - properties: - from: - type: string - format: date - nullable: true - to: - type: string - format: date - nullable: true - installation: *743 - organization: *744 - projects_v2_status_update: *794 - sender: *4 - required: - - action - - projects_v2_status_update - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: projects_v2_status_update - supported-webhook-types: - - organization - public: - post: - summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - operationId: public - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#public - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: public - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: public event - type: object - properties: - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: public - supported-webhook-types: - - repository - - organization - - app - pull-request-assigned: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was assigned to a user. - operationId: pull-request/assigned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request assigned event - type: object - properties: - action: - type: string - enum: - - assigned - assignee: *764 - enterprise: *742 - installation: *743 - number: &795 - description: The pull request number. - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - assignee - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-auto-merge-disabled: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-disabled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request auto_merge_disabled event - type: object - properties: - action: - type: string - enum: - - auto_merge_disabled - enterprise: *742 - installation: *743 - number: - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - reason: - type: string - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - reason - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-auto-merge-enabled: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-enabled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request auto_merge_enabled event - type: object - properties: - action: - type: string - enum: - - auto_merge_enabled - enterprise: *742 - installation: *743 - number: - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - reason: - type: string - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-closed: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was closed. If `merged` is false in the webhook - payload, the pull request was closed with unmerged commits. If `merged` is - true in the webhook payload, the pull request was merged. - operationId: pull-request/closed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request closed event - type: object - properties: - action: - type: string - enum: - - closed - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: &796 - allOf: - - *597 - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's - branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property is closing down. - Please use `squash_merge_commit_title` instead.** - type: boolean - default: false - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-converted-to-draft: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/converted-to-draft - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request converted_to_draft event - type: object - properties: - action: - type: string - enum: - - converted_to_draft - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: *796 - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-demilestoned: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from a milestone. - operationId: pull-request/demilestoned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: *742 - milestone: *581 - number: *795 - organization: *744 - pull_request: &797 - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - properties: - merge_commit_sha: - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - version: '2026-03-10' - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-dequeued: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from the merge queue. - operationId: pull-request/dequeued - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request dequeued event - type: object - properties: - action: - type: string - enum: - - dequeued - enterprise: *742 - installation: *743 - number: - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - reason: - type: string - enum: - - UNKNOWN_REMOVAL_REASON - - MANUAL - - MERGE - - MERGE_CONFLICT - - CI_FAILURE - - CI_TIMEOUT - - ALREADY_MERGED - - QUEUE_CLEARED - - ROLL_BACK - - BRANCH_PROTECTIONS - - GIT_TREE_INVALID - - INVALID_MERGE_COMMIT - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - - reason - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-edited: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The title or body of a pull request was edited, or the base branch - of a pull request was changed. - operationId: pull-request/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the comment if the action was `edited`. - type: object - properties: - base: - type: object - properties: - ref: - type: object - properties: - from: - type: string - required: - - from - sha: - type: object - properties: - from: - type: string - required: - - from - required: - - ref - - sha - body: - type: object - properties: - from: - description: The previous version of the body if the action - was `edited`. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title if the action - was `edited`. - type: string - required: - - from - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: *796 - repository: *745 - sender: *4 - required: - - action - - changes - - number - - pull_request - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-enqueued: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to the merge queue. - operationId: pull-request/enqueued - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request enqueued event - type: object - properties: - action: - type: string - enum: - - enqueued - enterprise: *742 - installation: *743 - number: - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_discussions - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-labeled: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was added to a pull request. - operationId: pull-request/labeled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request labeled event - type: object - properties: - action: - type: string - enum: - - labeled - enterprise: *742 - installation: *743 - label: *763 - number: *795 - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-locked: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/locked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request locked event - type: object - properties: - action: - type: string - enum: - - locked - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-milestoned: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to a milestone. - operationId: pull-request/milestoned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request milestoned event - type: object - properties: - action: - type: string - enum: - - milestoned - enterprise: *742 - milestone: *581 - number: *795 - organization: *744 - pull_request: *797 - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-opened: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was created - operationId: pull-request/opened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request opened event - type: object - properties: - action: - type: string - enum: - - opened - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: *796 - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-ready-for-review: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A draft pull request was marked as ready for review. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/ready-for-review - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request ready_for_review event - type: object - properties: - action: - type: string - enum: - - ready_for_review - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: *796 - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-reopened: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously closed pull request was reopened. - operationId: pull-request/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request reopened event - type: object - properties: - action: - type: string - enum: - - reopened - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: *796 - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-created: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was created. - operationId: pull-request-review-comment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review_comment created event - type: object - properties: - action: - type: string - enum: - - created - comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - nullable: true - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the - comment belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - null - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can - be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - active_lock_reason - repository: *745 - sender: *4 - required: - - action - - comment - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-deleted: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was deleted. - operationId: pull-request-review-comment/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review_comment deleted event - type: object - properties: - action: - type: string - enum: - - deleted - comment: &799 - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the - comment belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - null - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can - be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - active_lock_reason - repository: *745 - sender: *4 - required: - - action - - comment - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-edited: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The content of a comment on a pull request diff was changed. - operationId: pull-request-review-comment/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review_comment - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: *798 - comment: *799 - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - user_view_type: - type: string - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - active_lock_reason - repository: *745 - sender: *4 - required: - - action - - changes - - comment - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-dismissed: - post: - summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was dismissed. - operationId: pull-request-review/dismissed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review dismissed event - type: object - properties: - action: - type: string - enum: - - dismissed - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: *745 - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: string - nullable: true - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - enum: - - dismissed - - approved - - changes_requested - submitted_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - nullable: true - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: *4 - required: - - action - - review - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review - supported-webhook-types: - - repository - - organization - - app - pull-request-review-edited: - post: - summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The body comment on a pull request review was edited. - operationId: pull-request-review/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action - was `edited`. - type: string - required: - - from - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: *745 - review: &800 - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: string - nullable: true - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - submitted_at: - type: string - nullable: true - format: date-time - updated_at: - type: string - nullable: true - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: *4 - required: - - action - - changes - - review - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review - supported-webhook-types: - - repository - - organization - - app - pull-request-review-request-removed: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A request for review by a person or team was removed from a pull - request. - operationId: pull-request/review-request-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request review_request_removed event - oneOf: - - type: object - properties: - action: - type: string - enum: - - review_request_removed - enterprise: *742 - installation: *743 - number: - description: The pull request number. - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: The default value for a squash merge - commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: The default value for a squash merge - commit title. - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is - a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the - pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request - within its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or - `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - requested_reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - sender: *4 - required: - - requested_reviewer - - action - - number - - pull_request - - repository - - sender - - type: object - properties: - action: - type: string - enum: - - review_request_removed - enterprise: *742 - installation: *743 - number: - description: The pull request number. - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is - a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the - pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request - within its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or - `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - requested_team: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/0/properties/pull_request/required/17" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/1/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-requested: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - operationId: pull-request/review-requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request review_requested event - oneOf: - - type: object - properties: - action: - type: string - enum: - - review_requested - enterprise: *742 - installation: *743 - number: - description: The pull request number. - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is - a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the - pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request - within its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or - `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - requested_reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - sender: *4 - required: - - requested_reviewer - - action - - number - - pull_request - - repository - - sender - - type: object - properties: - action: - type: string - enum: - - review_requested - enterprise: *742 - installation: *743 - number: - description: The pull request number. - type: integer - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is - a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull - requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when - pull requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or - public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use - the pull request title as default. **This property - is closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the - pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request - within its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or - `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - requested_team: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: *4 - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/oneOf/0/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/0/properties/pull_request/required/17" - - op: remove - path: "/oneOf/1/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/oneOf/1/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-review-submitted: - post: - summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review submitted event - type: object - properties: - action: - type: string - enum: - - submitted - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: *745 - review: *800 - sender: *4 - required: - - action - - review - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review - supported-webhook-types: - - repository - - organization - - app - pull-request-review-thread-resolved: - post: - summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review_thread - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review_thread resolved event - type: object - properties: - action: - type: string - enum: - - resolved - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: *745 - sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - nullable: true - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - null - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: string - nullable: true - format: date-time - required: - - action - - thread - - pull_request - - repository - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_thread - supported-webhook-types: - - repository - - organization - - app - pull-request-review-thread-unresolved: - post: - summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request_review_thread - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request_review_thread unresolved event - type: object - properties: - action: - type: string - enum: - - unresolved - enterprise: *742 - installation: *743 - organization: *744 - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: *745 - sender: *4 - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment - applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers - to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the - comment applies. - type: string - original_line: - description: The line of the blob to which the comment - applies. The last line of the range for a multi-line - comment - type: integer - original_position: - description: The index of the original line in the diff - to which the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line - comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the - comment applies. - type: string - position: - description: The line index in the diff to which the comment - applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which - the comment belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review - comment belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for - a multi-line comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line - comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for - a multi-line comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - null - default: RIGHT - subject_type: - description: The level at which the comment is targeted, - can be a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - updated_at: - type: string - nullable: true - format: date-time - required: - - action - - thread - - pull_request - - repository - x-github-breaking-changes: - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_thread - supported-webhook-types: - - repository - - organization - - app - pull-request-synchronize: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request synchronize event - type: object - properties: - action: - type: string - enum: - - synchronize - after: - type: string - before: - type: string - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: The default value for a merge commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: The default value for a merge commit message - title. - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - before - - after - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-unassigned: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request unassigned event - type: object - properties: - action: - type: string - enum: - - unassigned - assignee: *801 - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-unlabeled: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request unlabeled event - type: object - properties: - action: - type: string - enum: - - unlabeled - enterprise: *742 - installation: *743 - label: *763 - number: *795 - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: The default value for a merge commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: The default value for a merge commit message - title. - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-unlocked: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: pull_request - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: pull_request unlocked event - type: object - properties: - action: - type: string - enum: - - unlocked - enterprise: *742 - installation: *743 - number: *795 - organization: *744 - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - null - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a - draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull - requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull - requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull - requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull - requests are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository - is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create - pull requests: all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the - pull request title as default. **This property is - closing down. Please use `squash_merge_commit_title` - instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign - off on web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading - #, identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull - request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within - its repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have - for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for - its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: *745 - sender: *4 - required: - - action - - number - - pull_request - - repository - - sender - x-github-breaking-changes: - - changeset: remove_use_squash_pr_title_as_default - patch: - - op: remove - path: "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" - - op: remove - path: "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" - version: '2026-03-10' - - changeset: remove_pull_request_merge_commit_sha - patch: - - op: remove - path: "/properties/pull_request/properties/merge_commit_sha" - - op: remove - path: "/properties/pull_request/required/17" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - push: - post: - summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - - > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: push - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: push event - type: object - properties: - after: - description: The SHA of the most recent commit on `ref` after the - push. - type: string - base_ref: - type: string - nullable: true - before: - description: The SHA of the most recent commit on `ref` before the - push. - type: string - commits: - description: An array of commit objects describing the pushed commits. - (Pushed commits are all commits that are included in the `compare` - between the `before` commit and the `after` commit.) The array - includes a maximum of 2048 commits. If necessary, you can use - the [Commits API](https://docs.github.com/rest/commits) to fetch - additional commits. - type: array - items: - title: Commit - type: object - properties: - added: - description: An array of files added in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that - have been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. A maximum - of 3000 changed files will be reported per commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - compare: - description: URL that shows the changes in this `ref` update, from - the `before` commit to the `after` commit. For a newly created - `ref` that is directly based on the default branch, this is the - comparison between the head of the default branch and the `after` - commit. Otherwise, this shows all commits until the `after` commit. - type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: *742 - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit - type: object - nullable: true - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have - been pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - installation: *743 - organization: *744 - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - name - ref: - description: 'The full git ref that was pushed. Example: `refs/heads/main` - or `refs/tags/v3.14.1`.' - type: string - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - has_pull_requests: - description: Whether pull requests are enabled. - type: boolean - default: true - pull_request_creation_policy: - description: 'The policy controlling who can create pull requests: - all or collaborators_only.' - type: string - enum: - - all - - collaborators_only - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sender: *4 - required: - - ref - - before - - after - - created - - deleted - - forced - - base_ref - - compare - - commits - - head_commit - - repository - - pusher - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: push - supported-webhook-types: - - repository - - organization - - app - registry-package-published: - post: - summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package was published to a registry. - operationId: registry-package/published - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: registry_package - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - published - enterprise: *742 - installation: *743 - organization: *744 - registry_package: - type: object - properties: - created_at: - type: string - nullable: true - description: - type: string - nullable: true - ecosystem: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - namespace: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - package_type: - type: string - package_version: - type: object - nullable: true - properties: - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - body: - oneOf: - - type: string - - type: object - body_html: - type: string - container_metadata: - type: object - properties: - labels: - type: object - nullable: true - manifest: - type: object - nullable: true - tag: - type: object - properties: - digest: - type: string - name: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - npm_metadata: - type: object - nullable: true - properties: - name: - type: string - version: - type: string - npm_user: - type: string - author: - oneOf: - - type: string - - type: object - nullable: true - bugs: - oneOf: - - type: string - - type: object - nullable: true - dependencies: - type: object - dev_dependencies: - type: object - peer_dependencies: - type: object - optional_dependencies: - type: object - description: - type: string - dist: - oneOf: - - type: string - - type: object - nullable: true - git_head: - type: string - homepage: - type: string - license: - type: string - main: - type: string - repository: - oneOf: - - type: string - - type: object - nullable: true - scripts: - type: object - id: - type: string - node_version: - type: string - npm_version: - type: string - has_shrinkwrap: - type: boolean - maintainers: - type: array - items: - type: string - contributors: - type: array - items: - type: string - engines: - type: object - keywords: - type: array - items: - type: string - files: - type: array - items: - type: string - bin: - type: object - man: - type: object - directories: - oneOf: - - type: string - - type: object - nullable: true - os: - type: array - items: - type: string - cpu: - type: array - items: - type: string - readme: - type: string - installation_command: - type: string - release_id: - type: integer - commit_oid: - type: string - published_via_actions: - type: boolean - deleted_by_id: - type: integer - nuget_metadata: - type: array - nullable: true - items: - type: object - properties: - id: - oneOf: - - type: string - - type: object - - type: integer - nullable: true - name: - type: string - value: - oneOf: - - type: boolean - - type: string - - type: integer - - type: object - properties: - url: - type: string - branch: - type: string - commit: - type: string - type: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - nullable: true - size: - type: integer - state: - type: string - nullable: true - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - prerelease: - type: boolean - published_at: - type: string - tag_name: - type: string - target_commitish: - type: string - url: - type: string - rubygems_metadata: - type: array - items: *782 - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - name - - description - - summary - - html_url - - metadata - - package_files - - installation_command - - package_url - registry: - type: object - nullable: true - properties: - about_url: - type: string - name: - type: string - type: - type: string - url: - type: string - vendor: - type: string - updated_at: - type: string - nullable: true - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: *745 - sender: *4 - required: - - action - - registry_package - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: registry_package - supported-webhook-types: - - repository - - organization - - app - registry-package-updated: - post: - summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package that was previously published to a registry was updated. - operationId: registry-package/updated - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: registry_package - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - action: - type: string - enum: - - updated - enterprise: *742 - installation: *743 - organization: *744 - registry_package: - type: object - properties: - created_at: - type: string - description: - nullable: true - ecosystem: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - namespace: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - package_type: - type: string - package_version: - type: object - properties: - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - body: - type: string - body_html: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - nullable: true - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - size: - type: integer - state: - type: string - updated_at: - type: string - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: string - prerelease: - type: boolean - published_at: - type: string - tag_name: - type: string - target_commitish: - type: string - url: - type: string - required: - - url - - html_url - - id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: *782 - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - name - - description - - summary - - body - - body_html - - html_url - - target_commitish - - target_oid - - created_at - - updated_at - - metadata - - package_files - - author - - installation_command - - package_url - registry: - type: object - nullable: true - updated_at: - type: string - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: *745 - sender: *4 - required: - - action - - registry_package - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: registry_package - supported-webhook-types: - - repository - - organization - - app - release-created: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A draft was saved, or a release or pre-release was published without - previously being saved as a draft. - operationId: release/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - release: &802 - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: string - nullable: true - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - digest: - type: string - nullable: true - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: - type: string - format: uri - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - digest - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - updated_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - immutable: - description: Whether or not the release is immutable. - type: boolean - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease - or a full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where - the Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - immutable - - created_at - - published_at - - assets - - tarball_url - - updated_at - - zipball_url - - body - repository: *745 - sender: *4 - required: - - action - - release - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - release-deleted: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft release was deleted. - operationId: release/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - release: *802 - repository: *745 - sender: *4 - required: - - action - - release - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - release-edited: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." - operationId: release/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action - was `edited`. - type: string - required: - - from - name: - type: object - properties: - from: - description: The previous version of the name if the action - was `edited`. - type: string - required: - - from - tag_name: - type: object - properties: - from: - description: The previous version of the tag_name if the - action was `edited`. - type: string - required: - - from - make_latest: - type: object - properties: - to: - description: Whether this release was explicitly `edited` - to be the latest. - type: boolean - required: - - to - enterprise: *742 - installation: *743 - organization: *744 - release: *802 - repository: *745 - sender: *4 - required: - - action - - changes - - release - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - release-prereleased: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was created and identified as a pre-release. A pre-release - is a release that is not ready for production and may be unstable. - operationId: release/prereleased - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release prereleased event - type: object - properties: - action: - type: string - enum: - - prereleased - enterprise: *742 - installation: *743 - organization: *744 - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - required: - - assets - - assets_url - - author - - body - - created_at - - draft - - html_url - - id - - immutable - - name - - node_id - - prerelease - - published_at - - tag_name - - tarball_url - - target_commitish - - updated_at - - upload_url - - url - - zipball_url - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - digest - - content_type - - size - - download_count - - created_at - - updated_at - nullable: true - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: string - nullable: true - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - digest: - type: string - nullable: true - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - url: - type: string - format: uri - assets_url: - type: string - format: uri - author: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - immutable: - description: Whether or not the release is immutable. - type: boolean - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease - or a full release. - type: boolean - enum: - - true - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where - the Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - updated_at: - type: string - nullable: true - format: date-time - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - repository: *745 - sender: *4 - required: - - action - - release - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - release-published: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft of a release was published. - operationId: release/published - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: *742 - installation: *743 - organization: *744 - release: &803 - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - required: - - assets - - assets_url - - author - - body - - created_at - - draft - - html_url - - id - - name - - node_id - - prerelease - - immutable - - published_at - - tag_name - - tarball_url - - target_commitish - - updated_at - - upload_url - - url - - zipball_url - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - digest - - download_count - - created_at - - updated_at - nullable: true - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: string - nullable: true - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - digest: - type: string - nullable: true - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - url: - type: string - format: uri - assets_url: - type: string - format: uri - author: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - immutable: - description: Whether or not the release is immutable. - type: boolean - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease - or a full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where - the Git tag is created from. - type: string - updated_at: - type: string - nullable: true - format: date-time - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - repository: *745 - sender: *4 - required: - - action - - release - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - release-released: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was published, or a pre-release was changed to a release. - operationId: release/released - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release released event - type: object - properties: - action: - type: string - enum: - - released - enterprise: *742 - installation: *743 - organization: *744 - release: *802 - repository: *745 - sender: *4 - required: - - action - - release - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - release-unpublished: - post: - summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release or pre-release was unpublished. - operationId: release/unpublished - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: release - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: release unpublished event - type: object - properties: - action: - type: string - enum: - - unpublished - enterprise: *742 - installation: *743 - organization: *744 - release: *803 - repository: *745 - sender: *4 - required: - - action - - release - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: release - supported-webhook-types: - - repository - - organization - - app - repository-advisory-published: - post: - summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A repository security advisory was published. - operationId: repository-advisory/published - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_advisory - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Repository advisory published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - repository_advisory: *664 - sender: *4 - required: - - action - - repository - - repository_advisory - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_advisory - supported-webhook-types: - - repository - - organization - - app - repository-advisory-reported: - post: - summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A private vulnerability report was submitted. - operationId: repository-advisory/reported - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_advisory - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Repository advisory reported event - type: object - properties: - action: - type: string - enum: - - reported - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - repository_advisory: *664 - sender: *4 - required: - - action - - repository - - repository_advisory - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_advisory - supported-webhook-types: - - repository - - organization - - app - repository-archived: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was archived. - operationId: repository/archived - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository archived event - type: object - properties: - action: - type: string - enum: - - archived - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-created: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was created. - operationId: repository/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-deleted: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A repository was deleted. GitHub Apps and repository webhooks will - not receive this event. - operationId: repository/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-dispatch-sample.collected: - post: - summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: repository-dispatch/sample.collected - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_dispatch - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository_dispatch event - type: object - properties: - action: - type: string - description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` - request body. - branch: - type: string - client_payload: - type: object - nullable: true - additionalProperties: true - description: The `client_payload` that was specified in the `POST - /repos/{owner}/{repo}/dispatches` request body. - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - branch - - client_payload - - repository - - sender - - installation - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_dispatch - supported-webhook-types: - - app - repository-edited: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The topics, default branch, description, or homepage of a repository - was changed. - operationId: repository/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - default_branch: - type: object - properties: - from: - type: string - required: - - from - description: - type: object - properties: - from: - type: string - nullable: true - required: - - from - homepage: - type: object - properties: - from: - type: string - nullable: true - required: - - from - topics: - type: object - properties: - from: - type: array - nullable: true - items: - type: string - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-import: - post: - summary: This event occurs when a repository is imported to GitHub. For more - information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). - operationId: repository-import - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_import - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository_import event - type: object - properties: - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - status: - type: string - enum: - - success - - cancelled - - failure - required: - - status - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_import - supported-webhook-types: - - repository - - organization - repository-privatized: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The visibility of a repository was changed to `private`. - operationId: repository/privatized - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository privatized event - type: object - properties: - action: - type: string - enum: - - privatized - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-publicized: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The visibility of a repository was changed to `public`. - operationId: repository/publicized - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository publicized event - type: object - properties: - action: - type: string - enum: - - publicized - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-renamed: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: The name of a repository was changed. - operationId: repository/renamed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository renamed event - type: object - properties: - action: - type: string - enum: - - renamed - changes: - type: object - properties: - repository: - type: object - properties: - name: - type: object - properties: - from: - type: string - required: - - from - required: - - name - required: - - repository - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-ruleset-created: - post: - summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was created. - operationId: repository-ruleset/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_ruleset - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository ruleset created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - repository_ruleset: *326 - sender: *4 - required: - - action - - repository_ruleset - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_ruleset - supported-webhook-types: - - repository - - organization - - app - repository-ruleset-deleted: - post: - summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was deleted. - operationId: repository-ruleset/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_ruleset - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository ruleset deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - repository_ruleset: *326 - sender: *4 - required: - - action - - repository_ruleset - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_ruleset - supported-webhook-types: - - repository - - organization - - app - repository-ruleset-edited: - post: - summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was edited. - operationId: repository-ruleset/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_ruleset - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository ruleset edited event - type: object - properties: - action: - type: string - enum: - - edited - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - repository_ruleset: *326 - changes: - type: object - properties: - name: - type: object - properties: - from: - type: string - enforcement: - type: object - properties: - from: - type: string - conditions: - type: object - properties: - added: - type: array - items: *300 - deleted: - type: array - items: *300 - updated: - type: array - items: - type: object - properties: - condition: *300 - changes: - type: object - properties: - condition_type: - type: object - properties: - from: - type: string - target: - type: object - properties: - from: - type: string - include: - type: object - properties: - from: - type: array - items: - type: string - exclude: - type: object - properties: - from: - type: array - items: - type: string - rules: - type: object - properties: - added: - type: array - items: *617 - deleted: - type: array - items: *617 - updated: - type: array - items: - type: object - properties: - rule: *617 - changes: - type: object - properties: - configuration: - type: object - properties: - from: - type: string - rule_type: - type: object - properties: - from: - type: string - pattern: - type: object - properties: - from: - type: string - sender: *4 - required: - - action - - repository_ruleset - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_ruleset - supported-webhook-types: - - repository - - organization - - app - repository-transferred: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Ownership of the repository was transferred to a user or organization - account. This event is only sent to the account where the ownership is transferred. - To receive the `repository.transferred` event, the new owner account must - have the GitHub App installed, and the App must be subscribed to "Repository" - events. - operationId: repository/transferred - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - owner: - type: object - properties: - from: - type: object - properties: - organization: - title: Organization - type: object - properties: - avatar_url: - type: string - format: uri - description: - type: string - nullable: true - events_url: - type: string - format: uri - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - issues_url: - type: string - format: uri - login: - type: string - members_url: - type: string - format: uri-template - node_id: - type: string - public_members_url: - type: string - format: uri-template - repos_url: - type: string - format: uri - url: - type: string - format: uri - required: - - login - - id - - node_id - - url - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - format: int64 - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - required: - - from - required: - - owner - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - changes - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-unarchived: - post: - summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A previously archived repository was unarchived. - operationId: repository/unarchived - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository unarchived event - type: object - properties: - action: - type: string - enum: - - unarchived - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository - supported-webhook-types: - - business - - repository - - organization - - app - repository-vulnerability-alert-create: - post: - summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. - - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was created. - operationId: repository-vulnerability-alert/create - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_vulnerability_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository_vulnerability_alert create event - type: object - properties: - action: - type: string - enum: - - create - alert: &804 - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - required: - - affected_package_name - - affected_range - - created_at - - external_identifier - - external_reference - - ghsa_id - - id - - node_id - - number - - severity - - state - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - auto_dismissed - - open - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_vulnerability_alert - supported-webhook-types: - - repository - - organization - repository-vulnerability-alert-dismiss: - post: - summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. - - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was dismissed. - operationId: repository-vulnerability-alert/dismiss - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_vulnerability_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository_vulnerability_alert dismiss event - type: object - properties: - action: - type: string - enum: - - dismiss - alert: - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - required: - - affected_package_name - - affected_range - - created_at - - dismiss_reason - - dismissed_at - - dismisser - - external_identifier - - external_reference - - ghsa_id - - id - - node_id - - number - - severity - - state - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_comment: - type: string - nullable: true - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - dismissed - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_vulnerability_alert - supported-webhook-types: - - repository - - organization - repository-vulnerability-alert-reopen: - post: - summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. - - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A previously dismissed or resolved repository vulnerability alert - was reopened. - operationId: repository-vulnerability-alert/reopen - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_vulnerability_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository_vulnerability_alert reopen event - type: object - properties: - action: - type: string - enum: - - reopen - alert: *804 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_vulnerability_alert - supported-webhook-types: - - repository - - organization - repository-vulnerability-alert-resolve: - post: - summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. - - > [!WARNING] - > **Closing down notice:** This event is closing down. Use the `dependabot_alert` event instead. - description: A repository vulnerability alert was marked as resolved. - operationId: repository-vulnerability-alert/resolve - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: repository_vulnerability_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: repository_vulnerability_alert resolve event - type: object - properties: - action: - type: string - enum: - - resolve - alert: - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - required: - - affected_package_name - - affected_range - - created_at - - external_identifier - - external_reference - - ghsa_id - - id - - node_id - - number - - severity - - state - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - fixed - - open - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: repository_vulnerability_alert - supported-webhook-types: - - repository - - organization - secret-scanning-alert-assigned: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was assigned. - operationId: secret-scanning-alert/assigned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert assigned event - type: object - properties: - action: - type: string - enum: - - assigned - alert: &805 - type: object - properties: - number: *178 - created_at: *179 - updated_at: - type: string - description: 'The time that the alert was last updated in ISO - 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - url: *181 - html_url: *182 - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this - alert. - resolution: - type: string - description: The reason for resolving the alert. - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - - pattern_deleted - - pattern_edited - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 - format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - resolution_comment: - type: string - description: An optional comment to resolve an alert. - nullable: true - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: - type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - provider: - type: string - description: The provider of the secret that was detected. - nullable: true - provider_slug: - type: string - description: The slug identifier for the provider of the secret - that was detected. - nullable: true - validity: - type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected - secret. - nullable: true - push_protection_bypassed_by: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in - ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - push_protection_bypass_request_reviewer_comment: - type: string - description: An optional comment when reviewing a push protection - bypass. - nullable: true - push_protection_bypass_request_comment: - type: string - description: An optional comment when requesting a push protection - bypass. - nullable: true - push_protection_bypass_request_html_url: - type: string - format: uri - description: The URL to a push protection bypass request. - nullable: true - publicly_leaked: - type: boolean - description: Whether the detected secret was publicly leaked. - nullable: true - multi_repo: - type: boolean - description: Whether the detected secret was found in multiple - repositories in the same organization or business. - nullable: true - assigned_to: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - closure_request_comment: - type: string - description: An optional comment from the closure request author. - nullable: true - closure_request_reviewer_comment: - type: string - description: An optional comment from the closure request reviewer. - nullable: true - closure_request_reviewer: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - assignee: *4 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-created: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was created. - operationId: secret-scanning-alert/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: *805 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-location-created: - post: - summary: |- - This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - - For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alerts, use the `secret_scanning_alert` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A new instance of a previously detected secret was detected in - a repository, and the location of the secret was added to the existing alert. - operationId: secret-scanning-alert-location/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert_location - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: Secret Scanning Alert Location Created Event - type: object - properties: - action: - type: string - enum: - - created - alert: *805 - installation: *743 - location: *806 - organization: *744 - repository: *745 - sender: *4 - required: - - location - - alert - - repository - - sender - examples: - default: - value: - action: created - alert: - number: 42 - created_at: '2020-11-06T18:18:30Z' - updated_at: '2020-11-06T18:18:30Z' - url: https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42 - html_url: https://github.com/octocat-repo/hello-world/security/secret-scanning/42 - locations_url: https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations - state: open - resolution: - resolved_at: - resolved_by: - secret_type: mailchimp_api_key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - publicly_leaked: false - multi_repo: false - location: - type: commit - details: - path: "/example/secrets.txt" - start_line: 1 - end_line: 1 - start_column: 1 - end_column: 64 - blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b - commit_url: https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b - repository: - id: 186853002 - node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= - name: hello-world - full_name: octocat-repo/hello-world - private: false - owner: - login: octocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - html_url: https://github.com/octocat-repo/hello-world - description: - fork: false - url: https://api.github.com/repos/octocat-repo/hello-world - forks_url: https://api.github.com/repos/octocat-repo/hello-world/forks - keys_url: https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id} - collaborators_url: https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator} - teams_url: https://api.github.com/repos/octocat-repo/hello-world/teams - hooks_url: https://api.github.com/repos/octocat-repo/hello-world/hooks - issue_events_url: https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number} - events_url: https://api.github.com/repos/octocat-repo/hello-world/events - assignees_url: https://api.github.com/repos/octocat-repo/hello-world/assignees{/user} - branches_url: https://api.github.com/repos/octocat-repo/hello-world/branches{/branch} - tags_url: https://api.github.com/repos/octocat-repo/hello-world/tags - blobs_url: https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha} - git_tags_url: https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha} - git_refs_url: https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha} - trees_url: https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha} - statuses_url: https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha} - languages_url: https://api.github.com/repos/octocat-repo/hello-world/languages - stargazers_url: https://api.github.com/repos/octocat-repo/hello-world/stargazers - contributors_url: https://api.github.com/repos/octocat-repo/hello-world/contributors - subscribers_url: https://api.github.com/repos/octocat-repo/hello-world/subscribers - subscription_url: https://api.github.com/repos/octocat-repo/hello-world/subscription - commits_url: https://api.github.com/repos/octocat-repo/hello-world/commits{/sha} - git_commits_url: https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha} - comments_url: https://api.github.com/repos/octocat-repo/hello-world/comments{/number} - issue_comment_url: https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number} - contents_url: https://api.github.com/repos/octocat-repo/hello-world/contents/{+path} - compare_url: https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head} - merges_url: https://api.github.com/repos/octocat-repo/hello-world/merges - archive_url: https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref} - downloads_url: https://api.github.com/repos/octocat-repo/hello-world/downloads - issues_url: https://api.github.com/repos/octocat-repo/hello-world/issues{/number} - pulls_url: https://api.github.com/repos/octocat-repo/hello-world/pulls{/number} - milestones_url: https://api.github.com/repos/octocat-repo/hello-world/milestones{/number} - notifications_url: https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating} - labels_url: https://api.github.com/repos/octocat-repo/hello-world/labels{/name} - releases_url: https://api.github.com/repos/octocat-repo/hello-world/releases{/id} - deployments_url: https://api.github.com/repos/octocat-repo/hello-world/deployments - created_at: '2019-05-15T15:19:25Z' - updated_at: '2019-05-15T15:21:03Z' - pushed_at: '2019-05-15T15:20:57Z' - git_url: git://github.com/octocat-repo/hello-world.git - ssh_url: git@github.com:octocat-repo/hello-world.git - clone_url: https://github.com/octocat-repo/hello-world.git - svn_url: https://github.com/octocat-repo/hello-world - homepage: - size: 0 - stargazers_count: 0 - watchers_count: 0 - language: Ruby - has_issues: true - has_projects: true - has_downloads: true - has_wiki: true - has_pages: true - forks_count: 1 - mirror_url: - archived: false - disabled: false - open_issues_count: 2 - license: - forks: 1 - open_issues: 2 - watchers: 0 - default_branch: master - is_template: false - sender: - login: octocat - id: 21031067 - node_id: MDQ6VXNlcjIxMDMxMDY3 - avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - application/x-www-form-urlencoded: - schema: - title: Secret Scanning Alert Location Created Event - type: object - properties: - payload: - description: A URL-encoded string of the secret_scanning_alert_location.created - JSON payload. The decoded payload is a JSON object. - type: string - required: - - payload - examples: - default: - value: - payload: action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: webhooks - subcategory: secret_scanning_alert_location - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-publicly-leaked: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was detected in a public repo. - operationId: secret-scanning-alert/publicly-leaked - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert publicly leaked event - type: object - properties: - action: - type: string - enum: - - publicly_leaked - alert: *805 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-reopened: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A previously closed secret scanning alert was reopened. - operationId: secret-scanning-alert/reopened - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: *805 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-resolved: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was closed. - operationId: secret-scanning-alert/resolved - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert resolved event - type: object - properties: - action: - type: string - enum: - - resolved - alert: *805 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-unassigned: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was unassigned. - operationId: secret-scanning-alert/unassigned - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert unassigned event - type: object - properties: - action: - type: string - enum: - - unassigned - alert: *805 - assignee: *4 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-alert-validated: - post: - summary: |- - This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning alert was validated. - operationId: secret-scanning-alert/validated - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_alert - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_alert validated event - type: object - properties: - action: - type: string - enum: - - validated - alert: *805 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - alert - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_alert - supported-webhook-types: - - repository - - organization - - app - secret-scanning-scan-completed: - post: - summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - - Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A secret scanning scan was completed. - operationId: secret-scanning-scan/completed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: secret_scanning_scan - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: secret_scanning_scan completed event - type: object - properties: - action: - type: string - enum: - - completed - type: - type: string - description: What type of scan was completed - enum: - - backfill - - custom-pattern-backfill - - pattern-version-backfill - source: - type: string - description: What type of content was scanned - enum: - - git - - issues - - pull-requests - - discussions - - wiki - started_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - completed_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - secret_types: - type: array - description: List of patterns that were updated. This will be empty - for normal backfill scans or custom pattern updates - items: - type: string - nullable: true - custom_pattern_name: - type: string - description: If the scan was triggered by a custom pattern update, - this will be the name of the pattern that was updated - nullable: true - custom_pattern_scope: - type: string - description: If the scan was triggered by a custom pattern update, - this will be the scope of the pattern that was updated - enum: - - repository - - organization - - enterprise - nullable: true - repository: *745 - enterprise: *742 - installation: *743 - organization: *744 - sender: *4 - required: - - action - - source - - type - - started_at - - completed_at - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: secret_scanning_scan - supported-webhook-types: - - repository - - organization - - app - security-advisory-published: - post: - summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: security_advisory - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: security_advisory published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - security_advisory: &807 - description: The details of the security advisory, including summary, - description, and severity. - type: object - properties: - cvss: - type: object - properties: - score: - type: number - vector_string: - type: string - nullable: true - required: - - vector_string - - score - cvss_severities: *63 - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: - type: string - updated_at: - type: string - vulnerabilities: - type: array - items: - type: object - properties: - first_patched_version: - type: object - nullable: true - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: - type: string - nullable: true - required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - x-github-breaking-changes: - - changeset: deprecate_cvss - patch: - properties: - cvss: - required: - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - version: '2026-03-10' - sender: *4 - required: - - action - - security_advisory - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: security_advisory - supported-webhook-types: - - app - security-advisory-updated: - post: - summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed. - operationId: security-advisory/updated - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: security_advisory - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: security_advisory updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - security_advisory: *807 - sender: *4 - required: - - action - - security_advisory - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: security_advisory - supported-webhook-types: - - app - security-advisory-withdrawn: - post: - summary: |- - This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: security_advisory - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: security_advisory withdrawn event - type: object - properties: - action: - type: string - enum: - - withdrawn - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - security_advisory: - description: The details of the security advisory, including summary, - description, and severity. - type: object - properties: - cvss: - type: object - properties: - score: - type: number - vector_string: - type: string - nullable: true - required: - - vector_string - - score - cvss_severities: *63 - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: - type: string - updated_at: - type: string - vulnerabilities: - type: array - items: - type: object - properties: - first_patched_version: - type: object - nullable: true - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: - type: string - required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: *4 - required: - - action - - security_advisory - x-github-breaking-changes: - - changeset: deprecate_cvss - patch: - - op: remove - path: "/properties/security_advisory/properties/cvss" - - op: remove - path: "/properties/security_advisory/required/0" - version: '2026-03-10' - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: security_advisory - supported-webhook-types: - - app - security-and-analysis: - post: - summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: security_and_analysis - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: security_and_analysis event - type: object - properties: - changes: - type: object - properties: - from: - type: object - properties: - security_and_analysis: *299 - enterprise: *742 - installation: *743 - organization: *744 - repository: *347 - sender: *4 - required: - - changes - - repository - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: security_and_analysis - supported-webhook-types: - - repository - - organization - - app - sponsorship-cancelled: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sponsorship - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sponsorship cancelled event - type: object - properties: - action: - type: string - enum: - - cancelled - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - sponsorship: &808 - type: object - properties: - created_at: - type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - user_view_type: - type: string - node_id: - type: string - privacy_level: - type: string - sponsor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - sponsorable: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will - include the original tier before the change or pending change. - For more information, see the pending tier change payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier - required: - - action - - sponsorship - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-created: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sponsorship - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sponsorship created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - sponsorship: *808 - required: - - action - - sponsorship - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-edited: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sponsorship - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sponsorship edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - privacy_level: - type: object - properties: - from: - description: The `edited` event types include the details - about the change when someone edits a sponsorship to change - the privacy. - type: string - required: - - from - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - sponsorship: *808 - required: - - action - - changes - - sponsorship - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sponsorship - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sponsorship pending_cancellation event - type: object - properties: - action: - type: string - enum: - - pending_cancellation - effective_date: &809 - description: The `pending_cancellation` and `pending_tier_change` - event types will include the date the cancellation or tier change - will take effect. - type: string - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - sponsorship: *808 - required: - - action - - sponsorship - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-pending-tier-change: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sponsorship - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sponsorship pending_tier_change event - type: object - properties: - action: - type: string - enum: - - pending_tier_change - changes: &810 - type: object - properties: - tier: - type: object - properties: - from: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` - will include the original tier before the change or pending - change. For more information, see the pending tier change - payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - from - required: - - tier - effective_date: *809 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - sponsorship: *808 - required: - - action - - changes - - sponsorship - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-tier-changed: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor changed the tier of their sponsorship and the change - has taken effect. If a sponsor upgraded their tier, the change took effect - immediately. If a sponsor downgraded their tier, the change took effect at - the beginning of the sponsor's next billing cycle. - operationId: sponsorship/tier-changed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sponsorship - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sponsorship tier_changed event - type: object - properties: - action: - type: string - enum: - - tier_changed - changes: *810 - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - sponsorship: *808 - required: - - action - - changes - - sponsorship - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - star-created: - post: - summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: star - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: star created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - starred_at: - description: 'The time the star was created. This is a timestamp - in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for - the `deleted` action.' - type: string - nullable: true - required: - - action - - starred_at - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: star - supported-webhook-types: - - repository - - organization - - app - star-deleted: - post: - summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: star - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: star deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - starred_at: - description: 'The time the star was created. This is a timestamp - in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for - the `deleted` action.' - nullable: true - required: - - action - - starred_at - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: star - supported-webhook-types: - - repository - - organization - - app - status: - post: - summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: status - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: status event - type: object - properties: - avatar_url: - type: string - nullable: true - format: uri - branches: - description: An array of branch objects containing the status' SHA. - Each branch contains the given SHA, but the SHA may or may not - be the head of the branch. The array includes a maximum of 10 - branches. - type: array - items: - type: object - properties: - commit: - type: object - properties: - sha: - type: string - nullable: true - url: - type: string - nullable: true - format: uri - required: - - sha - - url - name: - type: string - protected: - type: boolean - required: - - name - - commit - - protected - commit: - type: object - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - comments_url: - type: string - format: uri - commit: - type: object - properties: - author: - allOf: - - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - - type: object - properties: - date: - type: string - email: - type: string - name: - type: string - required: - - date - comment_count: - type: integer - committer: - allOf: - - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - - type: object - properties: - date: - type: string - email: - type: string - name: - type: string - required: - - date - message: - type: string - tree: - type: object - properties: - sha: - type: string - url: - type: string - format: uri - required: - - sha - - url - url: - type: string - format: uri - verification: - type: object - properties: - payload: - type: string - nullable: true - reason: - type: string - enum: - - expired_key - - not_signing_key - - gpgverify_error - - gpgverify_unavailable - - unsigned - - unknown_signature_type - - no_user - - unverified_email - - bad_email - - unknown_key - - malformed_signature - - invalid - - valid - - bad_cert - - ocsp_pending - signature: - type: string - nullable: true - verified: - type: boolean - verified_at: - type: string - nullable: true - required: - - verified - - reason - - signature - - payload - - verified_at - required: - - author - - committer - - message - - tree - - url - - comment_count - - verification - committer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - html_url: - type: string - format: uri - node_id: - type: string - parents: - type: array - items: - type: object - properties: - html_url: - type: string - format: uri - sha: - type: string - url: - type: string - format: uri - required: - - sha - - url - - html_url - sha: - type: string - url: - type: string - format: uri - required: - - sha - - node_id - - commit - - url - - html_url - - comments_url - - author - - committer - - parents - context: - type: string - created_at: - type: string - description: - description: The optional human-readable description added to the - status. - type: string - nullable: true - enterprise: *742 - id: - description: The unique identifier of the status. - type: integer - installation: *743 - name: - type: string - organization: *744 - repository: *745 - sender: *4 - sha: - description: The Commit SHA. - type: string - state: - description: The new state. Can be `pending`, `success`, `failure`, - or `error`. - type: string - enum: - - pending - - success - - failure - - error - target_url: - description: The optional link added to the status. - type: string - nullable: true - updated_at: - type: string - required: - - id - - sha - - name - - target_url - - context - - description - - state - - commit - - branches - - created_at - - updated_at - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: status - supported-webhook-types: - - repository - - organization - - app - sub-issues-parent-issue-added: - post: - summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sub_issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: parent issue added event - type: object - properties: - action: - type: string - enum: - - parent_issue_added - parent_issue_id: - description: The ID of the parent issue. - type: number - parent_issue: *85 - parent_issue_repo: *79 - sub_issue_id: - description: The ID of the sub-issue. - type: number - sub_issue: *85 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - parent_issue_id - - parent_issue - - parent_issue_repo - - sub_issue_id - - sub_issue - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sub-issues - supported-webhook-types: - - repository - - organization - - app - sub-issues-parent-issue-removed: - post: - summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sub_issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: parent issue removed event - type: object - properties: - action: - type: string - enum: - - parent_issue_removed - parent_issue_id: - description: The ID of the parent issue. - type: number - parent_issue: *85 - parent_issue_repo: *79 - sub_issue_id: - description: The ID of the sub-issue. - type: number - sub_issue: *85 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - parent_issue_id - - parent_issue - - parent_issue_repo - - sub_issue_id - - sub_issue - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sub-issues - supported-webhook-types: - - repository - - organization - - app - sub-issues-sub-issue-added: - post: - summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sub_issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sub-issue added event - type: object - properties: - action: - type: string - enum: - - sub_issue_added - sub_issue_id: - description: The ID of the sub-issue. - type: number - sub_issue: *85 - sub_issue_repo: *79 - parent_issue_id: - description: The ID of the parent issue. - type: number - parent_issue: *85 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - sub_issue_id - - sub_issue - - sub_issue_repo - - parent_issue_id - - parent_issue - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sub-issues - supported-webhook-types: - - repository - - organization - - app - sub-issues-sub-issue-removed: - post: - summary: |- - This event occurs when there is activity relating to sub-issues. - - For activity relating to issues more generally, use the `issues` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. - description: A sub-issue was removed from an issue. - operationId: sub-issues/sub-issue-removed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: sub_issues - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: sub-issue removed event - type: object - properties: - action: - type: string - enum: - - sub_issue_removed - sub_issue_id: - description: The ID of the sub-issue. - type: number - sub_issue: *85 - sub_issue_repo: *79 - parent_issue_id: - description: The ID of the parent issue. - type: number - parent_issue: *85 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - sub_issue_id - - sub_issue - - sub_issue_repo - - parent_issue_id - - parent_issue - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sub-issues - supported-webhook-types: - - repository - - organization - - app - team-add: - post: - summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." - - For activity relating to teams, see the `teams` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team_add - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: team_add event - type: object - properties: - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - team: &811 - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications - when their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to which - this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which - this team belongs - example: 42 - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - - type - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications - when their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - type: - description: The ownership type of the team - type: string - enum: - - enterprise - - organization - organization_id: - type: integer - description: Unique identifier of the organization to which - this team belongs - example: 37 - enterprise_id: - type: integer - description: Unique identifier of the enterprise to which this - team belongs - example: 42 - required: - - name - - id - required: - - team - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team_add - supported-webhook-types: - - repository - - organization - - app - team-added-to-repository: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: team added_to_repository event - type: object - properties: - action: - type: string - enum: - - added_to_repository - enterprise: *742 - installation: *743 - organization: *744 - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sender: *4 - team: *811 - required: - - action - - team - - organization - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-created: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was created. - operationId: team/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: team created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: *742 - installation: *743 - organization: *744 - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sender: *4 - team: *811 - required: - - action - - team - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-deleted: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: team deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: *742 - installation: *743 - organization: *744 - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sender: *4 - team: *811 - required: - - action - - team - - organization - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-edited: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: team edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the team if the action was `edited`. - type: object - properties: - description: - type: object - properties: - from: - description: The previous version of the description if - the action was `edited`. - type: string - required: - - from - name: - type: object - properties: - from: - description: The previous version of the name if the action - was `edited`. - type: string - required: - - from - privacy: - type: object - properties: - from: - description: The previous version of the team's privacy - if the action was `edited`. - type: string - required: - - from - notification_setting: - type: object - properties: - from: - description: The previous version of the team's notification - setting if the action was `edited`. - type: string - required: - - from - repository: - type: object - properties: - permissions: - type: object - properties: - from: - type: object - properties: - admin: - description: The previous version of the team member's - `admin` permission on a repository, if the action - was `edited`. - type: boolean - pull: - description: The previous version of the team member's - `pull` permission on a repository, if the action - was `edited`. - type: boolean - push: - description: The previous version of the team member's - `push` permission on a repository, if the action - was `edited`. - type: boolean - required: - - from - required: - - permissions - enterprise: *742 - installation: *743 - organization: *744 - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sender: *4 - team: *811 - required: - - action - - changes - - team - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - team-removed-from-repository: - post: - summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: team - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: team removed_from_repository event - type: object - properties: - action: - type: string - enum: - - removed_from_repository - enterprise: *742 - installation: *743 - organization: *744 - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the - repository. The keys are the custom property names, and the - values are the corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - format: int64 - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sender: *4 - team: *811 - required: - - action - - team - - organization - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: team - supported-webhook-types: - - organization - - business - - app - watch-started: - post: - summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: watch - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: watch started event - type: object - properties: - action: - type: string - enum: - - started - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - required: - - action - - repository - - sender - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: watch - supported-webhook-types: - - repository - - organization - - app - workflow-dispatch: - post: - summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - - For activity relating to workflow runs, use the `workflow_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: workflow-dispatch - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_dispatch - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_dispatch event - type: object - properties: - enterprise: *742 - inputs: - type: object - nullable: true - additionalProperties: true - installation: *743 - organization: *744 - ref: - type: string - repository: *745 - sender: *4 - workflow: - type: string - required: - - inputs - - ref - - repository - - sender - - workflow - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_dispatch - supported-webhook-types: - - app - workflow-job-completed: - post: - summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run finished. This event occurs when a job - in a workflow is completed, regardless of whether the job was successful or - unsuccessful. - operationId: workflow-job/completed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_job - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_job completed event - type: object - properties: - action: - type: string - enum: - - completed - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow_job: - allOf: - - title: Workflow Job - description: The workflow job. Many `workflow_job` keys, such - as `head_sha`, `conclusion`, and `started_at` are the same as - those in a [`check_run`](#check_run) object. - type: object - properties: - check_run_url: - type: string - format: uri - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - enum: - - success - - failure - - null - - skipped - - cancelled - - action_required - - neutral - - timed_out - created_at: - description: The time that the job created. - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - labels: - description: Custom labels for the job. Specified by the [`"runs-on"` - attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) - in the workflow YAML. - type: array - items: - type: string - name: - type: string - node_id: - type: string - run_attempt: - type: integer - run_id: - type: number - run_url: - type: string - format: uri - runner_group_id: - description: The ID of the runner group that is running this - job. This will be `null` as long as `workflow_job[status]` - is `queued`. - type: integer - nullable: true - runner_group_name: - description: The name of the runner group that is running - this job. This will be `null` as long as `workflow_job[status]` - is `queued`. - type: string - nullable: true - runner_id: - description: The ID of the runner that is running this job. - This will be `null` as long as `workflow_job[status]` is - `queued`. - type: integer - nullable: true - runner_name: - description: The name of the runner that is running this job. - This will be `null` as long as `workflow_job[status]` is - `queued`. - type: string - nullable: true - started_at: - type: string - status: - description: The current status of the job. Can be `queued`, - `in_progress`, `waiting`, or `completed`. - type: string - enum: - - queued - - in_progress - - completed - - waiting - head_branch: - type: string - description: The name of the current branch. - nullable: true - workflow_name: - type: string - description: The name of the workflow. - nullable: true - steps: - type: array - items: - title: Workflow Step - type: object - properties: - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - enum: - - failure - - skipped - - success - - cancelled - - null - name: - type: string - number: - type: integer - started_at: - type: string - nullable: true - status: - type: string - enum: - - in_progress - - completed - - queued - required: - - name - - status - - conclusion - - number - - started_at - - completed_at - url: - type: string - format: uri - required: - - id - - run_id - - run_url - - run_attempt - - node_id - - head_sha - - url - - html_url - - status - - conclusion - - started_at - - completed_at - - name - - steps - - check_run_url - - labels - - runner_id - - runner_name - - runner_group_id - - runner_group_name - - workflow_name - - head_branch - - created_at - - type: object - properties: - check_run_url: - type: string - completed_at: - type: string - conclusion: - type: string - enum: - - success - - failure - - skipped - - cancelled - - action_required - - neutral - - timed_out - created_at: - description: The time that the job created. - type: string - head_sha: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: string - nullable: true - name: - type: string - node_id: - type: string - run_attempt: - type: integer - run_id: - type: integer - run_url: - type: string - runner_group_id: - type: number - nullable: true - runner_group_name: - type: string - nullable: true - runner_id: - type: number - nullable: true - runner_name: - type: string - nullable: true - started_at: - type: string - status: - type: string - head_branch: - type: string - description: The name of the current branch. - nullable: true - workflow_name: - type: string - description: The name of the workflow. - nullable: true - steps: - type: array - items: - type: object - nullable: true - url: - type: string - required: - - conclusion - deployment: *507 - required: - - action - - repository - - sender - - workflow_job - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_job - supported-webhook-types: - - business - - repository - - organization - - app - workflow-job-in-progress: - post: - summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run started processing on a runner. - operationId: workflow-job/in-progress - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_job - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_job in_progress event - type: object - properties: - action: - type: string - enum: - - in_progress - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow_job: - allOf: - - title: Workflow Job - description: The workflow job. Many `workflow_job` keys, such - as `head_sha`, `conclusion`, and `started_at` are the same as - those in a [`check_run`](#check_run) object. - type: object - properties: - check_run_url: - type: string - format: uri - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - enum: - - success - - failure - - null - - cancelled - - neutral - created_at: - description: The time that the job created. - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - labels: - description: Custom labels for the job. Specified by the [`"runs-on"` - attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) - in the workflow YAML. - type: array - items: - type: string - name: - type: string - node_id: - type: string - run_attempt: - type: integer - run_id: - type: number - run_url: - type: string - format: uri - runner_group_id: - description: The ID of the runner group that is running this - job. This will be `null` as long as `workflow_job[status]` - is `queued`. - type: integer - nullable: true - runner_group_name: - description: The name of the runner group that is running - this job. This will be `null` as long as `workflow_job[status]` - is `queued`. - type: string - nullable: true - runner_id: - description: The ID of the runner that is running this job. - This will be `null` as long as `workflow_job[status]` is - `queued`. - type: integer - nullable: true - runner_name: - description: The name of the runner that is running this job. - This will be `null` as long as `workflow_job[status]` is - `queued`. - type: string - nullable: true - started_at: - type: string - status: - description: The current status of the job. Can be `queued`, - `in_progress`, or `completed`. - type: string - enum: - - queued - - in_progress - - completed - head_branch: - type: string - description: The name of the current branch. - nullable: true - workflow_name: - type: string - description: The name of the workflow. - nullable: true - steps: - type: array - items: - title: Workflow Step - type: object - properties: - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - enum: - - failure - - skipped - - success - - null - - cancelled - name: - type: string - number: - type: integer - started_at: - type: string - nullable: true - status: - type: string - enum: - - in_progress - - completed - - queued - - pending - required: - - name - - status - - conclusion - - number - - started_at - - completed_at - url: - type: string - format: uri - required: - - id - - run_id - - run_url - - run_attempt - - node_id - - head_sha - - url - - html_url - - status - - conclusion - - started_at - - completed_at - - name - - steps - - check_run_url - - labels - - runner_id - - runner_name - - runner_group_id - - runner_group_name - - workflow_name - - head_branch - - created_at - - type: object - properties: - check_run_url: - type: string - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - created_at: - description: The time that the job created. - type: string - head_sha: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: string - name: - type: string - node_id: - type: string - run_attempt: - type: integer - run_id: - type: integer - run_url: - type: string - runner_group_id: - type: number - nullable: true - runner_group_name: - type: string - nullable: true - runner_id: - type: number - nullable: true - runner_name: - type: string - nullable: true - started_at: - type: string - status: - type: string - enum: - - in_progress - - completed - - queued - head_branch: - type: string - description: The name of the current branch. - nullable: true - workflow_name: - type: string - description: The name of the workflow. - nullable: true - steps: - type: array - items: - title: Workflow Step - type: object - properties: - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - name: - type: string - number: - type: integer - started_at: - type: string - nullable: true - status: - type: string - enum: - - in_progress - - completed - - pending - - queued - required: - - name - - status - - conclusion - - number - - started_at - - completed_at - url: - type: string - required: - - status - - steps - deployment: *507 - required: - - action - - repository - - sender - - workflow_job - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_job - supported-webhook-types: - - business - - repository - - organization - - app - workflow-job-queued: - post: - summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run was created. - operationId: workflow-job/queued - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_job - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_job queued event - type: object - properties: - action: - type: string - enum: - - queued - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow_job: - type: object - properties: - check_run_url: - type: string - format: uri - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - created_at: - description: The time that the job created. - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - labels: - type: array - items: - type: string - name: - type: string - node_id: - type: string - run_attempt: - type: integer - run_id: - type: number - run_url: - type: string - format: uri - runner_group_id: - type: integer - nullable: true - runner_group_name: - type: string - nullable: true - runner_id: - type: integer - nullable: true - runner_name: - type: string - nullable: true - started_at: - type: string - format: date-time - status: - type: string - enum: - - queued - - in_progress - - completed - - waiting - head_branch: - type: string - description: The name of the current branch. - nullable: true - workflow_name: - type: string - description: The name of the workflow. - nullable: true - steps: - type: array - items: - title: Workflow Step - type: object - properties: - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - enum: - - failure - - skipped - - success - - cancelled - - null - name: - type: string - number: - type: integer - started_at: - type: string - nullable: true - status: - type: string - enum: - - completed - - in_progress - - queued - - pending - required: - - name - - status - - conclusion - - number - - started_at - - completed_at - url: - type: string - format: uri - required: - - id - - run_id - - run_url - - run_attempt - - node_id - - head_sha - - url - - html_url - - status - - conclusion - - started_at - - completed_at - - name - - steps - - check_run_url - - labels - - runner_id - - runner_name - - runner_group_id - - runner_group_name - - workflow_name - - head_branch - - created_at - deployment: *507 - required: - - action - - repository - - sender - - workflow_job - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_job - supported-webhook-types: - - business - - repository - - organization - - app - workflow-job-waiting: - post: - summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run was created and is waiting for approvals. - operationId: workflow-job/waiting - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_job - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_job waiting event - type: object - properties: - action: - type: string - enum: - - waiting - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow_job: - type: object - properties: - check_run_url: - type: string - format: uri - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - created_at: - description: The time that the job created. - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - labels: - type: array - items: - type: string - name: - type: string - node_id: - type: string - run_attempt: - type: integer - run_id: - type: number - run_url: - type: string - format: uri - runner_group_id: - type: integer - nullable: true - runner_group_name: - type: string - nullable: true - runner_id: - type: integer - nullable: true - runner_name: - type: string - nullable: true - started_at: - type: string - format: date-time - head_branch: - type: string - description: The name of the current branch. - nullable: true - workflow_name: - type: string - description: The name of the workflow. - nullable: true - status: - type: string - enum: - - queued - - in_progress - - completed - - waiting - steps: - type: array - items: - title: Workflow Step - type: object - properties: - completed_at: - type: string - nullable: true - conclusion: - type: string - nullable: true - enum: - - failure - - skipped - - success - - cancelled - - null - name: - type: string - number: - type: integer - started_at: - type: string - nullable: true - status: - type: string - enum: - - completed - - in_progress - - queued - - pending - - waiting - required: - - name - - status - - conclusion - - number - - started_at - - completed_at - url: - type: string - format: uri - required: - - id - - run_id - - run_url - - run_attempt - - node_id - - head_sha - - url - - html_url - - status - - conclusion - - started_at - - completed_at - - name - - steps - - check_run_url - - labels - - runner_id - - runner_name - - runner_group_id - - runner_group_name - - workflow_name - - head_branch - - created_at - deployment: *507 - required: - - action - - repository - - sender - - workflow_job - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_job - supported-webhook-types: - - business - - repository - - organization - - app - workflow-run-completed: - post: - summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)" in the REST API documentation. - - For activity relating to a job in a workflow run, use the `workflow_job` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A workflow run finished. This event occurs when a workflow run - is completed, regardless of whether the workflow was successful or unsuccessful. - operationId: workflow-run/completed - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_run completed event - type: object - properties: - action: - type: string - enum: - - completed - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow: *759 - workflow_run: - title: Workflow Run - type: object - required: - - actor - - artifacts_url - - cancel_url - - check_suite_id - - check_suite_node_id - - check_suite_url - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - name - - node_id - - path - - previous_attempt_url - - pull_requests - - repository - - rerun_url - - run_attempt - - run_number - - run_started_at - - status - - triggering_actor - - updated_at - - url - - workflow_id - - workflow_url - properties: - actor: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: string - nullable: true - enum: - - action_required - - cancelled - - failure - - neutral - - skipped - - stale - - success - - timed_out - - startup_failure - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - required: - - id - - tree_id - - message - - timestamp - - author - - committer - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - required: - - email - - name - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - required: - - email - - name - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - head_repository: - title: Repository Lite - type: object - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - format: uri - pull_requests: - type: array - items: - type: object - required: - - url - - id - - number - - head - - base - nullable: true - properties: - base: - type: object - required: - - ref - - sha - - repo - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - required: - - id - - url - - name - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - sha: - type: string - head: - type: object - required: - - ref - - sha - - repo - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - required: - - id - - url - - name - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - sha: - type: string - id: - type: number - number: - type: number - url: - type: string - format: uri - referenced_workflows: - type: array - nullable: true - items: - type: object - required: - - path - - sha - properties: - path: - type: string - ref: - type: string - sha: - type: string - repository: - title: Repository Lite - type: object - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - - waiting - triggering_actor: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - display_title: - type: string - example: Simple Workflow - description: The event-specific title associated with the run - or the run-name if set, or the value of `run-name` if it is - set in the workflow. - required: - - action - - repository - - sender - - workflow - - workflow_run - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_run - supported-webhook-types: - - business - - repository - - organization - - app - workflow-run-in-progress: - post: - summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)" in the REST API documentation. - - For activity relating to a job in a workflow run, use the `workflow_job` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A workflow run started processing on a runner. - operationId: workflow-run/in-progress - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_run in_progress event - type: object - properties: - action: - type: string - enum: - - in_progress - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow: *759 - workflow_run: - title: Workflow Run - type: object - required: - - actor - - artifacts_url - - cancel_url - - check_suite_id - - check_suite_node_id - - check_suite_url - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - name - - node_id - - path - - previous_attempt_url - - pull_requests - - repository - - rerun_url - - run_attempt - - run_number - - run_started_at - - status - - triggering_actor - - updated_at - - url - - workflow_id - - workflow_url - properties: - actor: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: string - nullable: true - enum: - - action_required - - cancelled - - failure - - neutral - - skipped - - stale - - success - - timed_out - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - required: - - id - - tree_id - - message - - timestamp - - author - - committer - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - required: - - email - - name - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - required: - - email - - name - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - head_repository: - title: Repository Lite - type: object - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - nullable: true - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - format: uri - pull_requests: - type: array - items: - type: object - required: - - url - - id - - number - - head - - base - nullable: true - properties: - base: - type: object - required: - - ref - - sha - - repo - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - required: - - id - - url - - name - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - sha: - type: string - head: - type: object - required: - - ref - - sha - - repo - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - required: - - id - - url - - name - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - sha: - type: string - id: - type: number - number: - type: number - url: - type: string - format: uri - referenced_workflows: - type: array - nullable: true - items: - type: object - required: - - path - - sha - properties: - path: - type: string - ref: - type: string - sha: - type: string - repository: - title: Repository Lite - type: object - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - triggering_actor: - title: User - type: object - nullable: true - required: - - login - - id - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - required: - - action - - repository - - sender - - workflow - - workflow_run - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_run - supported-webhook-types: - - business - - repository - - organization - - app - workflow-run-requested: - post: - summary: |- - This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/rest/actions/workflow-runs)" in the REST API documentation. - - For activity relating to a job in a workflow run, use the `workflow_job` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A workflow run was triggered. - operationId: workflow-run/requested - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run - parameters: - - name: User-Agent - in: header - example: GitHub-Hookshot/123abc - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 - schema: - type: string - - name: X-Github-Event - in: header - example: workflow_run - schema: - type: string - - name: X-Github-Hook-Installation-Target-Id - in: header - example: 123123 - schema: - type: string - - name: X-Github-Hook-Installation-Target-Type - in: header - example: repository - schema: - type: string - - name: X-GitHub-Delivery - in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 - schema: - type: string - - name: X-Hub-Signature-256 - in: header - example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e - schema: - type: string - requestBody: - required: true - content: - application/json: - schema: - title: workflow_run requested event - type: object - properties: - action: - type: string - enum: - - requested - enterprise: *742 - installation: *743 - organization: *744 - repository: *745 - sender: *4 - workflow: *759 - workflow_run: - title: Workflow Run - type: object - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - null - - skipped - - startup_failure - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - format: uri - pull_requests: - type: array - items: - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: number - number: - type: number - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - required: - - archive_url - - assignees_url - - blobs_url - - branches_url - - collaborators_url - - comments_url - - commits_url - - compare_url - - contents_url - - contributors_url - - deployments_url - - description - - downloads_url - - events_url - - fork - - forks_url - - full_name - - git_commits_url - - git_refs_url - - git_tags_url - - hooks_url - - html_url - - id - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - - waiting - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - display_title: - type: string - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - display_title - required: - - action - - repository - - sender - - workflow - - workflow_run - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: workflow_run - supported-webhook-types: - - business - - repository - - organization - - app diff --git a/provider-dev/openapi/src/github/v00.00.00000/provider.yaml b/provider-dev/openapi/src/github/v00.00.00000/provider.yaml new file mode 100644 index 0000000..aeb9844 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/provider.yaml @@ -0,0 +1,407 @@ +id: github +name: github +version: v00.00.00000 +providerServices: + actions: + id: actions:v00.00.00000 + name: actions + preferred: true + service: + $ref: github/v00.00.00000/services/actions.yaml + title: actions API + version: v00.00.00000 + description: Endpoints to manage GitHub Actions using the REST API. + activity: + id: activity:v00.00.00000 + name: activity + preferred: true + service: + $ref: github/v00.00.00000/services/activity.yaml + title: activity API + version: v00.00.00000 + description: >- + Activity APIs provide access to notifications, subscriptions, and + timelines. + agent_tasks: + id: agent_tasks:v00.00.00000 + name: agent_tasks + preferred: true + service: + $ref: github/v00.00.00000/services/agent_tasks.yaml + title: agent_tasks API + version: v00.00.00000 + description: github API + apps: + id: apps:v00.00.00000 + name: apps + preferred: true + service: + $ref: github/v00.00.00000/services/apps.yaml + title: apps API + version: v00.00.00000 + description: Information for integrations and installations. + billing: + id: billing:v00.00.00000 + name: billing + preferred: true + service: + $ref: github/v00.00.00000/services/billing.yaml + title: billing API + version: v00.00.00000 + description: Monitor charges and usage from Actions and Packages. + campaigns: + id: campaigns:v00.00.00000 + name: campaigns + preferred: true + service: + $ref: github/v00.00.00000/services/campaigns.yaml + title: campaigns API + version: v00.00.00000 + description: Endpoints to manage campaigns via the REST API. + checks: + id: checks:v00.00.00000 + name: checks + preferred: true + service: + $ref: github/v00.00.00000/services/checks.yaml + title: checks API + version: v00.00.00000 + description: Rich interactions with checks run by your integrations. + classroom: + id: classroom:v00.00.00000 + name: classroom + preferred: true + service: + $ref: github/v00.00.00000/services/classroom.yaml + title: classroom API + version: v00.00.00000 + description: Interact with GitHub Classroom. + code_scanning: + id: code_scanning:v00.00.00000 + name: code_scanning + preferred: true + service: + $ref: github/v00.00.00000/services/code_scanning.yaml + title: code_scanning API + version: v00.00.00000 + description: github API + code_security: + id: code_security:v00.00.00000 + name: code_security + preferred: true + service: + $ref: github/v00.00.00000/services/code_security.yaml + title: code_security API + version: v00.00.00000 + description: github API + codes_of_conduct: + id: codes_of_conduct:v00.00.00000 + name: codes_of_conduct + preferred: true + service: + $ref: github/v00.00.00000/services/codes_of_conduct.yaml + title: codes_of_conduct API + version: v00.00.00000 + description: github API + codespaces: + id: codespaces:v00.00.00000 + name: codespaces + preferred: true + service: + $ref: github/v00.00.00000/services/codespaces.yaml + title: codespaces API + version: v00.00.00000 + description: Endpoints to manage Codespaces using the REST API. + copilot: + id: copilot:v00.00.00000 + name: copilot + preferred: true + service: + $ref: github/v00.00.00000/services/copilot.yaml + title: copilot API + version: v00.00.00000 + description: Endpoints to manage Copilot using the REST API. + credentials: + id: credentials:v00.00.00000 + name: credentials + preferred: true + service: + $ref: github/v00.00.00000/services/credentials.yaml + title: credentials API + version: v00.00.00000 + description: Revoke compromised or leaked GitHub credentials. + dependabot: + id: dependabot:v00.00.00000 + name: dependabot + preferred: true + service: + $ref: github/v00.00.00000/services/dependabot.yaml + title: dependabot API + version: v00.00.00000 + description: Endpoints to manage Dependabot. + dependency_graph: + id: dependency_graph:v00.00.00000 + name: dependency_graph + preferred: true + service: + $ref: github/v00.00.00000/services/dependency_graph.yaml + title: dependency_graph API + version: v00.00.00000 + description: github API + emojis: + id: emojis:v00.00.00000 + name: emojis + preferred: true + service: + $ref: github/v00.00.00000/services/emojis.yaml + title: emojis API + version: v00.00.00000 + description: List emojis available to use on GitHub. + enterprise_team_memberships: + id: enterprise_team_memberships:v00.00.00000 + name: enterprise_team_memberships + preferred: true + service: + $ref: github/v00.00.00000/services/enterprise_team_memberships.yaml + title: enterprise_team_memberships API + version: v00.00.00000 + description: github API + enterprise_team_organizations: + id: enterprise_team_organizations:v00.00.00000 + name: enterprise_team_organizations + preferred: true + service: + $ref: github/v00.00.00000/services/enterprise_team_organizations.yaml + title: enterprise_team_organizations API + version: v00.00.00000 + description: github API + enterprise_teams: + id: enterprise_teams:v00.00.00000 + name: enterprise_teams + preferred: true + service: + $ref: github/v00.00.00000/services/enterprise_teams.yaml + title: enterprise_teams API + version: v00.00.00000 + description: github API + gists: + id: gists:v00.00.00000 + name: gists + preferred: true + service: + $ref: github/v00.00.00000/services/gists.yaml + title: gists API + version: v00.00.00000 + description: View, modify your gists. + git: + id: git:v00.00.00000 + name: git + preferred: true + service: + $ref: github/v00.00.00000/services/git.yaml + title: git API + version: v00.00.00000 + description: Raw Git functionality. + gitignore: + id: gitignore:v00.00.00000 + name: gitignore + preferred: true + service: + $ref: github/v00.00.00000/services/gitignore.yaml + title: gitignore API + version: v00.00.00000 + description: View gitignore templates + hosted_compute: + id: hosted_compute:v00.00.00000 + name: hosted_compute + preferred: true + service: + $ref: github/v00.00.00000/services/hosted_compute.yaml + title: hosted_compute API + version: v00.00.00000 + description: github API + interactions: + id: interactions:v00.00.00000 + name: interactions + preferred: true + service: + $ref: github/v00.00.00000/services/interactions.yaml + title: interactions API + version: v00.00.00000 + description: Owner or admin management of users interactions. + issues: + id: issues:v00.00.00000 + name: issues + preferred: true + service: + $ref: github/v00.00.00000/services/issues.yaml + title: issues API + version: v00.00.00000 + description: Interact with GitHub Issues. + licenses: + id: licenses:v00.00.00000 + name: licenses + preferred: true + service: + $ref: github/v00.00.00000/services/licenses.yaml + title: licenses API + version: v00.00.00000 + description: View various OSS licenses. + markdown: + id: markdown:v00.00.00000 + name: markdown + preferred: true + service: + $ref: github/v00.00.00000/services/markdown.yaml + title: markdown API + version: v00.00.00000 + description: Render GitHub flavored Markdown + meta: + id: meta:v00.00.00000 + name: meta + preferred: true + service: + $ref: github/v00.00.00000/services/meta.yaml + title: meta API + version: v00.00.00000 + description: Endpoints that give information about the API. + migrations: + id: migrations:v00.00.00000 + name: migrations + preferred: true + service: + $ref: github/v00.00.00000/services/migrations.yaml + title: migrations API + version: v00.00.00000 + description: Move projects to or from GitHub. + oidc: + id: oidc:v00.00.00000 + name: oidc + preferred: true + service: + $ref: github/v00.00.00000/services/oidc.yaml + title: oidc API + version: v00.00.00000 + description: Endpoints to manage GitHub OIDC configuration using the REST API. + orgs: + id: orgs:v00.00.00000 + name: orgs + preferred: true + service: + $ref: github/v00.00.00000/services/orgs.yaml + title: orgs API + version: v00.00.00000 + description: Interact with organizations. + packages: + id: packages:v00.00.00000 + name: packages + preferred: true + service: + $ref: github/v00.00.00000/services/packages.yaml + title: packages API + version: v00.00.00000 + description: Manage packages for authenticated users and organizations. + private_registries: + id: private_registries:v00.00.00000 + name: private_registries + preferred: true + service: + $ref: github/v00.00.00000/services/private_registries.yaml + title: private_registries API + version: v00.00.00000 + description: github API + projects: + id: projects:v00.00.00000 + name: projects + preferred: true + service: + $ref: github/v00.00.00000/services/projects.yaml + title: projects API + version: v00.00.00000 + description: Endpoints to manage Projects using the REST API. + pulls: + id: pulls:v00.00.00000 + name: pulls + preferred: true + service: + $ref: github/v00.00.00000/services/pulls.yaml + title: pulls API + version: v00.00.00000 + description: Interact with GitHub Pull Requests. + rate_limit: + id: rate_limit:v00.00.00000 + name: rate_limit + preferred: true + service: + $ref: github/v00.00.00000/services/rate_limit.yaml + title: rate_limit API + version: v00.00.00000 + description: github API + reactions: + id: reactions:v00.00.00000 + name: reactions + preferred: true + service: + $ref: github/v00.00.00000/services/reactions.yaml + title: reactions API + version: v00.00.00000 + description: Interact with reactions to various GitHub entities. + repos: + id: repos:v00.00.00000 + name: repos + preferred: true + service: + $ref: github/v00.00.00000/services/repos.yaml + title: repos API + version: v00.00.00000 + description: Interact with GitHub Repos. + search: + id: search:v00.00.00000 + name: search + preferred: true + service: + $ref: github/v00.00.00000/services/search.yaml + title: search API + version: v00.00.00000 + description: Search for specific items on GitHub. + secret_scanning: + id: secret_scanning:v00.00.00000 + name: secret_scanning + preferred: true + service: + $ref: github/v00.00.00000/services/secret_scanning.yaml + title: secret_scanning API + version: v00.00.00000 + description: github API + security_advisories: + id: security_advisories:v00.00.00000 + name: security_advisories + preferred: true + service: + $ref: github/v00.00.00000/services/security_advisories.yaml + title: security_advisories API + version: v00.00.00000 + description: github API + teams: + id: teams:v00.00.00000 + name: teams + preferred: true + service: + $ref: github/v00.00.00000/services/teams.yaml + title: teams API + version: v00.00.00000 + description: Interact with GitHub Teams. + users: + id: users:v00.00.00000 + name: users + preferred: true + service: + $ref: github/v00.00.00000/services/users.yaml + title: users API + version: v00.00.00000 + description: Interact with and view information about users and also current user. +config: + auth: + type: basic + username_var: STACKQL_GITHUB_USERNAME + password_var: STACKQL_GITHUB_PASSWORD diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/actions.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/actions.yaml new file mode 100644 index 0000000..7e36773 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/actions.yaml @@ -0,0 +1,17454 @@ +openapi: 3.0.3 +info: + title: actions API + description: Endpoints to manage GitHub Actions using the REST API. + version: 1.1.4 +paths: + /enterprises/{enterprise}/actions/cache/retention-limit: + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: >- + Gets GitHub Actions cache retention limit for an enterprise. All + organizations and repositories under this + + enterprise may not set a higher cache retention limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-retention-limit-for-enterprise + examples: + default: + $ref: '#/components/examples/actions-cache-retention-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: >- + Sets GitHub Actions cache retention limit for an enterprise. All + organizations and repositories under this + + enterprise may not set a higher cache retention limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-retention-limit-for-enterprise + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-retention-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /enterprises/{enterprise}/actions/cache/storage-limit: + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: >- + Gets GitHub Actions cache storage limit for an enterprise. All + organizations and repositories under this + + enterprise may not set a higher cache storage limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-storage-limit-for-enterprise + examples: + default: + $ref: '#/components/examples/actions-cache-storage-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: >- + Sets GitHub Actions cache storage limit for an enterprise. All + organizations and repositories under this + + enterprise may not set a higher cache storage limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-enterprise' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-storage-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /organizations/{org}/actions/cache/retention-limit: + get: + summary: Get GitHub Actions cache retention limit for an organization + description: >- + Gets GitHub Actions cache retention limit for an organization. All + repositories under this + + organization may not set a higher cache retention limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-retention-limit-for-organization + examples: + default: + $ref: '#/components/examples/actions-cache-retention-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: >- + Sets GitHub Actions cache retention limit for an organization. All + repositories under this + + organization may not set a higher cache retention limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-retention-limit-for-organization + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-retention-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /organizations/{org}/actions/cache/storage-limit: + get: + summary: Get GitHub Actions cache storage limit for an organization + description: >- + Gets GitHub Actions cache storage limit for an organization. All + repositories under this + + organization may not set a higher cache storage limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-storage-limit-for-organization + examples: + default: + $ref: '#/components/examples/actions-cache-storage-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: >- + Sets GitHub Actions cache storage limit for an organization. All + organizations and repositories under this + + organization may not set a higher cache storage limit. + + + OAuth tokens and personal access tokens (classic) need the + `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-storage-limit-for-organization + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-storage-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /orgs/{org}/actions/cache/usage: + get: + summary: Get GitHub Actions cache usage for an organization + description: >- + Gets the total GitHub Actions cache usage for an organization. + + The data fetched using this API is refreshed approximately every 5 + minutes, so values returned from this endpoint may take at least 5 + minutes to get updated. + + + OAuth tokens and personal access tokens (classic) need the `read:org` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-usage-org-enterprise' + examples: + default: + $ref: '#/components/examples/actions-cache-usage-org-enterprise' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /orgs/{org}/actions/cache/usage-by-repository: + get: + summary: List repositories with GitHub Actions cache usage for an organization + description: >- + Lists repositories and their GitHub Actions cache usage for an + organization. + + The data fetched using this API is refreshed approximately every 5 + minutes, so values returned from this endpoint may take at least 5 + minutes to get updated. + + + OAuth tokens and personal access tokens (classic) need the `read:org` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-by-repo-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repository_cache_usages + properties: + total_count: + type: integer + repository_cache_usages: + type: array + items: + $ref: '#/components/schemas/actions-cache-usage-by-repository' + examples: + default: + $ref: '#/components/examples/org-actions-cache-usage-by-repo' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /orgs/{org}/actions/hosted-runners: + get: + summary: List GitHub-hosted runners for an organization + description: >- + Lists all GitHub-hosted runners configured in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `manage_runner:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-hosted-runners-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + post: + summary: Create a GitHub-hosted runner for an organization + description: >- + Creates a GitHub-hosted runner for an organization. + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + operationId: actions/create-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: >- + Name of the runner. Must be between 1 and 64 characters and + may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + image: + description: >- + The image of runner. To list all available images, use `GET + /actions/hosted-runners/images/github-owned` or `GET + /actions/hosted-runners/images/partner`. + type: object + properties: + id: + description: The unique identifier of the runner image. + type: string + source: + description: The source of the runner image. + type: string + enum: + - github + - partner + - custom + version: + description: >- + The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true + size: + description: >- + The machine size of the runner. To list available sizes, use + `GET actions/hosted-runners/machine-sizes` + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: >- + The maximum amount of runners to scale up to. Runners will + not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: >- + Whether this runner should be created with a static public + IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + image_gen: + description: >- + Whether this runner should be used to generate custom + images. + type: boolean + default: false + required: + - name + - image + - size + - runner_group_id + examples: + default: + value: + name: My Hosted runner + image: + id: ubuntu-latest + source: github + runner_group_id: 1 + size: 4-core + maximum_runners: 50 + enable_static_ip: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom: + get: + summary: List custom images for an organization + description: >- + List custom images for an organization. + + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-custom-image' + examples: + default: + $ref: >- + #/components/examples/actions-hosted-runner-custom-image-versions + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}: + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: >- + Get a custom image definition for GitHub Actions Hosted Runners. + + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner-custom-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-custom-image' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + delete: + summary: Delete a custom image from the organization + description: >- + Delete a custom image from the organization. + + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions: + get: + summary: List image versions of a custom image for an organization + description: >- + List image versions of a custom image for an organization. + + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - $ref: '#/components/parameters/actions-custom-image-definition-id' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + $ref: >- + #/components/schemas/actions-hosted-runner-custom-image-version + examples: + default: + $ref: >- + #/components/examples/actions-hosted-runner-custom-image-versions + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}: + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: >- + Get an image version of a custom image for GitHub Actions Hosted + Runners. + + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + - $ref: '#/components/parameters/actions-custom-image-version' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-hosted-runner-custom-image-version + examples: + default: + $ref: >- + #/components/examples/actions-hosted-runner-custom-image-version + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + delete: + summary: Delete an image version of custom image from the organization + description: >- + Delete an image version of custom image from the organization. + + + OAuth tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + - $ref: '#/components/parameters/actions-custom-image-version' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/github-owned: + get: + summary: Get GitHub-owned images for GitHub-hosted runners in an organization + description: >- + Get the list of GitHub-owned images available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-github-owned-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-curated-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-curated-image' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/partner: + get: + summary: Get partner images for GitHub-hosted runners in an organization + description: >- + Get the list of partner images available for GitHub-hosted runners for + an organization. + operationId: actions/get-hosted-runners-partner-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-curated-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-curated-image' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/limits: + get: + summary: Get limits on GitHub-hosted runners for an organization + description: Get the GitHub-hosted runners limits for an organization. + operationId: actions/get-hosted-runners-limits-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner-limits' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-limits-default' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/machine-sizes: + get: + summary: Get GitHub-hosted runners machine specs for an organization + description: >- + Get the list of machine specs available for GitHub-hosted runners for an + organization. + operationId: actions/get-hosted-runners-machine-specs-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machine_specs + properties: + total_count: + type: integer + machine_specs: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-machine-spec' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-machine-spec' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/platforms: + get: + summary: Get platforms for GitHub-hosted runners in an organization + description: >- + Get the list of platforms available for GitHub-hosted runners for an + organization. + operationId: actions/get-hosted-runners-platforms-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - platforms + properties: + total_count: + type: integer + platforms: + type: array + items: + type: string + examples: + default: + value: + total_count: 1 + platforms: + - linux-x64 + - win-x64 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/{hosted_runner_id}: + get: + summary: Get a GitHub-hosted runner for an organization + description: >- + Gets a GitHub-hosted runner configured in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hosted-runner-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + patch: + summary: Update a GitHub-hosted runner for an organization + description: >- + Updates a GitHub-hosted runner for an organization. + + OAuth app tokens and personal access tokens (classic) need the + `manage_runners:org` scope to use this endpoint. + operationId: actions/update-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hosted-runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: >- + Name of the runner. Must be between 1 and 64 characters and + may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: >- + The maximum amount of runners to scale up to. Runners will + not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: >- + Whether this runner should be updated with a static public + IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + size: + description: >- + The machine size of the runner. To list available sizes, use + `GET actions/hosted-runners/machine-sizes` + type: string + image_id: + description: >- + The unique identifier of the runner image. To list available + images, use `GET + /actions/hosted-runners/images/github-owned`, `GET + /actions/hosted-runners/images/partner`, or `GET + /actions/hosted-runners/images/custom`. + type: string + image_version: + description: >- + The version of the runner image to deploy. This is relevant + only for runners using custom images. + type: string + nullable: true + examples: + default: + value: + name: My larger runner + runner_group_id: 1 + maximum_runners: 50 + enable_static_ip: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + delete: + summary: Delete a GitHub-hosted runner for an organization + description: Deletes a GitHub-hosted runner for an organization. + operationId: actions/delete-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hosted-runner-id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/permissions: + get: + summary: Get GitHub Actions permissions for an organization + description: >- + Gets the GitHub Actions permissions policy for repositories and allowed + actions and reusable workflows in an organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/get-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-organization-permissions' + examples: + default: + $ref: '#/components/examples/actions-organization-permissions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set GitHub Actions permissions for an organization + description: >- + Sets the GitHub Actions permissions policy for repositories and allowed + actions and reusable workflows in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/set-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + $ref: '#/components/schemas/enabled-repositories' + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: all + allowed_actions: selected + sha_pinning_required: true + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/artifact-and-log-retention: + get: + summary: Get artifact and log retention settings for an organization + description: >- + Gets artifact and log retention settings for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-artifact-and-log-retention-response + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set artifact and log retention settings for an organization + description: >- + Sets artifact and log retention settings for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-artifact-and-log-retention' + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/fork-pr-contributor-approval: + get: + summary: Get fork PR contributor approval permissions for an organization + description: >- + Gets the fork PR contributor approval policy for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-contributor-approval' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: >- + Sets the fork PR contributor approval policy for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/fork-pr-workflows-private-repos: + get: + summary: Get private repo fork PR workflow settings for an organization + description: >- + Gets the settings for whether workflows from fork pull requests can run + on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-workflows-private-repos' + examples: + default: + $ref: >- + #/components/examples/actions-fork-pr-workflows-private-repos + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: >- + Sets the settings for whether workflows from fork pull requests can run + on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-fork-pr-workflows-private-repos-request + examples: + default: + $ref: '#/components/examples/actions-fork-pr-workflows-private-repos' + responses: + '204': + description: Empty response for successful settings update + '403': + description: >- + Forbidden - Fork PR workflow settings for private repositories are + managed by the enterprise owner + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/repositories: + get: + summary: List selected repositories enabled for GitHub Actions in an organization + description: >- + Lists the selected repositories that are enabled for GitHub Actions in + an organization. To use this endpoint, the organization permission + policy for `enabled_repositories` must be configured to `selected`. For + more information, see "[Set GitHub Actions permissions for an + organization](#set-github-actions-permissions-for-an-organization)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/list-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: number + repositories: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default: + $ref: '#/components/examples/repository-paginated' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set selected repositories enabled for GitHub Actions in an organization + description: >- + Replaces the list of selected repositories that are enabled for GitHub + Actions in an organization. To use this endpoint, the organization + permission policy for `enabled_repositories` must be configured to + `selected`. For more information, see "[Set GitHub Actions permissions + for an + organization](#set-github-actions-permissions-for-an-organization)." + + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/set-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 42 + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/repositories/{repository_id}: + put: + summary: Enable a selected repository for GitHub Actions in an organization + description: >- + Adds a repository to the list of selected repositories that are enabled + for GitHub Actions in an organization. To use this endpoint, the + organization permission policy for `enabled_repositories` must be must + be configured to `selected`. For more information, see "[Set GitHub + Actions permissions for an + organization](#set-github-actions-permissions-for-an-organization)." + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/enable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + delete: + summary: Disable a selected repository for GitHub Actions in an organization + description: >- + Removes a repository from the list of selected repositories that are + enabled for GitHub Actions in an organization. To use this endpoint, the + organization permission policy for `enabled_repositories` must be + configured to `selected`. For more information, see "[Set GitHub Actions + permissions for an + organization](#set-github-actions-permissions-for-an-organization)." + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/disable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/selected-actions: + get: + summary: Get allowed actions and reusable workflows for an organization + description: >- + Gets the selected actions and reusable workflows that are allowed in an + organization. To use this endpoint, the organization permission policy + for `allowed_actions` must be configured to `selected`. For more + information, see "[Set GitHub Actions permissions for an + organization](#set-github-actions-permissions-for-an-organization)." + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + default: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set allowed actions and reusable workflows for an organization + description: >- + Sets the actions and reusable workflows that are allowed in an + organization. To use this endpoint, the organization permission policy + for `allowed_actions` must be configured to `selected`. For more + information, see "[Set GitHub Actions permissions for an + organization](#set-github-actions-permissions-for-an-organization)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/set-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + selected_actions: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/self-hosted-runners: + get: + summary: Get self-hosted runners settings for an organization + description: >- + Gets the settings for self-hosted runners for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/self-hosted-runners-settings' + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: >- + http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set self-hosted runners settings for an organization + description: >- + Sets the settings for self-hosted runners for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: >- + The policy that controls whether self-hosted runners can be + used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/self-hosted-runners/repositories: + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: >- + Lists repositories that are allowed to use self-hosted runners in an + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default: + $ref: '#/components/examples/repository-paginated' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: >- + Sets repositories that are allowed to use self-hosted runners in an + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: >- + IDs of repositories that can use repository-level + self-hosted runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}: + put: + summary: >- + Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: >- + Adds a repository to the list of repositories that are allowed to use + self-hosted runners in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + delete: + summary: >- + Remove a repository from the list of repositories allowed to use + self-hosted runners in an organization + description: >- + Removes a repository from the list of repositories that are allowed to + use self-hosted runners in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope or the "Actions policies" fine-grained permission to + use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/workflow: + get: + summary: Get default workflow permissions for an organization + description: >- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when + running workflows in an organization, + + as well as whether GitHub Actions can submit approving pull request + reviews. For more information, see + + "[Setting the permissions of the GITHUB_TOKEN for your + organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-get-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set default workflow permissions for an organization + description: >- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when + running workflows in an organization, and sets if GitHub Actions + + can submit approving pull request reviews. For more information, see + + "[Setting the permissions of the GITHUB_TOKEN for your + organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Success response + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/actions-set-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/runner-groups: + get: + summary: List self-hosted runner groups for an organization + description: >- + Lists all self-hosted runner groups configured in an organization and + inherited from an enterprise. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runner-groups-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/visible-to-repository' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runner_groups + properties: + total_count: + type: number + runner_groups: + type: array + items: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-groups-org' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + post: + summary: Create a self-hosted runner group for an organization + description: >- + Creates a new self-hosted runner group for an organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/create-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: >- + Visibility of a runner group. You can select all + repositories, select individual repositories, or limit + access to private repositories. + type: string + enum: + - selected + - all + - private + default: all + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + allows_public_repositories: + description: >- + Whether the runner group can be used by `public` + repositories. + type: boolean + default: false + restricted_to_workflows: + description: >- + If `true`, the runner group will be restricted to running + only the workflows specified in the `selected_workflows` + array. + type: boolean + default: false + selected_workflows: + description: >- + List of workflows the runner group should be allowed to run. + This setting will be ignored unless + `restricted_to_workflows` is set to `true`. + type: array + items: + type: string + description: >- + Name of workflow the runner group should be allowed to + run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_repository_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-group' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}: + get: + summary: Get a self-hosted runner group for an organization + description: >- + Gets a specific self-hosted runner group for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/get-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-group-item' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + patch: + summary: Update a self-hosted runner group for an organization + description: >- + Updates the `name` and `visibility` of a self-hosted runner group in an + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/update-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: >- + Visibility of a runner group. You can select all + repositories, select individual repositories, or all private + repositories. + type: string + enum: + - selected + - all + - private + allows_public_repositories: + description: >- + Whether the runner group can be used by `public` + repositories. + type: boolean + default: false + restricted_to_workflows: + description: >- + If `true`, the runner group will be restricted to running + only the workflows specified in the `selected_workflows` + array. + type: boolean + default: false + selected_workflows: + description: >- + List of workflows the runner group should be allowed to run. + This setting will be ignored unless + `restricted_to_workflows` is set to `true`. + type: array + items: + type: string + description: >- + Name of workflow the runner group should be allowed to + run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + nullable: true + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-group' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + delete: + summary: Delete a self-hosted runner group from an organization + description: >- + Deletes a self-hosted runner group for an organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/delete-self-hosted-runner-group-from-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners: + get: + summary: List GitHub-hosted runners in a group for an organization + description: >- + Lists the GitHub-hosted runners in an organization group. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/list-github-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories: + get: + summary: List repository access to a self-hosted runner group in an organization + description: >- + Lists the repositories with access to a self-hosted runner group + configured in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: number + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-paginated' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + put: + summary: Set repository access for a self-hosted runner group in an organization + description: >- + Replaces the list of repositories that have access to a self-hosted + runner group configured in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}: + put: + summary: Add repository access to a self-hosted runner group in an organization + description: >- + Adds a repository to the list of repositories that can access a + self-hosted runner group. The runner group must have `visibility` set to + `selected`. For more information, see "[Create a self-hosted runner + group for an + organization](#create-a-self-hosted-runner-group-for-an-organization)." + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + delete: + summary: >- + Remove repository access to a self-hosted runner group in an + organization + description: >- + Removes a repository from the list of selected repositories that can + access a self-hosted runner group. The runner group must have + `visibility` set to `selected`. For more information, see "[Create a + self-hosted runner group for an + organization](#create-a-self-hosted-runner-group-for-an-organization)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/runners: + get: + summary: List self-hosted runners in a group for an organization + description: >- + Lists self-hosted runners that are in a specific organization group. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + put: + summary: Set self-hosted runners in a group for an organization + description: >- + Replaces the list of self-hosted runners that are part of an + organization runner group. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/set-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - runners + examples: + default: + value: + runners: + - 9 + - 2 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}: + put: + summary: Add a self-hosted runner to a group for an organization + description: >- + Adds a self-hosted runner to a runner group configured in an + organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: actions/add-self-hosted-runner-to-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + delete: + summary: Remove a self-hosted runner from a group for an organization + description: >- + Removes a self-hosted runner from a group configured in an organization. + The runner is then returned to the default group. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + operationId: actions/remove-self-hosted-runner-from-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runners: + get: + summary: List self-hosted runners for an organization + description: >- + Lists all self-hosted runners configured in an organization. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/downloads: + get: + summary: List runner applications for an organization + description: >- + Lists binaries for the runner application that you can download and run. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-runner-applications-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/runner-application' + examples: + default: + $ref: '#/components/examples/runner-application-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/generate-jitconfig: + post: + summary: Create configuration for a just-in-time runner for an organization + description: >- + Generates a configuration that can be passed to the runner application + at startup. + + + The authenticated user must have admin access to the organization. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - name + - runner_group_id + - labels + properties: + name: + type: string + description: The name of the new runner. + runner_group_id: + type: integer + description: The ID of the runner group to register the runner to. + labels: + type: array + minItems: 1 + maxItems: 100 + items: + type: string + description: >- + The names of the custom labels to add to the runner. + **Minimum items**: 1. **Maximum items**: 100. + work_folder: + type: string + description: >- + The working directory to be used for job execution, relative + to the runner install directory. + default: _work + examples: + default: + value: + name: New runner + runner_group_id: 1 + labels: + - self-hosted + - X64 + - macOS + - no-gpu + work_folder: _work + responses: + '201': + $ref: '#/components/responses/actions_runner_jitconfig' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/registration-token: + post: + summary: Create a registration token for an organization + description: >- + Returns a token that you can pass to the `config` script. The token + expires after one hour. + + + For example, you can replace `TOKEN` in the following example with the + registration token provided by this endpoint to configure your + self-hosted runner: + + + ``` + + ./config.sh --url https://github.com/octo-org --token TOKEN + + ``` + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/create-registration-token-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/remove-token: + post: + summary: Create a remove token for an organization + description: >- + 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. + + + For example, you can replace `TOKEN` in the following example with the + registration token provided by this endpoint to remove your self-hosted + runner from an organization: + + + ``` + + ./config.sh remove --token TOKEN + + ``` + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/create-remove-token-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/{runner_id}: + get: + summary: Get a self-hosted runner for an organization + description: >- + Gets a specific self-hosted runner configured in an organization. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/get-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Delete a self-hosted runner from an organization + description: >- + Forces the removal of a self-hosted runner from an organization. You can + use this endpoint to completely remove the runner when the machine you + were using no longer exists. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/delete-self-hosted-runner-from-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/{runner_id}/labels: + get: + summary: List labels for a self-hosted runner for an organization + description: >- + Lists all labels for a self-hosted runner configured in an organization. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-labels-for-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + post: + summary: Add custom labels to a self-hosted runner for an organization + description: >- + Adds custom labels to a self-hosted runner configured in an + organization. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - actions + operationId: actions/add-custom-labels-to-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 1 + maxItems: 100 + description: The names of the custom labels to add to the runner. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + put: + summary: Set custom labels for a self-hosted runner for an organization + description: >- + Remove all previous custom labels and set the new custom labels for a + specific + + self-hosted runner configured in an organization. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/set-custom-labels-for-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 0 + maxItems: 100 + description: >- + The names of the custom labels to set for the runner. You + can pass an empty array to remove all custom labels. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Remove all custom labels from a self-hosted runner for an organization + description: >- + Remove all custom labels from a self-hosted runner configured in an + + organization. Returns the remaining read-only labels from the runner. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels_readonly' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/{runner_id}/labels/{name}: + delete: + summary: Remove a custom label from a self-hosted runner for an organization + description: >- + Remove a custom label from a self-hosted runner configured + + in an organization. Returns the remaining labels from the runner. + + + This endpoint returns a `404 Not Found` status if the custom label is + not + + present on the runner. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-custom-label-from-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + - $ref: '#/components/parameters/runner-label-name' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/secrets: + get: + summary: List organization secrets + description: >- + Lists all secrets available in an organization without revealing their + + encrypted values. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-org-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-organization-secrets + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/organization-actions-secret' + examples: + default: + $ref: '#/components/examples/organization-actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/public-key: + get: + summary: Get an organization public key + description: >- + Gets your public key, which you need to encrypt secrets. You need to + + encrypt a secret before you can create or update secrets. + + + The authenticated user must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/get-org-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#get-an-organization-public-key + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-public-key' + examples: + default: + $ref: '#/components/examples/actions-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/{secret_name}: + get: + summary: Get an organization secret + description: >- + Gets a single organization secret without revealing its encrypted value. + + + The authenticated user must have collaborator access to a repository to + create, update, or read secrets + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/get-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#get-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-actions-secret' + examples: + default: + $ref: '#/components/examples/organization-actions-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update an organization secret + description: >- + Creates or updates an organization secret with an encrypted value. + Encrypt your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/create-or-update-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get an organization + public + key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + visibility: + type: string + description: >- + Which type of organization repositories have access to the + organization secret. `selected` means only the repositories + specified by `selected_repository_ids` can access the + secret. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + secret. You can only provide a list of repository ids when + the `visibility` is set to `selected`. You can manage the + list of selected repositories using the [List selected + repositories for an organization + secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization + secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization + secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + type: integer + required: + - encrypted_value + - key_id + - visibility + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete an organization secret + description: >- + Deletes a secret in an organization using the secret name. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/delete-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#delete-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for an organization secret + description: >- + Lists all repositories that have been selected when the `visibility` + + for repository access to a secret is set to `selected`. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Set selected repositories for an organization secret + description: >- + Replaces all repositories for an organization secret when the + `visibility` + + for repository access is set to `selected`. The visibility is set when + you [Create + + or update an organization + secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/set-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + secret. You can only provide a list of repository ids when + the `visibility` is set to `selected`. You can add and + remove individual repositories using the [Add selected + repository to an organization + secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) + and [Remove selected repository from an organization + secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization secret + description: >- + Adds a repository to an organization secret when the `visibility` for + + repository access is set to `selected`. For more information about + setting the visibility, see [Create or + + update an organization + secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/add-selected-repo-to-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '409': + description: Conflict when visibility type is not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Remove selected repository from an organization secret + description: >- + Removes a repository from an organization secret when the `visibility` + + for repository access is set to `selected`. The visibility is set when + you [Create + + or update an organization + secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-selected-repo-from-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response when repository was removed from the selected list + '409': + description: Conflict when visibility type not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/variables: + get: + summary: List organization variables + description: >- + Lists all organization variables. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-org-variables + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#list-organization-variables + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/organization-actions-variable' + examples: + default: + $ref: >- + #/components/examples/organization-actions-variables-paginated + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + post: + summary: Create an organization variable + description: >- + Creates an organization variable that you can reference in a GitHub + Actions workflow. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/create-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#create-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + visibility: + type: string + description: >- + The type of repositories in the organization that can access + the variable. `selected` means only the repositories + specified by `selected_repository_ids` can access the + variable. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + variable. You can only provide a list of repository ids when + the `visibility` is set to `selected`. + items: + type: integer + required: + - name + - value + - visibility + examples: + default: + value: + name: USERNAME + value: octocat + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a variable + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /orgs/{org}/actions/variables/{name}: + get: + summary: Get an organization variable + description: >- + Gets a specific variable in an organization. + + + The authenticated user must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/get-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#get-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-actions-variable' + examples: + default: + $ref: '#/components/examples/organization-actions-variable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + patch: + summary: Update an organization variable + description: >- + Updates an organization variable that you can reference in a GitHub + Actions workflow. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/update-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#update-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + visibility: + type: string + description: >- + The type of repositories in the organization that can access + the variable. `selected` means only the repositories + specified by `selected_repository_ids` can access the + variable. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + variable. You can only provide a list of repository ids when + the `visibility` is set to `selected`. + items: + type: integer + examples: + default: + value: + name: USERNAME + value: octocat + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Delete an organization variable + description: >- + Deletes an organization variable using the variable name. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the`admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/delete-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#delete-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /orgs/{org}/actions/variables/{name}/repositories: + get: + summary: List selected repositories for an organization variable + description: >- + Lists all repositories that can access an organization variable + + that is available to selected repositories. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/list-selected-repos-for-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + '409': + description: >- + Response when the visibility of the variable is not set to + `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + put: + summary: Set selected repositories for an organization variable + description: >- + Replaces all repositories for an organization variable that is available + + to selected repositories. Organization variables that are available to + selected + + repositories have their `visibility` field set to `selected`. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/set-selected-repos-for-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: >- + The IDs of the repositories that can access the organization + variable. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + '409': + description: >- + Response when the visibility of the variable is not set to + `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /orgs/{org}/actions/variables/{name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization variable + description: >- + Adds a repository to an organization variable that is available to + selected repositories. + + Organization variables that are available to selected repositories have + their `visibility` field set to `selected`. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. If the repository is private, OAuth tokens + and personal access tokens (classic) need the `repo` scope to use this + endpoint. + tags: + - actions + operationId: actions/add-selected-repo-to-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '409': + description: >- + Response when the visibility of the variable is not set to + `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Remove selected repository from an organization variable + description: >- + Removes a repository from an organization variable that is + + available to selected repositories. Organization variables that are + available to + + selected repositories have their `visibility` field set to `selected`. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. If the repository is private, + the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-selected-repo-from-org-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '409': + description: >- + Response when the visibility of the variable is not set to + `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/artifacts: + get: + summary: List artifacts for a repository + description: >- + Lists all artifacts for a repository. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-artifacts-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/artifact-name' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - artifacts + properties: + total_count: + type: integer + artifacts: + type: array + items: + $ref: '#/components/schemas/artifact' + examples: + default: + $ref: '#/components/examples/artifact-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/artifacts/{artifact_id}: + get: + summary: Get an artifact + description: >- + Gets a specific artifact for a workflow run. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-artifact + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#get-an-artifact + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/artifact-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/artifact' + examples: + default: + $ref: '#/components/examples/artifact' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + delete: + summary: Delete an artifact + description: >- + Deletes an artifact for a workflow run. + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-artifact + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/artifact-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}: + get: + summary: Download an artifact + description: >- + Gets a redirect URL to download an archive for a repository. This URL + expires after 1 minute. Look for `Location:` in + + the response header to find the URL for the download. The + `:archive_format` must be `zip`. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/download-artifact + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#download-an-artifact + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/artifact-id' + - name: archive_format + in: path + required: true + schema: + type: string + responses: + '302': + description: Response + headers: + Location: + $ref: '#/components/headers/location' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/cache/retention-limit: + get: + summary: Get GitHub Actions cache retention limit for a repository + description: >- + Gets GitHub Actions cache retention limit for a repository. This + determines how long caches will be retained for, if + + not manually removed or evicted due to size constraints. + + + OAuth tokens and personal access tokens (classic) need the + `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-retention-limit-for-repository + examples: + default: + $ref: '#/components/examples/actions-cache-retention-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: >- + Sets GitHub Actions cache retention limit for a repository. This + determines how long caches will be retained for, if + + not manually removed or evicted due to size constraints. + + + OAuth tokens and personal access tokens (classic) need the + `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-retention-limit-for-repository + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-retention-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/cache/storage-limit: + get: + summary: Get GitHub Actions cache storage limit for a repository + description: >- + Gets GitHub Actions cache storage limit for a repository. This + determines the maximum size of caches that can be + + stored before eviction occurs. + + + OAuth tokens and personal access tokens (classic) need the + `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-cache-storage-limit-for-repository + examples: + default: + $ref: '#/components/examples/actions-cache-storage-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: >- + Sets GitHub Actions cache storage limit for a repository. This + determines the maximum size of caches that can be + + stored before eviction occurs. + + + OAuth tokens and personal access tokens (classic) need the + `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-repository' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-storage-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/cache/usage: + get: + summary: Get GitHub Actions cache usage for a repository + description: >- + Gets GitHub Actions cache usage for a repository. + + The data fetched using this API is refreshed approximately every 5 + minutes, so values returned from this endpoint may take at least 5 + minutes to get updated. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-usage-by-repository' + examples: + default: + $ref: '#/components/examples/actions-cache-usage' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/caches: + get: + summary: List GitHub Actions caches for a repository + description: >- + Lists the GitHub Actions caches for a repository. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-list + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/actions-cache-git-ref-full' + - $ref: '#/components/parameters/actions-cache-key' + - $ref: '#/components/parameters/actions-cache-list-sort' + - $ref: '#/components/parameters/direction' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-list' + examples: + default: + $ref: '#/components/examples/actions-cache-list' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: cache + x-stackQL-resource: cache + delete: + summary: Delete GitHub Actions caches for a repository (using a cache key) + description: >- + Deletes one or more GitHub Actions caches for a repository, using a + complete cache key. By default, all caches that match the provided key + are deleted, but you can optionally provide a Git ref to restrict + deletions to caches that match both the provided key and the Git ref. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-actions-cache-by-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/actions-cache-key-required' + - $ref: '#/components/parameters/actions-cache-git-ref-full' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-list' + examples: + default: + $ref: '#/components/examples/actions-cache-list' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/caches/{cache_id}: + delete: + summary: Delete a GitHub Actions cache for a repository (using a cache ID) + description: >- + Deletes a GitHub Actions cache for a repository, using a cache ID. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-actions-cache-by-id + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/cache-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/jobs/{job_id}: + get: + summary: Get a job for a workflow run + description: >- + Gets a specific job in a workflow run. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-job-for-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/job-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/job' + examples: + default: + $ref: '#/components/examples/job' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/jobs/{job_id}/logs: + get: + summary: Download job logs for a workflow run + description: >- + Gets a redirect URL to download a plain text file of logs for a workflow + job. This link expires after 1 minute. Look + + for `Location:` in the response header to find the URL for the download. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-job-logs-for-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/job-id' + responses: + '302': + description: Response + headers: + Location: + example: >- + https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun: + post: + summary: Re-run a job from a workflow run + description: >- + Re-run a job and its dependent jobs in a workflow run. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/re-run-job-for-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/job-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + enable_debug_logging: + type: boolean + default: false + description: Whether to enable debug logging for the re-run. + examples: + default: + value: null + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/oidc/customization/sub: + get: + summary: >- + Get the customization template for an OIDC subject claim for a + repository + description: >- + Gets the customization template for an OpenID Connect (OIDC) subject + claim. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/get-custom-oidc-sub-claim-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Status response + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-sub-repo' + examples: + default: + $ref: '#/components/examples/oidc-custom-sub-repo' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: oidc + x-stackQL-resource: oidc + put: + summary: >- + Set the customization template for an OIDC subject claim for a + repository + description: >- + Sets the customization template and `opt-in` or `opt-out` flag for an + OpenID Connect (OIDC) subject claim for a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/set-custom-oidc-sub-claim-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + title: Actions OIDC subject customization for a repository + description: Actions OIDC subject customization for a repository + type: object + required: + - use_default + properties: + use_default: + description: >- + Whether to use the default template or not. If `true`, the + `include_claim_keys` field is ignored. + type: boolean + include_claim_keys: + description: >- + Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string + examples: + default: + value: + use_default: false + include_claim_keys: + - repo + - context + responses: + '201': + description: Empty response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /repos/{owner}/{repo}/actions/organization-secrets: + get: + summary: List repository organization secrets + description: >- + Lists all organization secrets shared with a repository without + revealing their encrypted + + values. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-organization-secrets + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/organization-variables: + get: + summary: List repository organization variables + description: >- + Lists all organization variables shared with a repository. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-organization-variables + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#list-repository-organization-variables + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/permissions: + get: + summary: Get GitHub Actions permissions for a repository + description: >- + Gets the GitHub Actions permissions policy for a repository, including + whether GitHub Actions is enabled and the actions and reusable workflows + allowed to run in the repository. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-repository-permissions' + examples: + default: + $ref: '#/components/examples/actions-repository-permissions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set GitHub Actions permissions for a repository + description: >- + Sets the GitHub Actions permissions policy for enabling GitHub Actions + and allowed actions and reusable workflows in the repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/set-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + $ref: '#/components/schemas/actions-enabled' + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled + examples: + default: + value: + enabled: true + allowed_actions: selected + sha_pinning_required: true + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/access: + get: + summary: Get the level of access for workflows outside of the repository + description: >- + Gets the level of access that workflows outside of the repository have + to actions and reusable workflows in the repository. + + This endpoint only applies to private repositories. + + For more information, see "[Allowing access to components in a private + repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-workflow-access-to-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-workflow-access-to-repository' + examples: + default: + $ref: '#/components/examples/actions-workflow-access-to-repository' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set the level of access for workflows outside of the repository + description: >- + Sets the level of access that workflows outside of the repository have + to actions and reusable workflows in the repository. + + This endpoint only applies to private repositories. + + For more information, see "[Allowing access to components in a private + repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/set-workflow-access-to-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-workflow-access-to-repository' + examples: + default: + $ref: '#/components/examples/actions-workflow-access-to-repository' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention: + get: + summary: Get artifact and log retention settings for a repository + description: >- + Gets artifact and log retention settings for a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-artifact-and-log-retention-response + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set artifact and log retention settings for a repository + description: >- + Sets artifact and log retention settings for a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Empty response for successful settings update + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-artifact-and-log-retention' + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval: + get: + summary: Get fork PR contributor approval permissions for a repository + description: >- + Gets the fork PR contributor approval policy for a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-contributor-approval' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set fork PR contributor approval permissions for a repository + description: >- + Sets the fork PR contributor approval policy for a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos: + get: + summary: Get private repo fork PR workflow settings for a repository + description: >- + Gets the settings for whether workflows from fork pull requests can run + on a private repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-workflows-private-repos' + examples: + default: + $ref: >- + #/components/examples/actions-fork-pr-workflows-private-repos + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set private repo fork PR workflow settings for a repository + description: >- + Sets the settings for whether workflows from fork pull requests can run + on a private repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/actions-fork-pr-workflows-private-repos-request + examples: + default: + $ref: '#/components/examples/actions-fork-pr-workflows-private-repos' + responses: + '204': + description: Empty response for successful settings update + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/selected-actions: + get: + summary: Get allowed actions and reusable workflows for a repository + description: >- + Gets the settings for selected actions and reusable workflows that are + allowed in a repository. To use this endpoint, the repository policy for + `allowed_actions` must be configured to `selected`. For more + information, see "[Set GitHub Actions permissions for a + repository](#set-github-actions-permissions-for-a-repository)." + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + default: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set allowed actions and reusable workflows for a repository + description: >- + Sets the actions and reusable workflows that are allowed in a + repository. To use this endpoint, the repository permission policy for + `allowed_actions` must be configured to `selected`. For more + information, see "[Set GitHub Actions permissions for a + repository](#set-github-actions-permissions-for-a-repository)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: actions/set-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + selected_actions: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/workflow: + get: + summary: Get default workflow permissions for a repository + description: >- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when + running workflows in a repository, + + as well as if GitHub Actions can submit approving pull request reviews. + + For more information, see "[Setting the permissions of the GITHUB_TOKEN + for your + repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-get-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set default workflow permissions for a repository + description: >- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when + running workflows in a repository, and sets if GitHub Actions + + can submit approving pull request reviews. + + For more information, see "[Setting the permissions of the GITHUB_TOKEN + for your + repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Success response + '409': + description: >- + Conflict response when changing a setting is prevented by the owning + organization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-set-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/runners: + get: + summary: List self-hosted runners for a repository + description: >- + Lists all self-hosted runners configured in a repository. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/downloads: + get: + summary: List runner applications for a repository + description: >- + Lists binaries for the runner application that you can download and run. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-runner-applications-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/runner-application' + examples: + default: + $ref: '#/components/examples/runner-application-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/generate-jitconfig: + post: + summary: Create configuration for a just-in-time runner for a repository + description: >- + Generates a configuration that can be passed to the runner application + at startup. + + + The authenticated user must have admin access to the repository. + + + OAuth tokens and personal access tokens (classic) need the`repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - name + - runner_group_id + - labels + properties: + name: + type: string + description: The name of the new runner. + runner_group_id: + type: integer + description: The ID of the runner group to register the runner to. + labels: + type: array + minItems: 1 + maxItems: 100 + items: + type: string + description: >- + The names of the custom labels to add to the runner. + **Minimum items**: 1. **Maximum items**: 100. + work_folder: + type: string + description: >- + The working directory to be used for job execution, relative + to the runner install directory. + default: _work + examples: + default: + value: + name: New runner + runner_group_id: 1 + labels: + - self-hosted + - X64 + - macOS + - no-gpu + work_folder: _work + responses: + '201': + $ref: '#/components/responses/actions_runner_jitconfig' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/registration-token: + post: + summary: Create a registration token for a repository + description: >- + Returns a token that you can pass to the `config` script. The token + expires after one hour. + + + For example, you can replace `TOKEN` in the following example with the + registration token provided by this endpoint to configure your + self-hosted runner: + + + ``` + + ./config.sh --url https://github.com/octo-org --token TOKEN + + ``` + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/create-registration-token-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/remove-token: + post: + summary: Create a remove token for a repository + description: >- + Returns a token that you can pass to the `config` script to remove a + self-hosted runner from an repository. The token expires after one hour. + + + For example, you can replace `TOKEN` in the following example with the + registration token provided by this endpoint to remove your self-hosted + runner from an organization: + + + ``` + + ./config.sh remove --token TOKEN + + ``` + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/create-remove-token-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/{runner_id}: + get: + summary: Get a self-hosted runner for a repository + description: >- + Gets a specific self-hosted runner configured in a repository. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Delete a self-hosted runner from a repository + description: >- + Forces the removal of a self-hosted runner from a repository. You can + use this endpoint to completely remove the runner when the machine you + were using no longer exists. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-self-hosted-runner-from-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/{runner_id}/labels: + get: + summary: List labels for a self-hosted runner for a repository + description: >- + Lists all labels for a self-hosted runner configured in a repository. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-labels-for-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + post: + summary: Add custom labels to a self-hosted runner for a repository + description: >- + Adds custom labels to a self-hosted runner configured in a repository. + + + Authenticated users must have admin access to the organization to use + this endpoint. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 1 + maxItems: 100 + description: The names of the custom labels to add to the runner. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + put: + summary: Set custom labels for a self-hosted runner for a repository + description: >- + Remove all previous custom labels and set the new custom labels for a + specific + + self-hosted runner configured in a repository. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 0 + maxItems: 100 + description: >- + The names of the custom labels to set for the runner. You + can pass an empty array to remove all custom labels. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Remove all custom labels from a self-hosted runner for a repository + description: >- + Remove all custom labels from a self-hosted runner configured in a + + repository. Returns the remaining read-only labels from the runner. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels_readonly' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}: + delete: + summary: Remove a custom label from a self-hosted runner for a repository + description: >- + Remove a custom label from a self-hosted runner configured + + in a repository. Returns the remaining labels from the runner. + + + This endpoint returns a `404 Not Found` status if the custom label is + not + + present on the runner. + + + Authenticated users must have admin access to the repository to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + - $ref: '#/components/parameters/runner-label-name' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runs: + get: + summary: List workflow runs for a repository + description: >- + Lists all workflow runs for a repository. You can use parameters to + narrow the list of results. For more information about using parameters, + see + [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + + + This endpoint will return up to 1,000 results for each search when using + the following parameters: `actor`, `branch`, `check_suite_id`, + `created`, `event`, `head_sha`, `status`. + tags: + - actions + operationId: actions/list-workflow-runs-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/actor' + - $ref: '#/components/parameters/workflow-run-branch' + - $ref: '#/components/parameters/event' + - $ref: '#/components/parameters/workflow-run-status' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/created' + - $ref: '#/components/parameters/exclude-pull-requests' + - $ref: '#/components/parameters/workflow-run-check-suite-id' + - $ref: '#/components/parameters/workflow-run-head-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - workflow_runs + properties: + total_count: + type: integer + workflow_runs: + type: array + items: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}: + get: + summary: Get a workflow run + description: >- + Gets a specific workflow run. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/exclude-pull-requests' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + delete: + summary: Delete a workflow run + description: >- + Deletes a specific workflow run. + + + Anyone with write access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + operationId: actions/delete-workflow-run + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/approvals: + get: + summary: Get the review history for a workflow run + description: >- + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-reviews-for-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/environment-approvals' + examples: + default: + $ref: '#/components/examples/environment-approvals-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/approve: + post: + summary: Approve a workflow run for a fork pull request + description: >- + Approves a workflow run for a pull request from a public fork of a first + time contributor. For more information, see ["Approving workflow runs + from public + forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/approve-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts: + get: + summary: List workflow run artifacts + description: >- + Lists artifacts for a workflow run. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-workflow-run-artifacts + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/artifact-name' + - $ref: '#/components/parameters/direction' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - artifacts + properties: + total_count: + type: integer + artifacts: + type: array + items: + $ref: '#/components/schemas/artifact' + examples: + default: + $ref: '#/components/examples/artifact-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}: + get: + summary: Get a workflow run attempt + description: >- + Gets a specific workflow run attempt. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-run-attempt + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/attempt-number' + - $ref: '#/components/parameters/exclude-pull-requests' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs: + get: + summary: List jobs for a workflow run attempt + description: >- + Lists jobs for a specific workflow run attempt. You can use parameters + to narrow the list of results. For more information + + about using parameters, see + [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-jobs-for-workflow-run-attempt + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/attempt-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - jobs + properties: + total_count: + type: integer + jobs: + type: array + items: + $ref: '#/components/schemas/job' + examples: + default: + $ref: '#/components/examples/job-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs: + get: + summary: Download workflow run attempt logs + description: >- + Gets a redirect URL to download an archive of log files for a specific + workflow run attempt. This link expires after + + 1 minute. Look for `Location:` in the response header to find the URL + for the download. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-workflow-run-attempt-logs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/attempt-number' + responses: + '302': + description: Response + headers: + Location: + example: >- + https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/cancel: + post: + summary: Cancel a workflow run + description: >- + Cancels a workflow run using its `id`. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/cancel-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule: + post: + summary: Review custom deployment protection rules for a workflow run + description: >- + Approve or reject custom deployment protection rules provided by a + GitHub App for a workflow run. For more information, see "[Using + environments for + deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + + > [!NOTE] + + > GitHub Apps can only review their own custom deployment protection + rules. To approve or reject pending deployments that are waiting for + review from a specific person or team, see [`POST + /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/review-custom-gates-for-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + environment_name: + type: string + description: The name of the environment to approve or reject. + comment: + type: string + description: >- + Comment associated with the pending deployment protection + rule. **Required when state is not provided.** + state: + type: string + description: >- + Whether to approve or reject deployment to the specified + environments. + enum: + - approved + - rejected + required: + - environment_name + - comment + - state + examples: + default: + value: + environment_name: prod-eus + state: approved + comment: All health checks passed. + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel: + post: + summary: Force cancel a workflow run + description: >- + Cancels a workflow run and bypasses conditions that would otherwise + cause a workflow execution to continue, such as an `always()` condition + on a job. + + You should only use this endpoint to cancel a workflow run when the + workflow run is not responding to [`POST + /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/force-cancel-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/jobs: + get: + summary: List jobs for a workflow run + description: >- + Lists jobs for a workflow run. You can use parameters to narrow the list + of results. For more information + + about using parameters, see + [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-jobs-for-workflow-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - name: filter + description: >- + Filters jobs by their `completed_at` timestamp. `latest` returns + jobs from the most recent execution of the workflow run. `all` + returns all jobs for a workflow run, including from old executions + of the workflow run. + in: query + required: false + schema: + type: string + enum: + - latest + - all + default: latest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - jobs + properties: + total_count: + type: integer + jobs: + type: array + items: + $ref: '#/components/schemas/job' + examples: + default: + $ref: '#/components/examples/job-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/runs/{run_id}/logs: + get: + summary: Download workflow run logs + description: >- + Gets a redirect URL to download an archive of log files for a workflow + run. This link expires after 1 minute. Look for + + `Location:` in the response header to find the URL for the download. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-workflow-run-logs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '302': + description: Response + headers: + Location: + example: >- + https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + delete: + summary: Delete workflow run logs + description: >- + Deletes all logs for a workflow run. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-workflow-run-logs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments: + get: + summary: Get pending deployments for a workflow run + description: >- + Get all deployment environments for a workflow run that are waiting for + protection rules to pass. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-pending-deployments-for-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pending-deployment' + examples: + default: + $ref: '#/components/examples/pending-deployment-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + post: + summary: Review pending deployments for a workflow run + description: >- + Approve or reject pending deployments that are waiting on approval by a + required reviewer. + + + Required reviewers with read access to the repository contents and + deployments can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/review-pending-deployments-for-run + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + environment_ids: + type: array + description: The list of environment ids to approve or reject + example: + - 161171787 + - 161171795 + items: + type: integer + example: 161171787 + state: + type: string + description: >- + Whether to approve or reject deployment to the specified + environments. + enum: + - approved + - rejected + example: approved + comment: + type: string + description: A comment to accompany the deployment review + example: Ship it! + required: + - environment_ids + - state + - comment + examples: + default: + value: + environment_ids: + - 161171787 + state: approved + comment: Ship it! + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deployment' + examples: + default: + $ref: '#/components/examples/deployment-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/rerun: + post: + summary: Re-run a workflow + description: >- + Re-runs your workflow run using its `id`. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/re-run-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + enable_debug_logging: + type: boolean + default: false + description: Whether to enable debug logging for the re-run. + examples: + default: + value: null + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs: + post: + summary: Re-run failed jobs from a workflow run + description: >- + Re-run all of the failed jobs and their dependent jobs in a workflow run + using the `id` of the workflow run. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/re-run-workflow-failed-jobs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + enable_debug_logging: + type: boolean + default: false + description: Whether to enable debug logging for the re-run. + examples: + default: + value: null + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/timing: + get: + summary: Get workflow run usage + description: >- + > [!WARNING] + + > This endpoint is in the process of closing down. Refer to "[Actions + Get workflow usage and Get workflow run usage endpoints closing + down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" + for more information. + + + Gets the number of billable minutes and total run time for a specific + workflow run. Billable minutes only apply to workflows in private + repositories that use GitHub-hosted runners. Usage is listed for each + GitHub-hosted runner operating system in milliseconds. Any job re-runs + are also included in the usage. The usage does not include the + multiplier for macOS and Windows runners and is not rounded up to the + nearest whole minute. For more information, see "[Managing billing for + GitHub + Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-run-usage + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-run-usage' + examples: + default: + $ref: '#/components/examples/workflow-run-usage' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/secrets: + get: + summary: List repository secrets + description: >- + Lists all secrets available in a repository without revealing their + encrypted + + values. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-repository-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/secrets/public-key: + get: + summary: Get a repository public key + description: >- + Gets your public key, which you need to encrypt secrets. You need to + + encrypt a secret before you can create or update secrets. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-repo-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#get-a-repository-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-public-key' + examples: + default: + $ref: '#/components/examples/actions-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/secrets/{secret_name}: + get: + summary: Get a repository secret + description: >- + Gets a single repository secret without revealing its encrypted value. + + + The authenticated user must have collaborator access to the repository + to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update a repository secret + description: >- + Creates or updates a repository secret with an encrypted value. Encrypt + your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get a repository + public + key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete a repository secret + description: >- + Deletes a secret in a repository using the secret name. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#delete-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/variables: + get: + summary: List repository variables + description: >- + Lists all repository variables. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-variables + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#list-repository-variables + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + post: + summary: Create a repository variable + description: >- + Creates a repository variable that you can reference in a GitHub Actions + workflow. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/create-repo-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#create-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + required: + - name + - value + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/variables/{name}: + get: + summary: Get a repository variable + description: >- + Gets a specific variable in a repository. + + + The authenticated user must have collaborator access to the repository + to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/get-repo-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#get-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + patch: + summary: Update a repository variable + description: >- + Updates a repository variable that you can reference in a GitHub Actions + workflow. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/update-repo-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#update-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Delete a repository variable + description: >- + Deletes a repository variable using the variable name. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-repo-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#delete-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/workflows: + get: + summary: List repository workflows + description: >- + Lists the workflows in a repository. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-repo-workflows + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflows#list-repository-workflows + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - workflows + properties: + total_count: + type: integer + workflows: + type: array + items: + $ref: '#/components/schemas/workflow' + examples: + default: + $ref: '#/components/examples/workflow-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}: + get: + summary: Get a workflow + description: >- + Gets a specific workflow. You can replace `workflow_id` with the + workflow + + file name. For example, you could use `main.yaml`. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#get-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow' + examples: + default: + $ref: '#/components/examples/workflow' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable: + put: + summary: Disable a workflow + description: >- + Disables a workflow and sets the `state` of the workflow to + `disabled_manually`. You can replace `workflow_id` with the workflow + file name. For example, you could use `main.yaml`. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/disable-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#disable-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches: + post: + summary: Create a workflow dispatch event + description: >- + You can use this endpoint to manually trigger a GitHub Actions workflow + run. You can replace `workflow_id` with the workflow file name. For + example, you could use `main.yaml`. + + + You must configure your GitHub Actions workflow to run when the + [`workflow_dispatch` + webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) + event occurs. The `inputs` are configured in the workflow file. For more + information about how to configure the `workflow_dispatch` event in the + workflow file, see "[Events that trigger + workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + operationId: actions/create-workflow-dispatch + tags: + - actions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '200': + description: >- + Response including the workflow run ID and URLs when + `return_run_details` parameter is `true`. + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-dispatch-response' + examples: + default: + $ref: '#/components/examples/workflow-dispatch-response' + '204': + description: Empty response when `return_run_details` parameter is `false`. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ref: + type: string + description: >- + The git reference for the workflow. The reference can be a + branch or tag name. + inputs: + type: object + description: >- + Input keys and values configured in the workflow file. The + maximum number of properties is 25. Any default properties + configured in the workflow file will be used when `inputs` + are omitted. + additionalProperties: true + maxProperties: 25 + return_run_details: + type: boolean + description: >- + Whether the response should include the workflow run ID and + URLs. + required: + - ref + examples: + default: + value: + ref: topic-branch + inputs: + name: Mona the Octocat + home: San Francisco, CA + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-github-breaking-changes: + - changeset: change_workflow_dispatch_response_status + patch: + - op: remove + path: /responses/204 + - op: remove + path: >- + /requestBody/content/application~1json/schema/properties/return_run_details + version: '2026-03-10' + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable: + put: + summary: Enable a workflow + description: >- + Enables a workflow and sets the `state` of the workflow to `active`. You + can replace `workflow_id` with the workflow file name. For example, you + could use `main.yaml`. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/enable-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#enable-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs: + get: + summary: List workflow runs for a workflow + description: >- + List all workflow runs for a workflow. You can replace `workflow_id` + with the workflow file name. For example, you could use `main.yaml`. You + can use parameters to narrow the list of results. For more information + about using parameters, see + [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + + Anyone with read access to the repository can use this endpoint + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + + + This endpoint will return up to 1,000 results for each search when using + the following parameters: `actor`, `branch`, `check_suite_id`, + `created`, `event`, `head_sha`, `status`. + tags: + - actions + operationId: actions/list-workflow-runs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + - $ref: '#/components/parameters/actor' + - $ref: '#/components/parameters/workflow-run-branch' + - $ref: '#/components/parameters/event' + - $ref: '#/components/parameters/workflow-run-status' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/created' + - $ref: '#/components/parameters/exclude-pull-requests' + - $ref: '#/components/parameters/workflow-run-check-suite-id' + - $ref: '#/components/parameters/workflow-run-head-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - workflow_runs + properties: + total_count: + type: integer + workflow_runs: + type: array + items: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing: + get: + summary: Get workflow usage + description: >- + > [!WARNING] + + > This endpoint is in the process of closing down. Refer to "[Actions + Get workflow usage and Get workflow run usage endpoints closing + down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" + for more information. + + + Gets the number of billable minutes used by a specific workflow during + the current billing cycle. Billable minutes only apply to workflows in + private repositories that use GitHub-hosted runners. Usage is listed for + each GitHub-hosted runner operating system in milliseconds. Any job + re-runs are also included in the usage. The usage does not include the + multiplier for macOS and Windows runners and is not rounded up to the + nearest whole minute. For more information, see "[Managing billing for + GitHub + Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + + + You can replace `workflow_id` with the workflow file name. For example, + you could use `main.yaml`. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-usage + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#get-workflow-usage + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-usage' + examples: + default: + $ref: '#/components/examples/workflow-usage' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/environments/{environment_name}/secrets: + get: + summary: List environment secrets + description: >- + Lists all secrets available in an environment without revealing their + + encrypted values. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-environment-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key: + get: + summary: Get an environment public key + description: >- + Get the public key for an environment, which you need to encrypt + environment + + secrets. You need to encrypt a secret before you can create or update + secrets. + + + Anyone with read access to the repository can use this endpoint. + + + If the repository is private, OAuth tokens and personal access tokens + (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#get-an-environment-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-public-key' + examples: + default: + $ref: '#/components/examples/actions-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}: + get: + summary: Get an environment secret + description: >- + Gets a single environment secret without revealing its encrypted value. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/get-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update an environment secret + description: >- + Creates or updates an environment secret with an encrypted value. + Encrypt your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-environment-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get an environment + public + key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete an environment secret + description: >- + Deletes a secret in an environment using the secret name. + + + Authenticated users must have collaborator access to a repository to + create, update, or read secrets. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/secrets#delete-an-environment-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Default response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/environments/{environment_name}/variables: + get: + summary: List environment variables + description: >- + Lists all environment variables. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-variables + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#list-environment-variables + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + post: + summary: Create an environment variable + description: >- + Create an environment variable that you can reference in a GitHub + Actions workflow. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/create-environment-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#create-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + required: + - name + - value + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}: + get: + summary: Get an environment variable + description: >- + Gets a specific variable in an environment. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/get-environment-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#get-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/variable-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + patch: + summary: Update an environment variable + description: >- + Updates an environment variable that you can reference in a GitHub + Actions workflow. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - actions + operationId: actions/update-environment-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#update-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Delete an environment variable + description: >- + Deletes an environment variable using the variable name. + + + Authenticated users must have collaborator access to a repository to + create, update, or read variables. + + + OAuth tokens and personal access tokens (classic) need the `repo` scope + to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-variable + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/variables#delete-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + - $ref: '#/components/parameters/environment-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables +components: + schemas: + actions-cache-retention-limit-for-enterprise: + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: >- + For repositories & organizations in an enterprise, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + example: 14 + actions-cache-storage-limit-for-enterprise: + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: >- + For repositories & organizations in an enterprise, the maximum size + limit for the sum of all caches in a repository, in gigabytes. + type: integer + example: 10 + actions-cache-retention-limit-for-organization: + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: >- + For repositories in this organization, the maximum duration, in + days, for which caches in a repository may be retained. + type: integer + example: 14 + actions-cache-storage-limit-for-organization: + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: >- + For repositories in the organization, the maximum size limit for the + sum of all caches in a repository, in gigabytes. + type: integer + example: 10 + actions-cache-usage-org-enterprise: + type: object + properties: + total_active_caches_count: + type: integer + description: >- + The count of active caches across all repositories of an enterprise + or an organization. + total_active_caches_size_in_bytes: + type: integer + description: >- + The total size in bytes of all active cache items across all + repositories of an enterprise or an organization. + required: + - total_active_caches_count + - total_active_caches_size_in_bytes + actions-cache-usage-by-repository: + title: Actions Cache Usage by repository + description: GitHub Actions Cache Usage by repository. + type: object + properties: + full_name: + description: The repository owner and name for the cache usage being shown. + type: string + example: octo-org/Hello-World + active_caches_size_in_bytes: + description: >- + The sum of the size in bytes of all the active cache items in the + repository. + type: integer + example: 2322142 + active_caches_count: + description: The number of active caches in the repository. + type: integer + example: 3 + required: + - full_name + - active_caches_size_in_bytes + - active_caches_count + actions-hosted-runner: + title: GitHub-hosted hosted runner + description: A Github-hosted hosted runner. + type: object + properties: + id: + description: The unique identifier of the hosted runner. + type: integer + example: 5 + name: + description: The name of the hosted runner. + type: string + example: my-github-hosted-runner + runner_group_id: + description: >- + The unique identifier of the group that the hosted runner belongs + to. + type: integer + example: 2 + image_details: + $ref: '#/components/schemas/nullable-actions-hosted-runner-pool-image' + machine_size_details: + $ref: '#/components/schemas/actions-hosted-runner-machine-spec' + status: + description: The status of the runner. + type: string + example: Ready + enum: + - Ready + - Provisioning + - Shutdown + - Deleting + - Stuck + platform: + description: The operating system of the image. + type: string + example: linux-x64 + maximum_runners: + description: >- + The maximum amount of hosted runners. Runners will not scale + automatically above this number. Use this setting to limit your + cost. + type: integer + default: 10 + example: 5 + public_ip_enabled: + description: Whether public IP is enabled for the hosted runners. + type: boolean + example: true + public_ips: + description: >- + The public IP ranges when public IP is enabled for the hosted + runners. + type: array + items: + $ref: '#/components/schemas/public-ip' + last_active_on: + description: The time at which the runner was last used, in ISO 8601 format. + type: string + format: date-time + example: '2022-10-09T23:39:01Z' + nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. + required: + - id + - name + - image_details + - machine_size_details + - status + - public_ip_enabled + - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: >- + The ID of the image. Use this ID for the `image` parameter when + creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + actions-hosted-runner-curated-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: >- + The ID of the image. Use this ID for the `image` parameter when + creating a new larger runner. + type: string + example: ubuntu-20.04 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + required: + - id + - platform + - size_gb + - display_name + - source + actions-hosted-runner-limits: + type: object + properties: + public_ips: + title: Static public IP Limits for GitHub-hosted Hosted Runners. + description: >- + Provides details of static public IP limits for GitHub-hosted Hosted + Runners + type: object + properties: + maximum: + type: integer + description: >- + The maximum number of static public IP addresses that can be + used for Hosted Runners. + example: 50 + current_usage: + type: integer + description: >- + The current number of static public IP addresses in use by + Hosted Runners. + example: 17 + required: + - maximum + - current_usage + required: + - public_ips + actions-hosted-runner-machine-spec: + title: Github-owned VM details. + description: Provides details of a particular machine spec. + type: object + properties: + id: + description: The ID used for the `size` parameter when creating a new runner. + type: string + example: 8-core + cpu_cores: + description: The number of cores. + type: integer + example: 8 + memory_gb: + description: The available RAM for the machine spec. + type: integer + example: 32 + storage_gb: + description: The available SSD storage for the machine spec. + type: integer + example: 300 + required: + - id + - cpu_cores + - memory_gb + - storage_gb + actions-organization-permissions: + type: object + properties: + enabled_repositories: + $ref: '#/components/schemas/enabled-repositories' + selected_repositories_url: + type: string + description: >- + The API URL to use to get or set the selected repositories that are + allowed to run GitHub Actions, when `enabled_repositories` is set to + `selected`. + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + selected_actions_url: + $ref: '#/components/schemas/selected-actions-url' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled_repositories + enabled-repositories: + type: string + description: >- + The policy that controls the repositories in the organization that are + allowed to run GitHub Actions. + enum: + - all + - none + - selected + allowed-actions: + type: string + description: >- + The permissions policy that controls the actions and reusable workflows + that are allowed to run. + enum: + - all + - local_only + - selected + sha-pinning-required: + type: boolean + description: Whether actions must be pinned to a full-length commit SHA. + actions-artifact-and-log-retention-response: + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + actions-artifact-and-log-retention: + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + actions-fork-pr-contributor-approval: + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: >- + The policy that controls when fork PR workflows require approval + from a maintainer. + required: + - approval_policy + actions-fork-pr-workflows-private-repos: + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: >- + Whether workflows triggered by pull requests from forks are allowed + to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: >- + Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull + request. + send_secrets_and_variables: + type: boolean + description: >- + Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: >- + Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. + actions-fork-pr-workflows-private-repos-request: + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: >- + Whether workflows triggered by pull requests from forks are allowed + to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: >- + Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull + request. + send_secrets_and_variables: + type: boolean + description: >- + Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: >- + Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + selected-actions: + type: object + properties: + github_owned_allowed: + type: boolean + description: >- + Whether GitHub-owned actions are allowed. For example, this includes + the actions in the `actions` organization. + verified_allowed: + type: boolean + description: >- + Whether actions from GitHub Marketplace verified creators are + allowed. Set to `true` to allow all actions by GitHub Marketplace + verified creators. + patterns_allowed: + type: array + description: >- + Specifies a list of string-matching patterns to allow specific + action(s) and reusable workflow(s). Wildcards, tags, and SHAs are + allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, + `monalisa/*`. + + + > [!NOTE] + + > The `patterns_allowed` setting only applies to public + repositories. + items: + type: string + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: >- + The policy that controls whether self-hosted runners can be used by + repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: >- + The URL to the endpoint for managing selected repositories for + self-hosted runners in the organization + actions-get-default-workflow-permissions: + type: object + properties: + default_workflow_permissions: + $ref: '#/components/schemas/actions-default-workflow-permissions' + can_approve_pull_request_reviews: + $ref: '#/components/schemas/actions-can-approve-pull-request-reviews' + required: + - default_workflow_permissions + - can_approve_pull_request_reviews + actions-set-default-workflow-permissions: + type: object + properties: + default_workflow_permissions: + $ref: '#/components/schemas/actions-default-workflow-permissions' + can_approve_pull_request_reviews: + $ref: '#/components/schemas/actions-can-approve-pull-request-reviews' + runner-groups-org: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + description: >- + Link to the selected repositories resource for this runner group. + Not present unless visibility was set to `selected` + type: string + runners_url: + type: string + hosted_runners_url: + type: string + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + inherited: + type: boolean + inherited_allows_public_repositories: + type: boolean + allows_public_repositories: + type: boolean + workflow_restrictions_read_only: + description: >- + If `true`, the `restricted_to_workflows` and `selected_workflows` + fields cannot be modified. + type: boolean + default: false + restricted_to_workflows: + description: >- + If `true`, the runner group will be restricted to running only the + workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: >- + List of workflows the runner group should be allowed to run. This + setting will be ignored unless `restricted_to_workflows` is set to + `true`. + type: array + items: + type: string + description: >- + Name of workflow the runner group should be allowed to run. Note + that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + runner: + title: Self hosted runners + description: A self hosted runner + type: object + properties: + id: + description: The ID of the runner. + type: integer + example: 5 + runner_group_id: + description: The ID of the runner group. + type: integer + example: 1 + name: + description: The name of the runner. + type: string + example: iMac + os: + description: The Operating System of the runner. + type: string + example: macos + status: + description: The status of the runner. + type: string + example: online + busy: + type: boolean + labels: + type: array + items: + $ref: '#/components/schemas/runner-label' + ephemeral: + type: boolean + required: + - id + - name + - os + - status + - busy + - labels + runner-application: + title: Runner Application + description: Runner Application + type: object + properties: + os: + type: string + architecture: + type: string + download_url: + type: string + filename: + type: string + temp_download_token: + description: A short lived bearer token used to download the runner, if needed. + type: string + sha256_checksum: + type: string + required: + - os + - architecture + - download_url + - filename + authentication-token: + title: Authentication Token + description: Authentication Token + type: object + properties: + token: + description: The token used for authentication + type: string + example: v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + example: '2016-07-11T22:14:10Z' + permissions: + type: string + example: + issues: read + deployments: write + description: (opaque JSON object) + repositories: + description: The repositories this token has access to + type: array + items: + $ref: '#/components/schemas/repository' + single_file: + type: string + example: config.yaml + nullable: true + repository_selection: + description: >- + Describe whether all repositories have been selected or there's a + selection involved + type: string + enum: + - all + - selected + required: + - token + - expires_at + organization-actions-secret: + title: Actions Secret for an Organization + description: Secrets for GitHub Actions for an organization. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + visibility: + description: Visibility of a secret + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + example: >- + https://api.github.com/organizations/org/secrets/my_secret/repositories + required: + - name + - created_at + - updated_at + - visibility + actions-public-key: + title: ActionsPublicKey + description: The public key used for setting Actions Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + example: 2 + url: + type: string + example: https://api.github.com/user/keys/2 + title: + type: string + example: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + example: '2011-01-26T19:01:12Z' + required: + - key_id + - key + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + organization-actions-variable: + title: Actions Variable for an Organization + description: Organization variable for GitHub Actions. + type: object + properties: + name: + description: The name of the variable. + example: USERNAME + type: string + value: + description: The value of the variable. + example: octocat + type: string + created_at: + description: >- + The date and time at which the variable was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + example: '2019-01-24T22:45:36.000Z' + type: string + format: date-time + updated_at: + description: >- + The date and time at which the variable was last updated, in ISO + 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + example: '2019-01-24T22:45:36.000Z' + type: string + format: date-time + visibility: + description: Visibility of a variable + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + example: >- + https://api.github.com/organizations/org/variables/USERNAME/repositories + required: + - name + - value + - created_at + - updated_at + - visibility + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + example: 5 + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + example: AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + example: 12345 + url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + example: >- + https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip + expired: + description: Whether or not the artifact has expired. + type: boolean + created_at: + type: string + format: date-time + nullable: true + expires_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + digest: + type: string + description: >- + The SHA256 digest of the artifact. This field will only be populated + on artifacts uploaded with upload-artifact v4 or newer. For older + versions, this field will be null. + nullable: true + example: >- + sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + type: object + nullable: true + properties: + id: + example: 10 + type: integer + repository_id: + example: 42 + type: integer + head_repository_id: + example: 42 + type: integer + head_branch: + example: main + type: string + head_sha: + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-retention-limit-for-repository: + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this repository. + type: integer + example: 14 + actions-cache-storage-limit-for-repository: + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, in gigabytes. + type: integer + example: 10 + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + example: 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + example: 2 + ref: + type: string + example: refs/heads/main + key: + type: string + example: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + example: >- + 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + example: 1024 + required: + - total_count + - actions_caches + job: + title: Job + description: Information of a job execution in a workflow run + type: object + properties: + id: + description: The id of the job. + example: 21 + type: integer + run_id: + description: The id of the associated workflow run. + example: 5 + type: integer + run_url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5 + run_attempt: + type: integer + description: >- + Attempt number of the associated workflow run, 1 for first attempt + and higher if the workflow was re-run. + example: 1 + node_id: + type: string + example: MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: string + example: https://github.com/github/hello-world/runs/4 + nullable: true + status: + description: The phase of the lifecycle that the job is currently in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + conclusion: + description: The outcome of the job. + example: success + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + created_at: + description: The time that the job created, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + started_at: + description: The time that the job started, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + completed_at: + description: The time that the job finished, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + name: + description: The name of the job. + example: test-coverage + type: string + steps: + description: Steps in this job. + type: array + items: + type: object + required: + - name + - status + - conclusion + - number + properties: + status: + description: The phase of the lifecycle that the job is currently in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + conclusion: + description: The outcome of the job. + example: success + type: string + nullable: true + name: + description: The name of the job. + example: test-coverage + type: string + number: + type: integer + example: 1 + started_at: + description: The time that the step started, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + completed_at: + description: The time that the job finished, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + check_run_url: + type: string + example: https://api.github.com/repos/github/hello-world/check-runs/4 + labels: + type: array + items: + type: string + description: >- + Labels for the workflow job. Specified by the "runs_on" attribute in + the action's workflow file. + example: + - self-hosted + - foo + - bar + runner_id: + type: integer + nullable: true + example: 1 + description: >- + The ID of the runner to which this job has been assigned. (If a + runner hasn't yet been assigned, this will be null.) + runner_name: + type: string + nullable: true + example: my runner + description: >- + The name of the runner to which this job has been assigned. (If a + runner hasn't yet been assigned, this will be null.) + runner_group_id: + type: integer + nullable: true + example: 2 + description: >- + The ID of the runner group to which this job has been assigned. (If + a runner hasn't yet been assigned, this will be null.) + runner_group_name: + type: string + nullable: true + example: my runner group + description: >- + The name of the runner group to which this job has been assigned. + (If a runner hasn't yet been assigned, this will be null.) + workflow_name: + type: string + description: The name of the workflow. + nullable: true + example: Build + head_branch: + type: string + description: The name of the current branch. + nullable: true + example: main + required: + - id + - node_id + - run_id + - run_url + - head_sha + - workflow_name + - head_branch + - name + - url + - html_url + - status + - conclusion + - started_at + - completed_at + - check_run_url + - labels + - runner_id + - runner_name + - runner_group_id + - runner_group_name + - created_at + oidc-custom-sub-repo: + title: Actions OIDC subject customization for a repository + description: Actions OIDC subject customization for a repository + type: object + properties: + use_default: + description: >- + Whether to use the default template or not. If `true`, the + `include_claim_keys` field is ignored. + type: boolean + include_claim_keys: + description: >- + Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string + required: + - use_default + actions-secret: + title: Actions Secret + description: Set secrets for GitHub Actions. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + actions-variable: + title: Actions Variable + type: object + properties: + name: + description: The name of the variable. + example: USERNAME + type: string + value: + description: The value of the variable. + example: octocat + type: string + created_at: + description: >- + The date and time at which the variable was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + updated_at: + description: >- + The date and time at which the variable was last updated, in ISO + 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + required: + - name + - value + - created_at + - updated_at + actions-repository-permissions: + type: object + properties: + enabled: + $ref: '#/components/schemas/actions-enabled' + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + selected_actions_url: + $ref: '#/components/schemas/selected-actions-url' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled + actions-enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + actions-workflow-access-to-repository: + type: object + properties: + access_level: + type: string + description: >- + Defines the level of access that workflows outside of the repository + have to actions and reusable workflows within the + + repository. + + + `none` means the access is only possible from workflows in this + repository. `user` level access allows sharing across user owned + private repositories only. `organization` level access allows + sharing across the organization. + enum: + - none + - user + - organization + required: + - access_level + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + example: 5 + name: + type: string + description: The name of the workflow run. + nullable: true + example: Build + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + example: 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + example: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: string + nullable: true + example: master + head_sha: + description: >- + The SHA of the head commit that points to the version of the + workflow being run. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + path: + description: The full path of the workflow + example: octocat/octo-repo/.github/workflows/ci.yml@main + type: string + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + example: 106 + run_attempt: + type: integer + description: >- + Attempt number of the run, 1 for first attempt and higher if the + workflow was re-run. + example: 1 + referenced_workflows: + type: array + nullable: true + items: + $ref: '#/components/schemas/referenced-workflow' + event: + type: string + example: push + status: + type: string + nullable: true + example: completed + conclusion: + type: string + nullable: true + example: neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + example: 5 + url: + type: string + description: The URL to the workflow run. + example: https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + example: https://github.com/github/hello-world/suites/4 + pull_requests: + description: >- + Pull requests that are open with a `head_sha` or `head_branch` that + matches the workflow run. The returned pull requests do not + necessarily indicate pull requests that triggered the run. + type: array + nullable: true + items: + $ref: '#/components/schemas/pull-request-minimal' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + actor: + $ref: '#/components/schemas/simple-user' + triggering_actor: + $ref: '#/components/schemas/simple-user' + run_started_at: + type: string + format: date-time + description: The start time of the latest run. Resets on re-run. + jobs_url: + description: The URL to the jobs for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs + logs_url: + description: The URL to download the logs for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs + check_suite_url: + description: The URL to the associated check suite. + type: string + example: https://api.github.com/repos/github/hello-world/check-suites/12 + artifacts_url: + description: The URL to the artifacts for the workflow run. + type: string + example: >- + https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts + cancel_url: + description: The URL to cancel the workflow run. + type: string + example: >- + https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: >- + The URL to the previous attempted run of this workflow, if one + exists. + type: string + example: >- + https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + example: >- + https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + $ref: '#/components/schemas/nullable-simple-commit' + repository: + $ref: '#/components/schemas/minimal-repository' + head_repository: + $ref: '#/components/schemas/minimal-repository' + head_repository_id: + type: integer + example: 5 + display_title: + type: string + example: Simple Workflow + description: >- + The event-specific title associated with the run or the run-name if + set, or the value of `run-name` if it is set in the workflow. + required: + - id + - node_id + - head_branch + - run_number + - display_title + - event + - status + - conclusion + - head_sha + - path + - workflow_id + - url + - html_url + - created_at + - updated_at + - head_commit + - head_repository + - repository + - jobs_url + - logs_url + - check_suite_url + - cancel_url + - rerun_url + - artifacts_url + - workflow_url + - pull_requests + environment-approvals: + title: Environment Approval + description: An entry in the reviews log for environment deployments + type: object + properties: + environments: + description: The list of environments that were approved or rejected + type: array + items: + type: object + properties: + id: + description: The id of the environment. + example: 56780428 + type: integer + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: >- + https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: + description: The time that the environment was created, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + updated_at: + description: >- + The time that the environment was last updated, in ISO 8601 + format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + state: + description: >- + Whether deployment to the environment(s) was approved or rejected or + pending (with comments) + enum: + - approved + - rejected + - pending + example: approved + type: string + user: + $ref: '#/components/schemas/simple-user' + comment: + type: string + description: The comment submitted with the deployment review + example: Ship it! + required: + - environments + - state + - user + - comment + review-custom-gates-comment-required: + type: object + properties: + environment_name: + type: string + description: The name of the environment to approve or reject. + comment: + type: string + description: >- + Comment associated with the pending deployment protection rule. + **Required when state is not provided.** + required: + - environment_name + - comment + review-custom-gates-state-required: + type: object + properties: + environment_name: + type: string + description: The name of the environment to approve or reject. + state: + type: string + description: >- + Whether to approve or reject deployment to the specified + environments. + enum: + - approved + - rejected + comment: + type: string + description: Optional comment to include with the review. + required: + - environment_name + - state + pending-deployment: + title: Pending Deployment + description: Details of a deployment that is waiting for protection rules to pass + type: object + properties: + environment: + type: object + properties: + id: + description: The id of the environment. + type: integer + format: int64 + example: 56780428 + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: >- + https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + example: 30 + wait_timer_started_at: + description: The time that the wait timer began. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + nullable: true + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + example: true + reviewers: + type: array + description: >- + The people or teams that may approve jobs that reference the + environment. You can list up to six users or teams as reviewers. The + reviewers must have at least read access to the repository. Only one + of the required reviewers needs to approve the job for it to + proceed. + items: + type: object + properties: + type: + $ref: '#/components/schemas/deployment-reviewer-type' + reviewer: + anyOf: + - $ref: '#/components/schemas/simple-user' + - $ref: '#/components/schemas/team' + required: + - environment + - wait_timer + - wait_timer_started_at + - current_user_can_approve + - reviewers + deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + example: 42 + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + sha: + type: string + example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + example: topic-branch + type: string + task: + description: Parameter to specify a task to execute + example: deploy + type: string + payload: + type: object + additionalProperties: true + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: >- + Specifies if the given environment is will no longer exist at some + point in the future. Default: false. + example: true + type: boolean + production_environment: + description: >- + Specifies if the given environment is one that end-users directly + interact with. Default: false. + example: true + type: boolean + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow-run-usage: + title: Workflow Run Usage + description: Workflow Run Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + MACOS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + WINDOWS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + run_duration_ms: + type: integer + required: + - billable + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + example: 5 + node_id: + type: string + example: MDg6V29ya2Zsb3cxMg== + name: + type: string + example: CI + path: + type: string + example: ruby.yaml + state: + type: string + example: active + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + created_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + url: + type: string + example: https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + example: >- + https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + workflow-dispatch-response: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + $ref: '#/components/schemas/workflow-run-id' + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url + workflow-usage: + title: Workflow Usage + description: Workflow Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + properties: + total_ms: + type: integer + MACOS: + type: object + properties: + total_ms: + type: integer + WINDOWS: + type: object + properties: + total_ms: + type: integer + required: + - billable + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-actions-hosted-runner-pool-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: >- + The ID of the image. Use this ID for the `image` parameter when + creating a new larger runner. + type: string + example: ubuntu-20.04 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest + required: + - id + - size_gb + - display_name + - source + nullable: true + public-ip: + title: Public IP for a GitHub-hosted larger runners. + description: Provides details of Public IP for a GitHub-hosted larger runners + type: object + properties: + enabled: + description: Whether public IP is enabled. + type: boolean + example: true + prefix: + description: The prefix for the public IP. + type: string + example: 20.80.208.150 + length: + description: The length of the IP prefix. + type: integer + example: 28 + selected-actions-url: + type: string + description: >- + The API URL to use to get or set the actions and reusable workflows that + are allowed to run, when `allowed_actions` is set to `selected`. + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + actions-default-workflow-permissions: + type: string + description: >- + The default workflow permissions granted to the GITHUB_TOKEN when + running workflows. + enum: + - read + - write + actions-can-approve-pull-request-reviews: + type: boolean + description: >- + Whether GitHub Actions can approve pull requests. Enabling this can be a + security risk. + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + runner-label: + title: Self hosted runner label + description: A label for a self hosted runner + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: >- + The type of label. Read-only labels are applied automatically when + the runner is configured. + enum: + - read-only + - custom + required: + - name + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + referenced-workflow: + title: Referenced workflow + description: A workflow referenced/reused by the initial caller workflow + type: object + properties: + path: + type: string + sha: + type: string + ref: + type: string + required: + - path + - sha + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + nullable-simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + timestamp: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + author: + type: object + description: Information about the Git author + properties: + name: + description: Name of the commit's author + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's author + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + committer: + type: object + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's committer + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + required: + - id + - tree_id + - message + - timestamp + - author + - committer + nullable: true + deployment-reviewer-type: + type: string + description: The type of reviewer. + enum: + - User + - Team + example: User + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + workflow-run-id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + actions_runner_jitconfig: + description: Response + content: + application/json: + schema: + type: object + required: + - runner + - encoded_jit_config + properties: + runner: + $ref: '#/components/schemas/runner' + encoded_jit_config: + type: string + description: The base64 encoded runner configuration. + examples: + default: + $ref: '#/components/examples/runner-jitconfig' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + actions_runner_labels: + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - labels + properties: + total_count: + type: integer + labels: + type: array + items: + $ref: '#/components/schemas/runner-label' + examples: + default: + $ref: '#/components/examples/runner-labels' + actions_runner_labels_readonly: + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - labels + properties: + total_count: + type: integer + labels: + type: array + items: + $ref: '#/components/schemas/runner-label' + examples: + default: + $ref: '#/components/examples/runner-labels-readonly' + gone: + description: Gone + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: ^\d+\.\d+\.\d+$ + hosted-runner-id: + name: hosted_runner_id + description: Unique identifier of the GitHub-hosted runner. + in: path + required: true + schema: + type: integer + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + visible-to-repository: + name: visible_to_repository + description: >- + Only return runner groups that are allowed to be used by this + repository. + in: query + required: false + schema: + type: string + runner-group-id: + name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + runner-id: + name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + runner-label-name: + name: name + description: The name of a self-hosted runner's custom label. + in: path + required: true + schema: + type: string + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + variables-per-page: + name: per_page + description: >- + The number of results per page (max 30). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 10 + variable-name: + name: name + description: The name of the variable. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + artifact-name: + name: name + description: >- + The name field of an artifact. When specified, only artifacts with this + name will be returned. + in: query + required: false + schema: + type: string + artifact-id: + name: artifact_id + description: The unique identifier of the artifact. + in: path + required: true + schema: + type: integer + actions-cache-git-ref-full: + name: ref + description: >- + The full Git reference for narrowing down the cache. The `ref` for a + branch should be formatted as `refs/heads/`. To reference a + pull request use `refs/pull//merge`. + in: query + required: false + schema: + type: string + actions-cache-key: + name: key + description: An explicit key or prefix for identifying the cache + in: query + required: false + schema: + type: string + actions-cache-list-sort: + name: sort + description: >- + The property to sort the results by. `created_at` means when the cache + was created. `last_accessed_at` means when the cache was last accessed. + `size_in_bytes` is the size of the cache in bytes. + in: query + required: false + schema: + type: string + enum: + - created_at + - last_accessed_at + - size_in_bytes + default: last_accessed_at + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + actions-cache-key-required: + name: key + description: A key for identifying the cache. + in: query + required: true + schema: + type: string + cache-id: + name: cache_id + description: The unique identifier of the GitHub Actions cache. + in: path + required: true + schema: + type: integer + job-id: + name: job_id + description: The unique identifier of the job. + in: path + required: true + schema: + type: integer + actor: + name: actor + description: >- + Returns someone's workflow runs. Use the login for the user who created + the `push` associated with the check suite or workflow run. + in: query + required: false + schema: + type: string + workflow-run-branch: + name: branch + description: >- + Returns workflow runs associated with a branch. Use the name of the + branch of the `push`. + in: query + required: false + schema: + type: string + event: + name: event + description: >- + Returns workflow run triggered by the event you specify. For example, + `push`, `pull_request` or `issue`. For more information, see "[Events + that trigger + workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." + in: query + required: false + schema: + type: string + workflow-run-status: + name: status + description: >- + Returns workflow runs with the check run `status` or `conclusion` that + you specify. For example, a conclusion can be `success` or a status can + be `in_progress`. Only GitHub Actions can set a status of `waiting`, + `pending`, or `requested`. + in: query + required: false + schema: + type: string + enum: + - completed + - action_required + - cancelled + - failure + - neutral + - skipped + - stale + - success + - timed_out + - in_progress + - queued + - requested + - waiting + - pending + created: + name: created + description: >- + Returns workflow runs created within the given date-time range. For more + information on the syntax, see "[Understanding the search + syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + in: query + required: false + schema: + type: string + format: date-time + exclude-pull-requests: + name: exclude_pull_requests + description: If `true` pull requests are omitted from the response (empty array). + in: query + required: false + schema: + type: boolean + default: false + workflow-run-check-suite-id: + name: check_suite_id + description: Returns workflow runs with the `check_suite_id` that you specify. + in: query + schema: + type: integer + workflow-run-head-sha: + name: head_sha + description: >- + Only returns workflow runs that are associated with the specified + `head_sha`. + in: query + required: false + schema: + type: string + run-id: + name: run_id + description: The unique identifier of the workflow run. + in: path + required: true + schema: + type: integer + attempt-number: + name: attempt_number + description: The attempt number of the workflow run. + in: path + required: true + schema: + type: integer + workflow-id: + name: workflow_id + in: path + description: >- + The ID of the workflow. You can also pass the workflow file name as a + string. + required: true + schema: + oneOf: + - type: integer + - type: string + environment-name: + name: environment_name + in: path + required: true + description: >- + The name of the environment. The name must be URL encoded. For example, + any slashes in the name must be replaced with `%2F`. + schema: + type: string + examples: + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 + actions-cache-usage-org-enterprise: + value: + total_active_caches_size_in_bytes: 3344284 + total_active_caches_count: 5 + org-actions-cache-usage-by-repo: + value: + total_count: 2 + repository_cache_usages: + - full_name: octo-org/Hello-World + active_caches_size_in_bytes: 2322142 + active_caches_count: 3 + - full_name: octo-org/server + active_caches_size_in_bytes: 1022142 + active_caches_count: 2 + actions-hosted-runner-paginated: + value: + total_count: 2 + runners: + - id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + - id: 7 + name: My hosted Windows runner + runner_group_id: 2 + platform: win-x64 + image: + id: windows-latest + size: 256 + machine_size_details: + id: 8-core + cpu_cores: 8 + memory_gb: 32 + storage_gb: 300 + status: Ready + maximum_runners: 20 + public_ip_enabled: false + public_ips: [] + last_active_on: '2023-04-26T15:23:37Z' + actions-hosted-runner: + value: + id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-curated-image: + value: + id: ubuntu-20.04 + platform: linux-x64 + size_gb: 86 + display_name: '20.04' + source: github + actions-hosted-runner-limits-default: + value: + public_ips: + current_usage: 17 + maximum: 50 + actions-hosted-runner-machine-spec: + value: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + actions-organization-permissions: + value: + enabled_repositories: all + allowed_actions: selected + selected_actions_url: >- + https://api.github.com/organizations/42/actions/permissions/selected-actions + sha_pinning_required: true + actions-fork-pr-contributor-approval: + value: + approval_policy: first_time_contributors + actions-fork-pr-workflows-private-repos: + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + selected-actions: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + actions-default-workflow-permissions: + summary: Give read-only permission, and allow approving PRs. + value: + default_workflow_permissions: read + can_approve_pull_request_reviews: true + runner-groups-org: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: true + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: true + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-item: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: >- + https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: null + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 + runner-paginated: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + ephemeral: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only + - id: 24 + name: mac_runner + os: macos + status: offline + busy: false + ephemeral: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + runner-application-items: + value: + - os: osx + architecture: x64 + download_url: >- + https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz + filename: actions-runner-osx-x64-2.164.0.tar.gz + - os: linux + architecture: x64 + download_url: >- + https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz + filename: actions-runner-linux-x64-2.164.0.tar.gz + - os: linux + architecture: arm + download_url: >- + https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz + filename: actions-runner-linux-arm-2.164.0.tar.gz + - os: win + architecture: x64 + download_url: >- + https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip + filename: actions-runner-win-x64-2.164.0.zip + - os: linux + architecture: arm64 + download_url: >- + https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz + filename: actions-runner-linux-arm64-2.164.0.tar.gz + authentication-token: + value: + token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 + expires_at: '2020-01-22T12:13:35.123-08:00' + authentication-token-2: + value: + token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 + expires_at: '2020-01-29T12:13:35.123-08:00' + runner: + value: + id: 23 + name: MBP + os: macos + status: online + busy: true + ephemeral: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + organization-actions-secret-paginated: + value: + total_count: 3 + secrets: + - name: GIST_ID + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: private + - name: DEPLOY_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories + actions-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + organization-actions-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + organization-actions-variables-paginated: + value: + total_count: 3 + variables: + - name: USERNAME + value: octocat + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: private + - name: ACTIONS_RUNNER_DEBUG + value: true + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + - name: ADMIN_EMAIL + value: octocat@github.com + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories + organization-actions-variable: + value: + name: USERNAME + value: octocat + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories + artifact-paginated: + value: + total_count: 2 + artifacts: + - id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: >- + https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: >- + https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + digest: >- + sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + - id: 13 + node_id: MDg6QXJ0aWZhY3QxMw== + name: Test output + size_in_bytes: 453 + url: >- + https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 + archive_download_url: >- + https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + digest: >- + sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + id: 2332942 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 + artifact: + value: + id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: >- + https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-01-21T14:59:22Z' + updated_at: '2020-01-21T14:59:22Z' + digest: >- + sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + actions-cache-usage: + value: + full_name: octo-org/Hello-World + active_caches_size_in_bytes: 2322142 + active_caches_count: 3 + actions-cache-list: + value: + total_count: 1 + actions_caches: + - id: 505 + ref: refs/heads/main + key: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: '2019-01-24T22:45:36.000Z' + created_at: '2019-01-24T22:45:36.000Z' + size_in_bytes: 1024 + job: + value: + id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + workflow_name: CI + head_branch: main + oidc-custom-sub-repo: + value: + use_default: false + include_claim_keys: + - repo + - context + actions-secret-paginated: + value: + total_count: 2 + secrets: + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: GIST_ID + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + actions-variables-paginated: + value: + total_count: 2 + variables: + - name: USERNAME + value: octocat + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: EMAIL + value: octocat@github.com + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + actions-repository-permissions: + value: + enabled: true + allowed_actions: selected + selected_actions_url: >- + https://api.github.com/repositories/42/actions/permissions/selected-actions + sha_pinning_required: true + actions-workflow-access-to-repository: + value: + access_level: organization + workflow-run-paginated: + value: + total_count: 1 + workflow_runs: + - id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: master + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: .github/workflows/build.yml@main + run_number: 562 + event: push + display_title: Update README.md + status: queued + conclusion: null + workflow_id: 159038 + url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: >- + https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + workflow_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: >- + https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: >- + https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: >- + https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: >- + https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: >- + https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: >- + https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: >- + https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + workflow-run: + value: + id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: main + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: .github/workflows/build.yml@main + run_number: 562 + event: push + display_title: Update README.md + status: queued + conclusion: null + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + referenced_workflows: + - path: octocat/Hello-World/.github/workflows/deploy.yml@main + sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db + ref: refs/heads/main + - path: octo-org/octo-repo/.github/workflows/report.yml@v2 + sha: 79e9790903e1c3373b1a3e3a941d57405478a232 + ref: refs/tags/v2 + - path: >- + octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e + sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + previous_attempt_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 + workflow_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: >- + https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: >- + https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: >- + https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + environment-approvals-items: + value: + - state: approved + comment: Ship it! + environments: + - id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: >- + https://api.github.com/repos/github/hello-world/environments/staging + html_url: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + job-paginated: + value: + total_count: 1 + jobs: + - id: 399444496 + run_id: 29679449 + run_url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: >- + https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + workflow_name: CI + head_branch: main + pending-deployment-items: + value: + - environment: + id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: >- + https://api.github.com/repos/github/hello-world/environments/staging + html_url: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: 30 + wait_timer_started_at: '2020-11-23T22:00:40Z' + current_user_can_approve: true + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + deployment-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + workflow-run-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + jobs: 1 + job_runs: + - job_id: 1 + duration_ms: 180000 + MACOS: + total_ms: 240000 + jobs: 4 + job_runs: + - job_id: 2 + duration_ms: 60000 + - job_id: 3 + duration_ms: 60000 + - job_id: 4 + duration_ms: 60000 + - job_id: 5 + duration_ms: 60000 + WINDOWS: + total_ms: 300000 + jobs: 2 + job_runs: + - job_id: 6 + duration_ms: 150000 + - job_id: 7 + duration_ms: 150000 + run_duration_ms: 500000 + actions-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + actions-variable: + value: + name: USERNAME + value: octocat + created_at: '2021-08-10T14:59:22Z' + updated_at: '2022-01-10T14:59:22Z' + workflow-paginated: + value: + total_count: 2 + workflows: + - id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: .github/workflows/blank.yaml + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: >- + https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + - id: 269289 + node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== + name: Linter + path: .github/workflows/linter.yaml + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289 + html_url: >- + https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 + badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg + workflow: + value: + id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: .github/workflows/blank.yaml + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: >- + https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: >- + https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + workflow-dispatch-response: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 + workflow-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + MACOS: + total_ms: 240000 + WINDOWS: + total_ms: 300000 + runner-jitconfig: + value: + runner: + id: 23 + name: New runner + os: unknown + status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + encoded_jit_config: abc123 + runner-labels: + value: + total_count: 4 + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + runner-labels-readonly: + value: + total_count: 3 + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + location: + example: >- + https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D + schema: + type: string + x-stackQL-resources: + cache_retention_limit: + id: github.actions.cache_retention_limit + name: cache_retention_limit + title: Cache Retention Limit + methods: + get_actions_cache_retention_limit_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1cache~1retention-limit/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_actions_cache_retention_limit_for_enterprise: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1cache~1retention-limit/put + response: + mediaType: application/json + openAPIDocKey: '204' + get_actions_cache_retention_limit_for_organization: + operation: + $ref: >- + #/paths/~1organizations~1{org}~1actions~1cache~1retention-limit/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_actions_cache_retention_limit_for_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1organizations~1{org}~1actions~1cache~1retention-limit/put + response: + mediaType: application/json + openAPIDocKey: '204' + get_actions_cache_retention_limit_for_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1cache~1retention-limit/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_actions_cache_retention_limit_for_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1cache~1retention-limit/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cache_retention_limit/methods/get_actions_cache_retention_limit_for_repository + - $ref: >- + #/components/x-stackQL-resources/cache_retention_limit/methods/get_actions_cache_retention_limit_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/cache_retention_limit/methods/get_actions_cache_retention_limit_for_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/cache_retention_limit/methods/set_actions_cache_retention_limit_for_repository + - $ref: >- + #/components/x-stackQL-resources/cache_retention_limit/methods/set_actions_cache_retention_limit_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/cache_retention_limit/methods/set_actions_cache_retention_limit_for_organization + cache_storage_limit: + id: github.actions.cache_storage_limit + name: cache_storage_limit + title: Cache Storage Limit + methods: + get_actions_cache_storage_limit_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1cache~1storage-limit/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_actions_cache_storage_limit_for_enterprise: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1cache~1storage-limit/put + response: + mediaType: application/json + openAPIDocKey: '204' + get_actions_cache_storage_limit_for_organization: + operation: + $ref: '#/paths/~1organizations~1{org}~1actions~1cache~1storage-limit/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_actions_cache_storage_limit_for_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1organizations~1{org}~1actions~1cache~1storage-limit/put' + response: + mediaType: application/json + openAPIDocKey: '204' + get_actions_cache_storage_limit_for_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1cache~1storage-limit/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_actions_cache_storage_limit_for_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1cache~1storage-limit/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cache_storage_limit/methods/get_actions_cache_storage_limit_for_repository + - $ref: >- + #/components/x-stackQL-resources/cache_storage_limit/methods/get_actions_cache_storage_limit_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/cache_storage_limit/methods/get_actions_cache_storage_limit_for_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/cache_storage_limit/methods/set_actions_cache_storage_limit_for_repository + - $ref: >- + #/components/x-stackQL-resources/cache_storage_limit/methods/set_actions_cache_storage_limit_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/cache_storage_limit/methods/set_actions_cache_storage_limit_for_organization + cache_usage: + id: github.actions.cache_usage + name: cache_usage + title: Cache Usage + methods: + get_actions_cache_usage_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1cache~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_actions_cache_usage: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1cache~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cache_usage/methods/get_actions_cache_usage + - $ref: >- + #/components/x-stackQL-resources/cache_usage/methods/get_actions_cache_usage_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_cache_usage: + id: github.actions.org_cache_usage + name: org_cache_usage + title: Org Cache Usage + methods: + get_actions_cache_usage_by_repo_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1cache~1usage-by-repository/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_cache_usage/methods/get_actions_cache_usage_by_repo_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_hosted_runners: + id: github.actions.org_hosted_runners + name: org_hosted_runners + title: Org Hosted Runners + methods: + list_hosted_runners_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1hosted-runners/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_hosted_runner_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1hosted-runners/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_hosted_runner_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1{hosted_runner_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_hosted_runner_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1{hosted_runner_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_hosted_runner_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1{hosted_runner_id}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runners/methods/get_hosted_runner_for_org + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runners/methods/list_hosted_runners_for_org + insert: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runners/methods/create_hosted_runner_for_org + update: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runners/methods/update_hosted_runner_for_org + delete: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runners/methods/delete_hosted_runner_for_org + replace: [] + org_hosted_runner_custom_images: + id: github.actions.org_hosted_runner_custom_images + name: org_hosted_runner_custom_images + title: Org Hosted Runner Custom Images + methods: + list_custom_images_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1custom/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_custom_image_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1custom~1{image_definition_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_custom_image_from_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1custom~1{image_definition_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_custom_images/methods/get_custom_image_for_org + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_custom_images/methods/list_custom_images_for_org + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_custom_images/methods/delete_custom_image_from_org + replace: [] + org_hosted_runner_custom_image_versions: + id: github.actions.org_hosted_runner_custom_image_versions + name: org_hosted_runner_custom_image_versions + title: Org Hosted Runner Custom Image Versions + methods: + list_custom_image_versions_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1custom~1{image_definition_id}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_custom_image_version_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1custom~1{image_definition_id}~1versions~1{version}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_custom_image_version_from_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1custom~1{image_definition_id}~1versions~1{version}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_custom_image_versions/methods/get_custom_image_version_for_org + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_custom_image_versions/methods/list_custom_image_versions_for_org + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_custom_image_versions/methods/delete_custom_image_version_from_org + replace: [] + org_hosted_runner_github_images: + id: github.actions.org_hosted_runner_github_images + name: org_hosted_runner_github_images + title: Org Hosted Runner Github Images + methods: + get_hosted_runners_github_owned_images_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1github-owned/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_github_images/methods/get_hosted_runners_github_owned_images_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_hosted_runner_partner_images: + id: github.actions.org_hosted_runner_partner_images + name: org_hosted_runner_partner_images + title: Org Hosted Runner Partner Images + methods: + get_hosted_runners_partner_images_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1hosted-runners~1images~1partner/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_partner_images/methods/get_hosted_runners_partner_images_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_hosted_runner_limits: + id: github.actions.org_hosted_runner_limits + name: org_hosted_runner_limits + title: Org Hosted Runner Limits + methods: + get_hosted_runners_limits_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1hosted-runners~1limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.public_ips + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_limits/methods/get_hosted_runners_limits_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_hosted_runner_machine_specs: + id: github.actions.org_hosted_runner_machine_specs + name: org_hosted_runner_machine_specs + title: Org Hosted Runner Machine Specs + methods: + get_hosted_runners_machine_specs_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1hosted-runners~1machine-sizes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_machine_specs/methods/get_hosted_runners_machine_specs_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_hosted_runner_platforms: + id: github.actions.org_hosted_runner_platforms + name: org_hosted_runner_platforms + title: Org Hosted Runner Platforms + methods: + get_hosted_runners_platforms_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1hosted-runners~1platforms/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_hosted_runner_platforms/methods/get_hosted_runners_platforms_for_org + insert: [] + update: [] + delete: [] + replace: [] + permissions: + id: github.actions.permissions + name: permissions + title: Permissions + methods: + get_github_actions_permissions_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_github_actions_permissions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions/put' + response: + mediaType: application/json + openAPIDocKey: '204' + get_github_actions_permissions_repository: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_github_actions_permissions_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1permissions/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/get_github_actions_permissions_repository + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/get_github_actions_permissions_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/set_github_actions_permissions_repository + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/set_github_actions_permissions_organization + artifact_log_retention: + id: github.actions.artifact_log_retention + name: artifact_log_retention + title: Artifact Log Retention + methods: + get_artifact_and_log_retention_settings_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1artifact-and-log-retention/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_artifact_and_log_retention_settings_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1artifact-and-log-retention/put + response: + mediaType: application/json + openAPIDocKey: '204' + get_artifact_and_log_retention_settings_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1artifact-and-log-retention/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_artifact_and_log_retention_settings_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1artifact-and-log-retention/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/artifact_log_retention/methods/get_artifact_and_log_retention_settings_repository + - $ref: >- + #/components/x-stackQL-resources/artifact_log_retention/methods/get_artifact_and_log_retention_settings_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/artifact_log_retention/methods/set_artifact_and_log_retention_settings_repository + - $ref: >- + #/components/x-stackQL-resources/artifact_log_retention/methods/set_artifact_and_log_retention_settings_organization + org_fork_pr_contributor_approval_permissions: + id: github.actions.org_fork_pr_contributor_approval_permissions + name: org_fork_pr_contributor_approval_permissions + title: Org Fork Pr Contributor Approval Permissions + methods: + get_fork_pr_contributor_approval_permissions_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1fork-pr-contributor-approval/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_fork_pr_contributor_approval_permissions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1fork-pr-contributor-approval/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_fork_pr_contributor_approval_permissions/methods/get_fork_pr_contributor_approval_permissions_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/org_fork_pr_contributor_approval_permissions/methods/set_fork_pr_contributor_approval_permissions_organization + org_fork_pr_workflows_private_repos_settings: + id: github.actions.org_fork_pr_workflows_private_repos_settings + name: org_fork_pr_workflows_private_repos_settings + title: Org Fork Pr Workflows Private Repos Settings + methods: + get_private_repo_fork_pr_workflows_settings_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1fork-pr-workflows-private-repos/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_private_repo_fork_pr_workflows_settings_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1fork-pr-workflows-private-repos/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_fork_pr_workflows_private_repos_settings/methods/get_private_repo_fork_pr_workflows_settings_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/org_fork_pr_workflows_private_repos_settings/methods/set_private_repo_fork_pr_workflows_settings_organization + enabled_repos: + id: github.actions.enabled_repos + name: enabled_repos + title: Enabled Repos + methods: + list_selected_repositories_enabled_github_actions_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_selected_repositories_enabled_github_actions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions~1repositories/put' + response: + mediaType: application/json + openAPIDocKey: '204' + enable_selected_repository_github_actions_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + disable_selected_repository_github_actions_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/enabled_repos/methods/list_selected_repositories_enabled_github_actions_organization + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/enabled_repos/methods/disable_selected_repository_github_actions_organization + replace: + - $ref: >- + #/components/x-stackQL-resources/enabled_repos/methods/enable_selected_repository_github_actions_organization + - $ref: >- + #/components/x-stackQL-resources/enabled_repos/methods/set_selected_repositories_enabled_github_actions_organization + allowed_actions: + id: github.actions.allowed_actions + name: allowed_actions + title: Allowed Actions + methods: + get_allowed_actions_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions~1selected-actions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_allowed_actions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions~1selected-actions/put' + response: + mediaType: application/json + openAPIDocKey: '204' + get_allowed_actions_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1selected-actions/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_allowed_actions_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1selected-actions/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/allowed_actions/methods/get_allowed_actions_repository + - $ref: >- + #/components/x-stackQL-resources/allowed_actions/methods/get_allowed_actions_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/allowed_actions/methods/set_allowed_actions_repository + - $ref: >- + #/components/x-stackQL-resources/allowed_actions/methods/set_allowed_actions_organization + org_self_hosted_runners_permissions: + id: github.actions.org_self_hosted_runners_permissions + name: org_self_hosted_runners_permissions + title: Org Self Hosted Runners Permissions + methods: + get_self_hosted_runners_permissions_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1self-hosted-runners/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_self_hosted_runners_permissions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1self-hosted-runners/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_self_hosted_runners_permissions/methods/get_self_hosted_runners_permissions_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/org_self_hosted_runners_permissions/methods/set_self_hosted_runners_permissions_organization + org_self_hosted_runner_repo_access: + id: github.actions.org_self_hosted_runner_repo_access + name: org_self_hosted_runner_repo_access + title: Org Self Hosted Runner Repo Access + methods: + list_selected_repositories_self_hosted_runners_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1self-hosted-runners~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_selected_repositories_self_hosted_runners_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1self-hosted-runners~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + enable_selected_repository_self_hosted_runners_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1self-hosted-runners~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + disable_selected_repository_self_hosted_runners_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1permissions~1self-hosted-runners~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_self_hosted_runner_repo_access/methods/list_selected_repositories_self_hosted_runners_organization + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_self_hosted_runner_repo_access/methods/disable_selected_repository_self_hosted_runners_organization + replace: + - $ref: >- + #/components/x-stackQL-resources/org_self_hosted_runner_repo_access/methods/enable_selected_repository_self_hosted_runners_organization + - $ref: >- + #/components/x-stackQL-resources/org_self_hosted_runner_repo_access/methods/set_selected_repositories_self_hosted_runners_organization + default_workflow_permissions: + id: github.actions.default_workflow_permissions + name: default_workflow_permissions + title: Default Workflow Permissions + methods: + get_github_actions_default_workflow_permissions_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions~1workflow/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_github_actions_default_workflow_permissions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1permissions~1workflow/put' + response: + mediaType: application/json + openAPIDocKey: '204' + get_github_actions_default_workflow_permissions_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1workflow/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_github_actions_default_workflow_permissions_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1workflow/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/default_workflow_permissions/methods/get_github_actions_default_workflow_permissions_repository + - $ref: >- + #/components/x-stackQL-resources/default_workflow_permissions/methods/get_github_actions_default_workflow_permissions_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/default_workflow_permissions/methods/set_github_actions_default_workflow_permissions_repository + - $ref: >- + #/components/x-stackQL-resources/default_workflow_permissions/methods/set_github_actions_default_workflow_permissions_organization + org_runner_groups: + id: github.actions.org_runner_groups + name: org_runner_groups + title: Org Runner Groups + methods: + list_self_hosted_runner_groups_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runner-groups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_self_hosted_runner_group_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runner-groups/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_self_hosted_runner_group_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_self_hosted_runner_group_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_self_hosted_runner_group_from_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_runner_groups/methods/get_self_hosted_runner_group_for_org + - $ref: >- + #/components/x-stackQL-resources/org_runner_groups/methods/list_self_hosted_runner_groups_for_org + insert: + - $ref: >- + #/components/x-stackQL-resources/org_runner_groups/methods/create_self_hosted_runner_group_for_org + update: + - $ref: >- + #/components/x-stackQL-resources/org_runner_groups/methods/update_self_hosted_runner_group_for_org + delete: + - $ref: >- + #/components/x-stackQL-resources/org_runner_groups/methods/delete_self_hosted_runner_group_from_org + replace: [] + org_runner_group_hosted_runners: + id: github.actions.org_runner_group_hosted_runners + name: org_runner_group_hosted_runners + title: Org Runner Group Hosted Runners + methods: + list_github_hosted_runners_in_group_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1hosted-runners/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_hosted_runners/methods/list_github_hosted_runners_in_group_for_org + insert: [] + update: [] + delete: [] + replace: [] + org_runner_group_repos: + id: github.actions.org_runner_group_repos + name: org_runner_group_repos + title: Org Runner Group Repos + methods: + list_repo_access_to_self_hosted_runner_group_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_repo_access_to_self_hosted_runner_group_in_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_repo_access_to_self_hosted_runner_group_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_repo_access_to_self_hosted_runner_group_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_repos/methods/list_repo_access_to_self_hosted_runner_group_in_org + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_repos/methods/remove_repo_access_to_self_hosted_runner_group_in_org + replace: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_repos/methods/add_repo_access_to_self_hosted_runner_group_in_org + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_repos/methods/set_repo_access_to_self_hosted_runner_group_in_org + org_runner_group_runners: + id: github.actions.org_runner_group_runners + name: org_runner_group_runners + title: Org Runner Group Runners + methods: + list_self_hosted_runners_in_group_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1runners/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_self_hosted_runners_in_group_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1runners/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_self_hosted_runner_to_group_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1runners~1{runner_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_self_hosted_runner_from_group_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runner-groups~1{runner_group_id}~1runners~1{runner_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_runners/methods/list_self_hosted_runners_in_group_for_org + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_runners/methods/remove_self_hosted_runner_from_group_for_org + replace: + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_runners/methods/add_self_hosted_runner_to_group_for_org + - $ref: >- + #/components/x-stackQL-resources/org_runner_group_runners/methods/set_self_hosted_runners_in_group_for_org + self_hosted_runners: + id: github.actions.self_hosted_runners + name: self_hosted_runners + title: Self Hosted Runners + methods: + list_self_hosted_runners_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_self_hosted_runner_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_self_hosted_runner_from_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_self_hosted_runners_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1runners/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_self_hosted_runner_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_self_hosted_runner_from_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/self_hosted_runners/methods/get_self_hosted_runner_for_repo + - $ref: >- + #/components/x-stackQL-resources/self_hosted_runners/methods/get_self_hosted_runner_for_org + - $ref: >- + #/components/x-stackQL-resources/self_hosted_runners/methods/list_self_hosted_runners_for_repo + - $ref: >- + #/components/x-stackQL-resources/self_hosted_runners/methods/list_self_hosted_runners_for_org + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/self_hosted_runners/methods/delete_self_hosted_runner_from_repo + - $ref: >- + #/components/x-stackQL-resources/self_hosted_runners/methods/delete_self_hosted_runner_from_org + replace: [] + runner_applications: + id: github.actions.runner_applications + name: runner_applications + title: Runner Applications + methods: + list_runner_applications_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1downloads/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_runner_applications_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1downloads/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runner_applications/methods/list_runner_applications_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_applications/methods/list_runner_applications_for_org + insert: [] + update: [] + delete: [] + replace: [] + runner_jit_configs: + id: github.actions.runner_jit_configs + name: runner_jit_configs + title: Runner Jit Configs + methods: + generate_runner_jitconfig_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1generate-jitconfig/post' + response: + mediaType: application/json + openAPIDocKey: '201' + generate_runner_jitconfig_for_repo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1generate-jitconfig/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/runner_jit_configs/methods/generate_runner_jitconfig_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_jit_configs/methods/generate_runner_jitconfig_for_org + update: [] + delete: [] + replace: [] + runner_registration_tokens: + id: github.actions.runner_registration_tokens + name: runner_registration_tokens + title: Runner Registration Tokens + methods: + create_registration_token_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1registration-token/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_registration_token_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1registration-token/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/runner_registration_tokens/methods/create_registration_token_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_registration_tokens/methods/create_registration_token_for_org + update: [] + delete: [] + replace: [] + runner_remove_tokens: + id: github.actions.runner_remove_tokens + name: runner_remove_tokens + title: Runner Remove Tokens + methods: + create_remove_token_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1remove-token/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_remove_token_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1remove-token/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/runner_remove_tokens/methods/create_remove_token_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_remove_tokens/methods/create_remove_token_for_org + update: [] + delete: [] + replace: [] + runner_labels: + id: github.actions.runner_labels + name: runner_labels + title: Runner Labels + methods: + list_labels_for_self_hosted_runner_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_custom_labels_to_self_hosted_runner_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '200' + set_custom_labels_for_self_hosted_runner_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}~1labels/put' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_all_custom_labels_from_self_hosted_runner_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}~1labels/delete + response: + mediaType: application/json + openAPIDocKey: '200' + remove_custom_label_from_self_hosted_runner_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}~1labels~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list_labels_for_self_hosted_runner_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}~1labels/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_custom_labels_to_self_hosted_runner_for_repo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}~1labels/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_custom_labels_for_self_hosted_runner_for_repo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}~1labels/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_all_custom_labels_from_self_hosted_runner_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}~1labels/delete + response: + mediaType: application/json + openAPIDocKey: '200' + remove_custom_label_from_self_hosted_runner_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runners~1{runner_id}~1labels~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/list_labels_for_self_hosted_runner_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/list_labels_for_self_hosted_runner_for_org + insert: + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/add_custom_labels_to_self_hosted_runner_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/add_custom_labels_to_self_hosted_runner_for_org + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/remove_custom_label_from_self_hosted_runner_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/remove_custom_label_from_self_hosted_runner_for_org + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/remove_all_custom_labels_from_self_hosted_runner_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/remove_all_custom_labels_from_self_hosted_runner_for_org + replace: + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/set_custom_labels_for_self_hosted_runner_for_repo + - $ref: >- + #/components/x-stackQL-resources/runner_labels/methods/set_custom_labels_for_self_hosted_runner_for_org + secrets: + id: github.actions.secrets + name: secrets + title: Secrets + methods: + list_org_secrets: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_secret: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_org_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}/put' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_org_secret: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_repo_secrets: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1secrets~1{secret_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_repo_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1secrets~1{secret_name}/put + response: + mediaType: application/json + openAPIDocKey: '201' + delete_repo_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1secrets~1{secret_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_environment_secrets: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1secrets/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_environment_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1secrets~1{secret_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_environment_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1secrets~1{secret_name}/put + response: + mediaType: application/json + openAPIDocKey: '201' + delete_environment_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1secrets~1{secret_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/get_environment_secret + - $ref: '#/components/x-stackQL-resources/secrets/methods/get_repo_secret' + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/list_environment_secrets + - $ref: '#/components/x-stackQL-resources/secrets/methods/get_org_secret' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list_repo_secrets' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list_org_secrets' + insert: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/create_or_update_environment_secret + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/create_or_update_repo_secret + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/create_or_update_org_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/delete_environment_secret + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/delete_repo_secret + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete_org_secret' + replace: [] + public_keys: + id: github.actions.public_keys + name: public_keys + title: Public Keys + methods: + get_org_public_key: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1secrets~1public-key/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_public_key: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1secrets~1public-key/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_environment_public_key: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1secrets~1public-key/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_environment_public_key + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_repo_public_key + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_org_public_key + insert: [] + update: [] + delete: [] + replace: [] + repos_for_secret: + id: github.actions.repos_for_secret + name: repos_for_secret + title: Repos For Secret + methods: + list_selected_repos_for_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_selected_repos_for_org_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_selected_repo_to_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_selected_repo_from_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/list_selected_repos_for_org_secret + insert: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/add_selected_repo_to_org_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/remove_selected_repo_from_org_secret + replace: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/set_selected_repos_for_org_secret + variables: + id: github.actions.variables + name: variables + title: Variables + methods: + list_org_variables: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1variables/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_org_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1variables/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_org_variable: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1variables~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_org_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1variables~1{name}/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + delete_org_variable: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1variables~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_repo_variables: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1variables/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_repo_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1variables/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_repo_variable: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1variables~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_repo_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1variables~1{name}/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + delete_repo_variable: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1variables~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_environment_variables: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1variables/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_environment_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1variables/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_environment_variable: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1variables~1{name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_environment_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1variables~1{name}/patch + response: + mediaType: application/json + openAPIDocKey: '204' + delete_environment_variable: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1variables~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/variables/methods/get_environment_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/get_repo_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/list_environment_variables + - $ref: >- + #/components/x-stackQL-resources/variables/methods/get_org_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/list_repo_variables + - $ref: >- + #/components/x-stackQL-resources/variables/methods/list_org_variables + insert: + - $ref: >- + #/components/x-stackQL-resources/variables/methods/create_environment_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/create_repo_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/create_org_variable + update: + - $ref: >- + #/components/x-stackQL-resources/variables/methods/update_environment_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/update_repo_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/update_org_variable + delete: + - $ref: >- + #/components/x-stackQL-resources/variables/methods/delete_environment_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/delete_repo_variable + - $ref: >- + #/components/x-stackQL-resources/variables/methods/delete_org_variable + replace: [] + repos_for_org_variable: + id: github.actions.repos_for_org_variable + name: repos_for_org_variable + title: Repos For Org Variable + methods: + list_selected_repos_for_org_variable: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1variables~1{name}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_selected_repos_for_org_variable: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1variables~1{name}~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_selected_repo_to_org_variable: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1variables~1{name}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_selected_repo_from_org_variable: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1variables~1{name}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos_for_org_variable/methods/list_selected_repos_for_org_variable + insert: + - $ref: >- + #/components/x-stackQL-resources/repos_for_org_variable/methods/add_selected_repo_to_org_variable + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repos_for_org_variable/methods/remove_selected_repo_from_org_variable + replace: + - $ref: >- + #/components/x-stackQL-resources/repos_for_org_variable/methods/set_selected_repos_for_org_variable + artifacts: + id: github.actions.artifacts + name: artifacts + title: Artifacts + methods: + list_artifacts_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1artifacts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_artifact: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1artifacts~1{artifact_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_artifact: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1artifacts~1{artifact_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_workflow_run_artifacts: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1artifacts/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/get_artifact' + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/list_workflow_run_artifacts + - $ref: >- + #/components/x-stackQL-resources/artifacts/methods/list_artifacts_for_repo + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete_artifact' + replace: [] + cache: + id: github.actions.cache + name: cache + title: Cache + methods: + get_actions_cache_list: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1caches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_actions_cache_by_key: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1caches/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_actions_cache_by_id: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1caches~1{cache_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/cache/methods/get_actions_cache_list + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/cache/methods/delete_actions_cache_by_id + - $ref: >- + #/components/x-stackQL-resources/cache/methods/delete_actions_cache_by_key + replace: [] + workflow_jobs: + id: github.actions.workflow_jobs + name: workflow_jobs + title: Workflow Jobs + methods: + get_job_for_workflow_run: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1jobs~1{job_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_jobs_for_workflow_run_attempt: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1attempts~1{attempt_number}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_jobs_for_workflow_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1jobs/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workflow_jobs/methods/list_jobs_for_workflow_run_attempt + - $ref: >- + #/components/x-stackQL-resources/workflow_jobs/methods/get_job_for_workflow_run + - $ref: >- + #/components/x-stackQL-resources/workflow_jobs/methods/list_jobs_for_workflow_run + insert: [] + update: [] + delete: [] + replace: [] + workflow_runs: + id: github.actions.workflow_runs + name: workflow_runs + title: Workflow Runs + methods: + re_run_job_for_workflow_run: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1jobs~1{job_id}~1rerun/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_workflow_runs_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1runs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.workflow_runs + get_workflow_run: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_workflow_run: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + approve_workflow_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1approve/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_workflow_run_attempt: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1attempts~1{attempt_number}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel_workflow_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1cancel/post + response: + mediaType: application/json + openAPIDocKey: '202' + review_custom_gates_for_run: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1deployment_protection_rule/post + response: + mediaType: application/json + openAPIDocKey: '204' + force_cancel_workflow_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1force-cancel/post + response: + mediaType: application/json + openAPIDocKey: '202' + re_run_workflow: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1rerun/post + response: + mediaType: application/json + openAPIDocKey: '201' + re_run_workflow_failed_jobs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1rerun-failed-jobs/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_workflow_runs: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1workflows~1{workflow_id}~1runs/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workflow_runs/methods/get_workflow_run_attempt + - $ref: >- + #/components/x-stackQL-resources/workflow_runs/methods/get_workflow_run + - $ref: >- + #/components/x-stackQL-resources/workflow_runs/methods/list_workflow_runs + - $ref: >- + #/components/x-stackQL-resources/workflow_runs/methods/list_workflow_runs_for_repo + insert: + - $ref: >- + #/components/x-stackQL-resources/workflow_runs/methods/force_cancel_workflow_run + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workflow_runs/methods/delete_workflow_run + replace: [] + oidc: + id: github.actions.oidc + name: oidc + title: Oidc + methods: + get_custom_oidc_sub_claim_for_repo: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1oidc~1customization~1sub/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_custom_oidc_sub_claim_for_repo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1oidc~1customization~1sub/put + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/oidc/methods/get_custom_oidc_sub_claim_for_repo + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/oidc/methods/set_custom_oidc_sub_claim_for_repo + repo_org_secrets: + id: github.actions.repo_org_secrets + name: repo_org_secrets + title: Repo Org Secrets + methods: + list_repo_organization_secrets: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1organization-secrets/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_org_secrets/methods/list_repo_organization_secrets + insert: [] + update: [] + delete: [] + replace: [] + repo_org_variables: + id: github.actions.repo_org_variables + name: repo_org_variables + title: Repo Org Variables + methods: + list_repo_organization_variables: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1organization-variables/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_org_variables/methods/list_repo_organization_variables + insert: [] + update: [] + delete: [] + replace: [] + workflow_access: + id: github.actions.workflow_access + name: workflow_access + title: Workflow Access + methods: + get_workflow_access_to_repository: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1access/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_workflow_access_to_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1access/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workflow_access/methods/get_workflow_access_to_repository + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/workflow_access/methods/set_workflow_access_to_repository + fork_pr_contributor_approval_permissions: + id: github.actions.fork_pr_contributor_approval_permissions + name: fork_pr_contributor_approval_permissions + title: Fork Pr Contributor Approval Permissions + methods: + get_fork_pr_contributor_approval_permissions_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1fork-pr-contributor-approval/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_fork_pr_contributor_approval_permissions_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1fork-pr-contributor-approval/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/fork_pr_contributor_approval_permissions/methods/get_fork_pr_contributor_approval_permissions_repository + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/fork_pr_contributor_approval_permissions/methods/set_fork_pr_contributor_approval_permissions_repository + fork_pr_workflows_private_repos_settings: + id: github.actions.fork_pr_workflows_private_repos_settings + name: fork_pr_workflows_private_repos_settings + title: Fork Pr Workflows Private Repos Settings + methods: + get_private_repo_fork_pr_workflows_settings_repository: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1fork-pr-workflows-private-repos/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_private_repo_fork_pr_workflows_settings_repository: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1permissions~1fork-pr-workflows-private-repos/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/fork_pr_workflows_private_repos_settings/methods/get_private_repo_fork_pr_workflows_settings_repository + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/fork_pr_workflows_private_repos_settings/methods/set_private_repo_fork_pr_workflows_settings_repository + workflow_run_reviews: + id: github.actions.workflow_run_reviews + name: workflow_run_reviews + title: Workflow Run Reviews + methods: + get_reviews_for_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1approvals/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workflow_run_reviews/methods/get_reviews_for_run + insert: [] + update: [] + delete: [] + replace: [] + workflow_run_logs: + id: github.actions.workflow_run_logs + name: workflow_run_logs + title: Workflow Run Logs + methods: + delete_workflow_run_logs: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1logs/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/workflow_run_logs/methods/delete_workflow_run_logs + replace: [] + pending_deployments_for_run: + id: github.actions.pending_deployments_for_run + name: pending_deployments_for_run + title: Pending Deployments For Run + methods: + get_pending_deployments_for_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1pending_deployments/get + response: + mediaType: application/json + openAPIDocKey: '200' + review_pending_deployments_for_run: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1pending_deployments/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pending_deployments_for_run/methods/get_pending_deployments_for_run + insert: [] + update: [] + delete: [] + replace: [] + workflow_run_usage: + id: github.actions.workflow_run_usage + name: workflow_run_usage + title: Workflow Run Usage + methods: + get_workflow_run_usage: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1timing/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workflow_run_usage/methods/get_workflow_run_usage + insert: [] + update: [] + delete: [] + replace: [] + workflows: + id: github.actions.workflows + name: workflows + title: Workflows + methods: + list_repo_workflows: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1actions~1workflows/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_workflow: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1workflows~1{workflow_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + disable_workflow: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1workflows~1{workflow_id}~1disable/put + response: + mediaType: application/json + openAPIDocKey: '204' + create_workflow_dispatch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1workflows~1{workflow_id}~1dispatches/post + response: + mediaType: application/json + openAPIDocKey: '200' + enable_workflow: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1workflows~1{workflow_id}~1enable/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/workflows/methods/get_workflow' + - $ref: >- + #/components/x-stackQL-resources/workflows/methods/list_repo_workflows + insert: + - $ref: >- + #/components/x-stackQL-resources/workflows/methods/create_workflow_dispatch + update: [] + delete: [] + replace: [] + workflow_usage: + id: github.actions.workflow_usage + name: workflow_usage + title: Workflow Usage + methods: + get_workflow_usage: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1actions~1workflows~1{workflow_id}~1timing/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.billable + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/workflow_usage/methods/get_workflow_usage + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/activity.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/activity.yaml new file mode 100644 index 0000000..70237e9 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/activity.yaml @@ -0,0 +1,7601 @@ +openapi: 3.0.3 +info: + title: activity API + description: Activity APIs provide access to notifications, subscriptions, and timelines. + version: 1.1.4 +paths: + /events: + get: + summary: List public events + description: >- + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-public-events + parameters: + - $ref: '#/components/parameters/public-events-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/public-events-items' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /feeds: + get: + summary: Get feeds + description: >- + Lists the feeds available to the authenticated user. The response + provides a URL for each feed. You can then get a specific feed by + sending a request to one of the feed URLs. + + + * **Timeline**: The GitHub global public timeline + + * **User**: The public timeline for any user, using `uri_template`. + For more information, see + "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + + * **Current user public**: The public timeline for the authenticated + user + + * **Current user**: The private timeline for the authenticated user + + * **Current user actor**: The private timeline for activity created by + the authenticated user + + * **Current user organizations**: The private timeline for the + organizations the authenticated user is a member of. + + * **Security advisories**: A collection of public announcements that + provide information about security-related vulnerabilities in software + on GitHub. + + + By default, timeline resources are returned in JSON. You can specify the + `application/atom+xml` type in the `Accept` header to return timeline + resources in Atom format. For more information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + > [!NOTE] + + > Private feeds are only returned when [authenticating via Basic + Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + since current feed URIs use the older, non revocable auth tokens. + tags: + - activity + operationId: activity/get-feeds + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/feeds#get-feeds + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/feed' + examples: + default: + $ref: '#/components/examples/feed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: feeds + x-stackQL-resource: feeds + /networks/{owner}/{repo}/events: + get: + summary: List public events for a network of repositories + description: >- + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-events-for-repo-network + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/public-repo-events-items' + '301': + $ref: '#/components/responses/moved_permanently' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /notifications: + get: + summary: List notifications for the authenticated user + description: >- + List all notifications for the current user, sorted by most recently + updated. + tags: + - activity + operationId: activity/list-notifications-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/all' + - $ref: '#/components/parameters/participating' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/before' + - $ref: '#/components/parameters/page' + - name: per_page + description: >- + The number of results per page (max 50). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 50 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/thread' + examples: + default: + $ref: '#/components/examples/thread-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + put: + summary: Mark notifications as read + description: >- + Marks all notifications as "read" for the current user. If the number of + notifications is too large to complete in one request, you will receive + a `202 Accepted` status and GitHub will run an asynchronous process to + mark notifications as "read." To check whether any "unread" + notifications remain, you can use the [List notifications for the + authenticated + user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) + endpoint and pass the query parameter `all=false`. + tags: + - activity + operationId: activity/mark-notifications-as-read + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#mark-notifications-as-read + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + last_read_at: + description: >- + Describes the last point that notifications were checked. + Anything updated since this time will not be marked as read. + If you omit this parameter, all notifications are marked as + read. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + type: string + format: date-time + read: + description: Whether the notification has been read. + type: boolean + examples: + default: + value: + last_read_at: '2022-06-10T00:00:00Z' + read: true + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + default: + $ref: '#/components/examples/notifications-mark-read' + '205': + description: Reset Content + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /notifications/threads/{thread_id}: + get: + summary: Get a thread + description: Gets information about a notification thread. + tags: + - activity + operationId: activity/get-thread + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#get-a-thread + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/thread' + examples: + default: + $ref: '#/components/examples/thread' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + patch: + summary: Mark a thread as read + description: >- + Marks a thread as "read." Marking a thread as "read" is equivalent to + clicking a notification in your notification inbox on GitHub: + https://github.com/notifications. + tags: + - activity + operationId: activity/mark-thread-as-read + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '205': + description: Reset Content + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + delete: + summary: Mark a thread as done + description: >- + Marks a thread as "done." Marking a thread as "done" is equivalent to + marking a notification in your notification inbox on GitHub as done: + https://github.com/notifications. + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '204': + description: No content + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /notifications/threads/{thread_id}/subscription: + get: + summary: Get a thread subscription for the authenticated user + description: >- + This checks to see if the current user is subscribed to a thread. You + can also [get a repository + subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription). + + + Note that subscriptions are only generated if a user is participating in + a conversation--for example, they've replied to the thread, were + **@mentioned**, or manually subscribe to a thread. + tags: + - activity + operationId: activity/get-thread-subscription-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/thread-subscription' + examples: + default: + $ref: '#/components/examples/thread-subscription' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + put: + summary: Set a thread subscription + description: >- + If you are watching a repository, you receive notifications for all + threads by default. Use this endpoint to ignore future notifications for + threads until you comment on the thread or get an **@mention**. + + + You can also use this endpoint to subscribe to threads that you are + currently not receiving notifications for or to subscribed to threads + that you have previously ignored. + + + Unsubscribing from a conversation in a repository that you are not + watching is functionally equivalent to the [Delete a thread + subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) + endpoint. + tags: + - activity + operationId: activity/set-thread-subscription + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#set-a-thread-subscription + parameters: + - $ref: '#/components/parameters/thread-id' + requestBody: + required: false + content: + application/json: + schema: + properties: + ignored: + description: Whether to block all notifications from a thread. + default: false + type: boolean + type: object + examples: + default: + value: + ignored: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/thread-subscription' + examples: + default: + $ref: '#/components/examples/thread-subscription' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + delete: + summary: Delete a thread subscription + description: >- + Mutes all future notifications for a conversation until you comment on + the thread or get an **@mention**. If you are watching the repository of + the thread, you will still receive notifications. To ignore future + notifications for a repository you are watching, use the [Set a thread + subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) + endpoint and set `ignore` to `true`. + tags: + - activity + operationId: activity/delete-thread-subscription + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /orgs/{org}/events: + get: + summary: List public organization events + description: >- + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-org-events + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-public-organization-events + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + 200-response: + $ref: '#/components/examples/public-org-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/events: + get: + summary: List repository events + description: >- + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-repo-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-repository-events + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + 200-response: + $ref: '#/components/examples/repo-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/notifications: + get: + summary: List repository notifications for the authenticated user + description: >- + Lists all notifications for the current user in the specified + repository. + tags: + - activity + operationId: activity/list-repo-notifications-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/all' + - $ref: '#/components/parameters/participating' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/before' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/thread' + examples: + default: + $ref: '#/components/examples/thread-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + put: + summary: Mark repository notifications as read + description: >- + Marks all notifications in a repository as "read" for the current user. + If the number of notifications is too large to complete in one request, + you will receive a `202 Accepted` status and GitHub will run an + asynchronous process to mark notifications as "read." To check whether + any "unread" notifications remain, you can use the [List repository + notifications for the authenticated + user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) + endpoint and pass the query parameter `all=false`. + tags: + - activity + operationId: activity/mark-repo-notifications-as-read + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + last_read_at: + type: string + format: date-time + description: >- + Describes the last point that notifications were checked. + Anything updated since this time will not be marked as read. + If you omit this parameter, all notifications are marked as + read. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + examples: + default: + value: + last_read_at: '2019-01-01T00:00:00Z' + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: >- + Unread notifications couldn't be marked in a single + request. Notifications are being marked as read in the + background. + '205': + description: Reset Content + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /repos/{owner}/{repo}/stargazers: + get: + summary: List stargazers + description: >- + Lists the people that have starred the repository. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.star+json`**: Includes a timestamp of when + the star was created. + tags: + - activity + operationId: activity/list-stargazers-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#list-stargazers + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default-response: + $ref: '#/components/examples/simple-user-items-default-response' + alternative-response-with-star-creation-timestamps: + $ref: >- + #/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: starring + x-stackQL-resource: starring + /repos/{owner}/{repo}/subscribers: + get: + summary: List watchers + description: Lists the people watching the specified repository. + tags: + - activity + operationId: activity/list-watchers-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#list-watchers + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: watching + x-stackQL-resource: watching + /repos/{owner}/{repo}/subscription: + get: + summary: Get a repository subscription + description: >- + Gets information about whether the authenticated user is subscribed to + the repository. + tags: + - activity + operationId: activity/get-repo-subscription + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/watching#get-a-repository-subscription + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: if you subscribe to the repository + content: + application/json: + schema: + $ref: '#/components/schemas/repository-subscription' + examples: + response-if-you-subscribe-to-the-repository: + $ref: >- + #/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if you don't subscribe to the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + put: + summary: Set a repository subscription + description: >- + If you would like to watch a repository, set `subscribed` to `true`. If + you would like to ignore notifications made within a repository, set + `ignored` to `true`. If you would like to stop watching a repository, + [delete the repository's + subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) + completely. + tags: + - activity + operationId: activity/set-repo-subscription + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/watching#set-a-repository-subscription + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + subscribed: + type: boolean + description: >- + Determines if notifications should be received from this + repository. + ignored: + type: boolean + description: >- + Determines if all notifications should be blocked from this + repository. + examples: + default: + value: + subscribed: true + ignored: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-subscription' + examples: + default: + $ref: '#/components/examples/repository-subscription' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + delete: + summary: Delete a repository subscription + description: >- + This endpoint should only be used to stop watching a repository. To + control whether or not you wish to receive notifications from a + repository, [set the repository's subscription + manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). + tags: + - activity + operationId: activity/delete-repo-subscription + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/watching#delete-a-repository-subscription + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + /user/starred: + get: + summary: List repositories starred by the authenticated user + description: >- + Lists repositories the authenticated user has starred. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.star+json`**: Includes a timestamp of when + the star was created. + tags: + - activity + operationId: activity/list-repos-starred-by-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/sort-starred' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default-response: + $ref: '#/components/examples/repository-items-default-response' + application/vnd.github.v3.star+json: + schema: + type: array + items: + $ref: '#/components/schemas/starred-repository' + examples: + alternative-response-with-star-creation-timestamps: + $ref: >- + #/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + /user/starred/{owner}/{repo}: + get: + summary: Check if a repository is starred by the authenticated user + description: Whether the authenticated user has starred the repository. + tags: + - activity + operationId: activity/check-repo-is-starred-by-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response if this repository is starred by you + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if this repository is not starred by you + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + put: + summary: Star a repository for the authenticated user + description: >- + Note that you'll need to set `Content-Length` to zero when calling out + to this endpoint. For more information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - activity + operationId: activity/star-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + delete: + summary: Unstar a repository for the authenticated user + description: Unstar a repository that the authenticated user has previously starred. + tags: + - activity + operationId: activity/unstar-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + /user/subscriptions: + get: + summary: List repositories watched by the authenticated user + description: Lists repositories the authenticated user is watching. + tags: + - activity + operationId: activity/list-watched-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + /users/{username}/events: + get: + summary: List events for the authenticated user + description: >- + If you are authenticated as the given user, you will see your private + events. Otherwise, you'll only see public events. _Optional_: use the + fine-grained token with following permission set to view private events: + "Events" user permissions (read). + + + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-events-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/events/orgs/{org}: + get: + summary: List organization events for the authenticated user + description: >- + This is the user's organization dashboard. You must be authenticated as + the user to view this. + + + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-org-events-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-org-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/events/public: + get: + summary: List public events for a user + description: >- + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-events-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-public-events-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-public-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/received_events: + get: + summary: List events received by the authenticated user + description: >- + These are events that you've received by watching repositories and + following users. If you are authenticated as the + + given user, you will see private events. Otherwise, you'll only see + public events. + + + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-received-events-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-received-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/received_events/public: + get: + summary: List public events received by a user + description: >- + > [!NOTE] + + > This API is not built to serve real-time use cases. Depending on the + time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-received-public-events-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-received-public-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/starred: + get: + summary: List repositories starred by a user + description: >- + Lists repositories a user has starred. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.star+json`**: Includes a timestamp of when + the star was created. + tags: + - activity + operationId: activity/list-repos-starred-by-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/sort-starred' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/starred-repository' + examples: + default-response: + $ref: '#/components/examples/repository-items-default-response' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: starring + x-stackQL-resource: starring + /users/{username}/subscriptions: + get: + summary: List repositories watched by a user + description: Lists repositories a user is watching. + tags: + - activity + operationId: activity/list-repos-watched-by-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: watching + x-stackQL-resource: watching +components: + schemas: + event: + title: Event + description: Event + type: object + properties: + id: + type: string + type: + type: string + nullable: true + actor: + $ref: '#/components/schemas/actor' + repo: + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - name + - url + org: + $ref: '#/components/schemas/actor' + payload: + title: CreateEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + master_branch: + type: string + description: + type: string + nullable: true + pusher_type: + type: string + action: + type: string + discussion: + $ref: '#/components/schemas/discussion' + issue: + $ref: '#/components/schemas/issue' + assignee: + $ref: '#/components/schemas/simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + label: + $ref: '#/components/schemas/label' + labels: + type: array + items: + $ref: '#/components/schemas/label' + comment: + $ref: '#/components/schemas/issue-comment' + forkee: + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + private: + type: boolean + owner: + $ref: '#/components/schemas/simple-user' + html_url: + type: string + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + forks_url: + type: string + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + hooks_url: + type: string + issue_events_url: + type: string + events_url: + type: string + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + stargazers_url: + type: string + contributors_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + archive_url: + type: string + downloads_url: + type: string + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + pushed_at: + type: string + format: date-time + nullable: true + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + homepage: + type: string + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_downloads: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + forks_count: + type: integer + mirror_url: + type: string + nullable: true + archived: + type: boolean + disabled: + type: boolean + open_issues_count: + type: integer + license: + $ref: '#/components/schemas/nullable-license-simple' + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + topics: + type: array + items: + type: string + visibility: + type: string + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + default_branch: + type: string + public: + type: boolean + pages: + type: array + items: + type: object + properties: + page_name: + type: string + nullable: true + title: + type: string + nullable: true + summary: + type: string + nullable: true + action: + type: string + sha: + type: string + html_url: + type: string + member: + $ref: '#/components/schemas/simple-user' + repository_id: + type: integer + push_id: + type: integer + head: + type: string + before: + type: string + number: + type: integer + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + review: + type: object + properties: + id: + type: integer + node_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + commit_id: + type: string + submitted_at: + type: string + nullable: true + state: + type: string + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + updated_at: + type: string + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: >- + Specifies the commitish value that determines where the Git + tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: >- + true to create a draft (unpublished) release, false to + create a published one. + example: false + type: boolean + prerelease: + description: >- + Whether to identify the release as a prerelease or a full + release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + is_short_description_html_truncated: + type: boolean + short_description_html: + type: string + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + required: + - ref + - ref_type + - full_ref + - master_branch + - pusher_type + - action + - discussion + - issue + - comment + - forkee + - pages + - member + - repository_id + - push_id + - head + - before + - number + - pull_request + - review + - release + description: (opaque JSON object) + public: + type: boolean + created_at: + type: string + format: date-time + nullable: true + required: + - id + - type + - actor + - repo + - payload + - public + - created_at + feed: + title: Feed + description: Feed + type: object + properties: + timeline_url: + type: string + example: https://github.com/timeline + user_url: + type: string + example: https://github.com/{user} + current_user_public_url: + type: string + example: https://github.com/octocat + current_user_url: + type: string + example: https://github.com/octocat.private?token=abc123 + current_user_actor_url: + type: string + example: https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: + type: string + example: https://github.com/octocat-org + current_user_organization_urls: + type: array + example: + - >- + https://github.com/organizations/github/octocat.private.atom?token=abc123 + items: + type: string + format: uri + security_advisories_url: + type: string + example: https://github.com/security-advisories + repository_discussions_url: + type: string + example: https://github.com/{user}/{repo}/discussions + description: A feed of discussions for a given repository. + repository_discussions_category_url: + type: string + example: https://github.com/{user}/{repo}/discussions/categories/{category} + description: A feed of discussions for a given repository and category. + _links: + type: object + properties: + timeline: + $ref: '#/components/schemas/link-with-type' + user: + $ref: '#/components/schemas/link-with-type' + security_advisories: + $ref: '#/components/schemas/link-with-type' + current_user: + $ref: '#/components/schemas/link-with-type' + current_user_public: + $ref: '#/components/schemas/link-with-type' + current_user_actor: + $ref: '#/components/schemas/link-with-type' + current_user_organization: + $ref: '#/components/schemas/link-with-type' + current_user_organizations: + type: array + items: + $ref: '#/components/schemas/link-with-type' + repository_discussions: + $ref: '#/components/schemas/link-with-type' + repository_discussions_category: + $ref: '#/components/schemas/link-with-type' + required: + - timeline + - user + required: + - _links + - timeline_url + - user_url + thread: + title: Thread + description: Thread + type: object + properties: + id: + type: string + repository: + $ref: '#/components/schemas/minimal-repository' + subject: + type: object + properties: + title: + type: string + url: + type: string + latest_comment_url: + type: string + type: + type: string + required: + - title + - url + - latest_comment_url + - type + reason: + type: string + unread: + type: boolean + updated_at: + type: string + last_read_at: + type: string + nullable: true + url: + type: string + subscription_url: + type: string + example: https://api.github.com/notifications/threads/2/subscription + required: + - id + - unread + - reason + - updated_at + - last_read_at + - subject + - repository + - url + - subscription_url + thread-subscription: + title: Thread Subscription + description: Thread Subscription + type: object + properties: + subscribed: + type: boolean + example: true + ignored: + type: boolean + reason: + type: string + nullable: true + created_at: + type: string + format: date-time + example: '2012-10-06T21:34:12Z' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/notifications/threads/1/subscription + thread_url: + type: string + format: uri + example: https://api.github.com/notifications/threads/1 + repository_url: + type: string + format: uri + example: https://api.github.com/repos/1 + required: + - created_at + - ignored + - reason + - url + - subscribed + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - starred_at + - user + repository-subscription: + title: Repository Invitation + description: Repository invitations let you manage who you collaborate with. + type: object + properties: + subscribed: + description: Determines if notifications should be received from this repository. + type: boolean + example: true + ignored: + description: >- + Determines if all notifications should be blocked from this + repository. + type: boolean + reason: + type: string + nullable: true + created_at: + type: string + format: date-time + example: '2012-10-06T21:34:12Z' + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + required: + - created_at + - ignored + - reason + - subscribed + - url + - repository_url + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + starred-repository: + title: Starred Repository + description: Starred Repository + type: object + properties: + starred_at: + type: string + format: date-time + repo: + $ref: '#/components/schemas/repository' + required: + - starred_at + - repo + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + actor: + title: Actor + description: Actor + type: object + properties: + id: + type: integer + login: + type: string + display_login: + type: string + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + avatar_url: + type: string + format: uri + required: + - id + - login + - gravatar_id + - url + - avatar_url + create-event: + title: CreateEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + master_branch: + type: string + description: + type: string + nullable: true + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - master_branch + - pusher_type + delete-event: + title: DeleteEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - pusher_type + discussion-event: + title: DiscussionEvent + type: object + properties: + action: + type: string + discussion: + $ref: '#/components/schemas/discussion' + required: + - action + - discussion + issues-event: + title: IssuesEvent + type: object + properties: + action: + type: string + issue: + $ref: '#/components/schemas/issue' + assignee: + $ref: '#/components/schemas/simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + label: + $ref: '#/components/schemas/label' + labels: + type: array + items: + $ref: '#/components/schemas/label' + required: + - action + - issue + issue-comment-event: + title: IssueCommentEvent + type: object + properties: + action: + type: string + issue: + $ref: '#/components/schemas/issue' + comment: + $ref: '#/components/schemas/issue-comment' + required: + - action + - issue + - comment + fork-event: + title: ForkEvent + type: object + properties: + action: + type: string + forkee: + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + private: + type: boolean + owner: + $ref: '#/components/schemas/simple-user' + html_url: + type: string + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + forks_url: + type: string + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + hooks_url: + type: string + issue_events_url: + type: string + events_url: + type: string + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + stargazers_url: + type: string + contributors_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + archive_url: + type: string + downloads_url: + type: string + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + pushed_at: + type: string + format: date-time + nullable: true + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + homepage: + type: string + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_downloads: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + forks_count: + type: integer + mirror_url: + type: string + nullable: true + archived: + type: boolean + disabled: + type: boolean + open_issues_count: + type: integer + license: + $ref: '#/components/schemas/nullable-license-simple' + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + topics: + type: array + items: + type: string + visibility: + type: string + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + default_branch: + type: string + public: + type: boolean + required: + - action + - forkee + gollum-event: + title: GollumEvent + type: object + properties: + pages: + type: array + items: + type: object + properties: + page_name: + type: string + nullable: true + title: + type: string + nullable: true + summary: + type: string + nullable: true + action: + type: string + sha: + type: string + html_url: + type: string + required: + - pages + member-event: + title: MemberEvent + type: object + properties: + action: + type: string + member: + $ref: '#/components/schemas/simple-user' + required: + - action + - member + public-event: + title: PublicEvent + type: string + description: (opaque JSON object) + push-event: + title: PushEvent + type: object + properties: + repository_id: + type: integer + push_id: + type: integer + ref: + type: string + head: + type: string + before: + type: string + required: + - repository_id + - push_id + - ref + - head + - before + pull-request-event: + title: PullRequestEvent + type: object + properties: + action: + type: string + number: + type: integer + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + assignee: + $ref: '#/components/schemas/simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + label: + $ref: '#/components/schemas/label' + labels: + type: array + items: + $ref: '#/components/schemas/label' + required: + - action + - number + - pull_request + pull-request-review-comment-event: + title: PullRequestReviewCommentEvent + type: object + properties: + action: + type: string + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + comment: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + pull_request_review_id: + type: integer + nullable: true + diff_hunk: + type: string + path: + type: string + position: + type: integer + nullable: true + original_position: + type: integer + subject_type: + type: string + nullable: true + commit_id: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + body: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + original_commit_id: + type: string + reactions: + title: Reactions + type: object + properties: + '+1': + type: integer + '-1': + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + in_reply_to_id: + type: integer + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - _links + - reactions + required: + - action + - comment + - pull_request + pull-request-review-event: + title: PullRequestReviewEvent + type: object + properties: + action: + type: string + review: + type: object + properties: + id: + type: integer + node_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + commit_id: + type: string + submitted_at: + type: string + nullable: true + state: + type: string + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + updated_at: + type: string + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + required: + - action + - review + - pull_request + commit-comment-event: + title: CommitCommentEvent + type: object + properties: + action: + type: string + comment: + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - action + - comment + release-event: + title: ReleaseEvent + type: object + properties: + action: + type: string + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: >- + Specifies the commitish value that determines where the Git tag + is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: >- + true to create a draft (unpublished) release, false to create a + published one. + example: false + type: boolean + prerelease: + description: >- + Whether to identify the release as a prerelease or a full + release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + is_short_description_html_truncated: + type: boolean + short_description_html: + type: string + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + required: + - action + - release + watch-event: + title: WatchEvent + type: object + properties: + action: + type: string + required: + - action + link-with-type: + title: Link With Type + description: Hypermedia Link with Type + type: object + properties: + href: + type: string + type: + type: string + required: + - href + - type + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: string + nullable: true + answer_chosen_at: + type: string + nullable: true + answer_chosen_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + answer_html_url: + type: string + nullable: true + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + category: + type: object + properties: + created_at: + type: string + format: date-time + description: + type: string + emoji: + type: string + id: + type: integer + is_answerable: + type: boolean + name: + type: string + node_id: + type: string + repository_id: + type: integer + slug: + type: string + updated_at: + type: string + required: + - id + - repository_id + - emoji + - name + - description + - created_at + - updated_at + - slug + - is_answerable + comments: + type: integer + created_at: + type: string + format: date-time + html_url: + type: string + id: + type: integer + locked: + type: boolean + node_id: + type: string + number: + type: integer + reactions: + title: Reactions + type: object + properties: + '+1': + type: integer + '-1': + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + state: + type: string + description: >- + The current state of the discussion. + + `converting` means that the discussion is being converted from an + issue. + + `transferring` means that the discussion is being transferred from + another repository. + enum: + - open + - closed + - locked + - converting + - transferring + state_reason: + description: The reason for the current state + example: resolved + type: string + nullable: true + enum: + - resolved + - outdated + - duplicate + - reopened + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + labels: + type: array + items: + $ref: '#/components/schemas/label' + required: + - repository_url + - category + - answer_html_url + - answer_chosen_at + - answer_chosen_by + - html_url + - id + - node_id + - number + - title + - user + - state + - state_reason + - locked + - comments + - created_at + - updated_at + - active_lock_reason + - body + issue: + title: Issue + description: >- + Issues are a great way to keep track of tasks, enhancements, and bugs + for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: >- + It looks like the new widget form is broken on Safari. When I try + and create the widget, Safari crashes. This is reproducible on 10.8, + but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: >- + Labels to associate with this issue; pass one or more label names to + replace the set of labels on this issue; send an empty array to + clear all labels from the issue; note that the labels are silently + dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + label: + title: Label + description: >- + Color-coded labels help you categorize and filter your issues (just like + labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + example: 208045946 + node_id: + type: string + example: MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + example: https://api.github.com/repositories/42/labels/bug + type: string + format: uri + name: + description: The name of the label. + example: bug + type: string + description: + description: Optional description of the label, such as its purpose. + type: string + example: Something isn't working + nullable: true + color: + description: '6-character hex code, without the leading #, identifying the color' + example: FFFFFF + type: string + default: + description: Whether this label comes by default in a new repository. + type: boolean + example: true + required: + - id + - node_id + - url + - name + - description + - color + - default + issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: >- + Specifies the commitish value that determines where the Git tag is + created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: >- + true to create a draft (unpublished) release, false to create a + published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: >- + Details about the selected option (only present for single_select + fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + example: Team Environment + label: + type: string + nullable: true + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: string + nullable: true + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + $ref: '#/components/schemas/nullable-simple-user' + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + public-events-per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 15 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + all: + name: all + description: If `true`, show notifications marked as read. + in: query + required: false + schema: + type: boolean + default: false + participating: + name: participating + description: >- + If `true`, only shows notifications in which the user is directly + participating or mentioned. + in: query + required: false + schema: + type: boolean + default: false + since: + name: since + description: >- + Only show results that were last updated after the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + before: + name: before + description: >- + Only show notifications updated before the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + thread-id: + name: thread_id + description: >- + The unique identifier of the notification thread. This corresponds to + the value returned in the `id` field when you retrieve notifications + (for example with the [`GET /notifications` + operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). + in: path + required: true + schema: + type: integer + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + sort-starred: + name: sort + description: >- + The property to sort the results by. `created` means when the repository + was starred. `updated` means when the repository was last pushed to. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + public-events-items: + value: + - id: '22249084947' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-07T07:50:26Z' + feed: + value: + timeline_url: https://github.com/timeline + user_url: https://github.com/{user} + current_user_public_url: https://github.com/octocat + current_user_url: https://github.com/octocat.private?token=abc123 + current_user_actor_url: https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: '' + current_user_organization_urls: + - >- + https://github.com/organizations/github/octocat.private.atom?token=abc123 + security_advisories_url: https://github.com/security-advisories + _links: + timeline: + href: https://github.com/timeline + type: application/atom+xml + user: + href: https://github.com/{user} + type: application/atom+xml + current_user_public: + href: https://github.com/octocat + type: application/atom+xml + current_user: + href: https://github.com/octocat.private?token=abc123 + type: application/atom+xml + current_user_actor: + href: https://github.com/octocat.private.actor?token=abc123 + type: application/atom+xml + current_user_organization: + href: '' + type: '' + current_user_organizations: + - href: >- + https://github.com/organizations/github/octocat.private.atom?token=abc123 + type: application/atom+xml + security_advisories: + href: https://github.com/security-advisories + type: application/atom+xml + public-repo-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + thread-items: + value: + - id: '1' + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + subject: + title: Greetings + url: https://api.github.com/repos/octokit/octokit.rb/issues/123 + latest_comment_url: >- + https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 + type: Issue + reason: subscribed + unread: true + updated_at: '2014-11-07T22:01:45Z' + last_read_at: '2014-11-07T22:01:45Z' + url: https://api.github.com/notifications/threads/1 + subscription_url: https://api.github.com/notifications/threads/1/subscription + notifications-mark-read: + value: + message: >- + Unread notifications couldn't be marked in a single request. + Notifications are being marked as read in the background. + thread: + value: + id: '1' + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + subject: + title: Greetings + url: https://api.github.com/repos/octokit/octokit.rb/issues/123 + latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 + type: Issue + reason: subscribed + unread: true + updated_at: '2014-11-07T22:01:45Z' + last_read_at: '2014-11-07T22:01:45Z' + url: https://api.github.com/notifications/threads/1 + subscription_url: https://api.github.com/notifications/threads/1/subscription + thread-subscription: + value: + subscribed: true + ignored: false + reason: null + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/notifications/threads/1/subscription + thread_url: https://api.github.com/notifications/threads/1 + public-org-events-items: + value: + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + repo-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + simple-user-items-default-response: + summary: Default response + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + stargazer-items-alternative-response-with-star-creation-timestamps: + summary: Alternative response with star creation timestamps + value: + - starred_at: '2011-01-16T19:06:43Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository-subscription-response-if-you-subscribe-to-the-repository: + value: + subscribed: true + ignored: false + reason: null + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/repos/octocat/example/subscription + repository_url: https://api.github.com/repos/octocat/example + repository-subscription: + value: + subscribed: true + ignored: false + reason: null + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/repos/octocat/example/subscription + repository_url: https://api.github.com/repos/octocat/example + repository-items-default-response: + summary: Default response + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + starred-repository-items-alternative-response-with-star-creation-timestamps: + summary: Alternative response with star creation timestamps + value: + - starred_at: '2011-01-16T19:06:43Z' + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + user-events-items: + value: + - id: '22249084947' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: false + created_at: '2022-06-07T07:50:26Z' + user-org-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: false + created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + - id: '22196946742' + type: CreateEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + ref: master + ref_type: repository + full_ref: refs/heads/master + master_branch: master + description: null + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + user-public-events-items: + value: + - id: '22249084947' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-08T23:29:25Z' + user-received-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22196946742' + type: CreateEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + ref: master + ref_type: repository + full_ref: refs/heads/master + master_branch: master + description: null + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + user-received-public-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22196946742' + type: CreateEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + ref: master + ref_type: repository + full_ref: refs/heads/master + master_branch: master + description: null + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + public_events: + id: github.activity.public_events + name: public_events + title: Public Events + methods: + list_public_events: + operation: + $ref: '#/paths/~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_public_events_for_repo_network: + operation: + $ref: '#/paths/~1networks~1{owner}~1{repo}~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_public_org_events: + operation: + $ref: '#/paths/~1orgs~1{org}~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_public_events_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1events~1public/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_events/methods/list_public_events_for_repo_network + - $ref: >- + #/components/x-stackQL-resources/public_events/methods/list_public_org_events + - $ref: >- + #/components/x-stackQL-resources/public_events/methods/list_public_events_for_user + - $ref: >- + #/components/x-stackQL-resources/public_events/methods/list_public_events + insert: [] + update: [] + delete: [] + replace: [] + feeds: + id: github.activity.feeds + name: feeds + title: Feeds + methods: + get_feeds: + operation: + $ref: '#/paths/~1feeds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/feeds/methods/get_feeds' + insert: [] + update: [] + delete: [] + replace: [] + notifications: + id: github.activity.notifications + name: notifications + title: Notifications + methods: + list_notifications_for_authenticated_user: + operation: + $ref: '#/paths/~1notifications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + mark_notifications_as_read: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications/put' + response: + mediaType: application/json + openAPIDocKey: '202' + get_thread: + operation: + $ref: '#/paths/~1notifications~1threads~1{thread_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + mark_thread_as_read: + operation: + $ref: '#/paths/~1notifications~1threads~1{thread_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '205' + mark_thread_as_done: + operation: + $ref: '#/paths/~1notifications~1threads~1{thread_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_repo_notifications_for_authenticated_user: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1notifications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + mark_repo_notifications_as_read: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1notifications/put' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notifications/methods/list_repo_notifications_for_authenticated_user + - $ref: '#/components/x-stackQL-resources/notifications/methods/get_thread' + - $ref: >- + #/components/x-stackQL-resources/notifications/methods/list_notifications_for_authenticated_user + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/notifications/methods/mark_thread_as_read + delete: + - $ref: >- + #/components/x-stackQL-resources/notifications/methods/mark_thread_as_done + replace: [] + notifications_thread_subscriptions: + id: github.activity.notifications_thread_subscriptions + name: notifications_thread_subscriptions + title: Notifications Thread Subscriptions + methods: + get_thread_subscription_for_authenticated_user: + operation: + $ref: '#/paths/~1notifications~1threads~1{thread_id}~1subscription/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_thread_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1notifications~1threads~1{thread_id}~1subscription/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_thread_subscription: + operation: + $ref: '#/paths/~1notifications~1threads~1{thread_id}~1subscription/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/notifications_thread_subscriptions/methods/get_thread_subscription_for_authenticated_user + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/notifications_thread_subscriptions/methods/delete_thread_subscription + replace: + - $ref: >- + #/components/x-stackQL-resources/notifications_thread_subscriptions/methods/set_thread_subscription + events: + id: github.activity.events + name: events + title: Events + methods: + list_repo_events: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_events_for_authenticated_user: + operation: + $ref: '#/paths/~1users~1{username}~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_org_events_for_authenticated_user: + operation: + $ref: '#/paths/~1users~1{username}~1events~1orgs~1{org}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/list_repo_events' + - $ref: >- + #/components/x-stackQL-resources/events/methods/list_org_events_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/events/methods/list_events_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + repo_stargazers: + id: github.activity.repo_stargazers + name: repo_stargazers + title: Repo Stargazers + methods: + list_stargazers_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1stargazers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_stargazers/methods/list_stargazers_for_repo + insert: [] + update: [] + delete: [] + replace: [] + repo_watchers: + id: github.activity.repo_watchers + name: repo_watchers + title: Repo Watchers + methods: + list_watchers_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1subscribers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_watchers/methods/list_watchers_for_repo + insert: [] + update: [] + delete: [] + replace: [] + repo_subscriptions: + id: github.activity.repo_subscriptions + name: repo_subscriptions + title: Repo Subscriptions + methods: + get_repo_subscription: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1subscription/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_repo_subscription: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1subscription/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_repo_subscription: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1subscription/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_subscriptions/methods/get_repo_subscription + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repo_subscriptions/methods/delete_repo_subscription + replace: + - $ref: >- + #/components/x-stackQL-resources/repo_subscriptions/methods/set_repo_subscription + starring: + id: github.activity.starring + name: starring + title: Starring + methods: + list_repos_starred_by_authenticated_user: + operation: + $ref: '#/paths/~1user~1starred/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_repo_is_starred_by_authenticated_user: + operation: + $ref: '#/paths/~1user~1starred~1{owner}~1{repo}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + star_repo_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1starred~1{owner}~1{repo}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unstar_repo_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1starred~1{owner}~1{repo}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_repos_starred_by_user: + operation: + $ref: '#/paths/~1users~1{username}~1starred/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/starring/methods/list_repos_starred_by_user + - $ref: >- + #/components/x-stackQL-resources/starring/methods/list_repos_starred_by_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + watching: + id: github.activity.watching + name: watching + title: Watching + methods: + list_watched_repos_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_repos_watched_by_user: + operation: + $ref: '#/paths/~1users~1{username}~1subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/watching/methods/list_repos_watched_by_user + - $ref: >- + #/components/x-stackQL-resources/watching/methods/list_watched_repos_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + received_events: + id: github.activity.received_events + name: received_events + title: Received Events + methods: + list_received_events_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1received_events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/received_events/methods/list_received_events_for_user + insert: [] + update: [] + delete: [] + replace: [] + received_public_events: + id: github.activity.received_public_events + name: received_public_events + title: Received Public Events + methods: + list_received_public_events_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1received_events~1public/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/received_public_events/methods/list_received_public_events_for_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/agent_tasks.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/agent_tasks.yaml new file mode 100644 index 0000000..66179d3 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/agent_tasks.yaml @@ -0,0 +1,2680 @@ +openapi: 3.0.3 +info: + title: agent_tasks API + description: github API + version: 1.1.4 +paths: + /agents/repos/{owner}/{repo}/tasks: + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: >- + Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, + `idle`, `waiting_for_user`, `timed_out`, `cancelled`. + - name: is_archived + in: query + schema: + type: boolean + default: false + description: >- + Filter by archived status. When `true`, returns only archived tasks. + When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: > + Pagination links. Contains rel="first" (always), + + rel="prev" (when current page > 1), + + rel="next" (when more pages exist), and rel="last" (when on the + final page). + schema: + type: string + example: >- + ; + rel="next", + ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: >- + Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: > + Type of artifact. Available Values: `pull`, + `branch`. + data: + oneOf: + - type: object + description: >- + A GitHub resource (pull request, issue, + etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: >- + Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: >- + https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: >- + https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + post: + summary: Create a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new task for a repository. + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + description: The user's prompt for the agent + model: + type: string + description: >- + The model to use for this task. The allowed models may + change over time and depend on the user's GitHub Copilot + plan and organization policies. Currently supported values: + `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, + `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, + `claude-opus-4.5` + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: >- + Current state of the task, derived from its most recent + session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: > + Type of artifact. Available Values: `pull`, + `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: >- + https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: >- + https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + /agents/repos/{owner}/{repo}/tasks/{task_id}: + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: >- + Current state of the task, derived from its most recent + session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: > + Type of artifact. Available Values: `pull`, + `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: >- + https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: >- + https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + prompt: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + model: claude-sonnet-4.6 + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + /agents/tasks: + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: >- + Comma-separated list of task states to filter by. Can be any + combination of: `queued`, `in_progress`, `completed`, `failed`, + `idle`, `waiting_for_user`, `timed_out`, `cancelled`. + - name: is_archived + in: query + schema: + type: boolean + default: false + description: >- + Filter by archived status. When `true`, returns only archived tasks. + When `false` or omitted, returns only non-archived tasks. Defaults + to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: > + Pagination links. Contains rel="first" (always), + + rel="next" (when more pages exist), and rel="last" (when on the + final page). + schema: + type: string + example: >- + ; + rel="next", + ; + rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: >- + Current state of the task, derived from its most + recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: > + Type of artifact. Available Values: `pull`, + `branch`. + data: + oneOf: + - type: object + description: >- + A GitHub resource (pull request, issue, + etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: >- + Timestamp when the task was archived, null if not + archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + /agents/tasks/{task_id}: + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: >- + Current state of the task, derived from its most recent + session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: > + Type of artifact. Available Values: `pull`, + `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: >- + https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: >- + https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + prompt: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + model: claude-sonnet-4.6 + '400': + description: Problems parsing request + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: >- + Structured error response following GitHub REST API + conventions. + + For 422 Unprocessable Entity the errors array contains + validation + + details; for other error status codes only message and + + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: >- + Human-readable message (populated when code is + "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks +components: + x-stackQL-resources: + repo_tasks: + id: github.agent_tasks.repo_tasks + name: repo_tasks + title: Repo Tasks + methods: + list_tasks_for_repo: + operation: + $ref: '#/paths/~1agents~1repos~1{owner}~1{repo}~1tasks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_task: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1agents~1repos~1{owner}~1{repo}~1tasks/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_task_by_repo_and_id: + operation: + $ref: '#/paths/~1agents~1repos~1{owner}~1{repo}~1tasks~1{task_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_tasks/methods/get_task_by_repo_and_id + - $ref: >- + #/components/x-stackQL-resources/repo_tasks/methods/list_tasks_for_repo + insert: + - $ref: '#/components/x-stackQL-resources/repo_tasks/methods/create_task' + update: [] + delete: [] + replace: [] + tasks: + id: github.agent_tasks.tasks + name: tasks + title: Tasks + methods: + list_tasks: + operation: + $ref: '#/paths/~1agents~1tasks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_task_by_id: + operation: + $ref: '#/paths/~1agents~1tasks~1{task_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sessions + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tasks/methods/get_task_by_id' + - $ref: '#/components/x-stackQL-resources/tasks/methods/list_tasks' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/apps.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/apps.yaml new file mode 100644 index 0000000..5b9b31b --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/apps.yaml @@ -0,0 +1,7668 @@ +openapi: 3.0.3 +info: + title: apps API + description: Information for integrations and installations. + version: 1.1.4 +paths: + /app: + get: + summary: Get the authenticated app + description: >- + Returns the GitHub App associated with the authentication credentials + used. To see how many app installations are associated with this GitHub + App, see the `installations_count` in the response. For more details + about your app's installations, see the "[List installations for the + authenticated + app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" + endpoint. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-the-authenticated-app + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app-manifests/{code}/conversions: + post: + summary: Create a GitHub App from a manifest + description: >- + Use this endpoint to complete the handshake necessary when implementing + the [GitHub App Manifest + flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). + When you create a GitHub App with the manifest flow, you receive a + temporary `code` used to retrieve the GitHub App's `id`, `pem` (private + key), and `webhook_secret`. + tags: + - apps + operationId: apps/create-from-manifest + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest + parameters: + - name: code + in: path + required: true + schema: + type: string + responses: + '201': + description: Response + content: + application/json: + schema: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and + granted access to specific repositories. They come with + granular permissions and built-in webhooks. GitHub apps are + first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: >- + https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: >- + https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` + events are not included because they are global events and + not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub + app. Only returned when the integration is requesting + details about itself. + example: 5 + type: integer + client_secret: + type: string + webhook_secret: + type: string + nullable: true + pem: + type: string + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + - client_id + - client_secret + - webhook_secret + - pem + additionalProperties: true + examples: + default: + $ref: '#/components/examples/integration-from-manifest' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/hook/config: + get: + summary: Get a webhook configuration for an app + description: >- + Returns the webhook configuration for a GitHub App. For more information + about configuring a webhook for your app, see "[Creating a GitHub + App](/developers/apps/creating-a-github-app)." + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-webhook-config-for-app + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a webhook configuration for an app + description: >- + Updates the webhook configuration for a GitHub App. For more information + about configuring a webhook for your app, see "[Creating a GitHub + App](/developers/apps/creating-a-github-app)." + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/update-webhook-config-for-app + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + examples: + default: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/hook/deliveries: + get: + summary: List deliveries for an app webhook + description: >- + Returns a list of webhook deliveries for the webhook configured for a + GitHub App. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/list-webhook-deliveries + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/cursor' + - $ref: '#/components/parameters/webhook-delivery-status' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook-delivery-item' + examples: + default: + $ref: '#/components/examples/hook-delivery-items' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/hook/deliveries/{delivery_id}: + get: + summary: Get a delivery for an app webhook + description: >- + Returns a delivery for the webhook configured for a GitHub App. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-webhook-delivery + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook + parameters: + - $ref: '#/components/parameters/delivery-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook-delivery' + examples: + default: + $ref: '#/components/examples/hook-delivery' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/hook/deliveries/{delivery_id}/attempts: + post: + summary: Redeliver a delivery for an app webhook + description: >- + Redeliver a delivery for the webhook configured for a GitHub App. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/redeliver-webhook-delivery + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook + parameters: + - $ref: '#/components/parameters/delivery-id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/installation-requests: + get: + summary: List installation requests for the authenticated app + description: >- + Lists all the pending installation requests for the authenticated GitHub + App. + tags: + - apps + operationId: apps/list-installation-requests-for-authenticated-app + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: List of integration installation requests + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration-installation-request' + examples: + exampleKey1: + $ref: >- + #/components/examples/integration-installation-request-paginated + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/installations: + get: + summary: List installations for the authenticated app + description: >- + The permissions the installation has are included under the + `permissions` key. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/list-installations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/since' + - name: outdated + in: query + required: false + schema: + type: string + responses: + '200': + description: >- + The permissions the installation has are included under the + `permissions` key. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/base-installation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/installations/{installation_id}: + get: + summary: Get an installation for the authenticated app + description: >- + Enables an authenticated GitHub App to find an installation's + information using the installation id. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-installation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/base-installation' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + delete: + summary: Delete an installation for the authenticated app + description: >- + Uninstalls a GitHub App on a user, organization, or enterprise account. + If you prefer to temporarily suspend an app's access to your account's + resources, then we recommend the "[Suspend an app + installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" + endpoint. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/delete-installation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-github-breaking-changes: + - changeset: change_delete_installation_success_status + patch: + responses: + '202': + description: Response + '204': null + version: '2026-03-10' + x-stackQL-resource: apps + /app/installations/{installation_id}/access_tokens: + post: + summary: Create an installation access token for an app + description: >- + Creates an installation access token that enables a GitHub App to make + authenticated API requests for the app's installation on an organization + or individual account. Installation tokens expire one hour from the time + you create them. Using an expired token produces a status code of `401 - + Unauthorized`, and requires creating a new installation token. By + default the installation token has access to all repositories that the + installation can access. + + + Optionally, you can use the `repositories` or `repository_ids` body + parameters to specify individual repositories that the installation + access token can access. If you don't use `repositories` or + `repository_ids` to grant access to specific repositories, the + installation access token will have access to all repositories that the + installation was granted access to. The installation access token cannot + be granted access to repositories that the installation was not granted + access to. Up to 500 repositories can be listed in this manner. + + + Optionally, use the `permissions` body parameter to specify the + permissions that the installation access token should have. If + `permissions` is not specified, the installation access token will have + all of the permissions that were granted to the app. The installation + access token cannot be granted permissions that the app was not granted. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/create-installation-access-token + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app + parameters: + - $ref: '#/components/parameters/installation-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + repositories: + description: >- + List of repository names that the token should have access + to + type: array + items: + type: string + example: rails + repository_ids: + description: List of repository IDs that the token should have access to + example: + - 1 + type: array + items: + type: integer + permissions: + $ref: '#/components/schemas/app-permissions' + examples: + default: + value: + repositories: + - Hello-World + permissions: + issues: write + contents: read + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation-token' + examples: + default: + $ref: '#/components/examples/installation-token' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/installations/{installation_id}/suspended: + put: + summary: Suspend an app installation + description: >- + Suspends a GitHub App on a user, organization, or enterprise account, + which blocks the app from accessing the account's resources. When a + GitHub App is suspended, the app's access to the GitHub API or webhook + events is blocked for that account. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/suspend-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#suspend-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + delete: + summary: Unsuspend an app installation + description: >- + Removes a GitHub App installation suspension. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/unsuspend-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /applications/{client_id}/grant: + delete: + summary: Delete an app authorization + description: >- + OAuth and GitHub application owners can revoke a grant for their + application and a specific user. You must provide a valid OAuth + `access_token` as an input parameter and the grant for the token's owner + will be deleted. + + Deleting an application's grant will also delete all OAuth tokens + associated with the application for the user. Once deleted, the + application will have no access to the user's account and will no longer + be listed on [the application authorizations settings screen within + GitHub](https://github.com/settings/applications#authorized). + operationId: apps/delete-authorization + tags: + - apps + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + description: >- + The OAuth access token used to authenticate to the GitHub + API. + required: + - access_token + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + /applications/{client_id}/token: + post: + summary: Check a token + description: >- + OAuth applications and GitHub applications with OAuth authorizations can + use this API method for checking OAuth token validity without exceeding + the normal rate limits for failed login attempts. Authentication works + differently with this particular endpoint. Invalid tokens will return + `404 NOT FOUND`. + tags: + - apps + operationId: apps/check-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/oauth-applications#check-a-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + access_token: + description: The access_token of the OAuth or GitHub application. + type: string + required: + - access_token + type: object + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authorization' + examples: + default: + $ref: '#/components/examples/authorization-with-user' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + patch: + summary: Reset a token + description: >- + OAuth applications and GitHub applications with OAuth authorizations can + use this API method to reset a valid OAuth token without end-user + involvement. Applications must save the "token" property in the response + because changes take effect immediately. Invalid tokens will return `404 + NOT FOUND`. + tags: + - apps + operationId: apps/reset-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/oauth-applications#reset-a-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + access_token: + description: The access_token of the OAuth or GitHub application. + type: string + required: + - access_token + type: object + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authorization' + examples: + default: + $ref: '#/components/examples/authorization-with-user' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + delete: + summary: Delete an app token + description: >- + OAuth or GitHub application owners can revoke a single token for an + OAuth application or a GitHub application with an OAuth authorization. + tags: + - apps + operationId: apps/delete-token + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + description: >- + The OAuth access token used to authenticate to the GitHub + API. + required: + - access_token + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + /applications/{client_id}/token/scoped: + post: + summary: Create a scoped access token + description: >- + Use a non-scoped user access token to create a repository-scoped and/or + permission-scoped user access token. You can specify + + which repositories the token can access and which permissions are + granted to the + + token. + + + Invalid tokens will return `404 NOT FOUND`. + tags: + - apps + operationId: apps/scope-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#create-a-scoped-access-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + description: The access token used to authenticate to the GitHub API. + example: e72e16c7e42f292c6912e7710c838347ae178b4a + target: + description: >- + The name of the user or organization to scope the user + access token to. **Required** unless `target_id` is + specified. + type: string + example: octocat + target_id: + description: >- + The ID of the user or organization to scope the user access + token to. **Required** unless `target` is specified. + example: 1 + type: integer + repositories: + description: >- + The list of repository names to scope the user access token + to. `repositories` may not be specified if `repository_ids` + is specified. + type: array + items: + type: string + example: rails + repository_ids: + description: >- + The list of repository IDs to scope the user access token + to. `repository_ids` may not be specified if `repositories` + is specified. + example: + - 1 + type: array + items: + type: integer + permissions: + $ref: '#/components/schemas/app-permissions' + required: + - access_token + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + target: octocat + permissions: + metadata: read + issues: write + contents: read + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authorization' + examples: + default: + $ref: '#/components/examples/scope-token' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /apps/{app_slug}: + get: + summary: Get an app + description: >- + > [!NOTE] + + > The `:app_slug` is just the URL-friendly name of your GitHub App. You + can find this on the settings page for your GitHub App (e.g., + `https://github.com/settings/apps/:app_slug`). + tags: + - apps + operationId: apps/get-by-slug + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-an-app + parameters: + - $ref: '#/components/parameters/app-slug' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /installation/repositories: + get: + summary: List repositories accessible to the app installation + description: List repositories that an app installation can access. + tags: + - apps + operationId: apps/list-repos-accessible-to-installation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is + calculated hourly. When a repository is initially + created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can + be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: + all or collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: >- + The repository visibility: public, private, or + internal. + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: >- + Whether to allow Auto-merge to be used on pull + requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: >- + Whether to delete head branches when pull requests + are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is + behind its base branch can always be updated even if + it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull + request title as default. **This property is closing + down. Please use `squash_merge_commit_title` + instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's + title (if only one commit) or the pull request's + title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: >- + The default value for a squash merge commit message: + + + - `PR_BODY` - default to the pull request's body. + + - `COMMIT_MESSAGES` - default to the branch's commit + messages. + + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for + a merge message (e.g., Merge pull request #123 from + branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: >- + Whether to require contributors to sign off on + web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: >- + Whether anonymous git access is enabled for this + repository + code_search_index_status: + type: object + description: >- + The status of the code search index for this + repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + repository_selection: + type: string + example: selected + examples: + default: + $ref: '#/components/examples/repository-paginated-2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: installations + x-stackQL-resource: installations + /installation/token: + delete: + summary: Revoke an installation access token + description: >- + Revokes the installation token you're using to authenticate as an + installation and access this endpoint. + + + Once an installation token is revoked, the token is invalidated and + cannot be used. Other endpoints that require the revoked installation + token must have a new installation token to work. You can create a new + token using the "[Create an installation access token for an + app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" + endpoint. + tags: + - apps + operationId: apps/revoke-installation-access-token + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token + parameters: [] + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: installations + x-stackQL-resource: installations + /marketplace_listing/accounts/{account_id}: + get: + summary: Get a subscription plan for an account + description: >- + Shows whether the user or organization account actively subscribes to a + plan listed by the authenticated GitHub App. When someone submits a plan + change that won't be processed until the end of their billing cycle, you + will also see the upcoming pending change. + + + GitHub Apps must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. OAuth apps must use [basic + authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/get-subscription-plan-for-account + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account + parameters: + - $ref: '#/components/parameters/account-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + description: Not Found when the account has not purchased the listing + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/plans: + get: + summary: List plans + description: >- + Lists all plans that are part of your GitHub Marketplace listing. + + + GitHub Apps must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. OAuth apps must use [basic + authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-plans + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-plans + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-listing-plan' + examples: + default: + $ref: '#/components/examples/marketplace-listing-plan-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/plans/{plan_id}/accounts: + get: + summary: List accounts for a plan + description: >- + Returns user and organization accounts associated with the specified + plan, including free plans. For per-seat pricing, you see the list of + accounts that have purchased the plan, including the number of seats + purchased. When someone submits a plan change that won't be processed + until the end of their billing cycle, you will also see the upcoming + pending change. + + + GitHub Apps must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. OAuth apps must use [basic + authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-accounts-for-plan + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan + parameters: + - $ref: '#/components/parameters/plan-id' + - $ref: '#/components/parameters/sort' + - name: direction + description: >- + To return the oldest accounts first, set to `asc`. Ignored without + the `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/stubbed/accounts/{account_id}: + get: + summary: Get a subscription plan for an account (stubbed) + description: >- + Shows whether the user or organization account actively subscribes to a + plan listed by the authenticated GitHub App. When someone submits a plan + change that won't be processed until the end of their billing cycle, you + will also see the upcoming pending change. + + + GitHub Apps must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. OAuth apps must use [basic + authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/get-subscription-plan-for-account-stubbed + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed + parameters: + - $ref: '#/components/parameters/account-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + description: Not Found when the account has not purchased the listing + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/stubbed/plans: + get: + summary: List plans (stubbed) + description: >- + Lists all plans that are part of your GitHub Marketplace listing. + + + GitHub Apps must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. OAuth apps must use [basic + authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-plans-stubbed + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-plans-stubbed + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-listing-plan' + examples: + default: + $ref: '#/components/examples/marketplace-listing-plan-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/stubbed/plans/{plan_id}/accounts: + get: + summary: List accounts for a plan (stubbed) + description: >- + Returns repository and organization accounts associated with the + specified plan, including free plans. For per-seat pricing, you see the + list of accounts that have purchased the plan, including the number of + seats purchased. When someone submits a plan change that won't be + processed until the end of their billing cycle, you will also see the + upcoming pending change. + + + GitHub Apps must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. OAuth apps must use [basic + authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) + with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-accounts-for-plan-stubbed + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed + parameters: + - $ref: '#/components/parameters/plan-id' + - $ref: '#/components/parameters/sort' + - name: direction + description: >- + To return the oldest accounts first, set to `asc`. Ignored without + the `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /orgs/{org}/installation: + get: + summary: Get an organization installation for the authenticated app + description: >- + Enables an authenticated GitHub App to find the organization's + installation information. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-org-installation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /repos/{owner}/{repo}/installation: + get: + summary: Get a repository installation for the authenticated app + description: >- + Enables an authenticated GitHub App to find the repository's + installation information. The installation's account type will be either + an organization or a user account, depending which account the + repository belongs to. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-repo-installation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /user/installations: + get: + summary: List app installations accessible to the user access token + description: >- + Lists installations of your GitHub App that the authenticated user has + explicit permission (`:read`, `:write`, or `:admin`) to access. + + + The authenticated user has explicit permission to access repositories + they own, repositories where they are a collaborator, and repositories + that they can access through an organization membership. + + + You can find the permissions for the installation under the + `permissions` key. + tags: + - apps + operationId: apps/list-installations-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: >- + You can find the permissions for the installation under the + `permissions` key. + content: + application/json: + schema: + type: object + required: + - total_count + - installations + properties: + total_count: + type: integer + installations: + type: array + items: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: >- + #/components/examples/base-installation-for-auth-user-paginated + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + /user/installations/{installation_id}/repositories: + get: + summary: List repositories accessible to the user access token + description: >- + List repositories that the authenticated user has explicit permission + (`:read`, `:write`, or `:admin`) to access for an installation. + + + The authenticated user has explicit permission to access repositories + they own, repositories where they are a collaborator, and repositories + that they can access through an organization membership. + + + The access the user has to each repository is included in the hash under + the `permissions` key. + tags: + - apps + operationId: apps/list-installation-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token + parameters: + - $ref: '#/components/parameters/installation-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: >- + The access the user has to each repository is included in the hash + under the `permissions` key. + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repository_selection: + type: string + repositories: + type: array + items: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: >- + http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is + calculated hourly. When a repository is initially + created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can + be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: + all or collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: >- + The repository visibility: public, private, or + internal. + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: >- + Whether to allow Auto-merge to be used on pull + requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: >- + Whether to delete head branches when pull requests + are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is + behind its base branch can always be updated even if + it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull + request title as default. **This property is closing + down. Please use `squash_merge_commit_title` + instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's + title (if only one commit) or the pull request's + title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: >- + The default value for a squash merge commit message: + + + - `PR_BODY` - default to the pull request's body. + + - `COMMIT_MESSAGES` - default to the branch's commit + messages. + + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for + a merge message (e.g., Merge pull request #123 from + branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: >- + Whether to require contributors to sign off on + web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: >- + Whether anonymous git access is enabled for this + repository + code_search_index_status: + type: object + description: >- + The status of the code search index for this + repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + examples: + default: + $ref: '#/components/examples/repository-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + /user/installations/{installation_id}/repositories/{repository_id}: + put: + summary: Add a repository to an app installation + description: >- + Add a single repository to an installation. The authenticated user must + have admin access to the repository. + + + This endpoint only works for PATs (classic) with the `repo` scope. + tags: + - apps + operationId: apps/add-repo-to-installation-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + delete: + summary: Remove a repository from an app installation + description: >- + Remove a single repository from an installation. The authenticated user + must have admin access to the repository. The installation must have the + `repository_selection` of `selected`. + + + This endpoint only works for PATs (classic) with the `repo` scope. + tags: + - apps + operationId: apps/remove-repo-from-installation-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: >- + Returned when the application is installed on `all` repositories in + the organization, or if this request would remove the last + repository that the application has access to in the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + /user/marketplace_purchases: + get: + summary: List subscriptions for the authenticated user + description: Lists the active subscriptions for the authenticated user. + tags: + - apps + operationId: apps/list-subscriptions-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/user-marketplace-purchase' + examples: + default: + $ref: '#/components/examples/user-marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /user/marketplace_purchases/stubbed: + get: + summary: List subscriptions for the authenticated user (stubbed) + description: Lists the active subscriptions for the authenticated user. + tags: + - apps + operationId: apps/list-subscriptions-for-authenticated-user-stubbed + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/user-marketplace-purchase' + examples: + default: + $ref: '#/components/examples/user-marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /users/{username}/installation: + get: + summary: Get a user installation for the authenticated app + description: >- + Enables an authenticated GitHub App to find the user’s installation + information. + + + You must use a + [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) + to access this endpoint. + tags: + - apps + operationId: apps/get-user-installation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps +components: + schemas: + integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + webhook-config: + title: Webhook Configuration + description: Configuration object of the webhook + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + webhook-config-url: + type: string + description: The URL to which the payloads will be delivered. + example: https://example.com/webhook + format: uri + webhook-config-content-type: + type: string + description: >- + The media type used to serialize the payloads. Supported values include + `json` and `form`. The default is `form`. + example: '"json"' + webhook-config-secret: + type: string + description: >- + If provided, the `secret` will be used as the `key` to generate the HMAC + hex digest value for [delivery signature + headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + example: '"********"' + webhook-config-insecure-ssl: + type: string + description: >- + Determines whether the SSL certificate of the host for `url` will be + verified when delivering payloads. Supported values include `0` + (verification is performed) and `1` (verification is not performed). The + default is `0`. **We strongly recommend not setting this to `1` as you + are subject to man-in-the-middle and other attacks.** + example: '"0"' + hook-delivery-item: + title: Simple webhook delivery + description: Delivery made by a webhook, without request and response information. + type: object + properties: + id: + description: Unique identifier of the webhook delivery. + type: integer + format: int64 + example: 42 + guid: + description: >- + Unique identifier for the event (shared with all deliveries for all + webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + hook-delivery: + title: Webhook delivery + description: Delivery made by a webhook. + type: object + properties: + id: + description: Unique identifier of the delivery. + type: integer + example: 42 + guid: + description: >- + Unique identifier for the event (shared with all deliveries for all + webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Description of the status of the attempted delivery + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + url: + description: The URL target of the delivery. + type: string + example: https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: object + nullable: true + additionalProperties: true + payload: + description: The webhook payload. + type: object + nullable: true + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: object + nullable: true + additionalProperties: true + payload: + description: The response payload received. + type: string + nullable: true + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + integration-installation-request: + title: Integration Installation Request + description: Request to install an integration on a target + type: object + properties: + id: + description: Unique identifier of the request installation. + type: integer + example: 42 + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + account: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + requester: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-07-08T16:18:44-04:00' + required: + - id + - account + - requester + - created_at + installation: + title: Installation + description: Installation + type: object + properties: + id: + description: The ID of the installation. + type: integer + example: 1 + account: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + repository_selection: + description: >- + Describe whether all repositories have been selected or there's a + selection involved + type: string + enum: + - all + - selected + access_tokens_url: + type: string + format: uri + example: https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + example: https://api.github.com/installation/repositories + html_url: + type: string + format: uri + example: https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + example: 1 + client_id: + type: string + example: Iv1.ab1112223334445c + target_id: + description: The ID of the user or organization this token is being scoped to. + type: integer + target_type: + type: string + example: Organization + permissions: + $ref: '#/components/schemas/app-permissions' + events: + type: array + items: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + single_file_name: + type: string + example: config.yaml + nullable: true + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: + type: string + example: github-actions + suspended_by: + $ref: '#/components/schemas/nullable-simple-user' + suspended_at: + type: string + format: date-time + nullable: true + contact_email: + type: string + example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + nullable: true + required: + - id + - app_id + - app_slug + - target_id + - target_type + - single_file_name + - repository_selection + - access_tokens_url + - html_url + - repositories_url + - events + - account + - permissions + - created_at + - updated_at + - suspended_by + - suspended_at + app-permissions: + title: App Permissions + type: object + description: The permissions granted to the user access token. + properties: + actions: + type: string + description: >- + The level of permission to grant the access token for GitHub Actions + workflows, workflow runs, and artifacts. + enum: + - read + - write + administration: + type: string + description: >- + The level of permission to grant the access token for repository + creation, deletion, settings, teams, and collaborators creation. + enum: + - read + - write + artifact_metadata: + type: string + description: >- + The level of permission to grant the access token to create and + retrieve build artifact metadata records. + enum: + - read + - write + attestations: + type: string + description: >- + The level of permission to create and retrieve the access token for + repository attestations. + enum: + - read + - write + checks: + type: string + description: >- + The level of permission to grant the access token for checks on + code. + enum: + - read + - write + codespaces: + type: string + description: >- + The level of permission to grant the access token to create, edit, + delete, and list Codespaces. + enum: + - read + - write + contents: + type: string + description: >- + The level of permission to grant the access token for repository + contents, commits, branches, downloads, releases, and merges. + enum: + - read + - write + dependabot_secrets: + type: string + description: >- + The level of permission to grant the access token to manage + Dependabot secrets. + enum: + - read + - write + deployments: + type: string + description: >- + The level of permission to grant the access token for deployments + and deployment statuses. + enum: + - read + - write + discussions: + type: string + description: >- + The level of permission to grant the access token for discussions + and related comments and labels. + enum: + - read + - write + environments: + type: string + description: >- + The level of permission to grant the access token for managing + repository environments. + enum: + - read + - write + issues: + type: string + description: >- + The level of permission to grant the access token for issues and + related comments, assignees, labels, and milestones. + enum: + - read + - write + merge_queues: + type: string + description: >- + The level of permission to grant the access token to manage the + merge queues for a repository. + enum: + - read + - write + metadata: + type: string + description: >- + The level of permission to grant the access token to search + repositories, list collaborators, and access repository metadata. + enum: + - read + - write + packages: + type: string + description: >- + The level of permission to grant the access token for packages + published to GitHub Packages. + enum: + - read + - write + pages: + type: string + description: >- + The level of permission to grant the access token to retrieve Pages + statuses, configuration, and builds, as well as create new builds. + enum: + - read + - write + pull_requests: + type: string + description: >- + The level of permission to grant the access token for pull requests + and related comments, assignees, labels, milestones, and merges. + enum: + - read + - write + repository_custom_properties: + type: string + description: >- + The level of permission to grant the access token to view and edit + custom properties for a repository, when allowed by the property. + enum: + - read + - write + repository_hooks: + type: string + description: >- + The level of permission to grant the access token to manage the + post-receive hooks for a repository. + enum: + - read + - write + repository_projects: + type: string + description: >- + The level of permission to grant the access token to manage + repository projects, columns, and cards. + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + description: >- + The level of permission to grant the access token to view and manage + secret scanning alerts. + enum: + - read + - write + secrets: + type: string + description: >- + The level of permission to grant the access token to manage + repository secrets. + enum: + - read + - write + security_events: + type: string + description: >- + The level of permission to grant the access token to view and manage + security events like code scanning alerts. + enum: + - read + - write + single_file: + type: string + description: >- + The level of permission to grant the access token to manage just a + single file. + enum: + - read + - write + statuses: + type: string + description: >- + The level of permission to grant the access token for commit + statuses. + enum: + - read + - write + vulnerability_alerts: + type: string + description: >- + The level of permission to grant the access token to manage + Dependabot alerts. + enum: + - read + - write + workflows: + type: string + description: >- + The level of permission to grant the access token to update GitHub + Actions workflow files. + enum: + - write + custom_properties_for_organizations: + type: string + description: >- + The level of permission to grant the access token to view and edit + custom properties for an organization, when allowed by the property. + enum: + - read + - write + members: + type: string + description: >- + The level of permission to grant the access token for organization + teams and members. + enum: + - read + - write + organization_administration: + type: string + description: >- + The level of permission to grant the access token to manage access + to an organization. + enum: + - read + - write + organization_custom_roles: + type: string + description: >- + The level of permission to grant the access token for custom + repository roles management. + enum: + - read + - write + organization_custom_org_roles: + type: string + description: >- + The level of permission to grant the access token for custom + organization roles management. + enum: + - read + - write + organization_custom_properties: + type: string + description: >- + The level of permission to grant the access token for repository + custom properties management at the organization level. + enum: + - read + - write + - admin + organization_copilot_seat_management: + type: string + description: >- + The level of permission to grant the access token for managing + access to GitHub Copilot for members of an organization with a + Copilot Business subscription. This property is in public preview + and is subject to change. + enum: + - write + organization_copilot_agent_settings: + type: string + description: >- + The level of permission to grant the access token to view and manage + Copilot coding agent settings for an organization. + enum: + - read + - write + organization_announcement_banners: + type: string + description: >- + The level of permission to grant the access token to view and manage + announcement banners for an organization. + enum: + - read + - write + organization_events: + type: string + description: >- + The level of permission to grant the access token to view events + triggered by an activity in an organization. + enum: + - read + organization_hooks: + type: string + description: >- + The level of permission to grant the access token to manage the + post-receive hooks for an organization. + enum: + - read + - write + organization_personal_access_tokens: + type: string + description: >- + The level of permission to grant the access token for viewing and + managing fine-grained personal access token requests to an + organization. + enum: + - read + - write + organization_personal_access_token_requests: + type: string + description: >- + The level of permission to grant the access token for viewing and + managing fine-grained personal access tokens that have been approved + by an organization. + enum: + - read + - write + organization_plan: + type: string + description: >- + The level of permission to grant the access token for viewing an + organization's plan. + enum: + - read + organization_projects: + type: string + description: >- + The level of permission to grant the access token to manage + organization projects and projects public preview (where available). + enum: + - read + - write + - admin + organization_packages: + type: string + description: >- + The level of permission to grant the access token for organization + packages published to GitHub Packages. + enum: + - read + - write + organization_secrets: + type: string + description: >- + The level of permission to grant the access token to manage + organization secrets. + enum: + - read + - write + organization_self_hosted_runners: + type: string + description: >- + The level of permission to grant the access token to view and manage + GitHub Actions self-hosted runners available to an organization. + enum: + - read + - write + organization_user_blocking: + type: string + description: >- + The level of permission to grant the access token to view and manage + users blocked by the organization. + enum: + - read + - write + email_addresses: + type: string + description: >- + The level of permission to grant the access token to manage the + email addresses belonging to a user. + enum: + - read + - write + followers: + type: string + description: >- + The level of permission to grant the access token to manage the + followers belonging to a user. + enum: + - read + - write + git_ssh_keys: + type: string + description: >- + The level of permission to grant the access token to manage git SSH + keys. + enum: + - read + - write + gpg_keys: + type: string + description: >- + The level of permission to grant the access token to view and manage + GPG keys belonging to a user. + enum: + - read + - write + interaction_limits: + type: string + description: >- + The level of permission to grant the access token to view and manage + interaction limits on a repository. + enum: + - read + - write + profile: + type: string + description: >- + The level of permission to grant the access token to manage the + profile settings belonging to a user. + enum: + - write + starring: + type: string + description: >- + The level of permission to grant the access token to list and manage + repositories a user is starring. + enum: + - read + - write + enterprise_custom_properties_for_organizations: + type: string + description: >- + The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin + example: + contents: read + issues: read + deployments: write + single_file: read + installation-token: + title: Installation Token + description: Authentication token for a GitHub App installed on a user or org. + type: object + properties: + token: + type: string + expires_at: + type: string + permissions: + $ref: '#/components/schemas/app-permissions' + repository_selection: + type: string + enum: + - all + - selected + repositories: + type: array + items: + $ref: '#/components/schemas/repository' + single_file: + type: string + example: README.md + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + required: + - token + - expires_at + authorization: + title: Authorization + description: >- + The authorization for an OAuth app, GitHub App, or a Personal Access + Token. + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + format: uri + scopes: + description: A list of scopes that this authorization is in. + type: array + items: + type: string + nullable: true + token: + type: string + token_last_eight: + type: string + nullable: true + hashed_token: + type: string + nullable: true + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + note: + type: string + nullable: true + note_url: + type: string + format: uri + nullable: true + updated_at: + type: string + format: date-time + created_at: + type: string + format: date-time + fingerprint: + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + installation: + $ref: '#/components/schemas/nullable-scoped-installation' + expires_at: + type: string + format: date-time + nullable: true + required: + - app + - id + - note + - note_url + - scopes + - token + - hashed_token + - token_last_eight + - fingerprint + - url + - created_at + - updated_at + - expires_at + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + marketplace-purchase: + title: Marketplace Purchase + description: Marketplace Purchase + type: object + properties: + url: + type: string + type: + type: string + id: + type: integer + login: + type: string + organization_billing_email: + type: string + email: + type: string + nullable: true + marketplace_pending_change: + type: object + properties: + is_installed: + type: boolean + effective_date: + type: string + unit_count: + type: integer + nullable: true + id: + type: integer + plan: + $ref: '#/components/schemas/marketplace-listing-plan' + nullable: true + marketplace_purchase: + type: object + properties: + billing_cycle: + type: string + next_billing_date: + type: string + nullable: true + is_installed: + type: boolean + unit_count: + type: integer + nullable: true + on_free_trial: + type: boolean + free_trial_ends_on: + type: string + nullable: true + updated_at: + type: string + plan: + $ref: '#/components/schemas/marketplace-listing-plan' + required: + - url + - id + - type + - login + - marketplace_purchase + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + marketplace-listing-plan: + title: Marketplace Listing Plan + description: Marketplace Listing Plan + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: + type: string + format: uri + example: https://api.github.com/marketplace_listing/plans/1313/accounts + id: + type: integer + example: 1313 + number: + type: integer + example: 3 + name: + type: string + example: Pro + description: + type: string + example: A professional-grade CI solution + monthly_price_in_cents: + type: integer + example: 1099 + yearly_price_in_cents: + type: integer + example: 11870 + price_model: + type: string + enum: + - FREE + - FLAT_RATE + - PER_UNIT + example: FLAT_RATE + has_free_trial: + type: boolean + example: true + unit_name: + type: string + nullable: true + state: + type: string + example: published + bullets: + type: array + items: + type: string + example: + - Up to 25 private repositories + - 11 concurrent builds + required: + - url + - accounts_url + - id + - number + - name + - description + - has_free_trial + - price_model + - unit_name + - monthly_price_in_cents + - state + - yearly_price_in_cents + - bullets + user-marketplace-purchase: + title: User Marketplace Purchase + description: User Marketplace Purchase + type: object + properties: + billing_cycle: + type: string + example: monthly + next_billing_date: + type: string + format: date-time + example: '2017-11-11T00:00:00Z' + nullable: true + unit_count: + type: integer + nullable: true + on_free_trial: + type: boolean + example: true + free_trial_ends_on: + type: string + format: date-time + example: '2017-11-11T00:00:00Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2017-11-02T01:12:12Z' + nullable: true + account: + $ref: '#/components/schemas/marketplace-account' + plan: + $ref: '#/components/schemas/marketplace-listing-plan' + required: + - billing_cycle + - next_billing_date + - unit_count + - updated_at + - on_free_trial + - free_trial_ends_on + - account + - plan + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-scoped-installation: + title: Scoped Installation + type: object + properties: + permissions: + $ref: '#/components/schemas/app-permissions' + repository_selection: + description: >- + Describe whether all repositories have been selected or there's a + selection involved + type: string + enum: + - all + - selected + single_file_name: + type: string + example: config.yaml + nullable: true + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + repositories_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + account: + $ref: '#/components/schemas/simple-user' + required: + - permissions + - repository_selection + - single_file_name + - repositories_url + - account + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + marketplace-account: + title: Marketplace Account + type: object + properties: + url: + type: string + format: uri + id: + type: integer + type: + type: string + node_id: + type: string + login: + type: string + email: + type: string + nullable: true + format: email + organization_billing_email: + type: string + nullable: true + format: email + required: + - url + - id + - type + - login + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + cursor: + name: cursor + description: >- + Used for pagination: the starting delivery from which the page of + deliveries is fetched. Refer to the `link` header for the next and + previous page cursors. + in: query + required: false + schema: + type: string + webhook-delivery-status: + name: status + description: >- + Returns webhook deliveries filtered by delivery outcome classification + based on `status_code` range. A `status` of `success` returns deliveries + with a `status_code` in the 200-399 range (inclusive). A `status` of + `failure` returns deliveries with a `status_code` in the 400-599 range + (inclusive). + in: query + required: false + schema: + type: string + enum: + - success + - failure + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + since: + name: since + description: >- + Only show results that were last updated after the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + installation-id: + name: installation_id + description: The unique identifier of the installation. + in: path + required: true + schema: + type: integer + examples: + default: + value: 1 + client-id: + name: client_id + in: path + required: true + description: The client ID of the GitHub app. + schema: + type: string + examples: + default: + value: Iv1.8a61f9b3a7aba766 + app-slug: + name: app_slug + in: path + required: true + schema: + type: string + account-id: + name: account_id + description: account_id parameter + in: path + required: true + schema: + type: integer + plan-id: + name: plan_id + description: The unique identifier of the plan. + in: path + required: true + schema: + type: integer + sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + integration: + value: + id: 1 + slug: octoapp + client_id: Iv1.ab1112223334445c + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + integration-from-manifest: + value: + id: 1 + slug: octoapp + node_id: MDxOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + client_id: Iv1.8a61f9b3a7aba766 + client_secret: 1726be1638095a19edd134c77bde3aa2ece1e5d8 + webhook_secret: e340154128314309424b7c8e90325147d99fdafa + pem: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM + 9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP + X0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/ + 6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm + oNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma + szdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ + dBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva + KOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo + gDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP + kYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX + NuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd + NBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE + ZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG + J4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv + eDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3 + FI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk + 77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH + Pza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB + 1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c + 57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8 + M5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic + I9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN + 6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK + fgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG + ZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu + -----END RSA PRIVATE KEY----- + webhook-config: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + hook-delivery-items: + value: + - id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: '2019-06-03T00:57:16Z' + - id: 123456789 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-04T00:57:16Z' + redelivery: true + duration: 0.28 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: null + hook-delivery: + value: + id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + url: https://www.example.com + throttled_at: '2019-06-03T00:57:16Z' + request: + headers: + X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + Accept: '*/*' + X-GitHub-Hook-ID: '42' + User-Agent: GitHub-Hookshot/b8c71d8 + X-GitHub-Event: issues + X-GitHub-Hook-Installation-Target-ID: '123' + X-GitHub-Hook-Installation-Target-Type: repository + content-type: application/json + X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + payload: + action: opened + issue: + body: foo + repository: + id: 123 + response: + headers: + Content-Type: text/html;charset=utf-8 + payload: ok + integration-installation-request-paginated: + value: + - id: 25381 + node_id: MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA== + account: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + requester: + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2022-07-08T16:18:44-04:00' + base-installation-items: + value: + - id: 1 + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: selected + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + base-installation: + value: + id: 1 + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: selected + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + installation-token: + value: + token: ghs_16C7e42F292c6912E7710c838347Ae178B4a + expires_at: '2016-07-11T22:14:10Z' + permissions: + issues: write + contents: read + repository_selection: selected + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + authorization-with-user: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + - user + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: Iv1.8a61f9b3a7aba766 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + fingerprint: jklmnop12345678 + expires_at: '2011-09-08T17:26:27Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + scope-token: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: [] + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: Iv1.8a61f9b3a7aba766 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + fingerprint: jklmnop12345678 + expires_at: '2011-09-08T17:26:27Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + installation: + permissions: + metadata: read + issues: write + contents: read + repository_selection: selected + single_file_name: .github/workflow.yml + repositories_url: https://api.github.com/user/repos + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + has_multiple_single_files: false + single_file_paths: [] + repository-paginated-2: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + marketplace-purchase: + value: + url: https://api.github.com/orgs/github + type: Organization + id: 4 + login: github + organization_billing_email: billing@github.com + email: billing@github.com + marketplace_pending_change: + effective_date: '2017-11-11T00:00:00Z' + unit_count: null + id: 77 + plan: + url: https://api.github.com/marketplace_listing/plans/1111 + accounts_url: https://api.github.com/marketplace_listing/plans/1111/accounts + id: 1111 + number: 2 + name: Startup + description: A professional-grade CI solution + monthly_price_in_cents: 699 + yearly_price_in_cents: 7870 + price_model: FLAT_RATE + has_free_trial: true + state: published + unit_name: null + bullets: + - Up to 10 private repositories + - 3 concurrent builds + marketplace_purchase: + billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: null + on_free_trial: true + free_trial_ends_on: '2017-11-11T00:00:00Z' + updated_at: '2017-11-02T01:12:12Z' + plan: + url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + marketplace-listing-plan-items: + value: + - url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + marketplace-purchase-items: + value: + - url: https://api.github.com/orgs/github + type: Organization + id: 4 + login: github + organization_billing_email: billing@github.com + marketplace_pending_change: + effective_date: '2017-11-11T00:00:00Z' + unit_count: null + id: 77 + plan: + url: https://api.github.com/marketplace_listing/plans/1111 + accounts_url: https://api.github.com/marketplace_listing/plans/1111/accounts + id: 1111 + number: 2 + name: Startup + description: A professional-grade CI solution + monthly_price_in_cents: 699 + yearly_price_in_cents: 7870 + price_model: FLAT_RATE + has_free_trial: true + state: published + unit_name: null + bullets: + - Up to 10 private repositories + - 3 concurrent builds + marketplace_purchase: + billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: null + on_free_trial: true + free_trial_ends_on: '2017-11-11T00:00:00Z' + updated_at: '2017-11-02T01:12:12Z' + plan: + url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + installation: + value: + id: 1 + account: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/orgs/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + repository_selection: all + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + client_id: Iv1.ab1112223334445c + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + created_at: '2018-02-09T20:51:14Z' + updated_at: '2018-02-09T20:51:14Z' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: github-actions + suspended_at: null + suspended_by: null + base-installation-for-auth-user-paginated: + value: + total_count: 2 + installations: + - id: 1 + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: all + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + - id: 3 + account: + login: octocat + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: all + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + user-marketplace-purchase-items: + value: + - billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: null + on_free_trial: true + free_trial_ends_on: '2017-11-11T00:00:00Z' + updated_at: '2017-11-02T01:12:12Z' + account: + login: github + id: 4 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + email: null + organization_billing_email: billing@github.com + type: Organization + plan: + url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + integrations: + id: github.apps.integrations + name: integrations + title: Integrations + methods: + get_authenticated: + operation: + $ref: '#/paths/~1app/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_slug: + operation: + $ref: '#/paths/~1apps~1{app_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/integrations/methods/get_by_slug' + - $ref: >- + #/components/x-stackQL-resources/integrations/methods/get_authenticated + insert: [] + update: [] + delete: [] + replace: [] + apps: + id: github.apps.apps + name: apps + title: Apps + methods: + create_from_manifest: + operation: + $ref: '#/paths/~1app-manifests~1{code}~1conversions/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_installations: + operation: + $ref: '#/paths/~1app~1installations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_installation: + operation: + $ref: '#/paths/~1app~1installations~1{installation_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_installation: + operation: + $ref: '#/paths/~1app~1installations~1{installation_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + create_installation_access_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1app~1installations~1{installation_id}~1access_tokens/post + response: + mediaType: application/json + openAPIDocKey: '201' + suspend_installation: + operation: + $ref: '#/paths/~1app~1installations~1{installation_id}~1suspended/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unsuspend_installation: + operation: + $ref: '#/paths/~1app~1installations~1{installation_id}~1suspended/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + scope_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applications~1{client_id}~1token~1scoped/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_installation: + operation: + $ref: '#/paths/~1orgs~1{org}~1installation/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_installation: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1installation/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_user_installation: + operation: + $ref: '#/paths/~1users~1{username}~1installation/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/apps/methods/get_repo_installation + - $ref: '#/components/x-stackQL-resources/apps/methods/get_installation' + - $ref: '#/components/x-stackQL-resources/apps/methods/get_org_installation' + - $ref: >- + #/components/x-stackQL-resources/apps/methods/get_user_installation + - $ref: '#/components/x-stackQL-resources/apps/methods/list_installations' + insert: + - $ref: '#/components/x-stackQL-resources/apps/methods/create_from_manifest' + - $ref: >- + #/components/x-stackQL-resources/apps/methods/create_installation_access_token + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/apps/methods/delete_installation' + replace: [] + webhook_config: + id: github.apps.webhook_config + name: webhook_config + title: Webhook Config + methods: + get_webhook_config_for_app: + operation: + $ref: '#/paths/~1app~1hook~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_webhook_config_for_app: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1app~1hook~1config/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_config/methods/get_webhook_config_for_app + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/webhook_config/methods/update_webhook_config_for_app + delete: [] + replace: [] + webhook_deliveries: + id: github.apps.webhook_deliveries + name: webhook_deliveries + title: Webhook Deliveries + methods: + list_webhook_deliveries: + operation: + $ref: '#/paths/~1app~1hook~1deliveries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_deliveries/methods/list_webhook_deliveries + insert: [] + update: [] + delete: [] + replace: [] + webhook_delivery: + id: github.apps.webhook_delivery + name: webhook_delivery + title: Webhook Delivery + methods: + get_webhook_delivery: + operation: + $ref: '#/paths/~1app~1hook~1deliveries~1{delivery_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + redeliver_webhook_delivery: + operation: + $ref: '#/paths/~1app~1hook~1deliveries~1{delivery_id}~1attempts/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_delivery/methods/get_webhook_delivery + insert: [] + update: [] + delete: [] + replace: [] + integration_installation_requests: + id: github.apps.integration_installation_requests + name: integration_installation_requests + title: Integration Installation Requests + methods: + list_installation_requests_for_authenticated_app: + operation: + $ref: '#/paths/~1app~1installation-requests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/integration_installation_requests/methods/list_installation_requests_for_authenticated_app + insert: [] + update: [] + delete: [] + replace: [] + oauth_grants: + id: github.apps.oauth_grants + name: oauth_grants + title: Oauth Grants + methods: + delete_authorization: + operation: + $ref: '#/paths/~1applications~1{client_id}~1grant/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/oauth_grants/methods/delete_authorization + replace: [] + oauth_applications: + id: github.apps.oauth_applications + name: oauth_applications + title: Oauth Applications + methods: + check_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applications~1{client_id}~1token/post' + response: + mediaType: application/json + openAPIDocKey: '200' + reset_token: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1applications~1{client_id}~1token/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_token: + operation: + $ref: '#/paths/~1applications~1{client_id}~1token/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/oauth_applications/methods/delete_token + replace: [] + installation_repos: + id: github.apps.installation_repos + name: installation_repos + title: Installation Repos + methods: + list_repos_accessible_to_installation: + operation: + $ref: '#/paths/~1installation~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_installation_repos_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1installations~1{installation_id}~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_repo_to_installation_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1installations~1{installation_id}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_repo_from_installation_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1installations~1{installation_id}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/installation_repos/methods/list_installation_repos_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/installation_repos/methods/list_repos_accessible_to_installation + insert: + - $ref: >- + #/components/x-stackQL-resources/installation_repos/methods/add_repo_to_installation_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/installation_repos/methods/remove_repo_from_installation_for_authenticated_user + replace: [] + installations: + id: github.apps.installations + name: installations + title: Installations + methods: + revoke_installation_access_token: + operation: + $ref: '#/paths/~1installation~1token/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_installations_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1installations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/installations/methods/list_installations_for_authenticated_user + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/installations/methods/revoke_installation_access_token + replace: [] + marketplace_subs: + id: github.apps.marketplace_subs + name: marketplace_subs + title: Marketplace Subs + methods: + get_subscription_plan_for_account: + operation: + $ref: '#/paths/~1marketplace_listing~1accounts~1{account_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_accounts_for_plan: + operation: + $ref: '#/paths/~1marketplace_listing~1plans~1{plan_id}~1accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/marketplace_subs/methods/get_subscription_plan_for_account + - $ref: >- + #/components/x-stackQL-resources/marketplace_subs/methods/list_accounts_for_plan + insert: [] + update: [] + delete: [] + replace: [] + marketplace_listings: + id: github.apps.marketplace_listings + name: marketplace_listings + title: Marketplace Listings + methods: + list_plans: + operation: + $ref: '#/paths/~1marketplace_listing~1plans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/marketplace_listings/methods/list_plans + insert: [] + update: [] + delete: [] + replace: [] + marketplace_subs_stubbed: + id: github.apps.marketplace_subs_stubbed + name: marketplace_subs_stubbed + title: Marketplace Subs Stubbed + methods: + get_subscription_plan_for_account_stubbed: + operation: + $ref: '#/paths/~1marketplace_listing~1stubbed~1accounts~1{account_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_accounts_for_plan_stubbed: + operation: + $ref: >- + #/paths/~1marketplace_listing~1stubbed~1plans~1{plan_id}~1accounts/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/marketplace_subs_stubbed/methods/get_subscription_plan_for_account_stubbed + - $ref: >- + #/components/x-stackQL-resources/marketplace_subs_stubbed/methods/list_accounts_for_plan_stubbed + insert: [] + update: [] + delete: [] + replace: [] + marketplace_listings_stubbed: + id: github.apps.marketplace_listings_stubbed + name: marketplace_listings_stubbed + title: Marketplace Listings Stubbed + methods: + list_plans_stubbed: + operation: + $ref: '#/paths/~1marketplace_listing~1stubbed~1plans/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/marketplace_listings_stubbed/methods/list_plans_stubbed + insert: [] + update: [] + delete: [] + replace: [] + marketplace_users_subs: + id: github.apps.marketplace_users_subs + name: marketplace_users_subs + title: Marketplace Users Subs + methods: + list_subscriptions_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1marketplace_purchases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/marketplace_users_subs/methods/list_subscriptions_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + marketplace_users_subs_stubbed: + id: github.apps.marketplace_users_subs_stubbed + name: marketplace_users_subs_stubbed + title: Marketplace Users Subs Stubbed + methods: + list_subscriptions_for_authenticated_user_stubbed: + operation: + $ref: '#/paths/~1user~1marketplace_purchases~1stubbed/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/marketplace_users_subs_stubbed/methods/list_subscriptions_for_authenticated_user_stubbed + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/billing.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/billing.yaml new file mode 100644 index 0000000..80b3e19 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/billing.yaml @@ -0,0 +1,1820 @@ +openapi: 3.0.3 +info: + title: billing API + description: Monitor charges and usage from Actions and Packages. + version: 1.1.4 +paths: + /organizations/{org}/settings/billing/budgets: + get: + summary: Get all budgets for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets all budgets for an organization. The authenticated user must be an + organization admin or billing manager. + + Each page returns up to 10 budgets. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: page + description: The page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + - name: per_page + description: The number of results per page (max 10). + in: query + schema: + type: integer + default: 10 + - name: scope + description: Filter budgets by scope type. + in: query + schema: + type: string + enum: + - enterprise + - organization + - repository + - cost_center + responses: + '200': + $ref: '#/components/responses/get_all_budgets' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + x-stackQL-resource: budgets + /organizations/{org}/settings/billing/budgets/{budget_id}: + get: + summary: Get a budget by ID for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets a budget by ID. The authenticated user must be an organization + admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/budget' + responses: + '200': + $ref: '#/components/responses/budget' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + x-stackQL-resource: budgets + patch: + summary: Update a budget for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Updates an existing budget for an organization. The authenticated user + must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/budget' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: >- + The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: >- + Whether to prevent additional spending once the budget is + exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + description: The type of pricing for the budget + type: string + enum: + - ProductPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: >- + The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: >- + Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + description: The type of pricing for the budget + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_product_sku: + type: string + description: >- + A single product or SKU that will be covered in the + budget + examples: + update-budget: + $ref: '#/components/examples/update-budget' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + budget-not-found: + value: + message: >- + Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: >- + https://docs.github.com/rest/billing/budgets#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: >- + https://docs.github.com/rest/billing/budgets#update-a-budget + '422': + $ref: '#/components/responses/validation_failed' + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: >- + https://docs.github.com/rest/billing/budgets#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: budgets + x-stackQL-resource: budgets + delete: + summary: Delete a budget for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Deletes a budget by ID for an organization. The authenticated user must + be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/budget' + responses: + '200': + $ref: '#/components/responses/delete-budget' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + x-stackQL-resource: budgets + /organizations/{org}/settings/billing/premium_request/usage: + get: + summary: Get billing premium request usage report for an organization + description: >- + Gets a report of premium request usage for an organization. To use this + endpoint, you must be an administrator of an organization within an + enterprise or an organization account. + + + **Note:** Only data from the past 24 months is accessible via this + endpoint. + tags: + - billing + operationId: billing/get-github-billing-premium-request-usage-report-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-user' + - $ref: '#/components/parameters/billing-usage-report-model' + - $ref: '#/components/parameters/billing-usage-report-product' + responses: + '200': + $ref: '#/components/responses/billing_premium_request_usage_report_org' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /organizations/{org}/settings/billing/usage: + get: + summary: Get billing usage report for an organization + description: >- + Gets a report of the total usage for an organization. To use this + endpoint, you must be an administrator of an organization within an + enterprise or an organization account. + + + **Note:** This endpoint is only available to organizations with access + to the enhanced billing platform. For more information, see "[About the + enhanced billing + platform](https://docs.github.com/billing/using-the-new-billing-platform)." + tags: + - billing + operationId: billing/get-github-billing-usage-report-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month' + - $ref: '#/components/parameters/billing-usage-report-day' + responses: + '200': + $ref: '#/components/responses/billing_usage_report_org' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /organizations/{org}/settings/billing/usage/summary: + get: + summary: Get billing usage summary for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets a summary report of usage for an organization. To use this + endpoint, you must be an administrator of an organization within an + enterprise or an organization account. + + + **Note:** Only data from the past 24 months is accessible via this + endpoint. + tags: + - billing + operationId: billing/get-github-billing-usage-summary-report-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-repository' + - $ref: '#/components/parameters/billing-usage-report-product' + - $ref: '#/components/parameters/billing-usage-report-sku' + responses: + '200': + $ref: '#/components/responses/billing_usage_summary_report_org' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /users/{username}/settings/billing/premium_request/usage: + get: + summary: Get billing premium request usage report for a user + description: >- + Gets a report of premium request usage for a user. + + + **Note:** Only data from the past 24 months is accessible via this + endpoint. + tags: + - billing + operationId: billing/get-github-billing-premium-request-usage-report-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-model' + - $ref: '#/components/parameters/billing-usage-report-product' + responses: + '200': + $ref: '#/components/responses/billing_premium_request_usage_report_user' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /users/{username}/settings/billing/usage: + get: + summary: Get billing usage report for a user + description: >- + Gets a report of the total usage for a user. + + + **Note:** This endpoint is only available to users with access to the + enhanced billing platform. + tags: + - billing + operationId: billing/get-github-billing-usage-report-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month' + - $ref: '#/components/parameters/billing-usage-report-day' + responses: + '200': + $ref: '#/components/responses/billing_usage_report_user' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /users/{username}/settings/billing/usage/summary: + get: + summary: Get billing usage summary for a user + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets a summary report of usage for a user. + + + **Note:** Only data from the past 24 months is accessible via this + endpoint. + tags: + - billing + operationId: billing/get-github-billing-usage-summary-report-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-repository' + - $ref: '#/components/parameters/billing-usage-report-product' + - $ref: '#/components/parameters/billing-usage-report-sku' + responses: + '200': + $ref: '#/components/responses/billing_usage_summary_report_user' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage +components: + schemas: + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + $ref: '#/components/schemas/budget' + description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: >- + Indicates if there are more pages of results available (maps to + hasNextPage from billing platform) + total_count: + type: integer + description: Total number of budgets matching the query + required: + - budgets + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: octocat/hello-world + budget_amount: + type: integer + description: >- + The budget amount in whole dollars. For license-based products, this + represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + type: string + enum: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + delete-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the deletion operation + id: + type: string + description: The ID of the deleted budget + required: + - message + - id + billing-premium-request-usage-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + user: + type: string + description: The name of the user for the usage report. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems + billing-usage-report: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + organizationName: + type: string + description: Name of the organization. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + - organizationName + billing-usage-summary-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems + billing-premium-request-usage-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems + billing-usage-report-user: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + billing-usage-summary-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + description: The type of pricing for the budget + example: SkuPricing + type: string + enum: + - SkuPricing + budget_amount: + type: integer + description: >- + The budget amount limit in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + example: true + budget_scope: + type: string + description: >- + The scope of the budget (enterprise, organization, repository, cost + center) + example: enterprise + budget_entity_name: + type: string + description: >- + The name of the entity for the budget (enterprise does not require a + name). + example: octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + responses: + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + $ref: '#/components/schemas/get_all_budgets' + examples: + default: + $ref: '#/components/examples/get_all_budgets' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + budget: + description: Response when updating a budget + content: + application/json: + schema: + $ref: '#/components/schemas/get-budget' + examples: + default: + $ref: '#/components/examples/get-budget' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + $ref: '#/components/schemas/delete-budget' + examples: + default: + $ref: '#/components/examples/delete-budget' + billing_premium_request_usage_report_org: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + $ref: '#/components/schemas/billing-premium-request-usage-report-org' + examples: + default: + $ref: '#/components/examples/billing-premium-request-usage-report-org' + billing_usage_report_org: + description: Billing usage report response for an organization + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-report' + examples: + default: + $ref: '#/components/examples/billing-usage-report' + billing_usage_summary_report_org: + description: Response when getting a billing usage summary + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-summary-report-org' + examples: + default: + $ref: '#/components/examples/billing-usage-summary-report-org' + billing_premium_request_usage_report_user: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + $ref: '#/components/schemas/billing-premium-request-usage-report-user' + examples: + default: + $ref: '#/components/examples/billing-premium-request-usage-report-user' + billing_usage_report_user: + description: Response when getting a billing usage report + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-report-user' + examples: + default: + $ref: '#/components/examples/billing-usage-report-user' + billing_usage_summary_report_user: + description: Response when getting a billing usage summary + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-summary-report-user' + examples: + default: + $ref: '#/components/examples/billing-usage-summary-report-user' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + budget: + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + billing-usage-report-year: + name: year + description: >- + If specified, only return results for a single year. The value of `year` + is an integer with four digits representing a year. For example, `2025`. + Default value is the current year. + in: query + required: false + schema: + type: integer + billing-usage-report-month-default: + name: month + description: >- + If specified, only return results for a single month. The value of + `month` is an integer between `1` and `12`. Default value is the current + month. If no year is specified the default `year` is used. + in: query + required: false + schema: + type: integer + billing-usage-report-day: + name: day + description: >- + If specified, only return results for a single day. The value of `day` + is an integer between `1` and `31`. If no `year` or `month` is + specified, the default `year` and `month` are used. + in: query + required: false + schema: + type: integer + billing-usage-report-user: + name: user + description: The user name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-model: + name: model + description: The model name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-product: + name: product + description: The product name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-month: + name: month + description: >- + If specified, only return results for a single month. The value of + `month` is an integer between `1` and `12`. If no year is specified the + default `year` is used. + in: query + required: false + schema: + type: integer + billing-usage-report-repository: + name: repository + description: The repository name to query for usage in the format owner/repository. + in: query + required: false + schema: + type: string + billing-usage-report-sku: + name: sku + description: The SKU to query for usage. + in: query + required: false + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + has_next_page: false + total_count: 3 + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + delete-budget: + value: + message: Budget successfully deleted. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + billing-premium-request-usage-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 100 + netAmount: 4 + billing-usage-report: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + organizationName: GitHub + repositoryName: github/example + billing-usage-summary-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 1000 + netAmount: 8 + billing-premium-request-usage-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 100 + netAmount: 4 + billing-usage-report-user: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + repositoryName: user/example + billing-usage-summary-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 1000 + netAmount: 8 + x-stackQL-resources: + org_budgets: + id: github.billing.org_budgets + name: org_budgets + title: Org Budgets + methods: + get_all_budgets_org: + operation: + $ref: '#/paths/~1organizations~1{org}~1settings~1billing~1budgets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_budget_org: + operation: + $ref: >- + #/paths/~1organizations~1{org}~1settings~1billing~1budgets~1{budget_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_budget_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1organizations~1{org}~1settings~1billing~1budgets~1{budget_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_budget_org: + operation: + $ref: >- + #/paths/~1organizations~1{org}~1settings~1billing~1budgets~1{budget_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_budgets/methods/get_budget_org + - $ref: >- + #/components/x-stackQL-resources/org_budgets/methods/get_all_budgets_org + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/org_budgets/methods/update_budget_org + delete: + - $ref: >- + #/components/x-stackQL-resources/org_budgets/methods/delete_budget_org + replace: [] + org_premium_request_usage: + id: github.billing.org_premium_request_usage + name: org_premium_request_usage + title: Org Premium Request Usage + methods: + get_github_billing_premium_request_usage_report_org: + operation: + $ref: >- + #/paths/~1organizations~1{org}~1settings~1billing~1premium_request~1usage/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_premium_request_usage/methods/get_github_billing_premium_request_usage_report_org + insert: [] + update: [] + delete: [] + replace: [] + org_usage: + id: github.billing.org_usage + name: org_usage + title: Org Usage + methods: + get_github_billing_usage_report_org: + operation: + $ref: '#/paths/~1organizations~1{org}~1settings~1billing~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.usageItems + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_usage/methods/get_github_billing_usage_report_org + insert: [] + update: [] + delete: [] + replace: [] + org_usage_summary: + id: github.billing.org_usage_summary + name: org_usage_summary + title: Org Usage Summary + methods: + get_github_billing_usage_summary_report_org: + operation: + $ref: >- + #/paths/~1organizations~1{org}~1settings~1billing~1usage~1summary/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_usage_summary/methods/get_github_billing_usage_summary_report_org + insert: [] + update: [] + delete: [] + replace: [] + premium_request_usage: + id: github.billing.premium_request_usage + name: premium_request_usage + title: Premium Request Usage + methods: + get_github_billing_premium_request_usage_report_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1settings~1billing~1premium_request~1usage/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/premium_request_usage/methods/get_github_billing_premium_request_usage_report_user + insert: [] + update: [] + delete: [] + replace: [] + usage: + id: github.billing.usage + name: usage + title: Usage + methods: + get_github_billing_usage_report_user: + operation: + $ref: '#/paths/~1users~1{username}~1settings~1billing~1usage/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.usageItems + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/usage/methods/get_github_billing_usage_report_user + insert: [] + update: [] + delete: [] + replace: [] + usage_summary: + id: github.billing.usage_summary + name: usage_summary + title: Usage Summary + methods: + get_github_billing_usage_summary_report_user: + operation: + $ref: '#/paths/~1users~1{username}~1settings~1billing~1usage~1summary/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/usage_summary/methods/get_github_billing_usage_summary_report_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/campaigns.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/campaigns.yaml new file mode 100644 index 0000000..6898a0b --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/campaigns.yaml @@ -0,0 +1,1036 @@ +openapi: 3.0.3 +info: + title: campaigns API + description: Endpoints to manage campaigns via the REST API. + version: 1.1.4 +paths: + /orgs/{org}/campaigns: + get: + summary: List campaigns for an organization + description: >- + Lists campaigns in an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/list-org-campaigns + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - name: state + description: If specified, only campaigns with this state will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/campaign-state' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - ends_at + - published + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-org-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + post: + summary: Create a campaign for an organization + description: >- + Create a campaign for an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. + + + Fine-grained tokens must have the "Code scanning alerts" repository + permissions (read) on all repositories included + + in the campaign. + tags: + - campaigns + operationId: campaigns/create-campaign + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: >- + The logins of the users to set as the campaign managers. At + this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + description: The login of each manager + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: >- + The end date and time of the campaign. The date must be in + the future. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: string + format: uri + nullable: true + code_scanning_alerts: + description: The code scanning alerts to include in this campaign + type: array + minItems: 1 + items: + type: object + additionalProperties: false + properties: + repository_id: + type: integer + description: The repository id + alert_numbers: + type: array + description: The alert numbers + minItems: 1 + items: + type: integer + required: + - repository_id + - alert_numbers + nullable: true + generate_issues: + description: >- + If true, will automatically generate issues for the + campaign. The default is false. + type: boolean + default: false + required: + - name + - description + - ends_at + - code_scanning_alerts + - secret_scanning_alerts + examples: + default: + value: + name: Critical CodeQL alerts + description: >- + Address critical alerts before they are exploited to prevent + breaches, protect sensitive data, and mitigate financial and + reputational damage. + managers: + - octocat + ends_at: '2024-03-14T00:00:00Z' + code_scanning_alerts: + - repository_id: 1296269 + alert_numbers: + - 1 + - 2 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-summary' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '429': + description: Too Many Requests + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + /orgs/{org}/campaigns/{campaign_number}: + get: + summary: Get a campaign for an organization + description: >- + Gets a campaign for an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/get-campaign-summary + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-summary' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + patch: + summary: Update a campaign + description: >- + Updates a campaign in an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/update-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign + parameters: + - $ref: '#/components/parameters/org' + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: >- + The logins of the users to set as the campaign managers. At + this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: >- + The end date and time of the campaign, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: string + format: uri + nullable: true + state: + $ref: '#/components/schemas/campaign-state' + examples: + default: + value: + name: Critical CodeQL alerts + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-summary' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + delete: + summary: Delete a campaign for an organization + description: >- + Deletes a campaign in an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/delete-campaign + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Deletion successful + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns +components: + schemas: + campaign-state: + title: Campaign state + description: Indicates whether a campaign is open or closed + type: string + enum: + - open + - closed + campaign-summary: + title: Campaign summary + description: The campaign metadata and alert stats. + type: object + properties: + number: + type: integer + description: The number of the newly created campaign + created_at: + type: string + format: date-time + description: >- + The date and time the campaign was created, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: >- + The date and time the campaign was last updated, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + name: + type: string + description: The campaign name + description: + type: string + description: The campaign description + managers: + description: The campaign managers + type: array + items: + $ref: '#/components/schemas/simple-user' + team_managers: + description: The campaign team managers + type: array + items: + $ref: '#/components/schemas/team' + published_at: + description: >- + The date and time the campaign was published, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + ends_at: + description: >- + The date and time the campaign has ended, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + closed_at: + description: >- + The date and time the campaign was closed, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + type: string + format: date-time + nullable: true + state: + $ref: '#/components/schemas/campaign-state' + contact_link: + description: The contact link of the campaign. + type: string + format: uri + nullable: true + alert_stats: + type: object + additionalProperties: false + properties: + open_count: + type: integer + description: The number of open alerts + closed_count: + type: integer + description: The number of closed alerts + in_progress_count: + type: integer + description: The number of in-progress alerts + required: + - open_count + - closed_count + - in_progress_count + required: + - number + - created_at + - updated_at + - description + - managers + - ends_at + - state + - contact_link + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + examples: + campaign-org-items: + value: + - number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: >- + Address critical alerts before they are exploited to prevent + breaches, protect sensitive data, and mitigate financial and + reputational damage. + managers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + ends_at: '2024-03-14T12:29:18Z' + closed_at: null + state: open + - number: 4 + created_at: '2024-03-30T12:29:18Z' + updated_at: '2024-03-30T12:29:18Z' + name: Mitre top 10 KEV + description: >- + Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to + enhance security by addressing vulnerabilities actively exploited by + attackers. This reduces risk, prevents breaches and can help protect + sensitive data. + managers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + ends_at: '2024-04-30T12:29:18Z' + closed_at: null + state: open + campaign-summary: + value: + number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: >- + Address critical alerts before they are exploited to prevent breaches, + protect sensitive data, and mitigate financial and reputational + damage. + managers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + published_at: '2024-02-14T12:29:18Z' + ends_at: '2024-03-14T12:29:18Z' + closed_at: null + state: open + alert_stats: + open_count: 10 + closed_count: 3 + in_progress_count: 3 + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + org_campaigns: + id: github.campaigns.org_campaigns + name: org_campaigns + title: Org Campaigns + methods: + list_org_campaigns: + operation: + $ref: '#/paths/~1orgs~1{org}~1campaigns/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_campaign: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1campaigns/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_campaign_summary: + operation: + $ref: '#/paths/~1orgs~1{org}~1campaigns~1{campaign_number}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_campaign: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1campaigns~1{campaign_number}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_campaign: + operation: + $ref: '#/paths/~1orgs~1{org}~1campaigns~1{campaign_number}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_campaigns/methods/get_campaign_summary + - $ref: >- + #/components/x-stackQL-resources/org_campaigns/methods/list_org_campaigns + insert: + - $ref: >- + #/components/x-stackQL-resources/org_campaigns/methods/create_campaign + update: + - $ref: >- + #/components/x-stackQL-resources/org_campaigns/methods/update_campaign + delete: + - $ref: >- + #/components/x-stackQL-resources/org_campaigns/methods/delete_campaign + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/checks.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/checks.yaml new file mode 100644 index 0000000..8cc56b6 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/checks.yaml @@ -0,0 +1,4101 @@ +openapi: 3.0.3 +info: + title: checks API + description: Rich interactions with checks run by your integrations. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/check-runs: + post: + summary: Create a check run + description: >- + Creates a new check run for a specific commit in a repository. + + + To create a check run, you must use a GitHub App. OAuth apps and + authenticated users are not able to create a check suite. + + + In a check suite, GitHub limits the number of check runs with the same + name to 1000. Once these check runs exceed 1000, GitHub will start to + automatically delete older check runs. + + + > [!NOTE] + + > The Checks API only looks for pushes in the repository where the check + suite or check run were created. Pushes to a branch in a forked + repository are not detected and return an empty `pull_requests` array. + tags: + - checks + operationId: checks/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#create-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the check. For example, "code-coverage". + head_sha: + type: string + description: The SHA of the commit. + details_url: + type: string + description: >- + The URL of the integrator's site that has the full details + of the check. If the integrator does not provide this, then + the homepage of the GitHub app is used. + external_id: + type: string + description: A reference for the run on the integrator's system. + status: + type: string + description: >- + The current status of the check run. Only GitHub Actions can + set a status of `waiting`, `pending`, or `requested`. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + default: queued + started_at: + type: string + format: date-time + description: >- + The time that the check run began. This is a timestamp in + [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + conclusion: + type: string + description: >- + **Required if you provide `completed_at` or a `status` of + `completed`**. The final conclusion of the check. + + **Note:** Providing `conclusion` will automatically set the + `status` parameter to `completed`. You cannot change a check + run conclusion to `stale`, only GitHub can set this. + enum: + - action_required + - cancelled + - failure + - neutral + - success + - skipped + - stale + - timed_out + completed_at: + type: string + format: date-time + description: >- + The time the check completed. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + output: + type: object + description: >- + Check runs can accept a variety of data in the `output` + object, including a `title` and `summary` and can optionally + provide descriptive details about the run. + properties: + title: + type: string + description: The title of the check run. + summary: + type: string + maxLength: 65535 + description: >- + The summary of the check run. This parameter supports + Markdown. **Maximum length**: 65535 characters. + text: + type: string + maxLength: 65535 + description: >- + The details of the check run. This parameter supports + Markdown. **Maximum length**: 65535 characters. + annotations: + type: array + description: >- + Adds information from your analysis to specific lines of + code. Annotations are visible on GitHub in the + **Checks** and **Files changed** tab of the pull + request. The Checks API limits the number of annotations + to a maximum of 50 per API request. To create more than + 50 annotations, you have to make multiple requests to + the [Update a check + run](https://docs.github.com/rest/checks/runs#update-a-check-run) + endpoint. Each time you update the check run, + annotations are appended to the list of annotations that + already exist for the check run. GitHub Actions are + limited to 10 warning annotations and 10 error + annotations per step. For details about how you can view + annotations on GitHub, see "[About status + checks](https://docs.github.com/articles/about-status-checks#checks)". + maxItems: 50 + items: + type: object + properties: + path: + type: string + description: >- + The path of the file to add an annotation to. For + example, `assets/css/main.css`. + start_line: + type: integer + description: >- + The start line of the annotation. Line numbers + start at 1. + end_line: + type: integer + description: The end line of the annotation. + start_column: + type: integer + description: >- + The start column of the annotation. Annotations + only support `start_column` and `end_column` on + the same line. Omit this parameter if `start_line` + and `end_line` have different values. Column + numbers start at 1. + end_column: + type: integer + description: >- + The end column of the annotation. Annotations only + support `start_column` and `end_column` on the + same line. Omit this parameter if `start_line` and + `end_line` have different values. + annotation_level: + type: string + description: The level of the annotation. + enum: + - notice + - warning + - failure + message: + type: string + description: >- + A short description of the feedback for these + lines of code. The maximum size is 64 KB. + title: + type: string + description: >- + The title that represents the annotation. The + maximum size is 255 characters. + raw_details: + type: string + description: >- + Details about this annotation. The maximum size is + 64 KB. + required: + - path + - start_line + - end_line + - annotation_level + - message + images: + type: array + description: >- + Adds images to the output displayed in the GitHub pull + request UI. + items: + type: object + properties: + alt: + type: string + description: The alternative text for the image. + image_url: + type: string + description: The full URL of the image. + caption: + type: string + description: A short image description. + required: + - alt + - image_url + required: + - title + - summary + actions: + type: array + description: >- + Displays a button on GitHub that can be clicked to alert + your app to do additional tasks. For example, a code linting + app can display a button that automatically fixes detected + errors. The button created in this object is displayed after + the check run completes. When a user clicks the button, + GitHub sends the [`check_run.requested_action` + webhook](https://docs.github.com/webhooks/event-payloads/#check_run) + to your app. Each action includes a `label`, `identifier` + and `description`. A maximum of three actions are accepted. + To learn more about check runs and requested actions, see + "[Check runs and requested + actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + maxItems: 3 + items: + type: object + properties: + label: + type: string + maxLength: 20 + description: >- + The text to be displayed on a button in the web UI. + The maximum size is 20 characters. + description: + type: string + maxLength: 40 + description: >- + A short explanation of what this action would do. The + maximum size is 40 characters. + identifier: + type: string + maxLength: 20 + description: >- + A reference for the action on the integrator's system. + The maximum size is 20 characters. + required: + - label + - description + - identifier + required: + - name + - head_sha + - status + - conclusion + discriminator: + propertyName: status + additionalProperties: true + examples: + example-of-in-progress-conclusion: + summary: Example of an in_progress conclusion + value: + name: mighty_readme + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + status: in_progress + external_id: '42' + started_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: '' + text: '' + example-of-completed-conclusion: + summary: Example of a completed conclusion + value: + name: mighty_readme + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + status: completed + started_at: '2017-11-30T19:39:10Z' + conclusion: success + completed_at: '2017-11-30T19:49:10Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notices. + text: >- + You may have some misspelled words on lines 2 and 4. You + also may want to add a section in your README about how to + install your app. + annotations: + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'banaas'. + raw_details: Do you mean 'bananas' or 'banana'? + start_line: 2 + end_line: 2 + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'aples' + raw_details: Do you mean 'apples' or 'Naples' + start_line: 4 + end_line: 4 + images: + - alt: Super bananas + image_url: http://example.com/images/42 + actions: + - label: Fix + identifier: fix_errors + description: Allow us to fix these errors for you + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-run' + examples: + example-of-completed-conclusion: + $ref: >- + #/components/examples/check-run-example-of-completed-conclusion + example-of-in-progress-conclusion: + $ref: >- + #/components/examples/check-run-example-of-in-progress-conclusion + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-runs/{check_run_id}: + get: + summary: Get a check run + description: >- + Gets a single check run using its `id`. + + + > [!NOTE] + + > The Checks API only looks for pushes in the repository where the check + suite or check run were created. Pushes to a branch in a forked + repository are not detected and return an empty `pull_requests` array. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#get-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + patch: + summary: Update a check run + description: >- + Updates a check run for a specific commit in a repository. + + + > [!NOTE] + + > The endpoints to manage checks only look for pushes in the repository + where the check suite or check run were created. Pushes to a branch in a + forked repository are not detected and return an empty `pull_requests` + array. + + + OAuth apps and personal access tokens (classic) cannot use this + endpoint. + tags: + - checks + operationId: checks/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#update-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the check. For example, "code-coverage". + details_url: + type: string + description: >- + The URL of the integrator's site that has the full details + of the check. + external_id: + type: string + description: A reference for the run on the integrator's system. + started_at: + type: string + format: date-time + description: >- + This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + status: + type: string + description: >- + The current status of the check run. Only GitHub Actions can + set a status of `waiting`, `pending`, or `requested`. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + conclusion: + type: string + description: >- + **Required if you provide `completed_at` or a `status` of + `completed`**. The final conclusion of the check. + + **Note:** Providing `conclusion` will automatically set the + `status` parameter to `completed`. You cannot change a check + run conclusion to `stale`, only GitHub can set this. + enum: + - action_required + - cancelled + - failure + - neutral + - success + - skipped + - stale + - timed_out + completed_at: + type: string + format: date-time + description: >- + The time the check completed. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + output: + type: object + description: >- + Check runs can accept a variety of data in the `output` + object, including a `title` and `summary` and can optionally + provide descriptive details about the run. + properties: + title: + type: string + description: '**Required**.' + summary: + type: string + description: Can contain Markdown. + maxLength: 65535 + text: + type: string + description: Can contain Markdown. + maxLength: 65535 + annotations: + type: array + description: >- + Adds information from your analysis to specific lines of + code. Annotations are visible in GitHub's pull request + UI. Annotations are visible in GitHub's pull request UI. + The Checks API limits the number of annotations to a + maximum of 50 per API request. To create more than 50 + annotations, you have to make multiple requests to the + [Update a check + run](https://docs.github.com/rest/checks/runs#update-a-check-run) + endpoint. Each time you update the check run, + annotations are appended to the list of annotations that + already exist for the check run. GitHub Actions are + limited to 10 warning annotations and 10 error + annotations per step. For details about annotations in + the UI, see "[About status + checks](https://docs.github.com/articles/about-status-checks#checks)". + maxItems: 50 + items: + type: object + properties: + path: + type: string + description: >- + The path of the file to add an annotation to. For + example, `assets/css/main.css`. + start_line: + type: integer + description: >- + The start line of the annotation. Line numbers + start at 1. + end_line: + type: integer + description: The end line of the annotation. + start_column: + type: integer + description: >- + The start column of the annotation. Annotations + only support `start_column` and `end_column` on + the same line. Omit this parameter if `start_line` + and `end_line` have different values. Column + numbers start at 1. + end_column: + type: integer + description: >- + The end column of the annotation. Annotations only + support `start_column` and `end_column` on the + same line. Omit this parameter if `start_line` and + `end_line` have different values. + annotation_level: + type: string + description: The level of the annotation. + enum: + - notice + - warning + - failure + message: + type: string + description: >- + A short description of the feedback for these + lines of code. The maximum size is 64 KB. + title: + type: string + description: >- + The title that represents the annotation. The + maximum size is 255 characters. + raw_details: + type: string + description: >- + Details about this annotation. The maximum size is + 64 KB. + required: + - path + - start_line + - end_line + - annotation_level + - message + images: + type: array + description: >- + Adds images to the output displayed in the GitHub pull + request UI. + items: + type: object + properties: + alt: + type: string + description: The alternative text for the image. + image_url: + type: string + description: The full URL of the image. + caption: + type: string + description: A short image description. + required: + - alt + - image_url + required: + - summary + actions: + type: array + description: >- + Possible further actions the integrator can perform, which a + user may trigger. Each action includes a `label`, + `identifier` and `description`. A maximum of three actions + are accepted. To learn more about check runs and requested + actions, see "[Check runs and requested + actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + maxItems: 3 + items: + type: object + properties: + label: + type: string + maxLength: 20 + description: >- + The text to be displayed on a button in the web UI. + The maximum size is 20 characters. + description: + type: string + maxLength: 40 + description: >- + A short explanation of what this action would do. The + maximum size is 40 characters. + identifier: + type: string + maxLength: 20 + description: >- + A reference for the action on the integrator's system. + The maximum size is 20 characters. + required: + - label + - description + - identifier + required: + - conclusion + additionalProperties: true + examples: + default: + value: + name: mighty_readme + started_at: '2018-05-04T01:14:52Z' + status: completed + conclusion: success + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notices. + text: >- + You may have some misspelled words on lines 2 and 4. You + also may want to add a section in your README about how to + install your app. + annotations: + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'banaas'. + raw_details: Do you mean 'bananas' or 'banana'? + start_line: 2 + end_line: 2 + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'aples' + raw_details: Do you mean 'apples' or 'Naples' + start_line: 4 + end_line: 4 + images: + - alt: Super bananas + image_url: http://example.com/images/42 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations: + get: + summary: List check run annotations + description: >- + Lists annotations for a check run using the annotation `id`. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-annotations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#list-check-run-annotations + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/check-annotation' + examples: + default: + $ref: '#/components/examples/check-annotation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest: + post: + summary: Rerequest a check run + description: >- + Triggers GitHub to rerequest an existing check run, without pushing new + code to a repository. This endpoint will trigger the [`check_run` + webhook](https://docs.github.com/webhooks/event-payloads/#check_run) + event with the action `rerequested`. When a check run is `rerequested`, + the `status` of the check suite it belongs to is reset to `queued` and + the `conclusion` is cleared. The check run itself is not updated. GitHub + apps recieving the [`check_run` + webhook](https://docs.github.com/webhooks/event-payloads/#check_run) + with the `rerequested` action should then decide if the check run should + be reset or updated and call the [update `check_run` + endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) + to update the check_run if desired. + + + For more information about how to re-run GitHub Actions jobs, see + "[Re-run a job from a workflow + run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + tags: + - checks + operationId: checks/rerequest-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + description: >- + Forbidden if the check run is not rerequestable or doesn't belong to + the authenticated GitHub App + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Validation error if the check run is not rerequestable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-suites: + post: + summary: Create a check suite + description: >- + Creates a check suite manually. By default, check suites are + automatically created when you create a [check + run](https://docs.github.com/rest/checks/runs). You only need to use + this endpoint for manually creating check suites when you've disabled + automatic creation using "[Update repository preferences for check + suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". + + + > [!NOTE] + + > The Checks API only looks for pushes in the repository where the check + suite or check run were created. Pushes to a branch in a forked + repository are not detected and return an empty `pull_requests` array + and a `null` value for `head_branch`. + + + OAuth apps and personal access tokens (classic) cannot use this + endpoint. + tags: + - checks + operationId: checks/create-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#create-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + head_sha: + type: string + description: The sha of the head commit. + required: + - head_sha + examples: + default: + value: + head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 + responses: + '200': + description: Response when the suite already exists + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite' + '201': + description: Response when the suite was created + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/check-suites/preferences: + patch: + summary: Update repository preferences for check suites + description: >- + Changes the default automatic flow when creating check suites. By + default, a check suite is automatically created each time code is pushed + to a repository. When you disable the automatic creation of check + suites, you can manually [Create a check + suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + + You must have admin permissions in the repository to set preferences for + check suites. + tags: + - checks + operationId: checks/set-suites-preferences + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + auto_trigger_checks: + type: array + description: >- + Enables or disables automatic creation of CheckSuite events + upon pushes to the repository. Enabled by default. + items: + type: object + properties: + app_id: + type: integer + description: The `id` of the GitHub App. + setting: + type: boolean + description: >- + Set to `true` to enable automatic creation of + CheckSuite events upon pushes to the repository, or + `false` to disable them. + default: true + required: + - app_id + - setting + examples: + default: + value: + auto_trigger_checks: + - app_id: 4 + setting: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite-preference' + examples: + default: + $ref: '#/components/examples/check-suite-preference' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/check-suites/{check_suite_id}: + get: + summary: Get a check suite + description: >- + Gets a single check suite using its `id`. + + + > [!NOTE] + + > The Checks API only looks for pushes in the repository where the check + suite or check run were created. Pushes to a branch in a forked + repository are not detected and return an empty `pull_requests` array + and a `null` value for `head_branch`. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/get-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#get-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-suite-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs: + get: + summary: List check runs in a check suite + description: >- + Lists check runs for a check suite using its `id`. + + + > [!NOTE] + + > The endpoints to manage checks only look for pushes in the repository + where the check suite or check run were created. Pushes to a branch in a + forked repository are not detected and return an empty `pull_requests` + array. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-for-suite + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-suite-id' + - $ref: '#/components/parameters/check-name' + - $ref: '#/components/parameters/status' + - name: filter + description: >- + Filters check runs by their `completed_at` timestamp. `latest` + returns the most recent check runs. + in: query + required: false + schema: + type: string + enum: + - latest + - all + default: latest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - check_runs + properties: + total_count: + type: integer + check_runs: + type: array + items: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest: + post: + summary: Rerequest a check suite + description: >- + Triggers GitHub to rerequest an existing check suite, without pushing + new code to a repository. This endpoint will trigger the [`check_suite` + webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) + event with the action `rerequested`. When a check suite is + `rerequested`, its `status` is reset to `queued` and the `conclusion` is + cleared. + tags: + - checks + operationId: checks/rerequest-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-suite-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/commits/{ref}/check-runs: + get: + summary: List check runs for a Git reference + description: >- + Lists check runs for a commit ref. The `ref` can be a SHA, branch name, + or a tag name. + + + > [!NOTE] + + > The endpoints to manage checks only look for pushes in the repository + where the check suite or check run were created. Pushes to a branch in a + forked repository are not detected and return an empty `pull_requests` + array. + + + If there are more than 1000 check suites on a single git reference, this + endpoint will limit check runs to the 1000 most recent check suites. To + iterate over all possible check runs, use the [List check suites for a + Git + reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) + endpoint and provide the `check_suite_id` parameter to the [List check + runs in a check + suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-for-ref + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - $ref: '#/components/parameters/check-name' + - $ref: '#/components/parameters/status' + - name: filter + description: >- + Filters check runs by their `completed_at` timestamp. `latest` + returns the most recent check runs. + in: query + required: false + schema: + type: string + enum: + - latest + - all + default: latest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: app_id + in: query + required: false + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - check_runs + properties: + total_count: + type: integer + check_runs: + type: array + items: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/commits/{ref}/check-suites: + get: + summary: List check suites for a Git reference + description: >- + Lists check suites for a commit `ref`. The `ref` can be a SHA, branch + name, or a tag name. + + + > [!NOTE] + + > The endpoints to manage checks only look for pushes in the repository + where the check suite or check run were created. Pushes to a branch in a + forked repository are not detected and return an empty `pull_requests` + array and a `null` value for `head_branch`. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-suites-for-ref + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - name: app_id + description: Filters check suites by GitHub App `id`. + in: query + required: false + schema: + type: integer + example: 1 + - $ref: '#/components/parameters/check-name' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - check_suites + properties: + total_count: + type: integer + check_suites: + type: array + items: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites +components: + schemas: + check-run: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + id: + description: The id of the check. + example: 21 + type: integer + format: int64 + head_sha: + description: The SHA of the commit that is being checked. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + node_id: + type: string + example: MDg6Q2hlY2tSdW40 + external_id: + type: string + example: '42' + nullable: true + url: + type: string + example: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: + type: string + example: https://github.com/github/hello-world/runs/4 + nullable: true + details_url: + type: string + example: https://example.com + nullable: true + status: + description: >- + The phase of the lifecycle that the check is currently in. Statuses + of waiting, requested, and pending are reserved for GitHub Actions + check runs. + example: queued + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + conclusion: + type: string + example: neutral + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + nullable: true + started_at: + type: string + format: date-time + example: '2018-05-04T01:14:52Z' + nullable: true + completed_at: + type: string + format: date-time + example: '2018-05-04T01:14:52Z' + nullable: true + output: + type: object + properties: + title: + type: string + nullable: true + summary: + type: string + nullable: true + text: + type: string + nullable: true + annotations_count: + type: integer + annotations_url: + type: string + format: uri + required: + - title + - summary + - text + - annotations_count + - annotations_url + name: + description: The name of the check. + example: test-coverage + type: string + check_suite: + type: object + properties: + id: + type: integer + required: + - id + nullable: true + app: + $ref: '#/components/schemas/nullable-integration' + pull_requests: + description: >- + Pull requests that are open with a `head_sha` or `head_branch` that + matches the check. The returned pull requests do not necessarily + indicate pull requests that triggered the check. + type: array + items: + $ref: '#/components/schemas/pull-request-minimal' + deployment: + $ref: '#/components/schemas/deployment-simple' + required: + - id + - node_id + - head_sha + - name + - url + - html_url + - details_url + - status + - conclusion + - started_at + - completed_at + - external_id + - check_suite + - output + - app + - pull_requests + check-annotation: + title: Check Annotation + description: Check Annotation + type: object + properties: + path: + type: string + example: README.md + start_line: + type: integer + example: 2 + end_line: + type: integer + example: 2 + start_column: + type: integer + example: 5 + nullable: true + end_column: + type: integer + example: 10 + nullable: true + annotation_level: + type: string + example: warning + nullable: true + title: + type: string + example: Spell Checker + nullable: true + message: + type: string + example: Check your spelling for 'banaas'. + nullable: true + raw_details: + type: string + example: Do you mean 'bananas' or 'banana'? + nullable: true + blob_href: + type: string + required: + - path + - blob_href + - start_line + - end_line + - start_column + - end_column + - annotation_level + - title + - message + - raw_details + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + check-suite: + title: CheckSuite + description: A suite of checks performed on the code of a given code change + type: object + properties: + id: + type: integer + example: 5 + format: int64 + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + head_branch: + type: string + example: master + nullable: true + head_sha: + description: The SHA of the head commit that is being checked. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + status: + type: string + description: >- + The phase of the lifecycle that the check suite is currently in. + Statuses of waiting, requested, and pending are reserved for GitHub + Actions check suites. + example: completed + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + nullable: true + conclusion: + type: string + example: neutral + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - startup_failure + - stale + - null + nullable: true + url: + type: string + example: https://api.github.com/repos/github/hello-world/check-suites/5 + nullable: true + before: + type: string + example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + nullable: true + after: + type: string + example: d6fde92930d4715a2b49857d24b940956b26d2d3 + nullable: true + pull_requests: + type: array + items: + $ref: '#/components/schemas/pull-request-minimal' + nullable: true + app: + $ref: '#/components/schemas/nullable-integration' + repository: + $ref: '#/components/schemas/minimal-repository' + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + head_commit: + $ref: '#/components/schemas/simple-commit' + latest_check_runs_count: + type: integer + check_runs_url: + type: string + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + required: + - id + - node_id + - head_branch + - status + - conclusion + - head_sha + - url + - before + - after + - created_at + - updated_at + - app + - head_commit + - repository + - latest_check_runs_count + - check_runs_url + - pull_requests + check-suite-preference: + title: Check Suite Preference + description: Check suite configuration preferences for a repository. + type: object + required: + - preferences + - repository + properties: + preferences: + type: object + properties: + auto_trigger_checks: + type: array + items: + type: object + properties: + app_id: + type: integer + setting: + type: boolean + required: + - app_id + - setting + repository: + $ref: '#/components/schemas/minimal-repository' + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + deployment-simple: + title: Deployment + description: >- + A deployment created as the result of an Actions check run from a + workflow that references an environment + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + example: 42 + type: integer + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + task: + description: Parameter to specify a task to execute + example: deploy + type: string + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: >- + Specifies if the given environment is will no longer exist at some + point in the future. Default: false. + example: true + type: boolean + production_environment: + description: >- + Specifies if the given environment is one that end-users directly + interact with. Default: false. + example: true + type: boolean + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - task + - environment + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + timestamp: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + author: + type: object + description: Information about the Git author + properties: + name: + description: Name of the commit's author + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's author + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + committer: + type: object + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's committer + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + required: + - id + - tree_id + - message + - timestamp + - author + - committer + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + check-run-id: + name: check_run_id + description: The unique identifier of the check run. + in: path + required: true + schema: + type: integer + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + check-suite-id: + name: check_suite_id + description: The unique identifier of the check suite. + in: path + required: true + schema: + type: integer + check-name: + name: check_name + description: Returns check runs with the specified `name`. + in: query + required: false + schema: + type: string + status: + name: status + description: Returns check runs with the specified `status`. + in: query + required: false + schema: + type: string + enum: + - queued + - in_progress + - completed + commit-ref: + name: ref + description: >- + The commit reference. Can be a commit SHA, branch name + (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more + information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + in: path + required: true + schema: + type: string + x-multi-segment: true + examples: + check-run-example-of-completed-conclusion: + summary: Response for completed conclusion + value: + id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '42' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: completed + conclusion: neutral + started_at: '2018-05-04T01:14:52Z' + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: >- + You may have some misspelled words on lines 2 and 4. You also may + want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: >- + https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-run-example-of-in-progress-conclusion: + summary: Response for in_progress conclusion + value: + id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '42' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: in_progress + conclusion: null + started_at: '2018-05-04T01:14:52Z' + completed_at: null + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: >- + You may have some misspelled words on lines 2 and 4. You also may + want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: >- + https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-run: + value: + id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: completed + conclusion: neutral + started_at: '2018-05-04T01:14:52Z' + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: >- + You may have some misspelled words on lines 2 and 4. You also may + want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: >- + https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-annotation-items: + value: + - path: README.md + start_line: 2 + end_line: 2 + start_column: 5 + end_column: 10 + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'banaas'. + raw_details: Do you mean 'bananas' or 'banana'? + blob_href: >- + https://api.github.com/repos/github/rest-api-description/git/blobs/abc + check-suite: + value: + id: 5 + node_id: MDEwOkNoZWNrU3VpdGU1 + head_branch: master + head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 + status: completed + conclusion: neutral + url: https://api.github.com/repos/github/hello-world/check-suites/5 + before: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: [] + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + head_commit: + id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + timestamp: '2016-10-10T00:00:00Z' + author: + name: The Octocat + email: octocat@nowhere.com + committer: + name: The Octocat + email: octocat@nowhere.com + latest_check_runs_count: 1 + check_runs_url: >- + https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs + check-suite-preference: + value: + preferences: + auto_trigger_checks: + - app_id: 2 + setting: true + - app_id: 4 + setting: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + check-run-paginated: + value: + total_count: 1 + check_runs: + - id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: completed + conclusion: neutral + started_at: '2018-05-04T01:14:52Z' + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: >- + You may have some misspelled words on lines 2 and 4. You also + may want to add a section in your README about how to install + your app. + annotations_count: 2 + annotations_url: >- + https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-suite-paginated: + value: + total_count: 1 + check_suites: + - id: 5 + node_id: MDEwOkNoZWNrU3VpdGU1 + head_branch: master + head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 + status: completed + conclusion: neutral + url: https://api.github.com/repos/github/hello-world/check-suites/5 + before: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: [] + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + head_commit: + id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + timestamp: '2016-10-10T00:00:00Z' + author: + name: The Octocat + email: octocat@nowhere.com + committer: + name: The Octocat + email: octocat@nowhere.com + latest_check_runs_count: 1 + check_runs_url: >- + https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + runs: + id: github.checks.runs + name: runs + title: Runs + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1check-runs/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1check-runs~1{check_run_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1check-runs~1{check_run_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + rerequest_run: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1check-runs~1{check_run_id}~1rerequest/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_for_suite: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1check-suites~1{check_suite_id}~1check-runs/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_for_ref: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{ref}~1check-runs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/runs/methods/get' + - $ref: '#/components/x-stackQL-resources/runs/methods/list_for_suite' + - $ref: '#/components/x-stackQL-resources/runs/methods/list_for_ref' + insert: + - $ref: '#/components/x-stackQL-resources/runs/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/runs/methods/update' + delete: [] + replace: [] + annotations: + id: github.checks.annotations + name: annotations + title: Annotations + methods: + list_annotations: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1check-runs~1{check_run_id}~1annotations/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/annotations/methods/list_annotations + insert: [] + update: [] + delete: [] + replace: [] + suites: + id: github.checks.suites + name: suites + title: Suites + methods: + create_suite: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1check-suites/post' + response: + mediaType: application/json + openAPIDocKey: '200' + set_suites_preferences: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1check-suites~1preferences/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + get_suite: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1check-suites~1{check_suite_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + rerequest_suite: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1check-suites~1{check_suite_id}~1rerequest/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_suites_for_ref: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{ref}~1check-suites/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/suites/methods/get_suite' + - $ref: >- + #/components/x-stackQL-resources/suites/methods/list_suites_for_ref + insert: + - $ref: '#/components/x-stackQL-resources/suites/methods/create_suite' + update: + - $ref: >- + #/components/x-stackQL-resources/suites/methods/set_suites_preferences + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/classroom.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/classroom.yaml new file mode 100644 index 0000000..b7efd5c --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/classroom.yaml @@ -0,0 +1,964 @@ +openapi: 3.0.3 +info: + title: classroom API + description: Interact with GitHub Classroom. + version: 1.1.4 +paths: + /assignments/{assignment_id}: + get: + summary: Get an assignment + description: >- + Gets a GitHub Classroom assignment. Assignment will only be returned if + the current user is an administrator of the GitHub Classroom for the + assignment. + tags: + - classroom + operationId: classroom/get-an-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + parameters: + - $ref: '#/components/parameters/assignment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/classroom-assignment' + examples: + default: + $ref: '#/components/examples/classroom-assignment' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /assignments/{assignment_id}/accepted_assignments: + get: + summary: List accepted assignments for an assignment + description: >- + Lists any assignment repositories that have been created by students + accepting a GitHub Classroom assignment. Accepted assignments will only + be returned if the current user is an administrator of the GitHub + Classroom for the assignment. + tags: + - classroom + operationId: classroom/list-accepted-assignments-for-an-assignment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + parameters: + - $ref: '#/components/parameters/assignment-id' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/classroom-accepted-assignment' + examples: + default: + $ref: '#/components/examples/classroom-accepted-assignment' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /assignments/{assignment_id}/grades: + get: + summary: Get assignment grades + description: >- + Gets grades for a GitHub Classroom assignment. Grades will only be + returned if the current user is an administrator of the GitHub Classroom + for the assignment. + tags: + - classroom + operationId: classroom/get-assignment-grades + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + parameters: + - $ref: '#/components/parameters/assignment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/classroom-assignment-grade' + examples: + default: + $ref: '#/components/examples/classroom-assignment-grades' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /classrooms: + get: + summary: List classrooms + description: >- + Lists GitHub Classroom classrooms for the current user. Classrooms will + only be returned if the current user is an administrator of one or more + GitHub Classrooms. + tags: + - classroom + operationId: classroom/list-classrooms + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#list-classrooms + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-classroom' + examples: + default: + $ref: '#/components/examples/simple-classroom' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /classrooms/{classroom_id}: + get: + summary: Get a classroom + description: >- + Gets a GitHub Classroom classroom for the current user. Classroom will + only be returned if the current user is an administrator of the GitHub + Classroom. + tags: + - classroom + operationId: classroom/get-a-classroom + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + parameters: + - $ref: '#/components/parameters/classroom-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/classroom' + examples: + default: + $ref: '#/components/examples/classroom' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /classrooms/{classroom_id}/assignments: + get: + summary: List assignments for a classroom + description: >- + Lists GitHub Classroom assignments for a classroom. Assignments will + only be returned if the current user is an administrator of the GitHub + Classroom. + tags: + - classroom + operationId: classroom/list-assignments-for-a-classroom + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + parameters: + - $ref: '#/components/parameters/classroom-id' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-classroom-assignment' + examples: + default: + $ref: '#/components/examples/simple-classroom-assignment' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom +components: + schemas: + classroom-assignment: + title: Classroom Assignment + description: A GitHub Classroom assignment + type: object + properties: + id: + description: Unique identifier of the repository. + type: integer + example: 42 + public_repo: + description: Whether an accepted assignment creates a public repository. + type: boolean + example: true + title: + description: Assignment title. + type: string + example: Intro to Binaries + type: + description: Whether it's a group assignment or individual assignment. + type: string + example: individual + enum: + - individual + - group + invite_link: + description: The link that a student can use to accept the assignment. + type: string + example: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: + description: >- + Whether the invitation link is enabled. Visiting an enabled + invitation link will accept the assignment. + type: boolean + example: true + slug: + description: Sluggified name of the assignment. + type: string + example: intro-to-binaries + students_are_repo_admins: + description: >- + Whether students are admins on created repository when a student + accepts the assignment. + type: boolean + example: true + feedback_pull_requests_enabled: + description: >- + Whether feedback pull request will be created when a student accepts + the assignment. + type: boolean + example: true + max_teams: + description: The maximum allowable teams for the assignment. + nullable: true + type: integer + example: 0 + max_members: + description: The maximum allowable members per team. + nullable: true + type: integer + example: 0 + editor: + description: The selected editor for the assignment. + type: string + example: codespaces + accepted: + description: The number of students that have accepted the assignment. + type: integer + example: 25 + submitted: + description: The number of students that have submitted the assignment. + type: integer + example: 10 + passing: + description: The number of students that have passed the assignment. + type: integer + example: 10 + language: + description: The programming language used in the assignment. + type: string + example: elixir + deadline: + description: The time at which the assignment is due. + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + starter_code_repository: + $ref: '#/components/schemas/simple-classroom-repository' + classroom: + $ref: '#/components/schemas/classroom' + required: + - id + - public_repo + - title + - type + - invite_link + - invitations_enabled + - slug + - students_are_repo_admins + - feedback_pull_requests_enabled + - max_teams + - max_members + - editor + - accepted + - submitted + - passing + - language + - deadline + - starter_code_repository + - classroom + classroom-accepted-assignment: + title: Classroom Accepted Assignment + description: A GitHub Classroom accepted assignment + type: object + properties: + id: + description: Unique identifier of the repository. + type: integer + example: 42 + submitted: + description: Whether an accepted assignment has been submitted. + type: boolean + example: true + passing: + description: Whether a submission passed. + type: boolean + example: true + commit_count: + description: Count of student commits. + type: integer + example: 5 + grade: + description: Most recent grade. + type: string + example: 10/10 + students: + type: array + items: + $ref: '#/components/schemas/simple-classroom-user' + repository: + $ref: '#/components/schemas/simple-classroom-repository' + assignment: + $ref: '#/components/schemas/simple-classroom-assignment' + required: + - id + - submitted + - passing + - commit_count + - grade + - students + - repository + - assignment + classroom-assignment-grade: + title: Classroom Assignment Grade + description: Grade for a student or groups GitHub Classroom assignment + type: object + properties: + assignment_name: + description: Name of the assignment + type: string + assignment_url: + description: URL of the assignment + type: string + starter_code_url: + description: URL of the starter code for the assignment + type: string + github_username: + description: GitHub username of the student + type: string + roster_identifier: + description: Roster identifier of the student + type: string + student_repository_name: + description: Name of the student's assignment repository + type: string + student_repository_url: + description: URL of the student's assignment repository + type: string + submission_timestamp: + description: Timestamp of the student's assignment submission + type: string + points_awarded: + description: Number of points awarded to the student + type: integer + points_available: + description: Number of points available for the assignment + type: integer + group_name: + description: If a group assignment, name of the group the student is in + type: string + required: + - assignment_name + - assignment_url + - starter_code_url + - github_username + - roster_identifier + - student_repository_name + - student_repository_url + - submission_timestamp + - points_awarded + - points_available + simple-classroom: + title: Simple Classroom + description: A GitHub Classroom classroom + type: object + properties: + id: + description: Unique identifier of the classroom. + example: 42 + type: integer + name: + description: The name of the classroom. + type: string + example: Programming Elixir + archived: + description: Returns whether classroom is archived or not. + type: boolean + example: false + url: + description: The url of the classroom on GitHub Classroom. + type: string + example: https://classroom.github.com/classrooms/1-programming-elixir + required: + - id + - name + - archived + - url + classroom: + title: Classroom + description: A GitHub Classroom classroom + type: object + properties: + id: + description: Unique identifier of the classroom. + example: 42 + type: integer + name: + description: The name of the classroom. + type: string + example: Programming Elixir + archived: + description: Whether classroom is archived. + type: boolean + example: false + organization: + $ref: '#/components/schemas/simple-classroom-organization' + url: + description: The URL of the classroom on GitHub Classroom. + type: string + example: https://classroom.github.com/classrooms/1-programming-elixir + required: + - id + - name + - archived + - organization + - url + simple-classroom-assignment: + title: Simple Classroom Assignment + description: A GitHub Classroom assignment + type: object + properties: + id: + description: Unique identifier of the repository. + type: integer + example: 42 + public_repo: + description: Whether an accepted assignment creates a public repository. + type: boolean + example: true + title: + description: Assignment title. + type: string + example: Intro to Binaries + type: + description: Whether it's a Group Assignment or Individual Assignment. + type: string + example: individual + enum: + - individual + - group + invite_link: + description: The link that a student can use to accept the assignment. + type: string + example: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: + description: >- + Whether the invitation link is enabled. Visiting an enabled + invitation link will accept the assignment. + type: boolean + example: true + slug: + description: Sluggified name of the assignment. + type: string + example: intro-to-binaries + students_are_repo_admins: + description: >- + Whether students are admins on created repository on accepted + assignment. + type: boolean + example: true + feedback_pull_requests_enabled: + description: >- + Whether feedback pull request will be created on assignment + acceptance. + type: boolean + example: true + max_teams: + description: The maximum allowable teams for the assignment. + nullable: true + type: integer + example: 0 + max_members: + description: The maximum allowable members per team. + nullable: true + type: integer + example: 0 + editor: + description: The selected editor for the assignment. + type: string + example: codespaces + accepted: + description: The number of students that have accepted the assignment. + type: integer + example: 25 + submitted: + description: The number of students that have submitted the assignment. + type: integer + example: 10 + passing: + description: The number of students that have passed the assignment. + type: integer + example: 10 + language: + description: The programming language used in the assignment. + type: string + example: elixir + deadline: + description: The time at which the assignment is due. + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + classroom: + $ref: '#/components/schemas/simple-classroom' + required: + - id + - public_repo + - title + - type + - invite_link + - invitations_enabled + - slug + - students_are_repo_admins + - feedback_pull_requests_enabled + - editor + - accepted + - submitted + - passing + - language + - deadline + - classroom + simple-classroom-repository: + title: Simple Classroom Repository + description: A GitHub repository view for Classroom + type: object + properties: + id: + type: integer + example: 1296269 + description: A unique identifier of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique name of the repository. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + private: + type: boolean + description: Whether the repository is private. + default_branch: + type: string + example: main + description: The default branch for the repository. + required: + - id + - full_name + - html_url + - node_id + - private + - default_branch + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-classroom-user: + title: Simple Classroom User + description: A GitHub user simplified for Classroom. + type: object + properties: + id: + type: integer + example: 1 + login: + type: string + example: octocat + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + html_url: + type: string + format: uri + example: https://github.com/octocat + required: + - id + - login + - avatar_url + - html_url + simple-classroom-organization: + title: Organization Simple for Classroom + description: A GitHub organization. + type: object + properties: + id: + type: integer + example: 1 + login: + type: string + example: github + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + html_url: + type: string + format: uri + example: https://github.com/github + name: + type: string + example: Github - Code thigns happen here + nullable: true + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + required: + - id + - login + - node_id + - html_url + - name + - avatar_url + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + assignment-id: + name: assignment_id + description: The unique identifier of the classroom assignment. + in: path + required: true + schema: + type: integer + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + classroom-id: + name: classroom_id + description: The unique identifier of the classroom. + in: path + required: true + schema: + type: integer + examples: + classroom-assignment: + value: + id: 12, + public_repo: false, + title: Intro to Binaries + type: individual + invite_link: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: true, + slug: intro-to-binaries + students_are_repo_admins: false + feedback_pull_requests_enabled: true + max_teams: 0 + max_members: 0 + editor: codespaces + accepted: 100 + submitted: 40 + passing: 10 + language: ruby + deadline: '2011-01-26T19:06:43Z' + stater_code_repository: + id: 1296269 + full_name: octocat/Hello-World + html_url: https://github.com/octocat/Hello-World + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + private: false + default_branch: main + classroom: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + classroom-accepted-assignment: + value: + id: 12, + submitted: false, + passing: false, + commit_count: 5 + grade: 5/10 + students: + - id: 1 + login: octocat + avatar_url: https://github.com/images/error/octocat_happy.gif + html_url: https://github.com/octocat + repository: + id: 1296269 + full_name: octocat/Hello-World + html_url: https://github.com/octocat/Hello-World + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + private: false + default_branch: main + assignment: + id: 12, + public_repo: false, + title: Intro to Binaries + type: individual + invite_link: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: true, + slug: intro-to-binaries + students_are_repo_admins: false + feedback_pull_requests_enabled: true + max_teams: 0 + max_members: 0 + editor: codespaces + accepted: 100 + submitted: 40 + passing: 10 + language: ruby + classroom: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + classroom-assignment-grades: + value: + - assignment_name: Introduction to Strings + assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337 + starter_code_url: '' + github_username: octocat + roster_identifier: octocat@github.com + student_repository_name: intro-to-strings-1337-octocat + student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-octocat + submission_timestamp: 2018-11-12 01:02 + points_awarded: 10 + points_available: 15 + group_name: octocat-and-friends + - assignment_name: Introduction to Strings + assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337 + starter_code_url: '' + github_username: monalisa + roster_identifier: monalisa@github.com + student_repository_name: intro-to-strings-1337-monalisa + student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-monalisa + submission_timestamp: 2018-11-12 01:11 + points_awarded: 15 + points_available: 15 + group_name: monalisa-and-friends + simple-classroom: + value: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + classroom: + value: + id: 1296269 + name: Programming Elixir + archived: false, + organization: + id: 1 + login: programming-elixir + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + html_url: https://github.com/programming-elixir + name: Learn how to build fault tolerant applications + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + url: https://classroom.github.com/classrooms/1-programming-elixir + simple-classroom-assignment: + value: + id: 12, + public_repo: false, + title: Intro to Binaries + type: individual + invite_link: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: true, + slug: intro-to-binaries + students_are_repo_admins: false + feedback_pull_requests_enabled: true + max_teams: 0 + max_members: 0 + editor: codespaces + accepted: 100 + submitted: 40 + passing: 10 + language: ruby + deadline: '2020-01-11T11:59:22Z' + classroom: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + x-stackQL-resources: + assignments: + id: github.classroom.assignments + name: assignments + title: Assignments + methods: + get_an_assignment: + operation: + $ref: '#/paths/~1assignments~1{assignment_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/assignments/methods/get_an_assignment + insert: [] + update: [] + delete: [] + replace: [] + assignment_accepted_assignments: + id: github.classroom.assignment_accepted_assignments + name: assignment_accepted_assignments + title: Assignment Accepted Assignments + methods: + list_accepted_assignments_for_an_assignment: + operation: + $ref: '#/paths/~1assignments~1{assignment_id}~1accepted_assignments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/assignment_accepted_assignments/methods/list_accepted_assignments_for_an_assignment + insert: [] + update: [] + delete: [] + replace: [] + assignment_grades: + id: github.classroom.assignment_grades + name: assignment_grades + title: Assignment Grades + methods: + get_assignment_grades: + operation: + $ref: '#/paths/~1assignments~1{assignment_id}~1grades/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/assignment_grades/methods/get_assignment_grades + insert: [] + update: [] + delete: [] + replace: [] + classrooms: + id: github.classroom.classrooms + name: classrooms + title: Classrooms + methods: + list_classrooms: + operation: + $ref: '#/paths/~1classrooms/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_a_classroom: + operation: + $ref: '#/paths/~1classrooms~1{classroom_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/classrooms/methods/get_a_classroom + - $ref: >- + #/components/x-stackQL-resources/classrooms/methods/list_classrooms + insert: [] + update: [] + delete: [] + replace: [] + classroom_assignments: + id: github.classroom.classroom_assignments + name: classroom_assignments + title: Classroom Assignments + methods: + list_assignments_for_a_classroom: + operation: + $ref: '#/paths/~1classrooms~1{classroom_id}~1assignments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/classroom_assignments/methods/list_assignments_for_a_classroom + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/code_scanning.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/code_scanning.yaml new file mode 100644 index 0000000..58725da --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/code_scanning.yaml @@ -0,0 +1,4868 @@ +openapi: 3.0.3 +info: + title: code_scanning API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/code-scanning/alerts: + get: + summary: List code scanning alerts for an organization + description: >- + Lists code scanning alerts for the default branch for all eligible + repositories in an organization. Eligible repositories are repositories + that are owned by organizations that you own or for which you are a + security manager. For more information, see "[Managing security managers + in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` or `repo`s cope to use this endpoint with private or + public repositories, or the `public_repo` scope to use this endpoint + with only public repositories. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/tool-name' + - $ref: '#/components/parameters/tool-guid' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - name: state + description: >- + If specified, only code scanning alerts with this state will be + returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-state-query' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + - name: severity + description: >- + If specified, only code scanning alerts with this severity will be + returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-severity' + - name: assignees + description: > + Filter alerts by assignees. Provide a comma-separated list of user + handles (e.g., `octocat` or `octocat,hubot`). + + Use `*` to list alerts with at least one assignee or `none` to list + alerts with no assignees. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-organization-alert-items' + examples: + default: + $ref: '#/components/examples/code-scanning-organization-alert-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts: + get: + summary: List code scanning alerts for a repository + description: >- + Lists code scanning alerts. + + + The response includes a `most_recent_instance` object. + + This provides details of the most recent instance of this alert + + for the default branch (or for the specified Git reference if you used + `ref` in the request). + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/tool-name' + - $ref: '#/components/parameters/tool-guid' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/git-ref' + - $ref: '#/components/parameters/pr-alias' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + - name: state + description: >- + If specified, only code scanning alerts with this state will be + returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-state-query' + - name: severity + description: >- + If specified, only code scanning alerts with this severity will be + returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-severity' + - name: assignees + description: > + Filter alerts by assignees. Provide a comma-separated list of user + handles (e.g., `octocat` or `octocat,hubot`). + + Use `*` to list alerts with at least one assignee or `none` to list + alerts with no assignees. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-alert-items' + examples: + default: + $ref: '#/components/examples/code-scanning-alert-items' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}: + get: + summary: Get a code scanning alert + description: >- + Gets a single code scanning alert. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/get-alert + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-alert' + examples: + default: + $ref: '#/components/examples/code-scanning-alert' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + patch: + summary: Update a code scanning alert + description: >- + Updates the status of a single code scanning alert. + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + operationId: code-scanning/update-alert + tags: + - code-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + $ref: '#/components/schemas/code-scanning-alert-set-state' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + create_request: + $ref: '#/components/schemas/code-scanning-alert-create-request' + assignees: + $ref: '#/components/schemas/code-scanning-alert-assignees' + required: + - state + - assignees + examples: + default: + value: + state: dismissed + dismissed_reason: false positive + dismissed_comment: >- + This alert is not actually correct, because there's a + sanitizer included in the library. + create_request: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-alert' + examples: + default: + $ref: '#/components/examples/code-scanning-alert-dismissed' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix: + get: + summary: Get the status of an autofix for a code scanning alert + description: >- + Gets the status and description of an autofix for a code scanning alert. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/get-autofix + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix' + '400': + $ref: '#/components/responses/code_scanning_bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + post: + summary: Create an autofix for a code scanning alert + description: >- + Creates an autofix for a code scanning alert. + + + If a new autofix is to be created as a result of this request or is + currently being generated, then this endpoint will return a 202 Accepted + response. + + + If an autofix already exists for a given alert, then this endpoint will + return a 200 OK response. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/create-autofix + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix' + '202': + description: Accepted + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix-pending' + '400': + $ref: '#/components/responses/code_scanning_bad_request' + '403': + $ref: '#/components/responses/code_scanning_autofix_create_forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits: + post: + summary: Commit an autofix for a code scanning alert + description: >- + Commits an autofix for a code scanning alert. + + + If an autofix is committed as a result of this request, then this + endpoint will return a 201 Created response. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/commit-autofix + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix-commits' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix-commits' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix-commits-response' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix-commits-response' + '400': + $ref: '#/components/responses/code_scanning_bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances: + get: + summary: List instances of a code scanning alert + description: >- + Lists all instances of the specified code scanning alert. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/list-alert-instances + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/git-ref' + - $ref: '#/components/parameters/pr-alias' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-alert-instance-list' + examples: + default: + $ref: '#/components/examples/code-scanning-alert-instances' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/analyses: + get: + summary: List code scanning analyses for a repository + description: >- + Lists the details of all code scanning analyses for a repository, + + starting with the most recent. + + The response is paginated and you can use the `page` and `per_page` + parameters + + to list the analyses you're interested in. + + By default 30 analyses are listed per page. + + + The `rules_count` field in the response give the number of rules + + that were run in the analysis. + + For very old analyses this data is not available, + + and `0` is returned in this field. + + + > [!WARNING] + + > **Closing down notice:** The `tool_name` field is closing down and + will, in future, not be included in the response for this endpoint. The + example response reflects this change. The tool name can now be found + inside the `tool` field. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + operationId: code-scanning/list-recent-analyses + tags: + - code-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/tool-name' + - $ref: '#/components/parameters/tool-guid' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pr-alias' + - name: ref + in: query + description: >- + The Git reference for the analyses you want to list. The `ref` for a + branch can be formatted either as `refs/heads/` or + simply ``. To reference a pull request use + `refs/pull//merge`. + required: false + schema: + $ref: '#/components/schemas/code-scanning-ref' + - name: sarif_id + in: query + description: Filter analyses belonging to the same SARIF upload. + required: false + schema: + $ref: '#/components/schemas/code-scanning-analysis-sarif-id' + - $ref: '#/components/parameters/direction' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-analysis' + examples: + default: + $ref: '#/components/examples/code-scanning-analysis-items' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}: + get: + summary: Get a code scanning analysis for a repository + description: >- + Gets a specified code scanning analysis for a repository. + + + The default JSON response contains fields that describe the analysis. + + This includes the Git reference and commit SHA to which the analysis + relates, + + the datetime of the analysis, the name of the code scanning tool, + + and the number of alerts. + + + The `rules_count` field in the default response give the number of rules + + that were run in the analysis. + + For very old analyses this data is not available, + + and `0` is returned in this field. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/sarif+json`**: Instead of returning a summary of the + analysis, this endpoint returns a subset of the analysis data that was + uploaded. The data is formatted as [SARIF version + 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + It also returns additional data such as the `github/alertNumber` and + `github/alertUrl` properties. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + operationId: code-scanning/get-analysis + tags: + - code-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: analysis_id + in: path + description: >- + The ID of the analysis, as returned from the `GET + /repos/{owner}/{repo}/code-scanning/analyses` operation. + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-analysis' + examples: + response: + $ref: '#/components/examples/code-scanning-analysis-default' + application/sarif+json: + schema: + type: object + additionalProperties: true + examples: + response: + $ref: '#/components/examples/code-scanning-analysis-sarif' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/unprocessable_analysis' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + delete: + summary: Delete a code scanning analysis from a repository + description: >- + Deletes a specified code scanning analysis from a repository. + + + You can delete one analysis at a time. + + To delete a series of analyses, start with the most recent analysis and + work backwards. + + Conceptually, the process is similar to the undo function in a text + editor. + + + When you list the analyses for a repository, + + one or more will be identified as deletable in the response: + + + ``` + + "deletable": true + + ``` + + + An analysis is deletable when it's the most recent in a set of analyses. + + Typically, a repository will have multiple sets of analyses + + for each enabled code scanning tool, + + where a set is determined by a unique combination of analysis values: + + + * `ref` + + * `tool` + + * `category` + + + If you attempt to delete an analysis that is not the most recent in a + set, + + you'll get a 400 response with the message: + + + ``` + + Analysis specified is not deletable. + + ``` + + + The response from a successful `DELETE` operation provides you with + + two alternative URLs for deleting the next analysis in the set: + + `next_analysis_url` and `confirm_delete_url`. + + Use the `next_analysis_url` URL if you want to avoid accidentally + deleting the final analysis + + in a set. This is a useful option if you want to preserve at least one + analysis + + for the specified tool in your repository. + + Use the `confirm_delete_url` URL if you are content to remove all + analyses for a tool. + + When you delete the last analysis in a set, the value of + `next_analysis_url` and `confirm_delete_url` + + in the 200 response is `null`. + + + As an example of the deletion process, + + let's imagine that you added a workflow that configured a particular + code scanning tool + + to analyze the code in a repository. This tool has added 15 analyses: + + 10 on the default branch, and another 5 on a topic branch. + + You therefore have two separate sets of analyses for this tool. + + You've now decided that you want to remove all of the analyses for the + tool. + + To do this you must make 15 separate deletion requests. + + To start, you must find an analysis that's identified as deletable. + + Each set of analyses always has one that's identified as deletable. + + Having found the deletable analysis for one of the two sets, + + delete this analysis and then continue deleting the next analysis in the + set until they're all deleted. + + Then repeat the process for the second set. + + The procedure therefore consists of a nested loop: + + + **Outer loop**: + + * List the analyses for the repository, filtered by tool. + + * Parse this list to find a deletable analysis. If found: + + **Inner loop**: + * Delete the identified analysis. + * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + + The above process assumes that you want to remove all trace of the + tool's analyses from the GitHub user interface, for the specified + repository, and it therefore uses the `confirm_delete_url` value. + Alternatively, you could use the `next_analysis_url` value, which would + leave the last analysis in each set undeleted to avoid removing a tool's + analysis entirely. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + operationId: code-scanning/delete-analysis + tags: + - code-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: analysis_id + in: path + description: >- + The ID of the analysis, as returned from the `GET + /repos/{owner}/{repo}/code-scanning/analyses` operation. + required: true + schema: + type: integer + - name: confirm_delete + in: query + description: >- + Allow deletion if the specified analysis is the last in a set. If + you attempt to delete the final analysis in a set without setting + this parameter to `true`, you'll get a 400 response with the + message: `Analysis is last of its type and deletion may result in + the loss of historical alert data. Please specify confirm_delete.` + required: false + schema: + type: string + nullable: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-analysis-deletion' + examples: + default-response: + $ref: '#/components/examples/code-scanning-analysis-deletion' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/databases: + get: + summary: List CodeQL databases for a repository + description: >- + Lists the CodeQL databases that are available in a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/list-codeql-databases + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-codeql-database' + examples: + default: + $ref: '#/components/examples/code-scanning-codeql-databases' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}: + get: + summary: Get a CodeQL database for a repository + description: >- + Gets a CodeQL database for a language in a repository. + + + By default this endpoint returns JSON metadata about the CodeQL + database. To + + download the CodeQL database binary content, set the `Accept` header of + the request + + to + [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), + and make sure + + your HTTP client is configured to follow redirects or use the `Location` + header + + to make a second request to get the redirect URL. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-codeql-database + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: language + in: path + description: The language of the CodeQL database. + schema: + type: string + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-codeql-database' + examples: + default: + $ref: '#/components/examples/code-scanning-codeql-database' + '302': + $ref: '#/components/responses/found' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + delete: + summary: Delete a CodeQL database + description: >- + Deletes a CodeQL database for a language in a repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/delete-codeql-database + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: language + in: path + description: The language of the CodeQL database. + schema: + type: string + required: true + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses: + post: + summary: Create a CodeQL variant analysis + description: >- + Creates a new CodeQL variant analysis, which will run a CodeQL query + against one or more repositories. + + + Get started by learning more about [running CodeQL queries at scale with + Multi-Repository Variant + Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + + + Use the `owner` and `repo` parameters in the URL to specify the + controller repository that + + will be used for running GitHub Actions workflows and storing the + results of the CodeQL variant analysis. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - code-scanning + operationId: code-scanning/create-variant-analysis + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + language: + $ref: '#/components/schemas/code-scanning-variant-analysis-language' + query_pack: + description: >- + A Base64-encoded tarball containing a CodeQL query and all + its dependencies + type: string + repositories: + type: array + description: >- + List of repository names (in the form `owner/repo-name`) to + run the query against. Precisely one property from + `repositories`, `repository_lists` and `repository_owners` + is required. + items: + type: string + repository_lists: + description: >- + List of repository lists to run the query against. Precisely + one property from `repositories`, `repository_lists` and + `repository_owners` is required. + type: array + maxItems: 1 + items: + type: string + repository_owners: + description: >- + List of organization or user names whose repositories the + query should be run against. Precisely one property from + `repositories`, `repository_lists` and `repository_owners` + is required. + type: array + maxItems: 1 + items: + type: string + required: + - language + - query_pack + - repositories + - repository_lists + - repository_owners + examples: + repositories_parameter: + summary: >- + Using the "repositories" field. "query_pack" is abridged for + brevity. + value: + language: csharp + query_pack: aGVsbG8= + repositories: + - octocat/Hello-World + - octocat/example + repository_owners: + summary: Using the "repository_owners" field. "query_pack" is abridged. + value: + language: csharp + query_pack: aGVsbG8= + repository_owners: + - octocat + repository_lists: + summary: Using the "repository_lists" field. "query_pack" is abridged. + value: + language: csharp + query_pack: aGVsbG8= + repository_lists: + - top-100-csharp + responses: + '201': + description: Variant analysis submitted for processing + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-variant-analysis' + examples: + repositories_parameter: + summary: Response for a successful variant analysis submission + value: + $ref: '#/components/examples/code-scanning-variant-analysis' + repository_owners: + summary: Response for a successful variant analysis submission + value: + $ref: '#/components/examples/code-scanning-variant-analysis' + repository_lists: + summary: Response for a successful variant analysis submission + value: + $ref: '#/components/examples/code-scanning-variant-analysis' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unable to process variant analysis submission + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}: + get: + summary: Get the summary of a CodeQL variant analysis + description: >- + Gets the summary of a CodeQL variant analysis. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/get-variant-analysis + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: codeql_variant_analysis_id + in: path + description: The unique identifier of the variant analysis. + schema: + type: integer + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-variant-analysis' + examples: + default: + $ref: '#/components/examples/code-scanning-variant-analysis' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}: + get: + summary: Get the analysis status of a repository in a CodeQL variant analysis + description: >- + Gets the analysis status of a repository in a CodeQL variant analysis. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + tags: + - code-scanning + operationId: code-scanning/get-variant-analysis-repo-task + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis + parameters: + - $ref: '#/components/parameters/owner' + - name: repo + in: path + description: The name of the controller repository. + schema: + type: string + required: true + - name: codeql_variant_analysis_id + in: path + description: The ID of the variant analysis. + schema: + type: integer + required: true + - name: repo_owner + in: path + description: >- + The account owner of the variant analysis repository. The name is + not case sensitive. + schema: + type: string + required: true + - name: repo_name + in: path + description: The name of the variant analysis repository. + schema: + type: string + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-variant-analysis-repo-task' + examples: + default: + $ref: >- + #/components/examples/code-scanning-variant-analysis-repo-task + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/default-setup: + get: + summary: Get a code scanning default setup configuration + description: >- + Gets a code scanning default setup configuration. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-default-setup + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-default-setup' + examples: + default: + $ref: '#/components/examples/code-scanning-default-setup' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + patch: + summary: Update a code scanning default setup configuration + description: >- + Updates a code scanning default setup configuration. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with private or public repositories, or the + `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/update-default-setup + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-default-setup-update' + examples: + default: + $ref: '#/components/examples/code-scanning-default-setup-update' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '202': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/code-scanning-default-setup-update-response + examples: + default: + $ref: >- + #/components/examples/code-scanning-default-setup-update-response + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/code_scanning_conflict' + '422': + $ref: '#/components/responses/code_scanning_invalid_state' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/sarifs: + post: + summary: Upload an analysis as SARIF data + description: "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it." + operationId: code-scanning/upload-sarif + tags: + - code-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + commit_sha: + $ref: '#/components/schemas/code-scanning-analysis-commit-sha' + ref: + $ref: '#/components/schemas/code-scanning-ref-full' + sarif: + $ref: '#/components/schemas/code-scanning-analysis-sarif-file' + checkout_uri: + description: >- + The base directory used in the analysis, as it appears in + the SARIF file. + + This property is used to convert file paths from absolute to + relative, so that alerts can be mapped to their correct + location in the repository. + example: file:///github/workspace/ + type: string + format: uri + started_at: + description: >- + The time that the analysis run began. This is a timestamp in + [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + type: string + tool_name: + description: >- + The name of the tool used to generate the code scanning + analysis. If this parameter is not used, the tool name + defaults to "API". If the uploaded SARIF contains a tool + GUID, this will be available for filtering using the + `tool_guid` parameter of operations such as `GET + /repos/{owner}/{repo}/code-scanning/alerts`. + type: string + validate: + description: >- + Whether the SARIF file will be validated according to the + code scanning specifications. + + This parameter is intended to help integrators ensure that + the uploaded SARIF files are correctly rendered by code + scanning. + type: boolean + additionalProperties: false + required: + - commit_sha + - ref + - sarif + examples: + default: + value: + commit_sha: 4b6472266afd7b471e86085a6659e8c7f2b119da + ref: refs/heads/master + sarif: >- + H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-sarifs-receipt' + examples: + default: + $ref: '#/components/examples/code-scanning-sarif-upload' + '400': + description: Bad Request if the sarif field is invalid + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '413': + description: Payload Too Large if the sarif field is too large + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}: + get: + summary: Get information about a SARIF upload + description: >- + Gets information about a SARIF upload, including the status and the URL + of the analysis that was uploaded so that you can retrieve details of + the analysis. For more information, see "[Get a code scanning analysis + for a + repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint with private or public + repositories, or the `public_repo` scope to use this endpoint with only + public repositories. + operationId: code-scanning/get-sarif + tags: + - code-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sarif_id + description: The SARIF ID obtained after uploading. + in: path + schema: + type: string + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-sarifs-status' + examples: + default: + $ref: '#/components/examples/code-scanning-sarif-upload-status' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + description: Not Found if the sarif id does not match any upload + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning +components: + schemas: + code-scanning-alert-state-query: + type: string + description: State of a code scanning alert. + enum: + - open + - closed + - dismissed + - fixed + code-scanning-alert-severity: + type: string + description: Severity of a code scanning alert. + enum: + - critical + - high + - medium + - low + - warning + - note + - error + code-scanning-organization-alert-items: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + instances_url: + $ref: '#/components/schemas/alert-instances-url' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + rule: + $ref: '#/components/schemas/code-scanning-alert-rule-summary' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + most_recent_instance: + $ref: '#/components/schemas/code-scanning-alert-instance' + repository: + $ref: '#/components/schemas/simple-repository' + dismissal_approved_by: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + - repository + code-scanning-alert-items: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + instances_url: + $ref: '#/components/schemas/alert-instances-url' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + rule: + $ref: '#/components/schemas/code-scanning-alert-rule-summary' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + most_recent_instance: + $ref: '#/components/schemas/code-scanning-alert-instance' + dismissal_approved_by: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + code-scanning-alert: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + instances_url: + $ref: '#/components/schemas/alert-instances-url' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + rule: + $ref: '#/components/schemas/code-scanning-alert-rule' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + most_recent_instance: + $ref: '#/components/schemas/code-scanning-alert-instance' + dismissal_approved_by: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + code-scanning-alert-set-state: + description: >- + Sets the state of the code scanning alert. You must provide + `dismissed_reason` when you set the state to `dismissed`. + type: string + enum: + - open + - dismissed + code-scanning-alert-dismissed-reason: + type: string + description: >- + **Required when the state is dismissed.** The reason for dismissing or + closing the alert. + nullable: true + enum: + - false positive + - won't fix + - used in tests + code-scanning-alert-dismissed-comment: + type: string + description: The dismissal comment associated with the dismissal of the alert. + nullable: true + maxLength: 280 + code-scanning-alert-create-request: + type: boolean + description: If `true`, attempt to create an alert dismissal request. + code-scanning-alert-assignees: + description: >- + The list of users to assign to the code scanning alert. An empty array + unassigns all previous assignees from the alert. + type: array + items: + type: string + code-scanning-autofix: + type: object + properties: + status: + $ref: '#/components/schemas/code-scanning-autofix-status' + description: + $ref: '#/components/schemas/code-scanning-autofix-description' + started_at: + $ref: '#/components/schemas/code-scanning-autofix-started-at' + required: + - status + - description + - started_at + code-scanning-autofix-commits: + description: Commit an autofix for a code scanning alert + type: object + properties: + target_ref: + description: >- + The Git reference of target branch for the commit. Branch needs to + already exist. For more information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + type: string + message: + description: Commit message to be used. + type: string + nullable: true + code-scanning-autofix-commits-response: + type: object + properties: + target_ref: + type: string + description: >- + The Git reference of target branch for the commit. For more + information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + sha: + type: string + description: SHA of commit with autofix. + code-scanning-alert-instance-list: + type: object + properties: + ref: + $ref: '#/components/schemas/code-scanning-ref' + analysis_key: + $ref: '#/components/schemas/code-scanning-analysis-analysis-key' + environment: + $ref: '#/components/schemas/code-scanning-alert-environment' + category: + $ref: '#/components/schemas/code-scanning-analysis-category' + state: + $ref: '#/components/schemas/code-scanning-alert-instance-state' + commit_sha: + type: string + message: + type: object + properties: + text: + type: string + location: + $ref: '#/components/schemas/code-scanning-alert-location' + html_url: + type: string + classifications: + type: array + description: >- + Classifications that have been applied to the file that triggered + the alert. + + For example identifying it as documentation, or a generated file. + items: + $ref: '#/components/schemas/code-scanning-alert-classification' + code-scanning-ref: + type: string + description: >- + The Git reference, formatted as `refs/pull//merge`, + `refs/pull//head`, + + `refs/heads/` or simply ``. + code-scanning-analysis-sarif-id: + type: string + description: An identifier for the upload. + example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 + code-scanning-analysis: + type: object + properties: + ref: + $ref: '#/components/schemas/code-scanning-ref' + commit_sha: + $ref: '#/components/schemas/code-scanning-analysis-commit-sha' + analysis_key: + $ref: '#/components/schemas/code-scanning-analysis-analysis-key' + environment: + $ref: '#/components/schemas/code-scanning-analysis-environment' + category: + $ref: '#/components/schemas/code-scanning-analysis-category' + error: + type: string + example: error reading field xyz + created_at: + $ref: '#/components/schemas/code-scanning-analysis-created-at' + results_count: + type: integer + description: The total number of results in the analysis. + rules_count: + type: integer + description: The total number of rules used in the analysis. + id: + type: integer + description: Unique identifier for this analysis. + url: + $ref: '#/components/schemas/code-scanning-analysis-url' + sarif_id: + $ref: '#/components/schemas/code-scanning-analysis-sarif-id' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + deletable: + type: boolean + warning: + type: string + description: Warning generated when processing the analysis + example: 123 results were ignored + required: + - ref + - commit_sha + - analysis_key + - environment + - error + - created_at + - results_count + - rules_count + - id + - url + - sarif_id + - tool + - deletable + - warning + code-scanning-analysis-deletion: + title: Analysis deletion + description: Successful deletion of a code scanning analysis + type: object + properties: + next_analysis_url: + type: string + description: >- + Next deletable analysis in chain, without last analysis deletion + confirmation + format: uri + readOnly: true + nullable: true + confirm_delete_url: + type: string + description: >- + Next deletable analysis in chain, with last analysis deletion + confirmation + format: uri + readOnly: true + nullable: true + required: + - next_analysis_url + - confirm_delete_url + code-scanning-codeql-database: + title: CodeQL Database + description: A CodeQL database. + type: object + properties: + id: + type: integer + description: The ID of the CodeQL database. + name: + type: string + description: The name of the CodeQL database. + language: + type: string + description: The language of the CodeQL database. + uploader: + $ref: '#/components/schemas/simple-user' + content_type: + type: string + description: The MIME type of the CodeQL database file. + size: + type: integer + description: The size of the CodeQL database file in bytes. + created_at: + type: string + format: date-time + description: >- + The date and time at which the CodeQL database was created, in ISO + 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: >- + The date and time at which the CodeQL database was last updated, in + ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + url: + type: string + format: uri + description: >- + The URL at which to download the CodeQL database. The `Accept` + header must be set to the value of the `content_type` property. + commit_oid: + type: string + description: >- + The commit SHA of the repository at the time the CodeQL database was + created. + nullable: true + required: + - id + - name + - language + - uploader + - content_type + - size + - created_at + - updated_at + - url + code-scanning-variant-analysis-language: + type: string + description: The language targeted by the CodeQL query + enum: + - actions + - cpp + - csharp + - go + - java + - javascript + - python + - ruby + - rust + - swift + code-scanning-variant-analysis: + title: Variant Analysis + description: A run of a CodeQL query against one or more repositories. + type: object + properties: + id: + type: integer + description: The ID of the variant analysis. + controller_repo: + $ref: '#/components/schemas/simple-repository' + actor: + $ref: '#/components/schemas/simple-user' + query_language: + $ref: '#/components/schemas/code-scanning-variant-analysis-language' + query_pack_url: + type: string + description: The download url for the query pack. + created_at: + type: string + format: date-time + description: >- + The date and time at which the variant analysis was created, in ISO + 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: >- + The date and time at which the variant analysis was last updated, in + ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + completed_at: + type: string + format: date-time + nullable: true + description: >- + The date and time at which the variant analysis was completed, in + ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant + analysis has not yet completed or this information is not available. + status: + type: string + enum: + - in_progress + - succeeded + - failed + - cancelled + actions_workflow_run_id: + type: integer + description: >- + The GitHub Actions workflow run used to execute this variant + analysis. This is only available if the workflow run has started. + failure_reason: + type: string + enum: + - no_repos_queried + - actions_workflow_run_failed + - internal_error + description: >- + The reason for a failure of the variant analysis. This is only + available if the variant analysis has failed. + scanned_repositories: + type: array + items: + type: object + properties: + repository: + $ref: '#/components/schemas/code-scanning-variant-analysis-repository' + analysis_status: + $ref: '#/components/schemas/code-scanning-variant-analysis-status' + result_count: + type: integer + description: >- + The number of results in the case of a successful analysis. + This is only available for successful analyses. + artifact_size_in_bytes: + type: integer + description: >- + The size of the artifact. This is only available for + successful analyses. + failure_message: + type: string + description: >- + The reason of the failure of this repo task. This is only + available if the repository task has failed. + required: + - repository + - analysis_status + skipped_repositories: + type: object + description: >- + Information about repositories that were skipped from processing. + This information is only available to the user that initiated the + variant analysis. + properties: + access_mismatch_repos: + $ref: >- + #/components/schemas/code-scanning-variant-analysis-skipped-repo-group + not_found_repos: + type: object + properties: + repository_count: + type: integer + description: >- + The total number of repositories that were skipped for this + reason. + example: 2 + repository_full_names: + type: array + description: >- + A list of full repository names that were skipped. This list + may not include all repositories that were skipped. + items: + type: string + required: + - repository_count + - repository_full_names + no_codeql_db_repos: + $ref: >- + #/components/schemas/code-scanning-variant-analysis-skipped-repo-group + over_limit_repos: + $ref: >- + #/components/schemas/code-scanning-variant-analysis-skipped-repo-group + required: + - access_mismatch_repos + - not_found_repos + - no_codeql_db_repos + - over_limit_repos + required: + - id + - controller_repo + - actor + - query_language + - query_pack_url + - status + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + code-scanning-variant-analysis-repo-task: + type: object + properties: + repository: + $ref: '#/components/schemas/simple-repository' + analysis_status: + $ref: '#/components/schemas/code-scanning-variant-analysis-status' + artifact_size_in_bytes: + type: integer + description: >- + The size of the artifact. This is only available for successful + analyses. + result_count: + type: integer + description: >- + The number of results in the case of a successful analysis. This is + only available for successful analyses. + failure_message: + type: string + description: >- + The reason of the failure of this repo task. This is only available + if the repository task has failed. + database_commit_sha: + type: string + description: >- + The SHA of the commit the CodeQL database was built against. This is + only available for successful analyses. + source_location_prefix: + type: string + description: >- + The source location prefix to use. This is only available for + successful analyses. + artifact_url: + type: string + description: >- + The URL of the artifact. This is only available for successful + analyses. + required: + - repository + - analysis_status + code-scanning-default-setup: + description: Configuration for code scanning default setup. + type: object + properties: + state: + description: Code scanning default setup has been configured or not. + type: string + enum: + - configured + - not-configured + languages: + description: Languages to be analyzed. + type: array + items: + type: string + enum: + - actions + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - javascript + - python + - ruby + - typescript + - swift + runner_type: + description: Runner type to be used. + nullable: true + type: string + enum: + - standard + - labeled + runner_label: + description: Runner label to be used if the runner type is labeled. + nullable: true + type: string + example: code-scanning + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + threat_model: + description: >- + Threat model to be used for code scanning analysis. Use `remote` to + analyze only network sources and `remote_and_local` to include local + sources like filesystem access, command-line arguments, database + reads, environment variable and standard input. + type: string + enum: + - remote + - remote_and_local + updated_at: + description: Timestamp of latest configuration update. + nullable: true + type: string + format: date-time + example: '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + nullable: true + type: string + enum: + - weekly + x-github-breaking-changes: + - changeset: remove_single_js_ts + patch: + properties: + languages: + items: + enum: + - actions + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - python + - ruby + - swift + type: object + version: '2026-03-10' + code-scanning-default-setup-update: + description: Configuration for code scanning default setup. + type: object + properties: + state: + description: The desired state of code scanning default setup. + type: string + enum: + - configured + - not-configured + runner_type: + description: Runner type to be used. + type: string + enum: + - standard + - labeled + runner_label: + nullable: true + description: Runner label to be used if the runner type is labeled. + type: string + example: code-scanning + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + threat_model: + description: >- + Threat model to be used for code scanning analysis. Use `remote` to + analyze only network sources and `remote_and_local` to include local + sources like filesystem access, command-line arguments, database + reads, environment variable and standard input. + type: string + enum: + - remote + - remote_and_local + languages: + description: CodeQL languages to be analyzed. + type: array + items: + type: string + enum: + - actions + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - python + - ruby + - swift + additionalProperties: false + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + code-scanning-default-setup-update-response: + description: >- + You can use `run_url` to track the status of the run. This includes a + property status and conclusion. + + You should not rely on this always being an actions workflow run object. + type: object + properties: + run_id: + description: ID of the corresponding run. + type: integer + run_url: + description: URL of the corresponding run. + type: string + code-scanning-analysis-commit-sha: + description: The SHA of the commit to which the analysis you are uploading relates. + type: string + minLength: 40 + maxLength: 40 + pattern: ^[0-9a-fA-F]+$ + code-scanning-ref-full: + type: string + description: >- + The full Git reference, formatted as `refs/heads/`, + + `refs/tags/`, `refs/pull//merge`, or + `refs/pull//head`. + pattern: ^refs/(heads|tags|pull)/.*$ + example: refs/heads/main + code-scanning-analysis-sarif-file: + description: >- + A Base64 string representing the SARIF file to upload. You must first + compress your SARIF file using + [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then + translate the contents of the file into a Base64 encoding string. For + more information, see "[SARIF support for code + scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." + type: string + code-scanning-sarifs-receipt: + type: object + properties: + id: + $ref: '#/components/schemas/code-scanning-analysis-sarif-id' + url: + type: string + description: The REST API URL for checking the status of the upload. + format: uri + readOnly: true + code-scanning-sarifs-status: + type: object + properties: + processing_status: + type: string + enum: + - pending + - complete + - failed + description: >- + `pending` files have not yet been processed, while `complete` means + results from the SARIF have been stored. `failed` files have either + not been processed at all, or could only be partially processed. + analyses_url: + type: string + description: >- + The REST API URL for getting the analyses associated with the + upload. + format: uri + readOnly: true + nullable: true + errors: + type: array + items: + type: string + description: Any errors that ocurred during processing of the delivery. + readOnly: true + nullable: true + code-scanning-analysis-tool-name: + type: string + description: The name of the tool used to generate the code scanning analysis. + code-scanning-analysis-tool-guid: + nullable: true + type: string + description: >- + The GUID of the tool used to generate the code scanning analysis, if + provided in the uploaded SARIF data. + alert-number: + type: integer + description: The security alert number. + readOnly: true + alert-created-at: + type: string + description: >- + The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + alert-updated-at: + type: string + description: >- + The time that the alert was last updated in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + alert-instances-url: + type: string + description: The REST API URL for fetching the list of instances for an alert. + format: uri + readOnly: true + code-scanning-alert-state: + type: string + description: State of a code scanning alert. + nullable: true + enum: + - open + - dismissed + - fixed + alert-fixed-at: + type: string + description: >- + The time that the alert was no longer detected and was considered fixed + in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + alert-dismissed-at: + type: string + description: >- + The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + code-scanning-alert-rule-summary: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect the alert. + name: + type: string + description: The name of the rule used to detect the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + security_severity_level: + nullable: true + type: string + description: The security severity of the alert. + enum: + - low + - medium + - high + - critical + description: + type: string + description: A short description of the rule used to detect the alert. + full_description: + type: string + description: A description of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string + help: + nullable: true + type: string + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + nullable: true + type: string + description: A link to the documentation for the rule used to detect the alert. + code-scanning-analysis-tool: + type: object + properties: + name: + $ref: '#/components/schemas/code-scanning-analysis-tool-name' + version: + $ref: '#/components/schemas/code-scanning-analysis-tool-version' + guid: + $ref: '#/components/schemas/code-scanning-analysis-tool-guid' + code-scanning-alert-instance: + type: object + properties: + ref: + $ref: '#/components/schemas/code-scanning-ref' + analysis_key: + $ref: '#/components/schemas/code-scanning-analysis-analysis-key' + environment: + $ref: '#/components/schemas/code-scanning-alert-environment' + category: + $ref: '#/components/schemas/code-scanning-analysis-category' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + commit_sha: + type: string + message: + type: object + properties: + text: + type: string + markdown: + type: string + description: >- + The message text as GitHub-flavored Markdown, with placeholder + links for related locations replaced by links to the relevant + code. Only populated when related locations are available for + the alert instance. + location: + $ref: '#/components/schemas/code-scanning-alert-location' + html_url: + type: string + classifications: + type: array + description: >- + Classifications that have been applied to the file that triggered + the alert. + + For example identifying it as documentation, or a generated file. + items: + $ref: '#/components/schemas/code-scanning-alert-classification' + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-scanning-alert-rule: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect the alert. + name: + type: string + description: The name of the rule used to detect the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + security_severity_level: + nullable: true + type: string + description: The security severity of the alert. + enum: + - low + - medium + - high + - critical + description: + type: string + description: A short description of the rule used to detect the alert. + full_description: + type: string + description: A description of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string + help: + nullable: true + type: string + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + nullable: true + type: string + description: A link to the documentation for the rule used to detect the alert. + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + code-scanning-autofix-status: + type: string + description: The status of an autofix. + enum: + - pending + - error + - success + - outdated + code-scanning-autofix-description: + type: string + description: The description of an autofix. + nullable: true + code-scanning-autofix-started-at: + type: string + description: 'The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-analysis-analysis-key: + type: string + description: >- + Identifies the configuration under which the analysis was executed. For + example, in GitHub Actions this includes the workflow filename and job + name. + code-scanning-alert-environment: + type: string + description: >- + Identifies the variable values associated with the environment in which + the analysis that generated this alert instance was performed, such as + the language that was analyzed. + code-scanning-analysis-category: + type: string + description: >- + Identifies the configuration under which the analysis was executed. Used + to distinguish between multiple analyses for the same tool and commit, + but performed on different languages or different parts of the code. + code-scanning-alert-instance-state: + type: string + description: State of a code scanning alert instance. + nullable: true + enum: + - open + - fixed + code-scanning-alert-location: + type: object + description: Describe a region within a file for the alert. + properties: + path: + type: string + start_line: + type: integer + end_line: + type: integer + start_column: + type: integer + end_column: + type: integer + code-scanning-alert-classification: + type: string + description: A classification of the file. For example to identify it as generated. + nullable: true + enum: + - source + - generated + - test + - library + code-scanning-analysis-environment: + type: string + description: >- + Identifies the variable values associated with the environment in which + this analysis was performed. + code-scanning-analysis-created-at: + type: string + description: >- + The time that the analysis was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + code-scanning-analysis-url: + type: string + description: The REST API URL of the analysis resource. + format: uri + readOnly: true + code-scanning-variant-analysis-repository: + title: Repository Identifier + description: Repository Identifier + type: object + properties: + id: + type: integer + example: 1296269 + description: A unique identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + private: + type: boolean + description: Whether the repository is private. + stargazers_count: + type: integer + example: 80 + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + required: + - full_name + - id + - name + - private + - stargazers_count + - updated_at + code-scanning-variant-analysis-status: + type: string + description: The new status of the CodeQL variant analysis repository task. + enum: + - pending + - in_progress + - succeeded + - failed + - canceled + - timed_out + code-scanning-variant-analysis-skipped-repo-group: + type: object + properties: + repository_count: + type: integer + description: The total number of repositories that were skipped for this reason. + example: 2 + repositories: + type: array + description: >- + A list of repositories that were skipped. This list may not include + all repositories that were skipped. This is only available when the + repository was found and the user has access to it. + items: + $ref: '#/components/schemas/code-scanning-variant-analysis-repository' + required: + - repository_count + - repositories + code-scanning-analysis-tool-version: + nullable: true + type: string + description: The version of the tool used to generate the code scanning analysis. + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + not_modified: + description: Not modified + code_scanning_forbidden_read: + description: Response if GitHub Advanced Security is not enabled for this repository + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + code_scanning_forbidden_write: + description: >- + Response if the repository is archived or if GitHub Advanced Security is + not enabled for this repository + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + code_scanning_bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + default: + $ref: '#/components/examples/code-scanning-bad-request' + code_scanning_autofix_create_forbidden: + description: >- + Response if the repository is archived, if GitHub Advanced Security is + not enabled for this repository or if rate limit is exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + unprocessable_analysis: + description: Response if analysis could not be processed + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + found: + description: Found + code_scanning_conflict: + description: >- + Response if there is already a validation run in progress with a + different default setup configuration + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + code_scanning_invalid_state: + description: >- + Response if the configuration change cannot be made because the + repository is not in the required state + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + tool-name: + name: tool_name + description: >- + The name of a code scanning tool. Only results by this tool will be + listed. You can specify the tool by using either `tool_name` or + `tool_guid`, but not both. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-analysis-tool-name' + tool-guid: + name: tool_guid + description: >- + The GUID of a code scanning tool. Only results by this tool will be + listed. Note that some code scanning tools may not include a GUID in + their analysis data. You can specify the tool by using either + `tool_guid` or `tool_name`, but not both. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-analysis-tool-guid' + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + git-ref: + name: ref + description: >- + The Git reference for the results you want to list. The `ref` for a + branch can be formatted either as `refs/heads/` or simply + ``. To reference a pull request use + `refs/pull//merge`. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-ref' + pr-alias: + name: pr + description: The number of the pull request for the results you want to list. + in: query + required: false + schema: + type: integer + alert-number: + name: alert_number + in: path + description: >- + The number that identifies an alert. You can find this at the end of the + URL for a code scanning alert within GitHub, and in the `number` field + in the response from the `GET + /repos/{owner}/{repo}/code-scanning/alerts` operation. + required: true + schema: + $ref: '#/components/schemas/alert-number' + examples: + code-scanning-organization-alert-items: + value: + - number: 4 + created_at: '2020-02-13T12:29:18Z' + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 + html_url: https://github.com/octocat/hello-world/code-scanning/4 + state: open + dismissed_by: null + dismissed_at: null + dismissed_reason: null + dismissed_comment: null + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + - number: 3 + created_at: '2020-02-13T12:29:18Z' + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 + html_url: https://github.com/octocat/hello-world/code-scanning/3 + state: dismissed + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + dismissed_comment: >- + This alert is not actually correct, because there's a sanitizer + included in the library. + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: lib/ab12-gen.js + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: [] + instances_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + code-scanning-alert-items: + value: + - number: 4 + created_at: '2020-02-13T12:29:18Z' + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 + html_url: https://github.com/octocat/hello-world/code-scanning/4 + state: open + fixed_at: null + dismissed_by: null + dismissed_at: null + dismissed_reason: null + dismissed_comment: null + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances + - number: 3 + created_at: '2020-02-13T12:29:18Z' + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 + html_url: https://github.com/octocat/hello-world/code-scanning/3 + state: dismissed + fixed_at: null + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + dismissed_comment: >- + This alert is not actually correct, because there's a sanitizer + included in the library. + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: lib/ab12-gen.js + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: [] + instances_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances + code-scanning-alert: + value: + number: 42 + created_at: '2020-06-19T11:21:34Z' + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 + html_url: https://github.com/octocat/hello-world/code-scanning/42 + state: dismissed + fixed_at: null + dismissed_by: + login: octocat + id: 54933897 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + dismissed_comment: >- + This alert is not actually correct, because there's a sanitizer + included in the library. + rule: + id: js/zipslip + severity: error + security_severity_level: high + description: Arbitrary file write during zip extraction ("Zip Slip") + name: js/zipslip + full_description: >- + Extracting files from a malicious zip archive without validating + that the destination file path is within the destination directory + can cause files outside the destination directory to be overwritten. + tags: + - security + - external/cwe/cwe-022 + help: >- + # Arbitrary file write during zip extraction ("Zip + Slip")\nExtracting files from a malicious zip archive without + validating that the destination file path is within the destination + directory can cause files outside the destination directory to be + overwritten ... + help_uri: https://codeql.github.com/ + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: dismissed + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances + code-scanning-alert-dismissed: + value: + number: 42 + created_at: '2020-08-25T21:28:36Z' + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 + html_url: https://github.com/octocat/hello-world/code-scanning/42 + state: dismissed + fixed_at: null + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-09-02T22:34:56Z' + dismissed_reason: false positive + dismissed_comment: >- + This alert is not actually correct, because there's a sanitizer + included in the library. + rule: + id: js/zipslip + severity: error + security_severity_level: high + description: Arbitrary file write during zip extraction ("Zip Slip") + name: js/zipslip + full_description: >- + Extracting files from a malicious zip archive without validating + that the destination file path is within the destination directory + can cause files outside the destination directory to be overwritten. + tags: + - security + - external/cwe/cwe-022 + help: >- + # Arbitrary file write during zip extraction ("Zip + Slip")\nExtracting files from a malicious zip archive without + validating that the destination file path is within the destination + directory can cause files outside the destination directory to be + overwritten ... + help_uri: https://codeql.github.com/ + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: dismissed + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances + code-scanning-autofix: + value: + status: success + description: This fixes an XSS vulnerability by escaping the user input. + started_at: '2024-02-14T12:29:18Z' + code-scanning-autofix-pending: + value: + status: pending + description: null + started_at: '2024-02-14T12:29:18Z' + code-scanning-autofix-commits: + value: + target_ref: refs/heads/fix-bug + message: Let's fix this πŸͺ²! + code-scanning-autofix-commits-response: + value: + target_ref: refs/heads/main + sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 + code-scanning-alert-instances: + value: + - ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '' + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: lib/ab12-gen.js + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - library + - ref: refs/pull/3740/merge + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '' + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + state: fixed + commit_sha: b09da05606e27f463a2b49287684b4ae777092f2 + message: + text: >- + This suffix check is missing a length comparison to correctly + handle lastIndexOf returning -1. + location: + path: app/script.js + start_line: 2 + end_line: 2 + start_column: 10 + end_column: 50 + classifications: + - source + code-scanning-analysis-items: + value: + - ref: refs/heads/main + commit_sha: d99612c3e1f2970085cfbaeadf8f010ef69bad83 + analysis_key: .github/workflows/codeql-analysis.yml:analyze + environment: '{"language":"python"}' + error: '' + category: .github/workflows/codeql-analysis.yml:analyze/language:python + created_at: '2020-08-27T15:05:21Z' + results_count: 17 + rules_count: 49 + id: 201 + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201 + sarif_id: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 + tool: + name: CodeQL + guid: null + version: 2.4.0 + deletable: true + warning: '' + - ref: refs/heads/my-branch + commit_sha: c8cff6510d4d084fb1b4aa13b64b97ca12b07321 + analysis_key: .github/workflows/shiftleft.yml:build + environment: '{}' + error: '' + category: .github/workflows/shiftleft.yml:build/ + created_at: '2020-08-31T22:46:44Z' + results_count: 17 + rules_count: 32 + id: 200 + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200 + sarif_id: 8981cd8e-b078-4ac3-a3be-1dad7dbd0b582 + tool: + name: Python Security Analysis + guid: null + version: 1.2.0 + deletable: true + warning: '' + code-scanning-analysis-default: + summary: application/json response + value: + ref: refs/heads/main + commit_sha: c18c69115654ff0166991962832dc2bd7756e655 + analysis_key: .github/workflows/codeql-analysis.yml:analyze + environment: '{"language":"javascript"}' + error: '' + category: .github/workflows/codeql-analysis.yml:analyze/language:javascript + created_at: '2021-01-13T11:55:49Z' + results_count: 3 + rules_count: 67 + id: 3602840 + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201 + sarif_id: 47177e22-5596-11eb-80a1-c1e54ef945c6 + tool: + name: CodeQL + guid: null + version: 2.4.0 + deletable: true + warning: '' + code-scanning-analysis-sarif: + summary: application/sarif+json response + value: + runs: + - tool: + driver: + name: CodeQL + organization: GitHub + semanticVersion: 1.0.0 + rules: + - id: js/unused-local-variable + name: js/unused-local-variable + results: + - guid: 326aa09f-9af8-13cf-9851-3d0e5183ec38 + message: + text: Unused variable foo. + locations: + - physicalLocation: + artifactLocation: + uri: file1.js + region: + startLine: 1 + ruleId: js/unused-local-variable + properties: + - github/alertNumber: 2 + - github/alertUrl: >- + https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 + type: object + code-scanning-analysis-deletion: + summary: Default response + value: + next_analysis_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 + confirm_delete_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete + code-scanning-codeql-databases: + value: + - id: 1 + name: database.zip + language: java + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: application/zip + size: 1024 + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + url: >- + https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c + - id: 2 + name: database.zip + language: ruby + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: application/zip + size: 1024 + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + url: >- + https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c + code-scanning-codeql-database: + value: + id: 1 + name: database.zip + language: java + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: application/zip + size: 1024 + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + url: >- + https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c + code-scanning-variant-analysis: + summary: Default response + value: + id: 1 + controller_repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + query_language: python + query_pack_url: https://www.example.com + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + completed_at: '2022-09-12T13:15:33Z' + status: succeeded + actions_workflow_run_id: 3453588 + scanned_repositories: + - repository: + id: 1296269 + name: Hello-World + full_name: octocat/Hello-World + private: false + analysis_status: succeeded + result_count: 532 + artifact_size_in_bytes: 12345 + skipped_repositories: + access_mismatch_repos: + repository_count: 2 + repositories: + - id: 1 + name: octo-repo1 + full_name: octo-org/octo-repo1 + private: false + - id: 2 + name: octo-repo2 + full_name: octo-org/octo-repo2 + private: false + not_found_repos: + repository_count: 3 + repository_full_names: + - octo-org/octo-repo4 + - octo-org/octo-repo5 + - octo-org/octo-repo6 + no_codeql_db_repos: + repository_count: 2 + repositories: + - id: 7 + name: octo-repo7 + full_name: octo-org/octo-repo7 + private: false + - id: 8 + name: octo-repo8 + full_name: octo-org/octo-repo8 + private: false + over_limit_repos: + repository_count: 2 + repositories: + - id: 9 + name: octo-repo9 + full_name: octo-org/octo-repo9 + private: false + - id: 10 + name: octo-repo10 + full_name: octo-org/octo-repo10 + private: false + code-scanning-variant-analysis-repo-task: + summary: Default response + value: + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + analysis_status: succeeded + artifact_size_in_bytes: 12345 + result_count: 532 + database_commit_sha: 2d870c2a717a524627af38fa2da382188a096f90 + source_location_prefix: / + artifact_url: https://example.com + code-scanning-default-setup: + value: + state: configured + languages: + - ruby + - python + query_suite: default + threat_model: remote + updated_at: '2023-01-19T11:21:34Z' + schedule: weekly + code-scanning-default-setup-update: + value: + state: configured + threat_model: remote_and_local + code-scanning-default-setup-update-response: + value: + run_id: 42 + run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 + code-scanning-sarif-upload: + summary: Default response + value: + id: 47177e22-5596-11eb-80a1-c1e54ef945c6 + url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 + code-scanning-sarif-upload-status: + summary: Default response + value: + processing_status: complete + analyses_url: >- + https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 + code-scanning-bad-request: + value: + message: The alert_number is not valid + documentation_url: >- + https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + status: '400' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + alert_items: + id: github.code_scanning.alert_items + name: alert_items + title: Alert Items + methods: + list_alerts_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1code-scanning~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_alerts_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/alert_items/methods/list_alerts_for_repo + - $ref: >- + #/components/x-stackQL-resources/alert_items/methods/list_alerts_for_org + insert: [] + update: [] + delete: [] + replace: [] + alerts: + id: github.code_scanning.alerts + name: alerts + title: Alerts + methods: + get_alert: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_alert: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get_alert' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/alerts/methods/update_alert' + delete: [] + replace: [] + alert_autofixes: + id: github.code_scanning.alert_autofixes + name: alert_autofixes + title: Alert Autofixes + methods: + get_autofix: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}~1autofix/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_autofix: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}~1autofix/post + response: + mediaType: application/json + openAPIDocKey: '200' + commit_autofix: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}~1autofix~1commits/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/alert_autofixes/methods/get_autofix + insert: + - $ref: >- + #/components/x-stackQL-resources/alert_autofixes/methods/create_autofix + update: [] + delete: [] + replace: [] + alert_instances: + id: github.code_scanning.alert_instances + name: alert_instances + title: Alert Instances + methods: + list_alert_instances: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}~1instances/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/alert_instances/methods/list_alert_instances + insert: [] + update: [] + delete: [] + replace: [] + analysis: + id: github.code_scanning.analysis + name: analysis + title: Analysis + methods: + list_recent_analyses: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1analyses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_analysis: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1analyses~1{analysis_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_analysis: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1analyses~1{analysis_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/analysis/methods/get_analysis' + - $ref: >- + #/components/x-stackQL-resources/analysis/methods/list_recent_analyses + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/analysis/methods/delete_analysis' + replace: [] + codeql_databases: + id: github.code_scanning.codeql_databases + name: codeql_databases + title: Codeql Databases + methods: + list_codeql_databases: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1databases/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_codeql_database: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1databases~1{language}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_codeql_database: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1databases~1{language}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codeql_databases/methods/get_codeql_database + - $ref: >- + #/components/x-stackQL-resources/codeql_databases/methods/list_codeql_databases + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/codeql_databases/methods/delete_codeql_database + replace: [] + codeql_variant_analyses: + id: github.code_scanning.codeql_variant_analyses + name: codeql_variant_analyses + title: Codeql Variant Analyses + methods: + create_variant_analysis: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1variant-analyses/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_variant_analysis: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1variant-analyses~1{codeql_variant_analysis_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codeql_variant_analyses/methods/get_variant_analysis + insert: + - $ref: >- + #/components/x-stackQL-resources/codeql_variant_analyses/methods/create_variant_analysis + update: [] + delete: [] + replace: [] + codeql_variant_analysis_repo_tasks: + id: github.code_scanning.codeql_variant_analysis_repo_tasks + name: codeql_variant_analysis_repo_tasks + title: Codeql Variant Analysis Repo Tasks + methods: + get_variant_analysis_repo_task: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1variant-analyses~1{codeql_variant_analysis_id}~1repos~1{repo_owner}~1{repo_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codeql_variant_analysis_repo_tasks/methods/get_variant_analysis_repo_task + insert: [] + update: [] + delete: [] + replace: [] + default_setup: + id: github.code_scanning.default_setup + name: default_setup + title: Default Setup + methods: + get_default_setup: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1default-setup/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_default_setup: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1default-setup/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/default_setup/methods/get_default_setup + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/default_setup/methods/update_default_setup + delete: [] + replace: [] + sarifs: + id: github.code_scanning.sarifs + name: sarifs + title: Sarifs + methods: + upload_sarif: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1sarifs/post' + response: + mediaType: application/json + openAPIDocKey: '202' + get_sarif: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1sarifs~1{sarif_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sarifs/methods/get_sarif' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/sarifs/methods/upload_sarif' + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/code_security.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/code_security.yaml new file mode 100644 index 0000000..dce5802 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/code_security.yaml @@ -0,0 +1,3520 @@ +openapi: 3.0.3 +info: + title: code_security API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/code-security/configurations: + get: + summary: Get code security configurations for an enterprise + description: >- + Lists all code security configurations available in an enterprise. + + + The authenticated user must be an administrator of the enterprise in + order to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configurations-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - name: per_page + in: query + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: >- + #/components/examples/enterprise-code-security-configuration-list + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + post: + summary: Create a code security configuration for an enterprise + description: >- + Creates a code security configuration in an enterprise. + + + The authenticated user must be an administrator of the enterprise in + order to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: >- + The name of the code security configuration. Must be unique + within the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: > + The enablement status of GitHub Advanced Security features. + `enabled` will enable both Code Security and Secret + Protection features. + + + > [!WARNING] + + > `code_security` and `secret_protection` are deprecated + values for this field. Prefer the individual `code_security` + and `secret_protection` fields to set the status of these + features. + enum: + - enabled + - disabled + - code_security + - secret_protection + default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: >- + Whether to use runners labeled with + 'dependency-submission' or standard GitHub runners. + default: false + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_non_provider_patterns: + type: string + description: >- + The enablement status of secret scanning non provider + patterns + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of secret scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: High rish settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/defaults: + get: + summary: Get default code security configurations for an enterprise + description: >- + Lists the default code security configurations for an enterprise. + + + The authenticated user must be an administrator of the enterprise in + order to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-default-configurations' + examples: + default: + $ref: '#/components/examples/code-security-default-configurations' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}: + get: + summary: Retrieve a code security configuration of an enterprise + description: >- + Gets a code security configuration available in an enterprise. + + + The authenticated user must be an administrator of the enterprise in + order to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-single-configuration-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + patch: + summary: Update a custom code security configuration for an enterprise + description: >- + Updates a code security configuration in an enterprise. + + + The authenticated user must be an administrator of the enterprise in + order to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/update-enterprise-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: >- + The name of the code security configuration. Must be unique + across the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: > + The enablement status of GitHub Advanced Security features. + `enabled` will enable both Code Security and Secret + Protection features. + + + > [!WARNING] + + > `code_security` and `secret_protection` are deprecated + values for this field. Prefer the individual `code_security` + and `secret_protection` fields to set the status of these + features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: >- + Whether to use runners labeled with + 'dependency-submission' or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: >- + The enablement status of secret scanning non-provider + patterns + enum: + - enabled + - disabled + - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of secret scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-enterprise recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + delete: + summary: Delete a code security configuration for an enterprise + description: >- + Deletes a code security configuration from an enterprise. + + Repositories attached to the configuration will retain their settings + but will no longer be associated with + + the configuration. + + + The authenticated user must be an administrator for the enterprise to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach: + post: + summary: Attach an enterprise configuration to repositories + description: >- + Attaches an enterprise code security configuration to repositories. If + the repositories specified are already attached to a configuration, they + will be re-attached to the provided configuration. + + + If insufficient GHAS licenses are available to attach the configuration + to a repository, only free features will be enabled. + + + The authenticated user must be an administrator for the enterprise to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-enterprise-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration to. + enum: + - all + - all_without_configurations + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: all + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults: + put: + summary: Set a code security configuration as a default for an enterprise + description: >- + Sets a code security configuration as a default to be applied to new + repositories in your enterprise. + + + This configuration will be applied by default to the matching repository + type when created, but only for organizations within the enterprise that + do not already have a default code security configuration set. + + + The authenticated user must be an administrator for the enterprise to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: >- + Specify which types of repository this security + configuration should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: >- + Set this configuration to be enabled by default on all new + repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: >- + Specifies which types of repository this security + configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + value: + default_for_new_repos: all + configuration: + $ref: '#/components/examples/code-security-configuration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories: + get: + summary: >- + Get repositories associated with an enterprise code security + configuration + description: >- + Lists the repositories associated with an enterprise code security + configuration in an organization. + + + The authenticated user must be an administrator of the enterprise in + order to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-repositories-for-enterprise-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + - name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: status + description: >- + A comma-separated list of statuses. If specified, only repositories + with these attachment statuses will be returned. + + + Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, + `failed`, `updating`, `removed_by_enterprise` + in: query + required: false + schema: + type: string + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: >- + #/components/schemas/code-security-configuration-repositories + examples: + default: + summary: Example of code security configuration repositories + value: + - status: attached + repository: + $ref: '#/components/examples/simple-repository' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations: + get: + summary: Get code security configurations for an organization + description: >- + Lists all code security configurations available in an organization. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configurations-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: target_type + in: query + description: The target type of the code security configuration + required: false + schema: + type: string + enum: + - global + - all + default: all + - name: per_page + in: query + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration-list' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + post: + summary: Create a code security configuration + description: >- + Creates a code security configuration in an organization. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: >- + The name of the code security configuration. Must be unique + within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: > + The enablement status of GitHub Advanced Security features. + `enabled` will enable both Code Security and Secret + Protection features. + + + > [!WARNING] + + > `code_security` and `secret_protection` are deprecated + values for this field. Prefer the individual `code_security` + and `secret_protection` fields to set the status of these + features. + enum: + - enabled + - disabled + - code_security + - secret_protection + default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: >- + Whether to use runners labeled with + 'dependency-submission' or standard GitHub runners. + default: false + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: >- + The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: not_set + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: >- + The bypass reviewers for secret scanning delegated + bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: >- + The ID of the team or role selected as a bypass + reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_non_provider_patterns: + type: string + description: >- + The enablement status of secret scanning non provider + patterns + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of secret scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/defaults: + get: + summary: Get default code security configurations + description: >- + Lists the default code security configurations for an organization. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-default-configurations' + examples: + default: + $ref: '#/components/examples/code-security-default-configurations' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/detach: + delete: + summary: Detach configurations from repositories + description: >- + Detach code security configuration(s) from a set of repositories. + + Repositories will retain their settings but will no longer be associated + with the configuration. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/detach-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + selected_repository_ids: + type: array + description: >- + An array of repository IDs to detach from configurations. Up + to 250 IDs can be provided. + minItems: 1 + maxItems: 250 + items: + type: integer + description: Unique identifier of the repository. + examples: + default: + summary: Example for detaching repositories from configurations. + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + $ref: '#/components/responses/no_content' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}: + get: + summary: Get a code security configuration + description: >- + Gets a code security configuration available in an organization. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + patch: + summary: Update a code security configuration + description: >- + Updates a code security configuration in an organization. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/update-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: >- + The name of the code security configuration. Must be unique + within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: > + The enablement status of GitHub Advanced Security features. + `enabled` will enable both Code Security and Secret + Protection features. + + + > [!WARNING] + + > `code_security` and `secret_protection` are deprecated + values for this field. Prefer the individual `code_security` + and `secret_protection` fields to set the status of these + features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: >- + Whether to use runners labeled with + 'dependency-submission' or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + dependabot_delegated_alert_dismissal: + type: string + description: >- + The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: >- + The bypass reviewers for secret scanning delegated + bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: >- + The ID of the team or role selected as a bypass + reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: >- + The enablement status of secret scanning non-provider + patterns + enum: + - enabled + - disabled + - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: >- + The enablement status of secret scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-org recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled + responses: + '200': + description: Response when a configuration is updated + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration-updated' + '204': + description: Response when no new updates are made + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + delete: + summary: Delete a code security configuration + description: >- + Deletes the desired code security configuration from an organization. + + Repositories attached to the configuration will retain their settings + but will no longer be associated with + + the configuration. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}/attach: + post: + summary: Attach a configuration to repositories + description: >- + Attach a code security configuration to a set of repositories. If the + repositories specified are already attached to a configuration, they + will be re-attached to the provided configuration. + + + If insufficient GHAS licenses are available to attach the configuration + to a repository, only free features will be enabled. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: >- + The type of repositories to attach the configuration to. + `selected` means the configuration will be attached to only + the repositories specified by `selected_repository_ids` + enum: + - all + - all_without_configurations + - public + - private_or_internal + - selected + selected_repository_ids: + type: array + description: >- + An array of repository IDs to attach the configuration to. + You can only provide a list of repository ids when the + `scope` is set to `selected`. + items: + type: integer + description: Unique identifier of the repository. + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: selected + selected_repository_ids: + - 32 + - 91 + responses: + '202': + $ref: '#/components/responses/accepted' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}/defaults: + put: + summary: Set a code security configuration as a default for an organization + description: >- + Sets a code security configuration as a default to be applied to new + repositories in your organization. + + + This configuration will be applied to the matching repository type (all, + none, public, private and internal) by default when they are created. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: >- + Specify which types of repository this security + configuration should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: >- + Set this configuration to be enabled by default on all new + repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: >- + Specifies which types of repository this security + configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + value: + default_for_new_repos: all + configuration: + $ref: '#/components/examples/code-security-configuration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}/repositories: + get: + summary: Get repositories associated with a code security configuration + description: >- + Lists the repositories associated with a code security configuration in + an organization. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-repositories-for-configuration + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + - name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: status + description: >- + A comma-separated list of statuses. If specified, only repositories + with these attachment statuses will be returned. + + + Can be: `all`, `attached`, `attaching`, `detached`, `removed`, + `enforced`, `failed`, `updating`, `removed_by_enterprise` + in: query + required: false + schema: + type: string + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: >- + #/components/schemas/code-security-configuration-repositories + examples: + default: + summary: Example of code security configuration repositories + value: + - status: attached + repository: + $ref: '#/components/examples/simple-repository' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /repos/{owner}/{repo}/code-security-configuration: + get: + summary: Get the code security configuration associated with a repository + description: >- + Get the code security configuration that manages a repository's code + security settings. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration-for-repository + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: >- + #/components/schemas/code-security-configuration-for-repository + examples: + default: + $ref: >- + #/components/examples/code-security-configuration-for-repository + '204': + $ref: '#/components/responses/no_content' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations +components: + schemas: + code-security-configuration: + type: object + description: A code security configuration + properties: + id: + type: integer + description: The ID of the code security configuration + name: + type: string + description: >- + The name of the code security configuration. Must be unique within + the organization. + target_type: + type: string + description: The type of the code security configuration. + enum: + - global + - organization + - enterprise + description: + type: string + description: A description of the code security configuration + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + - code_security + - secret_protection + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: >- + Whether to use runners labeled with 'dependency-submission' or + standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true + properties: + allow_advanced: + nullable: true + type: boolean + description: Whether to allow repos which use advanced setup + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + type: object + description: Feature options for code scanning default setup + nullable: true + properties: + runner_type: + nullable: true + type: string + enum: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + nullable: true + type: string + description: >- + The label of the runner to use for code scanning when + runner_type is 'labeled'. + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + security_configuration_id: + type: integer + description: >- + The ID of the security configuration associated with this + bypass reviewer + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + url: + type: string + format: uri + description: The URL of the configuration + html_url: + type: string + format: uri + description: The URL of the configuration + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + code-scanning-options: + type: object + description: Security Configuration feature options for code scanning + nullable: true + properties: + allow_advanced: + nullable: true + type: boolean + description: Whether to allow repos which use advanced setup + code-scanning-default-setup-options: + type: object + description: Feature options for code scanning default setup + nullable: true + properties: + runner_type: + type: string + enum: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + nullable: true + type: string + description: >- + The label of the runner to use for code scanning default setup when + runner_type is 'labeled'. + code-security-default-configurations: + type: array + description: A list of default code security configurations + items: + type: object + properties: + default_for_new_repos: + enum: + - public + - private_and_internal + - all + description: >- + The visibility of newly created repositories for which the code + security configuration will be applied to by default + configuration: + $ref: '#/components/schemas/code-security-configuration' + code-security-configuration-repositories: + type: object + description: >- + Repositories associated with a code security configuration and + attachment status + properties: + status: + type: string + description: >- + The attachment status of the code security configuration on the + repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + repository: + $ref: '#/components/schemas/simple-repository' + code-security-configuration-for-repository: + type: object + description: >- + Code security configuration associated with a repository and attachment + status + properties: + status: + type: string + description: >- + The attachment status of the code security configuration on the + repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + configuration: + $ref: '#/components/schemas/code-security-configuration' + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + not_modified: + description: Not modified + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + no_content: + description: A header with no content is returned. + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + configuration-id: + name: configuration_id + description: The unique identifier of the code security configuration. + in: path + required: true + schema: + type: integer + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + examples: + enterprise-code-security-configuration-list: + value: + - id: 17 + target_type: global + name: GitHub recommended + description: >- + Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: >- + https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17 + html_url: >- + https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: enterprise + name: High risk settings + description: >- + This is a code security configuration for octo-enterprise high risk + repositories + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: >- + https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326 + html_url: >- + https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + enterprise-code-security-configuration: + value: + id: 1325 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: >- + https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 + html_url: >- + https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-default-configurations: + value: + - default_for_new_repos: public + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: >- + https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + - default_for_new_repos: private_and_internal + configuration: + id: 17 + target_type: global + name: GitHub recommended + description: >- + Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: >- + https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + code-security-configuration: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 1325 + reviewer_id: 5678 + reviewer_type: TEAM + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + simple-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + code-security-configuration-list: + value: + - id: 17 + target_type: global + name: GitHub recommended + description: >- + Suggested settings for Dependabot, secret scanning, and code + scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + secret_scanning_delegated_alert_dismissal: not_set + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: organization + name: High risk settings + description: >- + This is a code security configuration for octo-org high risk + repositories + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: >- + https://api.github.com/orgs/octo-org/code-security/configurations/1326 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + code-security-configuration-updated: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings v2 + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: disabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-configuration-for-repository: + value: + status: attached + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: >- + https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: >- + https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + x-stackQL-resources: + code_security_configurations: + id: github.code_security.code_security_configurations + name: code_security_configurations + title: Code Security Configurations + methods: + get_configurations_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_configuration_for_enterprise: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_single_configuration_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1{configuration_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_enterprise_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1{configuration_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_configuration_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1{configuration_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + attach_enterprise_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1{configuration_id}~1attach/post + response: + mediaType: application/json + openAPIDocKey: '202' + set_configuration_as_default_for_enterprise: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1{configuration_id}~1defaults/put + response: + mediaType: application/json + openAPIDocKey: '200' + get_configurations_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1code-security~1configurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1code-security~1configurations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + detach_configuration: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1detach/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get_configuration: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1{configuration_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1{configuration_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_configuration: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1{configuration_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + attach_configuration: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1{configuration_id}~1attach/post + response: + mediaType: application/json + openAPIDocKey: '202' + set_configuration_as_default: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1{configuration_id}~1defaults/put + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/get_single_configuration_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/get_configuration + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/get_configurations_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/get_configurations_for_org + insert: + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/attach_enterprise_configuration + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/attach_configuration + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/create_configuration_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/create_configuration + update: + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/update_enterprise_configuration + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/update_configuration + delete: + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/delete_configuration_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/delete_configuration + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/detach_configuration + replace: + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/set_configuration_as_default_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/code_security_configurations/methods/set_configuration_as_default + code_security_default_configurations: + id: github.code_security.code_security_default_configurations + name: code_security_default_configurations + title: Code Security Default Configurations + methods: + get_default_configurations_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1defaults/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_default_configurations: + operation: + $ref: '#/paths/~1orgs~1{org}~1code-security~1configurations~1defaults/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/code_security_default_configurations/methods/get_default_configurations_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/code_security_default_configurations/methods/get_default_configurations + insert: [] + update: [] + delete: [] + replace: [] + code_security_configuration_repos: + id: github.code_security.code_security_configuration_repos + name: code_security_configuration_repos + title: Code Security Configuration Repos + methods: + get_repositories_for_enterprise_configuration: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1code-security~1configurations~1{configuration_id}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_repositories_for_configuration: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1code-security~1configurations~1{configuration_id}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/code_security_configuration_repos/methods/get_repositories_for_enterprise_configuration + - $ref: >- + #/components/x-stackQL-resources/code_security_configuration_repos/methods/get_repositories_for_configuration + insert: [] + update: [] + delete: [] + replace: [] + repo_code_security_configuration: + id: github.code_security.repo_code_security_configuration + name: repo_code_security_configuration + title: Repo Code Security Configuration + methods: + get_configuration_for_repository: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1code-security-configuration/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_code_security_configuration/methods/get_configuration_for_repository + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/codes_of_conduct.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/codes_of_conduct.yaml new file mode 100644 index 0000000..c510d77 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/codes_of_conduct.yaml @@ -0,0 +1,371 @@ +openapi: 3.0.3 +info: + title: codes_of_conduct API + description: github API + version: 1.1.4 +paths: + /codes_of_conduct: + get: + summary: Get all codes of conduct + description: Returns array of all GitHub's codes of conduct. + tags: + - codes-of-conduct + operationId: codes-of-conduct/get-all-codes-of-conduct + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-of-conduct' + examples: + default: + $ref: '#/components/examples/code-of-conduct-simple-items' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codes-of-conduct + subcategory: codes-of-conduct + x-stackQL-resource: codes_of_conduct + /codes_of_conduct/{key}: + get: + summary: Get a code of conduct + description: Returns information about the specified GitHub code of conduct. + tags: + - codes-of-conduct + operationId: codes-of-conduct/get-conduct-code + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct + parameters: + - name: key + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-of-conduct' + examples: + default: + $ref: '#/components/examples/code-of-conduct' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codes-of-conduct + subcategory: codes-of-conduct + x-stackQL-resource: codes_of_conduct +components: + schemas: + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + code-of-conduct-simple-items: + value: + - key: citizen_code_of_conduct + name: Citizen Code of Conduct + url: https://api.github.com/codes_of_conduct/citizen_code_of_conduct + html_url: http://citizencodeofconduct.org/ + - key: contributor_covenant + name: Contributor Covenant + url: https://api.github.com/codes_of_conduct/contributor_covenant + html_url: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ + code-of-conduct: + value: + key: contributor_covenant + name: Contributor Covenant + url: https://api.github.com/codes_of_conduct/contributor_covenant + body: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we as + contributors and maintainers pledge to making participation in our + project and our community a harassment-free experience for everyone, + regardless of age, body size, disability, ethnicity, gender identity + and expression, level of experience, nationality, personal appearance, + race, religion, or sexual identity and orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate in + a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, + or reject comments, commits, code, wiki edits, issues, and other + contributions that are not aligned to this Code of Conduct, or to ban + temporarily or permanently any contributor for other behaviors that + they deem inappropriate, threatening, offensive, or harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in public + spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The project + team will review and investigate all complaints, and will respond in a + way that it deems appropriate to the circumstances. The project team + is obligated to maintain confidentiality with regard to the reporter + of an incident. Further details of specific enforcement policies may + be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: http://contributor-covenant.org/version/1/4/ + x-stackQL-resources: + codes_of_conduct: + id: github.codes_of_conduct.codes_of_conduct + name: codes_of_conduct + title: Codes Of Conduct + methods: + get_all_codes_of_conduct: + operation: + $ref: '#/paths/~1codes_of_conduct/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_conduct_code: + operation: + $ref: '#/paths/~1codes_of_conduct~1{key}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codes_of_conduct/methods/get_conduct_code + - $ref: >- + #/components/x-stackQL-resources/codes_of_conduct/methods/get_all_codes_of_conduct + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/codespaces.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/codespaces.yaml new file mode 100644 index 0000000..80b8e69 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/codespaces.yaml @@ -0,0 +1,8898 @@ +openapi: 3.0.3 +info: + title: codespaces API + description: Endpoints to manage Codespaces using the REST API. + version: 1.1.4 +paths: + /orgs/{org}/codespaces: + get: + summary: List codespaces for the organization + description: >- + Lists the codespaces associated to a specified organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-in-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/codespaces/access: + put: + summary: Manage access control for organization codespaces + description: >- + Sets which users can access codespaces in an organization. This is + synonymous with granting or revoking codespaces access permissions for + users according to the visibility. + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-codespaces-access + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces + parameters: + - $ref: '#/components/parameters/org' + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + visibility: + type: string + description: >- + Which users can access codespaces in the organization. + `disabled` means that no users can access codespaces in the + organization. + enum: + - disabled + - selected_members + - all_members + - all_members_and_outside_collaborators + selected_usernames: + type: array + description: >- + The usernames of the organization members who should have + access to codespaces in the organization. Required when + `visibility` is `selected_members`. The provided list of + usernames will replace any existing value. + items: + type: string + maxItems: 100 + required: + - visibility + examples: + default: + value: + visibility: selected_members + selected_usernames: + - johnDoe + - atomIO + responses: + '204': + description: Response when successfully modifying permissions. + '304': + $ref: '#/components/responses/not_modified' + '400': + description: Users are neither members nor collaborators of this organization. + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/codespaces/access/selected_users: + post: + summary: Add users to Codespaces access for an organization + description: >- + Codespaces for the specified users will be billed to the organization. + + + To use this endpoint, the access settings for the organization must be + set to `selected_members`. + + For information on how to change this setting, see "[Manage access + control for organization + codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-codespaces-access-users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: >- + The usernames of the organization members and outside + collaborators whose codespaces should be billed to the + organization. + items: + type: string + maxItems: 100 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - johnDoe + - atomIO + responses: + '204': + description: Response when successfully modifying permissions. + '304': + $ref: '#/components/responses/not_modified' + '400': + description: Users are neither members nor collaborators of this organization. + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + delete: + summary: Remove users from Codespaces access for an organization + description: >- + Codespaces for the specified users will no longer be billed to the + organization. + + + To use this endpoint, the access settings for the organization must be + set to `selected_members`. + + For information on how to change this setting, see "[Manage access + control for organization + codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-codespaces-access-users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization + deprecated: true + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: >- + The usernames of the organization members and outside + collaborators whose codespaces should not be billed to the + organization. + items: + type: string + maxItems: 100 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - johnDoe + - atomIO + responses: + '204': + description: Response when successfully modifying permissions. + '304': + $ref: '#/components/responses/not_modified' + '400': + description: Users are neither members nor collaborators of this organization. + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/codespaces/secrets: + get: + summary: List organization secrets + description: >- + Lists all Codespaces development environment secrets available at the + organization-level without revealing their encrypted + + values. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-org-secrets + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/codespaces-org-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/public-key: + get: + summary: Get an organization public key + description: >- + Gets a public key for an organization, which is required in order to + encrypt secrets. You need to encrypt the value of a secret before you + can create or update secrets. + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-org-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-public-key' + examples: + default: + $ref: '#/components/examples/codespaces-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/{secret_name}: + get: + summary: Get an organization secret + description: >- + Gets an organization development environment secret without revealing + its encrypted value. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-org-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + put: + summary: Create or update an organization secret + description: >- + Creates or updates an organization development environment secret with + an encrypted value. Encrypt your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-or-update-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + The value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get an organization + public + key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: The ID of the key you used to encrypt the secret. + visibility: + type: string + description: >- + Which type of organization repositories have access to the + organization secret. `selected` means only the repositories + specified by `selected_repository_ids` can access the + secret. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: >- + An array of repository IDs that can access the organization + secret. You can only provide a list of repository IDs when + the `visibility` is set to `selected`. You can manage the + list of selected repositories using the [List selected + repositories for an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + type: integer + required: + - visibility + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + delete: + summary: Delete an organization secret + description: >- + Deletes an organization development environment secret using the secret + name. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for an organization secret + description: >- + Lists all repositories that have been selected when the `visibility` + + for repository access to a secret is set to `selected`. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + put: + summary: Set selected repositories for an organization secret + description: >- + Replaces all repositories for an organization development environment + secret when the `visibility` + + for repository access is set to `selected`. The visibility is set when + you [Create + + or update an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + secret. You can only provide a list of repository ids when + the `visibility` is set to `selected`. You can add and + remove individual repositories using the [Set selected + repositories for an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict when visibility type not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization secret + description: >- + Adds a repository to an organization development environment secret when + the `visibility` for repository access is set to `selected`. The + visibility is set when you [Create or update an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/add-selected-repo-to-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict when visibility type is not set to selected + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + delete: + summary: Remove selected repository from an organization secret + description: >- + Removes a repository from an organization development environment secret + when the `visibility` + + for repository access is set to `selected`. The visibility is set when + you [Create + + or update an organization + secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/remove-selected-repo-from-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response when repository was removed from the selected list + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict when visibility type not set to selected + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/members/{username}/codespaces: + get: + summary: List codespaces for a user in organization + description: >- + Lists the codespaces that a member of an organization has for + repositories in that organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-codespaces-for-user-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/members/{username}/codespaces/{codespace_name}: + delete: + summary: Delete a codespace from the organization + description: >- + Deletes a user's codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-from-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/codespace-name' + responses: + '202': + $ref: '#/components/responses/accepted' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop: + post: + summary: Stop a codespace for an organization user + description: >- + Stops a user's codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/stop-in-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /repos/{owner}/{repo}/codespaces: + get: + summary: List codespaces in a repository for the authenticated user + description: >- + Lists the codespaces associated to a specified repository and the + authenticated user. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-in-repository-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list-for-repository' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + post: + summary: Create a codespace in a repository + description: >- + Creates a codespace owned by the authenticated user in the specified + repository. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-with-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + nullable: true + properties: + ref: + description: Git ref (typically a branch name) for this codespace + type: string + location: + description: >- + The requested location for a new codespace. Best efforts are + made to respect this upon creation. Assigned by IP if not + provided. + type: string + geo: + description: >- + The geographic area for this codespace. If not specified, + the value is assigned by IP. This property replaces + `location`, which is closing down. + type: string + enum: + - EuropeWest + - SoutheastAsia + - UsEast + - UsWest + client_ip: + description: IP for location auto-detection when proxying a request + type: string + machine: + description: Machine type to use for this codespace + type: string + devcontainer_path: + description: Path to devcontainer.json config to use for this codespace + type: string + multi_repo_permissions_opt_out: + description: >- + Whether to authorize requested permissions from + devcontainer.json + type: boolean + working_directory: + description: Working directory for this codespace + type: string + idle_timeout_minutes: + description: Time in minutes before codespace stops from inactivity + type: integer + display_name: + description: Display name for this codespace + type: string + retention_period_minutes: + description: >- + Duration in minutes after codespace has gone idle in which + it will be deleted. Must be integer minutes between 0 and + 43200 (30 days). + type: integer + examples: + default: + value: + ref: main + machine: standardLinux32gb + responses: + '201': + description: Response when the codespace was successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '202': + description: >- + Response when the codespace creation partially failed but is being + retried in the background + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/devcontainers: + get: + summary: >- + List devcontainer configurations in a repository for the authenticated + user + description: >- + Lists the devcontainer.json files associated with a specified repository + and the authenticated user. These files + + specify launchpoint configurations for codespaces created within the + repository. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - devcontainers + properties: + total_count: + type: integer + devcontainers: + type: array + items: + type: object + required: + - path + properties: + path: + type: string + name: + type: string + display_name: + type: string + examples: + default: + $ref: >- + #/components/examples/codespaces-list-devcontainers-for-repository + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/machines: + get: + summary: List available machine types for a repository + description: >- + List the machine types available for a given repository based on its + configuration. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/repo-machines-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: location + description: >- + The location to check for available machines. Assigned by IP if not + provided. + in: query + schema: + type: string + example: WestUs2 + - name: client_ip + description: IP for location auto-detection when proxying a request + in: query + schema: + type: string + - name: ref + description: >- + The branch or commit to check for prebuild availability and + devcontainer restrictions. + in: query + schema: + type: string + example: main + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machines + properties: + total_count: + type: integer + machines: + type: array + items: + $ref: '#/components/schemas/codespace-machine' + examples: + default: + $ref: '#/components/examples/codespace-machines-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: machines + x-stackQL-resource: machines + /repos/{owner}/{repo}/codespaces/new: + get: + summary: Get default attributes for a codespace + description: >- + Gets the default attributes for codespaces created by the user with the + repository. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/pre-flight-with-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: >- + The branch or commit to check for a default devcontainer path. If + not specified, the default branch will be checked. + in: query + schema: + type: string + example: main + - name: client_ip + description: >- + An alternative IP for default location auto-detection, such as when + proxying a request. + in: query + schema: + type: string + example: 1.2.3.4 + responses: + '200': + description: >- + Response when a user is able to create codespaces from the + repository. + content: + application/json: + schema: + type: object + properties: + billable_owner: + $ref: '#/components/schemas/simple-user' + defaults: + type: object + required: + - location + - devcontainer_path + properties: + location: + type: string + devcontainer_path: + type: string + nullable: true + examples: + default: + $ref: >- + #/components/examples/codespaces-default-attributes-for-a-codespace + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/permissions_check: + get: + summary: >- + Check if permissions defined by a devcontainer have been accepted by the + authenticated user + description: >- + Checks whether the permissions defined by a given devcontainer + configuration have been accepted by the authenticated user. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/check-permissions-for-devcontainer + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: >- + The git reference that points to the location of the devcontainer + configuration to use for the permission check. The value of `ref` + will typically be a branch name (`heads/BRANCH_NAME`). For more + information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + in: query + required: true + schema: + type: string + example: master + - name: devcontainer_path + description: >- + Path to the devcontainer.json configuration to use for the + permission check. + in: query + required: true + schema: + type: string + example: .devcontainer/example/devcontainer.json + responses: + '200': + description: Response when the permission check is successful + content: + application/json: + schema: + $ref: >- + #/components/schemas/codespaces-permissions-check-for-devcontainer + examples: + default: + $ref: >- + #/components/examples/codespaces-permissions-check-for-devcontainer + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/secrets: + get: + summary: List repository secrets + description: >- + Lists all development environment secrets available in a repository + without revealing their encrypted + + values. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-repo-secrets + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/repo-codespaces-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + /repos/{owner}/{repo}/codespaces/secrets/public-key: + get: + summary: Get a repository public key + description: >- + Gets your public key, which you need to encrypt secrets. You need to + + encrypt a secret before you can create or update secrets. + + + If the repository is private, OAuth app tokens and personal access + tokens (classic) need the `repo` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-repo-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-public-key' + examples: + default: + $ref: '#/components/examples/codespaces-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + /repos/{owner}/{repo}/codespaces/secrets/{secret_name}: + get: + summary: Get a repository secret + description: >- + Gets a single repository development environment secret without + revealing its encrypted value. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repo-codespaces-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + put: + summary: Create or update a repository secret + description: >- + Creates or updates a repository development environment secret with an + encrypted value. Encrypt your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. The associated user must be a repository + admin. + tags: + - codespaces + operationId: codespaces/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get a repository + public + key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + delete: + summary: Delete a repository secret + description: >- + Deletes a development environment secret in a repository using the + secret name. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. The associated user must be a repository + admin. + tags: + - codespaces + operationId: codespaces/delete-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + /repos/{owner}/{repo}/pulls/{pull_number}/codespaces: + post: + summary: Create a codespace from a pull request + description: >- + Creates a codespace owned by the authenticated user for the specified + pull request. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-with-pr-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + nullable: true + properties: + location: + description: >- + The requested location for a new codespace. Best efforts are + made to respect this upon creation. Assigned by IP if not + provided. + type: string + geo: + description: >- + The geographic area for this codespace. If not specified, + the value is assigned by IP. This property replaces + `location`, which is closing down. + type: string + enum: + - EuropeWest + - SoutheastAsia + - UsEast + - UsWest + client_ip: + description: IP for location auto-detection when proxying a request + type: string + machine: + description: Machine type to use for this codespace + type: string + devcontainer_path: + description: Path to devcontainer.json config to use for this codespace + type: string + multi_repo_permissions_opt_out: + description: >- + Whether to authorize requested permissions from + devcontainer.json + type: boolean + working_directory: + description: Working directory for this codespace + type: string + idle_timeout_minutes: + description: Time in minutes before codespace stops from inactivity + type: integer + display_name: + description: Display name for this codespace + type: string + retention_period_minutes: + description: >- + Duration in minutes after codespace has gone idle in which + it will be deleted. Must be integer minutes between 0 and + 43200 (30 days). + type: integer + examples: + default: + value: + repository_id: 1 + ref: main + responses: + '201': + description: Response when the codespace was successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '202': + description: >- + Response when the codespace creation partially failed but is being + retried in the background + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces: + get: + summary: List codespaces for the authenticated user + description: >- + Lists the authenticated user's codespaces. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/repository-id-in-query' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + post: + summary: Create a codespace for the authenticated user + description: >- + Creates a new codespace, owned by the authenticated user. + + + This endpoint requires either a `repository_id` OR a `pull_request` but + not both. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - repository_id + - pull_request + properties: + repository_id: + description: Repository id for this codespace + type: integer + ref: + description: Git ref (typically a branch name) for this codespace + type: string + location: + description: >- + The requested location for a new codespace. Best efforts are + made to respect this upon creation. Assigned by IP if not + provided. + type: string + geo: + description: >- + The geographic area for this codespace. If not specified, + the value is assigned by IP. This property replaces + `location`, which is closing down. + type: string + enum: + - EuropeWest + - SoutheastAsia + - UsEast + - UsWest + client_ip: + description: IP for location auto-detection when proxying a request + type: string + machine: + description: Machine type to use for this codespace + type: string + devcontainer_path: + description: Path to devcontainer.json config to use for this codespace + type: string + multi_repo_permissions_opt_out: + description: >- + Whether to authorize requested permissions from + devcontainer.json + type: boolean + working_directory: + description: Working directory for this codespace + type: string + idle_timeout_minutes: + description: Time in minutes before codespace stops from inactivity + type: integer + display_name: + description: Display name for this codespace + type: string + retention_period_minutes: + description: >- + Duration in minutes after codespace has gone idle in which + it will be deleted. Must be integer minutes between 0 and + 43200 (30 days). + type: integer + pull_request: + required: + - pull_request_number + - repository_id + description: Pull request number for this codespace + type: object + properties: + pull_request_number: + description: Pull request number + type: integer + repository_id: + description: Repository id for this codespace + type: integer + examples: + default: + value: + repository_id: 1 + ref: main + geo: UsWest + responses: + '201': + description: Response when the codespace was successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '202': + description: >- + Response when the codespace creation partially failed but is being + retried in the background + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/secrets: + get: + summary: List secrets for the authenticated user + description: >- + Lists all development environment secrets available for a user's + codespaces without revealing their + + encrypted values. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-secrets-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/codespaces-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/public-key: + get: + summary: Get public key for the authenticated user + description: >- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-public-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-user-public-key' + examples: + default: + $ref: '#/components/examples/codespaces-user-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/{secret_name}: + get: + summary: Get a secret for the authenticated user + description: >- + Gets a development environment secret available to a user's codespaces + without revealing its encrypted value. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-secret' + examples: + default: + $ref: '#/components/examples/user-codespaces-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update a secret for the authenticated user + description: >- + Creates or updates a development environment secret for a user's + codespace with an encrypted value. Encrypt your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-or-update-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get the public key + for the authenticated + user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the user secret. + You can manage the list of selected repositories using the + [List selected repositories for a user + secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), + [Set selected repositories for a user + secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), + and [Remove a selected repository from a user + secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) + endpoints. + items: + anyOf: + - type: integer + - type: string + required: + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + selected_repository_ids: + - '1234567' + - '2345678' + responses: + '201': + description: Response after successfully creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response after successfully updating a secret + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete a secret for the authenticated user + description: >- + Deletes a development environment secret from a user's codespaces using + the secret name. Deleting the secret will remove access from all + codespaces that were allowed to access the secret. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for a user secret + description: >- + List the repositories that have been granted the ability to use a user's + development environment secret. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-repositories-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-paginated' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Set selected repositories for a user secret + description: >- + Select the repositories that will use a user's development environment + secret. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-repositories-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: >- + An array of repository ids for which a codespace can access + the secret. You can manage the list of selected repositories + using the [List selected repositories for a user + secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), + [Add a selected repository to a user + secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), + and [Remove a selected repository from a user + secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - '1296269' + - '1296280' + responses: + '204': + description: No Content when repositories were added to the selected list + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add a selected repository to a user secret + description: >- + Adds a repository to the selected repositories for a user's development + environment secret. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/add-repository-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Remove a selected repository from a user secret + description: >- + Removes a repository from the selected repositories for a user's + development environment secret. + + + The authenticated user must have Codespaces access to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/remove-repository-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was removed from the selected list + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/{codespace_name}: + get: + summary: Get a codespace for the authenticated user + description: >- + Gets information about a user's codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + patch: + summary: Update a codespace for the authenticated user + description: >- + Updates a codespace owned by the authenticated user. Currently only the + codespace's machine type and recent folders can be modified using this + endpoint. + + + If you specify a new machine type it will be applied the next time your + codespace is started. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/update-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + machine: + description: A valid machine to transition this codespace to. + type: string + display_name: + description: Display name for this codespace + type: string + recent_folders: + description: >- + Recently opened folders inside the codespace. It is + currently used by the clients to determine the folder path + to load the codespace in. + type: array + items: + type: string + examples: + default: + value: + machine: standardLinux + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + delete: + summary: Delete a codespace for the authenticated user + description: >- + Deletes a user's codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '202': + $ref: '#/components/responses/accepted' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/exports: + post: + summary: Export a codespace for the authenticated user + description: >- + Triggers an export of the specified codespace and returns a URL and ID + where the status of the export can be monitored. + + + If changes cannot be pushed to the codespace's repository, they will be + pushed to a new or previously-existing fork instead. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/export-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace-export-details' + examples: + default: + $ref: '#/components/examples/user-export-details' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/exports/{export_id}: + get: + summary: Get details about a codespace export + description: >- + Gets information about an export of a codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-export-details-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export + parameters: + - $ref: '#/components/parameters/codespace-name' + - $ref: '#/components/parameters/export-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace-export-details' + examples: + default: + $ref: '#/components/examples/user-export-details' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/machines: + get: + summary: List machine types for a codespace + description: >- + List the machine types a codespace can transition to use. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/codespace-machines-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machines + properties: + total_count: + type: integer + machines: + type: array + items: + $ref: '#/components/schemas/codespace-machine' + examples: + default: + $ref: '#/components/examples/codespace-machines-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: machines + x-stackQL-resource: machines + /user/codespaces/{codespace_name}/publish: + post: + summary: Create a repository from an unpublished codespace + description: >- + Publishes an unpublished codespace, creating a new repository and + assigning it to the codespace. + + + The codespace's token is granted write permissions to the repository, + allowing the user to push their changes. + + + This will fail for a codespace that is already published, meaning it has + an associated repository. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/publish-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace + parameters: + - $ref: '#/components/parameters/codespace-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: A name for the new repository. + type: string + private: + description: Whether the new repository should be private. + type: boolean + default: false + examples: + default: + value: + repository: monalisa-octocat-hello-world-g4wpq6h95q + private: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace-with-full-repository' + examples: + default: + $ref: '#/components/examples/codespace-with-full-repository' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/start: + post: + summary: Start a codespace for the authenticated user + description: >- + Starts a user's codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/start-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '402': + description: Payment required + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/stop: + post: + summary: Stop a codespace for the authenticated user + description: >- + Stops a user's codespace. + + + OAuth app tokens and personal access tokens (classic) need the + `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/stop-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces +components: + schemas: + codespace: + type: object + title: Codespace + description: A codespace. + properties: + id: + type: integer + format: int64 + example: 1 + name: + description: Automatically generated name of this codespace. + type: string + example: monalisa-octocat-hello-world-g4wpq6h95q + display_name: + description: Display name for this codespace. + type: string + example: bookish space pancake + nullable: true + environment_id: + description: UUID identifying this codespace's environment. + type: string + example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + nullable: true + owner: + $ref: '#/components/schemas/simple-user' + billable_owner: + $ref: '#/components/schemas/simple-user' + repository: + $ref: '#/components/schemas/minimal-repository' + machine: + $ref: '#/components/schemas/nullable-codespace-machine' + devcontainer_path: + description: Path to devcontainer.json from repo root used to create Codespace. + type: string + example: .devcontainer/example/devcontainer.json + nullable: true + prebuild: + description: Whether the codespace was created from a prebuild. + type: boolean + example: false + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + last_used_at: + description: Last known time this codespace was started. + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + state: + description: State of this codespace. + enum: + - Unknown + - Created + - Queued + - Provisioning + - Available + - Awaiting + - Unavailable + - Deleted + - Moved + - Shutdown + - Archived + - Starting + - ShuttingDown + - Failed + - Exporting + - Updating + - Rebuilding + example: Available + type: string + url: + description: API URL for this codespace. + type: string + format: uri + git_status: + description: Details about the codespace's git repository. + type: object + properties: + ahead: + description: >- + The number of commits the local repository is ahead of the + remote. + type: integer + example: 0 + behind: + description: The number of commits the local repository is behind the remote. + type: integer + example: 0 + has_unpushed_changes: + description: Whether the local repository has unpushed changes. + type: boolean + has_uncommitted_changes: + description: Whether the local repository has uncommitted changes. + type: boolean + ref: + description: >- + The current branch (or SHA if in detached HEAD state) of the + local repository. + type: string + example: main + location: + description: The initally assigned location of a new codespace. + enum: + - EastUs + - SouthEastAsia + - WestEurope + - WestUs2 + example: WestUs2 + type: string + idle_timeout_minutes: + description: >- + The number of minutes of inactivity after which this codespace will + be automatically stopped. + type: integer + example: 60 + nullable: true + web_url: + description: URL to access this codespace on the web. + type: string + format: uri + machines_url: + description: >- + API URL to access available alternate machine types for this + codespace. + type: string + format: uri + start_url: + description: API URL to start this codespace. + type: string + format: uri + stop_url: + description: API URL to stop this codespace. + type: string + format: uri + publish_url: + description: API URL to publish this codespace to a new repository. + type: string + format: uri + nullable: true + pulls_url: + description: API URL for the Pull Request associated with this codespace, if any. + type: string + format: uri + nullable: true + recent_folders: + type: array + items: + type: string + runtime_constraints: + type: object + properties: + allowed_port_privacy_settings: + description: >- + The privacy settings a user can select from when forwarding a + port. + type: array + items: + type: string + nullable: true + pending_operation: + description: >- + Whether or not a codespace has a pending async operation. This would + mean that the codespace is temporarily unavailable. The only thing + that you can do with a codespace in this state is delete it. + type: boolean + nullable: true + pending_operation_disabled_reason: + description: Text to show user when codespace is disabled by a pending operation + type: string + nullable: true + idle_timeout_notice: + description: >- + Text to show user when codespace idle timeout minutes has been + overriden by an organization policy + type: string + nullable: true + retention_period_minutes: + description: >- + Duration in minutes after codespace has gone idle in which it will + be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + example: 60 + nullable: true + retention_expires_at: + description: >- + When a codespace will be auto-deleted based on the + "retention_period_minutes" and "last_used_at" + type: string + format: date-time + example: '2011-01-26T20:01:12Z' + nullable: true + last_known_stop_notice: + description: >- + The text to display to a user when a codespace has been stopped for + a potentially actionable reason. + type: string + example: you've used 100% of your spending limit for Codespaces + nullable: true + required: + - id + - name + - environment_id + - owner + - billable_owner + - repository + - machine + - prebuild + - created_at + - updated_at + - last_used_at + - state + - url + - git_status + - location + - idle_timeout_minutes + - web_url + - machines_url + - start_url + - stop_url + - pulls_url + - recent_folders + codespaces-org-secret: + title: Codespaces Secret + description: Secrets for a GitHub Codespace. + type: object + properties: + name: + description: The name of the secret + example: SECRET_NAME + type: string + created_at: + description: >- + The date and time at which the secret was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + updated_at: + description: >- + The date and time at which the secret was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + visibility: + description: >- + The type of repositories in the organization that the secret is + visible to + enum: + - all + - private + - selected + type: string + selected_repositories_url: + description: >- + The API URL at which the list of repositories this secret is visible + to can be retrieved + type: string + format: uri + example: >- + https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + required: + - name + - created_at + - updated_at + - visibility + codespaces-public-key: + title: CodespacesPublicKey + description: The public key used for setting Codespaces secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + example: 2 + url: + type: string + example: https://api.github.com/user/keys/2 + title: + type: string + example: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + example: '2011-01-26T19:01:12Z' + required: + - key_id + - key + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + codespace-machine: + type: object + title: Codespace machine + description: A description of the machine powering a codespace. + properties: + name: + type: string + description: The name of the machine. + example: standardLinux + display_name: + type: string + description: The display name of the machine includes cores, memory, and storage. + example: 4 cores, 16 GB RAM, 64 GB storage + operating_system: + type: string + description: The operating system of the machine. + example: linux + storage_in_bytes: + type: integer + description: How much storage is available to the codespace. + example: 68719476736 + memory_in_bytes: + type: integer + description: How much memory is available to the codespace. + example: 17179869184 + cpus: + type: integer + description: How many cores are available to the codespace. + example: 4 + prebuild_availability: + type: string + description: >- + Whether a prebuild is currently available when creating a codespace + for this machine and repository. If a branch was not specified as a + ref, the default branch will be assumed. Value will be "null" if + prebuilds are not supported or prebuild availability could not be + determined. Value will be "none" if no prebuild is available. Latest + values "ready" and "in_progress" indicate the prebuild availability + status. + example: ready + enum: + - none + - ready + - in_progress + nullable: true + required: + - name + - display_name + - operating_system + - storage_in_bytes + - memory_in_bytes + - cpus + - prebuild_availability + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + codespaces-permissions-check-for-devcontainer: + title: Codespaces Permissions Check + description: Permission check result for a given devcontainer config. + type: object + properties: + accepted: + description: >- + Whether the user has accepted the permissions defined by the + devcontainer config + example: true + type: boolean + required: + - accepted + repo-codespaces-secret: + title: Codespaces Secret + description: Set repository secrets for GitHub Codespaces. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + codespaces-secret: + title: Codespaces Secret + description: Secrets for a GitHub Codespace. + type: object + properties: + name: + description: The name of the secret + example: SECRET_NAME + type: string + created_at: + description: >- + The date and time at which the secret was created, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + updated_at: + description: >- + The date and time at which the secret was last updated, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + visibility: + description: >- + The type of repositories in the organization that the secret is + visible to + enum: + - all + - private + - selected + type: string + selected_repositories_url: + description: >- + The API URL at which the list of repositories this secret is visible + to can be retrieved + type: string + format: uri + example: https://api.github.com/user/secrets/SECRET_NAME/repositories + required: + - name + - created_at + - updated_at + - visibility + - selected_repositories_url + codespaces-user-public-key: + title: CodespacesUserPublicKey + description: The public key used for setting user Codespaces' Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + codespace-export-details: + type: object + title: Fetches information about an export of a codespace. + description: >- + An export of a codespace. Also, latest export details for a codespace + can be fetched with id = latest + properties: + state: + type: string + description: State of the latest export + nullable: true + example: succeeded | failed | in_progress + completed_at: + description: Completion time of the last export operation + type: string + format: date-time + nullable: true + example: '2021-01-01T19:01:12Z' + branch: + type: string + description: Name of the exported branch + nullable: true + example: codespace-monalisa-octocat-hello-world-g4wpq6h95q + sha: + type: string + description: Git commit SHA of the exported branch + nullable: true + example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 + id: + type: string + description: Id for the export details + example: latest + export_url: + type: string + description: Url for fetching export details + example: https://api.github.com/user/codespaces/:name/exports/latest + html_url: + type: string + nullable: true + description: Web url for the exported branch + example: https://github.com/octocat/hello-world/tree/:branch + codespace-with-full-repository: + type: object + title: Codespace + description: A codespace. + properties: + id: + type: integer + format: int64 + example: 1 + name: + description: Automatically generated name of this codespace. + type: string + example: monalisa-octocat-hello-world-g4wpq6h95q + display_name: + description: Display name for this codespace. + type: string + example: bookish space pancake + nullable: true + environment_id: + description: UUID identifying this codespace's environment. + type: string + example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + nullable: true + owner: + $ref: '#/components/schemas/simple-user' + billable_owner: + $ref: '#/components/schemas/simple-user' + repository: + $ref: '#/components/schemas/full-repository' + machine: + $ref: '#/components/schemas/nullable-codespace-machine' + devcontainer_path: + description: Path to devcontainer.json from repo root used to create Codespace. + type: string + example: .devcontainer/example/devcontainer.json + nullable: true + prebuild: + description: Whether the codespace was created from a prebuild. + type: boolean + example: false + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + last_used_at: + description: Last known time this codespace was started. + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + state: + description: State of this codespace. + enum: + - Unknown + - Created + - Queued + - Provisioning + - Available + - Awaiting + - Unavailable + - Deleted + - Moved + - Shutdown + - Archived + - Starting + - ShuttingDown + - Failed + - Exporting + - Updating + - Rebuilding + example: Available + type: string + url: + description: API URL for this codespace. + type: string + format: uri + git_status: + description: Details about the codespace's git repository. + type: object + properties: + ahead: + description: >- + The number of commits the local repository is ahead of the + remote. + type: integer + example: 0 + behind: + description: The number of commits the local repository is behind the remote. + type: integer + example: 0 + has_unpushed_changes: + description: Whether the local repository has unpushed changes. + type: boolean + has_uncommitted_changes: + description: Whether the local repository has uncommitted changes. + type: boolean + ref: + description: >- + The current branch (or SHA if in detached HEAD state) of the + local repository. + type: string + example: main + location: + description: The initally assigned location of a new codespace. + enum: + - EastUs + - SouthEastAsia + - WestEurope + - WestUs2 + example: WestUs2 + type: string + idle_timeout_minutes: + description: >- + The number of minutes of inactivity after which this codespace will + be automatically stopped. + type: integer + example: 60 + nullable: true + web_url: + description: URL to access this codespace on the web. + type: string + format: uri + machines_url: + description: >- + API URL to access available alternate machine types for this + codespace. + type: string + format: uri + start_url: + description: API URL to start this codespace. + type: string + format: uri + stop_url: + description: API URL to stop this codespace. + type: string + format: uri + publish_url: + description: API URL to publish this codespace to a new repository. + type: string + format: uri + nullable: true + pulls_url: + description: API URL for the Pull Request associated with this codespace, if any. + type: string + format: uri + nullable: true + recent_folders: + type: array + items: + type: string + runtime_constraints: + type: object + properties: + allowed_port_privacy_settings: + description: >- + The privacy settings a user can select from when forwarding a + port. + type: array + items: + type: string + nullable: true + pending_operation: + description: >- + Whether or not a codespace has a pending async operation. This would + mean that the codespace is temporarily unavailable. The only thing + that you can do with a codespace in this state is delete it. + type: boolean + nullable: true + pending_operation_disabled_reason: + description: Text to show user when codespace is disabled by a pending operation + type: string + nullable: true + idle_timeout_notice: + description: >- + Text to show user when codespace idle timeout minutes has been + overriden by an organization policy + type: string + nullable: true + retention_period_minutes: + description: >- + Duration in minutes after codespace has gone idle in which it will + be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + example: 60 + nullable: true + retention_expires_at: + description: >- + When a codespace will be auto-deleted based on the + "retention_period_minutes" and "last_used_at" + type: string + format: date-time + example: '2011-01-26T20:01:12Z' + nullable: true + required: + - id + - name + - environment_id + - owner + - billable_owner + - repository + - machine + - prebuild + - created_at + - updated_at + - last_used_at + - state + - url + - git_status + - location + - idle_timeout_minutes + - web_url + - machines_url + - start_url + - stop_url + - pulls_url + - recent_folders + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + nullable-codespace-machine: + type: object + title: Codespace machine + description: A description of the machine powering a codespace. + properties: + name: + type: string + description: The name of the machine. + example: standardLinux + display_name: + type: string + description: The display name of the machine includes cores, memory, and storage. + example: 4 cores, 16 GB RAM, 64 GB storage + operating_system: + type: string + description: The operating system of the machine. + example: linux + storage_in_bytes: + type: integer + description: How much storage is available to the codespace. + example: 68719476736 + memory_in_bytes: + type: integer + description: How much memory is available to the codespace. + example: 17179869184 + cpus: + type: integer + description: How many cores are available to the codespace. + example: 4 + prebuild_availability: + type: string + description: >- + Whether a prebuild is currently available when creating a codespace + for this machine and repository. If a branch was not specified as a + ref, the default branch will be assumed. Value will be "null" if + prebuilds are not supported or prebuild availability could not be + determined. Value will be "none" if no prebuild is available. Latest + values "ready" and "in_progress" indicate the prebuild availability + status. + example: ready + enum: + - none + - ready + - in_progress + nullable: true + required: + - name + - display_name + - operating_system + - storage_in_bytes + - memory_in_bytes + - cpus + - prebuild_availability + nullable: true + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + $ref: '#/components/schemas/nullable-repository' + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + $ref: '#/components/schemas/nullable-license-simple' + organization: + $ref: '#/components/schemas/nullable-simple-user' + parent: + $ref: '#/components/schemas/repository' + source: + $ref: '#/components/schemas/repository' + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct-simple' + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + responses: + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + codespace-name: + name: codespace_name + in: path + required: true + description: The name of the codespace. + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + pull-number: + name: pull_number + description: The number that identifies the pull request. + in: path + required: true + schema: + type: integer + repository-id-in-query: + name: repository_id + description: ID of the Repository to filter on + in: query + schema: + type: integer + export-id: + name: export_id + in: path + required: true + description: >- + The ID of the export operation, or `latest`. Currently only `latest` is + currently supported. + schema: + type: string + examples: + codespaces-list: + value: + total_count: 3 + codespaces: + - id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + recent_folders: [] + - id: 1 + name: monalisa-octocat-hello-world-3f89ada1j3 + environment_id: 526ce4d7-46da-494f-a4f9-cfd25b818719 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/foobar/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3 + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-3f89ada1j3.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop + recent_folders: [] + - id: 1 + name: monalisa-octocat-hello-world-f8adfad99a + environment_id: 6ac8cd6d-a2d0-4ae3-8cea-e135059264df + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-f8adfad99a.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop + recent_folders: [] + repo-codespaces-secret-paginated: + value: + total_count: 2 + secrets: + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + - name: GIST_ID + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + visibility: all + codespaces-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + repo-codespaces-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + codespace: + value: + id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + retention_period_minutes: 43200 + retention_expires_at: null + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + recent_folders: [] + template: null + codespaces-list-for-repository: + value: + total_count: 2 + codespaces: + - id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + recent_folders: [] + - id: 2 + name: monalisa-octocat-hello-world-3f89ada1j3 + environment_id: 526ce4d7-46da-494f-a4f9-cfd25b818719 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3 + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-3f89ada1j3.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop + recent_folders: [] + codespaces-list-devcontainers-for-repository: + value: + devcontainers: + - path: .devcontainer/foobar/devcontainer.json + name: foobar + display_name: foobar + - path: .devcontainer/devcontainer.json + name: kitchensink + display_name: kitchensink + - path: .devcontainer.json + display_name: Default project configuration + total_count: 3 + codespace-machines-list: + value: + total_count: 2 + machines: + - name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + - name: premiumLinux + display_name: 8 cores, 32 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 34359738368 + cpus: 8 + codespaces-default-attributes-for-a-codespace: + value: + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + defaults: + location: EastUs + devcontainer_path: .devcontainer/devcontainer.json + codespaces-permissions-check-for-devcontainer: + value: + accepted: true + codespaces-user-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + user-codespaces-secret: + value: + name: CODESPACE_GH_SECRET + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: null + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 + user-export-details: + value: + state: succeeded + completed_at: '2022-01-01T14:59:22Z' + branch: codespace-monalisa-octocat-hello-world-g4wpq6h95q + sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 + id: latest + export_url: https://api.github.com/user/codespaces/:name/exports/latest + codespace-with-full-repository: + value: + id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: null + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + retention_period_minutes: 43200 + retention_expires_at: null + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: >- + https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + recent_folders: [] + template: null + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + organizations: + id: github.codespaces.organizations + name: organizations + title: Organizations + methods: + list_in_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_codespaces_access: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1access/put' + response: + mediaType: application/json + openAPIDocKey: '204' + set_codespaces_access_users: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1access~1selected_users/post' + response: + mediaType: application/json + openAPIDocKey: '204' + delete_codespaces_access_users: + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1access~1selected_users/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_codespaces_for_user_in_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1members~1{username}~1codespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_from_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1members~1{username}~1codespaces~1{codespace_name}/delete + response: + mediaType: application/json + openAPIDocKey: '202' + stop_in_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1members~1{username}~1codespaces~1{codespace_name}~1stop/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/get_codespaces_for_user_in_org + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/list_in_organization + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/delete_from_organization + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/delete_codespaces_access_users + replace: + - $ref: >- + #/components/x-stackQL-resources/organizations/methods/set_codespaces_access + organization_secrets: + id: github.codespaces.organization_secrets + name: organization_secrets + title: Organization Secrets + methods: + list_org_secrets: + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_secret: + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_org_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}/put' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_org_secret: + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/organization_secrets/methods/get_org_secret + - $ref: >- + #/components/x-stackQL-resources/organization_secrets/methods/list_org_secrets + insert: + - $ref: >- + #/components/x-stackQL-resources/organization_secrets/methods/create_or_update_org_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/organization_secrets/methods/delete_org_secret + replace: [] + public_keys: + id: github.codespaces.public_keys + name: public_keys + title: Public Keys + methods: + get_org_public_key: + operation: + $ref: '#/paths/~1orgs~1{org}~1codespaces~1secrets~1public-key/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_public_key: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1codespaces~1secrets~1public-key/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_repo_public_key + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_org_public_key + insert: [] + update: [] + delete: [] + replace: [] + org_secrets_repos: + id: github.codespaces.org_secrets_repos + name: org_secrets_repos + title: Org Secrets Repos + methods: + list_selected_repos_for_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_selected_repos_for_org_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_selected_repo_to_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_selected_repo_from_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1codespaces~1secrets~1{secret_name}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_secrets_repos/methods/list_selected_repos_for_org_secret + insert: + - $ref: >- + #/components/x-stackQL-resources/org_secrets_repos/methods/add_selected_repo_to_org_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_secrets_repos/methods/remove_selected_repo_from_org_secret + replace: + - $ref: >- + #/components/x-stackQL-resources/org_secrets_repos/methods/set_selected_repos_for_org_secret + codespaces: + id: github.codespaces.codespaces + name: codespaces + title: Codespaces + methods: + list_in_repository_for_authenticated_user: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_with_repo_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codespaces/post' + response: + mediaType: application/json + openAPIDocKey: '201' + pre_flight_with_repo_for_authenticated_user: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codespaces~1new/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_with_pr_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1codespaces/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1codespaces/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + export_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}~1exports/post' + response: + mediaType: application/json + openAPIDocKey: '202' + publish_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}~1publish/post' + response: + mediaType: application/json + openAPIDocKey: '201' + start_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}~1start/post' + response: + mediaType: application/json + openAPIDocKey: '200' + stop_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}~1stop/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/list_in_repository_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/get_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/list_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/create_with_pr_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/create_with_repo_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/create_for_authenticated_user + update: + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/update_for_authenticated_user + delete: + - $ref: >- + #/components/x-stackQL-resources/codespaces/methods/delete_for_authenticated_user + replace: [] + devcontainers: + id: github.codespaces.devcontainers + name: devcontainers + title: Devcontainers + methods: + list_devcontainers_in_repository_for_authenticated_user: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codespaces~1devcontainers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/devcontainers/methods/list_devcontainers_in_repository_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + machines: + id: github.codespaces.machines + name: machines + title: Machines + methods: + repo_machines_for_authenticated_user: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codespaces~1machines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + codespace_machines_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1{codespace_name}~1machines/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/machines/methods/repo_machines_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/machines/methods/codespace_machines_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + devcontainer_permissions: + id: github.codespaces.devcontainer_permissions + name: devcontainer_permissions + title: Devcontainer Permissions + methods: + check_permissions_for_devcontainer: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1codespaces~1permissions_check/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/devcontainer_permissions/methods/check_permissions_for_devcontainer + insert: [] + update: [] + delete: [] + replace: [] + repository_secrets: + id: github.codespaces.repository_secrets + name: repository_secrets + title: Repository Secrets + methods: + list_repo_secrets: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codespaces~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1codespaces~1secrets~1{secret_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_repo_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1codespaces~1secrets~1{secret_name}/put + response: + mediaType: application/json + openAPIDocKey: '201' + delete_repo_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1codespaces~1secrets~1{secret_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repository_secrets/methods/get_repo_secret + - $ref: >- + #/components/x-stackQL-resources/repository_secrets/methods/list_repo_secrets + insert: + - $ref: >- + #/components/x-stackQL-resources/repository_secrets/methods/create_or_update_repo_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repository_secrets/methods/delete_repo_secret + replace: [] + secrets: + id: github.codespaces.secrets + name: secrets + title: Secrets + methods: + list_secrets_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_secret_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1secrets~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_secret_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1codespaces~1secrets~1{secret_name}/put' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_secret_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1secrets~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/get_secret_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/list_secrets_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/create_or_update_secret_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/delete_secret_for_authenticated_user + replace: [] + user_public_keys: + id: github.codespaces.user_public_keys + name: user_public_keys + title: User Public Keys + methods: + get_public_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1codespaces~1secrets~1public-key/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user_public_keys/methods/get_public_key_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + user_secrets: + id: github.codespaces.user_secrets + name: user_secrets + title: User Secrets + methods: + list_repositories_for_secret_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1codespaces~1secrets~1{secret_name}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_repositories_for_secret_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1user~1codespaces~1secrets~1{secret_name}~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_repository_for_secret_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1codespaces~1secrets~1{secret_name}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_repository_for_secret_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1codespaces~1secrets~1{secret_name}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user_secrets/methods/list_repositories_for_secret_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/user_secrets/methods/add_repository_for_secret_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/user_secrets/methods/remove_repository_for_secret_for_authenticated_user + replace: + - $ref: >- + #/components/x-stackQL-resources/user_secrets/methods/set_repositories_for_secret_for_authenticated_user + codespace_export_details: + id: github.codespaces.codespace_export_details + name: codespace_export_details + title: Codespace Export Details + methods: + get_export_details_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1codespaces~1{codespace_name}~1exports~1{export_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codespace_export_details/methods/get_export_details_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/copilot.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/copilot.yaml new file mode 100644 index 0000000..887ad5e --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/copilot.yaml @@ -0,0 +1,4750 @@ +openapi: 3.0.3 +info: + title: copilot API + description: Endpoints to manage Copilot using the REST API. + version: 1.1.4 +paths: + /enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day: + get: + summary: Get Copilot enterprise usage metrics for a specific day + description: >- + Use this endpoint to retrieve download links for the Copilot enterprise + usage metrics report for a specific day. The report provides + comprehensive usage data for Copilot features across the enterprise. + + + The report contains aggregated metrics for the specified day, including + usage statistics for various Copilot features, user engagement data, and + feature adoption metrics. Reports are generated daily and made available + for download through signed URLs with a limited expiration time. + + + The response includes download links to the report files, along with the + specific date of the report. The report covers a complete day for which + data has been processed. Reports are available starting from October 10, + 2025, and historical data can be accessed for up to 1 year from the + current date. + + + Enterprise owners, billing managers, and authorized users with + fine-grained "View Enterprise Copilot Metrics" permission can retrieve + Copilot metrics reports for the enterprise. OAuth app tokens and + personal access tokens (classic) need either the + `manage_billing:copilot` or `read:enterprise` scopes to use this + endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-one-day-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest: + get: + summary: Get Copilot enterprise usage metrics + description: >- + Use this endpoint to retrieve download links for the latest 28-day + enterprise Copilot usage metrics report. The report provides + comprehensive usage data for Copilot features across the enterprise. + + + The report contains aggregated metrics for the previous 28 days, + including usage statistics for various Copilot features, user engagement + data, and feature adoption metrics. Reports are generated daily and made + available for download through signed URLs with a limited expiration + time. + + + The response includes download links to the report files, along with the + specific date range covered by the report. The report covers a complete + 28-day period ending on the most recent day for which data has been + processed. + + + Enterprise owners, billing managers, and authorized users with + fine-grained "View Enterprise Copilot Metrics" permission can retrieve + Copilot metrics reports for the enterprise. OAuth app tokens and + personal access tokens (classic) need either the + `manage_billing:copilot` or `read:enterprise` scopes to use this + endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /enterprises/{enterprise}/copilot/metrics/reports/users-1-day: + get: + summary: Get Copilot users usage metrics for a specific day + description: >- + Use this endpoint to retrieve download links for the Copilot user usage + metrics report for a specific day. The report provides detailed + user-level usage data and engagement metrics for Copilot features across + the enterprise. + + + The report contains user-specific metrics for the specified day, + including individual user engagement statistics, feature usage patterns, + and adoption metrics broken down by user. This report allows authorized + users to analyze Copilot usage at the user level to understand adoption + patterns and identify opportunities for increased engagement. + + + Reports are generated daily and made available for download through + signed URLs with a limited expiration time. The response includes + download links to the report files, along with the specific date of the + report. The report covers a complete day for which data has been + processed. Reports are available starting from October 10, 2025, and + historical data can be accessed for up to 1 year from the current date. + + + Enterprise owners, billing managers, and authorized users with + fine-grained "View Enterprise Copilot Metrics" permission can retrieve + Copilot metrics reports for the enterprise. OAuth app tokens and + personal access tokens (classic) need either the + `manage_billing:copilot` or `read:enterprise` scopes to use this + endpoint. + tags: + - copilot + operationId: copilot/copilot-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest: + get: + summary: Get Copilot users usage metrics + description: >- + Use this endpoint to retrieve download links for the latest 28-day + enterprise users Copilot usage metrics report. The report provides + detailed user-level usage data and engagement metrics for Copilot + features across the enterprise. + + + The report contains user-specific metrics for the previous 28 days, + including individual user engagement statistics, feature usage patterns, + and adoption metrics broken down by user. This report allows authorized + users to analyze Copilot usage at the user level to understand adoption + patterns and identify opportunities for increased engagement. + + + Reports are generated daily and made available for download through + signed URLs with a limited expiration time. The response includes + download links to the report files, along with the specific date range + covered by the report. The report covers a complete 28-day period ending + on the most recent day for which data has been processed. + + + Enterprise owners, billing managers, and authorized users with + fine-grained "View Enterprise Copilot Metrics" permission can retrieve + Copilot metrics reports for the enterprise. OAuth app tokens and + personal access tokens (classic) need either the + `manage_billing:copilot` or `read:enterprise` scopes to use this + endpoint. + tags: + - copilot + operationId: copilot/copilot-users-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/billing: + get: + summary: Get Copilot seat information and settings for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets information about an organization's Copilot subscription, including + seat breakdown + + and feature policies. To configure these settings, go to your + organization's settings on GitHub.com. + + For more information, see "[Managing policies for Copilot in your + organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." + + + Only organization owners can view details about the organization's + Copilot Business or Copilot Enterprise subscription. + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `read:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/get-copilot-organization-details + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-organization-details' + examples: + default: + $ref: '#/components/examples/copilot-organization-details' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: There is a problem with your account's associated payment method. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/billing/seats: + get: + summary: List all Copilot seat assignments for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Lists all Copilot seats for which an organization with a Copilot + Business or Copilot Enterprise subscription is currently being billed. + + Only organization owners can view assigned seats. + + + Each seat object contains information about the assigned user's most + recent Copilot activity. Users must have telemetry enabled in their IDE + for Copilot in the IDE activity to be reflected in `last_activity_at`. + + For more information about activity data, see [Metrics data properties + for GitHub + Copilot](https://docs.github.com/copilot/reference/metrics-data). + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `read:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/list-copilot-seats + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 50 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_seats: + type: integer + description: >- + Total number of Copilot seats for the organization + currently being billed. + seats: + type: array + items: + $ref: '#/components/schemas/copilot-seat-details' + examples: + default: + $ref: '#/components/examples/copilot-seats-list' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/billing/selected_teams: + post: + summary: Add teams to the Copilot subscription for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Purchases a GitHub Copilot seat for all users within each specified + team. + + The organization will be billed for each seat based on the + organization's Copilot plan. For more information about Copilot pricing, + see "[About billing for GitHub Copilot in your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + + + Only organization owners can purchase Copilot seats for their + organization members. The organization must have a Copilot Business or + Copilot Enterprise subscription and a configured suggestion matching + policy. + + For more information about setting up a Copilot subscription, see + "[Subscribing to Copilot for your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + + For more information about setting a suggestion matching policy, see + "[Managing policies for Copilot in your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + + + The response contains the total number of new seats that were created + and existing seats that were refreshed. + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/add-copilot-seats-for-teams + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_teams: + type: array + description: >- + List of team names within the organization to which to grant + access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_teams + examples: + default: + value: + selected_teams: + - engteam1 + - engteam2 + - engteam3 + required: true + responses: + '201': + description: OK + content: + application/json: + schema: + type: object + description: >- + The total number of seats created for members of the specified + team(s). + properties: + seats_created: + type: integer + required: + - seats_created + examples: + default: + value: + seats_created: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: >- + Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code + suggestions policy has not been set for this organization, or the + organization's Copilot access setting is set to enable Copilot for + all users or is unconfigured. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + delete: + summary: Remove teams from the Copilot subscription for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Sets seats for all members of each team specified to "pending + cancellation". + + This will cause the members of the specified team(s) to lose access to + GitHub Copilot at the end of the current billing cycle unless they + retain access through another team. + + For more information about disabling access to Copilot, see "[Revoking + access to Copilot for members of your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + + + Only organization owners can cancel Copilot seats for their organization + members. + + + The response contains the total number of seats set to "pending + cancellation". + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/cancel-copilot-seat-assignment-for-teams + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_teams: + type: array + description: >- + The names of teams from which to revoke access to GitHub + Copilot. + items: + type: string + minItems: 1 + required: + - selected_teams + examples: + default: + value: + selected_teams: + - engteam1 + - engteam2 + - engteam3 + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: >- + The total number of seats set to "pending cancellation" for + members of the specified team(s). + properties: + seats_cancelled: + type: integer + required: + - seats_cancelled + examples: + default: + value: + seats_cancelled: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: >- + Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code + suggestions policy has not been set for this organization, or the + organization's Copilot access setting is set to enable Copilot for + all users or is unconfigured. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/billing/selected_users: + post: + summary: Add users to the Copilot subscription for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Purchases a GitHub Copilot seat for each user specified. + + The organization will be billed for each seat based on the + organization's Copilot plan. For more information about Copilot pricing, + see "[About billing for GitHub Copilot in your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + + + Only organization owners can purchase Copilot seats for their + organization members. The organization must have a Copilot Business or + Copilot Enterprise subscription and a configured suggestion matching + policy. + + For more information about setting up a Copilot subscription, see + "[Subscribing to Copilot for your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + + For more information about setting a suggestion matching policy, see + "[Managing policies for Copilot in your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + + + The response contains the total number of new seats that were created + and existing seats that were refreshed. + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/add-copilot-seats-for-users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: >- + The usernames of the organization members to be granted + access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - cooluser1 + - hacker2 + - octocat + required: true + responses: + '201': + description: OK + content: + application/json: + schema: + type: object + description: The total number of seats created for the specified user(s). + properties: + seats_created: + type: integer + required: + - seats_created + examples: + default: + value: + seats_created: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: >- + Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code + suggestions policy has not been set for this organization, or the + organization's Copilot access setting is set to enable Copilot for + all users or is unconfigured. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + delete: + summary: Remove users from the Copilot subscription for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Sets seats for all users specified to "pending cancellation". + + This will cause the specified users to lose access to GitHub Copilot at + the end of the current billing cycle unless they retain access through + team membership. + + For more information about disabling access to Copilot, see "[Revoking + access to Copilot for members of your + organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + + + Only organization owners can cancel Copilot seats for their organization + members. + + + The response contains the total number of seats set to "pending + cancellation". + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/cancel-copilot-seat-assignment-for-users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: >- + The usernames of the organization members for which to + revoke access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - cooluser1 + - hacker2 + - octocat + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: >- + The total number of seats set to "pending cancellation" for + the specified users. + properties: + seats_cancelled: + type: integer + required: + - seats_cancelled + examples: + default: + value: + seats_cancelled: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: >- + Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code + suggestions policy has not been set for this organization, the seat + management setting is set to enable Copilot for all users or is + unconfigured, or a user's seat cannot be cancelled because it was + assigned to them via a team. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/coding-agent/permissions: + get: + summary: Get Copilot coding agent permissions for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets information about which repositories in an organization have been + enabled + + or disabled for the Copilot coding agent. + + + Organization owners can configure whether Copilot coding agent is + enabled for + + all repositories, selected repositories, or no repositories owned by + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/get-copilot-coding-agent-permissions-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + type: string + description: >- + The policy for which repositories can use Copilot coding + agent. Can be one of `all`, `selected`, or `none`. + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: >- + The URL for the selected repositories endpoint. Only + present when `enabled_repositories` is `selected`. + required: + - enabled_repositories + examples: + all_enabled: + summary: All repositories enabled + value: + enabled_repositories: all + selected_enabled: + summary: Selected repositories enabled + value: + enabled_repositories: selected + selected_repositories_url: >- + https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories + none_enabled: + summary: No repositories enabled + value: + enabled_repositories: none + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + put: + summary: Set Copilot coding agent permissions for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Sets the policy for which repositories in an organization can use + Copilot coding agent. + + + Organization owners can configure whether Copilot coding agent is + enabled for + + all repositories, selected repositories, or no repositories owned by the + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/set-copilot-coding-agent-permissions-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + type: string + description: >- + The policy for which repositories can use Copilot coding + agent. Can be one of `all`, `selected`, or `none`. + enum: + - all + - selected + - none + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: selected + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + /orgs/{org}/copilot/coding-agent/permissions/repositories: + get: + summary: List repositories enabled for Copilot coding agent in an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Lists the selected repositories that are enabled for Copilot coding + agent in an organization. + + + Organization owners can use this endpoint when the coding agent + repository policy + + is set to `selected` to see which repositories have been enabled. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + required: + - total_count + - repositories + examples: + default: + $ref: '#/components/examples/minimal-repository-paginated' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + put: + summary: Set selected repositories for Copilot coding agent in an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Replaces the list of selected repositories that are enabled for Copilot + coding + + agent in an organization. This method can only be called when the coding + agent + + repository policy is set to `selected`. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs to enable for Copilot coding agent. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 42 + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + /orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}: + put: + summary: Enable a repository for Copilot coding agent in an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Adds a repository to the list of selected repositories enabled for + Copilot + + coding agent in an organization. This method can only be called when the + + coding agent repository policy is set to `selected`. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + delete: + summary: Disable a repository for Copilot coding agent in an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Removes a repository from the list of selected repositories enabled for + Copilot + + coding agent in an organization. This method can only be called when the + + coding agent repository policy is set to `selected`. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + /orgs/{org}/copilot/content_exclusion: + get: + summary: Get Copilot content exclusion rules for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets information about an organization's Copilot content exclusion path + rules. + + To configure these settings, go to the organization's settings on + GitHub. + + For more information, see "[Excluding content from GitHub + Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + + + Organization owners can view details about Copilot content exclusion + rules for the organization. + + + OAuth app tokens and personal access tokens (classic) need either the + `copilot` or `read:org` scopes to use this endpoint. + + + > [!CAUTION] + + > * At this time, the API does not support comments. This endpoint will + not return any comments in the existing rules. + + > * At this time, the API does not support duplicate keys. If your + content exclusion configuration contains duplicate keys, the API will + return only the last occurrence of that key. For example, if duplicate + entries are present, only the final value will be included in the + response. + tags: + - copilot + operationId: copilot/copilot-content-exclusion-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: >- + #/components/schemas/copilot-organization-content-exclusion-details + examples: + default: + $ref: >- + #/components/examples/copilot-organization-content-exclusion-details + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-content-exclusion-management + x-stackQL-resource: copilot_content_exclusion_management + put: + summary: Set Copilot content exclusion rules for an organization + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Sets Copilot content exclusion path rules for an organization. + + To configure these settings, go to the organization's settings on + GitHub. + + For more information, see "[Excluding content from GitHub + Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + + + Organization owners can set Copilot content exclusion rules for the + organization. + + + OAuth app tokens and personal access tokens (classic) need the `copilot` + scope to use this endpoint. + + + > [!CAUTION] + + > * At this time, the API does not support comments. When using this + endpoint, any existing comments in your rules will be deleted. + + > * At this time, the API does not support duplicate keys. If you submit + content exclusions through the API with duplicate keys, only the last + occurrence will be saved. Earlier entries with the same key will be + overwritten. + tags: + - copilot + operationId: copilot/set-copilot-content-exclusion-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + description: The content exclusion rules to set + required: true + content: + application/json: + schema: + type: object + additionalProperties: + type: array + items: + anyOf: + - type: string + description: The path to the file that will be excluded. + - type: object + properties: + ifAnyMatch: + type: array + items: + type: string + required: + - ifAnyMatch + additionalProperties: false + - type: object + properties: + ifNoneMatch: + type: array + items: + type: string + required: + - ifNoneMatch + additionalProperties: false + examples: + default: + summary: Example of content exclusion paths + value: + octo-repo: + - /src/some-dir/kernel.rs + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + default: + value: + message: Content exclusion rules updated successfully. + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '413': + $ref: '#/components/responses/too_large' + '422': + $ref: '#/components/responses/validation_failed_simple' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: null + enabledForGitHubApps: true + category: copilot + subcategory: copilot-content-exclusion-management + x-stackQL-resource: copilot_content_exclusion_management + /orgs/{org}/copilot/metrics: + get: + summary: Get Copilot metrics for an organization + description: >- + Use this endpoint to see a breakdown of aggregated metrics for various + GitHub Copilot features. See the response schema tab for detailed + metrics definitions. + + + > [!NOTE] + + > This endpoint will only return results for a given day if the + organization contained **five or more members with active Copilot + licenses** on that day, as evaluated at the end of that day. + + + The response contains metrics for up to 100 days prior. Metrics are + processed once per day for the previous day, + + and the response will only include data up until yesterday. In order for + an end user to be counted towards these metrics, + + they must have telemetry enabled in their IDE. + + + To access this endpoint, the Copilot Metrics API access policy must be + enabled for the organization. + + Only organization owners and owners and billing managers of the parent + enterprise can view Copilot metrics. + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use + this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: since + description: >- + Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format + (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. + in: query + required: false + schema: + type: string + - name: until + description: >- + Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format + (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if + it is passed. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/page' + - name: per_page + description: >- + The number of days of metrics to display per page (max 100). For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 100 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/copilot-usage-metrics-day' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-for-day' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/usage_metrics_api_disabled' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics + x-stackQL-resource: copilot_metrics + /orgs/{org}/copilot/metrics/reports/organization-1-day: + get: + summary: Get Copilot organization usage metrics for a specific day + description: >- + Use this endpoint to retrieve download links for the Copilot + organization usage metrics report for a specific day. The report + provides comprehensive usage data for Copilot features across the + organization. + + + The report contains aggregated metrics for the specified day, including + usage statistics for various Copilot features, user engagement data, and + feature adoption metrics. Reports are generated daily and made available + for download through signed URLs with a limited expiration time. + + + The response includes download links to the report files, along with the + specific date of the report. The report covers a complete day for which + data has been processed. + + + Organization owners and authorized users with fine-grained "View + Organization Copilot Metrics" permission can retrieve Copilot metrics + reports for the organization. OAuth app tokens and personal access + tokens (classic) need the `read:org` scope to use this endpoint. + + + For more information about organization metrics attribution, see [How + are metrics attributed across + organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-one-day-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/metrics/reports/organization-28-day/latest: + get: + summary: Get Copilot organization usage metrics + description: >- + Use this endpoint to retrieve download links for the latest 28-day + organization Copilot usage metrics report. The report provides + comprehensive usage data for Copilot features across the organization. + + + The report contains aggregated metrics for the previous 28 days, + including usage statistics for various Copilot features, user engagement + data, and feature adoption metrics. Reports are generated daily and made + available for download through signed URLs with a limited expiration + time. + + + The response includes download links to the report files, along with the + specific date range covered by the report. The report covers a complete + 28-day period ending on the most recent day for which data has been + processed. + + + Organization owners and authorized users with fine-grained "View + Organization Copilot Metrics" permission can retrieve Copilot metrics + reports for the organization. OAuth app tokens and personal access + tokens (classic) need the `read:org` scope to use this endpoint. + + + For more information about organization metrics attribution, see [How + are metrics attributed across + organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/metrics/reports/users-1-day: + get: + summary: Get Copilot organization users usage metrics for a specific day + description: >- + Use this endpoint to retrieve download links for the Copilot + organization user usage metrics report for a specific day. The report + provides detailed user-level usage data and engagement metrics for + Copilot features across the organization. + + + The report contains user-specific metrics for the specified day, + including individual user engagement statistics, feature usage patterns, + and adoption metrics broken down by user. This report allows authorized + users to analyze Copilot usage at the user level to understand adoption + patterns and identify opportunities for increased engagement. + + + Reports are generated daily and made available for download through + signed URLs with a limited expiration time. The response includes + download links to the report files, along with the specific date of the + report. The report covers a complete day for which data has been + processed. + + + Organization owners and authorized users with fine-grained "View + Organization Copilot Metrics" permission can retrieve Copilot metrics + reports for the organization. OAuth app tokens and personal access + tokens (classic) need the `read:org` scope to use this endpoint. + + + For more information about organization metrics attribution, see [How + are metrics attributed across + organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/metrics/reports/users-28-day/latest: + get: + summary: Get Copilot organization users usage metrics + description: >- + Use this endpoint to retrieve download links for the latest 28-day + organization users Copilot usage metrics report. The report provides + detailed user-level usage data and engagement metrics for Copilot + features across the organization. + + + The report contains user-specific metrics for the previous 28 days, + including individual user engagement statistics, feature usage patterns, + and adoption metrics broken down by user. This report allows authorized + users to analyze Copilot usage at the user level to understand adoption + patterns and identify opportunities for increased engagement. + + + Reports are generated daily and made available for download through + signed URLs with a limited expiration time. The response includes + download links to the report files, along with the specific date range + covered by the report. The report covers a complete 28-day period ending + on the most recent day for which data has been processed. + + + Organization owners and authorized users with fine-grained "View + Organization Copilot Metrics" permission can retrieve Copilot metrics + reports for the organization. OAuth app tokens and personal access + tokens (classic) need the `read:org` scope to use this endpoint. + + + For more information about organization metrics attribution, see [How + are metrics attributed across + organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-usage-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/members/{username}/copilot: + get: + summary: Get Copilot seat assignment details for a user + description: >- + > [!NOTE] + + > This endpoint is in public preview and is subject to change. + + + Gets the GitHub Copilot seat details for a member of an organization who + currently has access to GitHub Copilot. + + + The seat object contains information about the user's most recent + Copilot activity. Users must have telemetry enabled in their IDE for + Copilot in the IDE activity to be reflected in `last_activity_at`. + + For more information about activity data, see [Metrics data properties + for GitHub + Copilot](https://docs.github.com/copilot/reference/metrics-data). + + + Only organization owners can view Copilot seat assignment details for + members of their organization. + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot` or `read:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/get-copilot-seat-details-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '200': + description: The user's GitHub Copilot seat details, including usage. + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-seat-details' + examples: + default: + $ref: '#/components/examples/copilot-seat-detail-active' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: >- + Copilot Business or Enterprise is not enabled for this organization + or the user has a pending organization invitation. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/team/{team_slug}/copilot/metrics: + get: + summary: Get Copilot metrics for a team + description: >- + Use this endpoint to see a breakdown of aggregated metrics for various + GitHub Copilot features. See the response schema tab for detailed + metrics definitions. + + + > [!NOTE] + + > This endpoint will only return results for a given day if the team had + **five or more members with active Copilot licenses** on that day, as + evaluated at the end of that day. + + + The response contains metrics for up to 100 days prior. Metrics are + processed once per day for the previous day, + + and the response will only include data up until yesterday. In order for + an end user to be counted towards these metrics, + + they must have telemetry enabled in their IDE. + + + To access this endpoint, the Copilot Metrics API access policy must be + enabled for the organization containing the team within GitHub settings. + + Only organization owners for the organization that contains this team + and owners and billing managers of the parent enterprise can view + Copilot metrics for a team. + + + OAuth app tokens and personal access tokens (classic) need either the + `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use + this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - name: since + description: >- + Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format + (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. + in: query + required: false + schema: + type: string + - name: until + description: >- + Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format + (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if + it is passed. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/page' + - name: per_page + description: >- + The number of days of metrics to display per page (max 100). For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 100 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/copilot-usage-metrics-day' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-for-day' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/usage_metrics_api_disabled' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics + x-stackQL-resource: copilot_metrics +components: + schemas: + copilot-usage-metrics-1-day-report: + type: object + title: Copilot Metrics 1 Day Report + description: >- + Links to download the Copilot usage metrics report for an + enterprise/organization for a specific day. + properties: + download_links: + type: array + items: + type: string + format: uri + description: >- + The URLs to download the Copilot usage metrics report for the + enterprise/organization for the specified day. + report_day: + type: string + format: date + description: The day of the report in `YYYY-MM-DD` format. + required: + - download_links + - report_day + copilot-usage-metrics-28-day-report: + type: object + title: Copilot Metrics 28 Day Report + description: >- + Links to download the latest Copilot usage metrics report for an + enterprise/organization. + properties: + download_links: + type: array + items: + type: string + format: uri + description: >- + The URLs to download the latest Copilot usage metrics report for the + enterprise/organization. + report_start_day: + type: string + format: date + description: The start date of the report period in `YYYY-MM-DD` format. + report_end_day: + type: string + format: date + description: The end date of the report period in `YYYY-MM-DD` format. + required: + - download_links + - report_start_day + - report_end_day + copilot-organization-details: + title: Copilot Organization Details + description: >- + Information about the seat breakdown and policies set for an + organization with a Copilot Business or Copilot Enterprise subscription. + type: object + properties: + seat_breakdown: + $ref: '#/components/schemas/copilot-organization-seat-breakdown' + public_code_suggestions: + type: string + description: >- + The organization policy for allowing or blocking suggestions + matching public code (duplication detection filter). + enum: + - allow + - block + - unconfigured + ide_chat: + type: string + description: >- + The organization policy for allowing or disallowing Copilot Chat in + the IDE. + enum: + - enabled + - disabled + - unconfigured + platform_chat: + type: string + description: >- + The organization policy for allowing or disallowing Copilot features + on GitHub.com. + enum: + - enabled + - disabled + - unconfigured + cli: + type: string + description: The organization policy for allowing or disallowing Copilot CLI. + enum: + - enabled + - disabled + - unconfigured + seat_management_setting: + type: string + description: The mode of assigning new seats. + enum: + - assign_all + - assign_selected + - disabled + - unconfigured + plan_type: + type: string + description: >- + The Copilot plan of the organization, or the parent enterprise, when + applicable. + enum: + - business + - enterprise + required: + - seat_breakdown + - public_code_suggestions + - seat_management_setting + additionalProperties: true + copilot-seat-details: + title: Copilot Business Seat Detail + description: >- + Information about a Copilot Business seat assignment for a user, team, + or organization. + type: object + properties: + assignee: + $ref: '#/components/schemas/nullable-simple-user' + organization: + $ref: '#/components/schemas/nullable-organization-simple' + assigning_team: + description: >- + The team through which the assignee is granted access to GitHub + Copilot, if applicable. + nullable: true + title: Team + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + sync_to_organizations: + type: string + description: >- + Retired: this field will not be returned with GHEC enterprise + teams. + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + description: >- + Retired: this field will not be returned with GHEC enterprise + teams. + example: Justice League + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + - created_at + - updated_at + - group_id + pending_cancellation_date: + type: string + format: date + nullable: true + description: >- + The pending cancellation date for the seat, in `YYYY-MM-DD` format. + This will be null unless the assignee's Copilot access has been + canceled during the current billing cycle. If the seat has been + cancelled, this corresponds to the start of the organization's next + billing cycle. + last_activity_at: + type: string + format: date-time + nullable: true + description: >- + Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: string + nullable: true + description: >- + Last editor that was used by the user for a GitHub Copilot + completion. + last_authenticated_at: + type: string + format: date-time + nullable: true + description: >- + Timestamp of the last time the user authenticated with GitHub + Copilot, in ISO 8601 format. + created_at: + type: string + format: date-time + description: >- + Timestamp of when the assignee was last granted access to GitHub + Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: >- + **Closing down notice:** This field is no longer relevant and is + closing down. Use the `created_at` field to determine when the + assignee was last granted access to GitHub Copilot. Timestamp of + when the assignee's GitHub Copilot access was last updated, in ISO + 8601 format. + plan_type: + type: string + description: >- + The Copilot plan of the organization, or the parent enterprise, when + applicable. + enum: + - business + - enterprise + - unknown + required: + - created_at + additionalProperties: false + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + copilot-organization-content-exclusion-details: + title: Copilot Organization Content Exclusion Details + description: List all Copilot Content Exclusion rules for an organization. + type: object + additionalProperties: + type: array + items: + type: string + description: The path to the file that will be excluded. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: >- + The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: >- + The total number of Copilot users with activity belonging to any + Copilot feature, globally, for the given day. Includes passive + activity such as receiving a code suggestion, as well as engagement + activity such as accepting a code suggestion or prompting chat. Does + not include authentication events. Is not limited to the individual + features detailed on the endpoint. + total_engaged_users: + type: integer + description: >- + The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to + accepting a code suggestion, prompting Copilot chat, or triggering a + PR Summary. Does not include authentication events. Is not limited + to the individual features detailed on the endpoint. + copilot_ide_code_completions: + $ref: '#/components/schemas/copilot-ide-code-completions' + copilot_ide_chat: + $ref: '#/components/schemas/copilot-ide-chat' + copilot_dotcom_chat: + $ref: '#/components/schemas/copilot-dotcom-chat' + copilot_dotcom_pull_requests: + $ref: '#/components/schemas/copilot-dotcom-pull-requests' + required: + - date + additionalProperties: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + copilot-organization-seat-breakdown: + title: Copilot Seat Breakdown + description: The breakdown of Copilot Business seats for the organization. + type: object + properties: + total: + type: integer + description: >- + The total number of seats being billed for the organization as of + the current billing cycle. + added_this_cycle: + type: integer + description: Seats added during the current billing cycle. + pending_cancellation: + type: integer + description: >- + The number of seats that are pending cancellation at the end of the + current billing cycle. + pending_invitation: + type: integer + description: >- + The number of users who have been invited to receive a Copilot seat + through this organization. + active_this_cycle: + type: integer + description: >- + The number of seats that have used Copilot during the current + billing cycle. + inactive_this_cycle: + type: integer + description: >- + The number of seats that have not used Copilot during the current + billing cycle. + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + nullable: true + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: Justice League + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - name + - html_url + - slug + - created_at + - updated_at + - group_id + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: >- + Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: >- + Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: >- + Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: >- + Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both + full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: >- + Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full + and partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default model. + items: + type: object + properties: + name: + type: string + description: >- + Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as + 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: >- + Number of users who accepted at least one Copilot code + completion suggestion for the given editor, for the + given language and model. Includes both full and partial + acceptances. + languages: + type: array + description: >- + Code completion metrics for active languages, for the + given editor. + items: + type: object + description: >- + Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: >- + Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: >- + Number of users who accepted at least one Copilot + code completion suggestion for the given editor, + for the given language. Includes both full and + partial acceptances. + total_code_suggestions: + type: integer + description: >- + The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: >- + The number of Copilot code suggestions accepted + for the given editor, for the given language. + Includes both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: >- + The number of lines of code suggested by Copilot + code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: >- + The number of lines of code accepted from Copilot + code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: >- + The number of users who prompted Copilot Chat in the specified + editor. + models: + type: array + description: List of model metrics for custom models and the default model. + items: + type: object + properties: + name: + type: string + description: >- + Name of the model used for Copilot Chat. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: >- + The number of users who prompted Copilot Chat in the + given editor and model. + total_chats: + type: integer + description: >- + The total number of chats initiated by users in the + given editor and model. + total_chat_insertion_events: + type: integer + description: >- + The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, + for the given editor. + total_chat_copy_events: + type: integer + description: >- + The number of times users copied a code suggestion from + Copilot Chat using the keyboard, or the 'Copy' UI + element, for the given editor. + copilot-dotcom-chat: + type: object + description: Usage metrics for Copilot Chat in GitHub.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: >- + Total number of users who prompted Copilot Chat on github.com at + least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: >- + Name of the model used for Copilot Chat. If the default model + is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + description: The training date for the custom model (if applicable). + nullable: true + total_engaged_users: + type: integer + description: >- + Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: >- + The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: >- + Repositories in which users used Copilot for Pull Requests to + generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: >- + The number of users who generated pull request summaries using + Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default model. + items: + type: object + properties: + name: + type: string + description: >- + Name of the model used for Copilot pull request + summaries. If the default model is used will appear as + 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: >- + The number of pull request summaries generated using + Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: >- + The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository + and model. + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + too_large: + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + usage_metrics_api_disabled: + description: >- + Copilot Usage Metrics API setting is disabled at the organization or + enterprise level. + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + no_content: + description: A header with no content is returned. + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + day: + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + example: '2025-10-13' + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + examples: + copilot-usage-metrics-1-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_day: '2025-07-01' + copilot-usage-metrics-28-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_start_day: '2025-07-01' + report_end_day: '2025-07-28' + copilot-organization-details: + value: + seat_breakdown: + total: 12 + added_this_cycle: 9 + pending_invitation: 0 + pending_cancellation: 0 + active_this_cycle: 12 + inactive_this_cycle: 11 + seat_management_setting: assign_selected + ide_chat: enabled + platform_chat: enabled + cli: enabled + public_code_suggestions: block + plan_type: business + copilot-seats-list: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: null + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: null + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 + copilot-organization-content-exclusion-details: + value: + octo-repo: + - /src/some-dir/kernel.rs + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + copilot-seat-detail-active: + value: + created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: null + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + copilot_one_day_usage_metrics: + id: github.copilot.copilot_one_day_usage_metrics + name: copilot_one_day_usage_metrics + title: Copilot One Day Usage Metrics + methods: + copilot_enterprise_one_day_usage_metrics: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1copilot~1metrics~1reports~1enterprise-1-day/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/copilot_one_day_usage_metrics/methods/copilot_enterprise_one_day_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + copilot_usage_metrics: + id: github.copilot.copilot_usage_metrics + name: copilot_usage_metrics + title: Copilot Usage Metrics + methods: + copilot_enterprise_usage_metrics: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1copilot~1metrics~1reports~1enterprise-28-day~1latest/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/copilot_usage_metrics/methods/copilot_enterprise_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + copilot_user_one_day_usage_metrics: + id: github.copilot.copilot_user_one_day_usage_metrics + name: copilot_user_one_day_usage_metrics + title: Copilot User One Day Usage Metrics + methods: + copilot_users_one_day_usage_metrics: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1copilot~1metrics~1reports~1users-1-day/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/copilot_user_one_day_usage_metrics/methods/copilot_users_one_day_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + copilot_user_usage_metrics: + id: github.copilot.copilot_user_usage_metrics + name: copilot_user_usage_metrics + title: Copilot User Usage Metrics + methods: + copilot_users_usage_metrics: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1copilot~1metrics~1reports~1users-28-day~1latest/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/copilot_user_usage_metrics/methods/copilot_users_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + org_details: + id: github.copilot.org_details + name: org_details + title: Org Details + methods: + get_copilot_organization_details: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1billing/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_details/methods/get_copilot_organization_details + insert: [] + update: [] + delete: [] + replace: [] + org_seats: + id: github.copilot.org_seats + name: org_seats + title: Org Seats + methods: + list_copilot_seats: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1billing~1seats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_copilot_for_business_seats_for_teams: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1billing~1selected_teams/post' + response: + mediaType: application/json + openAPIDocKey: '201' + cancel_copilot_seat_assignment_for_teams: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1billing~1selected_teams/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_seats/methods/list_copilot_seats + insert: + - $ref: >- + #/components/x-stackQL-resources/org_seats/methods/add_copilot_for_business_seats_for_teams + update: [] + delete: [] + replace: [] + user_seats: + id: github.copilot.user_seats + name: user_seats + title: User Seats + methods: + add_copilot_for_business_seats_for_users: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1billing~1selected_users/post' + response: + mediaType: application/json + openAPIDocKey: '201' + cancel_copilot_seat_assignment_for_users: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1billing~1selected_users/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_copilot_seat_assignment_details_for_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1members~1{username}~1copilot/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user_seats/methods/get_copilot_seat_assignment_details_for_user + insert: + - $ref: >- + #/components/x-stackQL-resources/user_seats/methods/add_copilot_for_business_seats_for_users + update: [] + delete: [] + replace: [] + org_coding_agent_permissions: + id: github.copilot.org_coding_agent_permissions + name: org_coding_agent_permissions + title: Org Coding Agent Permissions + methods: + get_copilot_coding_agent_permissions_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1coding-agent~1permissions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_copilot_coding_agent_permissions_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1coding-agent~1permissions/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_coding_agent_permissions/methods/get_copilot_coding_agent_permissions_organization + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/org_coding_agent_permissions/methods/set_copilot_coding_agent_permissions_organization + org_coding_agent_repos: + id: github.copilot.org_coding_agent_repos + name: org_coding_agent_repos + title: Org Coding Agent Repos + methods: + list_copilot_coding_agent_selected_repositories_for_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1coding-agent~1permissions~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_copilot_coding_agent_selected_repositories_for_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1coding-agent~1permissions~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + enable_copilot_coding_agent_for_repository_in_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1coding-agent~1permissions~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + disable_copilot_coding_agent_for_repository_in_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1coding-agent~1permissions~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_coding_agent_repos/methods/list_copilot_coding_agent_selected_repositories_for_organization + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_coding_agent_repos/methods/disable_copilot_coding_agent_for_repository_in_organization + replace: + - $ref: >- + #/components/x-stackQL-resources/org_coding_agent_repos/methods/enable_copilot_coding_agent_for_repository_in_organization + - $ref: >- + #/components/x-stackQL-resources/org_coding_agent_repos/methods/set_copilot_coding_agent_selected_repositories_for_organization + org_content_exclusion: + id: github.copilot.org_content_exclusion + name: org_content_exclusion + title: Org Content Exclusion + methods: + copilot_content_exclusion_for_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1content_exclusion/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_copilot_content_exclusion_for_organization: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1content_exclusion/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/org_content_exclusion/methods/set_copilot_content_exclusion_for_organization + org_copilot_metrics: + id: github.copilot.org_copilot_metrics + name: org_copilot_metrics + title: Org Copilot Metrics + methods: + copilot_metrics_for_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1metrics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_copilot_metrics/methods/copilot_metrics_for_organization + insert: [] + update: [] + delete: [] + replace: [] + org_copilot_one_day_usage_metrics: + id: github.copilot.org_copilot_one_day_usage_metrics + name: org_copilot_one_day_usage_metrics + title: Org Copilot One Day Usage Metrics + methods: + copilot_organization_one_day_usage_metrics: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1metrics~1reports~1organization-1-day/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_copilot_one_day_usage_metrics/methods/copilot_organization_one_day_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + org_copilot_usage_metrics: + id: github.copilot.org_copilot_usage_metrics + name: org_copilot_usage_metrics + title: Org Copilot Usage Metrics + methods: + copilot_organization_usage_metrics: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1metrics~1reports~1organization-28-day~1latest/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_copilot_usage_metrics/methods/copilot_organization_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + org_copilot_user_one_day_usage_metrics: + id: github.copilot.org_copilot_user_one_day_usage_metrics + name: org_copilot_user_one_day_usage_metrics + title: Org Copilot User One Day Usage Metrics + methods: + copilot_organization_users_one_day_usage_metrics: + operation: + $ref: '#/paths/~1orgs~1{org}~1copilot~1metrics~1reports~1users-1-day/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_copilot_user_one_day_usage_metrics/methods/copilot_organization_users_one_day_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + org_copilot_user_usage_metrics: + id: github.copilot.org_copilot_user_usage_metrics + name: org_copilot_user_usage_metrics + title: Org Copilot User Usage Metrics + methods: + copilot_organization_users_usage_metrics: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1copilot~1metrics~1reports~1users-28-day~1latest/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_copilot_user_usage_metrics/methods/copilot_organization_users_usage_metrics + insert: [] + update: [] + delete: [] + replace: [] + copilot_metrics: + id: github.copilot.copilot_metrics + name: copilot_metrics + title: Copilot Metrics + methods: + copilot_metrics_for_team: + operation: + $ref: '#/paths/~1orgs~1{org}~1team~1{team_slug}~1copilot~1metrics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/copilot_metrics/methods/copilot_metrics_for_team + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/credentials.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/credentials.yaml new file mode 100644 index 0000000..151a35a --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/credentials.yaml @@ -0,0 +1,170 @@ +openapi: 3.0.3 +info: + title: credentials API + description: Revoke compromised or leaked GitHub credentials. + version: 1.1.4 +paths: + /credentials/revoke: + post: + summary: Revoke a list of credentials + description: >- + Submit a list of credentials to be revoked. This endpoint is intended to + revoke credentials the caller does not own and may have found exposed on + GitHub.com or elsewhere. It can also be used for credentials associated + with an old user account that you no longer have access to. Credential + owners will be notified of the revocation. + + + This endpoint currently accepts the following credential types: + + - Personal access tokens (classic) (`ghp_`) + + - Fine-grained personal access tokens (`github_pat_`) + + - OAuth app access tokens (`gho_`) + + - User-to-server tokens from GitHub Apps (`ghu_`) + + - Refresh tokens from GitHub Apps (`ghr_`) + + + + Revoked credentials may impact users on GitHub Free, Pro, & Team and + GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise + Managed Users. + + GitHub cannot reactivate any credentials that have been revoked; new + credentials will need to be generated. + + + To prevent abuse, this API is limited to only 60 unauthenticated + requests per hour and a max of 1000 tokens per API request. + + + > [!NOTE] + + > Any authenticated requests will return a 403. + tags: + - credentials + operationId: credentials/revoke + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + description: A list of credentials to be revoked, up to 1000 per request. + items: + type: string + minItems: 1 + maxItems: 1000 + required: + - credentials + examples: + default: + value: + credentials: + - ghp_1234567890abcdef1234567890abcdef12345678 + - >- + github_pat_0A1B2C3D4E5F6G7H8I9J0K_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456 + - gho_1234567890abcdef1234567890abcdef12345678 + - ghu_1234567890abcdef1234567890abcdef12345678 + - >- + ghr_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab + responses: + '202': + $ref: '#/components/responses/accepted' + '422': + $ref: '#/components/responses/validation_failed_simple' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: credentials + subcategory: revoke + x-stackQL-resource: revoke +components: + schemas: + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-stackQL-resources: + credentials: + id: github.credentials.credentials + name: credentials + title: Credentials + methods: + revoke: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1credentials~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/dependabot.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/dependabot.yaml new file mode 100644 index 0000000..689cbb6 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/dependabot.yaml @@ -0,0 +1,5010 @@ +openapi: 3.0.3 +info: + title: dependabot API + description: Endpoints to manage Dependabot. + version: 1.1.4 +paths: + /enterprises/{enterprise}/dependabot/alerts: + get: + summary: List Dependabot alerts for an enterprise + description: >- + Lists Dependabot alerts for repositories that are owned by the specified + enterprise. + + + The authenticated user must be a member of the enterprise to use this + endpoint. + + + Alerts are only returned for organizations in the enterprise for which + you are an organization owner or a security manager. For more + information about security managers, see "[Managing security managers in + your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: >- + #/components/parameters/dependabot-alert-comma-separated-classifications + - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-epss' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-has' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-assignees' + - $ref: '#/components/parameters/dependabot-alert-scope' + - $ref: '#/components/parameters/dependabot-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dependabot-alert-with-repository' + examples: + default: + $ref: '#/components/examples/dependabot-alerts-for-organization' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /organizations/{org}/dependabot/repository-access: + get: + summary: Lists the repositories Dependabot can access in an organization + description: >- + Lists repositories that organization admins have allowed Dependabot to + access when updating dependencies. + + > [!NOTE] + + > This operation supports both server-to-server and user-to-server + access. + + Unauthorized users will not see the existence of this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-repository-access-details' + examples: + default: + $ref: '#/components/examples/dependabot-repository-access-details' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + x-stackQL-resource: repository_access + patch: + summary: Updates Dependabot's repository access list for an organization + description: >- + Updates repositories according to the list of repositories that + organization admins have given Dependabot access to when they've updated + dependencies. + + + > [!NOTE] + + > This operation supports both server-to-server and user-to-server + access. + + Unauthorized users will not see the existence of this endpoint. + + + **Example request body:** + + ```json + + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + x-stackQL-resource: repository_access + /organizations/{org}/dependabot/repository-access/default-level: + put: + summary: Set the default repository access level for Dependabot + description: >- + Sets the default level of repository access Dependabot will have while + performing an update. Available values are: + + - 'public' - Dependabot will only have access to public repositories, + unless access is explicitly granted to non-public repositories. + + - 'internal' - Dependabot will only have access to public and internal + repositories, unless access is explicitly granted to private + repositories. + + + Unauthorized users will not see the existence of this endpoint. + + + This operation supports both server-to-server and user-to-server access. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + x-stackQL-resource: repository_access + /orgs/{org}/dependabot/alerts: + get: + summary: List Dependabot alerts for an organization + description: >- + Lists Dependabot alerts for an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - dependabot + operationId: dependabot/list-alerts-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: >- + #/components/parameters/dependabot-alert-comma-separated-classifications + - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-epss' + - $ref: >- + #/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls + - $ref: >- + #/components/parameters/dependabot-alert-comma-separated-artifact-registry + - $ref: >- + #/components/parameters/dependabot-alert-org-scope-comma-separated-has + - $ref: '#/components/parameters/dependabot-alert-comma-separated-assignees' + - $ref: >- + #/components/parameters/dependabot-alert-comma-separated-runtime-risk + - $ref: '#/components/parameters/dependabot-alert-scope' + - $ref: '#/components/parameters/dependabot-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dependabot-alert-with-repository' + examples: + default: + $ref: '#/components/examples/dependabot-alerts-for-organization' + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /orgs/{org}/dependabot/secrets: + get: + summary: List organization secrets + description: >- + Lists all secrets available in an organization without revealing their + + encrypted values. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-org-secrets + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#list-organization-secrets + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/organization-dependabot-secret' + examples: + default: + $ref: >- + #/components/examples/organization-dependabot-secret-paginated + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/public-key: + get: + summary: Get an organization public key + description: >- + Gets your public key, which you need to encrypt secrets. You need to + + encrypt a secret before you can create or update secrets. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/get-org-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-public-key' + examples: + default: + $ref: '#/components/examples/dependabot-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/{secret_name}: + get: + summary: Get an organization secret + description: >- + Gets a single organization secret without revealing its encrypted value. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/get-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-dependabot-secret' + examples: + default: + $ref: '#/components/examples/organization-dependabot-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update an organization secret + description: >- + Creates or updates an organization secret with an encrypted value. + Encrypt your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/create-or-update-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get an organization + public + key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + visibility: + type: string + description: >- + Which type of organization repositories have access to the + organization secret. `selected` means only the repositories + specified by `selected_repository_ids` can access the + secret. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + secret. You can only provide a list of repository ids when + the `visibility` is set to `selected`. You can manage the + list of selected repositories using the [List selected + repositories for an organization + secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization + secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization + secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + anyOf: + - type: integer + - type: string + required: + - visibility + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-github-breaking-changes: + - changeset: remove_string_type_from_repo_id_param + patch: + - op: replace + path: >- + /requestBody/content/application~1json/schema/properties/selected_repository_ids/items + value: + type: integer + version: '2026-03-10' + x-stackQL-resource: secrets + delete: + summary: Delete an organization secret + description: >- + Deletes a secret in an organization using the secret name. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/delete-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for an organization secret + description: >- + Lists all repositories that have been selected when the `visibility` + + for repository access to a secret is set to `selected`. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Set selected repositories for an organization secret + description: >- + Replaces all repositories for an organization secret when the + `visibility` + + for repository access is set to `selected`. The visibility is set when + you [Create + + or update an organization + secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: >- + An array of repository ids that can access the organization + secret. You can only provide a list of repository ids when + the `visibility` is set to `selected`. You can add and + remove individual repositories using the [Set selected + repositories for an organization + secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization + secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization secret + description: >- + Adds a repository to an organization secret when the `visibility` for + + repository access is set to `selected`. The visibility is set when you + [Create or + + update an organization + secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/add-selected-repo-to-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '409': + description: Conflict when visibility type is not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Remove selected repository from an organization secret + description: >- + Removes a repository from an organization secret when the `visibility` + + for repository access is set to `selected`. The visibility is set when + you [Create + + or update an organization + secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/remove-selected-repo-from-org-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response when repository was removed from the selected list + '409': + description: Conflict when visibility type not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/dependabot/alerts: + get: + summary: List Dependabot alerts for a repository + description: >- + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - dependabot + operationId: dependabot/list-alerts-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: >- + #/components/parameters/dependabot-alert-comma-separated-classifications + - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-manifests' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-epss' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-has' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-assignees' + - $ref: '#/components/parameters/dependabot-alert-scope' + - $ref: '#/components/parameters/dependabot-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dependabot-alert' + examples: + default: + $ref: '#/components/examples/dependabot-alerts-for-repository' + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /repos/{owner}/{repo}/dependabot/alerts/{alert_number}: + get: + summary: Get a Dependabot alert + description: >- + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - dependabot + operationId: dependabot/get-alert + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/dependabot-alert-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-alert' + examples: + default: + $ref: '#/components/examples/dependabot-alert-open' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + patch: + summary: Update a Dependabot alert + description: >- + The authenticated user must have access to security alerts for the + repository to use this endpoint. For more information, see "[Granting + access to security + alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + + + OAuth app tokens and personal access tokens (classic) need the + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - dependabot + operationId: dependabot/update-alert + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/dependabot-alert-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: >- + The state of the Dependabot alert. + + A `dismissed_reason` must be provided when setting the state + to `dismissed`. + enum: + - dismissed + - open + dismissed_reason: + type: string + description: >- + **Required when `state` is `dismissed`.** A reason for + dismissing the alert. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + dismissed_comment: + type: string + description: An optional comment associated with dismissing the alert. + maxLength: 280 + assignees: + type: array + description: >- + Usernames to assign to this Dependabot Alert. + + Pass one or more user logins to _replace_ the set of + assignees on this alert. + + Send an empty array (`[]`) to clear all assignees from the + alert. + items: + type: string + additionalProperties: false + required: + - state + - assignees + examples: + default: + value: + state: dismissed + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-alert' + examples: + default: + $ref: '#/components/examples/dependabot-alert-dismissed' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /repos/{owner}/{repo}/dependabot/secrets: + get: + summary: List repository secrets + description: >- + Lists all secrets available in a repository without revealing their + encrypted + + values. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-repo-secrets + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#list-repository-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/dependabot-secret' + examples: + default: + $ref: '#/components/examples/dependabot-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/dependabot/secrets/public-key: + get: + summary: Get a repository public key + description: >- + Gets your public key, which you need to encrypt secrets. You need to + + encrypt a secret before you can create or update secrets. Anyone with + read access + + to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint if the repository is private. + tags: + - dependabot + operationId: dependabot/get-repo-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-public-key' + examples: + default: + $ref: '#/components/examples/dependabot-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/dependabot/secrets/{secret_name}: + get: + summary: Get a repository secret + description: >- + Gets a single repository secret without revealing its encrypted value. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/get-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-secret' + examples: + default: + $ref: '#/components/examples/dependabot-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update a repository secret + description: >- + Creates or updates a repository secret with an encrypted value. Encrypt + your secret using + + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: >- + Value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get a repository + public + key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) + endpoint. + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete a repository secret + description: >- + Deletes a secret in a repository using the secret name. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/delete-repo-secret + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets +components: + schemas: + dependabot-alert-with-repository: + type: object + description: A Dependabot alert. + properties: + number: + $ref: '#/components/schemas/alert-number' + state: + type: string + description: The state of the Dependabot alert. + readOnly: true + enum: + - auto_dismissed + - dismissed + - fixed + - open + dependency: + type: object + description: Details for the vulnerable dependency. + readOnly: true + properties: + package: + $ref: '#/components/schemas/dependabot-alert-package' + manifest_path: + type: string + description: >- + The full path to the dependency manifest file, relative to the + root of the repository. + readOnly: true + scope: + type: string + description: The execution scope of the vulnerable dependency. + readOnly: true + nullable: true + enum: + - development + - runtime + relationship: + type: string + description: > + The vulnerable dependency's relationship to your project. + + + > [!NOTE] + + > We are rolling out support for dependency relationship across + ecosystems. This value will be "unknown" for all dependencies in + unsupported ecosystems. + readOnly: true + nullable: true + enum: + - unknown + - direct + - transitive + - inconclusive + security_advisory: + $ref: '#/components/schemas/dependabot-alert-security-advisory' + security_vulnerability: + $ref: '#/components/schemas/dependabot-alert-security-vulnerability' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_reason: + type: string + description: The reason that the alert was dismissed. + nullable: true + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + dismissed_comment: + type: string + description: An optional comment associated with the alert's dismissal. + nullable: true + maxLength: 280 + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + auto_dismissed_at: + $ref: '#/components/schemas/alert-auto-dismissed-at' + dismissal_request: + $ref: '#/components/schemas/dependabot-alert-dismissal-request-simple' + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + $ref: '#/components/schemas/simple-user' + repository: + $ref: '#/components/schemas/simple-repository' + required: + - number + - state + - dependency + - security_advisory + - security_vulnerability + - url + - html_url + - created_at + - updated_at + - dismissed_at + - dismissed_by + - dismissed_reason + - dismissed_comment + - fixed_at + - repository + additionalProperties: false + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: >- + Information about repositories that Dependabot is able to access in an + organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + $ref: '#/components/schemas/nullable-simple-repository' + additionalProperties: false + organization-dependabot-secret: + title: Dependabot Secret for an Organization + description: Secrets for GitHub Dependabot for an organization. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + visibility: + description: Visibility of a secret + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + example: >- + https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + required: + - name + - created_at + - updated_at + - visibility + dependabot-public-key: + title: DependabotPublicKey + description: The public key used for setting Dependabot Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + dependabot-alert: + type: object + description: A Dependabot alert. + properties: + number: + $ref: '#/components/schemas/alert-number' + state: + type: string + description: The state of the Dependabot alert. + readOnly: true + enum: + - auto_dismissed + - dismissed + - fixed + - open + dependency: + type: object + description: Details for the vulnerable dependency. + readOnly: true + properties: + package: + $ref: '#/components/schemas/dependabot-alert-package' + manifest_path: + type: string + description: >- + The full path to the dependency manifest file, relative to the + root of the repository. + readOnly: true + scope: + type: string + description: The execution scope of the vulnerable dependency. + readOnly: true + nullable: true + enum: + - development + - runtime + relationship: + type: string + description: > + The vulnerable dependency's relationship to your project. + + + > [!NOTE] + + > We are rolling out support for dependency relationship across + ecosystems. This value will be "unknown" for all dependencies in + unsupported ecosystems. + readOnly: true + nullable: true + enum: + - unknown + - direct + - transitive + - inconclusive + security_advisory: + $ref: '#/components/schemas/dependabot-alert-security-advisory' + security_vulnerability: + $ref: '#/components/schemas/dependabot-alert-security-vulnerability' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_reason: + type: string + description: The reason that the alert was dismissed. + nullable: true + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + dismissed_comment: + type: string + description: An optional comment associated with the alert's dismissal. + nullable: true + maxLength: 280 + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + auto_dismissed_at: + $ref: '#/components/schemas/alert-auto-dismissed-at' + dismissal_request: + $ref: '#/components/schemas/dependabot-alert-dismissal-request-simple' + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - state + - dependency + - security_advisory + - security_vulnerability + - url + - html_url + - created_at + - updated_at + - dismissed_at + - dismissed_by + - dismissed_reason + - dismissed_comment + - fixed_at + additionalProperties: false + dependabot-secret: + title: Dependabot Secret + description: Set secrets for Dependabot. + type: object + properties: + name: + description: The name of the secret. + example: MY_ARTIFACTORY_PASSWORD + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + alert-number: + type: integer + description: The security alert number. + readOnly: true + dependabot-alert-package: + type: object + description: Details for the vulnerable package. + readOnly: true + properties: + ecosystem: + type: string + description: The package's language or package management ecosystem. + readOnly: true + name: + type: string + description: The unique package name within its ecosystem. + readOnly: true + required: + - ecosystem + - name + additionalProperties: false + dependabot-alert-security-advisory: + type: object + description: Details for the GitHub Security Advisory. + readOnly: true + properties: + ghsa_id: + type: string + description: The unique GitHub Security Advisory ID assigned to the advisory. + readOnly: true + cve_id: + type: string + description: The unique CVE ID assigned to the advisory. + readOnly: true + nullable: true + summary: + type: string + description: A short, plain text summary of the advisory. + readOnly: true + maxLength: 1024 + description: + type: string + description: A long-form Markdown-supported description of the advisory. + readOnly: true + vulnerabilities: + type: array + description: Vulnerable version range information for the advisory. + readOnly: true + items: + $ref: '#/components/schemas/dependabot-alert-security-vulnerability' + severity: + type: string + description: The severity of the advisory. + readOnly: true + enum: + - low + - medium + - high + - critical + classification: + type: string + description: The classification of the advisory. + readOnly: true + enum: + - general + - malware + cvss: + type: object + description: >- + Details for the advisory pertaining to the Common Vulnerability + Scoring System. + readOnly: true + properties: + score: + type: number + description: The overall CVSS score of the advisory. + minimum: 0 + maximum: 10 + readOnly: true + vector_string: + type: string + description: The full CVSS vector string for the advisory. + readOnly: true + nullable: true + required: + - score + - vector_string + additionalProperties: false + cvss_severities: + $ref: '#/components/schemas/cvss-severities' + epss: + $ref: '#/components/schemas/security-advisory-epss' + cwes: + type: array + description: Details for the advisory pertaining to Common Weakness Enumeration. + readOnly: true + items: + type: object + description: A CWE weakness assigned to the advisory. + readOnly: true + properties: + cwe_id: + type: string + description: The unique CWE ID. + readOnly: true + name: + type: string + description: The short, plain text name of the CWE. + readOnly: true + required: + - cwe_id + - name + additionalProperties: false + identifiers: + type: array + description: >- + Values that identify this advisory among security information + sources. + readOnly: true + items: + type: object + description: An advisory identifier. + readOnly: true + properties: + type: + type: string + description: The type of advisory identifier. + readOnly: true + enum: + - CVE + - GHSA + value: + type: string + description: The value of the advisory identifer. + readOnly: true + required: + - value + - type + additionalProperties: false + references: + type: array + description: Links to additional advisory information. + readOnly: true + items: + type: object + description: A link to additional advisory information. + readOnly: true + properties: + url: + type: string + description: The URL of the reference. + format: uri + readOnly: true + required: + - url + additionalProperties: false + published_at: + type: string + description: >- + The time that the advisory was published in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + updated_at: + type: string + description: >- + The time that the advisory was last modified in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + withdrawn_at: + type: string + description: >- + The time that the advisory was withdrawn in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cvss + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + additionalProperties: false + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + properties: + cvss: null + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + type: object + version: '2026-03-10' + dependabot-alert-security-vulnerability: + type: object + description: Details pertaining to one vulnerable version range for the advisory. + readOnly: true + properties: + package: + $ref: '#/components/schemas/dependabot-alert-package' + severity: + type: string + description: The severity of the vulnerability. + readOnly: true + enum: + - low + - medium + - high + - critical + vulnerable_version_range: + type: string + description: >- + Conditions that identify vulnerable versions of this vulnerability's + package. + readOnly: true + first_patched_version: + type: object + description: >- + Details pertaining to the package version that patches this + vulnerability. + readOnly: true + nullable: true + properties: + identifier: + type: string + description: The package version that patches this vulnerability. + readOnly: true + required: + - identifier + additionalProperties: false + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + additionalProperties: false + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + alert-created-at: + type: string + description: >- + The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + alert-updated-at: + type: string + description: >- + The time that the alert was last updated in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + alert-dismissed-at: + type: string + description: >- + The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + alert-fixed-at: + type: string + description: >- + The time that the alert was no longer detected and was considered fixed + in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + alert-auto-dismissed-at: + type: string + description: >- + The time that the alert was auto-dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + dependabot-alert-dismissal-request-simple: + title: Dependabot alert dismissal request + description: Information about an active dismissal request for this Dependabot alert. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the dismissal request. + status: + type: string + description: The current status of the dismissal request. + enum: + - pending + - approved + - rejected + - cancelled + requester: + type: object + description: The user who requested the dismissal. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The login name of the user. + created_at: + type: string + format: date-time + description: The date and time when the dismissal request was created. + url: + type: string + format: uri + description: The API URL to get more information about this dismissal request. + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + nullable-simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable: true + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + cvss-severities: + type: object + nullable: true + properties: + cvss_v3: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 3 vector string. + nullable: true + score: + type: number + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 4 vector string. + nullable: true + score: + type: number + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + security-advisory-epss: + type: object + nullable: true + readOnly: true + description: >- + The EPSS scores as calculated by the [Exploit Prediction Scoring + System](https://www.first.org/epss). + properties: + percentage: + type: number + minimum: 0 + maximum: 100 + percentile: + type: number + minimum: 0 + maximum: 100 + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + dependabot-alert-comma-separated-classifications: + name: classification + in: query + description: >- + A comma-separated list of vulnerability classifications. If specified, + only alerts for vulnerabilities with these classifications will be + returned. + + + Can be: `malware`, `general` + schema: + type: string + dependabot-alert-comma-separated-states: + name: state + in: query + description: >- + A comma-separated list of states. If specified, only alerts with these + states will be returned. + + + Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` + schema: + type: string + dependabot-alert-comma-separated-severities: + name: severity + in: query + description: >- + A comma-separated list of severities. If specified, only alerts with + these severities will be returned. + + + Can be: `low`, `medium`, `high`, `critical` + schema: + type: string + dependabot-alert-comma-separated-ecosystems: + name: ecosystem + in: query + description: >- + A comma-separated list of ecosystems. If specified, only alerts for + these ecosystems will be returned. + + + Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, + `rubygems`, `rust` + schema: + type: string + dependabot-alert-comma-separated-packages: + name: package + in: query + description: >- + A comma-separated list of package names. If specified, only alerts for + these packages will be returned. + schema: + type: string + dependabot-alert-comma-separated-epss: + name: epss_percentage + in: query + description: >- + CVE Exploit Prediction Scoring System (EPSS) percentage. Can be + specified as: + + - An exact number (`n`) + + - Comparators such as `>n`, `=n`, `<=n` + + - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + + + Filters the list of alerts based on EPSS percentages. If specified, only + alerts with the provided EPSS percentages will be returned. + schema: + type: string + dependabot-alert-comma-separated-has: + name: has + in: query + description: >- + Filters the list of alerts based on whether the alert has the given + value. If specified, only alerts meeting this criterion will be + returned. + + Multiple `has` filters can be passed to filter for alerts that have all + of the values. Currently, only `patch` is supported. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + dependabot-alert-comma-separated-assignees: + name: assignee + in: query + description: >- + Filter alerts by assignees. + + Provide a comma-separated list of user handles (e.g., `octocat` or + `octocat,hubot`) to return alerts assigned to any of the specified + users. + + Use `*` to list alerts with at least one assignee or `none` to list + alerts with no assignees. + schema: + type: string + dependabot-alert-scope: + name: scope + in: query + description: >- + The scope of the vulnerable dependency. If specified, only alerts with + this scope will be returned. + schema: + type: string + enum: + - development + - runtime + dependabot-alert-sort: + name: sort + in: query + description: >- + The property by which to sort the results. + + `created` means when the alert was created. + + `updated` means when the alert's state last changed. + + `epss_percentage` sorts alerts by the Exploit Prediction Scoring System + (EPSS) percentage. + schema: + type: string + enum: + - created + - updated + - epss_percentage + default: created + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: >- + A comma-separated list of artifact registry URLs. If specified, only + alerts for repositories with storage records matching these URLs will be + returned. + schema: + type: string + dependabot-alert-comma-separated-artifact-registry: + name: artifact_registry + in: query + description: >- + A comma-separated list of Artifact Registry name strings. If specified, + only alerts for repositories with storage records matching these + registries will be returned. + + + Can be: `jfrog-artifactory` + schema: + type: string + dependabot-alert-org-scope-comma-separated-has: + name: has + in: query + description: >- + Filters the list of alerts based on whether the alert has the given + value. If specified, only alerts meeting this criterion will be + returned. + + Multiple `has` filters can be passed to filter for alerts that have all + of the values. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + - deployment + dependabot-alert-comma-separated-runtime-risk: + name: runtime_risk + in: query + description: >- + A comma-separated list of runtime risk strings. If specified, only + alerts for repositories with deployment records matching these risks + will be returned. + + + Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, + `lateral-movement` + schema: + type: string + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + dependabot-alert-comma-separated-manifests: + name: manifest + in: query + description: >- + A comma-separated list of full manifest paths. If specified, only alerts + for these manifests will be returned. + schema: + type: string + dependabot-alert-number: + name: alert_number + in: path + description: >- + The number that identifies a Dependabot alert in its repository. + + You can find this at the end of the URL for a Dependabot alert within + GitHub, + + or in `number` fields in the response from the + + `GET /repos/{owner}/{repo}/dependabot/alerts` operation. + required: true + schema: + $ref: '#/components/schemas/alert-number' + examples: + dependabot-alerts-for-organization: + value: + - number: 2 + state: dismissed + dependency: + package: + ecosystem: pip + name: django + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-rf4j-j272-fj86 + cve_id: CVE-2018-6188 + summary: >- + Django allows remote attackers to obtain potentially sensitive + information by leveraging data exposure from the + confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive + description: >- + django.contrib.auth.forms.AuthenticationForm in Django 2.0 before + 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain + potentially sensitive information by leveraging data exposure from + the confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive. + vulnerabilities: + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 1.11.8, < 1.11.10' + first_patched_version: + identifier: 1.11.10 + severity: high + cvss: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_v4: + vector_string: >- + CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N + score: 8.7 + epss: + percentage: 0.00045 + percentile: '0.16001e0' + cwes: + - cwe_id: CWE-200 + name: Exposure of Sensitive Information to an Unauthorized Actor + identifiers: + - type: GHSA + value: GHSA-rf4j-j272-fj86 + - type: CVE + value: CVE-2018-6188 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 + - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 + - url: https://usn.ubuntu.com/3559-1/ + - url: >- + https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ + - url: http://www.securitytracker.com/id/1040422 + published_at: '2018-10-03T21:13:54Z' + updated_at: '2022-04-26T18:35:37Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + url: https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2 + html_url: https://github.com/octo-org/octo-repo/security/dependabot/2 + created_at: '2022-06-15T07:43:03Z' + updated_at: '2022-08-23T14:29:47Z' + dismissed_at: '2022-08-23T14:29:47Z' + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + fixed_at: null + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + archive_url: >- + https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + compare_url: >- + https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo/events + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_comment_url: >- + https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + milestones_url: >- + https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + - number: 1 + state: open + dependency: + package: + ecosystem: pip + name: ansible + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-8f4m-hccc-8qph + cve_id: CVE-2021-20191 + summary: Insertion of Sensitive Information into Log File in ansible + description: >- + A flaw was found in ansible. Credentials, such as secrets, are + being disclosed in console log by default and not protected by + no_log feature when using those modules. An attacker can take + advantage of this information to steal those credentials. The + highest threat from this vulnerability is to data confidentiality. + vulnerabilities: + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.9.0, < 2.9.18' + first_patched_version: + identifier: 2.9.18 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.10.0, < 2.10.7' + first_patched_version: + identifier: 2.10.7 + severity: medium + cvss: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_v4: + vector_string: >- + CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 8.5 + cwes: + - cwe_id: CWE-532 + name: Insertion of Sensitive Information into Log File + identifiers: + - type: GHSA + value: GHSA-8f4m-hccc-8qph + - type: CVE + value: CVE-2021-20191 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 + - url: https://access.redhat.com/security/cve/cve-2021-20191 + - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 + published_at: '2021-06-01T17:38:00Z' + updated_at: '2021-08-12T23:06:00Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + url: >- + https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1 + html_url: https://github.com/octo-org/hello-world/security/dependabot/1 + created_at: '2022-06-14T15:21:52Z' + updated_at: '2022-06-14T15:21:52Z' + dismissed_at: null + dismissed_by: null + dismissed_reason: null + dismissed_comment: null + fixed_at: null + assignees: [] + repository: + id: 664700648 + node_id: MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg= + name: hello-world + full_name: octo-org/hello-world + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/hello-world + description: null + fork: false + url: https://api.github.com/repos/octo-org/hello-world + archive_url: >- + https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/hello-world/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octo-org/hello-world/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octo-org/hello-world/comments{/number} + commits_url: https://api.github.com/repos/octo-org/hello-world/commits{/sha} + compare_url: >- + https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/hello-world/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/hello-world/contributors + deployments_url: https://api.github.com/repos/octo-org/hello-world/deployments + downloads_url: https://api.github.com/repos/octo-org/hello-world/downloads + events_url: https://api.github.com/repos/octo-org/hello-world/events + forks_url: https://api.github.com/repos/octo-org/hello-world/forks + git_commits_url: >- + https://api.github.com/repos/octo-org/hello-world/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/hello-world/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/hello-world/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/hello-world/hooks + issue_comment_url: >- + https://api.github.com/repos/octo-org/hello-world/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octo-org/hello-world/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/hello-world/issues{/number} + keys_url: https://api.github.com/repos/octo-org/hello-world/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/hello-world/labels{/name} + languages_url: https://api.github.com/repos/octo-org/hello-world/languages + merges_url: https://api.github.com/repos/octo-org/hello-world/merges + milestones_url: >- + https://api.github.com/repos/octo-org/hello-world/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/hello-world/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/hello-world/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/hello-world/stargazers + statuses_url: https://api.github.com/repos/octo-org/hello-world/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/hello-world/subscribers + subscription_url: https://api.github.com/repos/octo-org/hello-world/subscription + tags_url: https://api.github.com/repos/octo-org/hello-world/tags + teams_url: https://api.github.com/repos/octo-org/hello-world/teams + trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} + dependabot-repository-access-details: + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: >- + https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: >- + https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: >- + https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: >- + https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + organization-dependabot-secret-paginated: + value: + total_count: 3 + secrets: + - name: MY_ARTIFACTORY_PASSWORD + created_at: '2021-08-10T14:59:22Z' + updated_at: '2021-12-10T14:59:22Z' + visibility: private + - name: NPM_TOKEN + created_at: '2021-08-10T14:59:22Z' + updated_at: '2021-12-10T14:59:22Z' + visibility: all + - name: GH_TOKEN + created_at: '2021-08-10T14:59:22Z' + updated_at: '2021-12-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories + dependabot-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + organization-dependabot-secret: + value: + name: NPM_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: >- + https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + dependabot-alerts-for-repository: + value: + - number: 2 + state: dismissed + dependency: + package: + ecosystem: pip + name: django + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-rf4j-j272-fj86 + cve_id: CVE-2018-6188 + summary: >- + Django allows remote attackers to obtain potentially sensitive + information by leveraging data exposure from the + confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive + description: >- + django.contrib.auth.forms.AuthenticationForm in Django 2.0 before + 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain + potentially sensitive information by leveraging data exposure from + the confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive. + vulnerabilities: + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 1.11.8, < 1.11.10' + first_patched_version: + identifier: 1.11.10 + severity: high + cvss: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_v4: + vector_string: >- + CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N + score: 8.7 + epss: + percentage: 0.00045 + percentile: '0.16001e0' + cwes: + - cwe_id: CWE-200 + name: Exposure of Sensitive Information to an Unauthorized Actor + identifiers: + - type: GHSA + value: GHSA-rf4j-j272-fj86 + - type: CVE + value: CVE-2018-6188 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 + - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 + - url: https://usn.ubuntu.com/3559-1/ + - url: >- + https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ + - url: http://www.securitytracker.com/id/1040422 + published_at: '2018-10-03T21:13:54Z' + updated_at: '2022-04-26T18:35:37Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 + html_url: https://github.com/octocat/hello-world/security/dependabot/2 + created_at: '2022-06-15T07:43:03Z' + updated_at: '2022-08-23T14:29:47Z' + dismissed_at: '2022-08-23T14:29:47Z' + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + fixed_at: null + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - number: 1 + state: open + dependency: + package: + ecosystem: pip + name: ansible + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-8f4m-hccc-8qph + cve_id: CVE-2021-20191 + summary: Insertion of Sensitive Information into Log File in ansible + description: >- + A flaw was found in ansible. Credentials, such as secrets, are + being disclosed in console log by default and not protected by + no_log feature when using those modules. An attacker can take + advantage of this information to steal those credentials. The + highest threat from this vulnerability is to data confidentiality. + vulnerabilities: + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.9.0, < 2.9.18' + first_patched_version: + identifier: 2.9.18 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.10.0, < 2.10.7' + first_patched_version: + identifier: 2.10.7 + severity: medium + cvss: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_v4: + vector_string: >- + CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 8.5 + cwes: + - cwe_id: CWE-532 + name: Insertion of Sensitive Information into Log File + identifiers: + - type: GHSA + value: GHSA-8f4m-hccc-8qph + - type: CVE + value: CVE-2021-20191 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 + - url: https://access.redhat.com/security/cve/cve-2021-20191 + - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 + published_at: '2021-06-01T17:38:00Z' + updated_at: '2021-08-12T23:06:00Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 + html_url: https://github.com/octocat/hello-world/security/dependabot/1 + created_at: '2022-06-14T15:21:52Z' + updated_at: '2022-06-14T15:21:52Z' + dismissed_at: null + dismissed_by: null + dismissed_reason: null + dismissed_comment: null + fixed_at: null + assignees: [] + dependabot-alert-open: + value: + number: 1 + state: open + dependency: + package: + ecosystem: pip + name: ansible + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-8f4m-hccc-8qph + cve_id: CVE-2021-20191 + summary: Insertion of Sensitive Information into Log File in ansible + description: >- + A flaw was found in ansible. Credentials, such as secrets, are being + disclosed in console log by default and not protected by no_log + feature when using those modules. An attacker can take advantage of + this information to steal those credentials. The highest threat from + this vulnerability is to data confidentiality. + vulnerabilities: + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.9.0, < 2.9.18' + first_patched_version: + identifier: 2.9.18 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.10.0, < 2.10.7' + first_patched_version: + identifier: 2.10.7 + severity: medium + cvss: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_v4: + vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 8.5 + epss: + percentage: 0.00045 + percentile: '0.16001e0' + cwes: + - cwe_id: CWE-532 + name: Insertion of Sensitive Information into Log File + identifiers: + - type: GHSA + value: GHSA-8f4m-hccc-8qph + - type: CVE + value: CVE-2021-20191 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 + - url: https://access.redhat.com/security/cve/cve-2021-20191 + - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 + published_at: '2021-06-01T17:38:00Z' + updated_at: '2021-08-12T23:06:00Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 + html_url: https://github.com/octocat/hello-world/security/dependabot/1 + created_at: '2022-06-14T15:21:52Z' + updated_at: '2022-06-14T15:21:52Z' + dismissed_at: null + dismissed_by: null + dismissed_reason: null + dismissed_comment: null + fixed_at: null + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dependabot-alert-dismissed: + value: + number: 2 + state: dismissed + dependency: + package: + ecosystem: pip + name: django + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-rf4j-j272-fj86 + cve_id: CVE-2018-6188 + summary: >- + Django allows remote attackers to obtain potentially sensitive + information by leveraging data exposure from the + confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive + description: >- + django.contrib.auth.forms.AuthenticationForm in Django 2.0 before + 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain + potentially sensitive information by leveraging data exposure from + the confirm_login_allowed() method, as demonstrated by discovering + whether a user account is inactive. + vulnerabilities: + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 1.11.8, < 1.11.10' + first_patched_version: + identifier: 1.11.10 + severity: high + cvss: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N + score: 8.7 + cwes: + - cwe_id: CWE-200 + name: Exposure of Sensitive Information to an Unauthorized Actor + identifiers: + - type: GHSA + value: GHSA-rf4j-j272-fj86 + - type: CVE + value: CVE-2018-6188 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 + - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 + - url: https://usn.ubuntu.com/3559-1/ + - url: >- + https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ + - url: http://www.securitytracker.com/id/1040422 + published_at: '2018-10-03T21:13:54Z' + updated_at: '2022-04-26T18:35:37Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 + html_url: https://github.com/octocat/hello-world/security/dependabot/2 + created_at: '2022-06-15T07:43:03Z' + updated_at: '2022-08-23T14:29:47Z' + dismissed_at: '2022-08-23T14:29:47Z' + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + fixed_at: null + assignees: [] + dependabot-secret-paginated: + value: + total_count: 2 + secrets: + - name: AZURE_DEVOPS_PAT + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: MY_ARTIFACTORY_PASSWORD + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + dependabot-secret: + value: + name: MY_ARTIFACTORY_PASSWORD + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + alerts: + id: github.dependabot.alerts + name: alerts + title: Alerts + methods: + list_alerts_for_enterprise: + operation: + $ref: '#/paths/~1enterprises~1{enterprise}~1dependabot~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_alerts_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1dependabot~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_alerts_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1dependabot~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_alert: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependabot~1alerts~1{alert_number}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_alert: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependabot~1alerts~1{alert_number}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get_alert' + - $ref: >- + #/components/x-stackQL-resources/alerts/methods/list_alerts_for_repo + - $ref: >- + #/components/x-stackQL-resources/alerts/methods/list_alerts_for_enterprise + - $ref: >- + #/components/x-stackQL-resources/alerts/methods/list_alerts_for_org + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/alerts/methods/update_alert' + delete: [] + replace: [] + org_dependabot_repository_access: + id: github.dependabot.org_dependabot_repository_access + name: org_dependabot_repository_access + title: Org Dependabot Repository Access + methods: + repository_access_for_org: + operation: + $ref: '#/paths/~1organizations~1{org}~1dependabot~1repository-access/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_repository_access_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1organizations~1{org}~1dependabot~1repository-access/patch + response: + mediaType: application/json + openAPIDocKey: '204' + set_repository_access_default_level: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1organizations~1{org}~1dependabot~1repository-access~1default-level/put + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_dependabot_repository_access/methods/repository_access_for_org + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/org_dependabot_repository_access/methods/update_repository_access_for_org + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/org_dependabot_repository_access/methods/set_repository_access_default_level + secrets: + id: github.dependabot.secrets + name: secrets + title: Secrets + methods: + list_org_secrets: + operation: + $ref: '#/paths/~1orgs~1{org}~1dependabot~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_secret: + operation: + $ref: '#/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_org_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}/put' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_org_secret: + operation: + $ref: '#/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_repo_secrets: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1dependabot~1secrets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependabot~1secrets~1{secret_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_repo_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependabot~1secrets~1{secret_name}/put + response: + mediaType: application/json + openAPIDocKey: '201' + delete_repo_secret: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependabot~1secrets~1{secret_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/secrets/methods/get_repo_secret' + - $ref: '#/components/x-stackQL-resources/secrets/methods/get_org_secret' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list_repo_secrets' + - $ref: '#/components/x-stackQL-resources/secrets/methods/list_org_secrets' + insert: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/create_or_update_repo_secret + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/create_or_update_org_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/secrets/methods/delete_repo_secret + - $ref: '#/components/x-stackQL-resources/secrets/methods/delete_org_secret' + replace: [] + public_keys: + id: github.dependabot.public_keys + name: public_keys + title: Public Keys + methods: + get_org_public_key: + operation: + $ref: '#/paths/~1orgs~1{org}~1dependabot~1secrets~1public-key/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_public_key: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependabot~1secrets~1public-key/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_repo_public_key + - $ref: >- + #/components/x-stackQL-resources/public_keys/methods/get_org_public_key + insert: [] + update: [] + delete: [] + replace: [] + repos_for_secret: + id: github.dependabot.repos_for_secret + name: repos_for_secret + title: Repos For Secret + methods: + list_selected_repos_for_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_selected_repos_for_org_secret: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + add_selected_repo_to_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + remove_selected_repo_from_org_secret: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1dependabot~1secrets~1{secret_name}~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/list_selected_repos_for_org_secret + insert: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/add_selected_repo_to_org_secret + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/remove_selected_repo_from_org_secret + replace: + - $ref: >- + #/components/x-stackQL-resources/repos_for_secret/methods/set_selected_repos_for_org_secret +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/dependency_graph.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/dependency_graph.yaml new file mode 100644 index 0000000..609472c --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/dependency_graph.yaml @@ -0,0 +1,844 @@ +openapi: 3.0.3 +info: + title: dependency_graph API + description: github API + version: 1.1.4 +paths: + /repos/{owner}/{repo}/dependency-graph/compare/{basehead}: + get: + summary: Get a diff of the dependencies between commits + description: >- + Gets the diff of the dependency changes between two commits of a + repository, based on the changes to the dependency manifests made in + those commits. + tags: + - dependency-graph + operationId: dependency-graph/diff-range + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: basehead + description: >- + The base and head Git revisions to compare. The Git revisions will + be resolved to commit SHAs. Named revisions will be resolved to + their corresponding HEAD commits, and an appropriate merge base will + be determined. This parameter expects the format `{base}...{head}`. + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/manifest-path' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependency-graph-diff' + examples: + default: + $ref: '#/components/examples/diff-range-response' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/dependency_review_forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + category: dependency-graph + subcategory: dependency-review + x-stackQL-resource: dependency_review + /repos/{owner}/{repo}/dependency-graph/sbom: + get: + summary: Export a software bill of materials (SBOM) for a repository. + description: >- + Exports the software bill of materials (SBOM) for a repository in SPDX + JSON format. + tags: + - dependency-graph + operationId: dependency-graph/export-sbom + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependency-graph-spdx-sbom' + examples: + default: + $ref: '#/components/examples/dependency-graph-export-sbom-response' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + category: dependency-graph + subcategory: sboms + x-stackQL-resource: sboms + /repos/{owner}/{repo}/dependency-graph/snapshots: + post: + summary: Create a snapshot of dependencies for a repository + description: >- + Create a new snapshot of a repository's dependencies. + + + The authenticated user must have access to the repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - dependency-graph + operationId: dependency-graph/create-repository-snapshot + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/snapshot' + examples: + example-of-a-dependency-submission: + $ref: '#/components/examples/dependency-graph-create-snapshot-request' + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + required: + - id + - created_at + - result + - message + properties: + id: + type: integer + description: ID of the created snapshot. + created_at: + type: string + description: The time at which the snapshot was created. + result: + type: string + description: >- + Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" + indicates that the snapshot was successfully created and + the repository's dependencies were updated. "ACCEPTED" + indicates that the snapshot was successfully created, but + the repository's dependencies were not updated. "INVALID" + indicates that the snapshot was malformed. + message: + type: string + description: >- + A message providing further details about the result, such + as why the dependencies were not updated. + examples: + example-of-a-dependency-submission: + $ref: >- + #/components/examples/dependency-graph-create-snapshot-success + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependency-graph + subcategory: dependency-submission + x-stackQL-resource: dependency_submission +components: + schemas: + dependency-graph-diff: + title: Dependency Graph Diff + description: A diff of the dependencies between two commits. + type: array + items: + type: object + properties: + change_type: + type: string + enum: + - added + - removed + manifest: + type: string + example: path/to/package-lock.json + ecosystem: + type: string + example: npm + name: + type: string + example: '@actions/core' + version: + type: string + example: 1.0.0 + package_url: + type: string + nullable: true + example: pkg:/npm/%40actions/core@1.1.0 + license: + type: string + nullable: true + example: MIT + source_repository_url: + type: string + nullable: true + example: https://github.com/github/actions + vulnerabilities: + type: array + items: + type: object + properties: + severity: + type: string + example: critical + advisory_ghsa_id: + type: string + example: GHSA-rf4j-j272-fj86 + advisory_summary: + type: string + example: A summary of the advisory. + advisory_url: + type: string + example: https://github.com/advisories/GHSA-rf4j-j272-fj86 + required: + - severity + - advisory_ghsa_id + - advisory_summary + - advisory_url + scope: + description: >- + Where the dependency is utilized. `development` means that the + dependency is only utilized in the development environment. + `runtime` means that the dependency is utilized at runtime and in + the development environment. + type: string + enum: + - unknown + - runtime + - development + required: + - change_type + - manifest + - ecosystem + - name + - version + - package_url + - license + - source_repository_url + - vulnerabilities + - scope + dependency-graph-spdx-sbom: + title: Dependency Graph SPDX SBOM + description: A schema for the SPDX JSON format returned by the Dependency Graph. + type: object + properties: + sbom: + type: object + properties: + SPDXID: + type: string + example: SPDXRef-DOCUMENT + description: The SPDX identifier for the SPDX document. + spdxVersion: + type: string + example: SPDX-2.3 + description: >- + The version of the SPDX specification that this document + conforms to. + comment: + type: string + example: >- + Exact versions could not be resolved for some packages. For more + information: + https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + description: An optional comment about the SPDX document. + creationInfo: + type: object + properties: + created: + type: string + example: '2021-11-03T00:00:00Z' + description: The date and time the SPDX document was created. + creators: + type: array + items: + type: string + example: GitHub + description: The tools that were used to generate the SPDX document. + required: + - created + - creators + name: + type: string + example: github/github + description: The name of the SPDX document. + dataLicense: + type: string + example: CC0-1.0 + description: The license under which the SPDX document is licensed. + documentNamespace: + type: string + example: >- + https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + description: The namespace for the SPDX document. + packages: + type: array + items: + type: object + properties: + SPDXID: + type: string + example: SPDXRef-Package + description: A unique SPDX identifier for the package. + name: + type: string + example: github/github + description: The name of the package. + versionInfo: + type: string + example: 1.0.0 + description: >- + The version of the package. If the package does not have + an exact version specified, + + a version range is given. + downloadLocation: + type: string + example: NOASSERTION + description: |- + The location where the package can be downloaded, + or NOASSERTION if this has not been determined. + filesAnalyzed: + type: boolean + example: false + description: |- + Whether the package's file content has been subjected to + analysis during the creation of the SPDX document. + licenseConcluded: + type: string + example: MIT + description: >- + The license of the package as determined while creating + the SPDX document. + licenseDeclared: + type: string + example: NOASSERTION + description: >- + The license of the package as declared by its author, or + NOASSERTION if this information + + was not available when the SPDX document was created. + supplier: + type: string + example: NOASSERTION + description: >- + The distribution source of this package, or NOASSERTION if + this was not determined. + copyrightText: + type: string + example: Copyright (c) 1985 GitHub.com + description: >- + The copyright holders of the package, and any dates + present with those notices, if available. + externalRefs: + type: array + items: + type: object + properties: + referenceCategory: + type: string + example: PACKAGE-MANAGER + description: >- + The category of reference to an external resource + this reference refers to. + referenceLocator: + type: string + example: pkg:gem/rails@6.0.1 + description: >- + A locator for the particular external resource this + reference refers to. + referenceType: + type: string + example: purl + description: >- + The category of reference to an external resource + this reference refers to. + required: + - referenceCategory + - referenceLocator + - referenceType + required: + - SPDXID + - name + - versionInfo + - downloadLocation + - filesAnalyzed + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + example: DEPENDS_ON + description: The type of relationship between the two SPDX elements. + spdxElementId: + type: string + description: >- + The SPDX identifier of the package that is the source of + the relationship. + relatedSpdxElement: + type: string + description: >- + The SPDX identifier of the package that is the target of + the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement + required: + - SPDXID + - spdxVersion + - creationInfo + - name + - dataLicense + - documentNamespace + - packages + required: + - sbom + snapshot: + title: snapshot + description: Create a new snapshot of a repository's dependencies. + type: object + properties: + version: + description: The version of the repository snapshot submission. + type: integer + job: + type: object + properties: + id: + type: string + description: The external ID of the job. + example: 5622a2b0-63f6-4732-8c34-a1ab27e102a11 + correlator: + type: string + description: >- + Correlator provides a key that is used to group snapshots + submitted over time. Only the "latest" submitted snapshot for a + given combination of `job.correlator` and `detector.name` will + be considered when calculating a repository's current + dependencies. Correlator should be as unique as it takes to + distinguish all detection runs for a given "wave" of CI workflow + you run. If you're using GitHub Actions, a good default value + for this could be the environment variables GITHUB_WORKFLOW and + GITHUB_JOB concatenated together. If you're using a build + matrix, then you'll also need to add additional key(s) to + distinguish between each submission inside a matrix variation. + example: yourworkflowname_yourjobname + html_url: + type: string + description: The url for the job. + example: http://example.com/build + required: + - id + - correlator + additionalProperties: false + sha: + description: >- + The commit SHA associated with this dependency snapshot. Maximum + length: 40 characters. + type: string + example: ddc951f4b1293222421f2c8df679786153acf689 + minLength: 40 + maxLength: 40 + ref: + description: The repository branch that triggered this snapshot. + type: string + pattern: ^refs/ + example: refs/heads/main + detector: + type: object + description: A description of the detector used. + properties: + name: + type: string + description: The name of the detector used. + example: docker buildtime detector + version: + type: string + description: The version of the detector used. + example: 1.0.0 + url: + type: string + description: The url of the detector used. + example: http://example.com/docker-buildtimer-detector + required: + - name + - version + - url + additionalProperties: false + metadata: + $ref: '#/components/schemas/metadata' + manifests: + type: object + description: >- + A collection of package manifests, which are a collection of related + dependencies declared in a file or representing a logical group of + dependencies. + additionalProperties: + $ref: '#/components/schemas/manifest' + scanned: + type: string + format: date-time + description: The time at which the snapshot was scanned. + example: '2020-06-13T14:52:50-05:00' + required: + - detector + - version + - ref + - sha + - job + - scanned + additionalProperties: false + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + metadata: + title: metadata + description: >- + User-defined metadata to store domain-specific information limited to 8 + keys with scalar values. + type: object + maxProperties: 8 + additionalProperties: + nullable: true + anyOf: + - type: string + - type: number + - type: boolean + manifest: + type: object + properties: + name: + type: string + description: The name of the manifest. + example: package-lock.json + file: + type: object + properties: + source_location: + type: string + description: >- + The path of the manifest file relative to the root of the Git + repository. + example: /src/build/package-lock.json + additionalProperties: false + metadata: + $ref: '#/components/schemas/metadata' + resolved: + type: object + description: A collection of resolved package dependencies. + additionalProperties: + $ref: '#/components/schemas/dependency' + required: + - name + additionalProperties: false + dependency: + type: object + properties: + package_url: + type: string + description: >- + Package-url (PURL) of dependency. See + https://github.com/package-url/purl-spec for more details. + example: pkg:/npm/%40actions/http-client@1.0.11 + pattern: ^pkg + metadata: + $ref: '#/components/schemas/metadata' + relationship: + type: string + description: >- + A notation of whether a dependency is requested directly by this + manifest or is a dependency of another dependency. + example: direct + enum: + - direct + - indirect + scope: + type: string + description: >- + A notation of whether the dependency is required for the primary + build artifact (runtime) or is only used for development. Future + versions of this specification may allow for more granular scopes. + example: runtime + enum: + - runtime + - development + dependencies: + type: array + description: Array of package-url (PURLs) of direct child dependencies. + example: '@actions/http-client' + items: + type: string + additionalProperties: false + responses: + dependency_review_forbidden: + description: >- + Response for a private repository when GitHub Advanced Security is not + enabled, or if used against a fork + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + manifest-path: + name: name + description: >- + The full path, relative to the repository root, of the dependency + manifest file. + in: query + required: false + schema: + type: string + examples: + diff-range-response: + value: + - change_type: removed + manifest: package.json + ecosystem: npm + name: helmet + version: 4.6.0 + package_url: pkg:npm/helmet@4.6.0 + license: MIT + source_repository_url: https://github.com/helmetjs/helmet + vulnerabilities: [] + - change_type: added + manifest: package.json + ecosystem: npm + name: helmet + version: 5.0.0 + package_url: pkg:npm/helmet@5.0.0 + license: MIT + source_repository_url: https://github.com/helmetjs/helmet + vulnerabilities: [] + - change_type: added + manifest: Gemfile + ecosystem: rubygems + name: ruby-openid + version: 2.7.0 + package_url: pkg:gem/ruby-openid@2.7.0 + license: null + source_repository_url: https://github.com/openid/ruby-openid + vulnerabilities: + - severity: critical + advisory_ghsa_id: GHSA-fqfj-cmh6-hj49 + advisory_summary: Ruby OpenID + advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 + dependency-graph-export-sbom-response: + value: + sbom: + SPDXID: SPDXRef-DOCUMENT + spdxVersion: SPDX-2.3 + creationInfo: + created: '2021-09-01T00:00:00Z' + creators: + - 'Tool: GitHub.com-Dependency-Graph' + name: github/example + dataLicense: CC0-1.0 + documentNamespace: >- + https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + packages: + - name: rails + SPDXID: SPDXRef-Package + versionInfo: 1.0.0 + downloadLocation: NOASSERTION + filesAnalyzed: false + licenseConcluded: MIT + licenseDeclared: MIT + copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository + dependency-graph-create-snapshot-request: + value: + version: 0 + sha: ce587453ced02b1526dfb4cb910479d431683101 + ref: refs/heads/main + job: + correlator: yourworkflowname_youractionname + id: yourrunid + detector: + name: octo-detector + version: 0.0.1 + url: https://github.com/octo-org/octo-repo + scanned: '2022-06-14T20:25:00Z' + manifests: + package-lock.json: + name: package-lock.json + file: + source_location: src/package-lock.json + resolved: + '@actions/core': + package_url: pkg:/npm/%40actions/core@1.1.9 + dependencies: + - '@actions/http-client' + '@actions/http-client': + package_url: pkg:/npm/%40actions/http-client@1.0.7 + dependencies: + - tunnel + tunnel: + package_url: pkg:/npm/tunnel@0.0.6 + dependency-graph-create-snapshot-success: + value: + id: 12345 + created_at: '2018-05-04T01:14:52Z' + message: Dependency results for the repo have been successfully updated. + result: SUCCESS + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + dependency_review: + id: github.dependency_graph.dependency_review + name: dependency_review + title: Dependency Review + methods: + diff_range: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1dependency-graph~1compare~1{basehead}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/dependency_review/methods/diff_range + insert: [] + update: [] + delete: [] + replace: [] + sboms: + id: github.dependency_graph.sboms + name: sboms + title: Sboms + methods: + export_sbom: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1dependency-graph~1sbom/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.sbom + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/sboms/methods/export_sbom' + insert: [] + update: [] + delete: [] + replace: [] + dependency_submission: + id: github.dependency_graph.dependency_submission + name: dependency_submission + title: Dependency Submission + methods: + create_repository_snapshot: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1dependency-graph~1snapshots/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/dependency_submission/methods/create_repository_snapshot + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/emojis.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/emojis.yaml new file mode 100644 index 0000000..aa4234c --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/emojis.yaml @@ -0,0 +1,3619 @@ +openapi: 3.0.3 +info: + title: emojis API + description: List emojis available to use on GitHub. + version: 1.1.4 +paths: + /emojis: + get: + summary: Get emojis + description: Lists all the emojis available to use on GitHub. + operationId: emojis/get + tags: + - emojis + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/emojis/emojis#get-emojis + parameters: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: + type: string + examples: + default: + $ref: '#/components/examples/emojis-get' + description: Response + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: emojis + subcategory: emojis + x-stackQL-resource: emojis +components: + responses: + not_modified: + description: Not modified + examples: + emojis-get: + value: + '100': >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8 + '1234': >- + https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8 + '+1': >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8 + '-1': >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8 + 1st_place_medal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8 + 2nd_place_medal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8 + 3rd_place_medal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8 + 8ball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8 + a: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8 + ab: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8 + abacus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8 + abc: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8 + abcd: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8 + accept: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8 + accessibility: >- + https://github.githubassets.com/images/icons/emoji/accessibility.png?v8 + accordion: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8 + adhesive_bandage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8 + adult: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8 + aerial_tramway: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8 + afghanistan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8 + airplane: https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8 + aland_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8 + alarm_clock: https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8 + albania: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8 + alembic: https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8 + algeria: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8 + alien: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8 + ambulance: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8 + american_samoa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8 + amphora: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8 + anatomical_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8 + anchor: https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8 + andorra: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8 + angel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8 + anger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8 + angola: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8 + angry: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8 + anguilla: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8 + anguished: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8 + ant: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8 + antarctica: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8 + antigua_barbuda: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8 + apple: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8 + aquarius: https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8 + argentina: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8 + aries: https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8 + armenia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8 + arrow_backward: https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8 + arrow_double_down: https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8 + arrow_double_up: https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8 + arrow_down: https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8 + arrow_down_small: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8 + arrow_forward: https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8 + arrow_heading_down: https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8 + arrow_heading_up: https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8 + arrow_left: https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8 + arrow_lower_left: https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8 + arrow_lower_right: https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8 + arrow_right: https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8 + arrow_right_hook: https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8 + arrow_up: https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8 + arrow_up_down: https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8 + arrow_up_small: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8 + arrow_upper_left: https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8 + arrow_upper_right: https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8 + arrows_clockwise: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8 + arrows_counterclockwise: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8 + art: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8 + articulated_lorry: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8 + artificial_satellite: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8 + artist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8 + aruba: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8 + ascension_island: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8 + asterisk: >- + https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8 + astonished: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8 + astronaut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8 + athletic_shoe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8 + atm: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8 + atom: https://github.githubassets.com/images/icons/emoji/atom.png?v8 + atom_symbol: https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8 + australia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8 + austria: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8 + auto_rickshaw: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8 + avocado: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8 + axe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8 + azerbaijan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8 + b: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8 + baby: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8 + baby_bottle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8 + baby_chick: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8 + baby_symbol: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8 + back: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8 + bacon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8 + badger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8 + badminton: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8 + bagel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8 + baggage_claim: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8 + baguette_bread: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8 + bahamas: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8 + bahrain: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8 + balance_scale: https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8 + bald_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8 + bald_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8 + ballet_shoes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8 + balloon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8 + ballot_box: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8 + ballot_box_with_check: https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8 + bamboo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8 + banana: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8 + bangbang: https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8 + bangladesh: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8 + banjo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8 + bank: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8 + bar_chart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8 + barbados: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8 + barber: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8 + baseball: https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8 + basecamp: https://github.githubassets.com/images/icons/emoji/basecamp.png?v8 + basecampy: https://github.githubassets.com/images/icons/emoji/basecampy.png?v8 + basket: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8 + basketball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8 + basketball_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8 + basketball_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8 + bat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8 + bath: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8 + bathtub: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8 + battery: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8 + beach_umbrella: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8 + bear: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8 + bearded_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8 + beaver: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8 + bed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8 + bee: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8 + beer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8 + beers: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8 + beetle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8 + beginner: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8 + belarus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8 + belgium: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8 + belize: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8 + bell: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8 + bell_pepper: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8 + bellhop_bell: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8 + benin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8 + bento: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8 + bermuda: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8 + beverage_box: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8 + bhutan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8 + bicyclist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8 + bike: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8 + biking_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8 + biking_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8 + bikini: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8 + billed_cap: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8 + biohazard: https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8 + bird: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8 + birthday: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8 + bison: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8 + black_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8 + black_circle: https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8 + black_flag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8 + black_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8 + black_joker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8 + black_large_square: https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8 + black_medium_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8 + black_medium_square: https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8 + black_nib: https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8 + black_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8 + black_square_button: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8 + blond_haired_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8 + blond_haired_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8 + blond_haired_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8 + blonde_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8 + blossom: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8 + blowfish: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8 + blue_book: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8 + blue_car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8 + blue_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8 + blue_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8 + blueberries: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8 + blush: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8 + boar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8 + boat: https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8 + bolivia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8 + bomb: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8 + bone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8 + book: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8 + bookmark: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8 + bookmark_tabs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8 + books: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8 + boom: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8 + boomerang: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8 + boot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8 + bosnia_herzegovina: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8 + botswana: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8 + bouncing_ball_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8 + bouncing_ball_person: https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8 + bouncing_ball_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8 + bouquet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8 + bouvet_island: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8 + bow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8 + bow_and_arrow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8 + bowing_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8 + bowing_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8 + bowl_with_spoon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8 + bowling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8 + bowtie: https://github.githubassets.com/images/icons/emoji/bowtie.png?v8 + boxing_glove: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8 + boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8 + brain: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8 + brazil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8 + bread: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8 + breast_feeding: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8 + bricks: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8 + bride_with_veil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8 + bridge_at_night: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8 + briefcase: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8 + british_indian_ocean_territory: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8 + british_virgin_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8 + broccoli: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8 + broken_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8 + broom: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8 + brown_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8 + brown_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8 + brown_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8 + brunei: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8 + bubble_tea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8 + bucket: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8 + bug: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8 + building_construction: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8 + bulb: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8 + bulgaria: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8 + bullettrain_front: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8 + bullettrain_side: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8 + burkina_faso: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8 + burrito: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8 + burundi: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8 + bus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8 + business_suit_levitating: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8 + busstop: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8 + bust_in_silhouette: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8 + busts_in_silhouette: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8 + butter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8 + butterfly: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8 + cactus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8 + cake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8 + calendar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8 + call_me_hand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8 + calling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8 + cambodia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8 + camel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8 + camera: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8 + camera_flash: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8 + cameroon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8 + camping: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8 + canada: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8 + canary_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8 + cancer: https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8 + candle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8 + candy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8 + canned_food: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8 + canoe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8 + cape_verde: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8 + capital_abcd: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8 + capricorn: https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8 + car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8 + card_file_box: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8 + card_index: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8 + card_index_dividers: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8 + caribbean_netherlands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8 + carousel_horse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8 + carpentry_saw: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8 + carrot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8 + cartwheeling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8 + cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8 + cat2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8 + cayman_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8 + cd: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8 + central_african_republic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8 + ceuta_melilla: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8 + chad: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8 + chains: https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8 + chair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8 + champagne: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8 + chart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8 + chart_with_downwards_trend: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8 + chart_with_upwards_trend: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8 + checkered_flag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8 + cheese: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8 + cherries: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8 + cherry_blossom: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8 + chess_pawn: https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8 + chestnut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8 + chicken: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8 + child: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8 + children_crossing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8 + chile: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8 + chipmunk: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8 + chocolate_bar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8 + chopsticks: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8 + christmas_island: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8 + christmas_tree: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8 + church: https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8 + cinema: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8 + circus_tent: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8 + city_sunrise: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8 + city_sunset: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8 + cityscape: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8 + cl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8 + clamp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8 + clap: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8 + clapper: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8 + classical_building: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8 + climbing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8 + climbing_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8 + climbing_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8 + clinking_glasses: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8 + clipboard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8 + clipperton_island: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8 + clock1: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8 + clock10: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8 + clock1030: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8 + clock11: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8 + clock1130: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8 + clock12: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8 + clock1230: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8 + clock130: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8 + clock2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8 + clock230: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8 + clock3: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8 + clock330: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8 + clock4: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8 + clock430: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8 + clock5: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8 + clock530: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8 + clock6: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8 + clock630: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8 + clock7: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8 + clock730: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8 + clock8: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8 + clock830: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8 + clock9: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8 + clock930: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8 + closed_book: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8 + closed_lock_with_key: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8 + closed_umbrella: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8 + cloud: https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8 + cloud_with_lightning: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8 + cloud_with_lightning_and_rain: https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8 + cloud_with_rain: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8 + cloud_with_snow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8 + clown_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8 + clubs: https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8 + cn: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8 + coat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8 + cockroach: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8 + cocktail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8 + coconut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8 + cocos_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8 + coffee: https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8 + coffin: https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8 + coin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8 + cold_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8 + cold_sweat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8 + collision: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8 + colombia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8 + comet: https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8 + comoros: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8 + compass: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8 + computer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8 + computer_mouse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8 + confetti_ball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8 + confounded: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8 + confused: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8 + congo_brazzaville: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8 + congo_kinshasa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8 + congratulations: https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8 + construction: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8 + construction_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8 + construction_worker_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8 + construction_worker_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8 + control_knobs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8 + convenience_store: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8 + cook: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8 + cook_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8 + cookie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 + cool: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 + cop: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 + copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 + corn: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 + costa_rica: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 + cote_divoire: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8 + couch_and_lamp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8 + couple: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8 + couple_with_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8 + couple_with_heart_man_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8 + couple_with_heart_woman_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8 + couple_with_heart_woman_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8 + couplekiss: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8 + couplekiss_man_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8 + couplekiss_man_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8 + couplekiss_woman_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8 + cow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8 + cow2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8 + cowboy_hat_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8 + crab: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8 + crayon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8 + credit_card: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8 + crescent_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8 + cricket: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8 + cricket_game: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8 + croatia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8 + crocodile: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8 + croissant: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8 + crossed_fingers: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8 + crossed_flags: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8 + crossed_swords: https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8 + crown: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8 + cry: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8 + crying_cat_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8 + crystal_ball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8 + cuba: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8 + cucumber: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8 + cup_with_straw: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8 + cupcake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8 + cupid: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8 + curacao: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8 + curling_stone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8 + curly_haired_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8 + curly_haired_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8 + curly_loop: https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8 + currency_exchange: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8 + curry: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8 + cursing_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8 + custard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8 + customs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8 + cut_of_meat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8 + cyclone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8 + cyprus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8 + czech_republic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8 + dagger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8 + dancer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8 + dancers: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8 + dancing_men: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8 + dancing_women: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8 + dango: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8 + dark_sunglasses: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8 + dart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8 + dash: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8 + date: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8 + de: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8 + deaf_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8 + deaf_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8 + deaf_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8 + deciduous_tree: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8 + deer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8 + denmark: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8 + department_store: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8 + dependabot: https://github.githubassets.com/images/icons/emoji/dependabot.png?v8 + derelict_house: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8 + desert: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8 + desert_island: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8 + desktop_computer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8 + detective: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8 + diamond_shape_with_a_dot_inside: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8 + diamonds: https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8 + diego_garcia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8 + disappointed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8 + disappointed_relieved: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8 + disguised_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8 + diving_mask: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8 + diya_lamp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8 + dizzy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8 + dizzy_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8 + djibouti: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8 + dna: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8 + do_not_litter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8 + dodo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8 + dog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8 + dog2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8 + dollar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8 + dolls: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8 + dolphin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8 + dominica: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8 + dominican_republic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8 + door: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8 + doughnut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8 + dove: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8 + dragon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8 + dragon_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8 + dress: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8 + dromedary_camel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8 + drooling_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8 + drop_of_blood: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8 + droplet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8 + drum: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8 + duck: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8 + dumpling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8 + dvd: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8 + e-mail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8 + eagle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8 + ear: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8 + ear_of_rice: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8 + ear_with_hearing_aid: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8 + earth_africa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8 + earth_americas: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8 + earth_asia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8 + ecuador: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8 + egg: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8 + eggplant: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8 + egypt: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8 + eight: >- + https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8 + eight_pointed_black_star: https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8 + eight_spoked_asterisk: https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8 + eject_button: https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8 + el_salvador: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8 + electric_plug: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8 + electron: https://github.githubassets.com/images/icons/emoji/electron.png?v8 + elephant: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8 + elevator: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8 + elf: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8 + elf_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8 + elf_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8 + email: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8 + end: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8 + england: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8 + envelope: https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8 + envelope_with_arrow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8 + equatorial_guinea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8 + eritrea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8 + es: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8 + estonia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8 + ethiopia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8 + eu: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8 + euro: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8 + european_castle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8 + european_post_office: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8 + european_union: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8 + evergreen_tree: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8 + exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8 + exploding_head: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8 + expressionless: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8 + eye: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8 + eye_speech_bubble: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8 + eyeglasses: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8 + eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8 + face_exhaling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8 + face_in_clouds: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8 + face_with_head_bandage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8 + face_with_spiral_eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8 + face_with_thermometer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8 + facepalm: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8 + facepunch: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 + factory: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8 + factory_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8 + fairy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8 + fairy_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8 + fairy_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8 + falafel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8 + falkland_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8 + fallen_leaf: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8 + family: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8 + family_man_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8 + family_man_boy_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8 + family_man_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8 + family_man_girl_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8 + family_man_girl_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8 + family_man_man_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8 + family_man_man_boy_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8 + family_man_man_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8 + family_man_man_girl_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8 + family_man_man_girl_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8 + family_man_woman_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8 + family_man_woman_boy_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8 + family_man_woman_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8 + family_man_woman_girl_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8 + family_man_woman_girl_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8 + family_woman_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8 + family_woman_boy_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8 + family_woman_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8 + family_woman_girl_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8 + family_woman_girl_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8 + family_woman_woman_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8 + family_woman_woman_boy_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8 + family_woman_woman_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8 + family_woman_woman_girl_boy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8 + family_woman_woman_girl_girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8 + farmer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8 + faroe_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8 + fast_forward: https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8 + fax: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8 + fearful: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8 + feather: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8 + feelsgood: https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8 + feet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8 + female_detective: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8 + female_sign: https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8 + ferris_wheel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8 + ferry: https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8 + field_hockey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8 + fiji: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8 + file_cabinet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8 + file_folder: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8 + film_projector: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8 + film_strip: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8 + finland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8 + finnadie: https://github.githubassets.com/images/icons/emoji/finnadie.png?v8 + fire: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8 + fire_engine: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8 + fire_extinguisher: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8 + firecracker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8 + firefighter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8 + fireworks: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8 + first_quarter_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8 + first_quarter_moon_with_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8 + fish: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8 + fish_cake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8 + fishsticks: https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8 + fishing_pole_and_fish: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8 + fist: https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8 + fist_left: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8 + fist_oncoming: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 + fist_raised: https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8 + fist_right: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8 + five: >- + https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8 + flags: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8 + flamingo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8 + flashlight: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8 + flat_shoe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8 + flatbread: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8 + fleur_de_lis: https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8 + flight_arrival: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8 + flight_departure: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8 + flipper: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8 + floppy_disk: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8 + flower_playing_cards: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8 + flushed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8 + fly: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8 + flying_disc: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8 + flying_saucer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8 + fog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8 + foggy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8 + fondue: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8 + foot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8 + football: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8 + footprints: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8 + fork_and_knife: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8 + fortune_cookie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8 + fountain: https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8 + fountain_pen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8 + four: >- + https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8 + four_leaf_clover: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8 + fox_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8 + fr: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8 + framed_picture: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8 + free: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8 + french_guiana: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8 + french_polynesia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8 + french_southern_territories: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8 + fried_egg: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8 + fried_shrimp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8 + fries: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8 + frog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8 + frowning: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8 + frowning_face: https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8 + frowning_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8 + frowning_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8 + frowning_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8 + fu: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8 + fuelpump: https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8 + full_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8 + full_moon_with_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8 + funeral_urn: https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8 + gabon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8 + gambia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8 + game_die: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8 + garlic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8 + gb: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8 + gear: https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8 + gem: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8 + gemini: https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8 + genie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8 + genie_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8 + genie_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8 + georgia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8 + ghana: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8 + ghost: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8 + gibraltar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8 + gift: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8 + gift_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8 + giraffe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8 + girl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8 + globe_with_meridians: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8 + gloves: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8 + goal_net: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8 + goat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8 + goberserk: https://github.githubassets.com/images/icons/emoji/goberserk.png?v8 + godmode: https://github.githubassets.com/images/icons/emoji/godmode.png?v8 + goggles: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8 + golf: https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8 + golfing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8 + golfing_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8 + golfing_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8 + gorilla: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8 + grapes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8 + greece: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8 + green_apple: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8 + green_book: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8 + green_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8 + green_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8 + green_salad: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8 + green_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8 + greenland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8 + grenada: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8 + grey_exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8 + grey_question: https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8 + grimacing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8 + grin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8 + grinning: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8 + guadeloupe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8 + guam: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8 + guard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8 + guardsman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8 + guardswoman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8 + guatemala: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8 + guernsey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8 + guide_dog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8 + guinea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8 + guinea_bissau: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8 + guitar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8 + gun: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8 + guyana: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8 + haircut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8 + haircut_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8 + haircut_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8 + haiti: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8 + hamburger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8 + hammer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8 + hammer_and_pick: https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8 + hammer_and_wrench: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8 + hamster: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8 + hand: https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8 + hand_over_mouth: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8 + handbag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8 + handball_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8 + handshake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8 + hankey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8 + hash: >- + https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8 + hatched_chick: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8 + hatching_chick: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8 + headphones: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8 + headstone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8 + health_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8 + hear_no_evil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8 + heard_mcdonald_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8 + heart: https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8 + heart_decoration: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8 + heart_eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8 + heart_eyes_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8 + heart_on_fire: >- + https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8 + heartbeat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8 + heartpulse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8 + hearts: https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8 + heavy_check_mark: https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8 + heavy_division_sign: https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8 + heavy_dollar_sign: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8 + heavy_exclamation_mark: https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8 + heavy_heart_exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8 + heavy_minus_sign: https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8 + heavy_multiplication_x: https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8 + heavy_plus_sign: https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8 + hedgehog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8 + helicopter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8 + herb: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8 + hibiscus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8 + high_brightness: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8 + high_heel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8 + hiking_boot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8 + hindu_temple: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8 + hippopotamus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8 + hocho: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8 + hole: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8 + honduras: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8 + honey_pot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8 + honeybee: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8 + hong_kong: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8 + hook: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8 + horse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8 + horse_racing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8 + hospital: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8 + hot_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8 + hot_pepper: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8 + hotdog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8 + hotel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8 + hotsprings: https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8 + hourglass: https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8 + hourglass_flowing_sand: https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8 + house: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8 + house_with_garden: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8 + houses: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8 + hugs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8 + hungary: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8 + hurtrealbad: https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8 + hushed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8 + hut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8 + ice_cream: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8 + ice_cube: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8 + ice_hockey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8 + ice_skate: https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8 + icecream: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8 + iceland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8 + id: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8 + ideograph_advantage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8 + imp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8 + inbox_tray: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8 + incoming_envelope: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8 + india: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8 + indonesia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8 + infinity: https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8 + information_desk_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8 + information_source: https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8 + innocent: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8 + interrobang: https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8 + iphone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8 + iran: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8 + iraq: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8 + ireland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8 + isle_of_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8 + israel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8 + it: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8 + izakaya_lantern: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8 + jack_o_lantern: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8 + jamaica: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8 + japan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8 + japanese_castle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8 + japanese_goblin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8 + japanese_ogre: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8 + jeans: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8 + jersey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8 + jigsaw: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8 + jordan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8 + joy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8 + joy_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8 + joystick: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8 + jp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8 + judge: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8 + juggling_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8 + kangaroo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8 + kazakhstan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8 + kenya: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8 + key: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8 + keyboard: https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8 + keycap_ten: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8 + kick_scooter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8 + kimono: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8 + kiribati: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8 + kiss: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8 + kissing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8 + kissing_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8 + kissing_closed_eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8 + kissing_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8 + kissing_smiling_eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8 + kite: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8 + kiwi_fruit: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8 + kneeling_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8 + kneeling_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8 + kneeling_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8 + knife: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8 + knot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8 + koala: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8 + koko: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8 + kosovo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8 + kr: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8 + kuwait: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8 + kyrgyzstan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8 + lab_coat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8 + label: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8 + lacrosse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8 + ladder: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8 + lady_beetle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8 + lantern: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8 + laos: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8 + large_blue_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8 + large_blue_diamond: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8 + large_orange_diamond: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8 + last_quarter_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8 + last_quarter_moon_with_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8 + latin_cross: https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8 + latvia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8 + laughing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8 + leafy_green: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8 + leaves: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8 + lebanon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8 + ledger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8 + left_luggage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8 + left_right_arrow: https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8 + left_speech_bubble: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8 + leftwards_arrow_with_hook: https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8 + leg: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8 + lemon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8 + leo: https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8 + leopard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8 + lesotho: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8 + level_slider: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8 + liberia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8 + libra: https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8 + libya: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8 + liechtenstein: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8 + light_rail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8 + link: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8 + lion: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8 + lips: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8 + lipstick: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8 + lithuania: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8 + lizard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8 + llama: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8 + lobster: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8 + lock: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8 + lock_with_ink_pen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8 + lollipop: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8 + long_drum: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8 + loop: https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8 + lotion_bottle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8 + lotus_position: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8 + lotus_position_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8 + lotus_position_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8 + loud_sound: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8 + loudspeaker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8 + love_hotel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8 + love_letter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8 + love_you_gesture: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8 + low_brightness: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8 + luggage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8 + lungs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8 + luxembourg: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8 + lying_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8 + m: https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8 + macau: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8 + macedonia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8 + madagascar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8 + mag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8 + mag_right: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8 + mage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8 + mage_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8 + mage_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8 + magic_wand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8 + magnet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8 + mahjong: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8 + mailbox: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8 + mailbox_closed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8 + mailbox_with_mail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8 + mailbox_with_no_mail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8 + malawi: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8 + malaysia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8 + maldives: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8 + male_detective: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8 + male_sign: https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8 + mali: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8 + malta: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8 + mammoth: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8 + man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8 + man_artist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8 + man_astronaut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8 + man_beard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8 + man_cartwheeling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8 + man_cook: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8 + man_dancing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8 + man_facepalming: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8 + man_factory_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8 + man_farmer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8 + man_feeding_baby: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8 + man_firefighter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8 + man_health_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8 + man_in_manual_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8 + man_in_motorized_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8 + man_in_tuxedo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8 + man_judge: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8 + man_juggling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8 + man_mechanic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8 + man_office_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8 + man_pilot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8 + man_playing_handball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8 + man_playing_water_polo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8 + man_scientist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8 + man_shrugging: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8 + man_singer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8 + man_student: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8 + man_teacher: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8 + man_technologist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8 + man_with_gua_pi_mao: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8 + man_with_probing_cane: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8 + man_with_turban: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8 + man_with_veil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8 + mandarin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 + mango: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8 + mans_shoe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8 + mantelpiece_clock: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8 + manual_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8 + maple_leaf: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8 + marshall_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8 + martial_arts_uniform: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8 + martinique: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8 + mask: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8 + massage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8 + massage_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8 + massage_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8 + mate: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8 + mauritania: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8 + mauritius: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8 + mayotte: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8 + meat_on_bone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8 + mechanic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8 + mechanical_arm: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8 + mechanical_leg: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8 + medal_military: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8 + medal_sports: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8 + medical_symbol: https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8 + mega: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8 + melon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8 + memo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8 + men_wrestling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8 + mending_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8 + menorah: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8 + mens: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8 + mermaid: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8 + merman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8 + merperson: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8 + metal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8 + metro: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8 + mexico: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8 + microbe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8 + micronesia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8 + microphone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8 + microscope: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8 + middle_finger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8 + military_helmet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8 + milk_glass: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8 + milky_way: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8 + minibus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8 + minidisc: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8 + mirror: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8 + mobile_phone_off: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8 + moldova: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8 + monaco: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8 + money_mouth_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8 + money_with_wings: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8 + moneybag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8 + mongolia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8 + monkey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8 + monkey_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8 + monocle_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8 + monorail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8 + montenegro: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8 + montserrat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8 + moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8 + moon_cake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8 + morocco: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8 + mortar_board: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8 + mosque: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8 + mosquito: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8 + motor_boat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8 + motor_scooter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8 + motorcycle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8 + motorized_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8 + motorway: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8 + mount_fuji: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8 + mountain: https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8 + mountain_bicyclist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8 + mountain_biking_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8 + mountain_biking_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8 + mountain_cableway: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8 + mountain_railway: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8 + mountain_snow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8 + mouse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8 + mouse2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8 + mouse_trap: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8 + movie_camera: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8 + moyai: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8 + mozambique: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8 + mrs_claus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8 + muscle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8 + mushroom: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8 + musical_keyboard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8 + musical_note: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8 + musical_score: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8 + mute: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8 + mx_claus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8 + myanmar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8 + nail_care: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8 + name_badge: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8 + namibia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8 + national_park: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8 + nauru: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8 + nauseated_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8 + nazar_amulet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8 + neckbeard: https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8 + necktie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8 + negative_squared_cross_mark: https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8 + nepal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8 + nerd_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8 + nesting_dolls: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8 + netherlands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8 + neutral_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8 + new: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8 + new_caledonia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8 + new_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8 + new_moon_with_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8 + new_zealand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8 + newspaper: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8 + newspaper_roll: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8 + next_track_button: https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8 + ng: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8 + ng_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8 + ng_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8 + nicaragua: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8 + niger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8 + nigeria: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8 + night_with_stars: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8 + nine: >- + https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8 + ninja: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8 + niue: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8 + no_bell: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8 + no_bicycles: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8 + no_entry: https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8 + no_entry_sign: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8 + no_good: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8 + no_good_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8 + no_good_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8 + no_mobile_phones: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8 + no_mouth: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8 + no_pedestrians: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8 + no_smoking: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8 + non-potable_water: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8 + norfolk_island: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8 + north_korea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8 + northern_mariana_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8 + norway: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8 + nose: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8 + notebook: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8 + notebook_with_decorative_cover: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8 + notes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8 + nut_and_bolt: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8 + o: https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8 + o2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8 + ocean: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8 + octocat: https://github.githubassets.com/images/icons/emoji/octocat.png?v8 + octopus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8 + oden: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8 + office: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8 + office_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8 + oil_drum: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8 + ok: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8 + ok_hand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8 + ok_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8 + ok_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8 + ok_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8 + old_key: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8 + older_adult: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8 + older_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8 + older_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8 + olive: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8 + om: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8 + oman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8 + 'on': >- + https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8 + oncoming_automobile: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8 + oncoming_bus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8 + oncoming_police_car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8 + oncoming_taxi: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8 + one: >- + https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8 + one_piece_swimsuit: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8 + onion: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8 + open_book: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8 + open_file_folder: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8 + open_hands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8 + open_mouth: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8 + open_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8 + ophiuchus: https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8 + orange: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 + orange_book: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8 + orange_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8 + orange_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8 + orange_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8 + orangutan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8 + orthodox_cross: https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8 + otter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8 + outbox_tray: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8 + owl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8 + ox: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8 + oyster: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8 + package: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8 + page_facing_up: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8 + page_with_curl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8 + pager: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8 + paintbrush: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8 + pakistan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8 + palau: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8 + palestinian_territories: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8 + palm_tree: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8 + palms_up_together: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8 + panama: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8 + pancakes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8 + panda_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8 + paperclip: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8 + paperclips: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8 + papua_new_guinea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8 + parachute: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8 + paraguay: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8 + parasol_on_ground: https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8 + parking: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8 + parrot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8 + part_alternation_mark: https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8 + partly_sunny: https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8 + partying_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8 + passenger_ship: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8 + passport_control: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8 + pause_button: https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8 + paw_prints: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8 + peace_symbol: https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8 + peach: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8 + peacock: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8 + peanuts: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8 + pear: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8 + pen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8 + pencil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8 + pencil2: https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8 + penguin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8 + pensive: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8 + people_holding_hands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8 + people_hugging: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8 + performing_arts: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8 + persevere: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8 + person_bald: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8 + person_curly_hair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8 + person_feeding_baby: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8 + person_fencing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8 + person_in_manual_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8 + person_in_motorized_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8 + person_in_tuxedo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8 + person_red_hair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8 + person_white_hair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8 + person_with_probing_cane: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8 + person_with_turban: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8 + person_with_veil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8 + peru: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8 + petri_dish: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8 + philippines: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8 + phone: https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8 + pick: https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8 + pickup_truck: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8 + pie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8 + pig: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8 + pig2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8 + pig_nose: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8 + pill: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8 + pilot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8 + pinata: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8 + pinched_fingers: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8 + pinching_hand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8 + pineapple: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8 + ping_pong: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8 + pirate_flag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8 + pisces: https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8 + pitcairn_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8 + pizza: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8 + placard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8 + place_of_worship: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8 + plate_with_cutlery: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8 + play_or_pause_button: https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8 + pleading_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8 + plunger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8 + point_down: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8 + point_left: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8 + point_right: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8 + point_up: https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8 + point_up_2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8 + poland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8 + polar_bear: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8 + police_car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8 + police_officer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + policeman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8 + policewoman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8 + poodle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8 + poop: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8 + popcorn: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8 + portugal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8 + post_office: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8 + postal_horn: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8 + postbox: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8 + potable_water: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8 + potato: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8 + potted_plant: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8 + pouch: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8 + poultry_leg: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8 + pound: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8 + pout: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8 + pouting_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8 + pouting_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8 + pouting_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8 + pouting_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8 + pray: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8 + prayer_beads: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8 + pregnant_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8 + pretzel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8 + previous_track_button: https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8 + prince: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8 + princess: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8 + printer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8 + probing_cane: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8 + puerto_rico: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8 + punch: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 + purple_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8 + purple_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8 + purple_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8 + purse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8 + pushpin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8 + put_litter_in_its_place: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8 + qatar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8 + question: https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8 + rabbit: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8 + rabbit2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8 + raccoon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8 + racehorse: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8 + racing_car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8 + radio: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8 + radio_button: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8 + radioactive: https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8 + rage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8 + rage1: https://github.githubassets.com/images/icons/emoji/rage1.png?v8 + rage2: https://github.githubassets.com/images/icons/emoji/rage2.png?v8 + rage3: https://github.githubassets.com/images/icons/emoji/rage3.png?v8 + rage4: https://github.githubassets.com/images/icons/emoji/rage4.png?v8 + railway_car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8 + railway_track: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8 + rainbow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8 + rainbow_flag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8 + raised_back_of_hand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8 + raised_eyebrow: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8 + raised_hand: https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8 + raised_hand_with_fingers_splayed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8 + raised_hands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8 + raising_hand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8 + raising_hand_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8 + raising_hand_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8 + ram: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8 + ramen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8 + rat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8 + razor: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8 + receipt: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8 + record_button: https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8 + recycle: https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8 + red_car: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8 + red_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8 + red_envelope: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8 + red_haired_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8 + red_haired_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8 + red_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8 + registered: https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8 + relaxed: https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8 + relieved: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8 + reminder_ribbon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8 + repeat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8 + repeat_one: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8 + rescue_worker_helmet: https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8 + restroom: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8 + reunion: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8 + revolving_hearts: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8 + rewind: https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8 + rhinoceros: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8 + ribbon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8 + rice: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8 + rice_ball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8 + rice_cracker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8 + rice_scene: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8 + right_anger_bubble: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8 + ring: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8 + ringed_planet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8 + robot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8 + rock: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8 + rocket: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8 + rofl: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8 + roll_eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8 + roll_of_paper: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8 + roller_coaster: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8 + roller_skate: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8 + romania: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8 + rooster: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8 + rose: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8 + rosette: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8 + rotating_light: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8 + round_pushpin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8 + rowboat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8 + rowing_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8 + rowing_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8 + ru: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8 + rugby_football: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8 + runner: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8 + running: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8 + running_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8 + running_shirt_with_sash: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8 + running_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8 + rwanda: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8 + sa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8 + safety_pin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8 + safety_vest: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8 + sagittarius: https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8 + sailboat: https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8 + sake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8 + salt: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8 + samoa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8 + san_marino: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8 + sandal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8 + sandwich: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8 + santa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8 + sao_tome_principe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8 + sari: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8 + sassy_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8 + sassy_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8 + satellite: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8 + satisfied: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8 + saudi_arabia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8 + sauna_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8 + sauna_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8 + sauna_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8 + sauropod: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8 + saxophone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8 + scarf: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8 + school: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8 + school_satchel: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8 + scientist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8 + scissors: https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8 + scorpion: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8 + scorpius: https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8 + scotland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8 + scream: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8 + scream_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8 + screwdriver: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8 + scroll: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8 + seal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8 + seat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8 + secret: https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8 + see_no_evil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8 + seedling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8 + selfie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8 + senegal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8 + serbia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8 + service_dog: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8 + seven: >- + https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8 + sewing_needle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8 + seychelles: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8 + shallow_pan_of_food: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8 + shamrock: https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8 + shark: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8 + shaved_ice: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8 + sheep: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8 + shell: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8 + shield: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8 + shinto_shrine: https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8 + ship: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8 + shipit: https://github.githubassets.com/images/icons/emoji/shipit.png?v8 + shirt: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8 + shoe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8 + shopping: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8 + shopping_cart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8 + shorts: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8 + shower: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8 + shrimp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8 + shrug: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8 + shushing_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8 + sierra_leone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8 + signal_strength: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8 + singapore: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8 + singer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8 + sint_maarten: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8 + six: >- + https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8 + six_pointed_star: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8 + skateboard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8 + ski: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8 + skier: https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8 + skull: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8 + skull_and_crossbones: https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8 + skunk: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8 + sled: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8 + sleeping: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8 + sleeping_bed: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8 + sleepy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8 + slightly_frowning_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8 + slightly_smiling_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8 + slot_machine: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8 + sloth: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8 + slovakia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8 + slovenia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8 + small_airplane: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8 + small_blue_diamond: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8 + small_orange_diamond: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8 + small_red_triangle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8 + small_red_triangle_down: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8 + smile: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8 + smile_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8 + smiley: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8 + smiley_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8 + smiling_face_with_tear: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8 + smiling_face_with_three_hearts: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8 + smiling_imp: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8 + smirk: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8 + smirk_cat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8 + smoking: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8 + snail: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8 + snake: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8 + sneezing_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8 + snowboarder: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8 + snowflake: https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8 + snowman: https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8 + snowman_with_snow: https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8 + soap: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8 + sob: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8 + soccer: https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8 + socks: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8 + softball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8 + solomon_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8 + somalia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8 + soon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8 + sos: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8 + sound: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8 + south_africa: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8 + south_georgia_south_sandwich_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8 + south_sudan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8 + space_invader: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8 + spades: https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8 + spaghetti: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8 + sparkle: https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8 + sparkler: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8 + sparkles: https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8 + sparkling_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8 + speak_no_evil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8 + speaker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8 + speaking_head: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8 + speech_balloon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8 + speedboat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8 + spider: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8 + spider_web: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8 + spiral_calendar: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8 + spiral_notepad: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8 + sponge: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8 + spoon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8 + squid: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8 + sri_lanka: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8 + st_barthelemy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8 + st_helena: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8 + st_kitts_nevis: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8 + st_lucia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8 + st_martin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8 + st_pierre_miquelon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8 + st_vincent_grenadines: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8 + stadium: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8 + standing_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8 + standing_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8 + standing_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8 + star: https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8 + star2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8 + star_and_crescent: https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8 + star_of_david: https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8 + star_struck: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8 + stars: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8 + station: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8 + statue_of_liberty: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8 + steam_locomotive: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8 + stethoscope: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8 + stew: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8 + stop_button: https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8 + stop_sign: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8 + stopwatch: https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8 + straight_ruler: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8 + strawberry: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8 + stuck_out_tongue: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8 + stuck_out_tongue_closed_eyes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8 + stuck_out_tongue_winking_eye: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8 + student: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8 + studio_microphone: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8 + stuffed_flatbread: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8 + sudan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8 + sun_behind_large_cloud: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8 + sun_behind_rain_cloud: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8 + sun_behind_small_cloud: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8 + sun_with_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8 + sunflower: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8 + sunglasses: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8 + sunny: https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8 + sunrise: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8 + sunrise_over_mountains: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8 + superhero: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8 + superhero_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8 + superhero_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8 + supervillain: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8 + supervillain_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8 + supervillain_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8 + surfer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8 + surfing_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8 + surfing_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8 + suriname: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8 + sushi: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8 + suspect: https://github.githubassets.com/images/icons/emoji/suspect.png?v8 + suspension_railway: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8 + svalbard_jan_mayen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8 + swan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8 + swaziland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8 + sweat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8 + sweat_drops: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8 + sweat_smile: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8 + sweden: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8 + sweet_potato: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8 + swim_brief: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8 + swimmer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8 + swimming_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8 + swimming_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8 + switzerland: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8 + symbols: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8 + synagogue: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8 + syria: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8 + syringe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8 + t-rex: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8 + taco: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8 + tada: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8 + taiwan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8 + tajikistan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8 + takeout_box: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8 + tamale: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8 + tanabata_tree: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8 + tangerine: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 + tanzania: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8 + taurus: https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8 + taxi: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8 + tea: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8 + teacher: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8 + teapot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8 + technologist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8 + teddy_bear: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8 + telephone: https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8 + telephone_receiver: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8 + telescope: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8 + tennis: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8 + tent: https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8 + test_tube: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8 + thailand: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8 + thermometer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8 + thinking: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8 + thong_sandal: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8 + thought_balloon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8 + thread: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8 + three: >- + https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8 + thumbsdown: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8 + thumbsup: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8 + ticket: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8 + tickets: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8 + tiger: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8 + tiger2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8 + timer_clock: https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8 + timor_leste: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8 + tipping_hand_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8 + tipping_hand_person: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8 + tipping_hand_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8 + tired_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8 + tm: https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8 + togo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8 + toilet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8 + tokelau: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8 + tokyo_tower: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8 + tomato: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8 + tonga: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8 + tongue: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8 + toolbox: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8 + tooth: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8 + toothbrush: >- + https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8 + top: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8 + tophat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8 + tornado: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8 + tr: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8 + trackball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8 + tractor: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8 + traffic_light: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8 + train: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8 + train2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8 + tram: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8 + transgender_flag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8 + transgender_symbol: https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8 + triangular_flag_on_post: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8 + triangular_ruler: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8 + trident: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8 + trinidad_tobago: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8 + tristan_da_cunha: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8 + triumph: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8 + trolleybus: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8 + trollface: https://github.githubassets.com/images/icons/emoji/trollface.png?v8 + trophy: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8 + tropical_drink: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8 + tropical_fish: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8 + truck: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8 + trumpet: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8 + tshirt: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8 + tulip: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8 + tumbler_glass: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8 + tunisia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8 + turkey: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8 + turkmenistan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8 + turks_caicos_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8 + turtle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8 + tuvalu: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8 + tv: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8 + twisted_rightwards_arrows: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8 + two: >- + https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8 + two_hearts: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8 + two_men_holding_hands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8 + two_women_holding_hands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8 + u5272: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8 + u5408: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8 + u55b6: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8 + u6307: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8 + u6708: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8 + u6709: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8 + u6e80: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8 + u7121: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8 + u7533: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8 + u7981: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8 + u7a7a: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8 + uganda: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8 + uk: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8 + ukraine: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8 + umbrella: https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8 + unamused: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8 + underage: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8 + unicorn: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8 + united_arab_emirates: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8 + united_nations: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8 + unlock: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8 + up: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8 + upside_down_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8 + uruguay: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8 + us: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8 + us_outlying_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8 + us_virgin_islands: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8 + uzbekistan: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8 + v: https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8 + vampire: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8 + vampire_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8 + vampire_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8 + vanuatu: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8 + vatican_city: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8 + venezuela: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8 + vertical_traffic_light: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8 + vhs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8 + vibration_mode: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8 + video_camera: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8 + video_game: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8 + vietnam: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8 + violin: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8 + virgo: https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8 + volcano: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8 + volleyball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8 + vomiting_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8 + vs: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8 + vulcan_salute: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8 + waffle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8 + wales: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8 + walking: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8 + walking_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8 + walking_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8 + wallis_futuna: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8 + waning_crescent_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8 + waning_gibbous_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8 + warning: https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8 + wastebasket: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8 + watch: https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8 + water_buffalo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8 + water_polo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8 + watermelon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8 + wave: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8 + wavy_dash: https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8 + waxing_crescent_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8 + waxing_gibbous_moon: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8 + wc: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8 + weary: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8 + wedding: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8 + weight_lifting: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8 + weight_lifting_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8 + weight_lifting_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8 + western_sahara: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8 + whale: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8 + whale2: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8 + wheel_of_dharma: https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8 + wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8 + white_check_mark: https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8 + white_circle: https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8 + white_flag: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8 + white_flower: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8 + white_haired_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8 + white_haired_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8 + white_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8 + white_large_square: https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8 + white_medium_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8 + white_medium_square: https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8 + white_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8 + white_square_button: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8 + wilted_flower: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8 + wind_chime: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8 + wind_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8 + window: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8 + wine_glass: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8 + wink: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8 + wolf: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8 + woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8 + woman_artist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8 + woman_astronaut: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8 + woman_beard: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8 + woman_cartwheeling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8 + woman_cook: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8 + woman_dancing: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8 + woman_facepalming: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8 + woman_factory_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8 + woman_farmer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8 + woman_feeding_baby: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8 + woman_firefighter: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8 + woman_health_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8 + woman_in_manual_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8 + woman_in_motorized_wheelchair: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8 + woman_in_tuxedo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8 + woman_judge: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8 + woman_juggling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8 + woman_mechanic: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8 + woman_office_worker: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8 + woman_pilot: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8 + woman_playing_handball: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8 + woman_playing_water_polo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8 + woman_scientist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8 + woman_shrugging: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8 + woman_singer: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8 + woman_student: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8 + woman_teacher: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8 + woman_technologist: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8 + woman_with_headscarf: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8 + woman_with_probing_cane: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8 + woman_with_turban: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8 + woman_with_veil: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8 + womans_clothes: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8 + womans_hat: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8 + women_wrestling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8 + womens: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8 + wood: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8 + woozy_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8 + world_map: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8 + worm: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8 + worried: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8 + wrench: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8 + wrestling: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8 + writing_hand: https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8 + x: https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8 + yarn: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8 + yawning_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8 + yellow_circle: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8 + yellow_heart: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8 + yellow_square: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8 + yemen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8 + yen: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8 + yin_yang: https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8 + yo_yo: >- + https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8 + yum: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8 + zambia: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8 + zany_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8 + zap: https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8 + zebra: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8 + zero: >- + https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8 + zimbabwe: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8 + zipper_mouth_face: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8 + zombie: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8 + zombie_man: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 + zombie_woman: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 + zzz: >- + https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 + x-stackQL-resources: + emojis: + id: github.emojis.emojis + name: emojis + title: Emojis + methods: + get_emojis: + operation: + $ref: '#/paths/~1emojis/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_team_memberships.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_team_memberships.yaml new file mode 100644 index 0000000..7bd5ad1 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_team_memberships.yaml @@ -0,0 +1,548 @@ +openapi: 3.0.3 +info: + title: enterprise_team_memberships API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/teams/{enterprise_team}/memberships: + get: + summary: List members in an enterprise team + description: Lists all team members in an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/list + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + /enterprises/{enterprise}/teams/{enterprise_team}/memberships/add: + post: + summary: Bulk add team members + description: Add multiple team members to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-add + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to add to the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully added team members. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + /enterprises/{enterprise}/teams/{enterprise_team}/memberships/remove: + post: + summary: Bulk remove team members + description: Remove multiple team members from an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-remove + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to be removed from the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully removed team members. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + /enterprises/{enterprise}/teams/{enterprise_team}/memberships/{username}: + get: + summary: Get enterprise team membership + description: Returns whether the user is a member of the enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/get + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/username' + responses: + '200': + description: User is a member of the enterprise team. + content: + application/json: + schema: + $ref: '#/components/schemas/simple-user' + examples: + exampleKey1: + $ref: '#/components/examples/simple-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + put: + summary: Add team member + description: Add a team member to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/add + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/username' + responses: + '201': + description: Successfully added team member + content: + application/json: + schema: + $ref: '#/components/schemas/simple-user' + examples: + exampleKey1: + $ref: '#/components/examples/simple-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + delete: + summary: Remove team membership + description: >- + Remove membership of a specific user from a particular team in an + enterprise. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/remove + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members +components: + schemas: + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + enterprise-team: + name: enterprise-team + description: >- + The slug version of the enterprise team name. You can also substitute + this value with the enterprise team id. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + simple-user: + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + enterprise_team_memberships: + id: github.enterprise_team_memberships.enterprise_team_memberships + name: enterprise_team_memberships + title: Enterprise Team Memberships + methods: + list: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1memberships/get + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1memberships~1{username}/get + response: + mediaType: application/json + openAPIDocKey: '200' + add: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1memberships~1{username}/put + response: + mediaType: application/json + openAPIDocKey: '201' + remove: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1memberships~1{username}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_memberships/methods/get + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_memberships/methods/list + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_memberships/methods/remove + replace: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_memberships/methods/add + enterprise_team_membership_bulk_additions: + id: >- + github.enterprise_team_memberships.enterprise_team_membership_bulk_additions + name: enterprise_team_membership_bulk_additions + title: Enterprise Team Membership Bulk Additions + methods: + bulk_add: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1memberships~1add/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_membership_bulk_additions/methods/bulk_add + update: [] + delete: [] + replace: [] + enterprise_team_membership_bulk_removals: + id: >- + github.enterprise_team_memberships.enterprise_team_membership_bulk_removals + name: enterprise_team_membership_bulk_removals + title: Enterprise Team Membership Bulk Removals + methods: + bulk_remove: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1memberships~1remove/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_membership_bulk_removals/methods/bulk_remove + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_team_organizations.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_team_organizations.yaml new file mode 100644 index 0000000..f5eafdf --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_team_organizations.yaml @@ -0,0 +1,452 @@ +openapi: 3.0.3 +info: + title: enterprise_team_organizations API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/teams/{enterprise_team}/organizations: + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + /enterprises/{enterprise}/teams/{enterprise_team}/organizations/add: + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + /enterprises/{enterprise}/teams/{enterprise_team}/organizations/remove: + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + /enterprises/{enterprise}/teams/{enterprise_team}/organizations/{org}: + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/org' + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple' + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/org' + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/org' + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations +components: + schemas: + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + enterprise-team: + name: enterprise-team + description: >- + The slug version of the enterprise team name. You can also substitute + this value with the enterprise team id. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + x-stackQL-resources: + enterprise_team_organizations: + id: github.enterprise_team_organizations.enterprise_team_organizations + name: enterprise_team_organizations + title: Enterprise Team Organizations + methods: + get_assignments: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1organizations/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_assignment: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1organizations~1{org}/get + response: + mediaType: application/json + openAPIDocKey: '200' + add: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1organizations~1{org}/put + response: + mediaType: application/json + openAPIDocKey: '201' + delete: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1organizations~1{org}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_organizations/methods/get_assignment + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_organizations/methods/get_assignments + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_organizations/methods/delete + replace: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_organizations/methods/add + enterprise_team_organization_bulk_additions: + id: >- + github.enterprise_team_organizations.enterprise_team_organization_bulk_additions + name: enterprise_team_organization_bulk_additions + title: Enterprise Team Organization Bulk Additions + methods: + bulk_add: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1organizations~1add/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_organization_bulk_additions/methods/bulk_add + update: [] + delete: [] + replace: [] + enterprise_team_organization_bulk_removals: + id: >- + github.enterprise_team_organizations.enterprise_team_organization_bulk_removals + name: enterprise_team_organization_bulk_removals + title: Enterprise Team Organization Bulk Removals + methods: + bulk_remove: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1teams~1{enterprise_team}~1organizations~1remove/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/enterprise_team_organization_bulk_removals/methods/bulk_remove + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_teams.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_teams.yaml new file mode 100644 index 0000000..f354fea --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/enterprise_teams.yaml @@ -0,0 +1,505 @@ +openapi: 3.0.3 +info: + title: enterprise_teams API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/teams: + get: + summary: List enterprise teams + description: List all teams in the enterprise for the authenticated user + tags: + - enterprise-teams + operationId: enterprise-teams/list + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + post: + summary: Create an enterprise team + description: >- + To create an enterprise team, the authenticated user must be an owner of + the enterprise. + tags: + - enterprise-teams + operationId: enterprise-teams/create + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + nullable: true + type: string + description: A description of the team. + sync_to_organizations: + type: string + description: > + Retired: this field is no longer supported. + + Whether the enterprise team should be reflected in each + organization. + + This value cannot be set. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: > + Specifies which organizations in the enterprise should have + access to this team. Can be one of `disabled`, `selected`, + or `all`. + + `disabled`: The team is not assigned to any organizations. + This is the default when you create a new team. + + `selected`: The team is assigned to specific organizations. + You can then use the [add organization assignments + API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) + endpoint. + + `all`: The team is assigned to all current and future + organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + nullable: true + type: string + description: >- + The ID of the IdP group to assign team membership with. You + can get this value from the [REST API endpoints for + SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). + required: + - name + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-item' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + /enterprises/{enterprise}/teams/{team_slug}: + get: + summary: Get an enterprise team + description: >- + Gets a team using the team's slug. To create the slug, GitHub replaces + special characters in the name string, changes all words to lowercase, + and replaces spaces with a `-` separator and adds the "ent:" prefix. For + example, "My TEam NΓ€me" would become `ent:my-team-name`. + tags: + - enterprise-teams + operationId: enterprise-teams/get + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/team-slug' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-item' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + patch: + summary: Update an enterprise team + description: To edit a team, the authenticated user must be an enterprise owner. + tags: + - enterprise-teams + operationId: enterprise-teams/update + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/team-slug' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + nullable: true + type: string + description: A new name for the team. + description: + nullable: true + type: string + description: A new description for the team. + sync_to_organizations: + type: string + description: > + Retired: this field is no longer supported. + + Whether the enterprise team should be reflected in each + organization. + + This value cannot be changed. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: > + Specifies which organizations in the enterprise should have + access to this team. Can be one of `disabled`, `selected`, + or `all`. + + `disabled`: The team is not assigned to any organizations. + This is the default when you create a new team. + + `selected`: The team is assigned to specific organizations. + You can then use the [add organization assignments + API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + + `all`: The team is assigned to all current and future + organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + nullable: true + type: string + description: >- + The ID of the IdP group to assign team membership with. The + new IdP group will replace the existing one, or replace + existing direct members if the team isn't currently linked + to an IdP group. + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-item' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + delete: + summary: Delete an enterprise team + description: >- + To delete an enterprise team, the authenticated user must be an + enterprise owner. + + + If you are an enterprise owner, deleting an enterprise team will delete + all of its IdP mappings as well. + tags: + - enterprise-teams + operationId: enterprise-teams/delete + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams +components: + schemas: + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: Justice League + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - name + - html_url + - slug + - created_at + - updated_at + - group_id + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + examples: + enterprise-teams-items: + value: + - id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: >- + https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + enterprise-teams-item: + value: + id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: >- + https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + enterprise_teams: + id: github.enterprise_teams.enterprise_teams + name: enterprise_teams + title: Enterprise Teams + methods: + list: + operation: + $ref: '#/paths/~1enterprises~1{enterprise}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1enterprises~1{enterprise}~1teams/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: '#/paths/~1enterprises~1{enterprise}~1teams~1{team_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1enterprises~1{enterprise}~1teams~1{team_slug}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1enterprises~1{enterprise}~1teams~1{team_slug}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/enterprise_teams/methods/get' + - $ref: '#/components/x-stackQL-resources/enterprise_teams/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/enterprise_teams/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/enterprise_teams/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/enterprise_teams/methods/delete' + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/gists.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/gists.yaml new file mode 100644 index 0000000..2bc4d9a --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/gists.yaml @@ -0,0 +1,2586 @@ +openapi: 3.0.3 +info: + title: gists API + description: View, modify your gists. + version: 1.1.4 +paths: + /gists: + get: + summary: List gists for the authenticated user + description: >- + Lists the authenticated user's gists or if called anonymously, this + endpoint returns all public gists: + tags: + - gists + operationId: gists/list + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + post: + summary: Create a gist + description: >- + Allows you to add a new gist with one or more files. + + + > [!NOTE] + + > Don't name your files "gistfile" with a numerical suffix. This is the + format of the automatic naming scheme that Gist uses internally. + operationId: gists/create + tags: + - gists + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#create-a-gist + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: Description of the gist + example: Example Ruby script + type: string + files: + description: Names and content for the files that make up the gist + example: + hello.rb: + content: puts "Hello, World!" + type: object + additionalProperties: + type: object + properties: + content: + description: Content of the file + readOnly: false + type: string + required: + - content + public: + description: Flag indicating whether the gist is public + example: true + type: boolean + default: false + enum: + - 'true' + - 'false' + required: + - files + type: object + examples: + default: + summary: Creating a gist + value: + description: Example of a gist + public: false + files: + README.md: + content: Hello World + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist' + headers: + Location: + example: https://api.github.com/gists/aa5a315d61ae9438b18d + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/public: + get: + summary: List public gists + description: >- + List public gists sorted by most recently updated to least recently + updated. + + + Note: With + [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), + you can fetch up to 3000 gists. For example, you can fetch 100 pages + with 30 gists per page or 30 pages with 100 gists per page. + tags: + - gists + operationId: gists/list-public + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-public-gists + parameters: + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/starred: + get: + summary: List starred gists + description: 'List the authenticated user''s starred gists:' + tags: + - gists + operationId: gists/list-starred + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-starred-gists + parameters: + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}: + get: + summary: Get a gist + description: >- + Gets a specified gist. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#get-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden_gist' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + patch: + summary: Update a gist + description: >- + Allows you to update a gist's description and to update, delete, or + rename gist files. Files + + from the previous version of the gist that aren't explicitly changed + during an edit + + are unchanged. + + + At least one of `description` or `files` is required. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#update-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: The description of the gist. + example: Example Ruby script + type: string + files: + description: >- + The gist files to be updated, renamed, or deleted. Each + `key` must match the current filename + + (including extension) of the targeted gist file. For + example: `hello.py`. + + + To delete a file, set the whole file to null. For example: + `hello.py : null`. The file will also be + + deleted if the specified object does not contain at least + one of `content` or `filename`. + example: + hello.rb: + content: blah + filename: goodbye.rb + type: object + additionalProperties: + type: object + nullable: true + properties: + content: + description: The new content of the file. + type: string + filename: + description: The new filename for the file. + type: string + nullable: true + type: object + nullable: true + examples: + updateGist: + summary: Updating a gist + value: + description: An updated gist description + files: + README.md: + content: Hello World from GitHub + deleteFile: + summary: Deleting a gist file + value: + files: + hello.py: null + renameFile: + summary: Renaming a gist file + value: + files: + hello.py: + filename: goodbye.py + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + updateGist: + $ref: '#/components/examples/gist' + deleteFile: + $ref: '#/components/examples/delete-gist-file' + renameFile: + $ref: '#/components/examples/rename-gist-file' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + delete: + summary: Delete a gist + description: '' + tags: + - gists + operationId: gists/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#delete-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/comments: + get: + summary: List gist comments + description: >- + Lists the comments on a gist. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#list-gist-comments + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create a gist comment + description: >- + Creates a comment on a gist. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#create-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + body: + description: The comment text. + type: string + maxLength: 65535 + example: Body of the attachment + type: object + required: + - body + examples: + default: + summary: Creating a comment in a gist + value: + body: This is a comment to a gist + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment' + headers: + Location: + example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + /gists/{gist_id}/comments/{comment_id}: + get: + summary: Get a gist comment + description: >- + Gets a comment on a gist. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#get-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden_gist' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update a gist comment + description: >- + Updates a comment on a gist. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#update-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + body: + description: The comment text. + type: string + maxLength: 65535 + example: Body of the attachment + type: object + required: + - body + examples: + default: + summary: Updating a comment in a gist + value: + body: This is an update to a comment in a gist + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete a gist comment + description: '' + tags: + - gists + operationId: gists/delete-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + /gists/{gist_id}/commits: + get: + summary: List gist commits + description: '' + tags: + - gists + operationId: gists/list-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gist-commits + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gist-commit' + examples: + default: + $ref: '#/components/examples/gist-commit-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/forks: + get: + summary: List gist forks + description: '' + tags: + - gists + operationId: gists/list-forks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gist-forks + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist-fork-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + post: + summary: Fork a gist + description: '' + tags: + - gists + operationId: gists/fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#fork-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist' + headers: + Location: + example: https://api.github.com/gists/aa5a315d61ae9438b18d + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/star: + get: + summary: Check if a gist is starred + description: '' + tags: + - gists + operationId: gists/check-is-starred + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response if gist is starred + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if gist is not starred + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + put: + summary: Star a gist + description: >- + Note that you'll need to set `Content-Length` to zero when calling out + to this endpoint. For more information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - gists + operationId: gists/star + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#star-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + delete: + summary: Unstar a gist + description: '' + tags: + - gists + operationId: gists/unstar + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#unstar-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/{sha}: + get: + summary: Get a gist revision + description: >- + Gets a specified gist revision. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This + is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/get-revision + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#get-a-gist-revision + parameters: + - $ref: '#/components/parameters/gist-id' + - name: sha + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /users/{username}/gists: + get: + summary: List gists for a user + description: 'Lists public gists for the specified user:' + tags: + - gists + operationId: gists/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists +components: + schemas: + base-gist: + title: Base Gist + description: Base Gist + type: object + properties: + url: + type: string + format: uri + forks_url: + type: string + format: uri + commits_url: + type: string + format: uri + id: + type: string + node_id: + type: string + git_pull_url: + type: string + format: uri + git_push_url: + type: string + format: uri + html_url: + type: string + format: uri + files: + type: object + additionalProperties: + type: object + properties: + filename: + type: string + type: + type: string + language: + type: string + raw_url: + type: string + size: + type: integer + encoding: + type: string + description: >- + The encoding used for `content`. Currently, `"utf-8"` and + `"base64"` are supported. + default: utf-8 + public: + type: boolean + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + description: + type: string + nullable: true + comments: + type: integer + comments_enabled: + type: boolean + user: + $ref: '#/components/schemas/nullable-simple-user' + comments_url: + type: string + format: uri + owner: + $ref: '#/components/schemas/simple-user' + truncated: + type: boolean + forks: + type: array + items: {} + history: + type: array + items: {} + required: + - id + - node_id + - url + - forks_url + - commits_url + - git_pull_url + - git_push_url + - html_url + - comments_url + - public + - description + - comments + - user + - files + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + user: null + required: + - id + - node_id + - url + - forks_url + - commits_url + - git_pull_url + - git_push_url + - html_url + - comments_url + - public + - description + - comments + - files + - created_at + - updated_at + type: object + version: '2026-03-10' + - changeset: remove_forks_history_from_base_gist + patch: + - op: remove + path: /properties/forks + - op: remove + path: /properties/history + version: '2026-03-10' + gist-simple: + title: Gist Simple + description: Gist Simple + type: object + properties: + forks: + deprecated: true + nullable: true + type: array + items: + type: object + properties: + id: + type: string + url: + type: string + format: uri + user: + $ref: '#/components/schemas/public-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + history: + deprecated: true + nullable: true + type: array + items: + $ref: '#/components/schemas/gist-history' + fork_of: + nullable: true + title: Gist + description: Gist + type: object + properties: + url: + type: string + format: uri + forks_url: + type: string + format: uri + commits_url: + type: string + format: uri + id: + type: string + node_id: + type: string + git_pull_url: + type: string + format: uri + git_push_url: + type: string + format: uri + html_url: + type: string + format: uri + files: + type: object + additionalProperties: + type: object + properties: + filename: + type: string + type: + type: string + language: + type: string + raw_url: + type: string + size: + type: integer + public: + type: boolean + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + description: + type: string + nullable: true + comments: + type: integer + comments_enabled: + type: boolean + user: + $ref: '#/components/schemas/nullable-simple-user' + comments_url: + type: string + format: uri + owner: + $ref: '#/components/schemas/nullable-simple-user' + truncated: + type: boolean + forks: + type: array + items: {} + history: + type: array + items: {} + required: + - id + - node_id + - url + - forks_url + - commits_url + - git_pull_url + - git_push_url + - html_url + - comments_url + - public + - description + - comments + - user + - files + - created_at + - updated_at + url: + type: string + forks_url: + type: string + commits_url: + type: string + id: + type: string + node_id: + type: string + git_pull_url: + type: string + git_push_url: + type: string + html_url: + type: string + files: + type: object + additionalProperties: + nullable: true + type: object + properties: + filename: + type: string + type: + type: string + language: + type: string + raw_url: + type: string + size: + type: integer + truncated: + type: boolean + content: + type: string + encoding: + type: string + description: >- + The encoding used for `content`. Currently, `"utf-8"` and + `"base64"` are supported. + default: utf-8 + public: + type: boolean + created_at: + type: string + updated_at: + type: string + description: + type: string + nullable: true + comments: + type: integer + comments_enabled: + type: boolean + user: + type: string + nullable: true + comments_url: + type: string + owner: + $ref: '#/components/schemas/simple-user' + truncated: + type: boolean + x-github-breaking-changes: + - changeset: remove_forks_history_from_base_gist + patch: + - op: remove + path: /properties/forks + - op: remove + path: /properties/history + version: '2026-03-10' + gist-comment: + title: Gist Comment + description: A comment made to a gist. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDExOkdpc3RDb21tZW50MQ== + url: + type: string + format: uri + example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: + description: The comment text. + type: string + maxLength: 65535 + example: Body of the attachment + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-18T23:23:56Z' + updated_at: + type: string + format: date-time + example: '2011-04-18T23:23:56Z' + author_association: + $ref: '#/components/schemas/author-association' + required: + - url + - id + - node_id + - user + - body + - author_association + - created_at + - updated_at + gist-commit: + title: Gist Commit + description: Gist Commit + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: + type: string + example: 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + $ref: '#/components/schemas/nullable-simple-user' + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + committed_at: + type: string + format: date-time + example: '2010-04-14T02:15:15Z' + required: + - url + - user + - version + - committed_at + - change_status + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + public-user: + title: Public User + description: Public User + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + user_view_type: + type: string + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + events_url: + type: string + received_events_url: + type: string + format: uri + type: + type: string + site_admin: + type: boolean + name: + type: string + nullable: true + company: + type: string + nullable: true + blog: + type: string + nullable: true + location: + type: string + nullable: true + email: + type: string + format: email + nullable: true + notification_email: + type: string + format: email + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + nullable: true + twitter_username: + type: string + nullable: true + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + private_gists: + type: integer + example: 1 + total_private_repos: + type: integer + example: 2 + owned_private_repos: + type: integer + example: 2 + disk_usage: + type: integer + example: 1 + collaborators: + type: integer + example: 3 + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + additionalProperties: false + gist-history: + title: Gist History + description: Gist History + type: object + properties: + user: + $ref: '#/components/schemas/nullable-simple-user' + version: + type: string + committed_at: + type: string + format: date-time + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + url: + type: string + format: uri + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden_gist: + description: Forbidden Gist + content: + application/json: + schema: + type: object + properties: + block: + type: object + properties: + reason: + type: string + created_at: + type: string + html_url: + type: string + nullable: true + message: + type: string + documentation_url: + type: string + parameters: + since: + name: since + description: >- + Only show results that were last updated after the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + gist-id: + name: gist_id + description: The unique identifier of the gist. + in: path + required: true + schema: + type: string + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + base-gist-items: + value: + - url: https://api.github.com/gists/aa5a315d61ae9438b18d + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + files: + hello_world.rb: + filename: hello_world.rb + type: application/x-ruby + language: Ruby + raw_url: >- + https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb + size: 167 + public: true + created_at: '2010-04-14T02:15:15Z' + updated_at: '2011-06-20T11:34:15Z' + description: Hello World Examples + comments: 0 + user: null + comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + truncated: false + gist: + value: + url: https://api.github.com/gists/2decf6c462d9b4418f2 + forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks + commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits + id: 2decf6c462d9b4418f2 + node_id: G_kwDOBhHyLdZDliNDQxOGYy + git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git + git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git + html_url: https://gist.github.com/2decf6c462d9b4418f2 + files: + README.md: + filename: README.md + type: text/markdown + language: Markdown + raw_url: >- + https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md + size: 23 + truncated: false + content: Hello world from GitHub + encoding: utf-8 + public: true + created_at: '2022-09-20T12:11:58Z' + updated_at: '2022-09-21T10:28:06Z' + description: An updated gist description. + comments: 0 + comments_enabled: true + user: null + comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments + owner: + login: monalisa + id: 104456405 + node_id: U_kgDOBhHyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + forks: [] + history: + - user: + login: monalisa + id: 104456405 + node_id: U_kgyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + version: 468aac8caed5f0c3b859b8286968 + committed_at: '2022-09-21T10:28:06Z' + change_status: + total: 2 + additions: 1 + deletions: 1 + url: >- + https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 + truncated: false + delete-gist-file: + value: + url: https://api.github.com/gists/2decf6c462d9b4418f2 + forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks + commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits + id: 2decf6c462d9b4418f2 + node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy + git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git + git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git + html_url: https://gist.github.com/2decf6c462d9b4418f2 + files: null + public: true + created_at: '2022-09-20T12:11:58Z' + updated_at: '2022-09-21T10:28:06Z' + description: A gist description. + comments: 0 + user: null + comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments + owner: + login: monalisa + id: 104456405 + node_id: U_kgDOBhHyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + forks: [] + history: + - user: + login: monalisa + id: 104456405 + node_id: U_kgyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + version: 9cc352a89178a6d4 + committed_at: '2022-09-21T10:28:06Z' + change_status: + total: 1 + additions: 0 + deletions: 1 + url: >- + https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 + truncated: false + rename-gist-file: + value: + url: https://api.github.com/gists/2decf6c462d9b4418f2 + forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks + commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits + id: 2decf6c462d9b4418f2 + node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy + git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git + git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git + html_url: https://gist.github.com/2decf6c462d9b4418f2 + files: + goodbye.py: + filename: goodbye.py + type: application/x-python + language: Python + raw_url: >- + https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py + size: 4 + truncated: false + content: '# Hello world' + public: true + created_at: '2022-09-20T12:11:58Z' + updated_at: '2022-09-21T10:28:06Z' + description: A gist description. + comments: 0 + user: null + comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments + owner: + login: monalisa + id: 104456405 + node_id: U_kgDOBhHyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + forks: [] + history: + - user: + login: monalisa + id: 104456405 + node_id: U_kgyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + version: 468aac8caed5f0c3b859b8286968 + committed_at: '2022-09-21T10:28:06Z' + change_status: + total: 0 + additions: 0 + deletions: 0 + url: >- + https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 + truncated: false + gist-comment-items: + value: + - id: 1 + node_id: MDExOkdpc3RDb21tZW50MQ== + url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: Just commenting for the sake of commenting + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-18T23:23:56Z' + updated_at: '2011-04-18T23:23:56Z' + author_association: COLLABORATOR + gist-comment: + value: + id: 1 + node_id: MDExOkdpc3RDb21tZW50MQ== + url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: Just commenting for the sake of commenting + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-18T23:23:56Z' + updated_at: '2011-04-18T23:23:56Z' + author_association: COLLABORATOR + gist-commit-items: + value: + - url: >- + https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + change_status: + deletions: 0 + additions: 180 + total: 180 + committed_at: '2010-04-14T02:15:15Z' + gist-fork-items: + value: + - url: https://api.github.com/gists/aa5a315d61ae9438b18d + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + files: + hello_world.rb: + filename: hello_world.rb + type: application/x-ruby + language: Ruby + raw_url: >- + https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb + size: 167 + public: true + created_at: '2010-04-14T02:15:15Z' + updated_at: '2011-06-20T11:34:15Z' + description: Hello World Examples + comments: 1 + user: null + comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + base-gist: + value: + url: https://api.github.com/gists/aa5a315d61ae9438b18d + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + files: + hello_world.rb: + filename: hello_world.rb + type: application/x-ruby + language: Ruby + raw_url: >- + https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb + size: 167 + public: true + created_at: '2010-04-14T02:15:15Z' + updated_at: '2011-06-20T11:34:15Z' + description: Hello World Examples + comments: 0 + user: null + comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + truncated: false + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + gists: + id: github.gists.gists + name: gists + title: Gists + methods: + list: + operation: + $ref: '#/paths/~1gists/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1gists/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: '#/paths/~1gists~1{gist_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1gists~1{gist_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1gists~1{gist_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + fork: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1forks/post' + response: + mediaType: application/json + openAPIDocKey: '201' + check_is_starred: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1star/get' + response: + mediaType: application/json + openAPIDocKey: '204' + star: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1star/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unstar: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1star/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1gists/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gists/methods/get' + - $ref: '#/components/x-stackQL-resources/gists/methods/list_for_user' + - $ref: '#/components/x-stackQL-resources/gists/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/gists/methods/fork' + - $ref: '#/components/x-stackQL-resources/gists/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/gists/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/gists/methods/delete' + replace: [] + public_gists: + id: github.gists.public_gists + name: public_gists + title: Public Gists + methods: + list_public: + operation: + $ref: '#/paths/~1gists~1public/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/public_gists/methods/list_public' + insert: [] + update: [] + delete: [] + replace: [] + starred_gists: + id: github.gists.starred_gists + name: starred_gists + title: Starred Gists + methods: + list_starred: + operation: + $ref: '#/paths/~1gists~1starred/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/starred_gists/methods/list_starred + insert: [] + update: [] + delete: [] + replace: [] + comments: + id: github.gists.comments + name: comments + title: Comments + methods: + list_comments: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1gists~1{gist_id}~1comments/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_comment: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1comments~1{comment_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1gists~1{gist_id}~1comments~1{comment_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_comment: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1comments~1{comment_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/get_comment' + - $ref: '#/components/x-stackQL-resources/comments/methods/list_comments' + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/create_comment' + update: + - $ref: '#/components/x-stackQL-resources/comments/methods/update_comment' + delete: + - $ref: '#/components/x-stackQL-resources/comments/methods/delete_comment' + replace: [] + commits: + id: github.gists.commits + name: commits + title: Commits + methods: + list_commits: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1commits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commits/methods/list_commits' + insert: [] + update: [] + delete: [] + replace: [] + forks: + id: github.gists.forks + name: forks + title: Forks + methods: + list_forks: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1forks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/forks/methods/list_forks' + insert: [] + update: [] + delete: [] + replace: [] + revisions: + id: github.gists.revisions + name: revisions + title: Revisions + methods: + get_revision: + operation: + $ref: '#/paths/~1gists~1{gist_id}~1{sha}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/revisions/methods/get_revision' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/git.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/git.yaml new file mode 100644 index 0000000..56d1063 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/git.yaml @@ -0,0 +1,2187 @@ +openapi: 3.0.3 +info: + title: git API + description: Raw Git functionality. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/git/blobs: + post: + summary: Create a blob + description: '' + tags: + - git + operationId: git/create-blob + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/blobs#create-a-blob + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The new blob's content. + encoding: + type: string + description: >- + The encoding used for `content`. Currently, `"utf-8"` and + `"base64"` are supported. + default: utf-8 + required: + - content + examples: + default: + value: + content: Content of the blob + encoding: utf-8 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/short-blob' + examples: + default: + $ref: '#/components/examples/short-blob' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + description: Validation failed + content: + application/json: + schema: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: >- + #/components/schemas/secret-scanning-push-protection-bypass-placeholder-id + token_type: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: blobs + x-stackQL-resource: blobs + /repos/{owner}/{repo}/git/blobs/{file_sha}: + get: + summary: Get a blob + description: >- + The `content` in the response will always be Base64 encoded. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw blob data. + + - **`application/vnd.github+json`**: Returns a JSON representation of + the blob with `content` as a base64 encoded string. This is the default + if no media type is specified. + + + **Note** This endpoint supports blobs up to 100 megabytes in size. + tags: + - git + operationId: git/get-blob + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/blobs#get-a-blob + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: file_sha + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/blob' + examples: + default: + $ref: '#/components/examples/blob' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: blobs + x-stackQL-resource: blobs + /repos/{owner}/{repo}/git/commits: + post: + summary: Create a commit + description: >- + Creates a new Git [commit + object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + + + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The following fields are + included in the `verification` object: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in the table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - git + operationId: git/create-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/commits#create-a-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The commit message + tree: + type: string + description: The SHA of the tree object this commit points to + parents: + type: array + description: >- + The full SHAs of the commits that were the parents of this + commit. If omitted or empty, the commit will be written as a + root commit. For a single parent, an array of one SHA should + be provided; for a merge commit, an array of more than one + should be provided. + items: + type: string + author: + type: object + description: >- + Information about the author of the commit. By default, the + `author` will be the authenticated user and the current + date. See the `author` and `committer` object below for + details. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + date: + type: string + format: date-time + description: >- + Indicates when this commit was authored (or committed). + This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + required: + - name + - email + committer: + type: object + description: >- + Information about the person who is making the commit. By + default, `committer` will use the information set in + `author`. See the `author` and `committer` object below for + details. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + date: + type: string + format: date-time + description: >- + Indicates when this commit was authored (or committed). + This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + signature: + type: string + description: >- + The [PGP + signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) + of the commit. GitHub adds the signature to the `gpgsig` + header of the created commit. For a commit signature to be + verifiable by Git or GitHub, it must be an ASCII-armored + detached PGP signature over the string commit as it would be + written to the object database. To pass a `signature` + parameter, you need to first manually create a valid PGP + signature, which can be complicated. You may find it easier + to [use the command + line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) + to create signed commits. + required: + - message + - tree + examples: + default: + value: + message: my commit message + author: + name: Mona Octocat + email: octocat@github.com + date: '2008-07-09T16:13:30+12:00' + parents: + - 7d1b31e74ee336d15cbd21741bc88a537ed063a0 + tree: 827efc6d56897b048c772eb4087f854f46256132 + signature: > + -----BEGIN PGP SIGNATURE----- + + + iQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv + + 7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI + + DkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n + + 2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA + + OQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k + + nrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU + + +NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB + + jHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ + + 3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+ + + UpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr + + X11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp + + eSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc= + + =5Io4 + + -----END PGP SIGNATURE----- + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-commit' + examples: + default: + $ref: '#/components/examples/git-commit' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/git/commits/{commit_sha}: + get: + summary: Get a commit object + description: >- + Gets a Git [commit + object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + + + To get the contents of a commit, see "[Get a + commit](/rest/commits/commits#get-a-commit)." + + + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The following fields are + included in the `verification` object: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in the table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - git + operationId: git/get-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/commits#get-a-commit-object + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-commit' + examples: + default: + $ref: '#/components/examples/git-commit-2' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/git/matching-refs/{ref}: + get: + summary: List matching references + description: >- + Returns an array of references from your Git database that match the + supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` + doesn't exist in the repository, but existing refs start with `:ref`, + they will be returned as an array. + + + When you use this endpoint without providing a `:ref`, it will return an + array of all the references from your Git database, including notes and + stashes if they exist on the server. Anything in the namespace is + returned, not just `heads` and `tags`. + + + > [!NOTE] + + > You need to explicitly [request a pull + request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to + trigger a test merge commit, which checks the mergeability of pull + requests. For more information, see "[Checking mergeability of pull + requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + + + If you request matching references for a branch named `feature` but the + branch `feature` doesn't exist, the response can still include other + matching head refs that start with the word `feature`, such as + `featureA` and `featureB`. + tags: + - git + operationId: git/list-matching-refs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#list-matching-references + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref-items' + headers: + Link: + $ref: '#/components/headers/link' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/ref/{ref}: + get: + summary: Get a reference + description: >- + Returns a single reference from your Git database. The `:ref` in the URL + must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is + returned. + + + > [!NOTE] + + > You need to explicitly [request a pull + request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to + trigger a test merge commit, which checks the mergeability of pull + requests. For more information, see "[Checking mergeability of pull + requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + tags: + - git + operationId: git/get-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#get-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/refs: + post: + summary: Create a reference + description: >- + Creates a reference for your repository. You are unable to create new + references for empty repositories, even if the commit SHA-1 hash used + exists. Empty repositories are repositories without branches. + tags: + - git + operationId: git/create-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#create-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ref: + type: string + description: >- + The name of the fully qualified reference (ie: + `refs/heads/master`). If it doesn't start with 'refs' and + have at least two slashes, it will be rejected. + sha: + type: string + description: The SHA1 value for this reference. + required: + - ref + - sha + examples: + default: + value: + ref: refs/heads/featureA + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA + schema: + type: string + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/refs/{ref}: + patch: + summary: Update a reference + description: >- + Updates the provided reference to point to a new SHA. For more + information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + tags: + - git + operationId: git/update-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#update-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sha: + type: string + description: The SHA1 value to set this reference to + force: + type: boolean + description: >- + Indicates whether to force the update or to make sure the + update is a fast-forward update. Leaving this out or setting + it to `false` will make sure you're not overwriting work. + default: false + required: + - sha + examples: + default: + value: + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + force: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + delete: + summary: Delete a reference + description: Deletes the provided reference. + tags: + - git + operationId: git/delete-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#delete-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + responses: + '204': + description: Response + '409': + $ref: '#/components/responses/conflict' + '422': + description: >- + Validation failed, an attempt was made to delete the default branch, + or the endpoint has been spammed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/tags: + post: + summary: Create a tag object + description: >- + Note that creating a tag object does not create the reference that makes + a tag in Git. If you want to create an annotated tag in Git, you have to + do this call to create the tag object, and then + [create](https://docs.github.com/rest/git/refs#create-a-reference) the + `refs/tags/[tag]` reference. If you want to create a lightweight tag, + you only have to + [create](https://docs.github.com/rest/git/refs#create-a-reference) the + tag reference - this call would be unnecessary. + + + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The following fields are + included in the `verification` object: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - git + operationId: git/create-tag + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/tags#create-a-tag-object + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tag: + type: string + description: >- + The tag's name. This is typically a version (e.g., + "v0.0.1"). + message: + type: string + description: The tag message. + object: + type: string + description: The SHA of the git object this is tagging. + type: + type: string + description: >- + The type of the object we're tagging. Normally this is a + `commit` but it can also be a `tree` or a `blob`. + enum: + - commit + - tree + - blob + tagger: + type: object + description: >- + An object with information about the individual creating the + tag. + properties: + name: + type: string + description: The name of the author of the tag + email: + type: string + description: The email of the author of the tag + date: + type: string + format: date-time + description: >- + When this object was tagged. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + required: + - name + - email + required: + - tag + - message + - object + - type + examples: + default: + value: + tag: v0.0.1 + message: initial version + object: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c + type: commit + tagger: + name: Monalisa Octocat + email: octocat@github.com + date: '2011-06-17T14:53:35-07:00' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tag' + examples: + default: + $ref: '#/components/examples/git-tag' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + schema: + type: string + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: tags + x-stackQL-resource: tags + /repos/{owner}/{repo}/git/tags/{tag_sha}: + get: + summary: Get a tag + description: >- + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The following fields are + included in the `verification` object: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - git + operationId: git/get-tag + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/tags#get-a-tag + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: tag_sha + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tag' + examples: + default: + $ref: '#/components/examples/git-tag' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: tags + x-stackQL-resource: tags + /repos/{owner}/{repo}/git/trees: + post: + summary: Create a tree + description: >- + The tree creation API accepts nested entries. If you specify both a tree + and a nested path modifying that tree, this endpoint will overwrite the + contents of the tree with the new path contents, and create a new tree + structure. + + + If you use this endpoint to add, delete, or modify the file contents in + a tree, you will need to commit the tree and then update a branch to + point to the commit. For more information see "[Create a + commit](https://docs.github.com/rest/git/commits#create-a-commit)" and + "[Update a + reference](https://docs.github.com/rest/git/refs#update-a-reference)." + + + Returns an error if you try to delete a file that does not exist. + tags: + - git + operationId: git/create-tree + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/trees#create-a-tree + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tree: + type: array + description: >- + Objects (of `path`, `mode`, `type`, and `sha`) specifying a + tree structure. + items: + type: object + properties: + path: + type: string + description: The file referenced in the tree. + mode: + type: string + description: >- + The file mode; one of `100644` for file (blob), + `100755` for executable (blob), `040000` for + subdirectory (tree), `160000` for submodule (commit), + or `120000` for a blob that specifies the path of a + symlink. + enum: + - '100644' + - '100755' + - '040000' + - '160000' + - '120000' + type: + type: string + description: Either `blob`, `tree`, or `commit`. + enum: + - blob + - tree + - commit + sha: + type: string + description: >- + The SHA1 checksum ID of the object in the tree. Also + called `tree.sha`. If the value is `null` then the + file will be deleted. + + **Note:** Use either `tree.sha` or `content` to + specify the contents of the entry. Using both + `tree.sha` and `content` will return an error. + nullable: true + content: + type: string + description: >- + The content you want this file to have. GitHub will + write this blob out and use that SHA for this entry. + Use either this, or `tree.sha`. + + **Note:** Use either `tree.sha` or `content` to + specify the contents of the entry. Using both + `tree.sha` and `content` will return an error. + base_tree: + type: string + description: >- + The SHA1 of an existing Git tree object which will be used + as the base for the new tree. If provided, a new Git tree + object will be created from entries in the Git tree object + pointed to by `base_tree` and entries defined in the `tree` + parameter. Entries defined in the `tree` parameter will + overwrite items from `base_tree` with the same `path`. If + you're creating new changes on a branch, then normally you'd + set `base_tree` to the SHA1 of the Git tree object of the + current latest commit on the branch you're working on. + + If not provided, GitHub will create a new Git tree object + from only the entries defined in the `tree` parameter. If + you create a new commit pointing to such a tree, then all + files which were a part of the parent commit's tree and were + not defined in the `tree` parameter will be listed as + deleted by the new commit. + required: + - tree + examples: + default: + value: + base_tree: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 + tree: + - path: file.rb + mode: '100644' + type: blob + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tree' + examples: + default: + $ref: '#/components/examples/git-tree' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: trees + x-stackQL-resource: trees + /repos/{owner}/{repo}/git/trees/{tree_sha}: + get: + summary: Get a tree + description: >- + Returns a single tree using the SHA1 value or ref name for that tree. + + + If `truncated` is `true` in the response then the number of items in the + `tree` array exceeded our maximum limit. If you need to fetch more + items, use the non-recursive method of fetching trees, and fetch one + sub-tree at a time. + + + > [!NOTE] + + > The limit for the `tree` array is 100,000 entries with a maximum size + of 7 MB when using the `recursive` parameter. + tags: + - git + operationId: git/get-tree + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/trees#get-a-tree + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: tree_sha + description: The SHA1 value or ref (branch or tag) name of the tree. + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: recursive + description: >- + Setting this parameter to any value returns the objects or subtrees + referenced by the tree specified in `:tree_sha`. For example, + setting `recursive` to any of the following will enable returning + objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this + parameter to prevent recursively returning objects or subtrees. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tree' + examples: + default-response: + $ref: '#/components/examples/git-tree-default-response' + response-recursively-retrieving-a-tree: + $ref: >- + #/components/examples/git-tree-response-recursively-retrieving-a-tree + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: trees + x-stackQL-resource: trees +components: + schemas: + short-blob: + title: Short Blob + description: Short Blob + type: object + properties: + url: + type: string + sha: + type: string + required: + - url + - sha + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + repository-rule-violation-error: + description: Repository rule violation was detected + type: object + properties: + message: + type: string + documentation_url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: >- + #/components/schemas/secret-scanning-push-protection-bypass-placeholder-id + token_type: + type: string + blob: + title: Blob + description: Blob + type: object + properties: + content: + type: string + encoding: + type: string + url: + type: string + format: uri + sha: + type: string + size: + type: integer + nullable: true + node_id: + type: string + highlighted_content: + type: string + required: + - sha + - url + - node_id + - size + - content + - encoding + git-commit: + title: Git Commit + description: Low-level Git commit operations within a repository + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + node_id: + type: string + url: + type: string + format: uri + author: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + tree: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - sha + - url + - html_url + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - signature + - payload + - verified_at + html_url: + type: string + format: uri + required: + - sha + - node_id + - url + - html_url + - author + - committer + - tree + - message + - parents + - verification + git-ref: + title: Git Reference + description: Git references within a repository + type: object + properties: + ref: + type: string + node_id: + type: string + url: + type: string + format: uri + object: + type: object + properties: + type: + type: string + sha: + description: SHA for the reference + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + minLength: 40 + maxLength: 40 + url: + type: string + format: uri + required: + - type + - sha + - url + required: + - ref + - node_id + - url + - object + git-tag: + title: Git Tag + description: Metadata for a Git tag + type: object + properties: + node_id: + type: string + example: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: + description: Name of the tag + example: v0.0.1 + type: string + sha: + type: string + example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: + description: URL for the tag + example: >- + https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + type: string + format: uri + message: + description: Message describing the purpose of the tag + example: Initial public release + type: string + tagger: + type: object + properties: + date: + type: string + email: + type: string + name: + type: string + required: + - date + - email + - name + object: + type: object + properties: + sha: + type: string + type: + type: string + url: + type: string + format: uri + required: + - sha + - type + - url + verification: + $ref: '#/components/schemas/verification' + required: + - sha + - url + - node_id + - tagger + - object + - tag + - message + git-tree: + title: Git Tree + description: The hierarchy between files in a Git repository. + type: object + properties: + sha: + type: string + url: + type: string + format: uri + truncated: + type: boolean + tree: + description: Objects specifying a tree structure + type: array + items: + type: object + required: + - path + - mode + - type + - sha + properties: + path: + type: string + example: test/file.rb + mode: + type: string + example: '040000' + type: + type: string + example: tree + sha: + type: string + example: 23f6827669e43831def8a7ad935069c8bd418261 + size: + type: integer + example: 12 + url: + type: string + example: >- + https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 + example: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + required: + - sha + - tree + - truncated + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + secret-scanning-push-protection-bypass-placeholder-id: + description: >- + The ID of the push protection bypass placeholder. This value is returned + on any push protected routes. + type: string + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + commit-sha: + name: commit_sha + description: The SHA of the commit. + in: path + required: true + schema: + type: string + x-multi-segment: true + git-ref-only: + name: ref + description: >- + The Git reference. For more information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + in: path + required: true + example: heads/feature-a + schema: + type: string + x-multi-segment: true + examples: + short-blob: + value: + url: >- + https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + sha: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + blob: + value: + content: Q29udGVudCBvZiB0aGUgYmxvYg== + encoding: base64 + url: >- + https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + sha: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + size: 19 + node_id: Q29udGVudCBvZiB0aGUgYmxvYg== + git-commit: + value: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132 + sha: 827efc6d56897b048c772eb4087f854f46256132 + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0 + sha: 7d1b31e74ee336d15cbd21741bc88a537ed063a0 + html_url: >- + https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + html_url: >- + https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + git-commit-2: + value: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: >- + https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: added readme, because im a good github citizen + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + html_url: >- + https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + git-ref-items: + value: + - ref: refs/heads/feature-a + node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE= + url: >- + https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a + object: + type: commit + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd + - ref: refs/heads/feature-b + node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI= + url: >- + https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b + object: + type: commit + sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac + git-ref: + value: + ref: refs/heads/featureA + node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== + url: >- + https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA + object: + type: commit + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd + git-tag: + value: + node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: v0.0.1 + sha: 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: >- + https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + message: initial version + tagger: + name: Monalisa Octocat + email: octocat@github.com + date: '2014-11-07T22:01:45Z' + object: + type: commit + sha: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + git-tree: + value: + sha: cd8274d15fa3ae2ab983129fb037999f264ba9a7 + url: >- + https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 + tree: + - path: file.rb + mode: '100644' + type: blob + size: 132 + sha: 7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + truncated: true + git-tree-default-response: + summary: Default response + value: + sha: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 + url: >- + https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312 + tree: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + - path: subdir + mode: '040000' + type: tree + sha: f484d249c660418515fb01c2b9662073663c242e + url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e + - path: exec_file + mode: '100755' + type: blob + size: 75 + sha: 45b983be36b73c0788dc9cbcb76cbb80fc7bb057 + url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057 + truncated: false + git-tree-response-recursively-retrieving-a-tree: + summary: Response recursively retrieving a tree + value: + sha: fc6274d15fa3ae2ab983129fb037999f264ba9a7 + url: >- + https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7 + tree: + - path: subdir/file.txt + mode: '100644' + type: blob + size: 132 + sha: 7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + url: >- + https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + truncated: false + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + blobs: + id: github.git.blobs + name: blobs + title: Blobs + methods: + create_blob: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1blobs/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_blob: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1blobs~1{file_sha}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/blobs/methods/get_blob' + insert: + - $ref: '#/components/x-stackQL-resources/blobs/methods/create_blob' + update: [] + delete: [] + replace: [] + commits: + id: github.git.commits + name: commits + title: Commits + methods: + create_commit: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1commits/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_commit: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1commits~1{commit_sha}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commits/methods/get_commit' + insert: + - $ref: '#/components/x-stackQL-resources/commits/methods/create_commit' + update: [] + delete: [] + replace: [] + refs: + id: github.git.refs + name: refs + title: Refs + methods: + list_matching_refs: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1matching-refs~1{ref}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_ref: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1refs/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update_ref: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1refs~1{ref}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ref: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1refs~1{ref}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/refs/methods/list_matching_refs' + insert: + - $ref: '#/components/x-stackQL-resources/refs/methods/create_ref' + update: + - $ref: '#/components/x-stackQL-resources/refs/methods/update_ref' + delete: + - $ref: '#/components/x-stackQL-resources/refs/methods/delete_ref' + replace: [] + ref: + id: github.git.ref + name: ref + title: Ref + methods: + get_ref: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1ref~1{ref}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/ref/methods/get_ref' + insert: [] + update: [] + delete: [] + replace: [] + tags: + id: github.git.tags + name: tags + title: Tags + methods: + create_tag: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1tags/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_tag: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1tags~1{tag_sha}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/get_tag' + insert: + - $ref: '#/components/x-stackQL-resources/tags/methods/create_tag' + update: [] + delete: [] + replace: [] + trees: + id: github.git.trees + name: trees + title: Trees + methods: + create_tree: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1trees/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_tree: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1git~1trees~1{tree_sha}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/trees/methods/get_tree' + insert: + - $ref: '#/components/x-stackQL-resources/trees/methods/create_tree' + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/gitignore.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/gitignore.yaml new file mode 100644 index 0000000..ca21908 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/gitignore.yaml @@ -0,0 +1,179 @@ +openapi: 3.0.3 +info: + title: gitignore API + description: View gitignore templates + version: 1.1.4 +paths: + /gitignore/templates: + get: + summary: Get all gitignore templates + description: >- + List all templates available to pass as an option when [creating a + repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). + operationId: gitignore/get-all-templates + tags: + - gitignore + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - Actionscript + - Android + - AppceleratorTitanium + - Autotools + - Bancha + - C + - C++ + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: gitignore + subcategory: gitignore + x-stackQL-resource: gitignore + /gitignore/templates/{name}: + get: + summary: Get a gitignore template + description: >- + Get the content of a gitignore template. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw .gitignore + contents. + operationId: gitignore/get-template + tags: + - gitignore + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template + parameters: + - name: name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gitignore-template' + examples: + default: + $ref: '#/components/examples/gitignore-template' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: gitignore + subcategory: gitignore + x-stackQL-resource: gitignore +components: + schemas: + gitignore-template: + title: Gitignore Template + description: Gitignore Template + type: object + properties: + name: + type: string + example: C + source: + type: string + example: | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + required: + - name + - source + responses: + not_modified: + description: Not modified + examples: + gitignore-template: + value: + name: C + source: | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + x-stackQL-resources: + gitignore: + id: github.gitignore.gitignore + name: gitignore + title: Gitignore + methods: + get_all_templates: + operation: + $ref: '#/paths/~1gitignore~1templates/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_template: + operation: + $ref: '#/paths/~1gitignore~1templates~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/gitignore/methods/get_template' + - $ref: >- + #/components/x-stackQL-resources/gitignore/methods/get_all_templates + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/hosted_compute.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/hosted_compute.yaml new file mode 100644 index 0000000..bb1b35d --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/hosted_compute.yaml @@ -0,0 +1,588 @@ +openapi: 3.0.3 +info: + title: hosted_compute API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/settings/network-configurations: + get: + summary: List hosted compute network configurations for an organization + description: >- + Lists all hosted compute network configurations configured in an + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/list-network-configurations-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - network_configurations + properties: + total_count: + type: integer + network_configurations: + type: array + items: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configurations-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + post: + summary: Create a hosted compute network configuration for an organization + description: >- + Creates a hosted compute network configuration for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/create-network-configuration-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: >- + Name of the network configuration. Must be between 1 and 100 + characters and may only contain upper and lowercase letters + a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: >- + The hosted compute service to use for the network + configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 1 + maxItems: 1 + description: >- + A list of identifiers of the network settings resources to + use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: >- + A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one + resource identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is enabled. + required: + - name + - network_settings_ids + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configuration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + /orgs/{org}/settings/network-configurations/{network_configuration_id}: + get: + summary: Get a hosted compute network configuration for an organization + description: >- + Gets a hosted compute network configuration configured in an + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-configuration-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-configuration-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configuration' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + patch: + summary: Update a hosted compute network configuration for an organization + description: >- + Updates a hosted compute network configuration for an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/update-network-configuration-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: >- + Name of the network configuration. Must be between 1 and 100 + characters and may only contain upper and lowercase letters + a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: >- + The hosted compute service to use for the network + configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: >- + A list of identifiers of the network settings resources to + use for the network configuration. Exactly one resource + identifier must be specified in the list. + items: + type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: >- + A list of identifiers of the failover network settings + resources to use for the network configuration. Exactly one + resource identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is enabled. + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configuration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + delete: + summary: Delete a hosted compute network configuration from an organization + description: >- + Deletes a hosted compute network configuration from an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/delete-network-configuration-from-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-configuration-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + /orgs/{org}/settings/network-settings/{network_settings_id}: + get: + summary: Get a hosted compute network settings resource for an organization + description: >- + Gets a hosted compute network settings resource configured for an + organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-settings-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-settings-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-settings' + examples: + default: + $ref: '#/components/examples/network-settings' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations +components: + schemas: + network-configuration: + title: Hosted compute network configuration + description: A hosted compute network configuration. + type: object + properties: + id: + description: The unique identifier of the network configuration. + type: string + example: 123ABC456DEF789 + name: + description: The name of the network configuration. + type: string + example: my-network-configuration + compute_service: + description: The hosted compute service the network configuration supports. + type: string + enum: + - none + - actions + - codespaces + network_settings_ids: + description: The unique identifier of each network settings in the configuration. + type: array + items: + type: string + example: 123ABC456DEF789 + failover_network_settings_ids: + description: >- + The unique identifier of each failover network settings in the + configuration. + type: array + items: + type: string + example: 123ABC456DEF789 + failover_network_enabled: + description: Indicates whether the failover network resource is enabled. + type: boolean + example: true + created_on: + description: >- + The time at which the network configuration was created, in ISO 8601 + format. + type: string + format: date-time + example: '2024-04-26T11:31:07Z' + nullable: true + required: + - id + - name + - created_on + network-settings: + title: Hosted compute network settings resource + description: A hosted compute network settings resource. + type: object + properties: + id: + description: The unique identifier of the network settings resource. + type: string + example: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: + description: >- + The identifier of the network configuration that is using this + settings resource. + type: string + example: 934E208B3EE0BD60CF5F752C426BFB53562 + name: + description: The name of the network settings resource. + type: string + example: my-network-settings + subnet_id: + description: The subnet this network settings resource is configured for. + type: string + example: >- + /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + region: + description: >- + The location of the subnet this network settings resource is + configured for. + type: string + example: eastus + required: + - id + - name + - subnet_id + - region + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + network-configuration-id: + name: network_configuration_id + description: Unique identifier of the hosted compute network configuration. + in: path + required: true + schema: + type: string + network-settings-id: + name: network_settings_id + description: Unique identifier of the hosted compute network settings. + in: path + required: true + schema: + type: string + examples: + network-configurations-paginated: + value: + total_count: 2 + network_configurations: + - id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + - id: 456789ABDCEF123 + name: My other configuration + compute_service: none + network_settings_ids: + - 56789ABDCEF1234 + - 6789ABDCEF12345 + created_on: '2023-04-26T15:23:37Z' + network-configuration: + value: + id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + network-settings: + value: + id: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 + name: my_network_settings + subnet_id: >- + /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + region: eastus + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + org_network_configurations: + id: github.hosted_compute.org_network_configurations + name: org_network_configurations + title: Org Network Configurations + methods: + list_network_configurations_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1settings~1network-configurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_network_configuration_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1settings~1network-configurations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_network_configuration_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1network-configurations~1{network_configuration_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_network_configuration_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1network-configurations~1{network_configuration_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_network_configuration_from_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1network-configurations~1{network_configuration_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_network_configurations/methods/get_network_configuration_for_org + - $ref: >- + #/components/x-stackQL-resources/org_network_configurations/methods/list_network_configurations_for_org + insert: + - $ref: >- + #/components/x-stackQL-resources/org_network_configurations/methods/create_network_configuration_for_org + update: + - $ref: >- + #/components/x-stackQL-resources/org_network_configurations/methods/update_network_configuration_for_org + delete: + - $ref: >- + #/components/x-stackQL-resources/org_network_configurations/methods/delete_network_configuration_from_org + replace: [] + org_network_settings: + id: github.hosted_compute.org_network_settings + name: org_network_settings + title: Org Network Settings + methods: + get_network_settings_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1network-settings~1{network_settings_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_network_settings/methods/get_network_settings_for_org + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/interactions.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/interactions.yaml new file mode 100644 index 0000000..89336f6 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/interactions.yaml @@ -0,0 +1,617 @@ +openapi: 3.0.3 +info: + title: interactions API + description: Owner or admin management of users interactions. + version: 1.1.4 +paths: + /orgs/{org}/interaction-limits: + get: + summary: Get interaction restrictions for an organization + description: >- + Shows which type of GitHub user can interact with this organization and + when the restriction expires. If there is no restrictions, you will see + an empty response. + tags: + - interactions + operationId: interactions/get-restrictions-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + additionalProperties: false + examples: + default: + $ref: '#/components/examples/interaction-limit-response' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs + x-stackQL-resource: orgs + put: + summary: Set interaction restrictions for an organization + description: >- + Temporarily restricts interactions to a certain type of GitHub user in + any public repository in the given organization. You must be an + organization owner to set these restrictions. Setting the interaction + limit at the organization level will overwrite any interaction limits + that are set for individual repositories owned by the organization. + tags: + - interactions + operationId: interactions/set-restrictions-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit' + examples: + default: + value: + limit: collaborators_only + expiry: one_month + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit-response' + examples: + default: + $ref: '#/components/examples/interaction-limit-response' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs + x-stackQL-resource: orgs + delete: + summary: Remove interaction restrictions for an organization + description: >- + Removes all interaction restrictions from public repositories in the + given organization. You must be an organization owner to remove + restrictions. + tags: + - interactions + operationId: interactions/remove-restrictions-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs + x-stackQL-resource: orgs + /repos/{owner}/{repo}/interaction-limits: + get: + summary: Get interaction restrictions for a repository + description: >- + Shows which type of GitHub user can interact with this repository and + when the restriction expires. If there are no restrictions, you will see + an empty response. + tags: + - interactions + operationId: interactions/get-restrictions-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + additionalProperties: false + examples: + default: + $ref: '#/components/examples/interaction-limit-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: repos + x-stackQL-resource: repos + put: + summary: Set interaction restrictions for a repository + description: >- + Temporarily restricts interactions to a certain type of GitHub user + within the given repository. You must have owner or admin access to set + these restrictions. If an interaction limit is set for the user or + organization that owns this repository, you will receive a `409 + Conflict` response and will not be able to use this endpoint to change + the interaction limit for a single repository. + tags: + - interactions + operationId: interactions/set-restrictions-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit' + examples: + default: + summary: Example request body + value: + limit: collaborators_only + expiry: one_day + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit-response' + examples: + default: + $ref: '#/components/examples/interaction-limit-2' + '409': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Remove interaction restrictions for a repository + description: >- + Removes all interaction restrictions from the given repository. You must + have owner or admin access to remove restrictions. If the interaction + limit is set for the user or organization that owns this repository, you + will receive a `409 Conflict` response and will not be able to use this + endpoint to change the interaction limit for a single repository. + tags: + - interactions + operationId: interactions/remove-restrictions-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '409': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: repos + x-stackQL-resource: repos + /user/interaction-limits: + get: + summary: Get interaction restrictions for your public repositories + description: >- + Shows which type of GitHub user can interact with your public + repositories and when the restriction expires. + tags: + - interactions + operationId: interactions/get-restrictions-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories + responses: + '200': + description: Default response + content: + application/json: + schema: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + additionalProperties: false + examples: + default: + $ref: '#/components/examples/interaction-limit-response' + '204': + description: Response when there are no restrictions + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: interactions + subcategory: user + x-stackQL-resource: user + put: + summary: Set interaction restrictions for your public repositories + description: >- + Temporarily restricts which type of GitHub user can interact with your + public repositories. Setting the interaction limit at the user level + will overwrite any interaction limits that are set for individual + repositories owned by the user. + tags: + - interactions + operationId: interactions/set-restrictions-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit' + examples: + default: + value: + limit: collaborators_only + expiry: one_month + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit-response' + examples: + default: + $ref: '#/components/examples/interaction-limit-user' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: interactions + subcategory: user + x-stackQL-resource: user + delete: + summary: Remove interaction restrictions from your public repositories + description: Removes any interaction restrictions from your public repositories. + tags: + - interactions + operationId: interactions/remove-restrictions-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: interactions + subcategory: user + x-stackQL-resource: user +components: + schemas: + interaction-limit-response: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + interaction-limit: + title: Interaction Restrictions + description: Limit interactions to a specific type of user for a specified duration + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + expiry: + $ref: '#/components/schemas/interaction-expiry' + required: + - limit + interaction-group: + type: string + description: >- + The type of GitHub user that can comment, open issues, or create pull + requests while the interaction limit is in effect. + example: collaborators_only + enum: + - existing_users + - contributors_only + - collaborators_only + interaction-expiry: + type: string + description: 'The duration of the interaction restriction. Default: `one_day`.' + example: one_month + enum: + - one_day + - three_days + - one_week + - one_month + - six_months + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + examples: + interaction-limit-response: + value: + limit: collaborators_only + origin: organization + expires_at: '2018-08-17T04:18:39Z' + interaction-limit-2: + value: + limit: collaborators_only + origin: repository + expires_at: '2018-08-17T04:18:39Z' + interaction-limit-user: + value: + limit: collaborators_only + origin: user + expires_at: '2018-08-17T04:18:39Z' + x-stackQL-resources: + orgs: + id: github.interactions.orgs + name: orgs + title: Orgs + methods: + get_restrictions_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1interaction-limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_restrictions_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1interaction-limits/put' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_restrictions_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1interaction-limits/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/orgs/methods/get_restrictions_for_org + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/orgs/methods/remove_restrictions_for_org + replace: + - $ref: >- + #/components/x-stackQL-resources/orgs/methods/set_restrictions_for_org + repos: + id: github.interactions.repos + name: repos + title: Repos + methods: + get_restrictions_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1interaction-limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_restrictions_for_repo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1interaction-limits/put' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_restrictions_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1interaction-limits/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos/methods/get_restrictions_for_repo + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repos/methods/remove_restrictions_for_repo + replace: + - $ref: >- + #/components/x-stackQL-resources/repos/methods/set_restrictions_for_repo + user: + id: github.interactions.user + name: user + title: User + methods: + get_restrictions_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1interaction-limits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_restrictions_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1interaction-limits/put' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_restrictions_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1interaction-limits/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user/methods/get_restrictions_for_authenticated_user + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/user/methods/remove_restrictions_for_authenticated_user + replace: + - $ref: >- + #/components/x-stackQL-resources/user/methods/set_restrictions_for_authenticated_user +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/issues.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/issues.yaml new file mode 100644 index 0000000..cae0edd --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/issues.yaml @@ -0,0 +1,10852 @@ +openapi: 3.0.3 +info: + title: issues API + description: Interact with GitHub Issues. + version: 1.1.4 +paths: + /issues: + get: + summary: List issues assigned to the authenticated user + description: >- + List issues assigned to the authenticated user across all visible + repositories including owned repositories, member + + repositories, and organization repositories. You can use the `filter` + query parameter to fetch issues that are not + + necessarily assigned to you. + + + > [!NOTE] + + > GitHub's REST API considers every pull request an issue, but not every + issue is a pull request. For this reason, "Issues" endpoints may return + both issues and pull requests in the response. You can identify pull + requests by the `pull_request` key. Be aware that the `id` of a pull + request returned from "Issues" endpoints will be an _issue id_. To find + out the pull request id, use the "[List pull + requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" + endpoint. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user + parameters: + - name: filter + description: >- + Indicates which sorts of issues to return. `assigned` means issues + assigned to you. `created` means issues created by you. `mentioned` + means issues mentioning you. `subscribed` means issues you're + subscribed to updates for. `all` or `repos` means all issues you can + see, regardless of participation or creation. + in: query + required: false + schema: + type: string + enum: + - assigned + - created + - mentioned + - subscribed + - repos + - all + default: assigned + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - $ref: '#/components/parameters/labels' + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - name: collab + in: query + required: false + schema: + type: boolean + - name: orgs + in: query + required: false + schema: + type: boolean + - name: owned + in: query + required: false + schema: + type: boolean + - name: pulls + in: query + required: false + schema: + type: boolean + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-with-repo-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: issues + subcategory: issues + x-stackQL-resource: issues + /orgs/{org}/issues: + get: + summary: List organization issues assigned to the authenticated user + description: >- + List issues in an organization assigned to the authenticated user. + + + > [!NOTE] + + > GitHub's REST API considers every pull request an issue, but not every + issue is a pull request. For this reason, "Issues" endpoints may return + both issues and pull requests in the response. You can identify pull + requests by the `pull_request` key. Be aware that the `id` of a pull + request returned from "Issues" endpoints will be an _issue id_. To find + out the pull request id, use the "[List pull + requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" + endpoint. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + - name: filter + description: >- + Indicates which sorts of issues to return. `assigned` means issues + assigned to you. `created` means issues created by you. `mentioned` + means issues mentioning you. `subscribed` means issues you're + subscribed to updates for. `all` or `repos` means all issues you can + see, regardless of participation or creation. + in: query + required: false + schema: + type: string + enum: + - assigned + - created + - mentioned + - subscribed + - repos + - all + default: assigned + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - $ref: '#/components/parameters/labels' + - name: type + description: Can be the name of an issue type. + in: query + required: false + schema: + type: string + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-with-repo-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: issues + subcategory: issues + x-stackQL-resource: issues + /repos/{owner}/{repo}/assignees: + get: + summary: List assignees + description: >- + Lists the [available + assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) + for issues in a repository. + tags: + - issues + operationId: issues/list-assignees + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/assignees#list-assignees + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/assignees/{assignee}: + get: + summary: Check if a user can be assigned + description: >- + Checks if a user has permission to be assigned to an issue in this + repository. + + + If the `assignee` can be assigned to issues in the repository, a `204` + header with no content is returned. + + + Otherwise a `404` status code is returned. + tags: + - issues + operationId: issues/check-user-can-be-assigned + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: assignee + in: path + required: true + schema: + type: string + responses: + '204': + description: >- + If the `assignee` can be assigned to issues in the repository, a + `204` header with no content is returned. + '404': + description: Otherwise a `404` status code is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/issues: + get: + summary: List repository issues + description: >- + List issues in a repository. Only open issues will be listed. + + + > [!NOTE] + + > GitHub's REST API considers every pull request an issue, but not every + issue is a pull request. For this reason, "Issues" endpoints may return + both issues and pull requests in the response. You can identify pull + requests by the `pull_request` key. Be aware that the `id` of a pull + request returned from "Issues" endpoints will be an _issue id_. To find + out the pull request id, use the "[List pull + requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" + endpoint. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#list-repository-issues + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: milestone + description: >- + If an `integer` is passed, it should refer to a milestone by its + `number` field. If the string `*` is passed, issues with any + milestone are accepted. If the string `none` is passed, issues + without milestones are returned. + in: query + required: false + schema: + type: string + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - name: assignee + description: >- + Can be the name of a user. Pass in `none` for issues with no + assigned user, and `*` for issues assigned to any user. + in: query + required: false + schema: + type: string + - name: type + description: >- + Can be the name of an issue type. If the string `*` is passed, + issues with any type are accepted. If the string `none` is passed, + issues without type are returned. + in: query + required: false + schema: + type: string + - name: creator + description: The user that created the issue. + in: query + required: false + schema: + type: string + - name: mentioned + description: A user that's mentioned in the issue. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/labels' + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + post: + summary: Create an issue + description: >- + Any user with pull access to a repository can create an issue. If + [issues are disabled in the + repository](https://docs.github.com/articles/disabling-issues/), the API + returns a `410 Gone` status. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#create-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + description: The title of the issue. + type: string + body: + type: string + description: The contents of the issue. + assignee: + type: string + description: >- + Login for the user that this issue should be assigned to. + _NOTE: Only users with push access can set the assignee for + new issues. The assignee is silently dropped otherwise. + **This field is closing down.**_ + nullable: true + milestone: + nullable: true + type: string + description: >- + The `number` of the milestone to associate this issue with. + _NOTE: Only users with push access can set the milestone for + new issues. The milestone is silently dropped otherwise._ + labels: + type: array + description: >- + Labels to associate with this issue. _NOTE: Only users with + push access can set labels for new issues. Labels are + silently dropped otherwise._ + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + assignees: + type: array + description: >- + Logins for Users to assign to this issue. _NOTE: Only users + with push access can set assignees for new issues. Assignees + are silently dropped otherwise._ + items: + type: string + type: + type: string + description: >- + The name of the issue type to associate with this issue. + _NOTE: Only users with push access can set the type for new + issues. The type is silently dropped otherwise._ + nullable: true + example: Epic + required: + - title + examples: + default: + value: + title: Found a bug + body: I'm having a problem with this. + assignees: + - octocat + milestone: 1 + labels: + - bug + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + schema: + type: string + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + requestBody: + content: + application/json: + schema: + properties: + assignee: null + type: object + version: '2026-03-10' + x-stackQL-resource: issues + /repos/{owner}/{repo}/issues/comments: + get: + summary: List issue comments for a repository + description: >- + You can use the REST API to list comments on issues and pull requests + for a repository. Every pull request is an issue, but not every issue is + a pull request. + + + By default, issue comments are ordered by ascending ID. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-comments-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/sort' + - name: direction + description: Either `asc` or `desc`. Ignored without the `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/comments/{comment_id}: + get: + summary: Get an issue comment + description: >- + You can use the REST API to get comments on issues and pull requests. + Every pull request is an issue, but not every issue is a pull request. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#get-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update an issue comment + description: >- + You can use the REST API to update comments on issues and pull requests. + Every pull request is an issue, but not every issue is a pull request. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#update-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment. + required: + - body + examples: + default: + value: + body: Me too + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete an issue comment + description: >- + You can use the REST API to delete comments on issues and pull requests. + Every pull request is an issue, but not every issue is a pull request. + tags: + - issues + operationId: issues/delete-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/comments/{comment_id}/pin: + put: + summary: Pin an issue comment + description: >- + You can use the REST API to pin comments on issues. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/pin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment-pinned' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Unpin an issue comment + description: You can use the REST API to unpin comments on issues. + tags: + - issues + operationId: issues/unpin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/events: + get: + summary: List issue events for a repository + description: Lists events for a repository. + tags: + - issues + operationId: issues/list-events-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-event' + examples: + default: + $ref: '#/components/examples/issue-event-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/issues/events/{event_id}: + get: + summary: Get an issue event + description: Gets a single event by the event id. + tags: + - issues + operationId: issues/get-event + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/events#get-an-issue-event + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: event_id + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-event' + examples: + default: + $ref: '#/components/examples/issue-event' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/issues/{issue_number}: + get: + summary: Get an issue + description: >- + The API returns a [`301 Moved Permanently` + status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) + if the issue was + + [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) + to another repository. If + + the issue was transferred to or deleted from a repository where the + authenticated user lacks read access, the API + + returns a `404 Not Found` status. If the issue was deleted from a + repository where the authenticated user has read + + access, the API returns a `410 Gone` status. To receive webhook events + for transferred and deleted issues, subscribe + + to the + [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) + webhook. + + + > [!NOTE] + + > GitHub's REST API considers every pull request an issue, but not every + issue is a pull request. For this reason, "Issues" endpoints may return + both issues and pull requests in the response. You can identify pull + requests by the `pull_request` key. Be aware that the `id` of a pull + request returned from "Issues" endpoints will be an _issue id_. To find + out the pull request id, use the "[List pull + requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" + endpoint. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#get-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + summary: Issue + value: + $ref: '#/components/examples/issue' + pinned_comment: + summary: Issue with pinned comment + value: + $ref: '#/components/examples/issue-with-pinned-comment' + '301': + $ref: '#/components/responses/moved_permanently' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + patch: + summary: Update an issue + description: >- + Issue owners and users with push access or Triage role can edit an + issue. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#update-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + description: The title of the issue. + nullable: true + type: string + body: + type: string + description: The contents of the issue. + nullable: true + assignee: + type: string + nullable: true + description: >- + Username to assign to this issue. **This field is closing + down.** + state: + type: string + description: The open or closed state of the issue. + enum: + - open + - closed + state_reason: + type: string + enum: + - completed + - not_planned + - duplicate + - reopened + nullable: true + description: >- + The reason for the state change. Ignored unless `state` is + changed. + example: not_planned + milestone: + nullable: true + type: string + description: >- + The `number` of the milestone to associate this issue with + or use `null` to remove the current milestone. Only users + with push access can set the milestone for issues. Without + push access to the repository, milestone changes are + silently dropped. + labels: + type: array + description: >- + Labels to associate with this issue. Pass one or more labels + to _replace_ the set of labels on this issue. Send an empty + array (`[]`) to clear all labels from the issue. Only users + with push access can set labels for issues. Without push + access to the repository, label changes are silently + dropped. + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + assignees: + type: array + description: >- + Usernames to assign to this issue. Pass one or more user + logins to _replace_ the set of assignees on this issue. Send + an empty array (`[]`) to clear all assignees from the issue. + Only users with push access can set assignees for new + issues. Without push access to the repository, assignee + changes are silently dropped. + items: + type: string + issue_field_values: + type: array + description: >- + An array of issue field values to set on this issue. Each + field value must include the field ID and the value to set. + Only users with push access can set field values for issues + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + value: + oneOf: + - type: string + - type: number + description: The value to set for the field + required: + - field_id + - value + additionalProperties: false + type: + type: string + description: >- + The name of the issue type to associate with this issue or + use `null` to remove the current issue type. Only users with + push access can set the type for issues. Without push access + to the repository, type changes are silently dropped. + nullable: true + example: Epic + examples: + default: + value: + title: Found a bug + body: I'm having a problem with this. + assignees: + - octocat + milestone: 1 + state: open + labels: + - bug + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '301': + $ref: '#/components/responses/moved_permanently' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + requestBody: + content: + application/json: + schema: + properties: + assignee: null + type: object + version: '2026-03-10' + x-stackQL-resource: issues + /repos/{owner}/{repo}/issues/{issue_number}/assignees: + post: + summary: Add assignees to an issue + description: >- + Adds up to 10 assignees to an issue. Users already assigned to an issue + are not replaced. + tags: + - issues + operationId: issues/add-assignees + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + assignees: + type: array + description: >- + Usernames of people to assign this issue to. _NOTE: Only + users with push access can add assignees to an issue. + Assignees are silently ignored otherwise._ + items: + type: string + examples: + default: + value: + assignees: + - hubot + - other_user + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + delete: + summary: Remove assignees from an issue + description: Removes one or more assignees from an issue. + tags: + - issues + operationId: issues/remove-assignees + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + content: + application/json: + schema: + type: object + properties: + assignees: + type: array + description: >- + Usernames of assignees to remove from an issue. _NOTE: Only + users with push access can remove assignees from an issue. + Assignees are silently ignored otherwise._ + items: + type: string + examples: + default: + value: + assignees: + - hubot + - other_user + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}: + get: + summary: Check if a user can be assigned to a issue + description: >- + Checks if a user has permission to be assigned to a specific issue. + + + If the `assignee` can be assigned to this issue, a `204` status code + with no content is returned. + + + Otherwise a `404` status code is returned. + tags: + - issues + operationId: issues/check-user-can-be-assigned-to-issue + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: assignee + in: path + required: true + schema: + type: string + responses: + '204': + description: Response if `assignee` can be assigned to `issue_number` + '404': + description: Response if `assignee` can not be assigned to `issue_number` + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/issues/{issue_number}/comments: + get: + summary: List issue comments + description: >- + You can use the REST API to list comments on issues and pull requests. + Every pull request is an issue, but not every issue is a pull request. + + + Issue comments are ordered by ascending ID. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#list-issue-comments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create an issue comment + description: >- + You can use the REST API to create comments on issues and pull requests. + Every pull request is an issue, but not every issue is a pull request. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + + Creating content too quickly using this endpoint may result in secondary + rate limiting. + + For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#create-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment. + required: + - body + examples: + default: + value: + body: Me too + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by: + get: + summary: List dependencies an issue is blocked by + description: >- + You can use the REST API to list the dependencies an issue is blocked + by. + + + This endpoint supports the following custom media types. For more + information, see [Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the Markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's Markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + post: + summary: Add a dependency an issue is blocked by + description: >- + You can use the REST API to add a 'blocked by' relationship to an issue. + + + Creating content too quickly using this endpoint may result in secondary + rate limiting. + + For more information, see [Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + + and [Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + + This endpoint supports the following custom media types. For more + information, see [Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the Markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's Markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + $ref: '#/components/responses/moved_permanently' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}: + delete: + summary: Remove dependency an issue is blocked by + description: >- + You can use the REST API to remove a dependency that an issue is blocked + by. + + + Removing content too quickly using this endpoint may result in secondary + rate limiting. + + For more information, see [Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + + and [Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + + This endpoint supports the following custom media types. For more + information, see [Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. + Response will include `body`. This is the default if you do not pass a + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the Markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's Markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '301': + $ref: '#/components/responses/moved_permanently' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking: + get: + summary: List dependencies an issue is blocking + description: >- + You can use the REST API to list the dependencies an issue is blocking. + + + This endpoint supports the following custom media types. For more + information, see [Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the Markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's Markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + /repos/{owner}/{repo}/issues/{issue_number}/events: + get: + summary: List issue events + description: Lists all events for an issue. + tags: + - issues + operationId: issues/list-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/events#list-issue-events + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-event-for-issue' + examples: + default: + $ref: '#/components/examples/issue-event-for-issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values: + get: + summary: List issue field values for an issue + description: Lists all issue field values for an issue. + tags: + - issues + operationId: issues/list-issue-field-values-for-issue + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + examples: + default: + $ref: '#/components/examples/issue-field-value-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + /repos/{owner}/{repo}/issues/{issue_number}/labels: + get: + summary: List labels for an issue + description: Lists all labels for an issue. + tags: + - issues + operationId: issues/list-labels-on-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + post: + summary: Add labels to an issue + description: Adds labels to an issue. + tags: + - issues + operationId: issues/add-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + labels: + type: array + minItems: 1 + description: >- + The names of the labels to add to the issue's existing + labels. You can also pass an `array` of labels directly, but + GitHub recommends passing an object with the `labels` key. + To replace all of the labels for an issue, use "[Set labels + for an + issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." + items: + type: string + items: + type: string + properties: + name: + type: string + required: + - name + examples: + default: + value: + labels: + - bug + - enhancement + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + put: + summary: Set labels for an issue + description: Removes any previous labels and sets the new labels for an issue. + tags: + - issues + operationId: issues/set-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + labels: + type: array + minItems: 1 + description: >- + The names of the labels to set for the issue. The labels you + set replace any existing labels. You can pass an empty array + to remove all labels. Alternatively, you can pass a single + label as a `string` or an `array` of labels directly, but + GitHub recommends passing an object with the `labels` key. + You can also add labels to the existing labels for an issue. + For more information, see "[Add labels to an + issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." + items: + type: string + minItems: 1 + items: + type: string + properties: + name: + type: string + required: + - name + examples: + default: + value: + labels: + - bug + - enhancement + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + delete: + summary: Remove all labels from an issue + description: Removes all labels from an issue. + tags: + - issues + operationId: issues/remove-all-labels + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '204': + description: Response + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}: + delete: + summary: Remove a label from an issue + description: >- + Removes the specified label from the issue, and returns the remaining + labels on the issue. This endpoint returns a `404 Not Found` status if + the label does not exist. + tags: + - issues + operationId: issues/remove-label + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items-2' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/issues/{issue_number}/lock: + put: + summary: Lock an issue + description: >- + Users with push access can lock an issue or pull request's conversation. + + + Note that, if you choose not to pass any parameters, you'll need to set + `Content-Length` to zero when calling out to this endpoint. For more + information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - issues + operationId: issues/lock + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#lock-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + lock_reason: + type: string + description: >- + The reason for locking the issue or pull request + conversation. Lock will fail if you don't use one of these + reasons: + * `off-topic` + * `too heated` + * `resolved` + * `spam` + enum: + - off-topic + - too heated + - resolved + - spam + examples: + default: + summary: Example of locking an issue as off-topic + value: + lock_reason: off-topic + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + delete: + summary: Unlock an issue + description: Users with push access can unlock an issue's conversation. + tags: + - issues + operationId: issues/unlock + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#unlock-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + /repos/{owner}/{repo}/issues/{issue_number}/parent: + get: + summary: Get parent issue + description: >- + You can use the REST API to get the parent issue of a sub-issue. + + + This endpoint supports the following custom media types. For more + information, see [Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/get-parent + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/sub_issue: + delete: + summary: Remove sub-issue + description: >- + You can use the REST API to remove a sub-issue from an issue. + + Removing content too quickly using this endpoint may result in secondary + rate limiting. + + For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass a + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/remove-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to remove + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue + schema: + type: string + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/sub_issues: + get: + summary: List sub-issues + description: >- + You can use the REST API to list the sub-issues on an issue. + + + This endpoint supports the following custom media types. For more + information, see [Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the Markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's Markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-sub-issues + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + post: + summary: Add sub-issue + description: >- + You can use the REST API to add sub-issues to issues. + + + Creating content too quickly using this endpoint may result in secondary + rate limiting. + + For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/add-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: >- + The id of the sub-issue to add. The sub-issue must belong to + the same repository owner as the parent issue + replace_parent: + type: boolean + description: >- + Option that, when true, instructs the operation to replace + the sub-issues current parent issue + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority: + patch: + summary: Reprioritize sub-issue + description: >- + You can use the REST API to reprioritize a sub-issue to a different + position in the parent list. + tags: + - issues + operationId: issues/reprioritize-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to reprioritize + after_id: + type: integer + description: >- + The id of the sub-issue to be prioritized after (either + positional argument after OR before should be specified). + before_id: + type: integer + description: >- + The id of the sub-issue to be prioritized before (either + positional argument after OR before should be specified). + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + after_id: 5 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/timeline: + get: + summary: List timeline events for an issue + description: List all timeline events for an issue. + tags: + - issues + operationId: issues/list-events-for-timeline + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/timeline-issue-events' + examples: + default: + $ref: '#/components/examples/timeline-issue-events' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: timeline + x-stackQL-resource: timeline + /repos/{owner}/{repo}/labels: + get: + summary: List labels for a repository + description: Lists all labels for a repository. + tags: + - issues + operationId: issues/list-labels-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/labels#list-labels-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + post: + summary: Create a label + description: >- + Creates a label for the specified repository with the given name and + color. The name and color parameters are required. The color must be a + valid [hexadecimal color code](http://www.color-hex.com/). + tags: + - issues + operationId: issues/create-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#create-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: >- + The name of the label. Emoji can be added to label names, + using either native emoji or colon-style markup. For + example, typing `:strawberry:` will render the emoji + ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png + ":strawberry:"). For a full list of available emoji and + codes, see "[Emoji cheat + sheet](https://github.com/ikatyang/emoji-cheat-sheet)." + color: + type: string + description: >- + The [hexadecimal color code](http://www.color-hex.com/) for + the label, without the leading `#`. + description: + type: string + description: >- + A short description of the label. Must be 100 characters or + fewer. + required: + - name + examples: + default: + value: + name: bug + description: Something isn't working + color: f29513 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/labels/bug + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/labels/{name}: + get: + summary: Get a label + description: Gets a label using the given name. + tags: + - issues + operationId: issues/get-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#get-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + patch: + summary: Update a label + description: Updates a label using the given label name. + tags: + - issues + operationId: issues/update-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#update-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: name + in: path + required: true + schema: + type: string + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + new_name: + type: string + description: >- + The new name of the label. Emoji can be added to label + names, using either native emoji or colon-style markup. For + example, typing `:strawberry:` will render the emoji + ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png + ":strawberry:"). For a full list of available emoji and + codes, see "[Emoji cheat + sheet](https://github.com/ikatyang/emoji-cheat-sheet)." + color: + type: string + description: >- + The [hexadecimal color code](http://www.color-hex.com/) for + the label, without the leading `#`. + description: + type: string + description: >- + A short description of the label. Must be 100 characters or + fewer. + examples: + default: + value: + new_name: 'bug :bug:' + description: Small bug fix required + color: b01f26 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + delete: + summary: Delete a label + description: Deletes a label using the given label name. + tags: + - issues + operationId: issues/delete-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#delete-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: name + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/milestones: + get: + summary: List milestones + description: Lists milestones for a repository. + tags: + - issues + operationId: issues/list-milestones + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#list-milestones + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: state + description: The state of the milestone. Either `open`, `closed`, or `all`. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - name: sort + description: What to sort results by. Either `due_on` or `completeness`. + in: query + required: false + schema: + type: string + enum: + - due_on + - completeness + default: due_on + - name: direction + description: The direction of the sort. Either `asc` or `desc`. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + post: + summary: Create a milestone + description: Creates a milestone. + tags: + - issues + operationId: issues/create-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#create-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the milestone. + state: + type: string + description: The state of the milestone. Either `open` or `closed`. + enum: + - open + - closed + default: open + description: + type: string + description: A description of the milestone. + due_on: + type: string + format: date-time + description: >- + The milestone due date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + required: + - title + examples: + default: + value: + title: v1.0 + state: open + description: Tracking milestone for version 1.0 + due_on: '2012-10-09T23:39:01Z' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + /repos/{owner}/{repo}/milestones/{milestone_number}: + get: + summary: Get a milestone + description: Gets a milestone using the given milestone number. + tags: + - issues + operationId: issues/get-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#get-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + patch: + summary: Update a milestone + description: '' + tags: + - issues + operationId: issues/update-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#update-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the milestone. + state: + type: string + description: The state of the milestone. Either `open` or `closed`. + enum: + - open + - closed + default: open + description: + type: string + description: A description of the milestone. + due_on: + type: string + format: date-time + description: >- + The milestone due date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + examples: + default: + value: + title: v1.0 + state: open + description: Tracking milestone for version 1.0 + due_on: '2012-10-09T23:39:01Z' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + delete: + summary: Delete a milestone + description: Deletes a milestone using the given milestone number. + tags: + - issues + operationId: issues/delete-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#delete-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + /repos/{owner}/{repo}/milestones/{milestone_number}/labels: + get: + summary: List labels for issues in a milestone + description: Lists labels for issues in a milestone. + tags: + - issues + operationId: issues/list-labels-for-milestone + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repositories/{repository_id}/issues/{issue_number}/issue-field-values: + post: + summary: Add issue field values to an issue + description: >- + Add custom field values to an issue. You can set values for + organization-level issue fields that have been defined for the + repository's organization. + + Adding an empty array will clear all existing field values for the + issue. + + + This endpoint supports the following field data types: + + - **`text`**: String values for text fields + + - **`single_select`**: Option names for single-select fields (must match + an existing option name) + + - **`number`**: Numeric values for number fields + + - **`date`**: ISO 8601 date strings for date fields + + + Only users with push access to the repository can add issue field + values. If you don't have the proper permissions, you'll receive a `403 + Forbidden` response. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - $ref: '#/components/parameters/repository-id' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: >- + An array of issue field values to add to this issue. Each + field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: >- + The value to set for text, single_select, or date + fields + - type: number + description: The value to set for number fields + description: >- + The value to set for the field. The type depends on + the field's data type: + + - For text fields: provide a string value + + - For single_select fields: provide the option name as + a string (must match an existing option) + + - For number fields: provide a numeric value + + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: >- + The current issue field values for this issue after adding the + new values + items: + $ref: '#/components/schemas/issue-field-value' + examples: + default: + $ref: '#/components/examples/issue-field-value-items' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + put: + summary: Set issue field values for an issue + description: >- + Set custom field values for an issue, replacing any existing values. You + can set values for organization-level issue fields that have been + defined for the repository's organization. + + + This endpoint supports the following field data types: + + - **`text`**: String values for text fields + + - **`single_select`**: Option names for single-select fields (must match + an existing option name) + + - **`number`**: Numeric values for number fields + + - **`date`**: ISO 8601 date strings for date fields + + + This operation will replace all existing field values with the provided + ones. If you want to add field values without replacing existing ones, + use the `POST` endpoint instead. + + + Only users with push access to the repository can set issue field + values. If you don't have the proper permissions, you'll receive a `403 + Forbidden` response. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - $ref: '#/components/parameters/repository-id' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: >- + An array of issue field values to set for this issue. Each + field value must include the field ID and the value to set. + All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: >- + The value to set for text, single_select, or date + fields + - type: number + description: The value to set for number fields + description: >- + The value to set for the field. The type depends on + the field's data type: + + - For text fields: provide a string value + + - For single_select fields: provide the option name as + a string (must match an existing option) + + - For number fields: provide a numeric value + + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: >- + The current issue field values for this issue after setting + the new values + items: + $ref: '#/components/schemas/issue-field-value' + examples: + default: + $ref: '#/components/examples/issue-field-value-items' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + /repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}: + delete: + summary: Delete an issue field value from an issue + description: >- + Remove a specific custom field value from an issue. + + + Only users with push access to the repository can delete issue field + values. If you don't have the proper permissions, you'll receive a `403 + Forbidden` response. + + + If the specified field does not have a value set on the issue, this + operation will return a `404` error. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - $ref: '#/components/parameters/repository-id' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/issue-field-id' + responses: + '204': + description: Issue field value deleted successfully + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + /user/issues: + get: + summary: List user account issues assigned to the authenticated user + description: >- + List issues across owned and member repositories assigned to the + authenticated user. + + + > [!NOTE] + + > GitHub's REST API considers every pull request an issue, but not every + issue is a pull request. For this reason, "Issues" endpoints may return + both issues and pull requests in the response. You can identify pull + requests by the `pull_request` key. Be aware that the `id` of a pull + request returned from "Issues" endpoints will be an _issue id_. To find + out the pull request id, use the "[List pull + requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" + endpoint. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - issues + operationId: issues/list-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user + parameters: + - name: filter + description: >- + Indicates which sorts of issues to return. `assigned` means issues + assigned to you. `created` means issues created by you. `mentioned` + means issues mentioning you. `subscribed` means issues you're + subscribed to updates for. `all` or `repos` means all issues you can + see, regardless of participation or creation. + in: query + required: false + schema: + type: string + enum: + - assigned + - created + - mentioned + - subscribed + - repos + - all + default: assigned + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - $ref: '#/components/parameters/labels' + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-with-repo-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: issues + subcategory: issues + x-stackQL-resource: issues +components: + schemas: + issue: + title: Issue + description: >- + Issues are a great way to keep track of tasks, enhancements, and bugs + for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: >- + It looks like the new widget form is broken on Safari. When I try + and create the widget, Safari crashes. This is reproducible on 10.8, + but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: >- + Labels to associate with this issue; pass one or more label names to + replace the set of labels on this issue; send an empty array to + clear all labels from the issue; note that the labels are silently + dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + issue-event: + title: Issue Event + description: Issue Event + type: object + properties: + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDEwOklzc3VlRXZlbnQx + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + $ref: '#/components/schemas/nullable-simple-user' + event: + type: string + example: closed + commit_id: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + nullable: true + commit_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + nullable: true + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue: + $ref: '#/components/schemas/nullable-issue' + label: + $ref: '#/components/schemas/issue-event-label' + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assigner: + $ref: '#/components/schemas/nullable-simple-user' + review_requester: + $ref: '#/components/schemas/nullable-simple-user' + requested_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + requested_team: + $ref: '#/components/schemas/team' + dismissed_review: + $ref: '#/components/schemas/issue-event-dismissed-review' + milestone: + $ref: '#/components/schemas/issue-event-milestone' + project_card: + $ref: '#/components/schemas/issue-event-project-card' + rename: + $ref: '#/components/schemas/issue-event-rename' + author_association: + $ref: '#/components/schemas/author-association' + lock_reason: + type: string + nullable: true + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + issue-event-for-issue: + title: Issue Event for Issue + description: Issue Event for Issue + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + assignee: + $ref: '#/components/schemas/simple-user' + assigner: + $ref: '#/components/schemas/simple-user' + milestone: + type: object + properties: + title: + type: string + required: + - title + rename: + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + nullable: true + type: string + dismissal_commit_id: + type: string + required: + - state + - review_id + - dismissal_message + lock_reason: + type: string + example: '"off-topic"' + nullable: true + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + - assigner + - milestone + - rename + - review_requester + - dismissed_review + - lock_reason + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: >- + Details about the selected option (only present for single_select + fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + label: + title: Label + description: >- + Color-coded labels help you categorize and filter your issues (just like + labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + example: 208045946 + node_id: + type: string + example: MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + example: https://api.github.com/repositories/42/labels/bug + type: string + format: uri + name: + description: The name of the label. + example: bug + type: string + description: + description: Optional description of the label, such as its purpose. + type: string + example: Something isn't working + nullable: true + color: + description: '6-character hex code, without the leading #, identifying the color' + example: FFFFFF + type: string + default: + description: Whether this label comes by default in a new repository. + type: boolean + example: true + required: + - id + - node_id + - url + - name + - description + - color + - default + timeline-issue-events: + title: Timeline Event + description: Timeline Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + milestone: + type: object + properties: + title: + type: string + required: + - title + rename: + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + nullable: true + type: string + dismissal_commit_id: + type: string + required: + - state + - review_id + - dismissal_message + lock_reason: + type: string + example: '"off-topic"' + nullable: true + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/simple-user' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + source: + type: object + properties: + type: + type: string + issue: + $ref: '#/components/schemas/issue' + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + author: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + tree: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - sha + - url + - html_url + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - signature + - payload + - verified_at + state: + type: string + example: CHANGES_REQUESTED + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + comments: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + assignee: + $ref: '#/components/schemas/simple-user' + state_reason: + type: string + nullable: true + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - milestone + - rename + - review_requester + - dismissed_review + - lock_reason + - html_url + - issue_url + - author_association + - user + - updated_at + - source + - sha + - author + - committer + - tree + - message + - parents + - verification + - body + - state + - pull_request_url + - _links + - assignee + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + nullable-issue: + title: Issue + description: >- + Issues are a great way to keep track of tasks, enhancements, and bugs + for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: >- + It looks like the new widget form is broken on Safari. When I try + and create the widget, Safari crashes. This is reproducible on 10.8, + but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: >- + Labels to associate with this issue; pass one or more label names to + replace the set of labels on this issue; send an empty array to + clear all labels from the issue; note that the labels are silently + dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + issue-event-label: + title: Issue Event Label + description: Issue Event Label + type: object + properties: + name: + type: string + nullable: true + color: + type: string + nullable: true + required: + - name + - color + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + issue-event-dismissed-review: + title: Issue Event Dismissed Review + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + type: string + nullable: true + dismissal_commit_id: + type: string + nullable: true + required: + - state + - review_id + - dismissal_message + issue-event-milestone: + title: Issue Event Milestone + description: Issue Event Milestone + type: object + properties: + title: + type: string + required: + - title + issue-event-project-card: + title: Issue Event Project Card + description: Issue Event Project Card + type: object + properties: + url: + type: string + format: uri + id: + type: integer + project_url: + type: string + format: uri + project_id: + type: integer + column_name: + type: string + previous_column_name: + type: string + required: + - url + - id + - project_url + - project_id + - column_name + issue-event-rename: + title: Issue Event Rename + description: Issue Event Rename + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + labeled-issue-event: + title: Labeled Issue Event + description: Labeled Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + unlabeled-issue-event: + title: Unlabeled Issue Event + description: Unlabeled Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + assigned-issue-event: + title: Assigned Issue Event + description: Assigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/integration' + assignee: + $ref: '#/components/schemas/simple-user' + assigner: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + - assigner + unassigned-issue-event: + title: Unassigned Issue Event + description: Unassigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + assignee: + $ref: '#/components/schemas/simple-user' + assigner: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + - assigner + milestoned-issue-event: + title: Milestoned Issue Event + description: Milestoned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + milestone: + type: object + properties: + title: + type: string + required: + - title + required: + - milestone + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + demilestoned-issue-event: + title: Demilestoned Issue Event + description: Demilestoned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + milestone: + type: object + properties: + title: + type: string + required: + - title + required: + - milestone + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + renamed-issue-event: + title: Renamed Issue Event + description: Renamed Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + rename: + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + required: + - rename + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + review-requested-issue-event: + title: Review Requested Issue Event + description: Review Requested Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + required: + - review_requester + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + review-request-removed-issue-event: + title: Review Request Removed Issue Event + description: Review Request Removed Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + required: + - review_requester + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + review-dismissed-issue-event: + title: Review Dismissed Issue Event + description: Review Dismissed Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + nullable: true + type: string + dismissal_commit_id: + type: string + required: + - state + - review_id + - dismissal_message + required: + - dismissed_review + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + locked-issue-event: + title: Locked Issue Event + description: Locked Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + lock_reason: + type: string + example: '"off-topic"' + nullable: true + required: + - lock_reason + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + added-to-project-issue-event: + title: Added to Project Issue Event + description: Added to Project Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + moved-column-in-project-issue-event: + title: Moved Column in Project Issue Event + description: Moved Column in Project Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + removed-from-project-issue-event: + title: Removed from Project Issue Event + description: Removed from Project Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + converted-note-to-issue-issue-event: + title: Converted Note to Issue Issue Event + description: Converted Note to Issue Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + timeline-comment-event: + title: Timeline Comment Event + description: Timeline Comment Event + type: object + properties: + event: + type: string + actor: + $ref: '#/components/schemas/simple-user' + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - event + - actor + - id + - node_id + - html_url + - issue_url + - author_association + - user + - url + - created_at + - updated_at + timeline-cross-referenced-event: + title: Timeline Cross Referenced Event + description: Timeline Cross Referenced Event + type: object + properties: + event: + type: string + actor: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + source: + type: object + properties: + type: + type: string + issue: + $ref: '#/components/schemas/issue' + required: + - event + - created_at + - updated_at + - source + timeline-committed-event: + title: Timeline Committed Event + description: Timeline Committed Event + type: object + properties: + event: + type: string + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + node_id: + type: string + url: + type: string + format: uri + author: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + tree: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - sha + - url + - html_url + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - signature + - payload + - verified_at + html_url: + type: string + format: uri + required: + - sha + - node_id + - url + - html_url + - author + - committer + - tree + - message + - parents + - verification + timeline-reviewed-event: + title: Timeline Reviewed Event + description: Timeline Reviewed Event + type: object + properties: + event: + type: string + id: + description: Unique identifier of the review + example: 42 + type: integer + node_id: + type: string + example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + $ref: '#/components/schemas/simple-user' + body: + nullable: true + description: The text of the review. + example: This looks great. + type: string + state: + type: string + example: CHANGES_REQUESTED + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + updated_at: + type: string + nullable: true + format: date-time + commit_id: + description: A commit SHA for the review. + example: 54bb654c9e6025347f57900a4a5c2313a96b8035 + type: string + body_html: + type: string + body_text: + type: string + author_association: + $ref: '#/components/schemas/author-association' + required: + - event + - id + - node_id + - user + - body + - state + - commit_id + - html_url + - pull_request_url + - _links + - author_association + timeline-line-commented-event: + title: Timeline Line Commented Event + description: Timeline Line Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + comments: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + timeline-commit-commented-event: + title: Timeline Commit Commented Event + description: Timeline Commit Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + commit_id: + type: string + comments: + type: array + items: + $ref: '#/components/schemas/commit-comment' + timeline-assigned-issue-event: + title: Timeline Assigned Issue Event + description: Timeline Assigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + assignee: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + timeline-unassigned-issue-event: + title: Timeline Unassigned Issue Event + description: Timeline Unassigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + assignee: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + state-change-issue-event: + title: State Change Issue Event + description: State Change Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + state_reason: + type: string + nullable: true + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + pull-request-review-comment: + title: Pull Request Review Comment + description: >- + Pull Request Review Comments are comments on a portion of the Pull + Request's diff. + type: object + properties: + url: + description: URL for the pull request review comment + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + type: string + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: integer + format: int64 + example: 42 + nullable: true + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + example: 1 + node_id: + description: The node ID of the pull request review comment. + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: + description: The relative path of the file to which the comment applies. + example: config/database.yaml + type: string + position: + description: >- + The line index in the diff to which the comment applies. This field + is closing down; use `line` instead. + example: 1 + type: integer + original_position: + description: >- + The index of the original line in the diff to which the comment + applies. This field is closing down; use `original_line` instead. + example: 4 + type: integer + commit_id: + description: The SHA of the commit to which the comment applies. + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + type: string + in_reply_to_id: + description: The comment ID to reply to. + example: 8 + type: integer + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + description: The text of the comment. + example: We should probably include a check for null values here. + type: string + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + description: URL for the pull request that the review comment belongs to. + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + $ref: '#/components/schemas/author-association' + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + original_start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: >- + The line of the blob to which the comment applies. The last line of + the range for a multi-line comment + example: 2 + type: integer + original_line: + description: >- + The line of the blob to which the comment applies. The last line of + the range for a multi-line comment + example: 2 + type: integer + side: + description: >- + The side of the diff to which the comment applies. The side of the + last line of the range for a multi-line comment + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + subject_type: + description: >- + The level at which the comment is targeted, can be a diff line or a + file. + type: string + enum: + - line + - file + reactions: + $ref: '#/components/schemas/reaction-rollup' + body_html: + type: string + example: '"

comment body

"' + body_text: + type: string + example: '"comment body"' + required: + - url + - id + - node_id + - pull_request_review_id + - diff_hunk + - path + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + commit-comment: + title: Commit Comment + description: Commit Comment + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - url + - html_url + - id + - node_id + - user + - position + - line + - path + - commit_id + - body + - author_association + - created_at + - updated_at + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + gone: + description: Gone + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + parameters: + labels: + name: labels + description: 'A list of comma separated label names. Example: `bug,ui,@high`' + in: query + required: false + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + since: + name: since + description: >- + Only show results that were last updated after the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + issue-number: + name: issue_number + description: The number that identifies the issue. + in: path + required: true + schema: + type: integer + milestone-number: + name: milestone_number + description: The number that identifies the milestone. + in: path + required: true + schema: + type: integer + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + issue-field-id: + name: issue_field_id + description: The unique identifier of the issue field. + in: path + required: true + schema: + type: integer + examples: + issue-with-repo-items: + value: + - id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + author_association: COLLABORATOR + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + issue-items: + value: + - id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + issue: + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + issue-comment-items: + value: + - id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + issue-comment: + value: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + pin: null + issue-comment-pinned: + value: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + issue-event-items: + value: + - id: 1 + node_id: MDEwOklzc3VlRXZlbnQx + url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + event: closed + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: '2011-04-14T16:00:49Z' + issue: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + author_association: COLLABORATOR + state_reason: completed + issue-event: + value: + id: 1 + node_id: MDEwOklzc3VlRXZlbnQx + url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + event: closed + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: '2011-04-14T16:00:49Z' + issue: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + performed_via_github_app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + events: + - push + - pull_request + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + author_association: COLLABORATOR + state_reason: completed + issue-with-pinned-comment: + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 1 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + issue-event-for-issue-items: + value: + - id: 1 + node_id: MDEwOklzc3VlRXZlbnQx + url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + event: closed + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: '2011-04-14T16:00:49Z' + performed_via_github_app: null + label: + name: label + color: red + issue-field-value-items: + value: + - issue_field_id: 1 + node_id: IFT_GDKND + data_type: text + value: DRI + - issue_field_id: 2 + node_id: IFSS_SADMS + data_type: single_select + value: 1 + single_select_option: + id: 1 + name: High + color: red + - issue_field_id: 3 + node_id: IFN_POINTS + data_type: number + value: 42 + - issue_field_id: 4 + node_id: IFD_DUEDATE + data_type: date + value: '2025-12-25' + label-items: + value: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + - id: 208045947 + node_id: MDU6TGFiZWwyMDgwNDU5NDc= + url: https://api.github.com/repos/octocat/Hello-World/labels/enhancement + name: enhancement + description: New feature or request + color: a2eeef + default: false + label-items-2: + value: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + timeline-issue-events: + value: + - id: 6430295168 + node_id: LOE_lADODwFebM5HwC0kzwAAAAF_RoSA + url: https://api.github.com/repos/github/roadmap/issues/events/6430295168 + actor: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + event: locked + commit_id: null + commit_url: null + created_at: '2022-04-13T20:49:13Z' + lock_reason: null + performed_via_github_app: null + - id: 6430296748 + node_id: LE_lADODwFebM5HwC0kzwAAAAF_Roqs + url: https://api.github.com/repos/github/roadmap/issues/events/6430296748 + actor: + login: github-product-roadmap + id: 67656570 + node_id: MDQ6VXNlcjY3NjU2NTcw + avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 + gravatar_id: '' + url: https://api.github.com/users/github-product-roadmap + html_url: https://github.com/github-product-roadmap + followers_url: https://api.github.com/users/github-product-roadmap/followers + following_url: >- + https://api.github.com/users/github-product-roadmap/following{/other_user} + gists_url: >- + https://api.github.com/users/github-product-roadmap/gists{/gist_id} + starred_url: >- + https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions + organizations_url: https://api.github.com/users/github-product-roadmap/orgs + repos_url: https://api.github.com/users/github-product-roadmap/repos + events_url: >- + https://api.github.com/users/github-product-roadmap/events{/privacy} + received_events_url: >- + https://api.github.com/users/github-product-roadmap/received_events + type: User + site_admin: false + event: labeled + commit_id: null + commit_url: null + created_at: '2022-04-13T20:49:34Z' + label: + name: beta + color: 99dd88 + performed_via_github_app: null + - id: 6635165802 + node_id: RTE_lADODwFebM5HwC0kzwAAAAGLfJhq + url: https://api.github.com/repos/github/roadmap/issues/events/6635165802 + actor: + login: github-product-roadmap + id: 67656570 + node_id: MDQ6VXNlcjY3NjU2NTcw + avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 + gravatar_id: '' + url: https://api.github.com/users/github-product-roadmap + html_url: https://github.com/github-product-roadmap + followers_url: https://api.github.com/users/github-product-roadmap/followers + following_url: >- + https://api.github.com/users/github-product-roadmap/following{/other_user} + gists_url: >- + https://api.github.com/users/github-product-roadmap/gists{/gist_id} + starred_url: >- + https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions + organizations_url: https://api.github.com/users/github-product-roadmap/orgs + repos_url: https://api.github.com/users/github-product-roadmap/repos + events_url: >- + https://api.github.com/users/github-product-roadmap/events{/privacy} + received_events_url: >- + https://api.github.com/users/github-product-roadmap/received_events + type: User + site_admin: false + event: renamed + commit_id: null + commit_url: null + created_at: '2022-05-18T19:29:01Z' + rename: + from: >- + Secret scanning: dry-runs for enterprise-level custom patterns + (cloud) + to: 'Secret scanning: dry-runs for enterprise-level custom patterns' + performed_via_github_app: null + - url: >- + https://api.github.com/repos/github/roadmap/issues/comments/1130876857 + html_url: https://github.com/github/roadmap/issues/493#issuecomment-1130876857 + issue_url: https://api.github.com/repos/github/roadmap/issues/493 + id: 1130876857 + node_id: IC_kwDODwFebM5DZ8-5 + user: + login: octocat + id: 94867353 + node_id: U_kgDOBaePmQ + avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + created_at: '2022-05-19T00:52:15Z' + updated_at: '2022-05-19T00:52:15Z' + author_association: COLLABORATOR + body: >- + 🚒 Shipped to the cloud: + https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/ + reactions: + url: >- + https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions + total_count: 0 + '+1': 0 + '-1': 0 + laugh: 0 + hooray: 0 + confused: 0 + heart: 0 + rocket: 0 + eyes: 0 + performed_via_github_app: null + event: commented + actor: + login: octocat + id: 94867353 + node_id: U_kgDOBaePmQ + avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + label: + value: + id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + label-2: + value: + id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: 'https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + description: Small bug fix required + color: b01f26 + default: true + milestone-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + milestone: + value: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + issues: + id: github.issues.issues + name: issues + title: Issues + methods: + list: + operation: + $ref: '#/paths/~1issues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1issues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + lock: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1lock/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unlock: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1lock/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issues/methods/get' + - $ref: '#/components/x-stackQL-resources/issues/methods/list_for_repo' + - $ref: '#/components/x-stackQL-resources/issues/methods/list_for_org' + - $ref: '#/components/x-stackQL-resources/issues/methods/list' + insert: + - $ref: '#/components/x-stackQL-resources/issues/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/issues/methods/update' + delete: [] + replace: [] + assignees: + id: github.issues.assignees + name: assignees + title: Assignees + methods: + list_assignees: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1assignees/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_user_can_be_assigned: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1assignees~1{assignee}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + add_assignees: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1assignees/post + response: + mediaType: application/json + openAPIDocKey: '201' + remove_assignees: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1assignees/delete + response: + mediaType: application/json + openAPIDocKey: '200' + check_user_can_be_assigned_to_issue: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1assignees~1{assignee}/get + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assignees/methods/list_assignees' + insert: + - $ref: '#/components/x-stackQL-resources/assignees/methods/add_assignees' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/assignees/methods/remove_assignees + replace: [] + comments: + id: github.issues.comments + name: comments + title: Comments + methods: + list_comments_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_comments: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1comments/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1comments/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/comments/methods/get_comment' + - $ref: '#/components/x-stackQL-resources/comments/methods/list_comments' + - $ref: >- + #/components/x-stackQL-resources/comments/methods/list_comments_for_repo + insert: + - $ref: '#/components/x-stackQL-resources/comments/methods/create_comment' + update: + - $ref: '#/components/x-stackQL-resources/comments/methods/update_comment' + delete: + - $ref: '#/components/x-stackQL-resources/comments/methods/delete_comment' + replace: [] + issue_comment_pins: + id: github.issues.issue_comment_pins + name: issue_comment_pins + title: Issue Comment Pins + methods: + pin_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}~1pin/put + response: + mediaType: application/json + openAPIDocKey: '200' + unpin_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}~1pin/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_comment_pins/methods/unpin_comment + replace: + - $ref: >- + #/components/x-stackQL-resources/issue_comment_pins/methods/pin_comment + events: + id: github.issues.events + name: events + title: Events + methods: + list_events_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues~1events/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_event: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1issues~1events~1{event_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_events: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1events/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/events/methods/get_event' + - $ref: '#/components/x-stackQL-resources/events/methods/list_events' + - $ref: >- + #/components/x-stackQL-resources/events/methods/list_events_for_repo + insert: [] + update: [] + delete: [] + replace: [] + issue_blocked_by_dependencies: + id: github.issues.issue_blocked_by_dependencies + name: issue_blocked_by_dependencies + title: Issue Blocked By Dependencies + methods: + list_dependencies_blocked_by: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1dependencies~1blocked_by/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_blocked_by_dependency: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1dependencies~1blocked_by/post + response: + mediaType: application/json + openAPIDocKey: '201' + remove_dependency_blocked_by: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1dependencies~1blocked_by~1{issue_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_blocked_by_dependencies/methods/list_dependencies_blocked_by + insert: + - $ref: >- + #/components/x-stackQL-resources/issue_blocked_by_dependencies/methods/add_blocked_by_dependency + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_blocked_by_dependencies/methods/remove_dependency_blocked_by + replace: [] + issue_blocking_dependencies: + id: github.issues.issue_blocking_dependencies + name: issue_blocking_dependencies + title: Issue Blocking Dependencies + methods: + list_dependencies_blocking: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1dependencies~1blocking/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_blocking_dependencies/methods/list_dependencies_blocking + insert: [] + update: [] + delete: [] + replace: [] + issue_field_values: + id: github.issues.issue_field_values + name: issue_field_values + title: Issue Field Values + methods: + list_issue_field_values_for_issue: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1issue-field-values/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_issue_field_values: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repositories~1{repository_id}~1issues~1{issue_number}~1issue-field-values/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_issue_field_values: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repositories~1{repository_id}~1issues~1{issue_number}~1issue-field-values/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_issue_field_value: + operation: + $ref: >- + #/paths/~1repositories~1{repository_id}~1issues~1{issue_number}~1issue-field-values~1{issue_field_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_field_values/methods/list_issue_field_values_for_issue + insert: + - $ref: >- + #/components/x-stackQL-resources/issue_field_values/methods/add_issue_field_values + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_field_values/methods/delete_issue_field_value + replace: + - $ref: >- + #/components/x-stackQL-resources/issue_field_values/methods/set_issue_field_values + labels: + id: github.issues.labels + name: labels + title: Labels + methods: + list_labels_on_issue: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1labels/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_labels: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1labels/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_labels: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1labels/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_all_labels: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1labels/delete + response: + mediaType: application/json + openAPIDocKey: '204' + remove_label: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1labels~1{name}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list_labels_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_label: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1labels/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_label: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1labels~1{name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_label: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1labels~1{name}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_label: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1labels~1{name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_labels_for_milestone: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1milestones~1{milestone_number}~1labels/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/labels/methods/list_labels_on_issue + - $ref: '#/components/x-stackQL-resources/labels/methods/get_label' + - $ref: >- + #/components/x-stackQL-resources/labels/methods/list_labels_for_milestone + - $ref: >- + #/components/x-stackQL-resources/labels/methods/list_labels_for_repo + insert: + - $ref: '#/components/x-stackQL-resources/labels/methods/add_labels' + - $ref: '#/components/x-stackQL-resources/labels/methods/create_label' + update: + - $ref: '#/components/x-stackQL-resources/labels/methods/update_label' + delete: + - $ref: '#/components/x-stackQL-resources/labels/methods/remove_label' + - $ref: '#/components/x-stackQL-resources/labels/methods/remove_all_labels' + - $ref: '#/components/x-stackQL-resources/labels/methods/delete_label' + replace: + - $ref: '#/components/x-stackQL-resources/labels/methods/set_labels' + issue_parent: + id: github.issues.issue_parent + name: issue_parent + title: Issue Parent + methods: + get_parent: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1parent/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/issue_parent/methods/get_parent' + insert: [] + update: [] + delete: [] + replace: [] + issue_sub_issues: + id: github.issues.issue_sub_issues + name: issue_sub_issues + title: Issue Sub Issues + methods: + remove_sub_issue: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1sub_issue/delete + response: + mediaType: application/json + openAPIDocKey: '200' + list_sub_issues: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1sub_issues/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_sub_issue: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1sub_issues/post + response: + mediaType: application/json + openAPIDocKey: '201' + reprioritize_sub_issue: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1sub_issues~1priority/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_sub_issues/methods/list_sub_issues + insert: + - $ref: >- + #/components/x-stackQL-resources/issue_sub_issues/methods/add_sub_issue + update: + - $ref: >- + #/components/x-stackQL-resources/issue_sub_issues/methods/reprioritize_sub_issue + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_sub_issues/methods/remove_sub_issue + replace: [] + timeline: + id: github.issues.timeline + name: timeline + title: Timeline + methods: + list_events_for_timeline: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1timeline/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/timeline/methods/list_events_for_timeline + insert: [] + update: [] + delete: [] + replace: [] + milestones: + id: github.issues.milestones + name: milestones + title: Milestones + methods: + list_milestones: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1milestones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_milestone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1milestones/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_milestone: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1milestones~1{milestone_number}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_milestone: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1milestones~1{milestone_number}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_milestone: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1milestones~1{milestone_number}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/milestones/methods/get_milestone' + - $ref: >- + #/components/x-stackQL-resources/milestones/methods/list_milestones + insert: + - $ref: >- + #/components/x-stackQL-resources/milestones/methods/create_milestone + update: + - $ref: >- + #/components/x-stackQL-resources/milestones/methods/update_milestone + delete: + - $ref: >- + #/components/x-stackQL-resources/milestones/methods/delete_milestone + replace: [] + user_issues: + id: github.issues.user_issues + name: user_issues + title: User Issues + methods: + list_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1issues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user_issues/methods/list_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/licenses.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/licenses.yaml new file mode 100644 index 0000000..be6d6d8 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/licenses.yaml @@ -0,0 +1,691 @@ +openapi: 3.0.3 +info: + title: licenses API + description: View various OSS licenses. + version: 1.1.4 +paths: + /licenses: + get: + summary: Get all commonly used licenses + description: >- + Lists the most commonly used licenses on GitHub. For more information, + see "[Licensing a repository + ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + tags: + - licenses + operationId: licenses/get-all-commonly-used + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses + parameters: + - name: featured + in: query + required: false + schema: + type: boolean + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/license-simple' + examples: + default: + $ref: '#/components/examples/license-simple-items' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: licenses + subcategory: licenses + x-stackQL-resource: licenses + /licenses/{license}: + get: + summary: Get a license + description: >- + Gets information about a specific license. For more information, see + "[Licensing a repository + ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + tags: + - licenses + operationId: licenses/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/licenses/licenses#get-a-license + parameters: + - name: license + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/license' + examples: + default: + $ref: '#/components/examples/license' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: licenses + subcategory: licenses + x-stackQL-resource: licenses + /repos/{owner}/{repo}/license: + get: + summary: Get the license for a repository + description: >- + This method returns the contents of the repository's license file, if + one is detected. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw contents of the + license. + + - **`application/vnd.github.html+json`**: Returns the license contents + in HTML. Markup languages are rendered to HTML using GitHub's + open-source [Markup library](https://github.com/github/markup). + tags: + - licenses + operationId: licenses/get-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/license-content' + examples: + default: + $ref: '#/components/examples/license-content' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: licenses + subcategory: licenses + x-stackQL-resource: licenses +components: + schemas: + license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + license: + title: License + description: License + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + spdx_id: + type: string + example: MIT + nullable: true + url: + type: string + format: uri + example: https://api.github.com/licenses/mit + nullable: true + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + example: http://choosealicense.com/licenses/mit/ + description: + type: string + example: >- + A permissive license that is short and to the point. It lets people + do anything with your code with proper attribution and without + warranty. + implementation: + type: string + example: >- + Create a text file (typically named LICENSE or LICENSE.txt) in the + root of your source code and copy the text of the license into the + file. Replace [year] with the current year and [fullname] with the + name (or names) of the copyright holders. + permissions: + type: array + example: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + items: + type: string + conditions: + type: array + example: + - include-copyright + items: + type: string + limitations: + type: array + example: + - no-liability + items: + type: string + body: + type: string + example: > + + + The MIT License (MIT) + + + Copyright (c) [year] [fullname] + + + Permission is hereby granted, free of charge, to any person + obtaining a copy + + of this software and associated documentation files (the + "Software"), to deal + + in the Software without restriction, including without limitation + the rights + + to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell + + copies of the Software, and to permit persons to whom the Software + is + + furnished to do so, subject to the following conditions: + + + The above copyright notice and this permission notice shall be + included in all + + copies or substantial portions of the Software. + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR + + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, + + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT + SHALL THE + + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR + OTHER + + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, + ARISING FROM, + + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE + + SOFTWARE. + featured: + type: boolean + example: true + required: + - key + - name + - url + - spdx_id + - node_id + - html_url + - description + - implementation + - permissions + - conditions + - limitations + - body + - featured + license-content: + title: License Content + description: License Content + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + size: + type: integer + url: + type: string + format: uri + html_url: + type: string + format: uri + nullable: true + git_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + license: + $ref: '#/components/schemas/nullable-license-simple' + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + - license + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + code-scanning-ref: + type: string + description: >- + The Git reference, formatted as `refs/pull//merge`, + `refs/pull//head`, + + `refs/heads/` or simply ``. + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + git-ref: + name: ref + description: >- + The Git reference for the results you want to list. The `ref` for a + branch can be formatted either as `refs/heads/` or simply + ``. To reference a pull request use + `refs/pull//merge`. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-ref' + examples: + license-simple-items: + value: + - key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + - key: lgpl-3.0 + name: GNU Lesser General Public License v3.0 + spdx_id: LGPL-3.0 + url: https://api.github.com/licenses/lgpl-3.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: mpl-2.0 + name: Mozilla Public License 2.0 + spdx_id: MPL-2.0 + url: https://api.github.com/licenses/mpl-2.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: agpl-3.0 + name: GNU Affero General Public License v3.0 + spdx_id: AGPL-3.0 + url: https://api.github.com/licenses/agpl-3.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: unlicense + name: The Unlicense + spdx_id: Unlicense + url: https://api.github.com/licenses/unlicense + node_id: MDc6TGljZW5zZW1pdA== + - key: apache-2.0 + name: Apache License 2.0 + spdx_id: Apache-2.0 + url: https://api.github.com/licenses/apache-2.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: gpl-3.0 + name: GNU General Public License v3.0 + spdx_id: GPL-3.0 + url: https://api.github.com/licenses/gpl-3.0 + node_id: MDc6TGljZW5zZW1pdA== + license: + value: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + html_url: http://choosealicense.com/licenses/mit/ + description: >- + A permissive license that is short and to the point. It lets people do + anything with your code with proper attribution and without warranty. + implementation: >- + Create a text file (typically named LICENSE or LICENSE.txt) in the + root of your source code and copy the text of the license into the + file. Replace [year] with the current year and [fullname] with the + name (or names) of the copyright holders. + permissions: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + conditions: + - include-copyright + limitations: + - no-liability + body: > + + + The MIT License (MIT) + + + Copyright (c) [year] [fullname] + + + Permission is hereby granted, free of charge, to any person obtaining + a copy + + of this software and associated documentation files (the "Software"), + to deal + + in the Software without restriction, including without limitation the + rights + + to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell + + copies of the Software, and to permit persons to whom the Software is + + furnished to do so, subject to the following conditions: + + + The above copyright notice and this permission notice shall be + included in all + + copies or substantial portions of the Software. + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR + + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, + + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT + SHALL THE + + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, + ARISING FROM, + + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + IN THE + + SOFTWARE. + featured: true + license-content: + value: + name: LICENSE + path: LICENSE + sha: 401c59dcc4570b954dd6d345e76199e1f4e76266 + size: 1077 + url: >- + https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master + html_url: https://github.com/benbalter/gman/blob/master/LICENSE + git_url: >- + https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 + download_url: >- + https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true + type: file + content: | + VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu + IEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv + ZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0 + aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls + ZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg + d2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh + dGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg + cHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg + Y29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z + IHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK + c3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv + dmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj + ZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50 + aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ + UyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL + SU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ + TUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG + SVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO + R0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ + UklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF + UyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G + IENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP + VVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU + SEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K + encoding: base64 + _links: + self: >- + https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master + git: >- + https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 + html: https://github.com/benbalter/gman/blob/master/LICENSE + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + x-stackQL-resources: + licenses: + id: github.licenses.licenses + name: licenses + title: Licenses + methods: + get_all_commonly_used: + operation: + $ref: '#/paths/~1licenses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1licenses~1{license}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1license/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/licenses/methods/get_for_repo' + - $ref: '#/components/x-stackQL-resources/licenses/methods/get' + - $ref: >- + #/components/x-stackQL-resources/licenses/methods/get_all_commonly_used + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/markdown.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/markdown.yaml new file mode 100644 index 0000000..cc528e4 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/markdown.yaml @@ -0,0 +1,198 @@ +openapi: 3.0.3 +info: + title: markdown API + description: Render GitHub flavored Markdown + version: 1.1.4 +paths: + /markdown: + post: + summary: Render a Markdown document + description: >- + Depending on what is rendered in the Markdown, you may need to provide + additional token scopes for labels, such as `issues:read` or + `pull_requests:read`. + operationId: markdown/render + tags: + - markdown + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/markdown/markdown#render-a-markdown-document + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + text: + description: The Markdown text to render in HTML. + type: string + mode: + description: The rendering mode. + enum: + - markdown + - gfm + default: markdown + example: markdown + type: string + context: + description: >- + The repository context to use when creating references in + `gfm` mode. For example, setting `context` to + `octo-org/octo-repo` will change the text `#42` into an HTML + link to issue 42 in the `octo-org/octo-repo` repository. + type: string + required: + - text + type: object + examples: + default: + summary: Rendering markdown + value: + text: Hello **world** + responses: + '200': + description: Response + headers: + Content-Type: + $ref: '#/components/headers/content-type' + Content-Length: + example: '279' + schema: + type: string + X-CommonMarker-Version: + $ref: '#/components/headers/x-common-marker-version' + content: + text/html: + schema: + type: string + examples: + default: + summary: Example response + value:

Hello world

+ '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: markdown + subcategory: markdown + x-stackQL-resource: markdown + /markdown/raw: + post: + summary: Render a Markdown document in raw mode + description: >- + You must send Markdown as plain text (using a `Content-Type` header of + `text/plain` or `text/x-markdown`) to this endpoint, rather than using + JSON format. In raw mode, [GitHub Flavored + Markdown](https://github.github.com/gfm/) is not supported and Markdown + will be rendered in plain format like a README.md file. Markdown content + must be 400 KB or less. + operationId: markdown/render-raw + tags: + - markdown + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode + parameters: [] + requestBody: + required: false + content: + text/plain: + schema: + type: string + examples: + default: + value: + text: Hello **world** + text/x-markdown: + schema: + type: string + examples: + default: + summary: Rendering markdown + value: + text: Hello **world** + responses: + '200': + description: Response + headers: + X-CommonMarker-Version: + $ref: '#/components/headers/x-common-marker-version' + content: + text/html: + schema: + type: string + examples: + default: + summary: Example response + value:

Hello world

+ '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: markdown + subcategory: markdown + x-stackQL-resource: markdown +components: + responses: + not_modified: + description: Not modified + headers: + content-type: + example: text/html + schema: + type: string + x-common-marker-version: + example: 0.17.4 + schema: + type: string + x-stackQL-resources: + rendered_markdown: + id: github.markdown.rendered_markdown + name: rendered_markdown + title: Rendered Markdown + methods: + render: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1markdown/post' + response: + mediaType: text/html + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/rendered_markdown/methods/render' + update: [] + delete: [] + replace: [] + rendered_markdown_raw: + id: github.markdown.rendered_markdown_raw + name: rendered_markdown_raw + title: Rendered Markdown Raw + methods: + render_raw: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1markdown~1raw/post' + response: + mediaType: text/html + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/rendered_markdown_raw/methods/render_raw + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/meta.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/meta.yaml new file mode 100644 index 0000000..760bfa5 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/meta.yaml @@ -0,0 +1,724 @@ +openapi: 3.0.3 +info: + title: meta API + description: Endpoints that give information about the API. + version: 1.1.4 +paths: + /: + get: + summary: GitHub API Root + description: Get Hypermedia links to resources accessible in GitHub's REST API + tags: + - meta + operationId: meta/root + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/root' + examples: + default: + $ref: '#/components/examples/root' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#github-api-root + x-stackQL-resource: meta + /meta: + get: + summary: Get GitHub meta information + description: >- + Returns meta information about GitHub, including a list of GitHub's IP + addresses. For more information, see "[About GitHub's IP + addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." + + + The API's response also includes a list of GitHub's domain names. + + + The values shown in the documentation's response are example values. You + must always query the API directly to get the latest values. + + + > [!NOTE] + + > This endpoint returns both IPv4 and IPv6 addresses. However, not all + features support IPv6. You should refer to the specific documentation + for each feature to determine if IPv6 is supported. + tags: + - meta + operationId: meta/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-apiname-meta-information + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-overview' + examples: + default: + $ref: '#/components/examples/api-overview' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta + /octocat: + get: + summary: Get Octocat + description: Get the octocat as ASCII art + tags: + - meta + operationId: meta/get-octocat + parameters: + - name: s + in: query + description: The words to show in Octocat's speech bubble + schema: + type: string + required: false + responses: + '200': + description: Response + content: + application/octocat-stream: + schema: + type: string + examples: + default: + $ref: '#/components/examples/octocat' + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-octocat + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta + /versions: + get: + summary: Get all API versions + description: Get all supported GitHub API versions. + tags: + - meta + operationId: meta/get-all-versions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-all-api-versions + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + format: date + example: '2021-01-01' + examples: + default: + value: + - '2021-01-01' + - '2021-06-01' + - '2022-01-01' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta + /zen: + get: + summary: Get the Zen of GitHub + description: Get a random sentence from the Zen of GitHub + tags: + - meta + operationId: meta/get-zen + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-the-zen-of-github + responses: + '200': + description: Response + content: + text/plain: + schema: + type: string + examples: + default: + summary: Example response + value: Responsive is better than fast + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta +components: + schemas: + root: + type: object + properties: + current_user_url: + type: string + format: uri-template + current_user_authorizations_html_url: + type: string + format: uri-template + authorizations_url: + type: string + format: uri-template + code_search_url: + type: string + format: uri-template + commit_search_url: + type: string + format: uri-template + emails_url: + type: string + format: uri-template + emojis_url: + type: string + format: uri-template + events_url: + type: string + format: uri-template + feeds_url: + type: string + format: uri-template + followers_url: + type: string + format: uri-template + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + hub_url: + type: string + format: uri-template + deprecated: true + issue_search_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + label_search_url: + type: string + format: uri-template + notifications_url: + type: string + format: uri-template + organization_url: + type: string + format: uri-template + organization_repositories_url: + type: string + format: uri-template + organization_teams_url: + type: string + format: uri-template + public_gists_url: + type: string + format: uri-template + rate_limit_url: + type: string + format: uri-template + repository_url: + type: string + format: uri-template + repository_search_url: + type: string + format: uri-template + current_user_repositories_url: + type: string + format: uri-template + starred_url: + type: string + format: uri-template + starred_gists_url: + type: string + format: uri-template + topic_search_url: + type: string + format: uri-template + user_url: + type: string + format: uri-template + user_organizations_url: + type: string + format: uri-template + user_repositories_url: + type: string + format: uri-template + user_search_url: + type: string + format: uri-template + required: + - current_user_url + - current_user_authorizations_html_url + - authorizations_url + - code_search_url + - commit_search_url + - emails_url + - emojis_url + - events_url + - feeds_url + - followers_url + - following_url + - gists_url + - issue_search_url + - issues_url + - keys_url + - label_search_url + - notifications_url + - organization_url + - organization_repositories_url + - organization_teams_url + - public_gists_url + - rate_limit_url + - repository_url + - repository_search_url + - current_user_repositories_url + - starred_url + - starred_gists_url + - user_url + - user_organizations_url + - user_repositories_url + - user_search_url + x-github-breaking-changes: + - changeset: remove_authorizations_url_from_api_root + patch: + - op: remove + path: /properties/authorizations_url + - op: remove + path: /required/2 + version: '2026-03-10' + - changeset: remove_hub_url_from_api_root + patch: + properties: + hub_url: null + type: object + version: '2026-03-10' + api-overview: + title: Api Overview + description: Api Overview + type: object + properties: + verifiable_password_authentication: + type: boolean + example: true + ssh_key_fingerprints: + type: object + properties: + SHA256_RSA: + type: string + SHA256_DSA: + type: string + SHA256_ECDSA: + type: string + SHA256_ED25519: + type: string + ssh_keys: + type: array + items: + type: string + example: + - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ + hooks: + type: array + items: + type: string + example: + - 192.0.2.1 + github_enterprise_importer: + type: array + items: + type: string + example: + - 192.0.2.1 + web: + type: array + items: + type: string + example: + - 192.0.2.1 + api: + type: array + items: + type: string + example: + - 192.0.2.1 + git: + type: array + items: + type: string + example: + - 192.0.2.1 + packages: + type: array + items: + type: string + example: + - 192.0.2.1 + pages: + type: array + items: + type: string + example: + - 192.0.2.1 + importer: + type: array + items: + type: string + example: + - 192.0.2.1 + actions: + type: array + items: + type: string + example: + - 192.0.2.1 + actions_macos: + type: array + items: + type: string + example: + - 192.0.2.1 + codespaces: + type: array + items: + type: string + example: + - 192.0.2.1 + dependabot: + type: array + items: + type: string + example: + - 192.0.2.1 + copilot: + type: array + items: + type: string + example: + - 192.0.2.1 + domains: + type: object + properties: + website: + type: array + items: + type: string + example: + - example.com + codespaces: + type: array + items: + type: string + example: + - example.com + copilot: + type: array + items: + type: string + example: + - example.com + packages: + type: array + items: + type: string + example: + - example.com + actions: + type: array + items: + type: string + example: + - example.com + actions_inbound: + type: object + properties: + full_domains: + type: array + items: + type: string + example: + - example.com + wildcard_domains: + type: array + items: + type: string + example: + - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + example: + - example + services: + type: array + items: + type: string + example: + - example.com + required: + - verifiable_password_authentication + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + root: + value: + current_user_url: https://api.github.com/user + current_user_authorizations_html_url: https://github.com/settings/connections/applications{/client_id} + authorizations_url: https://api.github.com/authorizations + code_search_url: >- + https://api.github.com/search/code?q={query}{&page,per_page,sort,order} + commit_search_url: >- + https://api.github.com/search/commits?q={query}{&page,per_page,sort,order} + emails_url: https://api.github.com/user/emails + emojis_url: https://api.github.com/emojis + events_url: https://api.github.com/events + feeds_url: https://api.github.com/feeds + followers_url: https://api.github.com/user/followers + following_url: https://api.github.com/user/following{/target} + gists_url: https://api.github.com/gists{/gist_id} + hub_url: https://api.github.com/hub + issue_search_url: >- + https://api.github.com/search/issues?q={query}{&page,per_page,sort,order} + issues_url: https://api.github.com/issues + keys_url: https://api.github.com/user/keys + label_search_url: >- + https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page} + notifications_url: https://api.github.com/notifications + organization_url: https://api.github.com/orgs/{org} + organization_repositories_url: https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort} + organization_teams_url: https://api.github.com/orgs/{org}/teams + public_gists_url: https://api.github.com/gists/public + rate_limit_url: https://api.github.com/rate_limit + repository_url: https://api.github.com/repos/{owner}/{repo} + repository_search_url: >- + https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order} + current_user_repositories_url: https://api.github.com/user/repos{?type,page,per_page,sort} + starred_url: https://api.github.com/user/starred{/owner}{/repo} + starred_gists_url: https://api.github.com/gists/starred + topic_search_url: https://api.github.com/search/topics?q={query}{&page,per_page} + user_url: https://api.github.com/users/{user} + user_organizations_url: https://api.github.com/user/orgs + user_repositories_url: https://api.github.com/users/{user}/repos{?type,page,per_page,sort} + user_search_url: >- + https://api.github.com/search/users?q={query}{&page,per_page,sort,order} + x-github-breaking-changes: + - changeset: remove_authorizations_url_from_api_root + patch: + - op: remove + path: /value/authorizations_url + version: '2026-03-10' + - changeset: remove_hub_url_from_api_root + patch: + value: + hub_url: null + version: '2026-03-10' + api-overview: + value: + verifiable_password_authentication: true + ssh_key_fingerprints: + SHA256_RSA: 1234567890 + SHA256_DSA: 1234567890 + SHA256_ECDSA: 1234567890 + SHA256_ED25519: 1234567890 + ssh_keys: + - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ + - ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ + - ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ + hooks: + - 192.0.2.1 + github_enterprise_importer: + - 192.0.2.1 + web: + - 192.0.2.1 + api: + - 192.0.2.1 + git: + - 192.0.2.1 + packages: + - 192.0.2.1 + pages: + - 192.0.2.1 + importer: + - 192.0.2.1 + actions: + - 192.0.2.1 + actions_macos: + - 192.0.2.1 + dependabot: + - 192.0.2.1 + copilot: + - 192.0.2.1 + domains: + website: + - '*.example.com' + codespaces: + - '*.example.com' + copilot: + - '*.example.com' + packages: + - '*.example.com' + octocat: + value: |2 + MMM. .MMM + MMMMMMMMMMMMMMMMMMM + MMMMMMMMMMMMMMMMMMM ___________________________________ + MMMMMMMMMMMMMMMMMMMMM | | + MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. | + MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________| + MMMM::- -:::::::- -::MMMM |/ + MM~:~ 00~:::::~ 00~:~MM + .. MMMMM::.00:::+:::.00::MMMMM .. + .MM::::: ._. :::::MM. + MMMM;:::::;MMMM + -MM MMMMMMM + ^ M+ MMMMMMMMM + MMMMMMM MM MM MM + MM MM MM MM + MM MM MM MM + .~~MM~MM~MM~MM~~. + ~~~~MM:~MM~~~MM~:MM~~~~ + ~~~~~~==~==~~~==~==~~~~~~ + ~~~~~~==~==~==~==~~~~~~ + :~==~==~==~==~~ + x-stackQL-resources: + root: + id: github.meta.root + name: root + title: Root + methods: + root: + operation: + $ref: '#/paths/~1/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/root/methods/root' + insert: [] + update: [] + delete: [] + replace: [] + meta: + id: github.meta.meta + name: meta + title: Meta + methods: + get: + operation: + $ref: '#/paths/~1meta/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/meta/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + octocat: + id: github.meta.octocat + name: octocat + title: Octocat + methods: + get_octocat: + operation: + $ref: '#/paths/~1octocat/get' + response: + mediaType: application/octocat-stream + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + versions: + id: github.meta.versions + name: versions + title: Versions + methods: + get_all_versions: + operation: + $ref: '#/paths/~1versions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/versions/methods/get_all_versions' + insert: [] + update: [] + delete: [] + replace: [] + zen: + id: github.meta.zen + name: zen + title: Zen + methods: + get_zen: + operation: + $ref: '#/paths/~1zen/get' + response: + mediaType: text/plain + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/migrations.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/migrations.yaml new file mode 100644 index 0000000..40c449d --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/migrations.yaml @@ -0,0 +1,5016 @@ +openapi: 3.0.3 +info: + title: migrations API + description: Move projects to or from GitHub. + version: 1.1.4 +paths: + /orgs/{org}/migrations: + get: + summary: List organization migrations + description: >- + Lists the most recent migrations, including both exports (which can be + started through the REST API) and imports (which cannot be started using + the REST API). + + + A list of `repositories` is only returned for export migrations. + tags: + - migrations + operationId: migrations/list-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#list-organization-migrations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-with-short-org-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + post: + summary: Start an organization migration + description: Initiates the generation of a migration archive. + tags: + - migrations + operationId: migrations/start-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#start-an-organization-migration + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repositories: + type: array + description: >- + A list of arrays indicating which repositories should be + migrated. + items: + type: string + lock_repositories: + type: boolean + example: true + description: >- + Indicates whether repositories should be locked (to prevent + manipulation) while migrating data. + default: false + exclude_metadata: + type: boolean + description: >- + Indicates whether metadata should be excluded and only git + source should be included for the migration. + default: false + exclude_git_data: + type: boolean + description: >- + Indicates whether the repository git data should be excluded + from the migration. + default: false + exclude_attachments: + type: boolean + example: true + description: >- + Indicates whether attachments should be excluded from the + migration (to reduce migration archive file size). + default: false + exclude_releases: + type: boolean + example: true + description: >- + Indicates whether releases should be excluded from the + migration (to reduce migration archive file size). + default: false + exclude_owner_projects: + type: boolean + example: true + description: >- + Indicates whether projects owned by the organization or + users should be excluded. from the migration. + default: false + org_metadata_only: + type: boolean + example: true + description: >- + Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore + other flags). + default: false + exclude: + type: array + description: >- + Exclude related items from being returned in the response in + order to improve performance of the request. + items: + type: string + enum: + - repositories + required: + - repositories + examples: + default: + value: + repositories: + - github/Hello-World + lock_repositories: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-with-short-org-2' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}: + get: + summary: Get an organization migration status + description: |- + Fetches the status of a migration. + + The `state` of a migration can be one of the following values: + + * `pending`, which means the migration hasn't started yet. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `failed`, which means the migration failed. + tags: + - migrations + operationId: migrations/get-status-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string + responses: + '200': + description: |- + * `pending`, which means the migration hasn't started yet. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `failed`, which means the migration failed. + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-with-short-org' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}/archive: + get: + summary: Download an organization migration archive + description: Fetches the URL to a migration archive. + tags: + - migrations + operationId: migrations/download-archive-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + responses: + '302': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + delete: + summary: Delete an organization migration archive + description: >- + Deletes a previous migration archive. Migration archives are + automatically deleted after seven days. + tags: + - migrations + operationId: migrations/delete-archive-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock: + delete: + summary: Unlock an organization repository + description: >- + Unlocks a repository that was locked for migration. You should unlock + each migrated repository and [delete + them](https://docs.github.com/rest/repos/repos#delete-a-repository) when + the migration is complete and you no longer need the source data. + tags: + - migrations + operationId: migrations/unlock-repo-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/repo-name' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}/repositories: + get: + summary: List repositories in an organization migration + description: List all the repositories for this organization migration. + tags: + - migrations + operationId: migrations/list-repos-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-github-breaking-changes: + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/simple-repository' + version: '2026-03-10' + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + examples: null + version: '2026-03-10' + x-stackQL-resource: orgs + /repos/{owner}/{repo}/import: + get: + summary: Get an import status + description: >- + View the progress of an import. + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + + + **Import status** + + + This section includes details about the possible values of the `status` + field of the Import Progress response. + + + An import that does not have errors will progress through these steps: + + + * `detecting` - the "detection" step of the import is in progress + because the request did not include a `vcs` parameter. The import is + identifying the type of source control present at the URL. + + * `importing` - the "raw" step of the import is in progress. This is + where commit data is fetched from the original repository. The import + progress response will include `commit_count` (the total number of raw + commits that will be imported) and `percent` (0 - 100, the current + progress through the import). + + * `mapping` - the "rewrite" step of the import is in progress. This is + where SVN branches are converted to Git branches, and where author + updates are applied. The import progress response does not include + progress information. + + * `pushing` - the "push" step of the import is in progress. This is + where the importer updates the repository on GitHub. The import progress + response will include `push_percent`, which is the percent value + reported by `git push` when it is "Writing objects". + + * `complete` - the import is complete, and the repository is ready on + GitHub. + + + If there are problems, you will see one of these in the `status` field: + + + * `auth_failed` - the import requires authentication in order to + connect to the original repository. To update authentication for the + import, please see the [Update an + import](https://docs.github.com/rest/migrations/source-imports#update-an-import) + section. + + * `error` - the import encountered an error. The import progress + response will include the `failed_step` and an error message. Contact + [GitHub + Support](https://support.github.com/contact?tags=dotcom-rest-api) for + more information. + + * `detection_needs_auth` - the importer requires authentication for + the originating repository to continue detection. To update + authentication for the import, please see the [Update an + import](https://docs.github.com/rest/migrations/source-imports#update-an-import) + section. + + * `detection_found_nothing` - the importer didn't recognize any source + control at the URL. To resolve, [Cancel the + import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) + and + [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) + with the correct URL. + + * `detection_found_multiple` - the importer found several projects or + repositories at the provided URL. When this is the case, the Import + Progress response will also include a `project_choices` field with the + possible project choices as values. To update project choice, please see + the [Update an + import](https://docs.github.com/rest/migrations/source-imports#update-an-import) + section. + + + **The project_choices field** + + + When multiple projects are found at the provided URL, the response hash + will include a `project_choices` field, the value of which is an array + of hashes each representing a project choice. The exact key/value pairs + of the project hashes will differ depending on the version control type. + + + **Git LFS related fields** + + + This section includes details about Git LFS related fields that may be + present in the Import Progress response. + + + * `use_lfs` - describes whether the import has been opted in or out of + using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if + no action has been taken. + + * `has_large_files` - the boolean value describing whether files + larger than 100MB were found during the `importing` step. + + * `large_files_size` - the total size in gigabytes of files larger + than 100MB found in the originating repository. + + * `large_files_count` - the total number of files larger than 100MB + found in the originating repository. To see a list of these files, make + a "Get Large Files" request. + tags: + - migrations + operationId: migrations/get-import-status + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/source-imports#get-an-import-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + default: + $ref: '#/components/examples/import' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + put: + summary: Start an import + description: >- + Start a source import to a GitHub repository using GitHub Importer. + + Importing into a GitHub repository with GitHub Actions enabled is not + supported and will + + return a status `422 Unprocessable Entity` response. + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/start-import + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#start-an-import + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + vcs_url: + type: string + description: The URL of the originating repository. + vcs: + type: string + description: >- + The originating VCS type. Without this parameter, the import + job will take additional time to detect the VCS type before + beginning the import. This detection step will be reflected + in the response. + enum: + - subversion + - git + - mercurial + - tfvc + vcs_username: + type: string + description: >- + If authentication is required, the username to provide to + `vcs_url`. + vcs_password: + type: string + description: >- + If authentication is required, the password to provide to + `vcs_url`. + tfvc_project: + type: string + description: >- + For a tfvc import, the name of the project that is being + imported. + required: + - vcs_url + examples: + default: + value: + vcs: subversion + vcs_url: http://svn.mycompany.com/svn/myproject + vcs_username: octocat + vcs_password: secret + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + default: + $ref: '#/components/examples/import-2' + headers: + Location: + example: https://api.github.com/repos/spraints/socm/import + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + patch: + summary: Update an import + description: >- + An import can be updated with credentials or a project choice by passing + in the appropriate parameters in this API + + request. If no parameters are provided, the import will be restarted. + + + Some servers (e.g. TFS servers) can have several projects at a single + URL. In those cases the import progress will + + have the status `detection_found_multiple` and the Import Progress + response will include a `project_choices` array. + + You can select the project to import by providing one of the objects in + the `project_choices` array in the update request. + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/update-import + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/source-imports#update-an-import + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + vcs_username: + type: string + description: The username to provide to the originating repository. + vcs_password: + type: string + description: The password to provide to the originating repository. + vcs: + type: string + description: The type of version control system you are migrating from. + enum: + - subversion + - tfvc + - git + - mercurial + example: '"git"' + tfvc_project: + type: string + description: >- + For a tfvc import, the name of the project that is being + imported. + example: '"project1"' + nullable: true + examples: + example-1: + summary: Update authentication for an import + value: + vcs_username: octocat + vcs_password: secret + example-2: + summary: Updating the project choice + value: + vcs: tfvc + tfvc_project: project1 + human_name: project1 (tfs) + example-3: + summary: Restarting an import + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + example-1: + $ref: '#/components/examples/import-example-1' + example-2: + $ref: '#/components/examples/import-example-2' + example-3: + $ref: '#/components/examples/import-response' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + delete: + summary: Cancel an import + description: >- + Stop an import for a repository. + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/cancel-import + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/source-imports#cancel-an-import + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/authors: + get: + summary: Get commit authors + description: >- + Each type of source control system represents authors in a different + way. For example, a Git commit author has a display name and an email + address, but a Subversion commit author just has a username. The GitHub + Importer will make the author information valid, but the author might + not be correct. For example, it will change the bare Subversion username + `hubot` into something like `hubot + `. + + + This endpoint and the [Map a commit + author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) + endpoint allow you to provide correct Git author information. + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/get-commit-authors + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/source-imports#get-commit-authors + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/since-user' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/porter-author' + examples: + default: + $ref: '#/components/examples/porter-author-items' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/authors/{author_id}: + patch: + summary: Map a commit author + description: >- + Update an author's identity for the import. Your application can + continue updating authors any time before you push + + new commits to the repository. + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/map-commit-author + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/source-imports#map-a-commit-author + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: author_id + in: path + required: true + schema: + type: integer + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + email: + type: string + description: The new Git author email. + name: + type: string + description: The new Git author name. + additionalProperties: false + examples: + default: + value: + email: hubot@github.com + name: Hubot the Robot + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/porter-author' + examples: + default: + $ref: '#/components/examples/porter-author' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/large_files: + get: + summary: Get large files + description: >- + List files larger than 100MB found during the import + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/get-large-files + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#get-large-files + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/porter-large-file' + examples: + default: + $ref: '#/components/examples/porter-large-file-items' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/lfs: + patch: + summary: Update Git LFS preference + description: >- + You can import repositories from Subversion, Mercurial, and TFS that + include files larger than 100MB. This ability + + is powered by [Git LFS](https://git-lfs.com). + + + You can learn more about our LFS feature and working with large files + [on our help + + site](https://docs.github.com/repositories/working-with-files/managing-large-files). + + + > [!WARNING] + + > **Endpoint closing down notice:** Due to very low levels of usage and + available alternatives, this endpoint is closing down and will no longer + be available from 00:00 UTC on April 12, 2024. For more details and + alternatives, see the + [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/set-lfs-preference + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + use_lfs: + type: string + description: >- + Whether to store large files during the import. `opt_in` + means large files will be stored using Git LFS. `opt_out` + means large files will be removed during the import. + enum: + - opt_in + - opt_out + required: + - use_lfs + examples: + default: + value: + use_lfs: opt_in + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + default: + $ref: '#/components/examples/import' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /user/migrations: + get: + summary: List user migrations + description: Lists all migrations a user has started. + tags: + - migrations + operationId: migrations/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#list-user-migrations + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + post: + summary: Start a user migration + description: Initiates the generation of a user migration archive. + tags: + - migrations + operationId: migrations/start-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#start-a-user-migration + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + lock_repositories: + description: >- + Lock the repositories being migrated at the start of the + migration + example: true + readOnly: false + type: boolean + exclude_metadata: + description: >- + Indicates whether metadata should be excluded and only git + source should be included for the migration. + example: true + readOnly: false + type: boolean + exclude_git_data: + description: >- + Indicates whether the repository git data should be excluded + from the migration. + example: true + readOnly: false + type: boolean + exclude_attachments: + description: Do not include attachments in the migration + example: true + readOnly: false + type: boolean + exclude_releases: + description: Do not include releases in the migration + example: true + readOnly: false + type: boolean + exclude_owner_projects: + description: >- + Indicates whether projects owned by the organization or + users should be excluded. + example: true + readOnly: false + type: boolean + org_metadata_only: + type: boolean + example: true + description: >- + Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore + other flags). + default: false + exclude: + description: >- + Exclude attributes from the API response to improve + performance + example: + - repositories + readOnly: false + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string + repositories: + type: array + items: + description: Repository path, owner and name + example: acme/widgets + type: string + required: + - repositories + type: object + examples: + default: + value: + repositories: + - octocat/Hello-World + lock_repositories: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-2' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}: + get: + summary: Get a user migration status + description: >- + Fetches a single user migration. The response includes the `state` of + the migration, which can be one of the following values: + + + * `pending` - the migration hasn't started yet. + + * `exporting` - the migration is in progress. + + * `exported` - the migration finished successfully. + + * `failed` - the migration failed. + + + Once the migration has been `exported` you can [download the migration + archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). + tags: + - migrations + operationId: migrations/get-status-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/users#get-a-user-migration-status + parameters: + - $ref: '#/components/parameters/migration-id' + - name: exclude + in: query + required: false + schema: + type: array + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}/archive: + get: + summary: Download a user migration archive + description: >- + Fetches the URL to download the migration archive as a `tar.gz` file. + Depending on the resources your repository uses, the migration archive + can contain JSON files with data for these objects: + + + * attachments + + * bases + + * commit\_comments + + * issue\_comments + + * issue\_events + + * issues + + * milestones + + * organizations + + * projects + + * protected\_branches + + * pull\_request\_reviews + + * pull\_requests + + * releases + + * repositories + + * review\_comments + + * schema + + * users + + + The archive will also contain an `attachments` directory that includes + all attachment files uploaded to GitHub.com and a `repositories` + directory that contains the repository's Git data. + tags: + - migrations + operationId: migrations/get-archive-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/users#download-a-user-migration-archive + parameters: + - $ref: '#/components/parameters/migration-id' + responses: + '302': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + delete: + summary: Delete a user migration archive + description: >- + Deletes a previous migration archive. Downloadable migration archives + are automatically deleted after seven days. Migration metadata, which is + returned in the [List user + migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) + and [Get a user migration + status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) + endpoints, will continue to be available even after an archive is + deleted. + tags: + - migrations + operationId: migrations/delete-archive-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive + parameters: + - $ref: '#/components/parameters/migration-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}/repos/{repo_name}/lock: + delete: + summary: Unlock a user repository + description: >- + Unlocks a repository. You can lock repositories when you [start a user + migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). + Once the migration is complete you can unlock each repository to begin + using it again or [delete the + repository](https://docs.github.com/rest/repos/repos#delete-a-repository) + if you no longer need the source data. Returns a status of `404 Not + Found` if the repository is not locked. + tags: + - migrations + operationId: migrations/unlock-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository + parameters: + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/repo-name' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}/repositories: + get: + summary: List repositories for a user migration + description: Lists all the repositories for this user migration. + tags: + - migrations + operationId: migrations/list-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration + parameters: + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-github-breaking-changes: + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/simple-repository' + version: '2026-03-10' + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + examples: null + version: '2026-03-10' + x-stackQL-resource: users +components: + schemas: + migration: + title: Migration + description: A migration. + type: object + properties: + id: + type: integer + format: int64 + example: 79 + owner: + $ref: '#/components/schemas/nullable-simple-user' + guid: + type: string + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: + type: string + example: pending + lock_repositories: + type: boolean + example: true + exclude_metadata: + type: boolean + exclude_git_data: + type: boolean + exclude_attachments: + type: boolean + exclude_releases: + type: boolean + exclude_owner_projects: + type: boolean + org_metadata_only: + type: boolean + repositories: + type: array + description: >- + The repositories included in the migration. Only returned for export + migrations. + items: + $ref: '#/components/schemas/repository' + url: + type: string + format: uri + example: https://api.github.com/orgs/octo-org/migrations/79 + created_at: + type: string + format: date-time + example: '2015-07-06T15:33:38-07:00' + updated_at: + type: string + format: date-time + example: '2015-07-06T15:33:38-07:00' + node_id: + type: string + archive_url: + type: string + format: uri + exclude: + description: >- + Exclude related items from being returned in the response in order + to improve performance of the request. The array can include any of: + `"repositories"`. + type: array + items: + description: >- + Allowed values that can be passed to the exclude parameter. The + array can include any of: `"repositories"`. + type: string + required: + - id + - node_id + - owner + - guid + - state + - lock_repositories + - exclude_metadata + - exclude_git_data + - exclude_attachments + - exclude_releases + - exclude_owner_projects + - org_metadata_only + - repositories + - url + - created_at + - updated_at + x-github-breaking-changes: + - changeset: restrict_repo_fields_in_migration_resource + patch: + - op: replace + path: /properties/repositories + value: + type: array + description: >- + The repositories included in the migration. Only returned for + export migrations. + items: + $ref: '#/components/schemas/simple-repository' + version: '2026-03-10' + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + import: + title: Import + description: A repository import from an external source. + type: object + properties: + vcs: + type: string + nullable: true + use_lfs: + type: boolean + vcs_url: + description: The URL of the originating repository. + type: string + svc_root: + type: string + tfvc_project: + type: string + status: + type: string + enum: + - auth + - error + - none + - detecting + - choose + - auth_failed + - importing + - mapping + - waiting_to_push + - pushing + - complete + - setup + - unknown + - detection_found_multiple + - detection_found_nothing + - detection_needs_auth + status_text: + type: string + nullable: true + failed_step: + type: string + nullable: true + error_message: + type: string + nullable: true + import_percent: + type: integer + nullable: true + commit_count: + type: integer + nullable: true + push_percent: + type: integer + nullable: true + has_large_files: + type: boolean + large_files_size: + type: integer + large_files_count: + type: integer + project_choices: + type: array + items: + type: object + properties: + vcs: + type: string + tfvc_project: + type: string + human_name: + type: string + message: + type: string + authors_count: + type: integer + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + authors_url: + type: string + format: uri + repository_url: + type: string + format: uri + svn_root: + type: string + required: + - vcs + - vcs_url + - status + - url + - repository_url + - html_url + - authors_url + porter-author: + title: Porter Author + description: Porter Author + type: object + properties: + id: + type: integer + remote_id: + type: string + remote_name: + type: string + email: + type: string + name: + type: string + url: + type: string + format: uri + import_url: + type: string + format: uri + required: + - id + - remote_id + - remote_name + - email + - name + - url + - import_url + porter-large-file: + title: Porter Large File + description: Porter Large File + type: object + properties: + ref_name: + type: string + path: + type: string + oid: + type: string + size: + type: integer + required: + - oid + - path + - ref_name + - size + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + porter_maintenance: + description: Unavailable due to service under maintenance. + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + migration-id: + name: migration_id + description: The unique identifier of the migration. + in: path + required: true + schema: + type: integer + repo-name: + name: repo_name + description: repo_name parameter + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + since-user: + name: since + description: A user ID. Only return users with an ID greater than this ID. + in: query + required: false + schema: + type: integer + examples: + migration-with-short-org-items: + value: + - id: 79 + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + node_id: MDQ6VXNlcjE= + migration-with-short-org-2: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + migration-with-short-org: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: exported + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + import: + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: complete + status_text: Done + has_large_files: true + large_files_size: 132331036 + large_files_count: 1 + authors_count: 4 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-2: + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: importing + status_text: Importing... + has_large_files: false + large_files_size: 0 + large_files_count: 0 + authors_count: 0 + commit_count: 1042 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-example-1: + summary: Example 1 + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: detecting + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-example-2: + summary: Example 2 + value: + vcs: tfvc + use_lfs: true + vcs_url: http://tfs.mycompany.com/tfs/myproject + tfvc_project: project1 + status: importing + status_text: Importing... + has_large_files: false + large_files_size: 0 + large_files_count: 0 + authors_count: 0 + commit_count: 1042 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-response: + summary: Response + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: importing + status_text: Importing... + has_large_files: false + large_files_size: 0 + large_files_count: 0 + authors_count: 0 + commit_count: 1042 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + porter-author-items: + value: + - id: 2268557 + remote_id: nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: nobody + email: hubot@github.com + name: Hubot + url: https://api.github.com/repos/octocat/socm/import/authors/2268557 + import_url: https://api.github.com/repos/octocat/socm/import + - id: 2268558 + remote_id: svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: svner + email: svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef + name: svner + url: https://api.github.com/repos/octocat/socm/import/authors/2268558 + import_url: https://api.github.com/repos/octocat/socm/import + - id: 2268559 + remote_id: svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: svner@example.com + email: svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef + name: svner@example.com + url: https://api.github.com/repos/octocat/socm/import/authors/2268559 + import_url: https://api.github.com/repos/octocat/socm/import + porter-author: + value: + id: 2268557 + remote_id: nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: nobody + email: hubot@github.com + name: Hubot + url: https://api.github.com/repos/octocat/socm/import/authors/2268557 + import_url: https://api.github.com/repos/octocat/socm/import + porter-large-file-items: + value: + - ref_name: refs/heads/master + path: foo/bar/1 + oid: d3d9446802a44259755d38e6d163e820 + size: 10485760 + - ref_name: refs/heads/master + path: foo/bar/2 + oid: 6512bd43d9caa6e02c990b0a82652dca + size: 11534336 + - ref_name: refs/heads/master + path: foo/bar/3 + oid: c20ad4d76fe97759aa27a0c99bff6710 + size: 12582912 + migration-items: + value: + - id: 79 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + node_id: MDQ6VXNlcjE= + migration-2: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + migration: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: exported + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + org_metadata_only: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + migrations: + id: github.migrations.migrations + name: migrations + title: Migrations + methods: + list_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1migrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + start_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1migrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_status_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1migrations~1{migration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1migrations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + start_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1migrations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_status_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1migrations~1{migration_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/migrations/methods/get_status_for_org + - $ref: '#/components/x-stackQL-resources/migrations/methods/list_for_org' + - $ref: >- + #/components/x-stackQL-resources/migrations/methods/get_status_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/migrations/methods/list_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + orgs: + id: github.migrations.orgs + name: orgs + title: Orgs + methods: + delete_archive_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1migrations~1{migration_id}~1archive/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/orgs/methods/delete_archive_for_org + replace: [] + repos: + id: github.migrations.repos + name: repos + title: Repos + methods: + unlock_repo_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1migrations~1{migration_id}~1repos~1{repo_name}~1lock/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_repos_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1migrations~1{migration_id}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + unlock_repo_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1migrations~1{migration_id}~1repos~1{repo_name}~1lock/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_repos_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1migrations~1{migration_id}~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repos/methods/list_repos_for_org' + - $ref: >- + #/components/x-stackQL-resources/repos/methods/list_repos_for_authenticated_user + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/repos/methods/unlock_repo_for_org' + - $ref: >- + #/components/x-stackQL-resources/repos/methods/unlock_repo_for_authenticated_user + replace: [] + source_imports: + id: github.migrations.source_imports + name: source_imports + title: Source Imports + methods: + get_import_status: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import/get' + response: + mediaType: application/json + openAPIDocKey: '200' + start_import: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import/put' + response: + mediaType: application/json + openAPIDocKey: '201' + update_import: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel_import: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/source_imports/methods/get_import_status + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/source_imports/methods/update_import + delete: [] + replace: [] + commit_authors: + id: github.migrations.commit_authors + name: commit_authors + title: Commit Authors + methods: + get_commit_authors: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import~1authors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + map_commit_author: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1import~1authors~1{author_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/commit_authors/methods/get_commit_authors + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/commit_authors/methods/map_commit_author + delete: [] + replace: [] + lfs: + id: github.migrations.lfs + name: lfs + title: Lfs + methods: + get_large_files: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import~1large_files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_lfs_preference: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1import~1lfs/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/lfs/methods/get_large_files' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/lfs/methods/set_lfs_preference' + delete: [] + replace: [] + users: + id: github.migrations.users + name: users + title: Users + methods: + delete_archive_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1migrations~1{migration_id}~1archive/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/users/methods/delete_archive_for_authenticated_user + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/oidc.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/oidc.yaml new file mode 100644 index 0000000..65172e9 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/oidc.yaml @@ -0,0 +1,582 @@ +openapi: 3.0.3 +info: + title: oidc API + description: Endpoints to manage GitHub OIDC configuration using the REST API. + version: 1.1.4 +paths: + /enterprises/{enterprise}/actions/oidc/customization/properties/repo: + get: + summary: List OIDC custom property inclusions for an enterprise + description: >- + Lists the repository custom properties that are included in the OIDC + token for repository actions in an enterprise. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - oidc + operationId: oidc/list-oidc-custom-property-inclusions-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: A JSON array of OIDC custom property inclusions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + value: + - custom_property_name: environment + inclusion_source: enterprise + - custom_property_name: team + inclusion_source: enterprise + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: oidc + x-stackQL-resource: oidc + post: + summary: Create an OIDC custom property inclusion for an enterprise + description: >- + Adds a repository custom property to be included in the OIDC token for + repository actions in an enterprise. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - oidc + operationId: oidc/create-oidc-custom-property-inclusion-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion-input' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + responses: + '201': + description: OIDC custom property inclusion created + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '422': + description: Property inclusion already exists + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}: + delete: + summary: Delete an OIDC custom property inclusion for an enterprise + description: >- + Removes a repository custom property from being included in the OIDC + token for repository actions in an enterprise. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:enterprise` scope to use this endpoint. + tags: + - oidc + operationId: oidc/delete-oidc-custom-property-inclusion-for-enterprise + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - name: custom_property_name + in: path + required: true + schema: + type: string + description: The name of the custom property to remove from OIDC token inclusion + responses: + '204': + description: OIDC custom property inclusion deleted + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Property inclusion not found + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /orgs/{org}/actions/oidc/customization/properties/repo: + get: + summary: List OIDC custom property inclusions for an organization + description: >- + Lists the repository custom properties that are included in the OIDC + token for repository actions in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/list-oidc-custom-property-inclusions-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: A JSON array of OIDC custom property inclusions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + value: + - property_name: environment + - property_name: team + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + post: + summary: Create an OIDC custom property inclusion for an organization + description: >- + Adds a repository custom property to be included in the OIDC token for + repository actions in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/create-oidc-custom-property-inclusion-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion-input' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + responses: + '201': + description: OIDC custom property inclusion created + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '422': + description: Property inclusion already exists + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}: + delete: + summary: Delete an OIDC custom property inclusion for an organization + description: >- + Removes a repository custom property from being included in the OIDC + token for repository actions in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/delete-oidc-custom-property-inclusion-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: custom_property_name + in: path + required: true + schema: + type: string + description: The name of the custom property to remove from OIDC token inclusion + responses: + '204': + description: OIDC custom property inclusion deleted + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Property inclusion not found + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /orgs/{org}/actions/oidc/customization/sub: + get: + summary: >- + Get the customization template for an OIDC subject claim for an + organization + description: >- + Gets the customization template for an OpenID Connect (OIDC) subject + claim. + + + OAuth app tokens and personal access tokens (classic) need the + `read:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/get-oidc-custom-sub-template-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: A JSON serialized template for OIDC subject claim customization + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-sub' + examples: + default: + $ref: '#/components/examples/oidc-custom-sub' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + put: + summary: >- + Set the customization template for an OIDC subject claim for an + organization + description: >- + Creates or updates the customization template for an OpenID Connect + (OIDC) subject claim. + + + OAuth app tokens and personal access tokens (classic) need the + `write:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/update-oidc-custom-sub-template-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: >- + Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string + examples: + default: + $ref: '#/components/examples/oidc-custom-sub' + responses: + '201': + description: Empty response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: oidc + x-stackQL-resource: oidc +components: + schemas: + oidc-custom-property-inclusion: + title: Actions OIDC Custom Property Inclusion + description: An OIDC custom property inclusion for repository properties + type: object + properties: + custom_property_name: + type: string + description: The name of the custom property that is included in the OIDC token + inclusion_source: + type: string + description: >- + Whether the inclusion was defined at the organization or enterprise + level + enum: + - organization + - enterprise + example: organization + required: + - custom_property_name + - inclusion_source + oidc-custom-property-inclusion-input: + title: Actions OIDC Custom Property Inclusion Input + description: Input for creating an OIDC custom property inclusion + type: object + properties: + custom_property_name: + type: string + description: The name of the custom property to include in the OIDC token + required: + - custom_property_name + oidc-custom-sub: + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: >- + Array of unique strings. Each claim key can only contain + alphanumeric characters and underscores. + type: array + items: + type: string + required: + - include_claim_keys + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + oidc-custom-property-inclusion: + value: + custom_property_name: environment + oidc-custom-sub: + value: + include_claim_keys: + - repo + - context + x-stackQL-resources: + oidc_custom_property_inclusions: + id: github.oidc.oidc_custom_property_inclusions + name: oidc_custom_property_inclusions + title: Oidc Custom Property Inclusions + methods: + list_oidc_custom_property_inclusions_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1oidc~1customization~1properties~1repo/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_oidc_custom_property_inclusion_for_enterprise: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1oidc~1customization~1properties~1repo/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete_oidc_custom_property_inclusion_for_enterprise: + operation: + $ref: >- + #/paths/~1enterprises~1{enterprise}~1actions~1oidc~1customization~1properties~1repo~1{custom_property_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/oidc_custom_property_inclusions/methods/list_oidc_custom_property_inclusions_for_enterprise + insert: + - $ref: >- + #/components/x-stackQL-resources/oidc_custom_property_inclusions/methods/create_oidc_custom_property_inclusion_for_enterprise + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/oidc_custom_property_inclusions/methods/delete_oidc_custom_property_inclusion_for_enterprise + replace: [] + org_oidc_custom_property_inclusions: + id: github.oidc.org_oidc_custom_property_inclusions + name: org_oidc_custom_property_inclusions + title: Org Oidc Custom Property Inclusions + methods: + list_oidc_custom_property_inclusions_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1oidc~1customization~1properties~1repo/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_oidc_custom_property_inclusion_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1oidc~1customization~1properties~1repo/post + response: + mediaType: application/json + openAPIDocKey: '201' + delete_oidc_custom_property_inclusion_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1actions~1oidc~1customization~1properties~1repo~1{custom_property_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_oidc_custom_property_inclusions/methods/list_oidc_custom_property_inclusions_for_org + insert: + - $ref: >- + #/components/x-stackQL-resources/org_oidc_custom_property_inclusions/methods/create_oidc_custom_property_inclusion_for_org + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/org_oidc_custom_property_inclusions/methods/delete_oidc_custom_property_inclusion_for_org + replace: [] + oidc: + id: github.oidc.oidc + name: oidc + title: Oidc + methods: + get_oidc_custom_sub_template_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1oidc~1customization~1sub/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.include_claim_keys + update_oidc_custom_sub_template_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1actions~1oidc~1customization~1sub/put' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/oidc/methods/get_oidc_custom_sub_template_for_org + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/oidc/methods/update_oidc_custom_sub_template_for_org +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/orgs.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/orgs.yaml new file mode 100644 index 0000000..7468132 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/orgs.yaml @@ -0,0 +1,13402 @@ +openapi: 3.0.3 +info: + title: orgs API + description: Interact with organizations. + version: 1.1.4 +paths: + /organizations: + get: + summary: List organizations + description: >- + Lists all organizations, in the order that they were created. + + + > [!NOTE] + + > Pagination is powered exclusively by the `since` parameter. Use the + [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) + to get the URL for the next page of organizations. + tags: + - orgs + operationId: orgs/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-organizations + parameters: + - $ref: '#/components/parameters/since-org' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}: + get: + summary: Get an organization + description: >- + Gets information about an organization. + + + When the value of `two_factor_requirement_enabled` is `true`, the + organization requires all members, billing managers, outside + collaborators, guest collaborators, repository collaborators, or + everyone with access to any repository within the organization to enable + [two-factor + authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + + + To see the full details about an organization, the authenticated user + must be an organization owner. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to see the full details about an organization. + + + To see information about an organization's GitHub plan, GitHub Apps need + the `Organization plan` permission. + tags: + - orgs + operationId: orgs/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#get-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-full' + examples: + default-response: + $ref: '#/components/examples/organization-full' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + patch: + summary: Update an organization + description: >- + > [!WARNING] + + > **Closing down notice:** GitHub will replace and discontinue + `members_allowed_repository_creation_type` in favor of more granular + permissions. The new input parameters are + `members_can_create_public_repositories`, + `members_can_create_private_repositories` for all organizations and + `members_can_create_internal_repositories` for organizations associated + with an enterprise account using GitHub Enterprise Cloud or GitHub + Enterprise Server 2.20+. For more information, see the [blog + post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + + + > [!WARNING] + + > **Closing down notice:** Code security product enablement for new + repositories through the organization API is closing down. Please use + [code security + configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) + to set defaults instead. For more information on setting a default + security configuration, see the + [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + + + Updates the organization's profile and member privileges. + + + The authenticated user must be an organization owner to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` or `repo` scope to use this endpoint. + tags: + - orgs + operationId: orgs/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#update-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + billing_email: + type: string + description: Billing email address. This address is not publicized. + company: + type: string + description: The company name. + email: + type: string + description: The publicly visible email address. + twitter_username: + type: string + description: The Twitter username of the company. + location: + type: string + description: The location. + name: + type: string + description: The shorthand name of the company. + description: + type: string + description: >- + The description of the company. The maximum size is 160 + characters. + has_organization_projects: + type: boolean + description: Whether an organization can use organization projects. + has_repository_projects: + type: boolean + description: >- + Whether repositories that belong to the organization can use + repository projects. + default_repository_permission: + type: string + description: >- + Default permission level members have for organization + repositories. + enum: + - read + - write + - admin + - none + default: read + members_can_create_repositories: + type: boolean + description: >- + Whether of non-admin organization members can create + repositories. **Note:** A parameter can override this + parameter. See `members_allowed_repository_creation_type` in + this table for details. + default: true + members_can_create_internal_repositories: + type: boolean + description: >- + Whether organization members can create internal + repositories, which are visible to all enterprise members. + You can only allow members to create internal repositories + if your organization is associated with an enterprise + account using GitHub Enterprise Cloud or GitHub Enterprise + Server 2.20+. For more information, see "[Restricting + repository creation in your + organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + in the GitHub Help documentation. + members_can_create_private_repositories: + type: boolean + description: >- + Whether organization members can create private + repositories, which are visible to organization members with + permission. For more information, see "[Restricting + repository creation in your + organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + in the GitHub Help documentation. + members_can_create_public_repositories: + type: boolean + description: >- + Whether organization members can create public repositories, + which are visible to anyone. For more information, see + "[Restricting repository creation in your + organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" + in the GitHub Help documentation. + members_allowed_repository_creation_type: + type: string + description: >- + Specifies which types of repositories non-admin organization + members can create. `private` is only available to + repositories that are part of an organization on GitHub + Enterprise Cloud. + + **Note:** This parameter is closing down and will be removed + in the future. Its return value ignores internal + repositories. Using this parameter overrides values set in + `members_can_create_repositories`. See the parameter + deprecation notice in the operation description for details. + enum: + - all + - private + - none + members_can_create_pages: + type: boolean + description: >- + Whether organization members can create GitHub Pages sites. + Existing published sites will not be impacted. + default: true + members_can_create_public_pages: + type: boolean + description: >- + Whether organization members can create public GitHub Pages + sites. Existing published sites will not be impacted. + default: true + members_can_create_private_pages: + type: boolean + description: >- + Whether organization members can create private GitHub Pages + sites. Existing published sites will not be impacted. + default: true + members_can_fork_private_repositories: + type: boolean + description: >- + Whether organization members can fork private organization + repositories. + default: false + web_commit_signoff_required: + type: boolean + description: >- + Whether contributors to organization repositories are + required to sign off on commits they make through GitHub's + web interface. + default: false + blog: + type: string + example: '"http://github.blog"' + advanced_security_enabled_for_new_repositories: + type: boolean + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether GitHub Advanced Security is automatically enabled + for new repositories and repositories transferred to this + organization. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + You can check which security and analysis features are + currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether Dependabot alerts are automatically enabled for new + repositories and repositories transferred to this + organization. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + You can check which security and analysis features are + currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + dependabot_security_updates_enabled_for_new_repositories: + type: boolean + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether Dependabot security updates are automatically + enabled for new repositories and repositories transferred to + this organization. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + You can check which security and analysis features are + currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + dependency_graph_enabled_for_new_repositories: + type: boolean + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether dependency graph is automatically enabled for new + repositories and repositories transferred to this + organization. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + You can check which security and analysis features are + currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + secret_scanning_enabled_for_new_repositories: + type: boolean + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether secret scanning is automatically enabled for new + repositories and repositories transferred to this + organization. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + You can check which security and analysis features are + currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether secret scanning push protection is automatically + enabled for new repositories and repositories transferred to + this organization. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + You can check which security and analysis features are + currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + secret_scanning_push_protection_custom_link_enabled: + type: boolean + description: >- + Whether a custom link is shown to contributors who are + blocked from pushing a secret by push protection. + secret_scanning_push_protection_custom_link: + type: string + description: >- + If `secret_scanning_push_protection_custom_link_enabled` is + true, the URL that will be displayed to contributors who are + blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: >- + Controls whether or not deploy keys may be added and used + for repositories in the organization. + examples: + default: + value: + billing_email: mona@github.com + company: GitHub + email: mona@github.com + twitter_username: github + location: San Francisco + name: github + description: GitHub, the company. + default_repository_permission: read + members_can_create_repositories: true + members_allowed_repository_creation_type: all + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-full' + examples: + default: + $ref: '#/components/examples/organization-full' + '409': + $ref: '#/components/responses/conflict' + '422': + description: Validation failed + content: + application/json: + schema: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-github-breaking-changes: + - changeset: remove_secret_scanning_custom_link_enablement_field + patch: + requestBody: + content: + application/json: + schema: + properties: + secret_scanning_push_protection_custom_link_enabled: null + type: object + version: '2026-03-10' + x-stackQL-resource: orgs + delete: + summary: Delete an organization + description: >- + Deletes an organization and all its repositories. + + + The organization login will be unavailable for 90 days after deletion. + + + Please review the Terms of Service regarding account deletion before + using this endpoint: + + + https://docs.github.com/site-policy/github-terms/github-terms-of-service + operationId: orgs/delete + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#delete-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-github-breaking-changes: + - changeset: change_delete_organization_trade_compliance_respose_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: orgs + /orgs/{org}/artifacts/metadata/deployment-record: + post: + summary: Create an artifact deployment record + description: |- + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. + tags: + - orgs + operationId: orgs/create-artifact-deployment-record + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + minLength: 1 + maxLength: 256 + example: libfoo + digest: + type: string + description: The hex encoded digest of the artifact. + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + status: + type: string + description: >- + The status of the artifact. Can be either deployed or + decommissioned. + enum: + - deployed + - decommissioned + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + cluster: + type: string + description: The deployment cluster. + maxLength: 128 + deployment_name: + type: string + description: > + The unique identifier for the deployment represented by the + new record. To accommodate differing + + containers and namespaces within a cluster, the following + format is recommended: + + {namespaceName}-{deploymentName}-{containerName}. + maxLength: 256 + tags: + type: object + description: The tags associated with the deployment. + additionalProperties: + type: string + maxProperties: 5 + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + github_repository: + type: string + description: >- + The name of the GitHub repository associated with the + artifact. This should be used + + when there are no provenance attestations available for the + artifact. The repository + + must belong to the organization specified in the path + parameter. + + + If a provenance attestation is available for the artifact, + the API will use + + the repository information from the attestation instead of + this parameter. + minLength: 1 + maxLength: 100 + pattern: ^[A-Za-z0-9.\-_]+$ + example: my-github-repo + return_records: + type: boolean + default: true + description: > + If true, the endpoint will return the created or updated + record in the response body. + required: + - name + - digest + - status + - logical_environment + - deployment_name + examples: + default: + value: + name: awesome-image + digest: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + status: deployed + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: deployment-pod + tags: + data-access: sensitive + responses: + '200': + description: Artifact deployment record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + $ref: '#/components/schemas/artifact-deployment-record' + required: + - total_count + examples: + default: + $ref: '#/components/examples/artifact-deployment-record-list' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}: + post: + summary: Set cluster deployment records + description: >- + Set deployment records for a given cluster. + + If proposed records in the 'deployments' field have identical 'cluster', + 'logical_environment', + + 'physical_environment', and 'deployment_name' values as existing + records, the existing records will be updated. + + If no existing records match, new records will be created. + tags: + - orgs + operationId: orgs/set-cluster-deployment-records + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records + parameters: + - $ref: '#/components/parameters/org' + - name: cluster + in: path + description: The cluster name. + required: true + schema: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9._-]+$ + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + deployments: + type: array + description: The list of deployments to record. + maxItems: 1000 + items: + type: object + properties: + name: + type: string + description: > + The name of the artifact. Note that if multiple + deployments have identical 'digest' parameter values, + + the name parameter must also be identical across all + entries. + minLength: 1 + maxLength: 256 + digest: + type: string + description: > + The hex encoded digest of the artifact. Note that if + multiple deployments have identical 'digest' parameter + values, + + the name and version parameters must also be identical + across all entries. + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + version: + type: string + description: > + The artifact version. Note that if multiple + deployments have identical 'digest' parameter values, + + the version parameter must also be identical across + all entries. + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + status: + type: string + description: The deployment status of the artifact. + default: deployed + enum: + - deployed + - decommissioned + deployment_name: + type: string + description: > + The unique identifier for the deployment represented + by the new record. To accommodate differing + + containers and namespaces within a record set, the + following format is recommended: + + {namespaceName}-{deploymentName}-{containerName}. + + The deployment_name must be unique across all entries + in the deployments array. + minLength: 1 + maxLength: 256 + github_repository: + type: string + description: >- + The name of the GitHub repository associated with the + artifact. This should be used + + when there are no provenance attestations available + for the artifact. The repository + + must belong to the organization specified in the path + parameter. + + + If a provenance attestation is available for the + artifact, the API will use + + the repository information from the attestation + instead of this parameter. + maxLength: 100 + pattern: ^[A-Za-z0-9.\-_]+$ + example: my-github-repo + tags: + type: object + description: Key-value pairs to tag the deployment record. + additionalProperties: + type: string + runtime_risks: + type: array + description: >- + A list of runtime risks associated with the + deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + required: + - name + - deployment_name + - digest + return_records: + type: boolean + default: true + description: > + If true, the endpoint will return the set records in the + response body + required: + - logical_environment + - deployments + examples: + default: + value: + logical_environment: prod + physical_environment: pacific-east + deployments: + - name: awesome-image + digest: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + version: 2.1.0 + status: deployed + deployment_name: deployment-pod + tags: + runtime-risk: sensitive-data + responses: + '200': + description: | + Deployment records created or updated successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + $ref: '#/components/schemas/artifact-deployment-record' + required: + - total_count + examples: + default: + $ref: '#/components/examples/artifact-deployment-record-list' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + insufficient_repo_permissions: + value: + message: + cause: >- + artifact metadata write permission required on one or + more repositories + repositories: + - 123 + - 345 + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/metadata/storage-record: + post: + summary: Create artifact metadata storage record + description: >- + Create metadata storage records for artifacts associated with an + organization. + + This endpoint will create a new artifact storage record on behalf of any + artifact matching the provided digest and + + associated with a repository owned by the organization. + tags: + - orgs + operationId: orgs/create-artifact-storage-record + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + example: libfoo + minLength: 1 + maxLength: 256 + digest: + type: string + description: The digest of the artifact (algorithm:hex-encoded-digest). + example: sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + artifact_url: + type: string + format: uri + pattern: ^https:// + description: The URL where the artifact is stored. + example: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + path: + type: string + format: uri + description: The path of the artifact. + example: com/github/bar/libfoo-1.2.3 + registry_url: + type: string + format: uri + pattern: ^https:// + description: The base URL of the artifact registry. + example: https://reg.example.com/artifactory/ + minLength: 1 + repository: + type: string + description: The repository name within the registry. + example: bar + status: + type: string + description: The status of the artifact (e.g., active, inactive). + example: active + enum: + - active + - eol + - deleted + default: active + github_repository: + type: string + description: >- + The name of the GitHub repository associated with the + artifact. This should be used + + when there are no provenance attestations available for the + artifact. The repository + + must belong to the organization specified in the path + parameter. + + + If a provenance attestation is available for the artifact, + the API will use + + the repository information from the attestation instead of + this parameter. + minLength: 1 + maxLength: 100 + pattern: ^[A-Za-z0-9.\-_]+$ + example: my-github-repo + return_records: + type: boolean + default: true + description: > + If true, the endpoint will return the created record in the + response body. + required: + - name + - digest + - registry_url + examples: + default: + value: + name: libfoo + version: 1.2.3 + digest: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + responses: + '200': + description: Artifact metadata storage record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + example: 1 + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + nullable: true + registry_url: + type: string + repository: + type: string + nullable: true + status: + type: string + created_at: + type: string + updated_at: + type: string + required: + - total_count + examples: + default: + value: + total_count: 1 + storage_records: + - name: libfoo + digest: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records: + get: + summary: List artifact deployment records + description: >- + List deployment records for an artifact metadata associated with an + organization. + tags: + - orgs + operationId: orgs/list-artifact-deployment-records + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/subject-digest' + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + properties: + total_count: + description: >- + The number of deployment records for this digest and + organization + example: 3 + type: integer + deployment_records: + type: array + items: + $ref: '#/components/schemas/artifact-deployment-record' + examples: + default: + $ref: '#/components/examples/artifact-deployment-record-list' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/{subject_digest}/metadata/storage-records: + get: + summary: List artifact storage records + description: >- + List a collection of artifact storage records with a given subject + digest that are associated with repositories owned by an organization. + + + The collection of storage records returned by this endpoint is filtered + according to the authenticated user's permissions; if the authenticated + user cannot read a repository, the attestations associated with that + repository will not be included in the response. In addition, when using + a fine-grained access token the `content:read` permission is required. + tags: + - orgs + operationId: orgs/list-artifact-storage-records + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records + parameters: + - $ref: '#/components/parameters/org' + - name: subject_digest + description: >- + The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + example: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + schema: + type: string + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: >- + The number of storage records for this digest and + organization + example: 3 + type: integer + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + registry_url: + type: string + repository: + type: string + status: + type: string + created_at: + type: string + updated_at: + type: string + examples: + default: + value: + storage_records: + - name: libfoo-1.2.3 + digest: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/attestations/bulk-list: + post: + summary: List attestations by bulk subject digests + description: >- + List a collection of artifact attestations associated with any entry in + a list of subject digests owned by an organization. + + + The collection of attestations returned by this endpoint is filtered + according to the authenticated user's permissions; if the authenticated + user cannot read a repository, the attestations associated with that + repository will not be included in the response. In addition, when using + a fine-grained access token the `attestations:read` permission is + required. + + + **Please note:** in order to offer meaningful security benefits, an + attestation's signature and timestamps **must** be cryptographically + verified, and the identity of the attestation signer **must** be + validated. Attestations can be verified using the [GitHub CLI + `attestation verify` + command](https://cli.github.com/manual/gh_attestation_verify). For more + information, see [our guide on how to use artifact attestations to + establish a build's + provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations-bulk + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: >- + Optional filter for fetching attestations with a given + predicate type. + + This option accepts `provenance`, `sbom`, `release`, or + freeform text + + for custom predicate types. + required: + - subject_digests + examples: + default: + $ref: '#/components/examples/bulk-subject-digest-body' + withPredicateType: + $ref: >- + #/components/examples/bulk-subject-digest-body-with-predicate-type + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + nullable: true + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + $ref: '#/components/examples/list-attestations-bulk' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations_subject_digests: + additionalProperties: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /orgs/{org}/attestations/delete-request: + post: + summary: Delete attestations in bulk + description: >- + Delete artifact attestations in bulk by either subject digests or unique + ID. + tags: + - orgs + operationId: orgs/delete-attestations-bulk + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: >- + The request body must include either `subject_digests` or + `attestation_ids`, but not both. + properties: + subject_digests: + type: array + items: + type: string + description: >- + List of subject digests associated with the artifact + attestations to delete. + minItems: 1 + maxItems: 1024 + attestation_ids: + type: array + items: + type: integer + description: >- + List of unique IDs associated with the artifact attestations + to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - attestation_ids + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/digest/{subject_digest}: + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - orgs + operationId: orgs/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest + parameters: + - $ref: '#/components/parameters/org' + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/repositories: + get: + summary: List attestation repositories + description: >- + List repositories owned by the provided organization that have created + at least one attested artifact + + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/org' + - name: predicate_type + description: >- + Optional filter for fetching attestations with a given predicate + type. + + This option accepts `provenance`, `sbom`, `release`, or freeform + text + + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + $ref: '#/components/examples/list-attestation-repositories' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/{attestation_id}: + delete: + summary: Delete attestations by ID + description: >- + Delete an artifact attestation by unique ID that is associated with a + repository owned by an org. + tags: + - orgs + operationId: orgs/delete-attestations-by-id + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id + parameters: + - $ref: '#/components/parameters/org' + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/{subject_digest}: + get: + summary: List attestations + description: >- + List a collection of artifact attestations with a given subject digest + that are associated with repositories owned by an organization. + + + The collection of attestations returned by this endpoint is filtered + according to the authenticated user's permissions; if the authenticated + user cannot read a repository, the attestations associated with that + repository will not be included in the response. In addition, when using + a fine-grained access token the `attestations:read` permission is + required. + + + **Please note:** in order to offer meaningful security benefits, an + attestation's signature and timestamps **must** be cryptographically + verified, and the identity of the attestation signer **must** be + validated. Attestations can be verified using the [GitHub CLI + `attestation verify` + command](https://cli.github.com/manual/gh_attestation_verify). For more + information, see [our guide on how to use artifact attestations to + establish a build's + provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestations + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/org' + - name: subject_digest + description: >- + The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: predicate_type + description: >- + Optional filter for fetching attestations with a given predicate + type. + + This option accepts `provenance`, `sbom`, `release`, or freeform + text + + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + nullable: true + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: >- + The attestation's Sigstore Bundle. + + Refer to the [Sigstore Bundle + Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) + for more information. + repository_id: + type: integer + bundle_url: + type: string + initiator: + type: string + examples: + default: + $ref: '#/components/examples/list-attestations' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /orgs/{org}/blocks: + get: + summary: List users blocked by an organization + description: List the users blocked by an organization. + tags: + - orgs + operationId: orgs/list-blocked-users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + /orgs/{org}/blocks/{username}: + get: + summary: Check if a user is blocked by an organization + description: >- + Returns a 204 if the given user is blocked by the given organization. + Returns a 404 if the organization is not blocking the user, or if the + user account has been identified as spam by GitHub. + tags: + - orgs + operationId: orgs/check-blocked-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: If the user is blocked + '404': + description: If the user is not blocked + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + put: + summary: Block a user from an organization + description: >- + Blocks the given user on behalf of the specified organization and + returns a 204. If the organization cannot block the given user a 422 is + returned. + tags: + - orgs + operationId: orgs/block-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + delete: + summary: Unblock a user from an organization + description: Unblocks the given user on behalf of the specified organization. + tags: + - orgs + operationId: orgs/unblock-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + /orgs/{org}/failed_invitations: + get: + summary: List failed organization invitations + description: >- + The return hash contains `failed_at` and `failed_reason` fields which + represent the time at which the invitation failed and the reason for the + failure. + tags: + - orgs + operationId: orgs/list-failed-invitations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#list-failed-organization-invitations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/hooks: + get: + summary: List organization webhooks + description: >- + List webhooks for an organization. + + + The authenticated user must be an organization owner to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/list-webhooks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + post: + summary: Create an organization webhook + description: >- + Create a hook that posts payloads in JSON format. + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or + + edit webhooks that they did not create and users cannot list, view, or + edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/create-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Must be passed as "web". + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + username: + type: string + example: '"kdaigle"' + password: + type: string + example: '"password"' + required: + - url + events: + type: array + description: >- + Determines what + [events](https://docs.github.com/webhooks/event-payloads) + the hook is triggered for. Set to `["*"]` to receive all + possible events. + default: + - push + items: + type: string + active: + type: boolean + description: >- + Determines if notifications are sent when the webhook is + triggered. Set to `true` to send notifications. + default: true + required: + - name + - config + examples: + default: + value: + name: web + active: true + events: + - push + - pull_request + config: + url: http://example.com/webhook + content_type: json + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook' + headers: + Location: + example: https://api.github.com/orgs/octocat/hooks/1 + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}: + get: + summary: Get an organization webhook + description: >- + Returns a webhook configured in an organization. To get only the webhook + + `config` properties, see "[Get a webhook configuration for an + organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/get-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update an organization webhook + description: >- + Updates a webhook configured in an organization. When you update a + webhook, + + the `secret` will be overwritten. If you previously had a `secret` set, + you must + + provide the same `secret` or set a new `secret` or the secret will be + removed. If + + you are only updating individual webhook `config` properties, use + "[Update a webhook + + configuration for an + organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/update-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + required: + - url + events: + type: array + description: >- + Determines what + [events](https://docs.github.com/webhooks/event-payloads) + the hook is triggered for. + default: + - push + items: + type: string + active: + type: boolean + description: >- + Determines if notifications are sent when the webhook is + triggered. Set to `true` to send notifications. + default: true + name: + type: string + example: '"web"' + examples: + default: + value: + active: true + events: + - pull_request + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook-2' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + delete: + summary: Delete an organization webhook + description: >- + Delete a webhook for an organization. + + + The authenticated user must be an organization owner to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/delete-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/config: + get: + summary: Get a webhook configuration for an organization + description: >- + Returns the webhook configuration for an organization. To get more + information about the webhook, including the `active` state and + `events`, use "[Get an organization webhook + ](/rest/orgs/webhooks#get-an-organization-webhook)." + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/get-webhook-config-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a webhook configuration for an organization + description: >- + Updates the webhook configuration for an organization. To update more + information about the webhook, including the `active` state and + `events`, use "[Update an organization webhook + ](/rest/orgs/webhooks#update-an-organization-webhook)." + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/update-webhook-config-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + examples: + default: + summary: Update an existing webhook + value: + url: http://example.com/webhook + content_type: json + insecure_ssl: '0' + secret: '********' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/deliveries: + get: + summary: List deliveries for an organization webhook + description: >- + Returns a list of webhook deliveries for a webhook configured in an + organization. + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/list-webhook-deliveries + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/cursor' + - $ref: '#/components/parameters/webhook-delivery-status' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook-delivery-item' + examples: + default: + $ref: '#/components/examples/hook-delivery-items' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}: + get: + summary: Get a webhook delivery for an organization webhook + description: >- + Returns a delivery for a webhook configured in an organization. + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/get-webhook-delivery + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook-delivery' + examples: + default: + $ref: '#/components/examples/hook-delivery' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts: + post: + summary: Redeliver a delivery for an organization webhook + description: >- + Redeliver a delivery for a webhook configured in an organization. + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/redeliver-webhook-delivery + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/pings: + post: + summary: Ping an organization webhook + description: >- + This will trigger a [ping + event](https://docs.github.com/webhooks/#ping-event) + + to be sent to the hook. + + + You must be an organization owner to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need + `admin:org_hook` scope. OAuth apps cannot list, view, or edit + + webhooks that they did not create and users cannot list, view, or edit + webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/ping-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}: + get: + summary: Get route stats by actor + description: >- + Get API request count statistics for an actor broken down by route + within a specified time frame. + tags: + - orgs + operationId: api-insights/get-route-stats-by-actor + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-actor-type' + - $ref: '#/components/parameters/api-insights-actor-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/api-insights-route-stats-sort' + - $ref: '#/components/parameters/api-insights-api-route-substring' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-route-stats' + examples: + default: + $ref: '#/components/examples/api-insights-route-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/subject-stats: + get: + summary: Get subject stats + description: >- + Get API request statistics for all subjects within an organization + within a specified time frame. Subjects can be users or GitHub Apps. + tags: + - orgs + operationId: api-insights/get-subject-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/api-insights-sort' + - $ref: '#/components/parameters/api-insights-subject-name-substring' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-subject-stats' + examples: + default: + $ref: '#/components/examples/api-insights-subject-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/summary-stats: + get: + summary: Get summary stats + description: >- + Get overall statistics of API requests made within an organization by + all users and apps within a specified time frame. + tags: + - orgs + operationId: api-insights/get-summary-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-summary-stats' + examples: + default: + $ref: '#/components/examples/api-insights-summary-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/summary-stats/users/{user_id}: + get: + summary: Get summary stats by user + description: >- + Get overall statistics of API requests within the organization for a + user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-user-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-summary-stats' + examples: + default: + $ref: '#/components/examples/api-insights-summary-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}: + get: + summary: Get summary stats by actor + description: >- + Get overall statistics of API requests within the organization made by a + specific actor. Actors can be GitHub App installations, OAuth apps or + other tokens on behalf of a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-actor + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-actor-type' + - $ref: '#/components/parameters/api-insights-actor-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-summary-stats' + examples: + default: + $ref: '#/components/examples/api-insights-summary-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/time-stats: + get: + summary: Get time stats + description: >- + Get the number of API requests and rate-limited requests made within an + organization over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-timestamp-increment' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-time-stats' + examples: + default: + $ref: '#/components/examples/api-insights-time-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/time-stats/users/{user_id}: + get: + summary: Get time stats by user + description: >- + Get the number of API requests and rate-limited requests made within an + organization by a specific user over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-user-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-timestamp-increment' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-time-stats' + examples: + default: + $ref: '#/components/examples/api-insights-time-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}: + get: + summary: Get time stats by actor + description: >- + Get the number of API requests and rate-limited requests made within an + organization by a specific actor within a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-actor-type' + - $ref: '#/components/parameters/api-insights-actor-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-timestamp-increment' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-time-stats' + examples: + default: + $ref: '#/components/examples/api-insights-time-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/user-stats/{user_id}: + get: + summary: Get user stats + description: >- + Get API usage statistics within an organization for a user broken down + by the type of access. + tags: + - orgs + operationId: api-insights/get-user-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-user-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-user-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/api-insights-sort' + - $ref: '#/components/parameters/api-insights-actor-name-substring' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-user-stats' + examples: + default: + $ref: '#/components/examples/api-insights-user-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/installations: + get: + summary: List app installations for an organization + description: >- + Lists all GitHub Apps in an organization. The installation count + includes + + all GitHub Apps installed on repositories in the organization. + + + The authenticated user must be an organization owner to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:read` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-app-installations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - installations + properties: + total_count: + type: integer + installations: + type: array + items: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/invitations: + get: + summary: List pending organization invitations + description: >- + The return hash contains a `role` field which refers to the Organization + + Invitation role and will be one of the following values: + `direct_member`, `admin`, + + `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub + + member, the `login` field in the return hash will be `null`. + tags: + - orgs + operationId: orgs/list-pending-invitations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#list-pending-organization-invitations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: role + description: Filter invitations by their member role. + in: query + required: false + schema: + type: string + enum: + - all + - admin + - direct_member + - billing_manager + - hiring_manager + default: all + - name: invitation_source + description: Filter invitations by their invitation source. + in: query + required: false + schema: + type: string + enum: + - all + - member + - scim + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + post: + summary: Create an organization invitation + description: >- + Invite people to an organization by using their GitHub user ID or their + email address. In order to create invitations in an organization, the + authenticated user must be an organization owner. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - orgs + operationId: orgs/create-invitation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#create-an-organization-invitation + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + invitee_id: + type: integer + description: >- + **Required unless you provide `email`**. GitHub user ID for + the person you are inviting. + email: + type: string + description: >- + **Required unless you provide `invitee_id`**. Email address + of the person you are inviting, which can be an existing + GitHub user. + role: + type: string + description: |- + The role for the new member. + * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + enum: + - admin + - direct_member + - billing_manager + - reinstate + default: direct_member + team_ids: + type: array + description: Specify IDs for the teams you want to invite new members to. + items: + type: integer + examples: + default: + value: + email: octocat@github.com + role: direct_member + team_ids: + - 12 + - 26 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/invitations/{invitation_id}: + delete: + summary: Cancel an organization invitation + description: >- + Cancel an organization invitation. In order to cancel an organization + invitation, the authenticated user must be an organization owner. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + tags: + - orgs + operationId: orgs/cancel-invitation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/invitations/{invitation_id}/teams: + get: + summary: List organization invitation teams + description: >- + List all teams associated with an invitation. In order to see + invitations in an organization, the authenticated user must be an + organization owner. + tags: + - orgs + operationId: orgs/list-invitation-teams + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#list-organization-invitation-teams + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/invitation-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/issue-fields: + get: + summary: List issue fields for an organization + description: >- + Lists all issue fields for an organization. OAuth app tokens and + personal access tokens (classic) need the read:org scope to use this + endpoint. + tags: + - orgs + operationId: orgs/list-issue-fields + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-field' + examples: + default: + $ref: '#/components/examples/issue-field-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + post: + summary: Create issue field for an organization + description: >- + Creates a new issue field for an organization. + + + You can find out more about issue fields in [Managing issue fields in an + organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + + + To use this endpoint, the authenticated user must be an administrator + for the organization. OAuth app tokens and + + personal access tokens (classic) need the `admin:org` scope to use this + endpoint. + tags: + - orgs + operationId: orgs/create-issue-field + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-create-issue-field' + examples: + default: + value: + name: Priority + description: Level of importance for the issue + data_type: single_select + options: + - name: High + description: High priority + color: red + - name: Medium + description: Medium priority + color: yellow + - name: Low + description: Low priority + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-field' + examples: + default: + $ref: '#/components/examples/issue-field' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + /orgs/{org}/issue-fields/{issue_field_id}: + patch: + summary: Update issue field for an organization + description: >- + Updates an issue field for an organization. + + + You can find out more about issue fields in [Managing issue fields in an + organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + + + To use this endpoint, the authenticated user must be an administrator + for the organization. OAuth app tokens and + + personal access tokens (classic) need the `admin:org` scope to use this + endpoint. + tags: + - orgs + operationId: orgs/update-issue-field + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-field-id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-update-issue-field' + examples: + default: + summary: Update name and description + description: Update the name and description of an issue field + value: + name: Priority + description: Level of importance for the issue + update-single-select-options: + summary: Update single select options + description: Update the options for a single select issue field + value: + name: Status + description: Current status of the issue + options: + - name: Backlog + description: Items waiting to be prioritized + color: gray + priority: 1 + - name: In Progress + description: Currently being worked on + color: blue + priority: 2 + - name: Done + description: Completed work + color: green + priority: 3 + update-name-only: + summary: Update name only + description: Update only the name of an issue field + value: + name: Updated Field Name + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-field' + examples: + default: + $ref: '#/components/examples/issue-field' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + delete: + summary: Delete issue field for an organization + description: >- + Deletes an issue field for an organization. + + + You can find out more about issue fields in [Managing issue fields in an + organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + + + To use this endpoint, the authenticated user must be an administrator + for the organization. OAuth app tokens and + + personal access tokens (classic) need the `admin:org` scope to use this + endpoint. + tags: + - orgs + operationId: orgs/delete-issue-field + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-field-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + /orgs/{org}/issue-types: + get: + summary: List issue types for an organization + description: >- + Lists all issue types for an organization. OAuth app tokens and personal + access tokens (classic) need the read:org scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-issue-types + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-type' + examples: + default: + $ref: '#/components/examples/issue-type-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + post: + summary: Create issue type for an organization + description: >- + Create a new issue type for an organization. + + + You can find out more about issue types in [Managing issue types in an + organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + + To use this endpoint, the authenticated user must be an administrator + for the organization. OAuth app tokens and + + personal access tokens (classic) need the `admin:org` scope to use this + endpoint. + tags: + - orgs + operationId: orgs/create-issue-type + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-create-issue-type' + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-type' + examples: + default: + $ref: '#/components/examples/issue-type' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + /orgs/{org}/issue-types/{issue_type_id}: + put: + summary: Update issue type for an organization + description: >- + Updates an issue type for an organization. + + + You can find out more about issue types in [Managing issue types in an + organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + + To use this endpoint, the authenticated user must be an administrator + for the organization. OAuth app tokens and + + personal access tokens (classic) need the `admin:org` scope to use this + endpoint. + tags: + - orgs + operationId: orgs/update-issue-type + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-type-id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-update-issue-type' + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-type' + examples: + default: + $ref: '#/components/examples/issue-type' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + delete: + summary: Delete issue type for an organization + description: >- + Deletes an issue type for an organization. + + + You can find out more about issue types in [Managing issue types in an + organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + + To use this endpoint, the authenticated user must be an administrator + for the organization. OAuth app tokens and + + personal access tokens (classic) need the `admin:org` scope to use this + endpoint. + tags: + - orgs + operationId: orgs/delete-issue-type + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-type-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + /orgs/{org}/members: + get: + summary: List organization members + description: >- + List all users who are members of an organization. If the authenticated + user is also a member of this organization then both concealed and + public members will be returned. + tags: + - orgs + operationId: orgs/list-members + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-organization-members + parameters: + - $ref: '#/components/parameters/org' + - name: filter + description: >- + Filter members returned in the list. `2fa_disabled` means that only + members without [two-factor + authentication](https://github.com/blog/1614-two-factor-authentication) + enabled will be returned. `2fa_insecure` means that only members + with [insecure 2FA + methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + will be returned. These options are only available for organization + owners. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 2fa_insecure + - all + default: all + - name: role + description: Filter members returned by their role. + in: query + required: false + schema: + type: string + enum: + - all + - admin + - member + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/members/{username}: + get: + summary: Check organization membership for a user + description: Check if a user is, publicly or privately, a member of the organization. + tags: + - orgs + operationId: orgs/check-membership-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response if requester is an organization member and user is a member + '302': + description: Response if requester is not an organization member + headers: + Location: + example: https://api.github.com/orgs/github/public_members/pezra + schema: + type: string + '404': + description: >- + Not Found if requester is an organization member and user is not a + member + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + delete: + summary: Remove an organization member + description: >- + Removing a user from this list will remove them from all teams and they + will no longer have any access to the organization's repositories. + + + > [!NOTE] + + > If a user has both direct membership in the organization as well as + indirect membership via an enterprise team, only their direct membership + will be removed. Their indirect membership via an enterprise team + remains until the user is removed from the enterprise team. + tags: + - orgs + operationId: orgs/remove-member + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#remove-an-organization-member + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-github-breaking-changes: + - changeset: change_remove_member_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: members + /orgs/{org}/memberships/{username}: + get: + summary: Get organization membership for a user + description: >- + In order to get a user's membership with an organization, the + authenticated user must be an organization member. The `state` parameter + in the response can be used to identify the user's membership status. + tags: + - orgs + operationId: orgs/get-membership-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + response-if-user-has-an-active-admin-membership-with-organization: + $ref: >- + #/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + put: + summary: Set organization membership for a user + description: >- + Only authenticated organization owners can add a member to the + organization or update the member's role. + + + * If the authenticated user is _adding_ a member to the organization, + the invited user will receive an email inviting them to the + organization. The user's [membership + status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) + will be `pending` until they accept the invitation. + + * Authenticated users can _update_ a user's membership by passing the + `role` parameter. If the authenticated user changes a member's role to + `admin`, the affected user will receive an email notifying them that + they've been made an organization owner. If the authenticated user + changes an owner's role to `member`, no email will be sent. + + + **Rate limits** + + + To prevent abuse, organization owners are limited to creating 50 + organization invitations for an organization within a 24 hour period. If + the organization is more than one month old or on a paid plan, the limit + is 500 invitations per 24 hour period. + tags: + - orgs + operationId: orgs/set-membership-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: >- + The role to give the user in the organization. Can be one + of: + * `admin` - The user will become an owner of the organization. + * `member` - The user will become a non-owner member of the organization. + enum: + - admin + - member + default: member + examples: + default: + summary: Set an organization membership role for a user + value: + role: member + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + response-if-user-already-had-membership-with-organization: + $ref: >- + #/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-github-breaking-changes: + - changeset: change_update_user_membership_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: members + delete: + summary: Remove organization membership for a user + description: >- + In order to remove a user's membership with an organization, the + authenticated user must be an organization owner. + + + If the specified user is an active member of the organization, this will + remove them from the organization. If the specified user has been + invited to the organization, this will cancel their invitation. The + specified user will receive an email notification in both cases. + + + > [!NOTE] + + > If a user has both direct membership in the organization as well as + indirect membership via an enterprise team, only their direct membership + will be removed. Their indirect membership via an enterprise team + remains until the user is removed from the enterprise team. + tags: + - orgs + operationId: orgs/remove-membership-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/organization-roles: + get: + summary: Get all organization roles for an organization + description: >- + Lists the organization roles available in this organization. For more + information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + To use this endpoint, the authenticated user must be one of: + + + - An administrator for the organization. + + - An organization member (or a member of a team) assigned a custom + organization role that includes the **View organization roles** + (`read_organization_custom_org_role`) permission. For more information, + see "[Permissions for organization + access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-org-roles + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response - list of organization roles + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + description: >- + The total number of organization roles available to the + organization. + roles: + type: array + description: >- + The list of organization roles available to the + organization. + items: + $ref: '#/components/schemas/organization-role' + examples: + default: + $ref: '#/components/examples/organization-role-list' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/teams/{team_slug}: + delete: + summary: Remove all organization roles for a team + description: >- + Removes all assigned organization roles from a team. For more + information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + The authenticated user must be an administrator for the organization to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-org-roles-team + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}: + put: + summary: Assign an organization role to a team + description: >- + Assigns an organization role to a team in an organization. For more + information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + The authenticated user must be an administrator for the organization to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/assign-team-to-org-role + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + '404': + description: Response if the organization, team or role does not exist. + '422': + description: >- + Response if the organization roles feature is not enabled for the + organization, or validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + delete: + summary: Remove an organization role from a team + description: >- + Removes an organization role from a team. For more information on + organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + The authenticated user must be an administrator for the organization to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-org-role-team + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/users/{username}: + delete: + summary: Remove all organization roles for a user + description: >- + Revokes all assigned organization roles from a user. For more + information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + The authenticated user must be an administrator for the organization to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-org-roles-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/users/{username}/{role_id}: + put: + summary: Assign an organization role to a user + description: >- + Assigns an organization role to a member of an organization. For more + information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + The authenticated user must be an administrator for the organization to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/assign-user-to-org-role + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + '404': + description: Response if the organization, user or role does not exist. + '422': + description: >- + Response if the organization roles feature is not enabled enabled + for the organization, the validation failed, or the user is not an + organization member. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + delete: + summary: Remove an organization role from a user + description: >- + Remove an organization role from a user. For more information on + organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + The authenticated user must be an administrator for the organization to + use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-org-role-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/{role_id}: + get: + summary: Get an organization role + description: >- + Gets an organization role that is available to this organization. For + more information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + To use this endpoint, the authenticated user must be one of: + + + - An administrator for the organization. + + - An organization member (or a member of a team) assigned a custom + organization role that includes the **View organization roles** + (`read_organization_custom_org_role`) permission. For more information, + see "[Permissions for organization + access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/get-org-role + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/role-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-role' + examples: + default: + $ref: '#/components/examples/organization-role' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/{role_id}/teams: + get: + summary: List teams that are assigned to an organization role + description: >- + Lists the teams that are assigned to an organization role. For more + information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + To use this endpoint, you must be an administrator for the organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-org-role-teams + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/role-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response - List of assigned teams + content: + application/json: + schema: + type: array + description: List of teams assigned to the organization role + items: + $ref: '#/components/schemas/team-role-assignment' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + description: Response if the organization or role does not exist. + '422': + description: >- + Response if the organization roles feature is not enabled or + validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/{role_id}/users: + get: + summary: List users that are assigned to an organization role + description: >- + Lists organization members that are assigned to an organization role. + For more information on organization roles, see "[Using organization + roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + + To use this endpoint, you must be an administrator for the organization. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-org-role-users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/role-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response - List of assigned users + content: + application/json: + schema: + type: array + description: List of users assigned to the organization role + items: + $ref: '#/components/schemas/user-role-assignment' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + description: Response if the organization or role does not exist. + '422': + description: >- + Response if the organization roles feature is not enabled or + validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/outside_collaborators: + get: + summary: List outside collaborators for an organization + description: List all users who are outside collaborators of an organization. + tags: + - orgs + operationId: orgs/list-outside-collaborators + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: filter + description: >- + Filter the list of outside collaborators. `2fa_disabled` means that + only outside collaborators without [two-factor + authentication](https://github.com/blog/1614-two-factor-authentication) + enabled will be returned. `2fa_insecure` means that only outside + collaborators with [insecure 2FA + methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + will be returned. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 2fa_insecure + - all + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: outside-collaborators + x-stackQL-resource: outside_collaborators + /orgs/{org}/outside_collaborators/{username}: + put: + summary: Convert an organization member to outside collaborator + description: >- + When an organization member is converted to an outside collaborator, + they'll only have access to the repositories that their current team + membership allows. The user will no longer be a member of the + organization. For more information, see "[Converting an organization + member to an outside + collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". + Converting an organization member to an outside collaborator may be + restricted by enterprise administrators. For more information, see + "[Enforcing repository management policies in your + enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + tags: + - orgs + operationId: orgs/convert-member-to-outside-collaborator + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + async: + type: boolean + description: >- + When set to `true`, the request will be performed + asynchronously. Returns a 202 status code when the job is + successfully queued. + default: false + examples: + '202': + summary: Status code 202, asynchronous request + value: + async: true + '204': + summary: Status code 204, synchronous request + value: null + responses: + '202': + description: User is getting converted asynchronously + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + '202': + value: null + '204': + description: User was converted + '403': + description: >- + Forbidden if user is the last owner of the organization, not a + member of the organization, or if the enterprise enforces a policy + for inviting outside collaborators. For more information, see + "[Enforcing repository management policies in your + enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: outside-collaborators + x-stackQL-resource: outside_collaborators + delete: + summary: Remove outside collaborator from an organization + description: >- + Removing a user from this list will remove them from all the + organization's repositories. + tags: + - orgs + operationId: orgs/remove-outside-collaborator + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '422': + description: Unprocessable Entity if user is a member of the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-user-is-a-member-of-the-organization: + value: + message: >- + You cannot specify an organization member to remove as an + outside collaborator. + documentation_url: >- + https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: outside-collaborators + x-stackQL-resource: outside_collaborators + /orgs/{org}/personal-access-token-requests: + get: + summary: >- + List requests to access organization resources with fine-grained + personal access tokens + description: >- + Lists requests from organization members to access organization + resources with a fine-grained personal access token. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grant-requests + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/personal-access-token-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/personal-access-token-owner' + - $ref: '#/components/parameters/personal-access-token-repository' + - $ref: '#/components/parameters/personal-access-token-permission' + - $ref: '#/components/parameters/personal-access-token-before' + - $ref: '#/components/parameters/personal-access-token-after' + - $ref: '#/components/parameters/personal-access-token-token-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: >- + #/components/schemas/organization-programmatic-access-grant-request + examples: + default: + $ref: '#/components/examples/org-pat-grant-request-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + post: + summary: >- + Review requests to access organization resources with fine-grained + personal access tokens + description: >- + Approves or denies multiple pending requests to access organization + resources via a fine-grained personal access token. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/review-pat-grant-requests-in-bulk + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pat_request_ids: + type: array + description: >- + Unique identifiers of the requests for access via + fine-grained personal access token. Must be formed of + between 1 and 100 `pat_request_id` values. + items: + type: integer + minItems: 1 + maxItems: 100 + action: + type: string + description: Action to apply to the requests. + enum: + - approve + - deny + reason: + type: string + description: >- + Reason for approving or denying the requests. Max 1024 + characters. + maxLength: 1024 + nullable: true + required: + - action + examples: + '204': + summary: Example of denying a request + value: + pat_request_ids: + - 42 + - 73 + action: deny + reason: Access is too broad. + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-token-requests/{pat_request_id}: + post: + summary: >- + Review a request to access organization resources with a fine-grained + personal access token + description: >- + Approves or denies a pending request to access organization resources + via a fine-grained personal access token. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/review-pat-grant-request + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token + parameters: + - $ref: '#/components/parameters/org' + - name: pat_request_id + in: path + description: >- + Unique identifier of the request for access via fine-grained + personal access token. + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: Action to apply to the request. + enum: + - approve + - deny + reason: + type: string + description: >- + Reason for approving or denying the request. Max 1024 + characters. + maxLength: 1024 + nullable: true + required: + - action + examples: + '204': + summary: Example of denying a request + value: + action: deny + reason: This request is denied because the access is too broad. + responses: + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories: + get: + summary: >- + List repositories requested to be accessed by a fine-grained personal + access token + description: >- + Lists the repositories a fine-grained personal access token request is + requesting access to. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grant-request-repositories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token + parameters: + - $ref: '#/components/parameters/org' + - name: pat_request_id + in: path + description: >- + Unique identifier of the request for access via fine-grained + personal access token. + required: true + schema: + type: integer + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-tokens: + get: + summary: >- + List fine-grained personal access tokens with access to organization + resources + description: >- + Lists approved fine-grained personal access tokens owned by organization + members that can access organization resources. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grants + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/personal-access-token-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/personal-access-token-owner' + - $ref: '#/components/parameters/personal-access-token-repository' + - $ref: '#/components/parameters/personal-access-token-permission' + - $ref: '#/components/parameters/personal-access-token-before' + - $ref: '#/components/parameters/personal-access-token-after' + - $ref: '#/components/parameters/personal-access-token-token-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-programmatic-access-grant' + examples: + default: + $ref: '#/components/examples/org-pat-grant-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + post: + summary: >- + Update the access to organization resources via fine-grained personal + access tokens + description: >- + Updates the access organization members have to organization resources + via fine-grained personal access tokens. Limited to revoking a token's + existing access. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-accesses + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: Action to apply to the fine-grained personal access token. + enum: + - revoke + pat_ids: + description: The IDs of the fine-grained personal access tokens. + type: array + items: + type: integer + description: >- + Unique identifier of the fine-grained personal access + token. + minItems: 1 + maxItems: 100 + required: + - action + - pat_ids + examples: + '204': + summary: Example of revoking a fine-grained personal access token. + value: + action: revoke + pat_ids: + - 1296269 + - 1296280 + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-tokens/{pat_id}: + post: + summary: >- + Update the access a fine-grained personal access token has to + organization resources + description: >- + Updates the access an organization member has to organization resources + via a fine-grained personal access token. Limited to revoking the + token's existing access. Limited to revoking a token's existing access. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-access + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/fine-grained-personal-access-token-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: Action to apply to the fine-grained personal access token. + enum: + - revoke + required: + - action + examples: + '204': + summary: Example of revoking a fine-grained personal access token. + value: + action: revoke + responses: + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-tokens/{pat_id}/repositories: + get: + summary: List repositories a fine-grained personal access token has access to + description: >- + Lists the repositories a fine-grained personal access token has access + to. + + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grant-repositories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to + parameters: + - $ref: '#/components/parameters/org' + - name: pat_id + in: path + description: Unique identifier of the fine-grained personal access token. + required: true + schema: + type: integer + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/properties/schema: + get: + summary: Get all custom properties for an organization + description: |- + Gets all custom properties defined for an organization. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-get-organization-definitions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-properties' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + patch: + summary: Create or update custom properties for an organization + description: >- + Creates new or updates existing custom properties defined for an + organization in a batch. + + + If the property already exists, the existing property will be replaced + with the new values. + + Missing optional values will fall back to default values, previous + values will be overwritten. + + E.g. if a property exists with `values_editable_by: org_and_repo_actors` + and it's updated without specifying `values_editable_by`, it will be + updated to default value `org_actors`. + + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + tags: + - orgs + operationId: >- + orgs/custom-properties-for-repos-create-or-update-organization-definitions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of custom properties to create or update. + items: + $ref: '#/components/schemas/custom-property' + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + type: object + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-properties' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + /orgs/{org}/properties/schema/{custom_property_name}: + get: + summary: Get a custom property for an organization + description: |- + Gets a custom property that is defined for an organization. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-get-organization-definition + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/custom-property-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-property' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + put: + summary: Create or update a custom property for an organization + description: >- + Creates a new or updates an existing custom property that is defined for + an organization. + + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + + - A user, or a user on a team, with the fine-grained permission of + `custom_properties_org_definitions_manager` in the organization. + tags: + - orgs + operationId: >- + orgs/custom-properties-for-repos-create-or-update-organization-definition + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/custom-property-name' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/custom-property-set-payload' + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-property' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + delete: + summary: Remove a custom property for an organization + description: |- + Removes a custom property that is defined for an organization. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-delete-organization-definition + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/custom-property-name' + responses: + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + /orgs/{org}/properties/values: + get: + summary: List custom property values for organization repositories + description: >- + Lists organization repositories with all of their custom property + values. + + Organization members can read these properties. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-get-organization-values + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: repository_query + description: >- + Finds repositories in the organization with a query containing one + or more search keywords and qualifiers. Qualifiers allow you to + limit your search to specific areas of GitHub. The REST API supports + the same qualifiers as the web interface for GitHub. To learn more + about the format of the query, see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + See "[Searching for + repositories](https://docs.github.com/articles/searching-for-repositories/)" + for a detailed list of qualifiers. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/org-repo-custom-property-values' + examples: + default: + $ref: '#/components/examples/org-repo-custom-property-values' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + patch: + summary: Create or update custom property values for organization repositories + description: >- + Create new or update existing custom property values for repositories in + a batch that belong to an organization. + + Each target repository will have its custom property values updated to + match the values provided in the request. + + + A maximum of 30 repositories can be updated in a single request. + + + Using a value of `null` for a custom property will remove or 'unset' the + property value from the repository. + + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-create-or-update-organization-values + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_names: + type: array + description: >- + The names of repositories that the custom property values + will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: >- + List of custom property names and associated values to apply + to the repositories. + items: + $ref: '#/components/schemas/custom-property-value' + required: + - repository_names + - properties + examples: + default: + $ref: '#/components/examples/org-repo-update-custom-property-values' + responses: + '204': + description: >- + No Content when custom property values are successfully created or + updated + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + /orgs/{org}/public_members: + get: + summary: List public organization members + description: >- + Members of an organization can choose to have their membership + publicized or not. + tags: + - orgs + operationId: orgs/list-public-members + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#list-public-organization-members + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/public_members/{username}: + get: + summary: Check public organization membership for a user + description: Check if the provided user is a public member of the organization. + tags: + - orgs + operationId: orgs/check-public-membership-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response if user is a public member + '404': + description: Not Found if user is not a public member + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + put: + summary: Set public organization membership for the authenticated user + description: >- + The user can publicize their own membership. (A user cannot publicize + the membership for another user.) + + + Note that you'll need to set `Content-Length` to zero when calling out + to this endpoint. For more information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - orgs + operationId: orgs/set-public-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: orgs + subcategory: members + x-stackQL-resource: members + delete: + summary: Remove public organization membership for the authenticated user + description: >- + Removes the public membership for the authenticated user from the + specified organization, unless public visibility is enforced by default. + tags: + - orgs + operationId: orgs/remove-public-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/rulesets/{ruleset_id}/history: + get: + summary: Get organization ruleset history + description: Get the history of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-history + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ruleset-version' + examples: + default: + $ref: '#/components/examples/ruleset-history' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + x-stackQL-resource: rules + /orgs/{org}/rulesets/{ruleset_id}/history/{version_id}: + get: + summary: Get organization ruleset version + description: Get a version of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-version + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ruleset-version-with-state' + examples: + default: + $ref: '#/components/examples/org-ruleset-version-with-state' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + x-stackQL-resource: rules + /orgs/{org}/security-managers: + get: + summary: List security manager teams + description: >- + > [!WARNING] + + > **Closing down notice:** This operation is closing down and will be + removed starting January 1, 2026. Please use the "[Organization + Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints + instead. + tags: + - orgs + operationId: orgs/list-security-manager-teams + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team-simple' + examples: + default: + $ref: '#/components/examples/team-simple-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true + x-stackQL-resource: security_managers + /orgs/{org}/security-managers/teams/{team_slug}: + put: + summary: Add a security manager team + description: >- + > [!WARNING] + + > **Closing down notice:** This operation is closing down and will be + removed starting January 1, 2026. Please use the "[Organization + Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints + instead. + tags: + - orgs + operationId: orgs/add-security-manager-team + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true + x-stackQL-resource: security_managers + delete: + summary: Remove a security manager team + description: >- + > [!WARNING] + + > **Closing down notice:** This operation is closing down and will be + removed starting January 1, 2026. Please use the "[Organization + Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints + instead. + tags: + - orgs + operationId: orgs/remove-security-manager-team + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true + x-stackQL-resource: security_managers + /orgs/{org}/settings/immutable-releases: + get: + summary: Get immutable releases settings for an organization + description: >- + Gets the immutable releases policy for repositories in an organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - orgs + operationId: orgs/get-immutable-releases-settings + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Immutable releases settings response + content: + application/json: + schema: + $ref: '#/components/schemas/immutable-releases-organization-settings' + examples: + default: + value: + enforced_repositories: all + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + put: + summary: Set immutable releases settings for an organization + description: >- + Sets the immutable releases policy for repositories in an organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enforced_repositories: + type: string + description: >- + The policy that controls how immutable releases are enforced + in the organization. + enum: + - all + - none + - selected + example: all + selected_repository_ids: + type: array + description: >- + An array of repository ids for which immutable releases + enforcement should be applied. You can only provide a list + of repository ids when the `enforced_repositories` is set to + `selected`. You can add and remove individual repositories + using the [Enable a selected repository for immutable + releases in an + organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + and [Disable a selected repository for immutable releases in + an + organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + endpoints. + items: + type: integer + required: + - enforced_repositories + examples: + default: + value: + enforced_repositories: all + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/settings/immutable-releases/repositories: + get: + summary: List selected repositories for immutable releases enforcement + description: >- + List all of the repositories that have been selected for immutable + releases enforcement in an organization. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - orgs + operationId: orgs/get-immutable-releases-settings-repositories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + put: + summary: Set selected repositories for immutable releases enforcement + description: >- + Replaces all repositories that have been selected for immutable releases + enforcement in an organization. To use this endpoint, the organization + immutable releases policy for `enforced_repositories` must be configured + to `selected`. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings-repositories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: >- + An array of repository ids for which immutable releases + enforcement should be applied. You can only provide a list + of repository ids when the `enforced_repositories` is set to + `selected`. You can add and remove individual repositories + using the [Enable a selected repository for immutable + releases in an + organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + and [Disable a selected repository for immutable releases in + an + organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/settings/immutable-releases/repositories/{repository_id}: + put: + summary: Enable a selected repository for immutable releases in an organization + description: >- + Adds a repository to the list of selected repositories that are enforced + for immutable releases in an organization. To use this endpoint, the + organization immutable releases policy for `enforced_repositories` must + be configured to `selected`. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: orgs/enable-selected-repository-immutable-releases-organization + tags: + - orgs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + delete: + summary: Disable a selected repository for immutable releases in an organization + description: >- + Removes a repository from the list of selected repositories that are + enforced for immutable releases in an organization. To use this + endpoint, the organization immutable releases policy for + `enforced_repositories` must be configured to `selected`. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + operationId: orgs/disable-selected-repository-immutable-releases-organization + tags: + - orgs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/{security_product}/{enablement}: + post: + summary: Enable or disable a security feature for an organization + description: >- + > [!WARNING] + + > **Closing down notice:** The ability to enable or disable a security + feature for all eligible repositories in an organization is closing + down. Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. For more information, see the + [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + + + Enables or disables the specified security feature for all eligible + repositories in an organization. For more information, see "[Managing + security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + The authenticated user must be an organization owner or be member of a + team with the security manager role to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org`, `write:org`, or `repo` scopes to use this endpoint. + tags: + - orgs + operationId: orgs/enable-or-disable-security-product-on-all-org-repos + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/security-product' + - $ref: '#/components/parameters/org-security-product-enablement' + requestBody: + required: false + content: + application/json: + schema: + properties: + query_suite: + description: >- + CodeQL query suite to be used. If you specify the + `query_suite` parameter, the default setup will be + configured with this query suite only on all repositories + that didn't have default setup already configured. It will + not change the query suite on repositories that already have + default setup configured. + + If you don't specify any `query_suite` in your request, the + preferred query suite of the organization will be applied. + type: string + enum: + - default + - extended + type: object + examples: + default: + value: null + responses: + '204': + description: Action started + '422': + description: >- + The action could not be taken due to an in progress enablement, or a + policy is preventing enablement + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: orgs + deprecationDate: '2024-07-22' + removalDate: '2025-07-22' + deprecated: true + x-stackQL-resource: orgs + /user/memberships/orgs: + get: + summary: List organization memberships for the authenticated user + description: Lists all of the authenticated user's organization memberships. + tags: + - orgs + operationId: orgs/list-memberships-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user + parameters: + - name: state + description: >- + Indicates the state of the memberships to return. If not specified, + the API returns both active and pending memberships. + in: query + required: false + schema: + type: string + enum: + - active + - pending + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/org-membership' + examples: + default: + $ref: '#/components/examples/org-membership-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /user/memberships/orgs/{org}: + get: + summary: Get an organization membership for the authenticated user + description: >- + If the authenticated user is an active or pending member of the + organization, this endpoint will return the user's membership. If the + authenticated user is not affiliated with the organization, a `404` is + returned. This endpoint will return a `403` if the request is made by a + GitHub App that is blocked by the organization. + tags: + - orgs + operationId: orgs/get-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + default: + $ref: '#/components/examples/org-membership' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + patch: + summary: Update an organization membership for the authenticated user + description: >- + Converts the authenticated user to an active member of the organization, + if that user has a pending invitation from the organization. + tags: + - orgs + operationId: orgs/update-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: >- + The state that the membership should be in. Only `"active"` + will be accepted. + enum: + - active + required: + - state + examples: + default: + value: + state: active + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + default: + $ref: '#/components/examples/org-membership-2' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /user/orgs: + get: + summary: List organizations for the authenticated user + description: >- + List organizations for the authenticated user. + + + For OAuth app tokens and personal access tokens (classic), this endpoint + only lists organizations that your authorization allows you to operate + on in some way (e.g., you can list teams with `read:org` scope, you can + publicize your organization membership with `user` scope, etc.). + Therefore, this API requires at least `user` or `read:org` scope for + OAuth app tokens and personal access tokens (classic). Requests with + insufficient scope will receive a `403 Forbidden` response. + + + > [!NOTE] + + > Requests using a fine-grained access token will receive a `200 + Success` response with an empty list. + tags: + - orgs + operationId: orgs/list-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /users/{username}/orgs: + get: + summary: List organizations for a user + description: >- + List [public organization + memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) + for the specified user. + + + This method only lists _public_ memberships, regardless of + authentication. If you need to fetch all of the organization memberships + (public and private) for the authenticated user, use the [List + organizations for the authenticated + user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) + API instead. + tags: + - orgs + operationId: orgs/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs +components: + schemas: + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + organization-full: + title: Organization Full + description: Organization Full + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + name: + type: string + example: github + company: + type: string + example: GitHub + blog: + type: string + format: uri + example: https://github.com/blog + location: + type: string + example: San Francisco + email: + type: string + format: email + example: octocat@github.com + twitter_username: + type: string + example: github + nullable: true + is_verified: + type: boolean + example: true + has_organization_projects: + type: boolean + example: true + has_repository_projects: + type: boolean + example: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + html_url: + type: string + format: uri + example: https://github.com/octocat + type: + type: string + example: Organization + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + private_gists: + type: integer + example: 81 + nullable: true + disk_usage: + type: integer + example: 10000 + nullable: true + collaborators: + type: integer + example: 8 + nullable: true + description: >- + The number of collaborators on private repositories. + + + This field may be null if the number of private repositories is over + 50,000. + billing_email: + type: string + format: email + example: org@example.com + nullable: true + plan: + type: object + properties: + name: + type: string + space: + type: integer + private_repos: + type: integer + filled_seats: + type: integer + seats: + type: integer + required: + - name + - space + - private_repos + default_repository_permission: + type: string + nullable: true + default_repository_branch: + type: string + example: main + nullable: true + description: The default branch for repositories created in this organization. + members_can_create_repositories: + type: boolean + example: true + nullable: true + two_factor_requirement_enabled: + type: boolean + example: true + nullable: true + members_allowed_repository_creation_type: + type: string + example: all + members_can_create_public_repositories: + type: boolean + example: true + members_can_create_private_repositories: + type: boolean + example: true + members_can_create_internal_repositories: + type: boolean + example: true + members_can_create_pages: + type: boolean + example: true + members_can_create_public_pages: + type: boolean + example: true + members_can_create_private_pages: + type: boolean + example: true + members_can_delete_repositories: + type: boolean + example: true + members_can_change_repo_visibility: + type: boolean + example: true + members_can_invite_outside_collaborators: + type: boolean + example: true + members_can_delete_issues: + type: boolean + example: true + display_commenter_full_name_setting_enabled: + type: boolean + example: true + readers_can_create_discussions: + type: boolean + example: true + members_can_create_teams: + type: boolean + example: true + members_can_view_dependency_insights: + type: boolean + example: true + members_can_fork_private_repositories: + type: boolean + example: false + nullable: true + web_commit_signoff_required: + type: boolean + example: false + advanced_security_enabled_for_new_repositories: + type: boolean + example: false + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether GitHub Advanced Security is enabled for new repositories and + repositories transferred to this organization. + + + This field is only visible to organization owners or members of a + team with the security manager role. + deprecated: true + dependabot_alerts_enabled_for_new_repositories: + type: boolean + example: false + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether Dependabot alerts are automatically enabled for new + repositories and repositories transferred to this organization. + + + This field is only visible to organization owners or members of a + team with the security manager role. + deprecated: true + dependabot_security_updates_enabled_for_new_repositories: + type: boolean + example: false + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether Dependabot security updates are automatically enabled for + new repositories and repositories transferred to this organization. + + + This field is only visible to organization owners or members of a + team with the security manager role. + deprecated: true + dependency_graph_enabled_for_new_repositories: + type: boolean + example: false + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether dependency graph is automatically enabled for new + repositories and repositories transferred to this organization. + + + This field is only visible to organization owners or members of a + team with the security manager role. + deprecated: true + secret_scanning_enabled_for_new_repositories: + type: boolean + example: false + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether secret scanning is automatically enabled for new + repositories and repositories transferred to this organization. + + + This field is only visible to organization owners or members of a + team with the security manager role. + deprecated: true + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + example: false + description: >- + **Endpoint closing down notice.** Please use [code security + configurations](https://docs.github.com/rest/code-security/configurations) + instead. + + + Whether secret scanning push protection is automatically enabled for + new repositories and repositories transferred to this organization. + + + This field is only visible to organization owners or members of a + team with the security manager role. + deprecated: true + secret_scanning_push_protection_custom_link_enabled: + type: boolean + example: false + description: >- + Whether a custom link is shown to contributors who are blocked from + pushing a secret by push protection. + secret_scanning_push_protection_custom_link: + type: string + example: https://github.com/test-org/test-repo/blob/main/README.md + nullable: true + description: >- + An optional URL string to display to contributors who are blocked + from pushing a secret. + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + archived_at: + type: string + format: date-time + nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: >- + Controls whether or not deploy keys may be added and used for + repositories in the organization. + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + - html_url + - has_organization_projects + - has_repository_projects + - public_repos + - public_gists + - followers + - following + - type + - created_at + - updated_at + - archived_at + x-github-breaking-changes: + - changeset: remove_secret_scanning_custom_link_enablement_field + patch: + - op: remove + path: /properties/secret_scanning_push_protection_custom_link_enabled + version: '2026-03-10' + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + artifact-deployment-record: + title: Artifact Deployment Record + description: Artifact Metadata Deployment Record + type: object + properties: + id: + type: integer + digest: + type: string + logical_environment: + type: string + physical_environment: + type: string + cluster: + type: string + deployment_name: + type: string + tags: + type: object + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + created_at: + type: string + updated_at: + type: string + attestation_id: + type: integer + description: >- + The ID of the provenance attestation associated with the deployment + record. + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + organization-invitation: + title: Organization Invitation + description: Organization Invitation + type: object + properties: + id: + type: integer + format: int64 + login: + type: string + nullable: true + email: + type: string + nullable: true + role: + type: string + created_at: + type: string + failed_at: + type: string + nullable: true + failed_reason: + type: string + nullable: true + inviter: + $ref: '#/components/schemas/simple-user' + team_count: + type: integer + node_id: + type: string + example: '"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x"' + invitation_teams_url: + type: string + example: '"https://api.github.com/organizations/16/invitations/1/teams"' + invitation_source: + type: string + example: '"member"' + required: + - id + - login + - email + - role + - created_at + - inviter + - team_count + - invitation_teams_url + - node_id + org-hook: + title: Org Hook + description: Org Hook + type: object + properties: + id: + type: integer + example: 1 + url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/hooks/1 + ping_url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/hooks/1/deliveries + name: + type: string + example: web + events: + type: array + example: + - push + - pull_request + items: + type: string + active: + type: boolean + example: true + config: + type: object + properties: + url: + type: string + example: '"http://example.com/2"' + insecure_ssl: + type: string + example: '"0"' + content_type: + type: string + example: '"form"' + secret: + type: string + example: '"********"' + updated_at: + type: string + format: date-time + example: '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + example: '2011-09-06T17:26:27Z' + type: + type: string + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + webhook-config-url: + type: string + description: The URL to which the payloads will be delivered. + example: https://example.com/webhook + format: uri + webhook-config-content-type: + type: string + description: >- + The media type used to serialize the payloads. Supported values include + `json` and `form`. The default is `form`. + example: '"json"' + webhook-config-secret: + type: string + description: >- + If provided, the `secret` will be used as the `key` to generate the HMAC + hex digest value for [delivery signature + headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + example: '"********"' + webhook-config-insecure-ssl: + type: string + description: >- + Determines whether the SSL certificate of the host for `url` will be + verified when delivering payloads. Supported values include `0` + (verification is performed) and `1` (verification is not performed). The + default is `0`. **We strongly recommend not setting this to `1` as you + are subject to man-in-the-middle and other attacks.** + example: '"0"' + webhook-config: + title: Webhook Configuration + description: Configuration object of the webhook + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + hook-delivery-item: + title: Simple webhook delivery + description: Delivery made by a webhook, without request and response information. + type: object + properties: + id: + description: Unique identifier of the webhook delivery. + type: integer + format: int64 + example: 42 + guid: + description: >- + Unique identifier for the event (shared with all deliveries for all + webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + hook-delivery: + title: Webhook delivery + description: Delivery made by a webhook. + type: object + properties: + id: + description: Unique identifier of the delivery. + type: integer + example: 42 + guid: + description: >- + Unique identifier for the event (shared with all deliveries for all + webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Description of the status of the attempted delivery + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + url: + description: The URL target of the delivery. + type: string + example: https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: object + nullable: true + additionalProperties: true + payload: + description: The webhook payload. + type: object + nullable: true + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: object + nullable: true + additionalProperties: true + payload: + description: The response payload received. + type: string + nullable: true + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + api-insights-route-stats: + title: Route Stats + description: API Insights usage route stats for an actor + type: array + items: + type: object + properties: + http_method: + description: The HTTP method + type: string + api_route: + description: The API path's route template + type: string + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: >- + The total number of requests that were rate limited within the + queried time period + type: integer + format: int64 + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + api-insights-subject-stats: + title: Subject Stats + description: API Insights usage subject stats for an organization + type: array + items: + type: object + properties: + subject_type: + type: string + subject_name: + type: string + subject_id: + type: integer + format: int64 + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + api-insights-summary-stats: + title: Summary Stats + description: API Insights usage summary stats for an organization + type: object + properties: + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: >- + The total number of requests that were rate limited within the + queried time period + type: integer + format: int64 + api-insights-time-stats: + title: Time Stats + description: API Insights usage time stats for an organization + type: array + items: + type: object + properties: + timestamp: + type: string + total_request_count: + type: integer + format: int64 + rate_limited_request_count: + type: integer + format: int64 + api-insights-user-stats: + title: User Stats + description: API Insights usage stats for a user + type: array + items: + type: object + properties: + actor_type: + type: string + actor_name: + type: string + actor_id: + type: integer + format: int64 + integration_id: + type: integer + format: int64 + nullable: true + oauth_application_id: + type: integer + format: int64 + nullable: true + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + installation: + title: Installation + description: Installation + type: object + properties: + id: + description: The ID of the installation. + type: integer + example: 1 + account: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + repository_selection: + description: >- + Describe whether all repositories have been selected or there's a + selection involved + type: string + enum: + - all + - selected + access_tokens_url: + type: string + format: uri + example: https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + example: https://api.github.com/installation/repositories + html_url: + type: string + format: uri + example: https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + example: 1 + client_id: + type: string + example: Iv1.ab1112223334445c + target_id: + description: The ID of the user or organization this token is being scoped to. + type: integer + target_type: + type: string + example: Organization + permissions: + $ref: '#/components/schemas/app-permissions' + events: + type: array + items: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + single_file_name: + type: string + example: config.yaml + nullable: true + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: + type: string + example: github-actions + suspended_by: + $ref: '#/components/schemas/nullable-simple-user' + suspended_at: + type: string + format: date-time + nullable: true + contact_email: + type: string + example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + nullable: true + required: + - id + - app_id + - app_slug + - target_id + - target_type + - single_file_name + - repository_selection + - access_tokens_url + - html_url + - repositories_url + - events + - account + - permissions + - created_at + - updated_at + - suspended_by + - suspended_at + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + issue-field: + title: Issue Field + description: >- + A custom attribute defined at the organization level for attaching + structured data to issues. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue field. + node_id: + type: string + description: The node identifier of the issue field. + name: + type: string + description: The name of the issue field. + description: + type: string + description: The description of the issue field. + nullable: true + data_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + visibility: + type: string + description: >- + The visibility of the issue field. Can be + `organization_members_only` (visible only within the organization) + or `all` (visible to all users who can see issues). + enum: + - organization_members_only + - all + options: + description: Available options for single select fields. + type: array + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the option. + name: + type: string + description: The name of the option. + description: + type: string + description: The description of the option. + nullable: true + color: + type: string + description: The color of the option. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + priority: + type: integer + description: The priority of the option for ordering. + nullable: true + created_at: + type: string + description: The time the option was created. + format: date-time + updated_at: + type: string + description: The time the option was last updated. + format: date-time + required: + - id + - name + nullable: true + created_at: + type: string + description: The time the issue field was created. + format: date-time + updated_at: + type: string + description: The time the issue field was last updated. + format: date-time + required: + - id + - node_id + - name + - data_type + organization-create-issue-field: + type: object + properties: + name: + description: Name of the issue field. + type: string + description: + description: Description of the issue field. + type: string + nullable: true + data_type: + description: The data type of the issue field. + type: string + enum: + - text + - date + - single_select + - number + visibility: + description: >- + The visibility of the issue field. Can be + `organization_members_only` (visible only within the organization) + or `all` (visible to all users who can see issues). Only used when + the visibility settings feature is enabled. Defaults to + `organization_members_only`. + type: string + enum: + - organization_members_only + - all + options: + description: >- + Options for single select fields. Required when data_type is + 'single_select'. + type: array + items: + type: object + properties: + name: + description: Name of the option. + type: string + description: + description: Description of the option. + type: string + nullable: true + color: + description: Color for the option. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + priority: + description: Priority of the option for ordering. + type: integer + required: + - name + - color + - priority + nullable: true + required: + - name + - data_type + organization-update-issue-field: + type: object + properties: + name: + description: Name of the issue field. + type: string + description: + description: Description of the issue field. + type: string + nullable: true + visibility: + description: >- + The visibility of the issue field. Can be + `organization_members_only` (visible only within the organization) + or `all` (visible to all users who can see issues). Only used when + the visibility settings feature is enabled. + type: string + enum: + - organization_members_only + - all + options: + description: >- + Options for single select fields. Only applicable when updating + single_select fields. + type: array + items: + type: object + properties: + name: + description: Name of the option. + type: string + description: + description: Description of the option. + type: string + nullable: true + color: + description: Color for the option. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + priority: + description: Priority of the option for ordering. + type: integer + required: + - name + - color + - priority + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + organization-create-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization level. + type: boolean + description: + description: Description of the issue type. + type: string + nullable: true + color: + description: Color for the issue type. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + required: + - name + - is_enabled + organization-update-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization level. + type: boolean + description: + description: Description of the issue type. + type: string + nullable: true + color: + description: Color for the issue type. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + required: + - name + - is_enabled + org-membership: + title: Org Membership + description: Org Membership + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/memberships/defunkt + state: + type: string + description: >- + The state of the member in the organization. The `pending` state + indicates the user has not yet accepted an invitation. + example: active + enum: + - active + - pending + role: + type: string + description: The user's membership type in the organization. + example: admin + enum: + - admin + - member + - billing_manager + direct_membership: + type: boolean + description: Whether the user has direct membership in the organization. + example: true + enterprise_teams_providing_indirect_membership: + type: array + description: >- + The slugs of the enterprise teams providing the user with indirect + membership in the organization. + + A limit of 100 enterprise team slugs is returned. + maxItems: 100 + items: + type: string + example: + - ent:team-one + - ent:team-two + organization_url: + type: string + format: uri + example: https://api.github.com/orgs/octocat + organization: + $ref: '#/components/schemas/organization-simple' + user: + $ref: '#/components/schemas/nullable-simple-user' + permissions: + type: object + properties: + can_create_repository: + type: boolean + required: + - can_create_repository + required: + - state + - role + - organization_url + - url + - organization + - user + organization-role: + title: Organization Role + description: Organization roles + type: object + properties: + id: + description: The unique identifier of the role. + type: integer + format: int64 + name: + description: The name of the role. + type: string + description: + description: >- + A short description about who this role is for or what permissions + it grants. + type: string + nullable: true + base_role: + type: string + nullable: true + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + - admin + source: + type: string + nullable: true + description: Source answers the question, "where did this role come from?" + enum: + - Organization + - Enterprise + - Predefined + permissions: + description: A list of permissions included in this role. + type: array + items: + type: string + organization: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + description: The date and time the role was created. + type: string + format: date-time + updated_at: + description: The date and time the role was last updated. + type: string + format: date-time + required: + - id + - name + - permissions + - organization + - created_at + - updated_at + team-role-assignment: + title: A Role Assignment for a Team + description: The Relationship a Team has with a role. + type: object + properties: + assignment: + type: string + description: >- + Determines if the team has a direct, indirect, or mixed relationship + to a role + enum: + - direct + - indirect + - mixed + example: direct + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + $ref: '#/components/schemas/nullable-team-simple' + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + - parent + user-role-assignment: + title: A Role Assignment for a User + description: The Relationship a User has with a role. + type: object + properties: + assignment: + type: string + description: >- + Determines if the user has a direct, indirect, or mixed relationship + to a role + enum: + - direct + - indirect + - mixed + example: direct + inherited_from: + description: Team the user has gotten the role through + type: array + items: + $ref: '#/components/schemas/team-simple' + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + organization-programmatic-access-grant-request: + title: Simple Organization Programmatic Access Grant Request + description: >- + Minimal representation of an organization programmatic access grant + request for enumerations + type: object + properties: + id: + type: integer + description: >- + Unique identifier of the request for access via fine-grained + personal access token. The `pat_request_id` used to review PAT + requests. + reason: + type: string + nullable: true + description: Reason for requesting access. + owner: + $ref: '#/components/schemas/simple-user' + repository_selection: + type: string + enum: + - none + - all + - subset + description: Type of repository selection requested. + repositories_url: + type: string + description: >- + URL to the list of repositories requested to be accessed via + fine-grained personal access token. Should only be followed when + `repository_selection` is `subset`. + permissions: + type: object + description: Permissions requested, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + created_at: + type: string + description: Date and time when the request for access was created. + token_id: + type: integer + description: >- + Unique identifier of the user's token. This field can also be found + in audit log events and the organization's settings for their PAT + grants. + token_name: + type: string + description: >- + The name given to the user's token. This field can also be found in + an organization's settings page for Active Tokens. + token_expired: + type: boolean + description: >- + Whether the associated fine-grained personal access token has + expired. + token_expires_at: + type: string + nullable: true + description: >- + Date and time when the associated fine-grained personal access token + expires. + token_last_used_at: + type: string + nullable: true + description: >- + Date and time when the associated fine-grained personal access token + was last used for authentication. + required: + - id + - reason + - owner + - repository_selection + - repositories_url + - permissions + - created_at + - token_id + - token_name + - token_expired + - token_expires_at + - token_last_used_at + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + organization-programmatic-access-grant: + title: Organization Programmatic Access Grant + description: >- + Minimal representation of an organization programmatic access grant for + enumerations + type: object + properties: + id: + type: integer + description: >- + Unique identifier of the fine-grained personal access token grant. + The `pat_id` used to get details about an approved fine-grained + personal access token. + owner: + $ref: '#/components/schemas/simple-user' + repository_selection: + type: string + enum: + - none + - all + - subset + description: Type of repository selection requested. + repositories_url: + type: string + description: >- + URL to the list of repositories the fine-grained personal access + token can access. Only follow when `repository_selection` is + `subset`. + permissions: + type: object + description: Permissions requested, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + access_granted_at: + type: string + description: >- + Date and time when the fine-grained personal access token was + approved to access the organization. + token_id: + type: integer + description: >- + Unique identifier of the user's token. This field can also be found + in audit log events and the organization's settings for their PAT + grants. + token_name: + type: string + description: >- + The name given to the user's token. This field can also be found in + an organization's settings page for Active Tokens. + token_expired: + type: boolean + description: >- + Whether the associated fine-grained personal access token has + expired. + token_expires_at: + type: string + nullable: true + description: >- + Date and time when the associated fine-grained personal access token + expires. + token_last_used_at: + type: string + nullable: true + description: >- + Date and time when the associated fine-grained personal access token + was last used for authentication. + required: + - id + - owner + - repository_selection + - repositories_url + - permissions + - access_granted_at + - token_id + - token_name + - token_expired + - token_expires_at + - token_last_used_at + custom-property: + title: Organization Custom Property + description: Custom property defined on an organization + type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: >- + The URL that can be used to fetch, update, or delete info about this + property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + - url + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + nullable: true + description: Default value of the property + type: string + items: + type: string + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory + required: + - property_name + - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + - url + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + nullable: true + description: Default value of the property + type: string + items: + type: string + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory + required: + - value_type + org-repo-custom-property-values: + title: Organization Repository Custom Property Values + description: List of custom property values for a repository + type: object + properties: + repository_id: + type: integer + example: 1296269 + repository_name: + type: string + example: Hello-World + repository_full_name: + type: string + example: octocat/Hello-World + properties: + type: array + items: + $ref: '#/components/schemas/custom-property-value' + description: List of custom property names and associated values + required: + - repository_id + - repository_name + - repository_full_name + - properties + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + description: The value assigned to the property + nullable: true + type: string + items: + type: string + required: + - property_name + - value + ruleset-version: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + ruleset-version-with-state: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + - state + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + state: + type: string + description: The state of the ruleset version (opaque JSON object) + team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + immutable-releases-organization-settings: + title: Check immutable releases organization settings + description: Check immutable releases settings for an organization. + type: object + properties: + enforced_repositories: + type: string + description: >- + The policy that controls how immutable releases are enforced in the + organization. + enum: + - all + - none + - selected + example: all + selected_repositories_url: + type: string + description: >- + The API URL to use to get or set the selected repositories for + immutable releases enforcement, when `enforced_repositories` is set + to `selected`. + required: + - enforced_repositories + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + app-permissions: + title: App Permissions + type: object + description: The permissions granted to the user access token. + properties: + actions: + type: string + description: >- + The level of permission to grant the access token for GitHub Actions + workflows, workflow runs, and artifacts. + enum: + - read + - write + administration: + type: string + description: >- + The level of permission to grant the access token for repository + creation, deletion, settings, teams, and collaborators creation. + enum: + - read + - write + artifact_metadata: + type: string + description: >- + The level of permission to grant the access token to create and + retrieve build artifact metadata records. + enum: + - read + - write + attestations: + type: string + description: >- + The level of permission to create and retrieve the access token for + repository attestations. + enum: + - read + - write + checks: + type: string + description: >- + The level of permission to grant the access token for checks on + code. + enum: + - read + - write + codespaces: + type: string + description: >- + The level of permission to grant the access token to create, edit, + delete, and list Codespaces. + enum: + - read + - write + contents: + type: string + description: >- + The level of permission to grant the access token for repository + contents, commits, branches, downloads, releases, and merges. + enum: + - read + - write + dependabot_secrets: + type: string + description: >- + The level of permission to grant the access token to manage + Dependabot secrets. + enum: + - read + - write + deployments: + type: string + description: >- + The level of permission to grant the access token for deployments + and deployment statuses. + enum: + - read + - write + discussions: + type: string + description: >- + The level of permission to grant the access token for discussions + and related comments and labels. + enum: + - read + - write + environments: + type: string + description: >- + The level of permission to grant the access token for managing + repository environments. + enum: + - read + - write + issues: + type: string + description: >- + The level of permission to grant the access token for issues and + related comments, assignees, labels, and milestones. + enum: + - read + - write + merge_queues: + type: string + description: >- + The level of permission to grant the access token to manage the + merge queues for a repository. + enum: + - read + - write + metadata: + type: string + description: >- + The level of permission to grant the access token to search + repositories, list collaborators, and access repository metadata. + enum: + - read + - write + packages: + type: string + description: >- + The level of permission to grant the access token for packages + published to GitHub Packages. + enum: + - read + - write + pages: + type: string + description: >- + The level of permission to grant the access token to retrieve Pages + statuses, configuration, and builds, as well as create new builds. + enum: + - read + - write + pull_requests: + type: string + description: >- + The level of permission to grant the access token for pull requests + and related comments, assignees, labels, milestones, and merges. + enum: + - read + - write + repository_custom_properties: + type: string + description: >- + The level of permission to grant the access token to view and edit + custom properties for a repository, when allowed by the property. + enum: + - read + - write + repository_hooks: + type: string + description: >- + The level of permission to grant the access token to manage the + post-receive hooks for a repository. + enum: + - read + - write + repository_projects: + type: string + description: >- + The level of permission to grant the access token to manage + repository projects, columns, and cards. + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + description: >- + The level of permission to grant the access token to view and manage + secret scanning alerts. + enum: + - read + - write + secrets: + type: string + description: >- + The level of permission to grant the access token to manage + repository secrets. + enum: + - read + - write + security_events: + type: string + description: >- + The level of permission to grant the access token to view and manage + security events like code scanning alerts. + enum: + - read + - write + single_file: + type: string + description: >- + The level of permission to grant the access token to manage just a + single file. + enum: + - read + - write + statuses: + type: string + description: >- + The level of permission to grant the access token for commit + statuses. + enum: + - read + - write + vulnerability_alerts: + type: string + description: >- + The level of permission to grant the access token to manage + Dependabot alerts. + enum: + - read + - write + workflows: + type: string + description: >- + The level of permission to grant the access token to update GitHub + Actions workflow files. + enum: + - write + custom_properties_for_organizations: + type: string + description: >- + The level of permission to grant the access token to view and edit + custom properties for an organization, when allowed by the property. + enum: + - read + - write + members: + type: string + description: >- + The level of permission to grant the access token for organization + teams and members. + enum: + - read + - write + organization_administration: + type: string + description: >- + The level of permission to grant the access token to manage access + to an organization. + enum: + - read + - write + organization_custom_roles: + type: string + description: >- + The level of permission to grant the access token for custom + repository roles management. + enum: + - read + - write + organization_custom_org_roles: + type: string + description: >- + The level of permission to grant the access token for custom + organization roles management. + enum: + - read + - write + organization_custom_properties: + type: string + description: >- + The level of permission to grant the access token for repository + custom properties management at the organization level. + enum: + - read + - write + - admin + organization_copilot_seat_management: + type: string + description: >- + The level of permission to grant the access token for managing + access to GitHub Copilot for members of an organization with a + Copilot Business subscription. This property is in public preview + and is subject to change. + enum: + - write + organization_copilot_agent_settings: + type: string + description: >- + The level of permission to grant the access token to view and manage + Copilot coding agent settings for an organization. + enum: + - read + - write + organization_announcement_banners: + type: string + description: >- + The level of permission to grant the access token to view and manage + announcement banners for an organization. + enum: + - read + - write + organization_events: + type: string + description: >- + The level of permission to grant the access token to view events + triggered by an activity in an organization. + enum: + - read + organization_hooks: + type: string + description: >- + The level of permission to grant the access token to manage the + post-receive hooks for an organization. + enum: + - read + - write + organization_personal_access_tokens: + type: string + description: >- + The level of permission to grant the access token for viewing and + managing fine-grained personal access token requests to an + organization. + enum: + - read + - write + organization_personal_access_token_requests: + type: string + description: >- + The level of permission to grant the access token for viewing and + managing fine-grained personal access tokens that have been approved + by an organization. + enum: + - read + - write + organization_plan: + type: string + description: >- + The level of permission to grant the access token for viewing an + organization's plan. + enum: + - read + organization_projects: + type: string + description: >- + The level of permission to grant the access token to manage + organization projects and projects public preview (where available). + enum: + - read + - write + - admin + organization_packages: + type: string + description: >- + The level of permission to grant the access token for organization + packages published to GitHub Packages. + enum: + - read + - write + organization_secrets: + type: string + description: >- + The level of permission to grant the access token to manage + organization secrets. + enum: + - read + - write + organization_self_hosted_runners: + type: string + description: >- + The level of permission to grant the access token to view and manage + GitHub Actions self-hosted runners available to an organization. + enum: + - read + - write + organization_user_blocking: + type: string + description: >- + The level of permission to grant the access token to view and manage + users blocked by the organization. + enum: + - read + - write + email_addresses: + type: string + description: >- + The level of permission to grant the access token to manage the + email addresses belonging to a user. + enum: + - read + - write + followers: + type: string + description: >- + The level of permission to grant the access token to manage the + followers belonging to a user. + enum: + - read + - write + git_ssh_keys: + type: string + description: >- + The level of permission to grant the access token to manage git SSH + keys. + enum: + - read + - write + gpg_keys: + type: string + description: >- + The level of permission to grant the access token to view and manage + GPG keys belonging to a user. + enum: + - read + - write + interaction_limits: + type: string + description: >- + The level of permission to grant the access token to view and manage + interaction limits on a repository. + enum: + - read + - write + profile: + type: string + description: >- + The level of permission to grant the access token to manage the + profile settings belonging to a user. + enum: + - write + starring: + type: string + description: >- + The level of permission to grant the access token to list and manage + repositories a user is starring. + enum: + - read + - write + enterprise_custom_properties_for_organizations: + type: string + description: >- + The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin + example: + contents: read + issues: read + deployments: write + single_file: read + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + no_content: + description: A header with no content is returned. + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + since-org: + name: since + description: >- + An organization ID. Only return organizations with an ID greater than + this ID. + in: query + required: false + schema: + type: integer + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + subject-digest: + name: subject_digest + description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + hook-id: + name: hook_id + description: >- + The unique identifier of the hook. You can find this value in the + `X-GitHub-Hook-ID` header of a webhook delivery. + in: path + required: true + schema: + type: integer + cursor: + name: cursor + description: >- + Used for pagination: the starting delivery from which the page of + deliveries is fetched. Refer to the `link` header for the next and + previous page cursors. + in: query + required: false + schema: + type: string + webhook-delivery-status: + name: status + description: >- + Returns webhook deliveries filtered by delivery outcome classification + based on `status_code` range. A `status` of `success` returns deliveries + with a `status_code` in the 200-399 range (inclusive). A `status` of + `failure` returns deliveries with a `status_code` in the 400-599 range + (inclusive). + in: query + required: false + schema: + type: string + enum: + - success + - failure + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + api-insights-actor-type: + name: actor_type + in: path + description: The type of the actor + required: true + schema: + type: string + enum: + - installation + - classic_pat + - fine_grained_pat + - oauth_app + - github_app_user_to_server + api-insights-actor-id: + name: actor_id + in: path + description: The ID of the actor + required: true + schema: + type: integer + api-insights-min-timestamp: + name: min_timestamp + description: >- + The minimum timestamp to query for stats. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: true + schema: + type: string + api-insights-max-timestamp: + name: max_timestamp + description: >- + The maximum timestamp to query for stats. Defaults to the time 30 days + ago. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + api-insights-route-stats-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - http_method + - api_route + - total_request_count + default: total_request_count + api-insights-api-route-substring: + name: api_route_substring + in: query + description: >- + Providing a substring will filter results where the API route contains + the substring. This is a case-insensitive search. + required: false + schema: + type: string + api-insights-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - subject_name + - total_request_count + default: total_request_count + api-insights-subject-name-substring: + name: subject_name_substring + in: query + description: >- + Providing a substring will filter results where the subject name + contains the substring. This is a case-insensitive search. + required: false + schema: + type: string + api-insights-user-id: + name: user_id + in: path + description: The ID of the user to query for stats + required: true + schema: + type: string + api-insights-timestamp-increment: + name: timestamp_increment + description: >- + The increment of time used to breakdown the query results (5m, 10m, 1h, + etc.) + in: query + required: true + schema: + type: string + api-insights-actor-name-substring: + name: actor_name_substring + in: query + description: >- + Providing a substring will filter results where the actor name contains + the substring. This is a case-insensitive search. + required: false + schema: + type: string + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + in: path + required: true + schema: + type: integer + issue-field-id: + name: issue_field_id + description: The unique identifier of the issue field. + in: path + required: true + schema: + type: integer + issue-type-id: + name: issue_type_id + description: The unique identifier of the issue type. + in: path + required: true + schema: + type: integer + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + role-id: + name: role_id + description: The unique identifier of the role. + in: path + required: true + schema: + type: integer + personal-access-token-sort: + name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created_at + default: created_at + personal-access-token-owner: + name: owner + description: A list of owner usernames to use to filter the results. + in: query + required: false + schema: + type: array + maxItems: 10 + items: + type: string + example: owner[]=octocat1,owner[]=octocat2 + personal-access-token-repository: + name: repository + description: The name of the repository to use to filter the results. + in: query + required: false + schema: + type: string + example: Hello-World + personal-access-token-permission: + name: permission + description: The permission to use to filter the results. + in: query + required: false + schema: + type: string + example: issues_read + personal-access-token-before: + name: last_used_before + description: >- + Only show fine-grained personal access tokens used before the given + time. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + personal-access-token-after: + name: last_used_after + description: >- + Only show fine-grained personal access tokens used after the given time. + This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + personal-access-token-token-id: + name: token_id + description: The ID of the token + in: query + required: false + schema: + type: array + maxItems: 50 + items: + type: string + example: token_id[]=1,token_id[]=2 + fine-grained-personal-access-token-id: + name: pat_id + description: The unique identifier of the fine-grained personal access token. + in: path + required: true + schema: + type: integer + custom-property-name: + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + security-product: + name: security_product + in: path + description: The security feature to enable or disable. + required: true + schema: + type: string + enum: + - dependency_graph + - dependabot_alerts + - dependabot_security_updates + - advanced_security + - code_scanning_default_setup + - secret_scanning + - secret_scanning_push_protection + org-security-product-enablement: + name: enablement + in: path + description: >- + The action to take. + + + `enable_all` means to enable the specified security feature for all + repositories in the organization. + + `disable_all` means to disable the specified security feature for all + repositories in the organization. + required: true + schema: + type: string + enum: + - enable_all + - disable_all + examples: + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-full: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: github + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: github + is_verified: true + has_organization_projects: true + has_repository_projects: true + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + html_url: https://github.com/octocat + created_at: '2008-01-14T04:33:35Z' + type: Organization + total_private_repos: 100 + owned_private_repos: 100 + private_gists: 81 + disk_usage: 10000 + collaborators: 8 + billing_email: mona@github.com + plan: + name: Medium + space: 400 + private_repos: 20 + filled_seats: 4 + seats: 5 + default_repository_permission: read + default_repository_branch: main + members_can_create_repositories: true + two_factor_requirement_enabled: true + members_allowed_repository_creation_type: all + members_can_create_public_repositories: false + members_can_create_private_repositories: false + members_can_create_internal_repositories: false + members_can_create_pages: true + members_can_create_public_pages: true + members_can_create_private_pages: true + members_can_delete_repositories: true + members_can_change_repo_visibility: true + members_can_invite_outside_collaborators: true + members_can_delete_issues: false + display_commenter_full_name_setting_enabled: false + readers_can_create_discussions: true + members_can_create_teams: true + members_can_view_dependency_insights: true + members_can_fork_private_repositories: false + web_commit_signoff_required: false + updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false + dependency_graph_enabled_for_new_repositories: false + dependabot_alerts_enabled_for_new_repositories: false + dependabot_security_updates_enabled_for_new_repositories: false + advanced_security_enabled_for_new_repositories: false + secret_scanning_enabled_for_new_repositories: false + secret_scanning_push_protection_enabled_for_new_repositories: false + secret_scanning_push_protection_custom_link: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md + secret_scanning_push_protection_custom_link_enabled: false + x-github-breaking-changes: + - changeset: remove_secret_scanning_custom_link_enablement_field + patch: + - op: remove + path: /value/secret_scanning_push_protection_custom_link_enabled + version: '2026-03-10' + artifact-deployment-record-list: + value: + total_count: 1 + deployment_records: + - id: 123 + digest: >- + sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: prod-deployment + tags: + data: sensitive + created: '2011-01-26T19:14:43Z' + updated_at: '2011-01-26T19:14:43Z' + attestation_id: 456 + bulk-subject-digest-body: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + bulk-subject-digest-body-with-predicate-type: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + predicateType: provenance + list-attestations-bulk: + value: + attestations_subject_digests: + - sha256:abc: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + organization-invitation-items: + value: + - id: 1 + login: monalisa + node_id: MDQ6VXNlcjE= + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + failed_at: '' + failed_reason: '' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams + invitation_source: member + org-hook-items: + value: + - id: 1 + url: https://api.github.com/orgs/octocat/hooks/1 + ping_url: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: https://api.github.com/orgs/octocat/hooks/1/deliveries + name: web + events: + - push + - pull_request + active: true + config: + url: http://example.com + content_type: json + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + type: Organization + org-hook: + value: + id: 1 + url: https://api.github.com/orgs/octocat/hooks/1 + ping_url: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: https://api.github.com/orgs/octocat/hooks/1/deliveries + name: web + events: + - push + - pull_request + active: true + config: + url: http://example.com + content_type: json + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + type: Organization + org-hook-2: + value: + id: 1 + url: https://api.github.com/orgs/octocat/hooks/1 + ping_url: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: >- + https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries + name: web + events: + - pull_request + active: true + config: + url: http://example.com + content_type: json + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + type: Organization + webhook-config: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + hook-delivery-items: + value: + - id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: '2019-06-03T00:57:16Z' + - id: 123456789 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-04T00:57:16Z' + redelivery: true + duration: 0.28 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: null + hook-delivery: + value: + id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + url: https://www.example.com + throttled_at: '2019-06-03T00:57:16Z' + request: + headers: + X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + Accept: '*/*' + X-GitHub-Hook-ID: '42' + User-Agent: GitHub-Hookshot/b8c71d8 + X-GitHub-Event: issues + X-GitHub-Hook-Installation-Target-ID: '123' + X-GitHub-Hook-Installation-Target-Type: repository + content-type: application/json + X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + payload: + action: opened + issue: + body: foo + repository: + id: 123 + response: + headers: + Content-Type: text/html;charset=utf-8 + payload: ok + api-insights-route-stats: + value: + - http_method: GET + api_route: /repositories/:repository_id + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-subject-stats: + value: + - subject_type: installation + subject_id: 954453 + subject_name: GitHub Actions + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-summary-stats: + value: + total_request_count: 34225 + rate_limited_request_count: 23 + api-insights-time-stats: + value: + - timestamp: '2024-09-11T15:00:00Z' + total_request_count: 34225 + rate_limited_request_count: 0 + - timestamp: '2024-09-11T15:05:00Z' + total_request_count: 10587 + rate_limited_request_count: 18 + - timestamp: '2024-09-11T15:10:00Z' + total_request_count: 43587 + rate_limited_request_count: 14 + - timestamp: '2024-09-11T15:15:00Z' + total_request_count: 19463 + rate_limited_request_count: 4 + - timestamp: '2024-09-11T15:20:00Z' + total_request_count: 60542 + rate_limited_request_count: 3 + - timestamp: '2024-09-11T15:25:00Z' + total_request_count: 55872 + rate_limited_request_count: 23 + api-insights-user-stats: + value: + - actor_type: oauth_app + actor_id: 954453 + actor_name: GitHub Actions + oauth_application_id: 1245 + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + installation-paginated: + value: + total_count: 1 + installations: + - id: 25381 + account: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + repository_selection: selected + access_tokens_url: https://api.github.com/app/installations/25381/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: >- + https://github.com/organizations/octo-org/settings/installations/25381 + app_id: 2218 + target_id: 6811672 + target_type: Organization + permissions: + deployments: write + metadata: read + pull_requests: read + statuses: read + events: + - deployment + - deployment_status + created_at: '2017-05-16T08:47:09.000-07:00' + updated_at: '2017-06-06T11:23:23.000-07:00' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: github-actions + suspended_at: null + suspended_by: null + organization-invitation: + value: + id: 1 + login: monalisa + node_id: MDQ6VXNlcjE= + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams + invitation_source: member + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + issue-field-items: + value: + - id: 1 + node_id: IFT_kwDNAd3NAZo + name: Text field + description: DRI + data_type: text + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + - id: 2 + node_id: IFSS_kwDNAd3NAZs + name: Priority + description: Level of importance + data_type: single_select + options: + - id: 1 + name: High + color: red + - id: 2 + name: Medium + color: yellow + - id: 3 + name: Low + color: green + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + issue-field: + value: + id: 512 + node_id: IF_kwDNAd3NAZr + name: Priority + description: Level of importance for the issue + data_type: single_select + options: + - id: 1 + name: High + description: High priority + color: red + priority: 1 + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + - id: 2 + name: Medium + description: Medium priority + color: yellow + priority: 2 + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + - id: 3 + name: Low + description: Low priority + color: green + priority: 3 + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + issue-type-items: + value: + - id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + - id: 411 + node_id: IT_kwDNAd3NAZs + name: Bug + description: An unexpected problem or behavior + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + issue-type: + value: + id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + org-membership-response-if-user-has-an-active-admin-membership-with-organization: + summary: Response if user has an active admin membership with organization + value: + url: https://api.github.com/orgs/octocat/memberships/defunkt + state: active + role: admin + organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + organization-role-list: + value: + total_count: 2 + roles: + - id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + - id: 8031 + name: Auditor + description: Permissions to read the organization audit log + permissions: + - read_audit_logs + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + organization-role: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + org-pat-grant-request-paginated: + value: + - id: 25381 + reason: I need to access the GitHub API + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository_selection: all + repositories_url: >- + https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories + permissions: + organization: + members: read + repository: + metadata: read + created_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token + token_expired: false + token_expires_at: '2023-11-16T08:47:09.000-07:00' + token_last_used_at: null + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + org-pat-grant-paginated: + value: + - id: 25381 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository_selection: all + repositories_url: >- + https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories + permissions: + organization: + members: read + repository: + metadata: read + access_granted_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token + token_expired: false + token_expires_at: '2023-11-16T08:47:09.000-07:00' + token_last_used_at: null + custom-properties: + value: + - property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + require_explicit_values: true + - property_name: service + url: https://api.github.com/orgs/github/properties/schema/service + source_type: organization + value_type: string + - property_name: team + url: https://api.github.com/orgs/github/properties/schema/team + source_type: organization + value_type: string + description: Team owning the repository + custom-property: + value: + property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + org-repo-custom-property-values: + value: + - repository_id: 1296269 + repository_name: Hello-World + repository_full_name: octocat/Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + type: object + org-repo-update-custom-property-values: + value: + repository_names: + - Hello-World + - octo-repo + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + type: object + ruleset-history: + value: + - version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + - version_id: 2 + actor: + id: 2 + type: User + updated_at: '2024-09-23T16:29:47Z' + - version_id: 1 + actor: + id: 1 + type: User + updated_at: '2024-08-23T16:29:47Z' + org-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 21 + name: super cool ruleset + target: branch + source_type: Organization + source: my-org + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + team-simple-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/organizations/1/team/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: https://api.github.com/organizations/1/team/1/repos + type: organization + organization_id: 1 + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + org-membership-items: + value: + - url: https://api.github.com/orgs/octocat/memberships/defunkt + state: active + role: admin + organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: [] + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - url: https://api.github.com/orgs/invitocat/memberships/defunkt + state: pending + role: admin + organization_url: https://api.github.com/orgs/invitocat + direct_membership: false + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + org-membership: + value: + url: https://api.github.com/orgs/invitocat/memberships/defunkt + state: pending + role: admin + organization_url: https://api.github.com/orgs/invitocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + org-membership-2: + value: + url: https://api.github.com/orgs/octocat/memberships/defunkt + state: active + role: admin + organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + orgs: + id: github.orgs.orgs + name: orgs + title: Orgs + methods: + list: + operation: + $ref: '#/paths/~1organizations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1orgs~1{org}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1orgs~1{org}/delete' + response: + mediaType: application/json + openAPIDocKey: '202' + enable_or_disable_security_product_on_all_org_repos: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1{security_product}~1{enablement}/post' + response: + mediaType: application/json + openAPIDocKey: '204' + list_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1orgs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/orgs/methods/get' + - $ref: '#/components/x-stackQL-resources/orgs/methods/list_for_user' + - $ref: '#/components/x-stackQL-resources/orgs/methods/list' + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/orgs/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/orgs/methods/delete' + replace: [] + artifact_deployment_records: + id: github.orgs.artifact_deployment_records + name: artifact_deployment_records + title: Artifact Deployment Records + methods: + create_artifact_deployment_record: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1artifacts~1metadata~1deployment-record/post' + response: + mediaType: application/json + openAPIDocKey: '200' + set_cluster_deployment_records: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1artifacts~1metadata~1deployment-record~1cluster~1{cluster}/post + response: + mediaType: application/json + openAPIDocKey: '200' + list_artifact_deployment_records: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1artifacts~1{subject_digest}~1metadata~1deployment-records/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/artifact_deployment_records/methods/list_artifact_deployment_records + insert: + - $ref: >- + #/components/x-stackQL-resources/artifact_deployment_records/methods/set_cluster_deployment_records + - $ref: >- + #/components/x-stackQL-resources/artifact_deployment_records/methods/create_artifact_deployment_record + update: [] + delete: [] + replace: [] + artifact_storage_records: + id: github.orgs.artifact_storage_records + name: artifact_storage_records + title: Artifact Storage Records + methods: + create_artifact_storage_record: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1artifacts~1metadata~1storage-record/post' + response: + mediaType: application/json + openAPIDocKey: '200' + list_artifact_storage_records: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1artifacts~1{subject_digest}~1metadata~1storage-records/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/artifact_storage_records/methods/list_artifact_storage_records + insert: + - $ref: >- + #/components/x-stackQL-resources/artifact_storage_records/methods/create_artifact_storage_record + update: [] + delete: [] + replace: [] + attestations: + id: github.orgs.attestations + name: attestations + title: Attestations + methods: + list_attestations_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1attestations~1bulk-list/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_attestations_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1attestations~1delete-request/post' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_attestations_by_subject_digest: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1attestations~1digest~1{subject_digest}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + delete_attestations_by_id: + operation: + $ref: '#/paths/~1orgs~1{org}~1attestations~1{attestation_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list_attestations: + operation: + $ref: '#/paths/~1orgs~1{org}~1attestations~1{subject_digest}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attestations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/list_attestations + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/delete_attestations_by_subject_digest + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/delete_attestations_by_id + replace: [] + attestation_repositories: + id: github.orgs.attestation_repositories + name: attestation_repositories + title: Attestation Repositories + methods: + list_attestation_repositories: + operation: + $ref: '#/paths/~1orgs~1{org}~1attestations~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/attestation_repositories/methods/list_attestation_repositories + insert: [] + update: [] + delete: [] + replace: [] + blocking: + id: github.orgs.blocking + name: blocking + title: Blocking + methods: + list_blocked_users: + operation: + $ref: '#/paths/~1orgs~1{org}~1blocks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_blocked_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1blocks~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + block_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1blocks~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unblock_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1blocks~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/blocking/methods/list_blocked_users + insert: [] + update: [] + delete: [] + replace: [] + failed_invitations: + id: github.orgs.failed_invitations + name: failed_invitations + title: Failed Invitations + methods: + list_failed_invitations: + operation: + $ref: '#/paths/~1orgs~1{org}~1failed_invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/failed_invitations/methods/list_failed_invitations + insert: [] + update: [] + delete: [] + replace: [] + webhooks: + id: github.orgs.webhooks + name: webhooks + title: Webhooks + methods: + list_webhooks: + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_webhook: + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_webhook: + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + ping_webhook: + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}~1pings/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/get_webhook' + - $ref: '#/components/x-stackQL-resources/webhooks/methods/list_webhooks' + insert: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/create_webhook' + update: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/update_webhook' + delete: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/delete_webhook' + replace: [] + webhook_config: + id: github.orgs.webhook_config + name: webhook_config + title: Webhook Config + methods: + get_webhook_config_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_webhook_config_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}~1config/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_config/methods/get_webhook_config_for_org + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/webhook_config/methods/update_webhook_config_for_org + delete: [] + replace: [] + webhook_deliveries: + id: github.orgs.webhook_deliveries + name: webhook_deliveries + title: Webhook Deliveries + methods: + list_webhook_deliveries: + operation: + $ref: '#/paths/~1orgs~1{org}~1hooks~1{hook_id}~1deliveries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_deliveries/methods/list_webhook_deliveries + insert: [] + update: [] + delete: [] + replace: [] + webhook_delivery: + id: github.orgs.webhook_delivery + name: webhook_delivery + title: Webhook Delivery + methods: + get_webhook_delivery: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1hooks~1{hook_id}~1deliveries~1{delivery_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + redeliver_webhook_delivery: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1hooks~1{hook_id}~1deliveries~1{delivery_id}~1attempts/post + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_delivery/methods/get_webhook_delivery + insert: [] + update: [] + delete: [] + replace: [] + api_insights_route_stats: + id: github.orgs.api_insights_route_stats + name: api_insights_route_stats + title: Api Insights Route Stats + methods: + get_route_stats_by_actor: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1insights~1api~1route-stats~1{actor_type}~1{actor_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_insights_route_stats/methods/get_route_stats_by_actor + insert: [] + update: [] + delete: [] + replace: [] + api_insights_subject_stats: + id: github.orgs.api_insights_subject_stats + name: api_insights_subject_stats + title: Api Insights Subject Stats + methods: + get_subject_stats: + operation: + $ref: '#/paths/~1orgs~1{org}~1insights~1api~1subject-stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_insights_subject_stats/methods/get_subject_stats + insert: [] + update: [] + delete: [] + replace: [] + api_insights_summary_stats: + id: github.orgs.api_insights_summary_stats + name: api_insights_summary_stats + title: Api Insights Summary Stats + methods: + get_summary_stats: + operation: + $ref: '#/paths/~1orgs~1{org}~1insights~1api~1summary-stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_summary_stats_by_user: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1insights~1api~1summary-stats~1users~1{user_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_summary_stats_by_actor: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1insights~1api~1summary-stats~1{actor_type}~1{actor_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_insights_summary_stats/methods/get_summary_stats_by_actor + - $ref: >- + #/components/x-stackQL-resources/api_insights_summary_stats/methods/get_summary_stats_by_user + - $ref: >- + #/components/x-stackQL-resources/api_insights_summary_stats/methods/get_summary_stats + insert: [] + update: [] + delete: [] + replace: [] + api_insights_time_stats: + id: github.orgs.api_insights_time_stats + name: api_insights_time_stats + title: Api Insights Time Stats + methods: + get_time_stats: + operation: + $ref: '#/paths/~1orgs~1{org}~1insights~1api~1time-stats/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_time_stats_by_user: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1insights~1api~1time-stats~1users~1{user_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_time_stats_by_actor: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1insights~1api~1time-stats~1{actor_type}~1{actor_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_insights_time_stats/methods/get_time_stats_by_actor + - $ref: >- + #/components/x-stackQL-resources/api_insights_time_stats/methods/get_time_stats_by_user + - $ref: >- + #/components/x-stackQL-resources/api_insights_time_stats/methods/get_time_stats + insert: [] + update: [] + delete: [] + replace: [] + api_insights_user_stats: + id: github.orgs.api_insights_user_stats + name: api_insights_user_stats + title: Api Insights User Stats + methods: + get_user_stats: + operation: + $ref: '#/paths/~1orgs~1{org}~1insights~1api~1user-stats~1{user_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/api_insights_user_stats/methods/get_user_stats + insert: [] + update: [] + delete: [] + replace: [] + app_installations: + id: github.orgs.app_installations + name: app_installations + title: App Installations + methods: + list_app_installations: + operation: + $ref: '#/paths/~1orgs~1{org}~1installations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/app_installations/methods/list_app_installations + insert: [] + update: [] + delete: [] + replace: [] + invitations: + id: github.orgs.invitations + name: invitations + title: Invitations + methods: + list_pending_invitations: + operation: + $ref: '#/paths/~1orgs~1{org}~1invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_invitation: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1invitations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + cancel_invitation: + operation: + $ref: '#/paths/~1orgs~1{org}~1invitations~1{invitation_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/list_pending_invitations + insert: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/create_invitation + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/cancel_invitation + replace: [] + invitation_teams: + id: github.orgs.invitation_teams + name: invitation_teams + title: Invitation Teams + methods: + list_invitation_teams: + operation: + $ref: '#/paths/~1orgs~1{org}~1invitations~1{invitation_id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/invitation_teams/methods/list_invitation_teams + insert: [] + update: [] + delete: [] + replace: [] + issue_fields: + id: github.orgs.issue_fields + name: issue_fields + title: Issue Fields + methods: + list_issue_fields: + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-fields/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_issue_field: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-fields/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_issue_field: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-fields~1{issue_field_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_issue_field: + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-fields~1{issue_field_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_fields/methods/list_issue_fields + insert: + - $ref: >- + #/components/x-stackQL-resources/issue_fields/methods/create_issue_field + update: + - $ref: >- + #/components/x-stackQL-resources/issue_fields/methods/update_issue_field + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_fields/methods/delete_issue_field + replace: [] + issue_types: + id: github.orgs.issue_types + name: issue_types + title: Issue Types + methods: + list_issue_types: + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-types/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_issue_type: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-types/post' + response: + mediaType: application/json + openAPIDocKey: '200' + update_issue_type: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-types~1{issue_type_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_issue_type: + operation: + $ref: '#/paths/~1orgs~1{org}~1issue-types~1{issue_type_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_types/methods/list_issue_types + insert: + - $ref: >- + #/components/x-stackQL-resources/issue_types/methods/create_issue_type + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_types/methods/delete_issue_type + replace: + - $ref: >- + #/components/x-stackQL-resources/issue_types/methods/update_issue_type + members: + id: github.orgs.members + name: members + title: Members + methods: + list_members: + operation: + $ref: '#/paths/~1orgs~1{org}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_member: + operation: + $ref: '#/paths/~1orgs~1{org}~1members~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/members/methods/list_members' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/members/methods/remove_member' + replace: [] + memberships: + id: github.orgs.memberships + name: memberships + title: Memberships + methods: + check_membership_for_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1members~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + get_membership_for_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1memberships~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_membership_for_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1memberships~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_membership_for_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1memberships~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_memberships_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1memberships~1orgs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_membership_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1memberships~1orgs~1{org}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_membership_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1memberships~1orgs~1{org}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/get_membership_for_user + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/get_membership_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/list_memberships_for_authenticated_user + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/update_membership_for_authenticated_user + delete: + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/remove_membership_for_user + replace: + - $ref: >- + #/components/x-stackQL-resources/memberships/methods/set_membership_for_user + roles: + id: github.orgs.roles + name: roles + title: Roles + methods: + list_org_roles: + operation: + $ref: '#/paths/~1orgs~1{org}~1organization-roles/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_role: + operation: + $ref: '#/paths/~1orgs~1{org}~1organization-roles~1{role_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/roles/methods/get_org_role' + - $ref: '#/components/x-stackQL-resources/roles/methods/list_org_roles' + insert: [] + update: [] + delete: [] + replace: [] + role_team_assignments: + id: github.orgs.role_team_assignments + name: role_team_assignments + title: Role Team Assignments + methods: + revoke_all_org_roles_team: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1organization-roles~1teams~1{team_slug}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + assign_team_to_org_role: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1organization-roles~1teams~1{team_slug}~1{role_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + revoke_org_role_team: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1organization-roles~1teams~1{team_slug}~1{role_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_org_role_teams: + operation: + $ref: '#/paths/~1orgs~1{org}~1organization-roles~1{role_id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/role_team_assignments/methods/list_org_role_teams + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/role_team_assignments/methods/revoke_org_role_team + - $ref: >- + #/components/x-stackQL-resources/role_team_assignments/methods/revoke_all_org_roles_team + replace: + - $ref: >- + #/components/x-stackQL-resources/role_team_assignments/methods/assign_team_to_org_role + role_user_assignments: + id: github.orgs.role_user_assignments + name: role_user_assignments + title: Role User Assignments + methods: + revoke_all_org_roles_user: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1organization-roles~1users~1{username}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + assign_user_to_org_role: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1organization-roles~1users~1{username}~1{role_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + revoke_org_role_user: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1organization-roles~1users~1{username}~1{role_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_org_role_users: + operation: + $ref: '#/paths/~1orgs~1{org}~1organization-roles~1{role_id}~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/role_user_assignments/methods/list_org_role_users + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/role_user_assignments/methods/revoke_org_role_user + - $ref: >- + #/components/x-stackQL-resources/role_user_assignments/methods/revoke_all_org_roles_user + replace: + - $ref: >- + #/components/x-stackQL-resources/role_user_assignments/methods/assign_user_to_org_role + outside_collaborators: + id: github.orgs.outside_collaborators + name: outside_collaborators + title: Outside Collaborators + methods: + list_outside_collaborators: + operation: + $ref: '#/paths/~1orgs~1{org}~1outside_collaborators/get' + response: + mediaType: application/json + openAPIDocKey: '200' + convert_member_to_outside_collaborator: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1outside_collaborators~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '202' + remove_outside_collaborator: + operation: + $ref: '#/paths/~1orgs~1{org}~1outside_collaborators~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/outside_collaborators/methods/list_outside_collaborators + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/outside_collaborators/methods/remove_outside_collaborator + replace: [] + pat_grant_requests: + id: github.orgs.pat_grant_requests + name: pat_grant_requests + title: Pat Grant Requests + methods: + list_pat_grant_requests: + operation: + $ref: '#/paths/~1orgs~1{org}~1personal-access-token-requests/get' + response: + mediaType: application/json + openAPIDocKey: '200' + review_pat_grant_requests_in_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1personal-access-token-requests/post' + response: + mediaType: application/json + openAPIDocKey: '202' + review_pat_grant_request: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1personal-access-token-requests~1{pat_request_id}/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pat_grant_requests/methods/list_pat_grant_requests + insert: [] + update: [] + delete: [] + replace: [] + repos_for_pat_grant_requests: + id: github.orgs.repos_for_pat_grant_requests + name: repos_for_pat_grant_requests + title: Repos For Pat Grant Requests + methods: + list_pat_grant_request_repositories: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1personal-access-token-requests~1{pat_request_id}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos_for_pat_grant_requests/methods/list_pat_grant_request_repositories + insert: [] + update: [] + delete: [] + replace: [] + pat_grants: + id: github.orgs.pat_grants + name: pat_grants + title: Pat Grants + methods: + list_pat_grants: + operation: + $ref: '#/paths/~1orgs~1{org}~1personal-access-tokens/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_pat_accesses: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1personal-access-tokens/post' + response: + mediaType: application/json + openAPIDocKey: '202' + update_pat_access: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1personal-access-tokens~1{pat_id}/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pat_grants/methods/list_pat_grants + insert: [] + update: [] + delete: [] + replace: [] + repos_for_pat_grants: + id: github.orgs.repos_for_pat_grants + name: repos_for_pat_grants + title: Repos For Pat Grants + methods: + list_pat_grant_repositories: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1personal-access-tokens~1{pat_id}~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos_for_pat_grants/methods/list_pat_grant_repositories + insert: [] + update: [] + delete: [] + replace: [] + custom_properties: + id: github.orgs.custom_properties + name: custom_properties + title: Custom Properties + methods: + custom_properties_for_repos_get_organization_definitions: + operation: + $ref: '#/paths/~1orgs~1{org}~1properties~1schema/get' + response: + mediaType: application/json + openAPIDocKey: '200' + custom_properties_for_repos_create_or_update_organization_definitions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1properties~1schema/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + custom_properties_for_repos_get_organization_definition: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1properties~1schema~1{custom_property_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + custom_properties_for_repos_create_or_update_organization_definition: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1properties~1schema~1{custom_property_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + custom_properties_for_repos_delete_organization_definition: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1properties~1schema~1{custom_property_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_properties/methods/custom_properties_for_repos_get_organization_definition + - $ref: >- + #/components/x-stackQL-resources/custom_properties/methods/custom_properties_for_repos_get_organization_definitions + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/custom_properties/methods/custom_properties_for_repos_create_or_update_organization_definitions + delete: + - $ref: >- + #/components/x-stackQL-resources/custom_properties/methods/custom_properties_for_repos_delete_organization_definition + replace: + - $ref: >- + #/components/x-stackQL-resources/custom_properties/methods/custom_properties_for_repos_create_or_update_organization_definition + custom_property_values: + id: github.orgs.custom_property_values + name: custom_property_values + title: Custom Property Values + methods: + custom_properties_for_repos_get_organization_values: + operation: + $ref: '#/paths/~1orgs~1{org}~1properties~1values/get' + response: + mediaType: application/json + openAPIDocKey: '200' + custom_properties_for_repos_create_or_update_organization_values: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1properties~1values/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_property_values/methods/custom_properties_for_repos_get_organization_values + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/custom_property_values/methods/custom_properties_for_repos_create_or_update_organization_values + delete: [] + replace: [] + public_members: + id: github.orgs.public_members + name: public_members + title: Public Members + methods: + list_public_members: + operation: + $ref: '#/paths/~1orgs~1{org}~1public_members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_public_membership_for_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1public_members~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + set_public_membership_for_authenticated_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1public_members~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + remove_public_membership_for_authenticated_user: + operation: + $ref: '#/paths/~1orgs~1{org}~1public_members~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_members/methods/list_public_members + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/public_members/methods/remove_public_membership_for_authenticated_user + replace: + - $ref: >- + #/components/x-stackQL-resources/public_members/methods/set_public_membership_for_authenticated_user + ruleset_history: + id: github.orgs.ruleset_history + name: ruleset_history + title: Ruleset History + methods: + get_org_ruleset_history: + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets~1{ruleset_id}~1history/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_ruleset_version: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1rulesets~1{ruleset_id}~1history~1{version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ruleset_history/methods/get_org_ruleset_version + - $ref: >- + #/components/x-stackQL-resources/ruleset_history/methods/get_org_ruleset_history + insert: [] + update: [] + delete: [] + replace: [] + security_managers: + id: github.orgs.security_managers + name: security_managers + title: Security Managers + methods: + list_security_manager_teams: + operation: + $ref: '#/paths/~1orgs~1{org}~1security-managers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_security_manager_team: + operation: + $ref: '#/paths/~1orgs~1{org}~1security-managers~1teams~1{team_slug}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + remove_security_manager_team: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1security-managers~1teams~1{team_slug}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_managers/methods/list_security_manager_teams + insert: + - $ref: >- + #/components/x-stackQL-resources/security_managers/methods/add_security_manager_team + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/security_managers/methods/remove_security_manager_team + replace: [] + immutable_releases_settings: + id: github.orgs.immutable_releases_settings + name: immutable_releases_settings + title: Immutable Releases Settings + methods: + get_immutable_releases_settings: + operation: + $ref: '#/paths/~1orgs~1{org}~1settings~1immutable-releases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + set_immutable_releases_settings: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1settings~1immutable-releases/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/immutable_releases_settings/methods/get_immutable_releases_settings + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/immutable_releases_settings/methods/set_immutable_releases_settings + immutable_releases_repos: + id: github.orgs.immutable_releases_repos + name: immutable_releases_repos + title: Immutable Releases Repos + methods: + get_immutable_releases_settings_repositories: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1immutable-releases~1repositories/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_immutable_releases_settings_repositories: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1immutable-releases~1repositories/put + response: + mediaType: application/json + openAPIDocKey: '204' + enable_selected_repository_immutable_releases_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1immutable-releases~1repositories~1{repository_id}/put + response: + mediaType: application/json + openAPIDocKey: '204' + disable_selected_repository_immutable_releases_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1settings~1immutable-releases~1repositories~1{repository_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/immutable_releases_repos/methods/get_immutable_releases_settings_repositories + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/immutable_releases_repos/methods/disable_selected_repository_immutable_releases_organization + replace: + - $ref: >- + #/components/x-stackQL-resources/immutable_releases_repos/methods/enable_selected_repository_immutable_releases_organization + - $ref: >- + #/components/x-stackQL-resources/immutable_releases_repos/methods/set_immutable_releases_settings_repositories + orgs_for_user: + id: github.orgs.orgs_for_user + name: orgs_for_user + title: Orgs For User + methods: + list_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1orgs/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/orgs_for_user/methods/list_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/packages.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/packages.yaml new file mode 100644 index 0000000..7a4e934 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/packages.yaml @@ -0,0 +1,3035 @@ +openapi: 3.0.3 +info: + title: packages API + description: Manage packages for authenticated users and organizations. + version: 1.1.4 +paths: + /orgs/{org}/docker/conflicts: + get: + summary: >- + Get list of conflicting packages during Docker migration for + organization + description: >- + Lists all packages that are in a specific organization, are readable by + the requesting user, and that encountered a conflict during a Docker + migration. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. + tags: + - packages + operationId: packages/list-docker-migration-conflicting-packages-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-org' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages: + get: + summary: List packages for an organization + description: >- + Lists packages in an organization readable by the user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/list-packages-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#list-packages-for-an-organization + parameters: + - name: package_type + description: >- + The type of supported package. Packages in GitHub's Gradle registry + have the type `maven`. Docker images pushed to GitHub's Container + registry (`ghcr.io`) have the type `container`. You can use the type + `docker` to find images that were pushed to GitHub's Docker registry + (`docker.pkg.github.com`), even if these have now been migrated to + the Container registry. + in: query + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-visibility' + - name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + - name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-org' + '400': + $ref: '#/components/responses/package_es_list_error' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}: + get: + summary: Get a package for an organization + description: >- + Gets a specific package in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/package-org' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package for an organization + description: >- + Deletes an entire package in an organization. You cannot delete a public + package if any version of the package has more than 5,000 downloads. In + this scenario, contact GitHub support for further assistance. + + + The authenticated user must have admin permissions in the organization + to use this endpoint. If the `package_type` belongs to a GitHub Packages + registry that supports granular permissions, the authenticated user must + also have admin permissions to the package. For the list of these + registries, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `delete:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/restore: + post: + summary: Restore a package for an organization + description: >- + Restores an entire package in an organization. + + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + The authenticated user must have admin permissions in the organization + to use this endpoint. If the `package_type` belongs to a GitHub Packages + registry that supports granular permissions, the authenticated user must + also have admin permissions to the package. For the list of these + registries, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `write:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - name: token + description: package token + schema: + type: string + required: false + in: query + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/versions: + get: + summary: List package versions for a package owned by an organization + description: >- + Lists package versions for a package owned by an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-all-package-versions-for-package-owned-by-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-versions-for-org' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}: + get: + summary: Get a package version for an organization + description: >- + Gets a specific package version in an organization. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-version-for-organization + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-version-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-version-org' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete package version for an organization + description: >- + Deletes a specific package version in an organization. If the package is + public and the package version has more than 5,000 downloads, you cannot + delete the package version. In this scenario, contact GitHub support for + further assistance. + + + The authenticated user must have admin permissions in the organization + to use this endpoint. If the `package_type` belongs to a GitHub Packages + registry that supports granular permissions, the authenticated user must + also have admin permissions to the package. For the list of these + registries, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `delete:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-version-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: + post: + summary: Restore package version for an organization + description: >- + Restores a specific package version in an organization. + + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + The authenticated user must have admin permissions in the organization + to use this endpoint. If the `package_type` belongs to a GitHub Packages + registry that supports granular permissions, the authenticated user must + also have admin permissions to the package. For the list of these + registries, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `write:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-version-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/docker/conflicts: + get: + summary: >- + Get list of conflicting packages during Docker migration for + authenticated-user + description: >- + Lists all packages that are owned by the authenticated user within the + user's namespace, and that encountered a conflict during a Docker + migration. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. + tags: + - packages + operationId: >- + packages/list-docker-migration-conflicting-packages-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages: + get: + summary: List packages for the authenticated user's namespace + description: >- + Lists packages owned by the authenticated user within the user's + namespace. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/list-packages-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace + parameters: + - name: package_type + description: >- + The type of supported package. Packages in GitHub's Gradle registry + have the type `maven`. Docker images pushed to GitHub's Container + registry (`ghcr.io`) have the type `container`. You can use the type + `docker` to find images that were pushed to GitHub's Docker registry + (`docker.pkg.github.com`), even if these have now been migrated to + the Container registry. + in: query + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + - $ref: '#/components/parameters/package-visibility' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + '400': + $ref: '#/components/responses/package_es_list_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}: + get: + summary: Get a package for the authenticated user + description: >- + Gets a specific package for a package owned by the authenticated user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/package-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package for the authenticated user + description: >- + Deletes a package owned by the authenticated user. You cannot delete a + public package if any version of the package has more than 5,000 + downloads. In this scenario, contact GitHub support for further + assistance. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `delete:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/restore: + post: + summary: Restore a package for the authenticated user + description: >- + Restores a package owned by the authenticated user. + + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `write:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - name: token + description: package token + schema: + type: string + required: false + in: query + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/versions: + get: + summary: List package versions for a package owned by the authenticated user + description: >- + Lists package versions for a package owned by the authenticated user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: >- + packages/get-all-package-versions-for-package-owned-by-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: >- + #/components/examples/package-versions-for-authenticated-user + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/versions/{package_version_id}: + get: + summary: Get a package version for the authenticated user + description: >- + Gets a specific package version for a package owned by the authenticated + user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-version-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-version-authenticated-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package version for the authenticated user + description: >- + Deletes a specific package version for a package owned by the + authenticated user. If the package is public and the package version + has more than 5,000 downloads, you cannot delete the package version. In + this scenario, contact GitHub support for further assistance. + + + The authenticated user must have admin permissions in the organization + to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `delete:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-version-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: + post: + summary: Restore a package version for the authenticated user + description: >- + Restores a package version owned by the authenticated user. + + + You can restore a deleted package version under the following + conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `write:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-version-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/docker/conflicts: + get: + summary: Get list of conflicting packages during Docker migration for user + description: >- + Lists all packages that are in a specific user's namespace, that the + requesting user has access to, and that encountered a conflict during + Docker migration. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. + tags: + - packages + operationId: packages/list-docker-migration-conflicting-packages-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages: + get: + summary: List packages for a user + description: >- + Lists all packages in a user's namespace for which the requesting user + has access. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/list-packages-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#list-packages-for-a-user + parameters: + - name: package_type + description: >- + The type of supported package. Packages in GitHub's Gradle registry + have the type `maven`. Docker images pushed to GitHub's Container + registry (`ghcr.io`) have the type `container`. You can use the type + `docker` to find images that were pushed to GitHub's Docker registry + (`docker.pkg.github.com`), even if these have now been migrated to + the Container registry. + in: query + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + - $ref: '#/components/parameters/package-visibility' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + '400': + $ref: '#/components/responses/package_es_list_error' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}: + get: + summary: Get a package for a user + description: >- + Gets a specific package metadata for a public package owned by a user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-a-package-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/package-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package for a user + description: >- + Deletes an entire package for a user. You cannot delete a public package + if any version of the package has more than 5,000 downloads. In this + scenario, contact GitHub support for further assistance. + + + If the `package_type` belongs to a GitHub Packages registry that + supports granular permissions, the authenticated user must have admin + permissions to the package. For the list of these registries, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `delete:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/restore: + post: + summary: Restore a package for a user + description: >- + Restores an entire package for a user. + + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + If the `package_type` belongs to a GitHub Packages registry that + supports granular permissions, the authenticated user must have admin + permissions to the package. For the list of these registries, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `write:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + - name: token + description: package token + schema: + type: string + required: false + in: query + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/versions: + get: + summary: List package versions for a package owned by a user + description: >- + Lists package versions for a public package owned by a specified user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-all-package-versions-for-package-owned-by-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-versions-for-user' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}: + get: + summary: Get a package version for a user + description: >- + Gets a specific package version for a public package owned by a + specified user. + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` scope to use this endpoint. For more information, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-version-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-version-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete package version for a user + description: >- + Deletes a specific package version for a user. If the package is public + and the package version has more than 5,000 downloads, you cannot delete + the package version. In this scenario, contact GitHub support for + further assistance. + + + If the `package_type` belongs to a GitHub Packages registry that + supports granular permissions, the authenticated user must have admin + permissions to the package. For the list of these registries, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `delete:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-version-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: + post: + summary: Restore package version for a user + description: >- + Restores a specific package version for a user. + + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + If the `package_type` belongs to a GitHub Packages registry that + supports granular permissions, the authenticated user must have admin + permissions to the package. For the list of these registries, see + "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:packages` and `write:packages` scopes to use this endpoint. For + more information, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-version-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages +components: + schemas: + package: + title: Package + description: A software package + type: object + properties: + id: + description: Unique identifier of the package. + type: integer + example: 1 + name: + description: The name of the package. + type: string + example: super-linter + package_type: + type: string + example: docker + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + url: + type: string + example: https://api.github.com/orgs/github/packages/container/super-linter + html_url: + type: string + example: >- + https://github.com/orgs/github/packages/container/package/super-linter + version_count: + description: The number of versions of the package. + type: integer + example: 1 + visibility: + type: string + example: private + enum: + - private + - public + owner: + $ref: '#/components/schemas/nullable-simple-user' + repository: + $ref: '#/components/schemas/nullable-minimal-repository' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - name + - package_type + - visibility + - url + - html_url + - version_count + - created_at + - updated_at + package-version: + title: Package Version + description: A version of a software package + type: object + properties: + id: + description: Unique identifier of the package version. + type: integer + example: 1 + name: + description: The name of the package version. + type: string + example: latest + url: + type: string + example: >- + https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 + package_html_url: + type: string + example: >- + https://github.com/orgs/github/packages/container/package/super-linter + html_url: + type: string + example: >- + https://github.com/orgs/github/packages/container/super-linter/786068 + license: + type: string + example: MIT + description: + type: string + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + deleted_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + metadata: + type: object + title: Package Version Metadata + properties: + package_type: + type: string + example: docker + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + container: + type: object + title: Container Metadata + properties: + tags: + type: array + items: + type: string + required: + - tags + docker: + type: object + title: Docker Metadata + properties: + tag: + type: array + items: + type: string + required: + - tags + required: + - package_type + required: + - id + - name + - url + - package_html_url + - created_at + - updated_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + responses: + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + package_es_list_error: + description: >- + The value of `per_page` multiplied by `page` cannot be greater than + 10000. + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + package-visibility: + name: visibility + description: >- + The selected visibility of the packages. This parameter is optional and + only filters an existing result set. + + + The `internal` visibility is only supported for GitHub Packages + registries that allow for granular permissions. For other ecosystems + `internal` is synonymous with `private`. + + For the list of GitHub Packages registries that support granular + permissions, see "[About permissions for GitHub + Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + in: query + required: false + schema: + type: string + enum: + - public + - private + - internal + package-type: + name: package_type + description: >- + The type of supported package. Packages in GitHub's Gradle registry have + the type `maven`. Docker images pushed to GitHub's Container registry + (`ghcr.io`) have the type `container`. You can use the type `docker` to + find images that were pushed to GitHub's Docker registry + (`docker.pkg.github.com`), even if these have now been migrated to the + Container registry. + in: path + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + package-name: + name: package_name + description: The name of the package. + in: path + required: true + schema: + type: string + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + package-version-id: + name: package_version_id + description: Unique identifier of the package version. + in: path + required: true + schema: + type: integer + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + packages-for-org: + value: + - id: 197 + name: hello_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + version_count: 1 + visibility: private + url: https://api.github.com/orgs/github/packages/container/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: >- + https://github.com/orgs/github/packages/container/package/hello_docker + - id: 198 + name: goodbye_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + version_count: 2 + visibility: private + url: https://api.github.com/orgs/github/packages/container/goodbye_docker + created_at: '2020-05-20T22:19:11Z' + updated_at: '2020-05-20T22:19:11Z' + html_url: >- + https://github.com/orgs/github/packages/container/package/goodbye_docker + package-org: + value: + id: 197 + name: hello_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + version_count: 1 + visibility: private + url: https://api.github.com/orgs/github/packages/container/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/package/hello_docker + package-versions-for-org: + value: + - id: 245301 + name: 1.0.4 + url: >- + https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301 + package_html_url: https://github.com/octo-org/hello-world-npm/packages/43752 + created_at: '2019-11-05T22:49:04Z' + updated_at: '2019-11-05T22:49:04Z' + html_url: >- + https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4 + metadata: + package_type: npm + - id: 209672 + name: 1.0.3 + url: >- + https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672 + package_html_url: https://github.com/octo-org/hello-world-npm/packages/43752 + created_at: '2019-10-29T15:42:11Z' + updated_at: '2019-10-29T15:42:12Z' + html_url: >- + https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3 + metadata: + package_type: npm + package-version-org: + value: + id: 836 + name: >- + sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 + url: >- + https://api.github.com/orgs/github/packages/container/hello_docker/versions/836 + package_html_url: https://github.com/orgs/github/packages/container/package/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/hello_docker/836 + metadata: + package_type: container + container: + tags: + - latest + packages-for-user: + value: + - id: 197 + name: hello_docker + package_type: container + owner: + login: octocat + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.octocatusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: User + site_admin: false + version_count: 1 + visibility: private + url: https://api.github.com/orgs/github/packages/container/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: >- + https://github.com/orgs/github/packages/container/package/hello_docker + - id: 198 + name: goodbye_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: User + site_admin: false + version_count: 2 + visibility: private + url: >- + https://api.github.com/user/octocat/packages/container/goodbye_docker + created_at: '2020-05-20T22:19:11Z' + updated_at: '2020-05-20T22:19:11Z' + html_url: >- + https://github.com/user/octocat/packages/container/package/goodbye_docker + package-user: + value: + id: 40201 + name: octo-name + package_type: rubygems + owner: + login: octocat + id: 209477 + node_id: MDQ6VXNlcjIwOTQ3Nw== + avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + version_count: 3 + visibility: public + url: https://api.github.com/users/octocat/packages/rubygems/octo-name + created_at: '2019-10-20T14:17:14Z' + updated_at: '2019-10-20T14:17:14Z' + repository: + id: 216219492 + node_id: MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI= + name: octo-name-repo + full_name: octocat/octo-name-repo + private: false + owner: + login: octocat + id: 209477 + node_id: MDQ6VXNlcjIwOTQ3Nw== + avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + html_url: https://github.com/octocat/octo-name-repo + description: Project for octocats + fork: false + url: https://api.github.com/repos/octocat/octo-name-repo + forks_url: https://api.github.com/repos/octocat/octo-name-repo/forks + keys_url: https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octocat/octo-name-repo/teams + hooks_url: https://api.github.com/repos/octocat/octo-name-repo/hooks + issue_events_url: >- + https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number} + events_url: https://api.github.com/repos/octocat/octo-name-repo/events + assignees_url: https://api.github.com/repos/octocat/octo-name-repo/assignees{/user} + branches_url: >- + https://api.github.com/repos/octocat/octo-name-repo/branches{/branch} + tags_url: https://api.github.com/repos/octocat/octo-name-repo/tags + blobs_url: https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octocat/octo-name-repo/languages + stargazers_url: https://api.github.com/repos/octocat/octo-name-repo/stargazers + contributors_url: https://api.github.com/repos/octocat/octo-name-repo/contributors + subscribers_url: https://api.github.com/repos/octocat/octo-name-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/octo-name-repo/subscription + commits_url: https://api.github.com/repos/octocat/octo-name-repo/commits{/sha} + git_commits_url: >- + https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha} + comments_url: >- + https://api.github.com/repos/octocat/octo-name-repo/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octocat/octo-name-repo/contents/{+path} + compare_url: >- + https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octocat/octo-name-repo/merges + archive_url: >- + https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octocat/octo-name-repo/downloads + issues_url: https://api.github.com/repos/octocat/octo-name-repo/issues{/number} + pulls_url: https://api.github.com/repos/octocat/octo-name-repo/pulls{/number} + milestones_url: >- + https://api.github.com/repos/octocat/octo-name-repo/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octocat/octo-name-repo/labels{/name} + releases_url: https://api.github.com/repos/octocat/octo-name-repo/releases{/id} + deployments_url: https://api.github.com/repos/octocat/octo-name-repo/deployments + html_url: https://github.com/octocat/octo-name-repo/packages/40201 + package-versions-for-authenticated-user: + value: + - id: 45763 + name: >- + sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9 + url: >- + https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763 + package_html_url: >- + https://github.com/users/octocat/packages/container/package/hello_docker + created_at: '2020-09-11T21:56:40Z' + updated_at: '2021-02-05T21:32:32Z' + html_url: >- + https://github.com/users/octocat/packages/container/hello_docker/45763 + metadata: + package_type: container + container: + tags: + - latest + - id: 881 + name: >- + sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 + url: >- + https://api.github.com/users/octocat/packages/container/hello_docker/versions/881 + package_html_url: >- + https://github.com/users/octocat/packages/container/package/hello_docker + created_at: '2020-05-21T22:22:20Z' + updated_at: '2021-02-05T21:32:32Z' + html_url: https://github.com/users/octocat/packages/container/hello_docker/881 + metadata: + package_type: container + container: + tags: [] + package-version-authenticated-user: + value: + id: 214 + name: >- + sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a + url: >- + https://api.github.com/users/octocat/packages/container/hello_docker/versions/214 + package_html_url: >- + https://github.com/users/octocat/packages/container/package/hello_docker + created_at: '2020-05-15T03:46:45Z' + updated_at: '2020-05-15T03:46:45Z' + html_url: https://github.com/users/octocat/packages/container/hello_docker/214 + metadata: + package_type: container + container: + tags: + - 1.13.6 + package-versions-for-user: + value: + - id: 3497268 + name: 0.3.0 + url: >- + https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2020-08-31T15:22:11Z' + updated_at: '2020-08-31T15:22:12Z' + description: Project for octocats + html_url: >- + https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0 + metadata: + package_type: rubygems + - id: 387039 + name: 0.2.0 + url: >- + https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2019-12-01T20:49:29Z' + updated_at: '2019-12-01T20:49:30Z' + description: Project for octocats + html_url: >- + https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 + metadata: + package_type: rubygems + - id: 169770 + name: 0.1.0 + url: >- + https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2019-10-20T14:17:14Z' + updated_at: '2019-10-20T14:17:15Z' + html_url: >- + https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0 + metadata: + package_type: rubygems + package-version-user: + value: + id: 387039 + name: 0.2.0 + url: >- + https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2019-12-01T20:49:29Z' + updated_at: '2019-12-01T20:49:30Z' + description: Octo-name client for Ruby + html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 + metadata: + package_type: rubygems + x-stackQL-resources: + docker_migration_packages: + id: github.packages.docker_migration_packages + name: docker_migration_packages + title: Docker Migration Packages + methods: + list_docker_migration_conflicting_packages_for_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1docker~1conflicts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_docker_migration_conflicting_packages_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1docker~1conflicts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_docker_migration_conflicting_packages_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1docker~1conflicts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/docker_migration_packages/methods/list_docker_migration_conflicting_packages_for_organization + - $ref: >- + #/components/x-stackQL-resources/docker_migration_packages/methods/list_docker_migration_conflicting_packages_for_user + - $ref: >- + #/components/x-stackQL-resources/docker_migration_packages/methods/list_docker_migration_conflicting_packages_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + packages: + id: github.packages.packages + name: packages + title: Packages + methods: + list_packages_for_organization: + operation: + $ref: '#/paths/~1orgs~1{org}~1packages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_package_for_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_package_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + restore_package_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}~1restore/post + response: + mediaType: application/json + openAPIDocKey: '204' + list_packages_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1packages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_package_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1packages~1{package_type}~1{package_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_package_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1packages~1{package_type}~1{package_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + restore_package_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1packages~1{package_type}~1{package_name}~1restore/post + response: + mediaType: application/json + openAPIDocKey: '204' + list_packages_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1packages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_package_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_package_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + restore_package_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}~1restore/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/packages/methods/get_package_for_organization + - $ref: >- + #/components/x-stackQL-resources/packages/methods/get_package_for_user + - $ref: >- + #/components/x-stackQL-resources/packages/methods/get_package_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/packages/methods/list_packages_for_organization + - $ref: >- + #/components/x-stackQL-resources/packages/methods/list_packages_for_user + - $ref: >- + #/components/x-stackQL-resources/packages/methods/list_packages_for_authenticated_user + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/packages/methods/delete_package_for_org + - $ref: >- + #/components/x-stackQL-resources/packages/methods/delete_package_for_user + - $ref: >- + #/components/x-stackQL-resources/packages/methods/delete_package_for_authenticated_user + replace: [] + package_versions: + id: github.packages.package_versions + name: package_versions + title: Package Versions + methods: + get_all_package_versions_for_package_owned_by_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_package_version_for_organization: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_package_version_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + restore_package_version_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}~1restore/post + response: + mediaType: application/json + openAPIDocKey: '204' + get_all_package_versions_for_package_owned_by_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1packages~1{package_type}~1{package_name}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_package_version_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_package_version_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + restore_package_version_for_authenticated_user: + operation: + $ref: >- + #/paths/~1user~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}~1restore/post + response: + mediaType: application/json + openAPIDocKey: '204' + get_all_package_versions_for_package_owned_by_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}~1versions/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_package_version_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_package_version_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + restore_package_version_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1packages~1{package_type}~1{package_name}~1versions~1{package_version_id}~1restore/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/get_package_version_for_organization + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/get_package_version_for_user + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/get_all_package_versions_for_package_owned_by_org + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/get_package_version_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/get_all_package_versions_for_package_owned_by_user + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/get_all_package_versions_for_package_owned_by_authenticated_user + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/delete_package_version_for_org + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/delete_package_version_for_user + - $ref: >- + #/components/x-stackQL-resources/package_versions/methods/delete_package_version_for_authenticated_user + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/private_registries.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/private_registries.yaml new file mode 100644 index 0000000..cc72a2e --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/private_registries.yaml @@ -0,0 +1,1097 @@ +openapi: 3.0.3 +info: + title: private_registries API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/private-registries: + get: + summary: List private registries for an organization + description: >- + + Lists all private registry configurations available at the + organization-level without revealing their encrypted + + values. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/list-org-private-registries + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - configurations + properties: + total_count: + type: integer + configurations: + type: array + items: + $ref: '#/components/schemas/org-private-registry-configuration' + examples: + default: + $ref: >- + #/components/examples/org-private-registry-configurations-paginated + headers: + Link: + $ref: '#/components/headers/link' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + post: + summary: Create a private registry for an organization + description: >- + + Creates a private registry configuration with an encrypted value for an + organization. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), + the `encrypted_value` and `key_id` fields should be omitted. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/create-org-private-registry + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: >- + The username to use when authenticating with the private + registry. This field should be omitted if the private + registry does not require a username for authentication. + type: string + nullable: true + replaces_base: + description: >- + Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for + rubygems). When set to `true`, Dependabot will only use this + registry and will not fall back to the public registry. When + set to `false` (default), Dependabot will use this registry + for scoped packages but may fall back to the public registry + for other packages. + type: boolean + default: false + encrypted_value: + description: >- + The value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private + registries public key for an + organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. Required when `auth_type` is `token` or + `username_password`. Should be omitted for OIDC auth types. + type: string + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + description: >- + The ID of the key you used to encrypt the secret. Required + when `auth_type` is `token` or `username_password`. Should + be omitted for OIDC auth types. + type: string + visibility: + description: >- + Which type of organization repositories have access to the + private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the + private registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: >- + An array of repository IDs that can access the organization + private registry. You can only provide a list of repository + IDs when `visibility` is set to `selected`. You can manage + the list of selected repositories using the [Update a + private registry for an + organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) + endpoint. This field should be omitted if `visibility` is + set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: >- + The authentication type for the private registry. Defaults + to `token` if not specified. Use `oidc_azure`, `oidc_aws`, + or `oidc_jfrog` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + tenant_id: + description: >- + The tenant ID of the Azure AD application. Required when + `auth_type` is `oidc_azure`. + type: string + client_id: + description: >- + The client ID of the Azure AD application. Required when + `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: >- + The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: >- + The CodeArtifact domain. Required when `auth_type` is + `oidc_aws`. + type: string + domain_owner: + description: >- + The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: >- + The JFrog OIDC provider name. Required when `auth_type` is + `oidc_jfrog`. + type: string + audience: + description: >- + The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` + auth types. + type: string + identity_mapping_name: + description: >- + The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: >- + Example of a private registry configuration with private + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: >- + Example of a private registry configuration with selected + visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + $ref: >- + #/components/schemas/org-private-registry-configuration-with-selected-repositories + examples: + org-private-registry-with-selected-visibility: + $ref: '#/components/examples/org-private-registry-configuration' + org-private-registry-with-private-visibility: + $ref: >- + #/components/examples/org-private-registry-configuration-with-selected-repositories + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + /orgs/{org}/private-registries/public-key: + get: + summary: Get private registries public key for an organization + description: >- + + Gets the org public key, which is needed to encrypt private registry + secrets. You need to encrypt a secret before you can create or update + secrets. + + + OAuth tokens and personal access tokens (classic) need the `admin:org` + scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + $ref: '#/components/examples/private-registries-public-key' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + /orgs/{org}/private-registries/{secret_name}: + get: + summary: Get a private registry for an organization + description: >- + + Get the configuration of a single private registry defined for an + organization, omitting its encrypted value. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + $ref: '#/components/schemas/org-private-registry-configuration' + examples: + default: + $ref: '#/components/examples/org-private-registry-configuration' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + patch: + summary: Update a private registry for an organization + description: >- + + Updates a private registry configuration with an encrypted value for an + organization. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). + For more information, see "[Encrypting secrets for the REST + API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), + the `encrypted_value` and `key_id` fields should be omitted. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: >- + The username to use when authenticating with the private + registry. This field should be omitted if the private + registry does not require a username for authentication. + type: string + nullable: true + replaces_base: + description: >- + Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for + rubygems). When set to `true`, Dependabot will only use this + registry and will not fall back to the public registry. When + set to `false` (default), Dependabot will use this registry + for scoped packages but may fall back to the public registry + for other packages. + type: boolean + default: false + encrypted_value: + description: >- + The value for your secret, encrypted with + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get private + registries public key for an + organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) + endpoint. + type: string + pattern: >- + ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: >- + Which type of organization repositories have access to the + private registry. `selected` means only the repositories + specified by `selected_repository_ids` can access the + private registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: >- + An array of repository IDs that can access the organization + private registry. You can only provide a list of repository + IDs when `visibility` is set to `selected`. This field + should be omitted if `visibility` is set to `all` or + `private`. + type: array + items: + type: integer + auth_type: + description: >- + The authentication type for the private registry. This field + cannot be changed after creation. If provided, it must match + the existing `auth_type` of the configuration. To change the + authentication type, delete and recreate the configuration. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + tenant_id: + description: >- + The tenant ID of the Azure AD application. Required when + `auth_type` is `oidc_azure`. + type: string + client_id: + description: >- + The client ID of the Azure AD application. Required when + `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: >- + The AWS IAM role name. Required when `auth_type` is + `oidc_aws`. + type: string + domain: + description: >- + The CodeArtifact domain. Required when `auth_type` is + `oidc_aws`. + type: string + domain_owner: + description: >- + The CodeArtifact domain owner (AWS account ID). Required + when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: >- + The JFrog OIDC provider name. Required when `auth_type` is + `oidc_jfrog`. + type: string + audience: + description: >- + The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` + auth types. + type: string + identity_mapping_name: + description: >- + The JFrog identity mapping name. Optional for `oidc_jfrog` + auth type. + type: string + examples: + secret-based-update: + summary: Update a secret-based private registry + value: + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + oidc-azure-update: + summary: Update an OIDC private registry (Azure) + value: + tenant_id: 12345678-1234-1234-1234-123456789012 + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + delete: + summary: Delete a private registry for an organization + description: >- + + Delete a private registry configuration at the organization-level. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/delete-org-private-registry + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations +components: + schemas: + org-private-registry-configuration: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + example: MAVEN_REPOSITORY_SECRET + type: string + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private registry. + example: monalisa + type: string + nullable: true + replaces_base: + description: >- + Whether this private registry replaces the base registry (e.g., + npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back to the + public registry. When `false` (default), Dependabot will use this + registry for scoped packages but may fall back to the public + registry for other packages. + type: boolean + default: false + visibility: + description: >- + Which type of organization repositories have access to the private + registry. + enum: + - all + - private + - selected + type: string + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + org-private-registry-configuration-with-selected-repositories: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + example: MAVEN_REPOSITORY_SECRET + type: string + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private registry. + example: monalisa + type: string + replaces_base: + description: >- + Whether this private registry replaces the base registry (e.g., + npmjs.org for npm, rubygems.org for rubygems). When `true`, + Dependabot will only use this registry and will not fall back to the + public registry. When `false` (default), Dependabot will use this + registry for scoped packages but may fall back to the public + registry for other packages. + type: boolean + default: false + visibility: + description: >- + Which type of organization repositories have access to the private + registry. `selected` means only the repositories specified by + `selected_repository_ids` can access the private registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: >- + An array of repository IDs that can access the organization private + registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + examples: + org-private-registry-configurations-paginated: + value: + total_count: 1 + configurations: + - name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + org-private-registry-configuration: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-configuration-with-selected-repositories: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + private-registries-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + private_registries: + id: github.private_registries.private_registries + name: private_registries + title: Private Registries + methods: + list_org_private_registries: + operation: + $ref: '#/paths/~1orgs~1{org}~1private-registries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_org_private_registry: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1private-registries/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_org_private_registry: + operation: + $ref: '#/paths/~1orgs~1{org}~1private-registries~1{secret_name}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_org_private_registry: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1private-registries~1{secret_name}/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + delete_org_private_registry: + operation: + $ref: '#/paths/~1orgs~1{org}~1private-registries~1{secret_name}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_registries/methods/get_org_private_registry + - $ref: >- + #/components/x-stackQL-resources/private_registries/methods/list_org_private_registries + insert: + - $ref: >- + #/components/x-stackQL-resources/private_registries/methods/create_org_private_registry + update: + - $ref: >- + #/components/x-stackQL-resources/private_registries/methods/update_org_private_registry + delete: + - $ref: >- + #/components/x-stackQL-resources/private_registries/methods/delete_org_private_registry + replace: [] + private_registry_public_key: + id: github.private_registries.private_registry_public_key + name: private_registry_public_key + title: Private Registry Public Key + methods: + get_org_public_key: + operation: + $ref: '#/paths/~1orgs~1{org}~1private-registries~1public-key/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_registry_public_key/methods/get_org_public_key + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/projects.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/projects.yaml new file mode 100644 index 0000000..cbe0ec3 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/projects.yaml @@ -0,0 +1,6816 @@ +openapi: 3.0.3 +info: + title: projects API + description: Endpoints to manage Projects using the REST API. + version: 1.1.4 +paths: + /orgs/{org}/projectsV2: + get: + summary: List projects for organization + description: >- + List all projects owned by a specific organization accessible by the + authenticated user. + tags: + - projects + operationId: projects/list-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/projects#list-projects-for-organization + parameters: + - $ref: '#/components/parameters/org' + - name: q + description: Limit results to projects of the specified type. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /orgs/{org}/projectsV2/{project_number}: + get: + summary: Get project for organization + description: Get a specific organization-owned project. + tags: + - projects + operationId: projects/get-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/projects#get-project-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /orgs/{org}/projectsV2/{project_number}/drafts: + post: + summary: Create draft item for organization owned project + description: Create draft issue item for the specified organization owned project. + tags: + - projects + operationId: projects/create-draft-item-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: Details of the draft item to create in the project. + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the draft issue item to create in the project. + body: + type: string + description: >- + The body content of the draft issue item to create in the + project. + required: + - title + examples: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + draft_issue: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts + x-stackQL-resource: drafts + /orgs/{org}/projectsV2/{project_number}/fields: + get: + summary: List project fields for organization + description: List all fields for a specific organization-owned project. + tags: + - projects + operationId: projects/list-fields-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/fields#list-project-fields-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + single_select_options: + type: array + description: >- + The options available for single select fields. At least one + option must be provided when creating a single select field. + items: + $ref: >- + #/components/schemas/projects-v2-field-single-select-option + iteration_configuration: + $ref: >- + #/components/schemas/projects-v2-field-iteration-configuration + required: + - issue_field_id + - name + - data_type + - single_select_options + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select-request' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration-request' + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + text_field: + $ref: '#/components/examples/projects-v2-field-text' + number_field: + $ref: '#/components/examples/projects-v2-field-number' + date_field: + $ref: '#/components/examples/projects-v2-field-date' + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /orgs/{org}/projectsV2/{project_number}/fields/{field_id}: + get: + summary: Get project field for organization + description: Get a specific field for an organization-owned project. + tags: + - projects + operationId: projects/get-field-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/fields#get-project-field-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/field-id' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /orgs/{org}/projectsV2/{project_number}/items: + get: + summary: List items for an organization owned project + description: >- + List all items for a specific organization-owned project accessible by + the authenticated user. + tags: + - projects + operationId: projects/list-items-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - name: q + description: >- + Search query to filter items, see [Filtering + projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + in: query + required: false + schema: + type: string + - name: fields + description: >- + Limit results to specific fields, by their IDs. If not specified, + the title field will be returned. + + + Example: `fields[]=123&fields[]=456&fields[]=789` or + `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + post: + summary: Add item to organization owned project + description: >- + Add an issue or pull request item to the specified organization owned + project. + tags: + - projects + operationId: projects/add-item-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: >- + Details of the item to add to the project. You can specify either the + unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: >- + The type of item to add to the project. Must be either Issue + or PullRequest. + id: + type: integer + description: >- + The unique identifier of the issue or pull request to add to + the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + - id + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + issue_with_nwo: + summary: >- + Response for adding an issue using repository owner, name, + and issue number + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_nwo: + summary: >- + Response for adding a pull request using repository owner, + name, and PR number + value: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /orgs/{org}/projectsV2/{project_number}/items/{item_id}: + get: + summary: Get an item for an organization owned project + description: Get a specific item from an organization-owned project. + tags: + - projects + operationId: projects/get-org-item + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/item-id' + - name: fields + description: >- + Limit results to specific fields, by their IDs. If not specified, + the title field will be returned. + + + Example: fields[]=123&fields[]=456&fields[]=789 or + fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + patch: + summary: Update project item for organization + description: Update a specific item in an organization-owned project. + tags: + - projects + operationId: projects/update-item-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#update-project-item-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/item-id' + requestBody: + required: true + description: >- + Field updates to apply to the project item. Only text, number, date, + single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: >- + The new value for the field: + + - For text, number, and date fields, provide the new + value directly. + + - For single select and iteration fields, provide the + ID of the option or iteration. + + - To clear the field, set this to null. + nullable: true + oneOf: + - type: string + - type: number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + text_field: + $ref: '#/components/examples/projects-v2-item-with-content' + number_field: + $ref: '#/components/examples/projects-v2-item-with-content' + date_field: + $ref: '#/components/examples/projects-v2-item-with-content' + single_select_field: + $ref: '#/components/examples/projects-v2-item-with-content' + iteration_field: + $ref: '#/components/examples/projects-v2-item-with-content' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + delete: + summary: Delete project item for organization + description: Delete a specific item from an organization-owned project. + tags: + - projects + operationId: projects/delete-item-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#delete-project-item-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/item-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /orgs/{org}/projectsV2/{project_number}/views: + post: + summary: Create a view for an organization-owned project + description: >- + Create a new view in an organization-owned project. Views allow you to + customize how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + example: Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + example: board + filter: + type: string + description: >- + The filter query for the view. See [Filtering + projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + example: is:issue is:open + visible_fields: + type: array + description: >- + `visible_fields` is not applicable to `roadmap` layout + views. + + For `table` and `board` layouts, this represents the field + IDs that should be visible in the view. If not provided, the + default visible fields will be used. + items: + type: integer + example: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in an organization-owned project. + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-view' + examples: + table_view: + summary: Response for creating a table view + value: + $ref: '#/components/examples/projects-v2-view' + board_view: + summary: Response for creating a board view with filter + value: + $ref: '#/components/examples/projects-v2-view' + roadmap_view: + summary: Response for creating a roadmap view + value: + $ref: '#/components/examples/projects-v2-view' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + description: Service unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: views + x-stackQL-resource: views + /orgs/{org}/projectsV2/{project_number}/views/{view_number}/items: + get: + summary: List items for an organization project view + description: >- + List items in an organization project with the saved view's filter + applied. + tags: + - projects + operationId: projects/list-view-items-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/view-number' + - name: fields + description: >- + Limit results to specific fields, by their IDs. If not specified, + the + + title field will be returned. + + + Example: `fields[]=123&fields[]=456&fields[]=789` or + `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /user/{user_id}/projectsV2/{project_number}/drafts: + post: + summary: Create draft item for user owned project + description: Create draft issue item for the specified user owned project. + tags: + - projects + operationId: projects/create-draft-item-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project + parameters: + - $ref: '#/components/parameters/user-id' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: Details of the draft item to create in the project. + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the draft issue item to create in the project. + body: + type: string + description: >- + The body content of the draft issue item to create in the + project. + required: + - title + examples: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + draft_issue: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts + x-stackQL-resource: drafts + /users/{user_id}/projectsV2/{project_number}/views: + post: + summary: Create a view for a user-owned project + description: >- + Create a new view in a user-owned project. Views allow you to customize + how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project + parameters: + - $ref: '#/components/parameters/user-id' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + example: Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + example: board + filter: + type: string + description: >- + The filter query for the view. See [Filtering + projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + example: is:issue is:open + visible_fields: + type: array + description: >- + `visible_fields` is not applicable to `roadmap` layout + views. + + For `table` and `board` layouts, this represents the field + IDs that should be visible in the view. If not provided, the + default visible fields will be used. + items: + type: integer + example: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in a user-owned project. + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-view' + examples: + table_view: + summary: Response for creating a table view + value: + $ref: '#/components/examples/projects-v2-view' + board_view: + summary: Response for creating a board view with filter + value: + $ref: '#/components/examples/projects-v2-view' + roadmap_view: + summary: Response for creating a roadmap view + value: + $ref: '#/components/examples/projects-v2-view' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + description: Service unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: views + x-stackQL-resource: views + /users/{username}/projectsV2: + get: + summary: List projects for user + description: >- + List all projects owned by a specific user accessible by the + authenticated user. + tags: + - projects + operationId: projects/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#list-projects-for-user + parameters: + - $ref: '#/components/parameters/username' + - name: q + description: Limit results to projects of the specified type. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /users/{username}/projectsV2/{project_number}: + get: + summary: Get project for user + description: Get a specific user-owned project. + tags: + - projects + operationId: projects/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /users/{username}/projectsV2/{project_number}/fields: + get: + summary: List project fields for user + description: List all fields for a specific user-owned project. + tags: + - projects + operationId: projects/list-fields-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/fields#list-project-fields-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + single_select_options: + type: array + description: >- + The options available for single select fields. At least one + option must be provided when creating a single select field. + items: + $ref: >- + #/components/schemas/projects-v2-field-single-select-option + iteration_configuration: + $ref: >- + #/components/schemas/projects-v2-field-iteration-configuration + required: + - name + - data_type + - single_select_options + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select-request' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration-request' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + text_field: + $ref: '#/components/examples/projects-v2-field-text' + number_field: + $ref: '#/components/examples/projects-v2-field-number' + date_field: + $ref: '#/components/examples/projects-v2-field-date' + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /users/{username}/projectsV2/{project_number}/fields/{field_id}: + get: + summary: Get project field for user + description: Get a specific field for a user-owned project. + tags: + - projects + operationId: projects/get-field-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/fields#get-project-field-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/field-id' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /users/{username}/projectsV2/{project_number}/items: + get: + summary: List items for a user owned project + description: >- + List all items for a specific user-owned project accessible by the + authenticated user. + tags: + - projects + operationId: projects/list-items-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + - name: q + description: >- + Search query to filter items, see [Filtering + projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + in: query + required: false + schema: + type: string + - name: fields + description: >- + Limit results to specific fields, by their IDs. If not specified, + the title field will be returned. + + + Example: `fields[]=123&fields[]=456&fields[]=789` or + `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + post: + summary: Add item to user owned project + description: Add an issue or pull request item to the specified user owned project. + tags: + - projects + operationId: projects/add-item-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#add-item-to-user-owned-project + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: >- + Details of the item to add to the project. You can specify either the + unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: >- + The type of item to add to the project. Must be either Issue + or PullRequest. + id: + type: integer + description: >- + The unique identifier of the issue or pull request to add to + the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + - id + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + issue_with_nwo: + summary: >- + Response for adding an issue using repository owner, name, + and issue number + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_nwo: + summary: >- + Response for adding a pull request using repository owner, + name, and PR number + value: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /users/{username}/projectsV2/{project_number}/items/{item_id}: + get: + summary: Get an item for a user owned project + description: Get a specific item from a user-owned project. + tags: + - projects + operationId: projects/get-user-item + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/item-id' + - name: fields + description: >- + Limit results to specific fields, by their IDs. If not specified, + the title field will be returned. + + + Example: fields[]=123&fields[]=456&fields[]=789 or + fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + patch: + summary: Update project item for user + description: Update a specific item in a user-owned project. + tags: + - projects + operationId: projects/update-item-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#update-project-item-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/item-id' + requestBody: + required: true + description: >- + Field updates to apply to the project item. Only text, number, date, + single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: >- + The new value for the field: + + - For text, number, and date fields, provide the new + value directly. + + - For single select and iteration fields, provide the + ID of the option or iteration. + + - To clear the field, set this to null. + nullable: true + oneOf: + - type: string + - type: number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + text_field: + $ref: '#/components/examples/projects-v2-item-with-content' + number_field: + $ref: '#/components/examples/projects-v2-item-with-content' + date_field: + $ref: '#/components/examples/projects-v2-item-with-content' + single_select_field: + $ref: '#/components/examples/projects-v2-item-with-content' + iteration_field: + $ref: '#/components/examples/projects-v2-item-with-content' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + delete: + summary: Delete project item for user + description: Delete a specific item from a user-owned project. + tags: + - projects + operationId: projects/delete-item-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#delete-project-item-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/item-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /users/{username}/projectsV2/{project_number}/views/{view_number}/items: + get: + summary: List items for a user project view + description: List items in a user project with the saved view's filter applied. + tags: + - projects + operationId: projects/list-view-items-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/view-number' + - name: fields + description: >- + Limit results to specific fields, by their IDs. If not specified, + the + + title field will be returned. + + + Example: `fields[]=123&fields[]=456&fields[]=789` or + `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: items + x-stackQL-resource: items +components: + schemas: + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + description: The unique identifier of the project. + node_id: + type: string + description: The node ID of the project. + owner: + $ref: '#/components/schemas/simple-user' + creator: + $ref: '#/components/schemas/simple-user' + title: + type: string + description: The project title. + description: + type: string + nullable: true + description: A short description of the project. + public: + type: boolean + description: Whether the project is visible to anyone with access to the owner. + closed_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the project was closed. + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the project was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the project was last updated. + number: + type: integer + description: The project number. + short_description: + type: string + nullable: true + description: A concise summary of the project. + deleted_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the project was deleted. + deleted_by: + $ref: '#/components/schemas/nullable-simple-user' + state: + type: string + enum: + - open + - closed + description: The current state of the project. + latest_status_update: + $ref: '#/components/schemas/nullable-projects-v2-status-update' + is_template: + type: boolean + description: Whether this project is a template + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + projects-v2-item-simple: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + content: + description: The content represented by the item. + title: Issue + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: >- + It looks like the new widget form is broken on Safari. When I + try and create the widget, Safari crashes. This is reproducible + on 10.8, but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: >- + Labels to associate with this issue; pass one or more label + names to replace the set of labels on this issue; send an empty + array to clear all labels from the issue; note that the labels + are silently dropped for users without push access to the + repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + statuses_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + auto_merge: + $ref: '#/components/schemas/auto-merge' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + - _links + - base + - body + - commits_url + - diff_url + - head + - issue_url + - merge_commit_sha + - merged_at + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + content_type: + $ref: '#/components/schemas/projects-v2-item-content-type' + creator: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the item was archived. + project_url: + type: string + format: uri + description: The URL of the project this item belongs to. + item_url: + type: string + format: uri + description: The URL of the item in the project. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-field: + title: Projects v2 Field + description: A field inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the field. + issue_field_id: + type: integer + description: The ID of the issue field. + node_id: + type: string + description: The node ID of the field. + project_url: + type: string + description: The API URL of the project that contains the field. + example: https://api.github.com/projects/1 + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - assignees + - linked_pull_requests + - reviewers + - labels + - milestone + - repository + - title + - text + - single_select + - number + - date + - iteration + - issue_type + - parent_issue + - sub_issues_progress + options: + type: array + description: The options available for single select fields. + items: + $ref: '#/components/schemas/projects-v2-single-select-options' + configuration: + type: object + description: Configuration for iteration fields. + properties: + start_day: + type: integer + description: The day of the week when the iteration starts. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + items: + $ref: '#/components/schemas/projects-v2-iteration-settings' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the field was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the field was last updated. + required: + - id + - name + - data_type + - created_at + - updated_at + - project_url + projects-v2-field-single-select-option: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + additionalProperties: false + projects-v2-field-iteration-configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: >- + The default duration for iterations in days. Individual iterations + can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + additionalProperties: false + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + projects-v2-item-with-content: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + project_url: + type: string + format: uri + example: https://api.github.com/users/monalisa/2/projectsV2/3 + description: The API URL of the project that contains this item. + content_type: + $ref: '#/components/schemas/projects-v2-item-content-type' + content: + type: object + additionalProperties: true + nullable: true + description: The content of the item, which varies by content type. + creator: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the item was archived. + item_url: + type: string + format: uri + example: https://api.github.com/users/monalisa/2/projectsV2/items/3 + nullable: true + description: The API URL of this item. + fields: + type: array + items: + type: object + additionalProperties: true + description: The fields and values associated with this item. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-view: + title: Projects v2 View + description: A view inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the view. + number: + type: integer + description: The number of the view within the project. + name: + type: string + description: The name of the view. + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + node_id: + type: string + description: The node ID of the view. + project_url: + type: string + description: The API URL of the project that contains the view. + example: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: + type: string + format: uri + description: The web URL of the view. + example: https://github.com/orgs/octocat/projects/1/views/1 + creator: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the view was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the view was last updated. + filter: + type: string + nullable: true + description: The filter query for the view. + example: is:issue is:open + visible_fields: + type: array + description: The list of field IDs that are visible in the view. + items: + type: integer + sort_by: + type: array + description: >- + The sorting configuration for the view. Each element is a tuple of + [field_id, direction] where direction is "asc" or "desc". + items: + type: array + minItems: 2 + maxItems: 2 + items: + oneOf: + - type: integer + - type: string + group_by: + type: array + description: The list of field IDs used for horizontal grouping. + items: + type: integer + vertical_group_by: + type: array + description: The list of field IDs used for vertical grouping (board layout). + items: + type: integer + required: + - id + - number + - name + - layout + - node_id + - project_url + - html_url + - creator + - created_at + - updated_at + - visible_fields + - sort_by + - group_by + - vertical_group_by + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the status update. + node_id: + type: string + description: The node ID of the status update. + project_node_id: + type: string + description: The node ID of the project that this status update belongs to. + creator: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the status update was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the status update was last updated. + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + description: The current status. + start_date: + type: string + format: date + example: '2022-04-28' + description: The start date of the period covered by the update. + target_date: + type: string + format: date + example: '2022-04-28' + description: The target date associated with the update. + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at + nullable: true + issue: + title: Issue + description: >- + Issues are a great way to keep track of tasks, enhancements, and bugs + for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: >- + It looks like the new widget form is broken on Safari. When I try + and create the widget, Safari crashes. This is reproducible on 10.8, + but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: >- + Labels to associate with this issue; pass one or more label names to + replace the set of labels on this issue; send an empty array to + clear all labels from the issue; note that the labels are silently + dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + example: 1347 + state: + type: string + example: open + locked: + type: boolean + example: true + title: + type: string + example: new-feature + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + projects-v2-draft-issue: + title: Draft Issue + description: A draft issue in a project + type: object + properties: + id: + type: number + description: The ID of the draft issue + node_id: + type: string + description: The node ID of the draft issue + title: + type: string + description: The title of the draft issue + body: + type: string + description: The body content of the draft issue + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + description: The time the draft issue was created + updated_at: + type: string + format: date-time + description: The time the draft issue was last updated + required: + - id + - node_id + - title + - user + - created_at + - updated_at + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-single-select-options: + title: Projects v2 Single Select Option + description: An option for a single select field + type: object + properties: + id: + type: string + description: The unique identifier of the option. + name: + type: object + description: The display name of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: + type: object + description: The description of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + color: + type: string + description: The color associated with the option. + required: + - id + - name + - description + - color + projects-v2-iteration-settings: + title: Projects v2 Iteration Setting + description: An iteration setting for an iteration field + type: object + properties: + id: + type: string + description: The unique identifier of the iteration setting. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + title: + type: object + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: The iteration title, in raw text and HTML formats. + completed: + type: boolean + description: Whether the iteration has been completed. + required: + - id + - start_date + - duration + - title + - completed + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: >- + Details about the selected option (only present for single_select + fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + $ref: '#/components/schemas/simple-user' + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + project-number: + name: project_number + description: The project's number. + in: path + required: true + schema: + type: integer + field-id: + name: field_id + description: The unique identifier of the field. + in: path + required: true + schema: + type: integer + item-id: + name: item_id + description: The unique identifier of the project item. + in: path + required: true + schema: + type: integer + view-number: + name: view_number + description: The number that identifies the project view. + in: path + required: true + schema: + type: integer + user-id: + name: user_id + description: The unique identifier of the user. + in: path + required: true + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + projects-v2: + value: + id: 2 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + title: My Projects + description: A board to manage my personal projects. + public: true + closed_at: null + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + number: 2 + short_description: null + deleted_at: null + deleted_by: null + state: open + latest_status_update: + id: 3 + node_id: PVTSU_lAECAQM + creator: + login: hubot + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: false + body: DONE + start_date: '2025-07-23' + target_date: '2025-07-26' + status: COMPLETE + created_at: '2025-07-11T16:19:28Z' + updated_at: '2025-07-11T16:19:28Z' + is_template: true + projects-v2-item-simple: + value: + id: 17 + node_id: PVTI_lADOANN5s84ACbL0zgBueEI + content: + id: 38 + node_id: I_kwDOANN5s85FtLts + title: Example Draft Issue + body: This is a draft issue in the project. + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: DraftIssue + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + archived_at: null + project_url: https://api.github.com/users/octocat/projectsV2/1 + item_url: https://api.github.com/users/octocat/projectsV2/items/17 + projects-v2-field-items: + value: + - id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + - id: 67891 + node_id: PVTF_lADOABCD9876543210 + name: Status + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_4 + name: + html: Todo + raw: Todo + color: GRAY + description: + html: Items to be worked on + raw: Items to be worked on + - id: option_5 + name: + html: In Progress + raw: In Progress + color: BLUE + description: + html: Items currently being worked on + raw: Items currently being worked on + - id: option_6 + name: + html: Done + raw: Done + color: GREEN + description: + html: Completed items + raw: Completed items + created_at: '2022-04-29T10:30:00Z' + updated_at: '2022-04-29T10:30:00Z' + - id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + - id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + - id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + - id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-item-with-content: + value: + id: 13 + node_id: PVTI_lAAFAQ0 + project_url: https://api.github.com/orgs/github/projectsV2/1 + content: + url: https://api.github.com/repos/github/Hello-World/pulls/6 + id: 10 + node_id: PR_kwABCg + html_url: https://github.com/github/Hello-World/pull/6 + diff_url: https://github.com/github/Hello-World/pull/6.diff + patch_url: https://github.com/github/Hello-World/pull/6.patch + issue_url: https://api.github.com/repos/github/Hello-World/issues/6 + number: 6 + state: open + locked: false + title: Issue title + user: + login: monalisa + id: 161 + node_id: U_kgDMoQ + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + pinned_comment: null + body: Issue body + created_at: '2025-08-01T18:44:50Z' + updated_at: '2025-08-06T19:25:18Z' + closed_at: null + merged_at: null + merge_commit_sha: 98e25bad5878e54d22e5338cbc905dd2deedfa34 + assignee: + login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + assignees: + - login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + requested_reviewers: + - login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + requested_teams: [] + labels: + - id: 19 + node_id: LA_kwABEw + url: >- + https://api.github.com/repos/github/Hello-World/labels/bug%20:bug: + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: >- + https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: fun size 🍫 + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: >- + https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: πŸš’ wontfix + color: 5891ce + default: false + description: This will not be worked on + milestone: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: >- + https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: null + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: null + closed_at: null + draft: false + commits_url: https://api.github.com/repos/github/Hello-World/pulls/6/commits + review_comments_url: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment_url: >- + https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/github/Hello-World/issues/6/comments + statuses_url: >- + https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + head: + label: github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f + ref: branch-2ee3da8fde8a1adfe6d0809a1a414e4f + sha: a3258d3434ecb2058b2784c8eb8610c2e9937a0d + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: null + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: >- + https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: >- + https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: >- + https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: >- + https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: >- + https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: >- + https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: >- + https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: null + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: null + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: null + archived: false + disabled: false + open_issues_count: 3 + license: null + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + base: + label: github:branch-0f4ceb14cbe39e4786ffbabb776da599 + ref: branch-0f4ceb14cbe39e4786ffbabb776da599 + sha: 9a9f5a8d77bdc2540412900d3c930fe36a82b5ed + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: null + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: >- + https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: >- + https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: >- + https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: >- + https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: >- + https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: >- + https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: >- + https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: null + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: null + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: null + archived: false + disabled: false + open_issues_count: 3 + license: null + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + _links: + self: + href: https://api.github.com/repos/github/Hello-World/pulls/6 + html: + href: https://github.com/github/Hello-World/pull/6 + issue: + href: https://api.github.com/repos/github/Hello-World/issues/6 + comments: + href: >- + https://api.github.com/repos/github/Hello-World/issues/6/comments + review_comments: + href: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment: + href: >- + https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/github/Hello-World/pulls/6/commits + statuses: + href: >- + https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + author_association: MEMBER + auto_merge: null + active_lock_reason: null + content_type: PullRequest + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + created_at: '2025-08-01T18:44:51Z' + updated_at: '2025-08-06T19:25:18Z' + archived_at: null + item_url: https://api.github.com/orgs/github/projectsV2/1/items/13 + fields: + - id: 1 + name: Title + data_type: title + value: + raw: >- + It seemed to me that any civilization that had so far lost its + head as to need to include a set of detailed instructions for + use in a packet of toothpicks, was no longer a civilization in + which I could live and stay sane. + html: >- + It seemed to me that any civilization that had so far lost its + head as to need to include a set of detailed instructions for + use in a packet of toothpicks, was no longer a civilization in + which I could live and stay sane. + number: 6 + url: https://github.com/5/1/pull/6 + issue_id: 12 + state: open + state_reason: null + is_draft: false + - id: 2 + name: Assignees + data_type: assignees + value: + - login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + - id: 3 + name: Status + data_type: single_select + value: + id: '98236657' + name: + raw: Done + html: Done + color: PURPLE + description: + raw: This has been completed + html: This has been completed + - id: 4 + name: Labels + data_type: labels + value: + - id: 19 + node_id: LA_kwABEw + url: >- + https://api.github.com/repos/github/Hello-World/labels/bug%20:bug: + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: >- + https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: fun size 🍫 + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: >- + https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: πŸš’ wontfix + color: 5891ce + default: false + description: This will not be worked on + - id: 5 + name: Linked pull requests + data_type: linked_pull_requests + value: [] + - id: 6 + name: Milestone + data_type: milestone + value: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: >- + https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: null + creator: + login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: null + closed_at: null + - id: 7 + name: Repository + data_type: repository + value: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: null + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: >- + https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: >- + https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: >- + https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: >- + https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: >- + https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: >- + https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: >- + https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + - id: 8 + name: Type + data_type: issue_type + value: null + - id: 9 + name: Reviewers + data_type: reviewers + value: + - type: ReviewRequest + status: pending + reviewer: + avatarUrl: https://github.com/images/error/octocat_happy.gif + id: 2 + login: monalisa + url: https://github.com/monalisa + name: monalisa + type: User + - id: 10 + name: Parent issue + data_type: parent_issue + value: null + - id: 11 + name: Sub-issues progress + data_type: sub_issues_progress + value: null + projects-v2-view: + value: + id: 1 + number: 1 + name: Sprint Board + layout: board + node_id: PVTV_lADOANN5s84ACbL0zgBueEI + project_url: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: https://github.com/orgs/octocat/projects/1/views/1 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + filter: is:issue is:open + visible_fields: + - 123 + - 456 + - 789 + sort_by: + - - 123 + - asc + - - 456 + - desc + group_by: + - 123 + vertical_group_by: + - 456 + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + projects: + id: github.projects.projects + name: projects + title: Projects + methods: + list_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1projectsV2/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1projectsV2~1{project_number}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/projects/methods/get_for_org' + - $ref: '#/components/x-stackQL-resources/projects/methods/get_for_user' + - $ref: '#/components/x-stackQL-resources/projects/methods/list_for_org' + - $ref: '#/components/x-stackQL-resources/projects/methods/list_for_user' + insert: [] + update: [] + delete: [] + replace: [] + project_draft_items: + id: github.projects.project_draft_items + name: project_draft_items + title: Project Draft Items + methods: + create_draft_item_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1drafts/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/project_draft_items/methods/create_draft_item_for_org + update: [] + delete: [] + replace: [] + project_fields: + id: github.projects.project_fields + name: project_fields + title: Project Fields + methods: + list_fields_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1fields/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_field_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1fields/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_field_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1fields~1{field_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_fields_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1fields/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_field_for_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1fields/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_field_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1fields~1{field_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_fields/methods/get_field_for_org + - $ref: >- + #/components/x-stackQL-resources/project_fields/methods/get_field_for_user + - $ref: >- + #/components/x-stackQL-resources/project_fields/methods/list_fields_for_org + - $ref: >- + #/components/x-stackQL-resources/project_fields/methods/list_fields_for_user + insert: + - $ref: >- + #/components/x-stackQL-resources/project_fields/methods/add_field_for_org + - $ref: >- + #/components/x-stackQL-resources/project_fields/methods/add_field_for_user + update: [] + delete: [] + replace: [] + project_items: + id: github.projects.project_items + name: project_items + title: Project Items + methods: + list_items_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1items/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_item_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1items/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_org_item: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1items~1{item_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_item_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1items~1{item_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_item_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1items~1{item_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + create_draft_item_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1user~1{user_id}~1projectsV2~1{project_number}~1drafts/post + response: + mediaType: application/json + openAPIDocKey: '201' + list_items_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1items/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_item_for_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1items/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_user_item: + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1items~1{item_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_item_for_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1items~1{item_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_item_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1items~1{item_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/get_org_item + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/get_user_item + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/list_items_for_org + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/list_items_for_user + insert: + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/add_item_for_org + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/create_draft_item_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/add_item_for_user + update: + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/update_item_for_org + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/update_item_for_user + delete: + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/delete_item_for_org + - $ref: >- + #/components/x-stackQL-resources/project_items/methods/delete_item_for_user + replace: [] + project_views: + id: github.projects.project_views + name: project_views + title: Project Views + methods: + create_view_for_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1views/post' + response: + mediaType: application/json + openAPIDocKey: '201' + create_view_for_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1users~1{user_id}~1projectsV2~1{project_number}~1views/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/project_views/methods/create_view_for_org + - $ref: >- + #/components/x-stackQL-resources/project_views/methods/create_view_for_user + update: [] + delete: [] + replace: [] + project_view_items: + id: github.projects.project_view_items + name: project_view_items + title: Project View Items + methods: + list_view_items_for_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1projectsV2~1{project_number}~1views~1{view_number}~1items/get + response: + mediaType: application/json + openAPIDocKey: '200' + list_view_items_for_user: + operation: + $ref: >- + #/paths/~1users~1{username}~1projectsV2~1{project_number}~1views~1{view_number}~1items/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/project_view_items/methods/list_view_items_for_org + - $ref: >- + #/components/x-stackQL-resources/project_view_items/methods/list_view_items_for_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/pulls.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/pulls.yaml new file mode 100644 index 0000000..6b70ef9 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/pulls.yaml @@ -0,0 +1,8324 @@ +openapi: 3.0.3 +info: + title: pulls API + description: Interact with GitHub Pull Requests. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/pulls: + get: + summary: List pull requests + description: >- + Lists pull requests in a specified repository. + + + Draft pull requests are available in public repositories with GitHub + + Free and GitHub Free for organizations, GitHub Pro, and legacy + per-repository billing + + plans, and in public and private repositories with GitHub Team and + GitHub Enterprise + + Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + + in the GitHub Help documentation. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - pulls + operationId: pulls/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#list-pull-requests + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: state + description: Either `open`, `closed`, or `all` to filter by state. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - name: head + description: >- + Filter pulls by head user or head organization and branch name in + the format of `user:ref-name` or `organization:ref-name`. For + example: `github:new-script-format` or `octocat:test-branch`. + in: query + required: false + schema: + type: string + - name: base + description: 'Filter pulls by base branch name. Example: `gh-pages`.' + in: query + required: false + schema: + type: string + - name: sort + description: >- + What to sort results by. `popularity` will sort by the number of + comments. `long-running` will sort by date created and will limit + the results to pull requests that have been open for more than a + month and have had activity within the past month. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - popularity + - long-running + default: created + - name: direction + description: >- + The direction of the sort. Default: `desc` when sort is `created` or + sort is not specified, otherwise `asc`. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + post: + summary: Create a pull request + description: >- + Draft pull requests are available in public repositories with GitHub + Free and GitHub Free for organizations, GitHub Pro, and legacy + per-repository billing plans, and in public and private repositories + with GitHub Team and GitHub Enterprise Cloud. For more information, see + [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + To open or update a pull request in a public repository, you must have + write access to the head or the source branch. For organization-owned + repositories, you must be a member of the organization that owns the + repository to open or update a pull request. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - pulls + operationId: pulls/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: >- + The title of the new pull request. Required unless `issue` + is specified. + head: + type: string + description: >- + The name of the branch where your changes are implemented. + For cross-repository pull requests in the same network, + namespace `head` with a user like this: `username:branch`. + head_repo: + type: string + description: >- + The name of the repository where the changes in the pull + request were made. This field is required for + cross-repository pull requests if both repositories are + owned by the same organization. + format: repo.nwo + example: octo-org/octo-repo + base: + type: string + description: >- + The name of the branch you want the changes pulled into. + This should be an existing branch on the current repository. + You cannot submit a pull request to one repository that + requests a merge to a base of another repository. + body: + type: string + description: The contents of the pull request. + maintainer_can_modify: + type: boolean + description: >- + Indicates whether [maintainers can + modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) + the pull request. + draft: + type: boolean + description: >- + Indicates whether the pull request is a draft. See "[Draft + Pull + Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" + in the GitHub Help documentation to learn more. + issue: + type: integer + format: int64 + example: 1 + description: >- + An issue in the repository to convert to a pull request. The + issue title, body, and comments will become the title, body, + and comments on the new pull request. Required unless + `title` is specified. + required: + - head + - base + examples: + default: + value: + title: Amazing new feature + body: Please pull these awesome changes in! + head: octocat:new-feature + base: master + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request' + examples: + default: + $ref: '#/components/examples/pull-request' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/comments: + get: + summary: List review comments in a repository + description: >- + Lists review comments for all pull requests in a repository. By default, + + review comments are in ascending order by ID. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-review-comments-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at + - name: direction + description: The direction to sort results. Ignored without `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/comments/{comment_id}: + get: + summary: Get a review comment for a pull request + description: >- + Provides details for a specified review comment. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/get-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-2' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update a review comment for a pull request + description: >- + Edits the content of a specified review comment. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/update-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The text of the reply to the review comment. + required: + - body + examples: + default: + value: + body: I like this too! + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete a review comment for a pull request + description: Deletes a review comment. + tags: + - pulls + operationId: pulls/delete-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/{pull_number}: + get: + summary: Get a pull request + description: >- + Draft pull requests are available in public repositories with GitHub + Free and GitHub Free for organizations, GitHub Pro, and legacy + per-repository billing plans, and in public and private repositories + with GitHub Team and GitHub Enterprise Cloud. For more information, see + [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Lists details of a pull request by providing its number. + + + When you get, + [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), + or + [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a + pull request, GitHub creates a merge commit to test whether the pull + request can be automatically merged into the base branch. This test + commit is not added to the base branch or the head branch. You can + review the status of the test commit using the `mergeable` key. For more + information, see "[Checking mergeability of pull + requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + + + The value of the `mergeable` attribute can be `true`, `false`, or + `null`. If the value is `null`, then GitHub has started a background job + to compute the mergeability. After giving the job time to complete, + resubmit the request. When the job finishes, you will see a non-`null` + value for the `mergeable` attribute in the response. If `mergeable` is + `true`, then `merge_commit_sha` will be the SHA of the _test_ merge + commit. + + + The value of the `merge_commit_sha` attribute changes depending on the + state of the pull request. Before merging a pull request, the + `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. + After merging a pull request, the `merge_commit_sha` attribute changes + depending on how you merged the pull request: + + + * If merged as a [merge + commit](https://docs.github.com/articles/about-merge-methods-on-github/), + `merge_commit_sha` represents the SHA of the merge commit. + + * If merged via a + [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), + `merge_commit_sha` represents the SHA of the squashed commit on the base + branch. + + * If + [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), + `merge_commit_sha` represents the commit that the base branch was + updated to. + + + Pass the appropriate [media + type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) + to fetch diff and patch formats. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + + - **`application/vnd.github.diff`**: For more information, see + "[git-diff](https://git-scm.com/docs/git-diff)" in the Git + documentation. If a diff is corrupt, contact us through the [GitHub + Support portal](https://support.github.com/). Include the repository + name and pull request ID in your message. + tags: + - pulls + operationId: pulls/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + responses: + '200': + description: >- + Pass the appropriate [media + type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) + to fetch diff and patch formats. + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request' + examples: + default: + $ref: '#/components/examples/pull-request' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '406': + $ref: '#/components/responses/unacceptable' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + patch: + summary: Update a pull request + description: >- + Draft pull requests are available in public repositories with GitHub + Free and GitHub Free for organizations, GitHub Pro, and legacy + per-repository billing plans, and in public and private repositories + with GitHub Team and GitHub Enterprise Cloud. For more information, see + [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + To open or update a pull request in a public repository, you must have + write access to the head or the source branch. For organization-owned + repositories, you must be a member of the organization that owns the + repository to open or update a pull request. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - pulls + operationId: pulls/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the pull request. + body: + type: string + description: The contents of the pull request. + state: + type: string + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + base: + type: string + description: >- + The name of the branch you want your changes pulled into. + This should be an existing branch on the current repository. + You cannot update the base branch on a pull request to point + to another repository. + maintainer_can_modify: + type: boolean + description: >- + Indicates whether [maintainers can + modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) + the pull request. + examples: + default: + value: + title: new title + body: updated body + state: open + base: master + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request' + examples: + default: + $ref: '#/components/examples/pull-request' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/comments: + get: + summary: List review comments on a pull request + description: >- + Lists all review comments for a specified pull request. By default, + review comments + + are in ascending order by ID. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-review-comments + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/sort' + - name: direction + description: The direction to sort results. Ignored without `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create a review comment for a pull request + description: >- + Creates a review comment on the diff of a specified pull request. To add + a regular comment to a pull request timeline, see "[Create an issue + comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." + + + If your comment applies to more than one line in the pull request diff, + you should use the parameters `line`, `side`, and optionally + `start_line` and `start_side` in your request. + + + The `position` parameter is closing down. If you use `position`, the + `line`, `side`, `start_line`, and `start_side` parameters are not + required. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The text of the review comment. + commit_id: + type: string + description: >- + The SHA of the commit needing a comment. Not using the + latest commit SHA may render your comment outdated if a + subsequent commit modifies the line you specify as the + `position`. + path: + type: string + description: The relative path to the file that necessitates a comment. + position: + type: integer + description: >- + **This parameter is closing down. Use `line` instead**. The + position in the diff where you want to add a review comment. + Note this value is not the same as the line number in the + file. The position value equals the number of lines down + from the first "@@" hunk header in the file you want to add + a comment. The line just below the "@@" line is position 1, + the next line is position 2, and so on. The position in the + diff continues to increase through lines of whitespace and + additional hunks until the beginning of a new file. + deprecated: true + x-github: + deprecationDate: '2022-11-01' + side: + type: string + description: >- + In a split diff view, the side of the diff that the pull + request's changes appear on. Can be `LEFT` or `RIGHT`. Use + `LEFT` for deletions that appear in red. Use `RIGHT` for + additions that appear in green or unchanged lines that + appear in white and are shown for context. For a multi-line + comment, side represents whether the last line of the + comment range is a deletion or addition. For more + information, see "[Diff view + options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" + in the GitHub Help documentation. + enum: + - LEFT + - RIGHT + line: + type: integer + description: >- + **Required unless using `subject_type:file`**. The line of + the blob in the pull request diff that the comment applies + to. For a multi-line comment, the last line of the range + that your comment applies to. + start_line: + type: integer + description: >- + **Required when using multi-line comments unless using + `in_reply_to`**. The `start_line` is the first line in the + pull request diff that your multi-line comment applies to. + To learn more about multi-line comments, see "[Commenting on + a pull + request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" + in the GitHub Help documentation. + start_side: + type: string + description: >- + **Required when using multi-line comments unless using + `in_reply_to`**. The `start_side` is the starting side of + the diff that the comment applies to. Can be `LEFT` or + `RIGHT`. To learn more about multi-line comments, see + "[Commenting on a pull + request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" + in the GitHub Help documentation. See `side` in this table + for additional context. + enum: + - LEFT + - RIGHT + - side + in_reply_to: + type: integer + example: 2 + description: >- + The ID of the review comment to reply to. To find the ID of + a review comment with ["List review comments on a pull + request"](#list-review-comments-on-a-pull-request). When + specified, all parameters other than `body` in the request + body are ignored. + subject_type: + type: string + description: The level at which the comment is targeted. + enum: + - line + - file + required: + - body + - commit_id + - path + examples: + example-for-a-multi-line-comment: + summary: Example for a multi-line comment + value: + body: Great stuff! + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + path: file1.txt + start_line: 1 + start_side: RIGHT + line: 2 + side: RIGHT + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + example-for-a-multi-line-comment: + $ref: >- + #/components/examples/pull-request-review-comment-example-for-a-multi-line-comment + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies: + post: + summary: Create a reply for a review comment + description: >- + Creates a reply to a review comment for a pull request. For the + `comment_id`, provide the ID of the review comment you are replying to. + This must be the ID of a _top-level review comment_, not a reply to that + comment. Replies to replies are not supported. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create-reply-for-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The text of the review comment. + required: + - body + examples: + default: + value: + body: Great stuff! + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: false + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/{pull_number}/commits: + get: + summary: List commits on a pull request + description: >- + Lists a maximum of 250 commits for a pull request. To receive a complete + + commit list for pull requests with more than 250 commits, use the [List + commits](https://docs.github.com/rest/commits/commits#list-commits) + + endpoint. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - pulls + operationId: pulls/list-commits + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/files: + get: + summary: List pull requests files + description: >- + Lists the files in a specified pull request. + + + > [!NOTE] + + > Responses include a maximum of 3000 files. The paginated response + returns 30 files per page by default. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. + Response will include `body`. This is the default if you do not pass any + specific media type. + + - **`application/vnd.github.text+json`**: Returns a text only + representation of the markdown body. Response will include `body_text`. + + - **`application/vnd.github.html+json`**: Returns HTML rendered from the + body's markdown. Response will include `body_html`. + + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML + representations. Response will include `body`, `body_text`, and + `body_html`. + tags: + - pulls + operationId: pulls/list-files + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/diff-entry' + examples: + default: + $ref: '#/components/examples/diff-entry-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/merge: + get: + summary: Check if a pull request has been merged + description: >- + Checks if a pull request has been merged into the base branch. The HTTP + status of the response indicates whether or not the pull request has + been merged; the response body is empty. + tags: + - pulls + operationId: pulls/check-if-merged + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + responses: + '204': + description: Response if pull request has been merged + '404': + description: Not Found if pull request has not been merged + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + put: + summary: Merge a pull request + description: >- + Merges a pull request into the base branch. + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + examples: + response-if-merge-was-successful: + value: + commit_title: Expand enum + commit_message: Add a new value to the merge_method enum + responses: + '200': + description: if merge was successful + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-merge-result' + examples: + response-if-merge-was-successful: + $ref: >- + #/components/examples/pull-request-merge-result-response-if-merge-was-successful + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '405': + description: Method Not Allowed if merge cannot be performed + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-merge-cannot-be-performed: + value: + message: Pull Request is not mergeable + '409': + description: Conflict if sha was provided and pull request head did not match + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-sha-was-provided-and-pull-request-head-did-not-match: + value: + message: Head branch was modified. Review and try the merge again. + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers: + get: + summary: Get all requested reviewers for a pull request + description: >- + Gets the users or teams whose review is requested for a pull request. + Once a requested reviewer submits a review, they are no longer + considered a requested reviewer. Their review will instead be returned + by the [List reviews for a pull + request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) + operation. + tags: + - pulls + operationId: pulls/list-requested-reviewers + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-request' + examples: + default: + $ref: '#/components/examples/simple-pull-request-review-request' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: review-requests + x-stackQL-resource: review_requests + post: + summary: Request reviewers for a pull request + description: >- + Requests reviews for a pull request from a given set of users and/or + teams. + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/request-reviewers + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + reviewers: + type: array + description: An array of user `login`s that will be requested. + items: + type: string + team_reviewers: + type: array + description: An array of team `slug`s that will be requested. + items: + type: string + required: + - reviewers + - team_reviewers + examples: + default: + value: + reviewers: + - octocat + - hubot + - other_user + team_reviewers: + - justice-league + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-review-request' + '403': + $ref: '#/components/responses/forbidden' + '422': + description: Unprocessable Entity if user is not a collaborator + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: review-requests + x-stackQL-resource: review_requests + delete: + summary: Remove requested reviewers from a pull request + description: >- + Removes review requests from a pull request for a given set of users + and/or teams. + tags: + - pulls + operationId: pulls/remove-requested-reviewers + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reviewers: + type: array + description: An array of user `login`s that will be removed. + items: + type: string + team_reviewers: + type: array + description: An array of team `slug`s that will be removed. + items: + type: string + required: + - reviewers + examples: + default: + value: + reviewers: + - octocat + - hubot + - other_user + team_reviewers: + - justice-league + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-simple' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: review-requests + x-stackQL-resource: review_requests + /repos/{owner}/{repo}/pulls/{pull_number}/reviews: + get: + summary: List reviews for a pull request + description: >- + Lists all reviews for a specified pull request. The list of reviews + returns in chronological order. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-reviews + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: The list of reviews returns in chronological order. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + post: + summary: Create a review for a pull request + description: >- + Creates a review on a specified pull request. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + Pull request reviews created in the `PENDING` state are not submitted + and therefore do not include the `submitted_at` property in the + response. To create a pending review for a pull request, leave the + `event` parameter blank. For more information about submitting a + `PENDING` review, see "[Submit a review for a pull + request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + + + > [!NOTE] + + > To comment on a specific line in a file, you need to first determine + the position of that line in the diff. To see a pull request diff, add + the `application/vnd.github.v3.diff` media type to the `Accept` header + of a call to the [Get a pull + request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) + endpoint. + + + The `position` value equals the number of lines down from the first "@@" + hunk header in the file you want to add a comment. The line just below + the "@@" line is position 1, the next line is position 2, and so on. The + position in the diff continues to increase through lines of whitespace + and additional hunks until the beginning of a new file. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + commit_id: + type: string + description: >- + The SHA of the commit that needs a review. Not using the + latest commit SHA may render your review comment outdated if + a subsequent commit modifies the line you specify as the + `position`. Defaults to the most recent commit in the pull + request when you do not specify a value. + body: + type: string + description: >- + **Required** when using `REQUEST_CHANGES` or `COMMENT` for + the `event` parameter. The body text of the pull request + review. + event: + type: string + description: >- + The review action you want to perform. The review actions + include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By + leaving this blank, you set the review action state to + `PENDING`, which means you will need to [submit the pull + request + review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) + when you are ready. + enum: + - APPROVE + - REQUEST_CHANGES + - COMMENT + comments: + type: array + description: >- + Use the following table to specify the location, + destination, and contents of the draft review comment. + items: + type: object + properties: + path: + type: string + description: >- + The relative path to the file that necessitates a + review comment. + position: + type: integer + description: >- + The position in the diff where you want to add a + review comment. Note this value is not the same as the + line number in the file. The `position` value equals + the number of lines down from the first "@@" hunk + header in the file you want to add a comment. The line + just below the "@@" line is position 1, the next line + is position 2, and so on. The position in the diff + continues to increase through lines of whitespace and + additional hunks until the beginning of a new file. + body: + type: string + description: Text of the review comment. + line: + type: integer + example: 28 + side: + type: string + example: RIGHT + start_line: + type: integer + example: 26 + start_side: + type: string + example: LEFT + required: + - path + - body + examples: + default: + value: + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + body: >- + This is close to perfect! Please address the suggested + inline change. + event: REQUEST_CHANGES + comments: + - path: file.md + position: 6 + body: Please add more information here, and fix this typo. + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}: + get: + summary: Get a review for a pull request + description: >- + Retrieves a pull request review by its ID. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/get-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-4' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + put: + summary: Update a review for a pull request + description: >- + Updates the contents of a specified review summary comment. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/update-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The body text of the pull request review. + required: + - body + examples: + default: + value: + body: >- + This is close to perfect! Please address the suggested + inline change. And add more about this. + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-5' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + delete: + summary: Delete a pending review for a pull request + description: >- + Deletes a pull request review that has not been submitted. Submitted + reviews cannot be deleted. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/delete-pending-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments: + get: + summary: List comments for a pull request review + description: >- + Lists comments for a specific pull request review. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-comments-for-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/review-comment' + examples: + default: + $ref: '#/components/examples/review-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals: + put: + summary: Dismiss a review for a pull request + description: >- + Dismisses a specified review on a pull request. + + + > [!NOTE] + + > To dismiss a pull request review on a [protected + branch](https://docs.github.com/rest/branches/branch-protection), you + must be a repository administrator or be included in the list of people + or teams who can dismiss pull request reviews. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/dismiss-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The message for the pull request review dismissal + event: + type: string + example: '"DISMISS"' + enum: + - DISMISS + required: + - message + examples: + default: + value: + message: You are dismissed + event: DISMISS + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-3' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events: + post: + summary: Submit a review for a pull request + description: >- + Submits a pending review for a pull request. For more information about + creating a pending review for a pull request, see "[Create a review for + a pull + request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/submit-review + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The body text of the pull request review + event: + type: string + description: >- + The review action you want to perform. The review actions + include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When + you leave this blank, the API returns _HTTP 422 + (Unrecognizable entity)_ and sets the review action state to + `PENDING`, which means you will need to re-submit the pull + request review using a review action. + enum: + - APPROVE + - REQUEST_CHANGES + - COMMENT + required: + - event + examples: + default: + value: + body: Here is the body for the review. + event: REQUEST_CHANGES + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-4' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/update-branch: + put: + summary: Update a pull request branch + description: >- + Updates the pull request branch with the latest upstream changes by + merging HEAD from the base branch into the pull request branch. + + Note: If making a request on behalf of a GitHub App you must also have + permissions to write the contents of the head repository. + tags: + - pulls + operationId: pulls/update-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + expected_head_sha: + type: string + description: >- + The expected SHA of the pull request's HEAD ref. This is the + most recent commit on the pull request's branch. If the + expected SHA does not match the pull request's HEAD, you + will receive a `422 Unprocessable Entity` status. You can + use the "[List + commits](https://docs.github.com/rest/commits/commits#list-commits)" + endpoint to find the most recent commit SHA. Default: SHA of + the pull request's current HEAD ref. + examples: + default: + value: + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Updating pull request branch. + url: https://github.com/repos/octocat/Hello-World/pulls/53 + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: pulls + subcategory: pulls + x-stackQL-resource: pulls +components: + schemas: + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + example: 1347 + state: + type: string + example: open + locked: + type: boolean + example: true + title: + type: string + example: new-feature + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + pull-request: + type: object + title: Pull Request + description: >- + Pull requests let you tell others about changes you've pushed to a + repository on GitHub. Once a pull request is sent, interested parties + can review the set of changes, discuss potential modifications, and even + push follow-up commits if necessary. + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + example: 42 + type: integer + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + example: open + type: string + locked: + type: boolean + example: true + title: + description: The title of the pull request. + example: Amazing new feature + type: string + user: + $ref: '#/components/schemas/simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + nullable: true + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team-simple' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + merged: + type: boolean + mergeable: + type: boolean + example: true + nullable: true + rebaseable: + type: boolean + example: true + nullable: true + mergeable_state: + type: string + example: clean + merged_by: + $ref: '#/components/schemas/nullable-simple-user' + comments: + type: integer + example: 10 + review_comments: + type: integer + example: 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + example: true + type: boolean + commits: + type: integer + example: 3 + additions: + type: integer + example: 100 + deletions: + type: integer + example: 3 + changed_files: + type: integer + example: 5 + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + type: object + version: '2026-03-10' + pull-request-review-comment: + title: Pull Request Review Comment + description: >- + Pull Request Review Comments are comments on a portion of the Pull + Request's diff. + type: object + properties: + url: + description: URL for the pull request review comment + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + type: string + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: integer + format: int64 + example: 42 + nullable: true + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + example: 1 + node_id: + description: The node ID of the pull request review comment. + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: + description: The relative path of the file to which the comment applies. + example: config/database.yaml + type: string + position: + description: >- + The line index in the diff to which the comment applies. This field + is closing down; use `line` instead. + example: 1 + type: integer + original_position: + description: >- + The index of the original line in the diff to which the comment + applies. This field is closing down; use `original_line` instead. + example: 4 + type: integer + commit_id: + description: The SHA of the commit to which the comment applies. + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + type: string + in_reply_to_id: + description: The comment ID to reply to. + example: 8 + type: integer + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + description: The text of the comment. + example: We should probably include a check for null values here. + type: string + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + description: URL for the pull request that the review comment belongs to. + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + $ref: '#/components/schemas/author-association' + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + original_start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: >- + The line of the blob to which the comment applies. The last line of + the range for a multi-line comment + example: 2 + type: integer + original_line: + description: >- + The line of the blob to which the comment applies. The last line of + the range for a multi-line comment + example: 2 + type: integer + side: + description: >- + The side of the diff to which the comment applies. The side of the + last line of the range for a multi-line comment + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + subject_type: + description: >- + The level at which the comment is targeted, can be a diff line or a + file. + type: string + enum: + - line + - file + reactions: + $ref: '#/components/schemas/reaction-rollup' + body_html: + type: string + example: '"

comment body

"' + body_text: + type: string + example: '"comment body"' + required: + - url + - id + - node_id + - pull_request_review_id + - diff_hunk + - path + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + commit: + title: Commit + description: Commit + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + $ref: '#/components/schemas/nullable-git-user' + committer: + $ref: '#/components/schemas/nullable-git-user' + message: + type: string + example: Fix all the bugs + comment_count: + type: integer + example: 0 + tree: + type: object + properties: + sha: + type: string + example: 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + required: + - sha + - url + verification: + $ref: '#/components/schemas/verification' + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + committer: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + parents: + type: array + items: + type: object + properties: + sha: + type: string + example: 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + required: + - sha + - url + stats: + type: object + properties: + additions: + type: integer + deletions: + type: integer + total: + type: integer + files: + type: array + items: + $ref: '#/components/schemas/diff-entry' + required: + - url + - sha + - node_id + - html_url + - comments_url + - commit + - author + - committer + - parents + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + nullable: true + example: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + example: file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + example: added + additions: + type: integer + example: 103 + deletions: + type: integer + example: 21 + changes: + type: integer + example: 124 + blob_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + example: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + previous_filename: + type: string + example: file.txt + required: + - additions + - blob_url + - changes + - contents_url + - deletions + - filename + - raw_url + - sha + - status + pull-request-merge-result: + title: Pull Request Merge Result + description: Pull Request Merge Result + type: object + properties: + sha: + type: string + merged: + type: boolean + message: + type: string + required: + - merged + - message + - sha + pull-request-review-request: + title: Pull Request Review Request + description: Pull Request Review Request + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + type: array + items: + $ref: '#/components/schemas/team' + required: + - users + - teams + pull-request-review: + title: Pull Request Review + description: Pull Request Reviews are reviews on pull requests. + type: object + properties: + id: + description: Unique identifier of the review + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + description: The text of the review. + example: This looks great. + type: string + state: + type: string + example: CHANGES_REQUESTED + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + commit_id: + description: >- + A commit SHA for the review. If the commit object was garbage + collected or forcibly deleted, then it no longer exists in Git and + this value will be `null`. + example: 54bb654c9e6025347f57900a4a5c2313a96b8035 + type: string + nullable: true + body_html: + type: string + body_text: + type: string + author_association: + $ref: '#/components/schemas/author-association' + required: + - id + - node_id + - user + - body + - state + - commit_id + - html_url + - pull_request_url + - _links + - author_association + review-comment: + title: Legacy Review Comment + description: Legacy Review Comment + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: integer + format: int64 + example: 42 + nullable: true + id: + type: integer + format: int64 + example: 10 + node_id: + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: + type: string + example: file1.txt + position: + type: integer + example: 1 + nullable: true + original_position: + type: integer + example: 4 + commit_id: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + example: 8 + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Great stuff + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + $ref: '#/components/schemas/author-association' + _links: + type: object + properties: + self: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + pull_request: + $ref: '#/components/schemas/link' + required: + - self + - html + - pull_request + body_text: + type: string + body_html: + type: string + reactions: + $ref: '#/components/schemas/reaction-rollup' + side: + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: >- + The line of the blob to which the comment applies. The last line of + the range for a multi-line comment + example: 2 + type: integer + original_line: + description: >- + The original line of the blob to which the comment applies. The last + line of the range for a multi-line comment + example: 2 + type: integer + start_line: + description: The first line of the range for a multi-line comment. + example: 2 + type: integer + nullable: true + original_start_line: + description: The original first line of the range for a multi-line comment. + example: 2 + type: integer + nullable: true + subject_type: + description: >- + The level at which the comment is targeted, can be a diff line or a + file. + type: string + enum: + - line + - file + required: + - id + - node_id + - url + - body + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - pull_request_review_id + - html_url + - pull_request_url + - _links + - author_association + - created_at + - updated_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + $ref: '#/components/schemas/simple-user' + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + nullable-git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' + nullable: true + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + responses: + not_modified: + description: Not modified + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + unacceptable: + description: Unacceptable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + since: + name: since + description: >- + Only show results that were last updated after the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + pull-number: + name: pull_number + description: The number that identifies the pull request. + in: path + required: true + schema: + type: integer + sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + review-id: + name: review_id + description: The unique identifier of the review. + in: path + required: true + schema: + type: integer + examples: + pull-request-simple-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + pull-request: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_merge_commit: true + allow_forking: true + forks: 123 + open_issues: 123 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + watchers: 123 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_merge_commit: true + forks: 123 + open_issues: 123 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + watchers: 123 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + merged: false + mergeable: true + rebaseable: true + mergeable_state: clean + merged_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + comments: 10 + review_comments: 0 + maintainer_can_modify: true + commits: 3 + additions: 100 + deletions: 3 + changed_files: 5 + pull-request-review-comment-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + pull-request-review-comment-2: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + pull-request-review-comment-example-for-a-multi-line-comment: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + pull-request-review-comment: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 426899381 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + commit-items: + value: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + diff-entry-items: + value: + - sha: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: file1.txt + status: added + additions: 103 + deletions: 21 + changes: 124 + blob_url: >- + https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: >- + https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + pull-request-merge-result-response-if-merge-was-successful: + value: + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + merged: true + message: Pull Request successfully merged + simple-pull-request-review-request: + value: + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + pull-request-review-request: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + pull-request-simple: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + pull-request-review-items: + value: + - id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Here is the body for the review. + state: APPROVED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: >- + https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + pull-request-review: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: This is close to perfect! Please address the suggested inline change. + state: CHANGES_REQUESTED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: >- + https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + pull-request-review-4: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Here is the body for the review. + state: APPROVED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: >- + https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + pull-request-review-5: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: >- + This is close to perfect! Please address the suggested inline change. + And add more about this. + state: CHANGES_REQUESTED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: >- + https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + review-comment-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + pull-request-review-3: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Here is the body for the review. + state: DISMISSED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: >- + https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + pull_requests: + id: github.pulls.pull_requests + name: pull_requests + title: Pull Requests + methods: + list: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pull_requests/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + pull_request: + id: github.pulls.pull_request + name: pull_request + title: Pull Request + methods: + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + check_if_merged: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1merge/get' + response: + mediaType: application/json + openAPIDocKey: '204' + merge: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1merge/put' + response: + mediaType: application/json + openAPIDocKey: '200' + update_branch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1update-branch/put + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pull_request/methods/get' + insert: + - $ref: '#/components/x-stackQL-resources/pull_request/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/pull_request/methods/update' + delete: [] + replace: [] + comments: + id: github.pulls.comments + name: comments + title: Comments + methods: + list_review_comments_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_review_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1comments~1{comment_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_review_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1comments~1{comment_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_review_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1comments~1{comment_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_review_comments: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1comments/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_review_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1comments/post + response: + mediaType: application/json + openAPIDocKey: '201' + create_reply_for_review_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1comments~1{comment_id}~1replies/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/get_review_comment + - $ref: >- + #/components/x-stackQL-resources/comments/methods/list_review_comments + - $ref: >- + #/components/x-stackQL-resources/comments/methods/list_review_comments_for_repo + insert: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/create_reply_for_review_comment + - $ref: >- + #/components/x-stackQL-resources/comments/methods/create_review_comment + update: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/update_review_comment + delete: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/delete_review_comment + replace: [] + commits: + id: github.pulls.commits + name: commits + title: Commits + methods: + list_commits: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1commits/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commits/methods/list_commits' + insert: [] + update: [] + delete: [] + replace: [] + files: + id: github.pulls.files + name: files + title: Files + methods: + list_files: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1files/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/files/methods/list_files' + insert: [] + update: [] + delete: [] + replace: [] + review_requests: + id: github.pulls.review_requests + name: review_requests + title: Review Requests + methods: + list_requested_reviewers: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1requested_reviewers/get + response: + mediaType: application/json + openAPIDocKey: '200' + request_reviewers: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1requested_reviewers/post + response: + mediaType: application/json + openAPIDocKey: '201' + remove_requested_reviewers: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1requested_reviewers/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/review_requests/methods/list_requested_reviewers + insert: + - $ref: >- + #/components/x-stackQL-resources/review_requests/methods/request_reviewers + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/review_requests/methods/remove_requested_reviewers + replace: [] + reviews: + id: github.pulls.reviews + name: reviews + title: Reviews + methods: + list_reviews: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_review: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_review: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews~1{review_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_review: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews~1{review_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_pending_review: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews~1{review_id}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + dismiss_review: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews~1{review_id}~1dismissals/put + response: + mediaType: application/json + openAPIDocKey: '200' + submit_review: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews~1{review_id}~1events/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/reviews/methods/get_review' + - $ref: '#/components/x-stackQL-resources/reviews/methods/list_reviews' + insert: + - $ref: '#/components/x-stackQL-resources/reviews/methods/create_review' + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/reviews/methods/delete_pending_review + replace: + - $ref: '#/components/x-stackQL-resources/reviews/methods/update_review' + comments_for_review: + id: github.pulls.comments_for_review + name: comments_for_review + title: Comments For Review + methods: + list_comments_for_review: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1{pull_number}~1reviews~1{review_id}~1comments/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/comments_for_review/methods/list_comments_for_review + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/rate_limit.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/rate_limit.yaml new file mode 100644 index 0000000..28431de --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/rate_limit.yaml @@ -0,0 +1,295 @@ +openapi: 3.0.3 +info: + title: rate_limit API + description: github API + version: 1.1.4 +paths: + /rate_limit: + get: + summary: Get rate limit status for the authenticated user + description: >- + > [!NOTE] + + > Accessing this endpoint does not count against your REST API rate + limit. + + + Some categories of endpoints have custom rate limits that are separate + from the rate limit governing the other REST API endpoints. For this + reason, the API response categorizes your rate limit. Under `resources`, + you'll see objects relating to different categories: + + * The `core` object provides your rate limit status for all + non-search-related resources in the REST API. + + * The `search` object provides your rate limit status for the REST API + for searching (excluding code searches). For more information, see + "[Search](https://docs.github.com/rest/search/search)." + + * The `code_search` object provides your rate limit status for the REST + API for searching code. For more information, see "[Search + code](https://docs.github.com/rest/search/search#search-code)." + + * The `graphql` object provides your rate limit status for the GraphQL + API. For more information, see "[Resource + limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + + * The `integration_manifest` object provides your rate limit status for + the `POST /app-manifests/{code}/conversions` operation. For more + information, see "[Creating a GitHub App from a + manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + + * The `dependency_snapshots` object provides your rate limit status for + submitting snapshots to the dependency graph. For more information, see + "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + + * The `dependency_sbom` object provides your rate limit status for + requesting SBOMs from the dependency graph. For more information, see + "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + + * The `code_scanning_upload` object provides your rate limit status for + uploading SARIF results to code scanning. For more information, see + "[Uploading a SARIF file to + GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + + * The `actions_runner_registration` object provides your rate limit + status for registering self-hosted runners in GitHub Actions. For more + information, see "[Self-hosted + runners](https://docs.github.com/rest/actions/self-hosted-runners)." + + * The `source_import` object is no longer in use for any API endpoints, + and it will be removed in the next API version. For more information + about API versions, see "[API + Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." + + + > [!NOTE] + + > The `rate` object is closing down. If you're writing new API client + code or updating existing code, you should use the `core` object instead + of the `rate` object. The `core` object contains the same information + that is present in the `rate` object. + tags: + - rate-limit + operationId: rate-limit/get + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rate-limit-overview' + examples: + default: + $ref: '#/components/examples/rate-limit-overview' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/x-rate-limit-limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/x-rate-limit-remaining' + X-RateLimit-Reset: + $ref: '#/components/headers/x-rate-limit-reset' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: rate-limit + subcategory: rate-limit + x-stackQL-resource: rate_limit +components: + schemas: + rate-limit-overview: + title: Rate Limit Overview + description: Rate Limit Overview + type: object + properties: + resources: + type: object + properties: + core: + $ref: '#/components/schemas/rate-limit' + graphql: + $ref: '#/components/schemas/rate-limit' + search: + $ref: '#/components/schemas/rate-limit' + code_search: + $ref: '#/components/schemas/rate-limit' + source_import: + $ref: '#/components/schemas/rate-limit' + integration_manifest: + $ref: '#/components/schemas/rate-limit' + code_scanning_upload: + $ref: '#/components/schemas/rate-limit' + actions_runner_registration: + $ref: '#/components/schemas/rate-limit' + scim: + $ref: '#/components/schemas/rate-limit' + dependency_snapshots: + $ref: '#/components/schemas/rate-limit' + dependency_sbom: + $ref: '#/components/schemas/rate-limit' + code_scanning_autofix: + $ref: '#/components/schemas/rate-limit' + required: + - core + - search + rate: + $ref: '#/components/schemas/rate-limit' + required: + - rate + - resources + x-github-breaking-changes: + - changeset: remove_rate_limit_rate + patch: + properties: + rate: null + required: + - resources + type: object + version: '2026-03-10' + rate-limit: + title: Rate Limit + type: object + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + used: + type: integer + required: + - limit + - remaining + - reset + - used + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + rate-limit-overview: + value: + resources: + core: + limit: 5000 + used: 1 + remaining: 4999 + reset: 1691591363 + search: + limit: 30 + used: 12 + remaining: 18 + reset: 1691591091 + graphql: + limit: 5000 + used: 7 + remaining: 4993 + reset: 1691593228 + integration_manifest: + limit: 5000 + used: 1 + remaining: 4999 + reset: 1691594631 + source_import: + limit: 100 + used: 1 + remaining: 99 + reset: 1691591091 + code_scanning_upload: + limit: 500 + used: 1 + remaining: 499 + reset: 1691594631 + actions_runner_registration: + limit: 10000 + used: 0 + remaining: 10000 + reset: 1691594631 + scim: + limit: 15000 + used: 0 + remaining: 15000 + reset: 1691594631 + dependency_snapshots: + limit: 100 + used: 0 + remaining: 100 + reset: 1691591091 + code_search: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 + rate: + limit: 5000 + used: 1 + remaining: 4999 + reset: 1372700873 + headers: + x-rate-limit-limit: + example: 5000 + schema: + type: integer + x-rate-limit-remaining: + example: 4999 + schema: + type: integer + x-rate-limit-reset: + example: 1590701888 + schema: + type: integer + format: timestamp + x-stackQL-resources: + rate_limit: + id: github.rate_limit.rate_limit + name: rate_limit + title: Rate Limit + methods: + get: + operation: + $ref: '#/paths/~1rate_limit/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rate_limit/methods/get' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/reactions.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/reactions.yaml new file mode 100644 index 0000000..8ffa3f7 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/reactions.yaml @@ -0,0 +1,1372 @@ +openapi: 3.0.3 +info: + title: reactions API + description: Interact with reactions to various GitHub entities. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/comments/{comment_id}/reactions: + get: + summary: List reactions for a commit comment + description: >- + List the reactions to a [commit + comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + tags: + - reactions + operationId: reactions/list-for-commit-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - name: content + description: >- + Returns a single [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a commit comment. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for a commit comment + description: >- + Create a reaction to a [commit + comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + A response with an HTTP `200` status means that you already added the + reaction type to this commit comment. + tags: + - reactions + operationId: reactions/create-for-commit-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: >- + The [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions) + to add to the commit comment. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}: + delete: + summary: Delete a commit comment reaction + description: >- + > [!NOTE] + + > You can also specify a repository by `repository_id` using the route + `DELETE + /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + + + Delete a reaction to a [commit + comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + tags: + - reactions + operationId: reactions/delete-for-commit-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions: + get: + summary: List reactions for an issue comment + description: >- + List the reactions to an [issue + comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + tags: + - reactions + operationId: reactions/list-for-issue-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - name: content + description: >- + Returns a single [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to an issue comment. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for an issue comment + description: >- + Create a reaction to an [issue + comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + A response with an HTTP `200` status means that you already added the + reaction type to this issue comment. + tags: + - reactions + operationId: reactions/create-for-issue-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: >- + The [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions) + to add to the issue comment. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}: + delete: + summary: Delete an issue comment reaction + description: >- + > [!NOTE] + + > You can also specify a repository by `repository_id` using the route + `DELETE delete + /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + + + Delete a reaction to an [issue + comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + tags: + - reactions + operationId: reactions/delete-for-issue-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/{issue_number}/reactions: + get: + summary: List reactions for an issue + description: >- + List the reactions to an + [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/list-for-issue + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: content + description: >- + Returns a single [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to an issue. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for an issue + description: >- + Create a reaction to an + [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A + response with an HTTP `200` status means that you already added the + reaction type to this issue. + tags: + - reactions + operationId: reactions/create-for-issue + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: >- + The [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions) + to add to the issue. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}: + delete: + summary: Delete an issue reaction + description: >- + > [!NOTE] + + > You can also specify a repository by `repository_id` using the route + `DELETE + /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + + + Delete a reaction to an + [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/delete-for-issue + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions: + get: + summary: List reactions for a pull request review comment + description: >- + List the reactions to a [pull request review + comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + tags: + - reactions + operationId: reactions/list-for-pull-request-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - name: content + description: >- + Returns a single [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a pull request review + comment. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for a pull request review comment + description: >- + Create a reaction to a [pull request review + comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + A response with an HTTP `200` status means that you already added the + reaction type to this pull request review comment. + tags: + - reactions + operationId: reactions/create-for-pull-request-review-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: >- + The [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions) + to add to the pull request review comment. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}: + delete: + summary: Delete a pull request comment reaction + description: >- + > [!NOTE] + + > You can also specify a repository by `repository_id` using the route + `DELETE + /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + + + Delete a reaction to a [pull request review + comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + tags: + - reactions + operationId: reactions/delete-for-pull-request-comment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/releases/{release_id}/reactions: + get: + summary: List reactions for a release + description: >- + List the reactions to a + [release](https://docs.github.com/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/list-for-release + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - name: content + description: >- + Returns a single [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a release. + in: query + required: false + schema: + type: string + enum: + - '+1' + - laugh + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for a release + description: >- + Create a reaction to a + [release](https://docs.github.com/rest/releases/releases#get-a-release). + A response with a `Status: 200 OK` means that you already added the + reaction type to this release. + tags: + - reactions + operationId: reactions/create-for-release + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: >- + The [reaction + type](https://docs.github.com/rest/reactions/reactions#about-reactions) + to add to the release. + enum: + - '+1' + - laugh + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}: + delete: + summary: Delete a release reaction + description: >- + > [!NOTE] + + > You can also specify a repository by `repository_id` using the route + `DELETE delete + /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + + + Delete a reaction to a + [release](https://docs.github.com/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/delete-for-release + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions +components: + schemas: + reaction: + title: Reaction + description: >- + Reactions to conversations provide a way to help people express their + feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + $ref: '#/components/schemas/nullable-simple-user' + content: + description: The reaction to use + example: heart + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + gone: + description: Gone + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer + issue-number: + name: issue_number + description: The number that identifies the issue. + in: path + required: true + schema: + type: integer + release-id: + name: release_id + description: The unique identifier of the release. + in: path + required: true + schema: + type: integer + examples: + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + commit_comments: + id: github.reactions.commit_comments + name: commit_comments + title: Commit Comments + methods: + list_for_commit_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1comments~1{comment_id}~1reactions/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_commit_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1comments~1{comment_id}~1reactions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_for_commit_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1comments~1{comment_id}~1reactions~1{reaction_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/commit_comments/methods/list_for_commit_comment + insert: + - $ref: >- + #/components/x-stackQL-resources/commit_comments/methods/create_for_commit_comment + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/commit_comments/methods/delete_for_commit_comment + replace: [] + issue_comments: + id: github.reactions.issue_comments + name: issue_comments + title: Issue Comments + methods: + list_for_issue_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}~1reactions/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_issue_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}~1reactions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_for_issue_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1comments~1{comment_id}~1reactions~1{reaction_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_for_issue: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1reactions/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_issue: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1reactions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_for_issue: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1issues~1{issue_number}~1reactions~1{reaction_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issue_comments/methods/list_for_issue_comment + - $ref: >- + #/components/x-stackQL-resources/issue_comments/methods/list_for_issue + insert: + - $ref: >- + #/components/x-stackQL-resources/issue_comments/methods/create_for_issue_comment + - $ref: >- + #/components/x-stackQL-resources/issue_comments/methods/create_for_issue + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/issue_comments/methods/delete_for_issue_comment + - $ref: >- + #/components/x-stackQL-resources/issue_comments/methods/delete_for_issue + replace: [] + pr_comments: + id: github.reactions.pr_comments + name: pr_comments + title: Pr Comments + methods: + list_for_pull_request_review_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1comments~1{comment_id}~1reactions/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_pull_request_review_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1comments~1{comment_id}~1reactions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_for_pull_request_comment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pulls~1comments~1{comment_id}~1reactions~1{reaction_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pr_comments/methods/list_for_pull_request_review_comment + insert: + - $ref: >- + #/components/x-stackQL-resources/pr_comments/methods/create_for_pull_request_review_comment + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/pr_comments/methods/delete_for_pull_request_comment + replace: [] + release_comments: + id: github.reactions.release_comments + name: release_comments + title: Release Comments + methods: + list_for_release: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}~1reactions/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_release: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}~1reactions/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_for_release: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}~1reactions~1{reaction_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/release_comments/methods/list_for_release + insert: + - $ref: >- + #/components/x-stackQL-resources/release_comments/methods/create_for_release + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/release_comments/methods/delete_for_release + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/repos.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/repos.yaml new file mode 100644 index 0000000..da7ffd1 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/repos.yaml @@ -0,0 +1,31668 @@ +openapi: 3.0.3 +info: + title: repos API + description: Interact with GitHub Repos. + version: 1.1.4 +paths: + /orgs/{org}/repos: + get: + summary: List organization repositories + description: >- + Lists repositories for the specified organization. + + + > [!NOTE] + + > In order to see the `security_and_analysis` block for a repository you + must have admin permissions for the repository or be an owner or + security manager for the organization that owns the repository. For more + information, see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + tags: + - repos + operationId: repos/list-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#list-organization-repositories + parameters: + - $ref: '#/components/parameters/org' + - name: type + description: Specifies the types of repositories you want returned. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + - forks + - sources + - member + default: all + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - pushed + - full_name + default: created + - name: direction + description: >- + The order to sort by. Default: `asc` when using `full_name`, + otherwise `desc`. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + post: + summary: Create an organization repository + description: >- + Creates a new repository in the specified organization. The + authenticated user must be a member of the organization. + + + OAuth app tokens and personal access tokens (classic) need the + `public_repo` or `repo` scope to create a public repository, and `repo` + scope to create a private repository. + tags: + - repos + operationId: repos/create-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#create-an-organization-repository + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the repository. + description: + type: string + description: A short description of the repository. + homepage: + type: string + description: A URL with more information about the repository. + private: + type: boolean + description: Whether the repository is private. + default: false + visibility: + type: string + description: The visibility of the repository. + enum: + - public + - private + has_issues: + type: boolean + description: >- + Either `true` to enable issues for this repository or + `false` to disable them. + default: true + has_projects: + type: boolean + description: >- + Either `true` to enable projects for this repository or + `false` to disable them. **Note:** If you're creating a + repository in an organization that has disabled repository + projects, the default is `false`, and if you pass `true`, + the API returns an error. + default: true + has_wiki: + type: boolean + description: >- + Either `true` to enable the wiki for this repository or + `false` to disable it. + default: true + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + is_template: + type: boolean + description: >- + Either `true` to make this repo available as a template + repository or `false` to prevent it. + default: false + team_id: + type: integer + description: >- + The id of the team that will be granted access to this + repository. This is only valid when creating a repository in + an organization. + auto_init: + type: boolean + description: Pass `true` to create an initial commit with empty README. + default: false + gitignore_template: + type: string + description: >- + Desired language or platform [.gitignore + template](https://github.com/github/gitignore) to apply. Use + the name of the template without the extension. For example, + "Haskell". + license_template: + type: string + description: >- + Choose an [open source license + template](https://choosealicense.com/) that best suits your + needs, and then use the [license + keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) + as the `license_template` string. For example, "mit" or + "mpl-2.0". + allow_squash_merge: + type: boolean + description: >- + Either `true` to allow squash-merging pull requests, or + `false` to prevent squash-merging. + default: true + allow_merge_commit: + type: boolean + description: >- + Either `true` to allow merging pull requests with a merge + commit, or `false` to prevent merging pull requests with + merge commits. + default: true + allow_rebase_merge: + type: boolean + description: >- + Either `true` to allow rebase-merging pull requests, or + `false` to prevent rebase-merging. + default: true + allow_auto_merge: + type: boolean + description: >- + Either `true` to allow auto-merge on pull requests, or + `false` to disallow auto-merge. + default: false + delete_branch_on_merge: + type: boolean + description: >- + Either `true` to allow automatically deleting head branches + when pull requests are merged, or `false` to prevent + automatic deletion. **The authenticated user must be an + organization owner to set this property to `true`.** + default: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Either `true` to allow squash-merge commits to use pull + request title, or `false` to use commit message. **This + property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + Required when using `squash_merge_commit_message`. + + + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if + only one commit) or the pull request's title (when more than + one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: >- + The default value for a squash merge commit message: + + + - `PR_BODY` - default to the pull request's body. + + - `COMMIT_MESSAGES` - default to the branch's commit + messages. + + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + Required when using `merge_commit_message`. + + + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge + message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + custom_properties: + type: object + description: >- + The custom properties for the new repository. The keys are + the custom property names, and the values are the + corresponding custom property values. + additionalProperties: true + required: + - name + examples: + default: + value: + name: Hello-World + description: This is your first repository + homepage: https://github.com + private: false + has_issues: true + has_projects: true + has_wiki: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-github-breaking-changes: + - changeset: change_create_repo_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: repos + /orgs/{org}/rulesets: + get: + summary: Get all organization repository rulesets + description: Get all the repository rulesets for an organization. + tags: + - repos + operationId: repos/get-org-rulesets + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/ruleset-targets' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + post: + summary: Create an organization repository ruleset + description: Create a repository ruleset for an organization. + tags: + - repos + operationId: repos/create-org-ruleset + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + default: branch + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/org-ruleset-conditions' + rules: + type: array + description: An array of rules within the ruleset. + items: + $ref: '#/components/schemas/org-rules' + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /orgs/{org}/rulesets/rule-suites: + get: + summary: List organization rule suites + description: >- + Lists suites of rule evaluations at the organization level. + + For more information, see "[Managing rulesets for repositories in your + organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-org-rule-suites + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/ref-in-query' + - $ref: '#/components/parameters/repository-name-in-query' + - $ref: '#/components/parameters/time-period' + - $ref: '#/components/parameters/actor-name-in-query' + - $ref: '#/components/parameters/rule-suite-result' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suites' + examples: + default: + $ref: '#/components/examples/rule-suite-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rule-suites + x-stackQL-resource: rule_suites + /orgs/{org}/rulesets/rule-suites/{rule_suite_id}: + get: + summary: Get an organization rule suite + description: >- + Gets information about a suite of rule evaluations from within an + organization. + + For more information, see "[Managing rulesets for repositories in your + organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-org-rule-suite + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/rule-suite-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suite' + examples: + default: + $ref: '#/components/examples/rule-suite' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rule-suites + x-stackQL-resource: rule_suites + /orgs/{org}/rulesets/{ruleset_id}: + get: + summary: Get an organization repository ruleset + description: >- + Get a repository ruleset for an organization. + + + **Note:** To prevent leaking sensitive information, the `bypass_actors` + property is only returned if the user + + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-org-ruleset + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + put: + summary: Update an organization repository ruleset + description: Update a ruleset for an organization. + tags: + - repos + operationId: repos/update-org-ruleset + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/org-ruleset-conditions' + rules: + description: An array of rules within the ruleset. + type: array + items: + $ref: '#/components/schemas/org-rules' + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + delete: + summary: Delete an organization repository ruleset + description: Delete a ruleset for an organization. + tags: + - repos + operationId: repos/delete-org-ruleset + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /repos/{owner}/{repo}: + get: + summary: Get a repository + description: >- + The `parent` and `source` objects are present when the repository is a + fork. `parent` is the repository this repository was forked from, + `source` is the ultimate source for the network. + + + > [!NOTE] + + > - In order to see the `security_and_analysis` block for a repository + you must have admin permissions for the repository or be an owner or + security manager for the organization that owns the repository. For more + information, see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + > - To view merge-related settings, you must have the `contents:read` + and `contents:write` permissions. + tags: + - repos + operationId: repos/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#get-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default-response: + $ref: '#/components/examples/full-repository-default-response' + '301': + $ref: '#/components/responses/moved_permanently' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + patch: + summary: Update a repository + description: >- + **Note**: To edit a repository's topics, use the [Replace all repository + topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) + endpoint. + tags: + - repos + operationId: repos/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#update-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the repository. + description: + type: string + description: A short description of the repository. + homepage: + type: string + description: A URL with more information about the repository. + private: + type: boolean + description: >- + Either `true` to make the repository private or `false` to + make it public. Default: `false`. + + **Note**: You will get a `422` error if the organization + restricts [changing repository + visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) + to organization owners and a non-owner tries to change the + value of private. + default: false + visibility: + type: string + description: The visibility of the repository. + enum: + - public + - private + security_and_analysis: + type: object + description: >- + Specify which security and analysis features to enable or + disable for the repository. + + + To use this parameter, you must have admin permissions for + the repository or be an owner or security manager for the + organization that owns the repository. For more information, + see "[Managing security managers in your + organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + + For example, to enable GitHub Advanced Security, use this + data in the body of the `PATCH` request: + + `{ "security_and_analysis": {"advanced_security": { + "status": "enabled" } } }`. + + + You can check which security and analysis features are + currently enabled by using a `GET /repos/{owner}/{repo}` + request. + nullable: true + properties: + advanced_security: + type: object + description: >- + Use the `status` property to enable or disable GitHub + Advanced Security for this repository. + + For more information, see "[About GitHub Advanced + + Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + + + For standalone Code Scanning or Secret Protection + products, this parameter cannot be used. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + code_security: + type: object + description: >- + Use the `status` property to enable or disable GitHub + Code Security for this repository. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning: + type: object + description: >- + Use the `status` property to enable or disable secret + scanning for this repository. For more information, see + "[About secret + scanning](/code-security/secret-security/about-secret-scanning)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_push_protection: + type: object + description: >- + Use the `status` property to enable or disable secret + scanning push protection for this repository. For more + information, see "[Protecting pushes with secret + scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_ai_detection: + type: object + description: >- + Use the `status` property to enable or disable secret + scanning AI detection for this repository. For more + information, see "[Responsible detection of generic + secrets with + AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_non_provider_patterns: + type: object + description: >- + Use the `status` property to enable or disable secret + scanning non-provider patterns for this repository. For + more information, see "[Supported secret scanning + patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_delegated_alert_dismissal: + type: object + description: >- + Use the `status` property to enable or disable secret + scanning delegated alert dismissal for this repository. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_delegated_bypass: + type: object + description: >- + Use the `status` property to enable or disable secret + scanning delegated bypass for this repository. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_delegated_bypass_options: + type: object + description: >- + Feature options for secret scanning delegated bypass. + + This object is only honored when + `security_and_analysis.secret_scanning_delegated_bypass.status` + is set to `enabled`. + + You can send this object in the same request as + `secret_scanning_delegated_bypass`, or update just the + options in a separate request. + properties: + reviewers: + type: array + description: >- + The bypass reviewers for secret scanning delegated + bypass. + + If you omit this field, the existing set of + reviewers is unchanged. + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: >- + The ID of the team or role selected as a + bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + has_issues: + type: boolean + description: >- + Either `true` to enable issues for this repository or + `false` to disable them. + default: true + has_projects: + type: boolean + description: >- + Either `true` to enable projects for this repository or + `false` to disable them. **Note:** If you're creating a + repository in an organization that has disabled repository + projects, the default is `false`, and if you pass `true`, + the API returns an error. + default: true + has_wiki: + type: boolean + description: >- + Either `true` to enable the wiki for this repository or + `false` to disable it. + default: true + is_template: + type: boolean + description: >- + Either `true` to make this repo available as a template + repository or `false` to prevent it. + default: false + default_branch: + type: string + description: Updates the default branch for this repository. + allow_squash_merge: + type: boolean + description: >- + Either `true` to allow squash-merging pull requests, or + `false` to prevent squash-merging. + default: true + allow_merge_commit: + type: boolean + description: >- + Either `true` to allow merging pull requests with a merge + commit, or `false` to prevent merging pull requests with + merge commits. + default: true + allow_rebase_merge: + type: boolean + description: >- + Either `true` to allow rebase-merging pull requests, or + `false` to prevent rebase-merging. + default: true + allow_auto_merge: + type: boolean + description: >- + Either `true` to allow auto-merge on pull requests, or + `false` to disallow auto-merge. + default: false + delete_branch_on_merge: + type: boolean + description: >- + Either `true` to allow automatically deleting head branches + when pull requests are merged, or `false` to prevent + automatic deletion. + default: false + allow_update_branch: + type: boolean + description: >- + Either `true` to always allow a pull request head branch + that is behind its base branch to be updated even if it is + not required to be up to date before merging, or false + otherwise. + default: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Either `true` to allow squash-merge commits to use pull + request title, or `false` to use commit message. **This + property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + Required when using `squash_merge_commit_message`. + + + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if + only one commit) or the pull request's title (when more than + one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: >- + The default value for a squash merge commit message: + + + - `PR_BODY` - default to the pull request's body. + + - `COMMIT_MESSAGES` - default to the branch's commit + messages. + + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + Required when using `merge_commit_message`. + + + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge + message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + archived: + type: boolean + description: >- + Whether to archive this repository. `false` will unarchive a + previously archived repository. + default: false + allow_forking: + type: boolean + description: >- + Either `true` to allow private forks, or `false` to prevent + private forks. + default: false + web_commit_signoff_required: + type: boolean + description: >- + Either `true` to require contributors to sign off on + web-based commits, or `false` to not require contributors to + sign off on web-based commits. + default: false + examples: + default: + value: + name: Hello-World + description: This is your first repository + homepage: https://github.com + private: true + has_issues: true + has_projects: true + has_wiki: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + '307': + $ref: '#/components/responses/temporary_redirect' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Delete a repository + description: >- + Deleting a repository requires admin access. + + + If an organization owner has configured the organization to prevent + members from deleting organization-owned + + repositories, you will get a `403 Forbidden` response. + + + OAuth app tokens and personal access tokens (classic) need the + `delete_repo` scope to use this endpoint. + tags: + - repos + operationId: repos/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#delete-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '307': + $ref: '#/components/responses/temporary_redirect' + '403': + description: >- + If an organization owner has configured the organization to prevent + members from deleting organization-owned repositories, a member will + get this response: + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + default: + value: + message: Organization members cannot delete repositories. + documentation_url: >- + https://docs.github.com/rest/repos/repos#delete-a-repository + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/activity: + get: + summary: List repository activities + description: >- + Lists a detailed history of changes to a repository, such as pushes, + merges, force pushes, and branch changes, and associates these changes + with commits and users. + + + For more information about viewing repository activity, + + see "[Viewing activity and data for your + repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." + tags: + - repos + operationId: repos/list-activities + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-activities + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: ref + description: >- + The Git reference for the activities you want to list. + + + The `ref` for a branch can be formatted either as + `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is + the name of your branch. + in: query + required: false + schema: + type: string + - name: actor + description: >- + The GitHub username to use to filter by the actor who performed the + activity. + in: query + required: false + schema: + type: string + - name: time_period + description: >- + The time period to filter by. + + + For example, `day` will filter for activity that occurred in the + past 24 hours, and `week` will filter for activity that occurred in + the past 7 days (168 hours). + in: query + required: false + schema: + type: string + enum: + - day + - week + - month + - quarter + - year + - name: activity_type + description: >- + The activity type to filter by. + + + For example, you can choose to filter by "force_push", to see all + force pushes to the repository. + in: query + required: false + schema: + type: string + enum: + - push + - force_push + - branch_creation + - branch_deletion + - pr_merge + - merge_queue_merge + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/activity' + examples: + default: + $ref: '#/components/examples/activity-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/attestations: + post: + summary: Create an attestation + description: >- + Store an artifact attestation and associate it with a repository. + + + The authenticated user must have write permission to the repository and, + if using a fine-grained access token, the `attestations:write` + permission is required. + + + Artifact attestations are meant to be created using the [attest + action](https://github.com/actions/attest). For more information, see + our guide on [using artifact attestations to establish a build's + provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/create-attestation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/attestations#create-an-attestation + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: >- + The attestation's Sigstore Bundle. + + Refer to the [Sigstore Bundle + Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) + for more information. + required: + - bundle + examples: + default: + $ref: '#/components/examples/attestation' + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: integer + description: The ID of the attestation. + examples: + default: + value: + id: 2 + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: attestations + x-stackQL-resource: attestations + /repos/{owner}/{repo}/attestations/{subject_digest}: + get: + summary: List attestations + description: >- + List a collection of artifact attestations with a given subject digest + that are associated with a repository. + + + The authenticated user making the request must have read access to the + repository. In addition, when using a fine-grained access token the + `attestations:read` permission is required. + + + **Please note:** in order to offer meaningful security benefits, an + attestation's signature and timestamps **must** be cryptographically + verified, and the identity of the attestation signer **must** be + validated. Attestations can be verified using the [GitHub CLI + `attestation verify` + command](https://cli.github.com/manual/gh_attestation_verify). For more + information, see [our guide on how to use artifact attestations to + establish a build's + provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/attestations#list-attestations + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: subject_digest + description: >- + The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: predicate_type + description: >- + Optional filter for fetching attestations with a given predicate + type. + + This option accepts `provenance`, `sbom`, `release`, or freeform + text + + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: >- + The attestation's Sigstore Bundle. + + Refer to the [Sigstore Bundle + Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) + for more information. + repository_id: + type: integer + bundle_url: + type: string + initiator: + type: string + examples: + default: + $ref: '#/components/examples/list-attestations' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /repos/{owner}/{repo}/autolinks: + get: + summary: Get all autolinks of a repository + description: >- + Gets all autolinks that are configured for a repository. + + + Information about autolinks are only available to repository + administrators. + tags: + - repos + operationId: repos/list-autolinks + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/autolink' + examples: + default: + $ref: '#/components/examples/autolink-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + post: + summary: Create an autolink reference for a repository + description: Users with admin access to the repository can create an autolink. + tags: + - repos + operationId: repos/create-autolink + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + key_prefix: + type: string + description: >- + This prefix appended by certain characters will generate a + link any time it is found in an issue, pull request, or + commit. + url_template: + type: string + description: >- + The URL must contain `` for the reference number. + `` matches different characters depending on the value + of `is_alphanumeric`. + is_alphanumeric: + type: boolean + default: true + description: >- + Whether this autolink reference matches alphanumeric + characters. If true, the `` parameter of the + `url_template` matches alphanumeric characters `A-Z` (case + insensitive), `0-9`, and `-`. If false, this autolink + reference only matches numeric characters. + required: + - key_prefix + - url_template + examples: + default: + value: + key_prefix: TICKET- + url_template: https://example.com/TICKET?query= + is_alphanumeric: true + responses: + '201': + description: response + content: + application/json: + schema: + $ref: '#/components/schemas/autolink' + examples: + default: + $ref: '#/components/examples/autolink' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/autolinks/1 + schema: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + /repos/{owner}/{repo}/autolinks/{autolink_id}: + get: + summary: Get an autolink reference of a repository + description: >- + This returns a single autolink reference by ID that was configured for + the given repository. + + + Information about autolinks are only available to repository + administrators. + tags: + - repos + operationId: repos/get-autolink + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/autolink-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/autolink' + examples: + default: + $ref: '#/components/examples/autolink' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + delete: + summary: Delete an autolink reference from a repository + description: >- + This deletes a single autolink reference by ID that was configured for + the given repository. + + + Information about autolinks are only available to repository + administrators. + tags: + - repos + operationId: repos/delete-autolink + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/autolink-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + /repos/{owner}/{repo}/automated-security-fixes: + get: + summary: Check if Dependabot security updates are enabled for a repository + description: >- + Shows whether Dependabot security updates are enabled, disabled or + paused for a repository. The authenticated user must have admin read + access to the repository. For more information, see "[Configuring + Dependabot security + updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/check-automated-security-fixes + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response if Dependabot is enabled + content: + application/json: + schema: + $ref: '#/components/schemas/check-automated-security-fixes' + examples: + default: + value: + enabled: true + paused: false + '404': + description: Not Found if Dependabot is not enabled for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable Dependabot security updates + description: >- + Enables Dependabot security updates for a repository. The authenticated + user must have admin access to the repository. For more information, see + "[Configuring Dependabot security + updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/enable-automated-security-fixes + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable Dependabot security updates + description: >- + Disables Dependabot security updates for a repository. The authenticated + user must have admin access to the repository. For more information, see + "[Configuring Dependabot security + updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/disable-automated-security-fixes + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/branches: + get: + summary: List branches + description: '' + tags: + - repos + operationId: repos/list-branches + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#list-branches + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: protected + description: >- + Setting to `true` returns only branches protected by branch + protections or rulesets. When set to `false`, only unprotected + branches are returned. Omitting this parameter returns all branches. + in: query + required: false + schema: + type: boolean + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/short-branch' + examples: + default: + $ref: '#/components/examples/short-branch-with-protection-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/branches/{branch}: + get: + summary: Get a branch + description: '' + tags: + - repos + operationId: repos/get-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#get-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-with-protection' + examples: + default: + $ref: '#/components/examples/branch-get' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/branches/{branch}/protection: + get: + summary: Get branch protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-branch-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-protection' + examples: + default: + $ref: '#/components/examples/branch-protection' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Update branch protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Protecting a branch requires admin or owner permissions to the + repository. + + + > [!NOTE] + + > Passing new arrays of `users` and `teams` replaces their previous + values. + + + > [!NOTE] + + > The list of users, apps, and teams in total is limited to 100 items. + tags: + - repos + operationId: repos/update-branch-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#update-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + required_status_checks: + type: object + description: >- + Require status checks to pass before merging. Set to `null` + to disable. + nullable: true + properties: + strict: + type: boolean + description: Require branches to be up to date before merging. + contexts: + type: array + deprecated: true + description: >- + **Closing down notice**: The list of status checks to + require in order to merge into this branch. If any of + these checks have recently been set by a particular + GitHub App, they will be required to come from that app + in future for the branch to merge. Use `checks` instead + of `contexts` for more fine-grained control. + items: + type: string + checks: + type: array + description: >- + The list of status checks to require in order to merge + into this branch. + items: + type: object + required: + - context + properties: + context: + type: string + description: The name of the required check + app_id: + type: integer + description: >- + The ID of the GitHub App that must provide this + check. Omit this field to automatically select the + GitHub App that has recently provided this check, + or any app if it was not set by a GitHub App. Pass + -1 to explicitly allow any app to set the status. + required: + - strict + - contexts + enforce_admins: + type: boolean + description: >- + Enforce all configured restrictions for administrators. Set + to `true` to enforce required status checks for repository + administrators. Set to `null` to disable. + nullable: true + required_pull_request_reviews: + type: object + description: >- + Require at least one approving review on a pull request, + before merging. Set to `null` to disable. + nullable: true + properties: + dismissal_restrictions: + type: object + description: >- + Specify which users, teams, and apps can dismiss pull + request reviews. Pass an empty `dismissal_restrictions` + object to disable. User and team + `dismissal_restrictions` are only available for + organization-owned repositories. Omit this parameter for + personal repositories. + properties: + users: + type: array + description: The list of user `login`s with dismissal access + items: + type: string + teams: + type: array + description: The list of team `slug`s with dismissal access + items: + type: string + apps: + type: array + description: The list of app `slug`s with dismissal access + items: + type: string + dismiss_stale_reviews: + type: boolean + description: >- + Set to `true` if you want to automatically dismiss + approving reviews when someone pushes a new commit. + require_code_owner_reviews: + type: boolean + description: >- + Blocks merging pull requests until [code + owners](https://docs.github.com/articles/about-code-owners/) + review them. + required_approving_review_count: + type: integer + description: >- + Specify the number of reviewers required to approve pull + requests. Use a number between 1 and 6 or 0 to not + require reviewers. + require_last_push_approval: + type: boolean + description: >- + Whether the most recent push must be approved by someone + other than the person who pushed it. Default: `false`. + default: false + bypass_pull_request_allowances: + type: object + description: >- + Allow specific users, teams, or apps to bypass pull + request requirements. + properties: + users: + type: array + description: >- + The list of user `login`s allowed to bypass pull + request requirements. + items: + type: string + teams: + type: array + description: >- + The list of team `slug`s allowed to bypass pull + request requirements. + items: + type: string + apps: + type: array + description: >- + The list of app `slug`s allowed to bypass pull + request requirements. + items: + type: string + restrictions: + type: object + description: >- + Restrict who can push to the protected branch. User, app, + and team `restrictions` are only available for + organization-owned repositories. Set to `null` to disable. + nullable: true + properties: + users: + type: array + description: The list of user `login`s with push access + items: + type: string + teams: + type: array + description: The list of team `slug`s with push access + items: + type: string + apps: + type: array + description: The list of app `slug`s with push access + items: + type: string + required: + - users + - teams + required_linear_history: + type: boolean + description: >- + Enforces a linear commit Git history, which prevents anyone + from pushing merge commits to a branch. Set to `true` to + enforce a linear commit history. Set to `false` to disable a + linear commit Git history. Your repository must allow squash + merging or rebase merging before you can enable a linear + commit history. Default: `false`. For more information, see + "[Requiring a linear commit + history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" + in the GitHub Help documentation. + allow_force_pushes: + type: boolean + description: >- + Permits force pushes to the protected branch by anyone with + write access to the repository. Set to `true` to allow force + pushes. Set to `false` or `null` to block force pushes. + Default: `false`. For more information, see "[Enabling force + pushes to a protected + branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + in the GitHub Help documentation." + nullable: true + allow_deletions: + type: boolean + description: >- + Allows deletion of the protected branch by anyone with write + access to the repository. Set to `false` to prevent deletion + of the protected branch. Default: `false`. For more + information, see "[Enabling force pushes to a protected + branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + in the GitHub Help documentation. + block_creations: + type: boolean + description: >- + If set to `true`, the `restrictions` branch protection + settings which limits who can push will also block pushes + which create new branches, unless the push is initiated by a + user, team, or app which has the ability to push. Set to + `true` to restrict new branch creation. Default: `false`. + required_conversation_resolution: + type: boolean + description: >- + Requires all conversations on code to be resolved before a + pull request can be merged into a branch that matches this + rule. Set to `false` to disable. Default: `false`. + lock_branch: + type: boolean + description: >- + Whether to set the branch as read-only. If this is true, + users will not be able to push to the branch. Default: + `false`. + default: false + allow_fork_syncing: + type: boolean + description: >- + Whether users can pull changes from upstream when the branch + is locked. Set to `true` to allow fork syncing. Set to + `false` to prevent fork syncing. Default: `false`. + default: false + required: + - required_status_checks + - enforce_admins + - required_pull_request_reviews + - restrictions + examples: + default: + value: + required_status_checks: + strict: true + contexts: + - continuous-integration/travis-ci + enforce_admins: true + required_pull_request_reviews: + dismissal_restrictions: + users: + - octocat + teams: + - justice-league + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + bypass_pull_request_allowances: + users: + - octocat + teams: + - justice-league + restrictions: + users: + - octocat + teams: + - justice-league + apps: + - super-ci + required_linear_history: true + allow_force_pushes: true + allow_deletions: true + block_creations: true + required_conversation_resolution: true + lock_branch: true + allow_fork_syncing: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch' + examples: + default: + $ref: '#/components/examples/branch-protection-update' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete branch protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/delete-branch-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#delete-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins: + get: + summary: Get admin branch protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-admin-branch-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Set admin branch protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Adding admin enforcement requires admin or owner permissions to the + repository and branch protection to be enabled. + tags: + - repos + operationId: repos/set-admin-branch-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete admin branch protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Removing admin enforcement requires admin or owner permissions to the + repository and branch protection to be enabled. + tags: + - repos + operationId: repos/delete-admin-branch-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews: + get: + summary: Get pull request review protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-pull-request-review-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-pull-request-review' + examples: + default: + $ref: '#/components/examples/protected-branch-pull-request-review' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + patch: + summary: Update pull request review protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Updating pull request review enforcement requires admin or owner + permissions to the repository and branch protection to be enabled. + + + > [!NOTE] + + > Passing new arrays of `users` and `teams` replaces their previous + values. + tags: + - repos + operationId: repos/update-pull-request-review-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + dismissal_restrictions: + type: object + description: >- + Specify which users, teams, and apps can dismiss pull + request reviews. Pass an empty `dismissal_restrictions` + object to disable. User and team `dismissal_restrictions` + are only available for organization-owned repositories. Omit + this parameter for personal repositories. + properties: + users: + type: array + description: The list of user `login`s with dismissal access + items: + type: string + teams: + type: array + description: The list of team `slug`s with dismissal access + items: + type: string + apps: + type: array + description: The list of app `slug`s with dismissal access + items: + type: string + dismiss_stale_reviews: + type: boolean + description: >- + Set to `true` if you want to automatically dismiss approving + reviews when someone pushes a new commit. + require_code_owner_reviews: + type: boolean + description: >- + Blocks merging pull requests until [code + owners](https://docs.github.com/articles/about-code-owners/) + have reviewed. + required_approving_review_count: + type: integer + description: >- + Specifies the number of reviewers required to approve pull + requests. Use a number between 1 and 6 or 0 to not require + reviewers. + require_last_push_approval: + type: boolean + description: >- + Whether the most recent push must be approved by someone + other than the person who pushed it. Default: `false` + default: false + bypass_pull_request_allowances: + type: object + description: >- + Allow specific users, teams, or apps to bypass pull request + requirements. + properties: + users: + type: array + description: >- + The list of user `login`s allowed to bypass pull request + requirements. + items: + type: string + teams: + type: array + description: >- + The list of team `slug`s allowed to bypass pull request + requirements. + items: + type: string + apps: + type: array + description: >- + The list of app `slug`s allowed to bypass pull request + requirements. + items: + type: string + examples: + default: + value: + dismissal_restrictions: + users: + - octocat + teams: + - justice-league + apps: + - octoapp + bypass_pull_request_allowances: + users: + - octocat + teams: + - justice-league + apps: + - octoapp + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-pull-request-review' + examples: + default: + $ref: '#/components/examples/protected-branch-pull-request-review' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete pull request review protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/delete-pull-request-review-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures: + get: + summary: Get commit signature protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + When authenticated with admin or owner permissions to the repository, + you can use this endpoint to check whether a branch requires signed + commits. An enabled status of `true` indicates you must sign commits on + this branch. For more information, see [Signing commits with + GPG](https://docs.github.com/articles/signing-commits-with-gpg) in + GitHub Help. + + + > [!NOTE] + + > You must enable branch protection to require signed commits. + tags: + - repos + operationId: repos/get-commit-signature-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Create commit signature protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + When authenticated with admin or owner permissions to the repository, + you can use this endpoint to require signed commits on a branch. You + must enable branch protection to require signed commits. + tags: + - repos + operationId: repos/create-commit-signature-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete commit signature protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + When authenticated with admin or owner permissions to the repository, + you can use this endpoint to disable required signed commits on a + branch. You must enable branch protection to require signed commits. + tags: + - repos + operationId: repos/delete-commit-signature-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks: + get: + summary: Get status checks protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-status-checks-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/status-check-policy' + examples: + default: + $ref: '#/components/examples/status-check-policy' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + patch: + summary: Update status check protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Updating required status checks requires admin or owner permissions to + the repository and branch protection to be enabled. + tags: + - repos + operationId: repos/update-status-check-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#update-status-check-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + strict: + type: boolean + description: Require branches to be up to date before merging. + contexts: + type: array + deprecated: true + description: >- + **Closing down notice**: The list of status checks to + require in order to merge into this branch. If any of these + checks have recently been set by a particular GitHub App, + they will be required to come from that app in future for + the branch to merge. Use `checks` instead of `contexts` for + more fine-grained control. + items: + type: string + checks: + type: array + description: >- + The list of status checks to require in order to merge into + this branch. + items: + type: object + required: + - context + properties: + context: + type: string + description: The name of the required check + app_id: + type: integer + description: >- + The ID of the GitHub App that must provide this check. + Omit this field to automatically select the GitHub App + that has recently provided this check, or any app if + it was not set by a GitHub App. Pass -1 to explicitly + allow any app to set the status. + examples: + default: + value: + strict: true + contexts: + - continuous-integration/travis-ci + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/status-check-policy' + examples: + default: + $ref: '#/components/examples/status-check-policy' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove status check protection + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/remove-status-check-protection + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts: + get: + summary: Get all status check contexts + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-all-status-check-contexts + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add status check contexts + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/add-status-check-contexts + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + description: The name of the status checks + items: + type: string + required: + - contexts + example: + contexts: + - contexts + description: The name of the status checks + items: + type: string + examples: + default: + summary: Example adding status checks to a branch protection rule + value: + contexts: + - continuous-integration/travis-ci + - continuous-integration/jenkins + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + - continuous-integration/jenkins + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: contexts + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set status check contexts + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/set-status-check-contexts + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + description: The name of the status checks + items: + type: string + required: + - contexts + example: + contexts: + - contexts + description: The name of the status checks + items: + type: string + examples: + default: + summary: Example updating status checks for a branch protection rule + value: + contexts: + - continuous-integration/travis-ci + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: contexts + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove status check contexts + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + tags: + - repos + operationId: repos/remove-status-check-contexts + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + description: The name of the status checks + items: + type: string + required: + - contexts + example: + contexts: + - contexts + description: The name of the status checks + items: + type: string + examples: + default: + summary: Example removing status checks from a branch protection rule + value: + contexts: + - continuous-integration/jenkins + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: contexts + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions: + get: + summary: Get access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Lists who has access to this protected branch. + + + > [!NOTE] + + > Users, apps, and teams `restrictions` are only available for + organization-owned repositories. + tags: + - repos + operationId: repos/get-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-restriction-policy' + examples: + default: + $ref: '#/components/examples/branch-restriction-policy' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Disables the ability to restrict who can push to this branch. + tags: + - repos + operationId: repos/delete-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps: + get: + summary: Get apps with access to the protected branch + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Lists the GitHub Apps that have push access to this branch. Only GitHub + Apps that are installed on the repository and that have been granted + write access to the repository contents can be added as authorized + actors on a protected branch. + tags: + - repos + operationId: repos/get-apps-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add app access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Grants the specified apps push access for this branch. Only GitHub Apps + that are installed on the repository and that have been granted write + access to the repository contents can be added as authorized actors on a + protected branch. + tags: + - repos + operationId: repos/add-app-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + apps: + type: array + description: >- + The GitHub Apps that have push access to this branch. Use + the slugified version of the app name. **Note**: The list of + users, apps, and teams in total is limited to 100 items. + items: + type: string + required: + - apps + example: + apps: + - my-app + examples: + default: + value: + apps: + - octoapp + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: apps + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set app access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Replaces the list of apps that have push access to this branch. This + removes all apps that previously had push access and grants push access + to the new list of apps. Only GitHub Apps that are installed on the + repository and that have been granted write access to the repository + contents can be added as authorized actors on a protected branch. + tags: + - repos + operationId: repos/set-app-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + apps: + type: array + description: >- + The GitHub Apps that have push access to this branch. Use + the slugified version of the app name. **Note**: The list of + users, apps, and teams in total is limited to 100 items. + items: + type: string + required: + - apps + example: + apps: + - my-app + examples: + default: + value: + apps: + - octoapp + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: apps + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove app access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Removes the ability of an app to push to this branch. Only GitHub Apps + that are installed on the repository and that have been granted write + access to the repository contents can be added as authorized actors on a + protected branch. + tags: + - repos + operationId: repos/remove-app-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + apps: + type: array + description: >- + The GitHub Apps that have push access to this branch. Use + the slugified version of the app name. **Note**: The list of + users, apps, and teams in total is limited to 100 items. + items: + type: string + required: + - apps + example: + apps: + - my-app + examples: + default: + value: + apps: + - my-app + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: apps + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams: + get: + summary: Get teams with access to the protected branch + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Lists the teams who have push access to this branch. The list includes + child teams. + tags: + - repos + operationId: repos/get-teams-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add team access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Grants the specified teams push access for this branch. You can also + give push access to child teams. + tags: + - repos + operationId: repos/add-team-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + teams: + type: array + description: The slug values for teams + items: + type: string + required: + - teams + example: + teams: + - my-team + description: The slug values for teams + items: + type: string + examples: + default: + summary: Example adding a team in a branch protection rule + value: + teams: + - justice-league + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: teams + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set team access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Replaces the list of teams that have push access to this branch. This + removes all teams that previously had push access and grants push access + to the new list of teams. Team restrictions include child teams. + tags: + - repos + operationId: repos/set-team-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + teams: + type: array + description: The slug values for teams + items: + type: string + required: + - teams + example: + teams: + - justice-league + description: The slug values for teams + items: + type: string + examples: + default: + summary: Example replacing a team in a branch protection rule + value: + teams: + - justice-league + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: teams + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove team access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Removes the ability of a team to push to this branch. You can also + remove push access for child teams. + tags: + - repos + operationId: repos/remove-team-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + content: + application/json: + schema: + type: object + properties: + teams: + type: array + description: The slug values for teams + items: + type: string + required: + - teams + example: + teams: + - my-team + description: The slug values for teams + items: + type: string + examples: + default: + summary: Example removing a team in a branch protection rule + value: + teams: + - octocats + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: teams + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users: + get: + summary: Get users with access to the protected branch + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Lists the people who have push access to this branch. + tags: + - repos + operationId: repos/get-users-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add user access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Grants the specified people push access for this branch. + + + | Type | + Description + | + + | ------- | + ----------------------------------------------------------------------------------------------------------------------------- + | + + | `array` | Usernames for people who can have push access. **Note**: The + list of users, apps, and teams in total is limited to 100 items. | + tags: + - repos + operationId: repos/add-user-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona + examples: + default: + summary: Example adding a user in a branch protection rule + value: + users: + - octocat + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: users + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set user access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Replaces the list of people that have push access to this branch. This + removes all people that previously had push access and grants push + access to the new list of people. + + + | Type | + Description + | + + | ------- | + ----------------------------------------------------------------------------------------------------------------------------- + | + + | `array` | Usernames for people who can have push access. **Note**: The + list of users, apps, and teams in total is limited to 100 items. | + tags: + - repos + operationId: repos/set-user-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona + examples: + default: + summary: Example replacing a user in a branch protection rule + value: + users: + - octocat + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: users + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove user access restrictions + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Removes the ability of a user to push to this branch. + + + | Type | + Description + | + + | ------- | + --------------------------------------------------------------------------------------------------------------------------------------------- + | + + | `array` | Usernames of the people who should no longer have push + access. **Note**: The list of users, apps, and teams in total is limited + to 100 items. | + tags: + - repos + operationId: repos/remove-user-access-restrictions + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona + examples: + default: + summary: Example removing a user in a branch protection rule + value: + users: + - octocat + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: users + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/rename: + post: + summary: Rename a branch + description: >- + Renames a branch in a repository. + + + > [!NOTE] + + > Although the API responds immediately, the branch rename process might + take some extra time to complete in the background. You won't be able to + push to the old branch name while the rename process is in progress. For + more information, see "[Renaming a + branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + + + The authenticated user must have push access to the branch. If the + branch is the default branch, the authenticated user must also have + admin or owner permissions. + + + In order to rename the default branch, fine-grained access tokens also + need the `administration:write` repository permission. + tags: + - repos + operationId: repos/rename-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#rename-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_name: + type: string + description: The new name of the branch. + required: + - new_name + examples: + default: + value: + new_name: my_renamed_branch + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-with-protection' + examples: + default: + $ref: '#/components/examples/branch-with-protection' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/codeowners/errors: + get: + summary: List CODEOWNERS errors + description: >- + List any syntax errors that are detected in the CODEOWNERS + + file. + + + For more information about the correct CODEOWNERS syntax, + + see "[About code + owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + tags: + - repos + operationId: repos/codeowners-errors + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-codeowners-errors + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: >- + A branch, tag or commit name used to determine which version of the + CODEOWNERS file to use. Default: the repository's default branch + (e.g. `main`) + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codeowners-errors' + examples: + default: + $ref: '#/components/examples/codeowners-errors' + '404': + description: Resource not found + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/collaborators: + get: + summary: List repository collaborators + description: >- + For organization-owned repositories, the list of collaborators includes + outside collaborators, organization members that are direct + collaborators, organization members with access through team + memberships, organization members with access through default + organization permissions, and organization owners. + + The `permissions` hash returned in the response contains the base role + permissions of the collaborator. The `role_name` is the highest role + assigned to the collaborator after considering all sources of grants, + including: repo, teams, organization, and enterprise. + + There is presently not a way to differentiate between an organization + level grant and a repository level grant from this endpoint response. + + + Team members will include the members of child teams. + + + The authenticated user must have write, maintain, or admin privileges on + the repository to use this endpoint. For organization-owned + repositories, the authenticated user needs to be a member of the + organization. + + OAuth app tokens and personal access tokens (classic) need the + `read:org` and `repo` scopes to use this endpoint. + tags: + - repos + operationId: repos/list-collaborators + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: affiliation + description: >- + Filter collaborators returned by their affiliation. `outside` means + all outside collaborators of an organization-owned repository. + `direct` means all collaborators with permissions to an + organization-owned repository, regardless of organization membership + status. `all` means all collaborators the authenticated user can + see. + in: query + required: false + schema: + type: string + enum: + - outside + - direct + - all + default: all + - name: permission + description: >- + Filter collaborators by the permissions they have on the repository. + If not specified, all collaborators will be returned. + in: query + required: false + schema: + type: string + enum: + - pull + - triage + - push + - maintain + - admin + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/collaborator' + examples: + default: + $ref: '#/components/examples/collaborator-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + /repos/{owner}/{repo}/collaborators/{username}: + get: + summary: Check if a user is a repository collaborator + description: >- + For organization-owned repositories, the list of collaborators includes + outside collaborators, organization members that are direct + collaborators, organization members with access through team + memberships, organization members with access through default + organization permissions, and organization owners. + + + Team members will include the members of child teams. + + + The authenticated user must have push access to the repository to use + this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `read:org` and `repo` scopes to use this endpoint. + tags: + - repos + operationId: repos/check-collaborator + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response if user is a collaborator + '404': + description: Not Found if user is not a collaborator + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + put: + summary: Add a repository collaborator + description: >- + Add a user to a repository with a specified level of access. If the + repository is owned by an organization, this API does not add the user + to the organization - a user that has repository access without being an + organization member is called an "outside collaborator" (if they are not + an Enterprise Managed User) or a "repository collaborator" if they are + an Enterprise Managed User. These users are exempt from some + organization policies - see "[Adding outside collaborators to + repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" + to learn more about these collaborator types. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + + + Adding an outside collaborator may be restricted by enterprise and + organization administrators. For more information, see "[Enforcing + repository management policies in your + enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" + and "[Setting permissions for adding outside + collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" + for organization settings. + + + For more information on permission levels, see "[Repository permission + levels for an + organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + There are restrictions on which permissions can be granted to + organization members when an organization base role is in place. In this + case, the role being given must be equal to or higher than the org base + permission. Otherwise, the request will fail with: + + + ``` + + Cannot assign {member} permission of {role name} + + ``` + + + Note that, if you choose not to pass any parameters, you'll need to set + `Content-Length` to zero when calling out to this endpoint. For more + information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + + + The invitee will receive a notification that they have been invited to + the repository, which they must accept or decline. They may do this via + the notifications page, the email they receive, or by using the + [API](https://docs.github.com/rest/collaborators/invitations). + + + For Enterprise Managed Users, this endpoint does not send invitations - + these users are automatically added to organizations and repositories. + Enterprise Managed Users can only be added to organizations and + repositories within their enterprise. + + + **Updating an existing collaborator's permission level** + + + The endpoint can also be used to change the permissions of an existing + collaborator without first removing and re-adding the collaborator. To + change the permissions, use the same endpoint and pass a different + `permission` parameter. The response will be a `204`, with no other + indication that the permission level changed. + + + **Rate limits** + + + You are limited to sending 50 invitations to a repository per 24 hour + period. Note there is no limit if you are inviting organization members + to an organization repository. + tags: + - repos + operationId: repos/add-collaborator + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: >- + The permission to grant the collaborator. **Only valid on + organization-owned repositories.** We accept the following + permissions to be set: `pull`, `triage`, `push`, `maintain`, + `admin` and you can also specify a custom repository role + name, if the owning organization has defined any. + default: push + examples: + new-invitation-is-created: + summary: Add a collaborator with triage permissions + value: + permission: triage + responses: + '201': + description: Response when a new invitation is created + content: + application/json: + schema: + $ref: '#/components/schemas/repository-invitation' + examples: + new-invitation-is-created: + $ref: >- + #/components/examples/repository-invitation-response-when-a-new-invitation-is-created + '204': + description: >- + Response when: + + - an existing collaborator is added as a collaborator + + - an organization member is added as an individual collaborator + + - an existing team member (whose team is also a repository + collaborator) is added as an individual collaborator + '403': + $ref: '#/components/responses/forbidden' + '422': + description: >- + Response when: + + - validation failed, or the endpoint has been spammed + + - an Enterprise Managed User (EMU) account was invited to a + repository in an enterprise with personal user accounts + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + delete: + summary: Remove a repository collaborator + description: >- + Removes a collaborator from a repository. + + + To use this endpoint, the authenticated user must either be an + administrator of the repository or target themselves for removal. + + + This endpoint also: + + - Cancels any outstanding invitations sent by the collaborator + + - Unassigns the user from any issues + + - Removes access to organization projects if the user is not an + organization member and is not a collaborator on any other organization + repositories. + + - Unstars the repository + + - Updates access permissions to packages + + + Removing a user as a collaborator has the following effects on forks: + - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + - If the user had their own fork of the repository, the fork will be deleted. + - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + + > [!NOTE] + + > A user can still have access to the repository through organization + permissions like base repository permissions. + + + Although the API responds immediately, the additional permission updates + might take some extra time to complete in the background. + + + For more information on fork permissions, see "[About permissions and + visibility of + forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + tags: + - repos + operationId: repos/remove-collaborator + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + responses: + '204': + description: No Content when collaborator was removed from the repository. + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + /repos/{owner}/{repo}/collaborators/{username}/permission: + get: + summary: Get repository permissions for a user + description: >- + Checks the repository permission and role of a collaborator. + + + The `permission` attribute provides the legacy base roles of `admin`, + `write`, `read`, and `none`, where the + + `maintain` role is mapped to `write` and the `triage` role is mapped to + `read`. + + The `role_name` attribute provides the name of the assigned role, + including custom roles. The + + `permission` can also be used to determine which base level of access + the collaborator has to the repository. + + + The calculated permissions are the highest role assigned to the + collaborator after considering all sources of grants, including: repo, + teams, organization, and enterprise. + + There is presently not a way to differentiate between an organization + level grant and a repository level grant from this endpoint response. + tags: + - repos + operationId: repos/get-collaborator-permission-level + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + responses: + '200': + description: if user has admin permissions + content: + application/json: + schema: + $ref: '#/components/schemas/repository-collaborator-permission' + examples: + response-if-user-has-admin-permissions: + $ref: >- + #/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + /repos/{owner}/{repo}/comments: + get: + summary: List commit comments for a repository + description: >- + Lists the commit comments for a specified repository. Comments are + ordered by ascending ID. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - repos + operationId: repos/list-commit-comments-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/comments/{comment_id}: + get: + summary: Get a commit comment + description: >- + Gets a specified commit comment. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - repos + operationId: repos/get-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#get-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update a commit comment + description: >- + Updates the contents of a specified commit comment. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - repos + operationId: repos/update-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#update-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment + required: + - body + examples: + default: + value: + body: Nice change + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment-2' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete a commit comment + description: '' + tags: + - repos + operationId: repos/delete-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/commits: + get: + summary: List commits + description: >- + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The following fields are + included in the `verification` object: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - repos + operationId: repos/list-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#list-commits + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sha + description: >- + SHA or branch to start listing commits from. Default: the + repository’s default branch (usually `main`). + in: query + required: false + schema: + type: string + - name: path + description: Only commits containing this file path will be returned. + in: query + required: false + schema: + type: string + - name: author + description: GitHub username or email address to use to filter by commit author. + in: query + required: false + schema: + type: string + - name: committer + description: >- + GitHub username or email address to use to filter by commit + committer. + in: query + required: false + schema: + type: string + - name: since + description: >- + Only show results that were last updated after the given time. This + is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, + timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or + unexpected results may be returned. + in: query + required: false + schema: + type: string + format: date-time + - name: until + description: >- + Only commits before this date will be returned. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must + be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected + results may be returned. + in: query + required: false + schema: + type: string + format: date-time + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit-items' + headers: + Link: + $ref: '#/components/headers/link' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head: + get: + summary: List branches for HEAD commit + description: >- + Protected branches are available in public repositories with GitHub Free + and GitHub Free for organizations, and in public and private + repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and + GitHub Enterprise Server. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + Returns all branches where the given commit SHA is the HEAD, or latest + commit for the branch. + tags: + - repos + operationId: repos/list-branches-for-head-commit + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/commits/commits#list-branches-for-head-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/branch-short' + examples: + default: + $ref: '#/components/examples/branch-short-items' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{commit_sha}/comments: + get: + summary: List commit comments + description: >- + Lists the comments for a specified commit. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - repos + operationId: repos/list-comments-for-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#list-commit-comments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create a commit comment + description: >- + Create a comment for a commit using its `:commit_sha`. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw + markdown body. Response will include `body`. This is the default if you + do not pass any specific media type. + + - **`application/vnd.github-commitcomment.text+json`**: Returns a text + only representation of the markdown body. Response will include + `body_text`. + + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML + rendered from the body's markdown. Response will include `body_html`. + + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, + text, and HTML representations. Response will include `body`, + `body_text`, and `body_html`. + tags: + - repos + operationId: repos/create-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#create-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment. + path: + type: string + description: Relative path of the file to comment on. + position: + type: integer + description: Line index in the diff to comment on. + line: + type: integer + description: >- + **Closing down notice**. Use **position** parameter instead. + Line number in the file to comment on. + required: + - body + examples: + default: + value: + body: Great stuff + path: file1.txt + position: 4 + line: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/comments/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/commits/{commit_sha}/pulls: + get: + summary: List pull requests associated with a commit + description: >- + Lists the merged pull request that introduced the commit to the + repository. If the commit is not present in the default branch, it will + return merged and open pull requests associated with the commit. + + + To list the open or merged pull requests associated with a branch, you + can set the `commit_sha` parameter to the branch name. + tags: + - repos + operationId: repos/list-pull-requests-associated-with-commit + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{ref}: + get: + summary: Get a commit + description: >- + Returns the contents of a single commit reference. You must have `read` + access for the repository to use this endpoint. + + + > [!NOTE] + + > If there are more than 300 files in the commit diff and the default + JSON media type is requested, the response will include pagination link + headers for the remaining files, up to a limit of 3000 files. Each page + contains the static commit information, and the only changes are to the + file listing. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + Pagination query parameters are not supported for these media types. + + + - **`application/vnd.github.diff`**: Returns the diff of the commit. + Larger diffs may time out and return a 5xx status code. + + - **`application/vnd.github.patch`**: Returns the patch of the commit. + Diffs with binary data will have no `patch` property. Larger diffs may + time out and return a 5xx status code. + + - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You + can use this endpoint to check if a remote reference's SHA-1 hash is the + same as your local reference's SHA-1 hash by providing the local SHA-1 + reference as the ETag. + + + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The following fields are + included in the `verification` object: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - repos + operationId: repos/get-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#get-a-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/commit-ref' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit' + application/vnd.github.diff: + schema: + type: string + examples: + default: + $ref: '#/components/examples/diff-media-type' + application/vnd.github.patch: + schema: + type: string + examples: + default: + $ref: '#/components/examples/patch-media-type' + application/vnd.github.sha: + schema: + type: string + examples: + default: + value: ac3282a2725be3b1d4979169a7a311c89066af1c + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{ref}/status: + get: + summary: Get the combined status for a specific reference + description: >- + Users with pull access in a repository can access a combined view of + commit statuses for a given ref. The ref can be a SHA, a branch name, or + a tag name. + + + + Additionally, a combined `state` is returned. The `state` is one of: + + + * **failure** if any of the contexts report as `error` or `failure` + + * **pending** if there are no statuses or a context is `pending` + + * **success** if the latest status for all contexts is `success` + tags: + - repos + operationId: repos/get-combined-status-for-ref + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/combined-commit-status' + examples: + default: + $ref: '#/components/examples/combined-commit-status' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/commits/{ref}/statuses: + get: + summary: List commit statuses for a reference + description: >- + Users with pull access in a repository can view commit statuses for a + given ref. The ref can be a SHA, a branch name, or a tag name. Statuses + are returned in reverse chronological order. The first status in the + list will be the latest one. + + + This resource is also available via a legacy route: `GET + /repos/:owner/:repo/statuses/:ref`. + tags: + - repos + operationId: repos/list-commit-statuses-for-ref + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/status' + examples: + default: + $ref: '#/components/examples/status-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/community/profile: + get: + summary: Get community profile metrics + description: >- + Returns all community profile metrics for a repository. The repository + cannot be a fork. + + + The returned metrics include an overall health score, the repository + description, the presence of documentation, the + + detected code of conduct, the detected license, and the presence of + ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + + README, and CONTRIBUTING files. + + + The `health_percentage` score is defined as a percentage of how many of + + the recommended community health files are present. For more + information, see + + "[About community profiles for public + repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + + + `content_reports_enabled` is only returned for organization-owned + repositories. + tags: + - repos + operationId: repos/get-community-profile-metrics + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/metrics/community#get-community-profile-metrics + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/community-profile' + examples: + default: + $ref: '#/components/examples/community-profile' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: community + x-stackQL-resource: community + /repos/{owner}/{repo}/compare/{basehead}: + get: + summary: Compare two commits + description: >- + Compares two commits against one another. You can compare refs (branches + or tags) and commit SHAs in the same repository, or you can compare refs + and commit SHAs that exist in different repositories within the same + repository network, including fork branches. For more information about + how to view a repository's network, see "[Understanding connections + between + repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + + + This endpoint is equivalent to running the `git log BASE..HEAD` command, + but it returns commits in a different order. The `git log BASE..HEAD` + command returns commits in reverse chronological order, whereas the API + returns commits in chronological order. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.diff`**: Returns the diff of the commit. + + - **`application/vnd.github.patch`**: Returns the patch of the commit. + Diffs with binary data will have no `patch` property. + + + The API response includes details about the files that were changed + between the two commits. This includes the status of the change (if a + file was added, removed, modified, or renamed), and details of the + change itself. For example, files with a `renamed` status have a + `previous_filename` field showing the previous filename of the file, and + files with a `modified` status have a `patch` field showing the changes + made to the file. + + + When calling this endpoint without any paging parameter (`per_page` or + `page`), the returned list is limited to 250 commits, and the last + commit in the list is the most recent of the entire comparison. + + + **Working with large comparisons** + + + To process a response with a large number of commits, use a query + parameter (`per_page` or `page`) to paginate the results. When using + pagination: + + + - The list of changed files is only shown on the first page of results, + and it includes up to 300 changed files for the entire comparison. + + - The results are returned in chronological order, but the last commit + in the returned list may not be the most recent one in the entire set if + there are more pages of results. + + + For more information on working with pagination, see "[Using pagination + in the REST + API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." + + + **Signature verification object** + + + The response will include a `verification` object that describes the + result of verifying the commit's signature. The `verification` object + includes the following fields: + + + | Name | Type | Description | + + | ---- | ---- | ----------- | + + | `verified` | `boolean` | Indicates whether GitHub considers the + signature in this commit to be verified. | + + | `reason` | `string` | The reason for verified value. Possible values + and their meanings are enumerated in table below. | + + | `signature` | `string` | The signature that was extracted from the + commit. | + + | `payload` | `string` | The value that was signed. | + + | `verified_at` | `string` | The date the signature was verified by + GitHub. | + + + These are the possible values for `reason` in the `verification` object: + + + | Value | Description | + + | ----- | ----------- | + + | `expired_key` | The key that made the signature is expired. | + + | `not_signing_key` | The "signing" flag is not among the usage flags in + the GPG key that made the signature. | + + | `gpgverify_error` | There was an error communicating with the + signature verification service. | + + | `gpgverify_unavailable` | The signature verification service is + currently unavailable. | + + | `unsigned` | The object does not include a signature. | + + | `unknown_signature_type` | A non-PGP signature was found in the + commit. | + + | `no_user` | No user was associated with the `committer` email address + in the commit. | + + | `unverified_email` | The `committer` email address in the commit was + associated with a user, but the email address is not verified on their + account. | + + | `bad_email` | The `committer` email address in the commit is not + included in the identities of the PGP key that made the signature. | + + | `unknown_key` | The key that made the signature has not been + registered with any user's account. | + + | `malformed_signature` | There was an error parsing the signature. | + + | `invalid` | The signature could not be cryptographically verified + using the key whose key-id was found in the signature. | + + | `valid` | None of the above errors applied, so the signature is + considered to be verified. | + tags: + - repos + operationId: repos/compare-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#compare-two-commits + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - name: basehead + description: >- + The base branch and head branch to compare. This parameter expects + the format `BASE...HEAD`. Both must be branch names in `repo`. To + compare with a branch that exists in a different repository in the + same network as `repo`, the `basehead` parameter expects the format + `USERNAME:BASE...USERNAME:HEAD`. + in: path + required: true + x-multi-segment: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comparison' + examples: + default: + $ref: '#/components/examples/commit-comparison' + application/vnd.github.diff: + schema: + type: string + examples: + default: + $ref: '#/components/examples/diff-media-type' + application/vnd.github.patch: + schema: + type: string + examples: + default: + $ref: '#/components/examples/patch-media-type' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/contents/{path}: + get: + summary: Get repository content + description: >- + Gets the contents of a file or directory in a repository. Specify the + file path or directory with the `path` parameter. If you omit the `path` + parameter, you will receive the contents of the repository's root + directory. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw file contents + for files and symlinks. + + - **`application/vnd.github.html+json`**: Returns the file contents in + HTML. Markup languages are rendered to HTML using GitHub's open-source + [Markup library](https://github.com/github/markup). + + - **`application/vnd.github.object+json`**: Returns the contents in a + consistent object format regardless of the content type. For example, + instead of an array of objects for a directory, the response will be an + object with an `entries` attribute containing the array of objects. + + + If the content is a directory, the response will be an array of objects, + one object for each item in the directory. When listing the contents of + a directory, submodules have their "type" specified as "file". + Logically, the value _should_ be "submodule". This behavior exists [for + backwards compatibility purposes](https://git.io/v1YCW). In the next + major version of the API, the type will be returned as "submodule". + + + If the content is a symlink and the symlink's target is a normal file in + the repository, then the API responds with the content of the file. + Otherwise, the API responds with an object describing the symlink + itself. + + + If the content is a submodule, the `submodule_git_url` field identifies + the location of the submodule repository, and the `sha` identifies a + specific commit within the submodule repository. Git uses the given URL + when cloning the submodule repository, and checks out the submodule at + that specific commit. If the submodule repository is not hosted on + github.com, the Git URLs (`git_url` and `_links["git"]`) and the + github.com URLs (`html_url` and `_links["html"]`) will have null values. + + + **Notes**: + + + - To get a repository's contents recursively, you can [recursively get + the tree](https://docs.github.com/rest/git/trees#get-a-tree). + + - This API has an upper limit of 1,000 files for a directory. If you + need to retrieve + + more files, use the [Git Trees + API](https://docs.github.com/rest/git/trees#get-a-tree). + + - Download URLs expire and are meant to be used just once. To ensure the + download URL does not expire, please use the contents API to obtain a + fresh download URL for each download. + + - If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the contents of + these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. + tags: + - repos + operationId: repos/get-content + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#get-repository-content + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: path + description: path parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: >- + The name of the commit/branch/tag. Default: the repository’s default + branch. + in: query + required: false + schema: + type: string + requestBody: + required: false + content: + application/json: + examples: + response-if-content-is-a-file-github-object: + summary: Content is a file using the object media type + response-if-content-is-a-directory-github-object: + summary: Content is a directory using the object media type + response-if-content-is-a-file: + summary: Content is a file + response-if-content-is-a-directory: + summary: Content is a directory + response-if-content-is-a-symlink: + summary: Content is a symlink + response-if-content-is-a-submodule: + summary: Content is a submodule + responses: + '200': + description: Response + content: + application/vnd.github.object: + schema: + $ref: '#/components/schemas/content-tree' + examples: + response-if-content-is-a-file-github-object: + $ref: >- + #/components/examples/content-file-response-if-content-is-a-file + response-if-content-is-a-directory-github-object: + $ref: >- + #/components/examples/content-file-response-if-content-is-a-directory-object + application/json: + schema: + discriminator: + propertyName: type + mapping: + array: '#/components/schemas/content-directory' + file: '#/components/schemas/content-file' + symlink: '#/components/schemas/content-symlink' + submodule: '#/components/schemas/content-submodule' + title: Content Directory + description: A list of directory items + type: array + items: + type: object + properties: + type: + type: string + enum: + - dir + - file + - submodule + - symlink + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + properties: + type: + type: string + enum: + - file + encoding: + type: string + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + example: '"actual/actual.md"' + submodule_git_url: + type: string + example: '"git://example.com/defunkt/dotjs.git"' + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + - target + - submodule_git_url + examples: + response-if-content-is-a-file: + $ref: >- + #/components/examples/content-file-response-if-content-is-a-file + response-if-content-is-a-directory: + $ref: >- + #/components/examples/content-file-response-if-content-is-a-directory + response-if-content-is-a-symlink: + $ref: >- + #/components/examples/content-file-response-if-content-is-a-symlink + response-if-content-is-a-submodule: + $ref: >- + #/components/examples/content-file-response-if-content-is-a-submodule + '302': + $ref: '#/components/responses/found' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-github-breaking-changes: + - changeset: return_submodule_type_for_submodules_in_directory_lists + patch: + description: >- + Gets the contents of a file or directory in a repository. Specify + the file path or directory with the `path` parameter. If you omit + the `path` parameter, you will receive the contents of the + repository's root directory. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw file + contents for files and symlinks. + + - **`application/vnd.github.html+json`**: Returns the file + contents in HTML. Markup languages are rendered to HTML using + GitHub's open-source [Markup + library](https://github.com/github/markup). + + - **`application/vnd.github.object+json`**: Returns the contents + in a consistent object format regardless of the content type. For + example, instead of an array of objects for a directory, the + response will be an object with an `entries` attribute containing + the array of objects. + + + If the content is a directory: The response will be an array of + objects, one object for each item in the directory. + + + If the content is a symlink and the symlink's target is a normal + file in the repository, then the API responds with the content of + the file. Otherwise, the API responds with an object describing + the symlink itself. + + + If the content is a submodule, the `submodule_git_url` field + identifies the location of the submodule repository, and the `sha` + identifies a specific commit within the submodule repository. Git + uses the given URL when cloning the submodule repository, and + checks out the submodule at that specific commit. If the submodule + repository is not hosted on github.com, the Git URLs (`git_url` + and `_links["git"]`) and the github.com URLs (`html_url` and + `_links["html"]`) will have null values. + + + **Notes**: + + + - To get a repository's contents recursively, you can [recursively + get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + + - This API has an upper limit of 1,000 files for a directory. If + you need to retrieve + + more files, use the [Git Trees + API](https://docs.github.com/rest/git/trees#get-a-tree). + + - Download URLs expire and are meant to be used just once. To + ensure the download URL does not expire, please use the contents + API to obtain a fresh download URL for each download. + + - If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the + contents of these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. + version: '2026-03-10' + x-stackQL-resource: contents + put: + summary: Create or update file contents + description: >- + Creates a new file or replaces an existing file in a repository. + + + > [!NOTE] + + > If you use this endpoint and the "[Delete a + file](https://docs.github.com/rest/repos/contents/#delete-a-file)" + endpoint in parallel, the concurrent requests will conflict and you will + receive errors. You must use these endpoints serially instead. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. The `workflow` scope is also required in + order to modify files in the `.github/workflows` directory. + tags: + - repos + operationId: repos/create-or-update-file-contents + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/contents#create-or-update-file-contents + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: path + description: path parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The commit message. + content: + type: string + description: The new file content, using Base64 encoding. + sha: + type: string + description: >- + **Required if you are updating a file**. The blob SHA of the + file being replaced. + branch: + type: string + description: 'The branch name. Default: the repository’s default branch.' + committer: + type: object + description: >- + The person that committed the file. Default: the + authenticated user. + properties: + name: + type: string + description: >- + The name of the author or committer of the commit. + You'll receive a `422` status code if `name` is omitted. + email: + type: string + description: >- + The email of the author or committer of the commit. + You'll receive a `422` status code if `email` is + omitted. + date: + type: string + example: '"2013-01-05T13:13:22+05:00"' + required: + - name + - email + author: + type: object + description: >- + The author of the file. Default: The `committer` or the + authenticated user if you omit `committer`. + properties: + name: + type: string + description: >- + The name of the author or committer of the commit. + You'll receive a `422` status code if `name` is omitted. + email: + type: string + description: >- + The email of the author or committer of the commit. + You'll receive a `422` status code if `email` is + omitted. + date: + type: string + example: '"2013-01-15T17:13:22+05:00"' + required: + - name + - email + required: + - message + - content + examples: + example-for-creating-a-file: + summary: Example for creating a file + value: + message: my commit message + committer: + name: Monalisa Octocat + email: octocat@github.com + content: bXkgbmV3IGZpbGUgY29udGVudHM= + example-for-updating-a-file: + summary: Example for updating a file + value: + message: a new commit message + committer: + name: Monalisa Octocat + email: octocat@github.com + content: bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz + sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/file-commit' + examples: + example-for-updating-a-file: + $ref: >- + #/components/examples/file-commit-example-for-updating-a-file + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/file-commit' + examples: + example-for-creating-a-file: + $ref: >- + #/components/examples/file-commit-example-for-creating-a-file + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict + content: + application/json: + schema: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: >- + #/components/schemas/secret-scanning-push-protection-bypass-placeholder-id + token_type: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + delete: + summary: Delete a file + description: >- + Deletes a file in a repository. + + + You can provide an additional `committer` parameter, which is an object + containing information about the committer. Or, you can provide an + `author` parameter, which is an object containing information about the + author. + + + The `author` section is optional and is filled in with the `committer` + information if omitted. If the `committer` information is omitted, the + authenticated user's information is used. + + + You must provide values for both `name` and `email`, whether you choose + to use `author` or `committer`. Otherwise, you'll receive a `422` status + code. + + + > [!NOTE] + + > If you use this endpoint and the "[Create or update file + contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" + endpoint in parallel, the concurrent requests will conflict and you will + receive errors. You must use these endpoints serially instead. + tags: + - repos + operationId: repos/delete-file + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#delete-a-file + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: path + description: path parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The commit message. + sha: + type: string + description: The blob SHA of the file being deleted. + branch: + type: string + description: 'The branch name. Default: the repository’s default branch' + committer: + type: object + description: object containing information about the committer. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + author: + type: object + description: object containing information about the author. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + required: + - message + - sha + examples: + default: + value: + message: my commit message + committer: + name: Monalisa Octocat + email: octocat@github.com + sha: 329688480d39049927147c162b9d2deaf885005f + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/file-commit' + examples: + default: + $ref: '#/components/examples/file-commit' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/contributors: + get: + summary: List repository contributors + description: >- + Lists contributors to the specified repository and sorts them by the + number of commits per contributor in descending order. This endpoint may + return information that is a few hours old because the GitHub REST API + caches contributor data to improve performance. + + + GitHub identifies contributors by author email address. This endpoint + groups contribution counts by GitHub user, which includes all associated + email addresses. To improve performance, only the first 500 author email + addresses in the repository link to GitHub users. The rest will appear + as anonymous contributors without associated GitHub user information. + tags: + - repos + operationId: repos/list-contributors + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-contributors + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: anon + description: Set to `1` or `true` to include anonymous contributors in results. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: If repository contains content + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/contributor' + examples: + response-if-repository-contains-content: + $ref: >- + #/components/examples/contributor-items-response-if-repository-contains-content + headers: + Link: + $ref: '#/components/headers/link' + '204': + description: Response if repository is empty + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/deployments: + get: + summary: List deployments + description: 'Simple filtering of deployments is available via query parameters:' + tags: + - repos + operationId: repos/list-deployments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/deployments#list-deployments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sha + description: The SHA recorded at creation time. + in: query + required: false + schema: + type: string + default: none + - name: ref + description: The name of the ref. This can be a branch, tag, or SHA. + in: query + required: false + schema: + type: string + default: none + - name: task + description: >- + The name of the task for the deployment (e.g., `deploy` or + `deploy:migrations`). + in: query + required: false + schema: + type: string + default: none + - name: environment + description: >- + The name of the environment that was deployed to (e.g., `staging` or + `production`). + in: query + required: false + schema: + type: string + default: none + nullable: true + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deployment' + examples: + default: + $ref: '#/components/examples/deployment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + post: + summary: Create a deployment + description: >- + Deployments offer a few configurable parameters with certain defaults. + + + The `ref` parameter can be any named branch, tag, or SHA. At GitHub we + often deploy branches and verify them + + before we merge a pull request. + + + The `environment` parameter allows deployments to be issued to different + runtime environments. Teams often have + + multiple environments for verifying their applications, such as + `production`, `staging`, and `qa`. This parameter + + makes it easier to track which environments have requested deployments. + The default environment is `production`. + + + The `auto_merge` parameter is used to ensure that the requested ref is + not behind the repository's default branch. If + + the ref _is_ behind the default branch for the repository, we will + attempt to merge it for you. If the merge succeeds, + + the API will return a successful merge commit. If merge conflicts + prevent the merge from succeeding, the API will + + return a failure response. + + + By default, [commit + statuses](https://docs.github.com/rest/commits/statuses) for every + submitted context must be in a `success` + + state. The `required_contexts` parameter allows you to specify a subset + of contexts that must be `success`, or to + + specify contexts that have not yet been submitted. You are not required + to use commit statuses to deploy. If you do + + not require any contexts or create any commit statuses, the deployment + will always succeed. + + + The `payload` parameter is available for any extra information that a + deployment system might need. It is a JSON text + + field that will be passed on when a deployment event is dispatched. + + + The `task` parameter is used by the deployment system to allow different + execution paths. In the web world this might + + be `deploy:migrations` to run schema changes on the system. In the + compiled world this could be a flag to compile an + + application with debugging enabled. + + + Merged branch response: + + + You will see this response when GitHub automatically merges the base + branch into the topic branch instead of creating + + a deployment. This auto-merge happens when: + + * Auto-merge option is enabled in the repository + + * Topic branch does not include the latest changes on the base branch, + which is `master` in the response example + + * There are no merge conflicts + + + If there are no new commits in the base branch, a new request to create + a deployment should give a successful + + response. + + + Merge conflict response: + + + This error happens when the `auto_merge` option is enabled and when the + default branch (in this case `master`), can't + + be merged into the branch that's being deployed (in this case + `topic-branch`), due to merge conflicts. + + + Failed commit status checks: + + + This error happens when the `required_contexts` parameter indicates that + one or more contexts need to have a `success` + + status for the commit to be deployed, but one or more of the required + contexts do not have a state of `success`. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repo_deployment` scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/deployments#create-a-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ref: + type: string + description: The ref to deploy. This can be a branch, tag, or SHA. + task: + type: string + description: >- + Specifies a task to execute (e.g., `deploy` or + `deploy:migrations`). + default: deploy + auto_merge: + type: boolean + description: >- + Attempts to automatically merge the default branch into the + requested ref, if it's behind the default branch. + default: true + required_contexts: + type: array + description: >- + The [status](https://docs.github.com/rest/commits/statuses) + contexts to verify against commit status checks. If you omit + this parameter, GitHub verifies all unique contexts before + creating a deployment. To bypass checking entirely, pass an + empty array. Defaults to all unique contexts. + items: + type: string + payload: + type: object + additionalProperties: true + description: JSON payload with extra information about the deployment. + default: '' + environment: + type: string + description: >- + Name for the target deployment environment (e.g., + `production`, `staging`, `qa`). + default: production + description: + type: string + description: Short description of the deployment. + default: '' + nullable: true + transient_environment: + type: boolean + description: >- + Specifies if the given environment is specific to the + deployment and will no longer exist at some point in the + future. Default: `false` + default: false + production_environment: + type: boolean + description: >- + Specifies if the given environment is one that end-users + directly interact with. Default: `true` when `environment` + is `production` and `false` otherwise. + required: + - ref + examples: + simple-example: + summary: Simple example + value: + ref: topic-branch + payload: '{ "deploy": "migrate" }' + description: Deploy request from hubot + advanced-example: + summary: Advanced example + value: + ref: topic-branch + auto_merge: false + payload: '{ "deploy": "migrate" }' + description: Deploy request from hubot + required_contexts: + - ci/janky + - security/brakeman + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment' + examples: + simple-example: + $ref: '#/components/examples/deployment-simple-example' + '202': + description: Merged branch response + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + merged-branch-response: + value: + message: Auto-merged master into topic-branch on deployment. + '409': + description: >- + Conflict when there is a merge conflict or the commit's status + checks failed + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + /repos/{owner}/{repo}/deployments/{deployment_id}: + get: + summary: Get a deployment + description: '' + tags: + - repos + operationId: repos/get-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/deployments#get-a-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment' + examples: + default: + $ref: '#/components/examples/deployment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + delete: + summary: Delete a deployment + description: >- + If the repository only has one deployment, you can delete the deployment + regardless of its status. If the repository has more than one + deployment, you can only delete inactive deployments. This ensures that + repositories with multiple deployments will always have an active + deployment. + + + To set a deployment as inactive, you must: + + + * Create a new deployment that is active so that the system has a + record of the current state, then delete the previously active + deployment. + + * Mark the active deployment as inactive by adding any non-successful + deployment status. + + + For more information, see "[Create a + deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" + and "[Create a deployment + status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repo_deployment` scope to use this endpoint. + tags: + - repos + operationId: repos/delete-deployment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/deployments#delete-a-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + /repos/{owner}/{repo}/deployments/{deployment_id}/statuses: + get: + summary: List deployment statuses + description: 'Users with pull access can view deployment statuses for a deployment:' + tags: + - repos + operationId: repos/list-deployment-statuses + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/statuses#list-deployment-statuses + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deployment-status' + examples: + default: + $ref: '#/components/examples/deployment-status-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: statuses + x-stackQL-resource: statuses + post: + summary: Create a deployment status + description: >- + Users with `push` access can create deployment statuses for a given + deployment. + + + OAuth app tokens and personal access tokens (classic) need the + `repo_deployment` scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment-status + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/statuses#create-a-deployment-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: >- + The state of the status. When you set a transient deployment + to `inactive`, the deployment will be shown as `destroyed` + in GitHub. + enum: + - error + - failure + - inactive + - in_progress + - queued + - pending + - success + target_url: + type: string + description: >- + The target URL to associate with this status. This URL + should contain output to keep the user updated while the + task is running or serve as historical information for what + happened in the deployment. + + + > [!NOTE] + + > It's recommended to use the `log_url` parameter, which + replaces `target_url`. + default: '' + log_url: + type: string + description: >- + The full URL of the deployment's output. This parameter + replaces `target_url`. We will continue to accept + `target_url` to support legacy uses, but we recommend + replacing `target_url` with `log_url`. Setting `log_url` + will automatically set `target_url` to the same value. + Default: `""` + default: '' + description: + type: string + description: >- + A short description of the status. The maximum description + length is 140 characters. + default: '' + environment: + type: string + description: >- + Name for the target deployment environment, which can be + changed when setting a deploy status. For example, + `production`, `staging`, or `qa`. If not defined, the + environment of the previous status on the deployment will be + used, if it exists. Otherwise, the environment of the + deployment will be used. + environment_url: + type: string + description: 'Sets the URL for accessing your environment. Default: `""`' + default: '' + auto_inactive: + type: boolean + description: >- + Adds a new `inactive` status to all prior non-transient, + non-production environment deployments with the same + repository and `environment` name as the created status's + deployment. An `inactive` status is only added to + deployments that had a `success` state. Default: `true` + required: + - state + examples: + default: + value: + environment: production + state: success + log_url: https://example.com/deployment/42/output + description: Deployment finished successfully. + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-status' + examples: + default: + $ref: '#/components/examples/deployment-status' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + schema: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}: + get: + summary: Get a deployment status + description: 'Users with pull access can view a deployment status for a deployment:' + tags: + - repos + operationId: repos/get-deployment-status + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/statuses#get-a-deployment-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + - name: status_id + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-status' + examples: + default: + $ref: '#/components/examples/deployment-status' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/dispatches: + post: + summary: Create a repository dispatch event + description: >- + You can use this endpoint to trigger a webhook event called + `repository_dispatch` when you want activity that happens outside of + GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You + must configure your GitHub Actions workflow or GitHub App to run when + the `repository_dispatch` event occurs. For an example + `repository_dispatch` webhook payload, see + "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + + + The `client_payload` parameter is available for any extra information + that your workflow might need. This parameter is a JSON payload that + will be passed on when the webhook event is dispatched. For example, the + `client_payload` can include a message that a user would like to send + using a GitHub Actions workflow. Or the `client_payload` can be used as + a test to debug your workflow. + + + This input example shows how you can use the `client_payload` as a test + to debug your workflow. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/create-dispatch-event + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - event_type + properties: + event_type: + type: string + description: >- + A custom webhook event name. Must be 100 characters or + fewer. + minLength: 1 + maxLength: 100 + client_payload: + type: object + description: >- + JSON payload with extra information about the webhook event + that your action or workflow may use. The maximum number of + top-level properties is 10. The total size of the JSON + payload must be less than 64KB. + additionalProperties: true + maxProperties: 10 + examples: + default: + value: + event_type: on-demand-test + client_payload: + unit: false + integration: true + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/environments: + get: + summary: List environments + description: >- + Lists the environments for a repository. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-all-environments + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/environments#list-environments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of environments in this repository + example: 5 + type: integer + environments: + type: array + items: + $ref: '#/components/schemas/environment' + examples: + default: + $ref: '#/components/examples/environments' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + /repos/{owner}/{repo}/environments/{environment_name}: + get: + summary: Get an environment + description: >- + > [!NOTE] + + > To get information about name patterns that branches must match in + order to deploy to this environment, see "[Get a deployment branch + policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-environment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/environments#get-an-environment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/environment' + examples: + default: + $ref: '#/components/examples/environment' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + put: + summary: Create or update an environment + description: >- + Create or update an environment with protection rules, such as required + reviewers. For more information about environment protection rules, see + "[Environments](/actions/reference/environments#environment-protection-rules)." + + + > [!NOTE] + + > To create or update name patterns that branches must match in order to + deploy to this environment, see "[Deployment branch + policies](/rest/deployments/branch-policies)." + + + > [!NOTE] + + > To create or update secrets for an environment, see "[GitHub Actions + secrets](/rest/actions/secrets)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-environment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/environments#create-or-update-an-environment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + wait_timer: + $ref: '#/components/schemas/wait-timer' + prevent_self_review: + $ref: '#/components/schemas/prevent-self-review' + reviewers: + type: array + nullable: true + description: >- + The people or teams that may review jobs that reference the + environment. You can list up to six users or teams as + reviewers. The reviewers must have at least read access to + the repository. Only one of the required reviewers needs to + approve the job for it to proceed. + items: + type: object + properties: + type: + $ref: '#/components/schemas/deployment-reviewer-type' + id: + type: integer + description: >- + The id of the user or team who can review the + deployment + example: 4532992 + deployment_branch_policy: + $ref: '#/components/schemas/deployment-branch-policy-settings' + additionalProperties: false + examples: + default: + value: + wait_timer: 30 + prevent_self_review: false + reviewers: + - type: User + id: 1 + - type: Team + id: 1 + deployment_branch_policy: + protected_branches: false + custom_branch_policies: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/environment' + examples: + default: + $ref: '#/components/examples/environment' + '422': + description: >- + Validation error when the environment name is invalid or when + `protected_branches` and `custom_branch_policies` in + `deployment_branch_policy` are set to the same value + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + delete: + summary: Delete an environment + description: >- + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/delete-an-environment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/environments#delete-an-environment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + responses: + '204': + description: Default response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies: + get: + summary: List deployment branch policies + description: >- + Lists the deployment branch policies for an environment. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/list-deployment-branch-policies + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: >- + The number of deployment branch policies for the + environment. + type: integer + example: 2 + branch_policies: + type: array + items: + $ref: '#/components/schemas/deployment-branch-policy' + required: + - total_count + - branch_policies + examples: + default: + $ref: '#/components/examples/deployment-branch-policies-list' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + post: + summary: Create a deployment branch policy + description: >- + Creates a deployment branch or tag policy for an environment. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment-branch-policy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/deployment-branch-policy-name-pattern-with-type + examples: + example-wildcard: + summary: Example of a wildcard name pattern + value: + name: release/* + example-single-branch: + summary: Example of a single branch name pattern + value: + name: main + type: branch + example-single-tag: + summary: Example of a single tag name pattern + value: + name: v1 + type: tag + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy' + examples: + example-wildcard: + $ref: '#/components/examples/deployment-branch-policy-wildcard' + example-single-branch: + $ref: '#/components/examples/deployment-branch-policy-single-branch' + example-single-tag: + $ref: '#/components/examples/deployment-branch-policy-single-tag' + '303': + description: Response if the same branch name pattern already exists + '404': + description: >- + Not Found or `deployment_branch_policy.custom_branch_policies` + property for the environment is set to false + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}: + get: + summary: Get a deployment branch policy + description: >- + Gets a deployment branch or tag policy for an environment. + + + Anyone with read access to the repository can use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-deployment-branch-policy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/branch-policy-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy' + examples: + default: + $ref: '#/components/examples/deployment-branch-policy-wildcard' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + put: + summary: Update a deployment branch policy + description: >- + Updates a deployment branch or tag policy for an environment. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/update-deployment-branch-policy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/branch-policy-id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy-name-pattern' + examples: + default: + value: + name: release/* + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy' + examples: + default: + $ref: '#/components/examples/deployment-branch-policy-wildcard' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + delete: + summary: Delete a deployment branch policy + description: >- + Deletes a deployment branch or tag policy for an environment. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/delete-deployment-branch-policy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/branch-policy-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules: + get: + summary: Get all deployment protection rules for an environment + description: >- + Gets all custom deployment protection rules that are enabled for an + environment. Anyone with read access to the repository can use this + endpoint. For more information about environments, see "[Using + environments for + deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + + For more information about the app that is providing this custom + deployment rule, see the [documentation for the `GET /apps/{app_slug}` + endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-all-deployment-protection-rules + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + responses: + '200': + description: List of deployment protection rules + content: + application/json: + schema: + type: object + properties: + total_count: + description: >- + The number of enabled custom deployment protection rules + for this environment + type: integer + example: 10 + custom_deployment_protection_rules: + type: array + items: + $ref: '#/components/schemas/deployment-protection-rule' + example: + $ref: '#/components/examples/deployment-protection-rules' + examples: + default: + value: + total_count: 2 + custom_deployment_protection_rules: + - id: 3 + node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv + enabled: true + app: + id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + - id: 4 + node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 + enabled: true + app: + id: 1 + node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy + slug: another-custom-app + integration_url: https://api.github.com/apps/another-custom-app + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + post: + summary: Create a custom deployment protection rule on an environment + description: >- + Enable a custom deployment protection rule for an environment. + + + The authenticated user must have admin or owner permissions to the + repository to use this endpoint. + + + For more information about the app that is providing this custom + deployment rule, see the [documentation for the `GET /apps/{app_slug}` + endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as + the [guide to creating custom deployment protection + rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment-protection-rule + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + requestBody: + content: + application/json: + schema: + type: object + properties: + integration_id: + type: integer + description: >- + The ID of the custom app that will be enabled on the + environment. + examples: + default: + value: + integration_id: 5 + required: true + responses: + '201': + description: The enabled custom deployment protection rule + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-protection-rule' + examples: + default: + $ref: '#/components/examples/deployment-protection-rule' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps: + get: + summary: List custom deployment rule integrations available for an environment + description: >- + Gets all custom deployment protection rule integrations that are + available for an environment. + + + The authenticated user must have admin or owner permissions to the + repository to use this endpoint. + + + For more information about environments, see "[Using environments for + deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + + For more information about the app that is providing this custom + deployment rule, see "[GET an + app](https://docs.github.com/rest/apps/apps#get-an-app)". + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/list-custom-deployment-rule-integrations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: >- + A list of custom deployment rule integrations available for this + environment. + content: + application/json: + schema: + type: object + properties: + total_count: + description: >- + The total number of custom deployment protection rule + integrations available for this environment. + type: integer + example: 35 + available_custom_deployment_protection_rule_integrations: + type: array + items: + $ref: '#/components/schemas/custom-deployment-rule-app' + examples: + default: + $ref: '#/components/examples/custom-deployment-protection-rule-apps' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}: + get: + summary: Get a custom deployment protection rule + description: >- + Gets an enabled custom deployment protection rule for an environment. + Anyone with read access to the repository can use this endpoint. For + more information about environments, see "[Using environments for + deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + + For more information about the app that is providing this custom + deployment rule, see [`GET + /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-custom-deployment-protection-rule + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/protection-rule-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-protection-rule' + examples: + default: + $ref: '#/components/examples/deployment-protection-rule' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + delete: + summary: Disable a custom protection rule for an environment + description: >- + Disables a custom deployment protection rule for an environment. + + + The authenticated user must have admin or owner permissions to the + repository to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/disable-deployment-protection-rule + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/protection-rule-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + /repos/{owner}/{repo}/forks: + get: + summary: List forks + description: '' + tags: + - repos + operationId: repos/list-forks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/forks#list-forks + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sort + description: The sort order. `stargazers` will sort by star count. + in: query + required: false + schema: + type: string + enum: + - newest + - oldest + - stargazers + - watchers + default: newest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items-2' + headers: + Link: + $ref: '#/components/headers/link' + '400': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: forks + x-stackQL-resource: forks + post: + summary: Create a fork + description: >- + Create a fork for the authenticated user. + + + > [!NOTE] + + > Forking a Repository happens asynchronously. You may have to wait a + short period of time before you can access the git objects. If this + takes longer than 5 minutes, be sure to contact [GitHub + Support](https://support.github.com/contact?tags=dotcom-rest-api). + + + > [!NOTE] + + > Although this endpoint works with GitHub Apps, the GitHub App must be + installed on the destination account with access to all repositories and + on the source account with access to the source repository. + tags: + - repos + operationId: repos/create-fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/forks#create-a-fork + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + organization: + type: string + description: >- + Optional parameter to specify the organization name if + forking into an organization. + name: + type: string + description: >- + When forking from an existing repository, a new name for the + fork. + default_branch_only: + type: boolean + description: >- + When forking from an existing repository, fork with only the + default branch. + examples: + default: + value: + organization: octocat + name: Hello-World + default_branch_only: true + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: forks + x-stackQL-resource: forks + /repos/{owner}/{repo}/hooks: + get: + summary: List repository webhooks + description: >- + Lists webhooks for a repository. `last response` may return null if + there have not been any deliveries within 30 days. + tags: + - repos + operationId: repos/list-webhooks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + post: + summary: Create a repository webhook + description: >- + Repositories can have multiple webhooks installed. Each webhook should + have a unique `config`. Multiple webhooks can + + share the same `config` as long as those webhooks do not have any + `events` that overlap. + tags: + - repos + operationId: repos/create-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + name: + type: string + description: >- + Use `web` to create a webhook. Default: `web`. This + parameter only accepts the value `web`. + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + events: + type: array + description: >- + Determines what + [events](https://docs.github.com/webhooks/event-payloads) + the hook is triggered for. + default: + - push + items: + type: string + active: + type: boolean + description: >- + Determines if notifications are sent when the webhook is + triggered. Set to `true` to send notifications. + default: true + additionalProperties: false + examples: + default: + value: + name: web + active: true + events: + - push + - pull_request + config: + url: https://example.com/webhook + content_type: json + insecure_ssl: '0' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}: + get: + summary: Get a repository webhook + description: >- + Returns a webhook configured in a repository. To get only the webhook + `config` properties, see "[Get a webhook configuration for a + repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." + tags: + - repos + operationId: repos/get-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a repository webhook + description: >- + Updates a webhook configured in a repository. If you previously had a + `secret` set, you must provide the same `secret` or set a new `secret` + or the secret will be removed. If you are only updating individual + webhook `config` properties, use "[Update a webhook configuration for a + repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." + tags: + - repos + operationId: repos/update-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + config: + $ref: '#/components/schemas/webhook-config' + events: + type: array + description: >- + Determines what + [events](https://docs.github.com/webhooks/event-payloads) + the hook is triggered for. This replaces the entire array of + events. + default: + - push + items: + type: string + add_events: + type: array + description: >- + Determines a list of events to be added to the list of + events that the Hook triggers for. + items: + type: string + remove_events: + type: array + description: >- + Determines a list of events to be removed from the list of + events that the Hook triggers for. + items: + type: string + active: + type: boolean + description: >- + Determines if notifications are sent when the webhook is + triggered. Set to `true` to send notifications. + default: true + examples: + default: + value: + active: true + add_events: + - pull_request + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + delete: + summary: Delete a repository webhook + description: >- + Delete a webhook for an organization. + + + The authenticated user must be a repository owner, or have admin access + in the repository, to delete the webhook. + tags: + - repos + operationId: repos/delete-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/config: + get: + summary: Get a webhook configuration for a repository + description: >- + Returns the webhook configuration for a repository. To get more + information about the webhook, including the `active` state and + `events`, use "[Get a repository + webhook](/rest/webhooks/repos#get-a-repository-webhook)." + + + OAuth app tokens and personal access tokens (classic) need the + `read:repo_hook` or `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/get-webhook-config-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a webhook configuration for a repository + description: >- + Updates the webhook configuration for a repository. To update more + information about the webhook, including the `active` state and + `events`, use "[Update a repository + webhook](/rest/webhooks/repos#update-a-repository-webhook)." + + + OAuth app tokens and personal access tokens (classic) need the + `write:repo_hook` or `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/update-webhook-config-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + examples: + default: + summary: Example of updating content type and URL + value: + content_type: json + url: https://example.com/webhook + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/deliveries: + get: + summary: List deliveries for a repository webhook + description: >- + Returns a list of webhook deliveries for a webhook configured in a + repository. + tags: + - repos + operationId: repos/list-webhook-deliveries + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/cursor' + - $ref: '#/components/parameters/webhook-delivery-status' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook-delivery-item' + examples: + default: + $ref: '#/components/examples/hook-delivery-items' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}: + get: + summary: Get a delivery for a repository webhook + description: Returns a delivery for a webhook configured in a repository. + tags: + - repos + operationId: repos/get-webhook-delivery + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook-delivery' + examples: + default: + $ref: '#/components/examples/hook-delivery' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts: + post: + summary: Redeliver a delivery for a repository webhook + description: Redeliver a webhook delivery for a webhook configured in a repository. + tags: + - repos + operationId: repos/redeliver-webhook-delivery + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/pings: + post: + summary: Ping a repository webhook + description: >- + This will trigger a [ping + event](https://docs.github.com/webhooks/#ping-event) to be sent to the + hook. + tags: + - repos + operationId: repos/ping-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/tests: + post: + summary: Test the push repository webhook + description: >- + This will trigger the hook with the latest push to the current + repository if the hook is subscribed to `push` events. If the hook is + not subscribed to `push` events, the server will respond with 204 but no + test POST will be generated. + + + > [!NOTE] + + > Previously `/repos/:owner/:repo/hooks/:hook_id/test` + tags: + - repos + operationId: repos/test-push-webhook + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/immutable-releases: + get: + summary: Check if immutable releases are enabled for a repository + description: >- + Shows whether immutable releases are enabled or disabled. Also + identifies whether immutability is being + + enforced by the repository owner. The authenticated user must have + admin read access to the repository. + tags: + - repos + operationId: repos/check-immutable-releases + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response if immutable releases are enabled + content: + application/json: + schema: + $ref: '#/components/schemas/check-immutable-releases' + examples: + default: + value: + enabled: true + enforced_by_owner: false + '404': + description: Not Found if immutable releases are not enabled for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable immutable releases + description: >- + Enables immutable releases for a repository. The authenticated user must + have admin access to the repository. + tags: + - repos + operationId: repos/enable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-immutable-releases + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable immutable releases + description: >- + Disables immutable releases for a repository. The authenticated user + must have admin access to the repository. + tags: + - repos + operationId: repos/disable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-immutable-releases + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/invitations: + get: + summary: List repository invitations + description: >- + When authenticating as a user with admin rights to a repository, this + endpoint will list all currently open repository invitations. + tags: + - repos + operationId: repos/list-invitations + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/invitations#list-repository-invitations + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-invitation' + examples: + default: + $ref: '#/components/examples/repository-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /repos/{owner}/{repo}/invitations/{invitation_id}: + patch: + summary: Update a repository invitation + description: '' + tags: + - repos + operationId: repos/update-invitation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/invitation-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permissions: + type: string + description: >- + The permissions that the associated user will have on the + repository. Valid values are `read`, `write`, `maintain`, + `triage`, and `admin`. + enum: + - read + - write + - maintain + - triage + - admin + examples: + default: + summary: Example request body + value: + permissions: write + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-invitation' + examples: + default: + $ref: '#/components/examples/repository-invitation' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + delete: + summary: Delete a repository invitation + description: '' + tags: + - repos + operationId: repos/delete-invitation + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /repos/{owner}/{repo}/keys: + get: + summary: List deploy keys + description: '' + tags: + - repos + operationId: repos/list-deploy-keys + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deploy-key' + examples: + default: + $ref: '#/components/examples/deploy-key-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + post: + summary: Create a deploy key + description: You can create a read-only deploy key. + tags: + - repos + operationId: repos/create-deploy-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: A name for the key. + key: + type: string + description: The contents of the key. + read_only: + type: boolean + description: >- + If `true`, the key will only be able to read repository + contents. Otherwise, the key will be able to read and + write. + + Deploy keys with write access can perform the same actions + as an organization member with admin access, or a + collaborator on a personal repository. For more information, + see "[Repository permission levels for an + organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" + and "[Permission levels for a user account + repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." + required: + - key + examples: + default: + value: + title: octocat@octomac + key: ssh-rsa AAA... + read_only: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deploy-key' + examples: + default: + $ref: '#/components/examples/deploy-key' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/keys/1 + schema: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + /repos/{owner}/{repo}/keys/{key_id}: + get: + summary: Get a deploy key + description: '' + tags: + - repos + operationId: repos/get-deploy-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deploy-key' + examples: + default: + $ref: '#/components/examples/deploy-key' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + delete: + summary: Delete a deploy key + description: >- + Deploy keys are immutable. If you need to update a key, remove the key + and create a new one instead. + tags: + - repos + operationId: repos/delete-deploy-key + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/key-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + /repos/{owner}/{repo}/languages: + get: + summary: List repository languages + description: >- + Lists languages for the specified repository. The value shown for each + language is the number of bytes of code written in that language. + tags: + - repos + operationId: repos/list-languages + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-languages + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/language' + examples: + default: + $ref: '#/components/examples/language' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/merge-upstream: + post: + summary: Sync a fork branch with the upstream repository + description: >- + Sync a branch of a forked repository to keep it up-to-date with the + upstream repository. + tags: + - repos + operationId: repos/merge-upstream + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + branch: + type: string + description: >- + The name of the branch which should be updated to match + upstream. + required: + - branch + examples: + default: + value: + branch: main + responses: + '200': + description: The branch has been successfully synced with the upstream repository + content: + application/json: + schema: + $ref: '#/components/schemas/merged-upstream' + examples: + default: + $ref: '#/components/examples/merged-upstream' + '409': + description: The branch could not be synced because of a merge conflict + '422': + description: The branch could not be synced for some other reason + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/merges: + post: + summary: Merge a branch + description: '' + tags: + - repos + operationId: repos/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#merge-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + base: + type: string + description: >- + The name of the base branch that the head will be merged + into. + head: + type: string + description: >- + The head to merge. This can be a branch name or a commit + SHA1. + commit_message: + type: string + description: >- + Commit message to use for the merge commit. If omitted, a + default message will be used. + required: + - base + - head + examples: + default: + value: + base: master + head: cool_feature + commit_message: Shipped cool_feature! + responses: + '201': + description: Successful Response (The resulting merge commit) + content: + application/json: + schema: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit' + '204': + description: Response when already merged + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found when the base or head does not exist + '409': + description: Conflict when there is a merge conflict + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/pages: + get: + summary: Get a GitHub Pages site + description: >- + Gets information about a GitHub Pages site. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/get-pages + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page' + examples: + default: + $ref: '#/components/examples/page' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + post: + summary: Create a GitHub Pages site + description: >- + Configures a GitHub Pages site. For more information, see "[About GitHub + Pages](/github/working-with-github-pages/about-github-pages)." + + + The authenticated user must be a repository administrator, maintainer, + or have the 'manage GitHub Pages settings' permission. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/create-pages-site + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The source branch and directory used to publish your Pages site. + nullable: true + properties: + build_type: + type: string + description: >- + The process in which the Page will be built. Possible values + are `"legacy"` and `"workflow"`. + enum: + - legacy + - workflow + source: + type: object + description: >- + The source branch and directory used to publish your Pages + site. + properties: + branch: + type: string + description: >- + The repository branch used to publish your site's source + files. + path: + type: string + description: >- + The repository directory that includes the source files + for the Pages site. Allowed paths are `/` or `/docs`. + Default: `/` + enum: + - / + - /docs + default: / + required: + - branch + required: + - source + - build_type + examples: + default: + value: + source: + branch: main + path: /docs + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page' + examples: + default: + $ref: '#/components/examples/page' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + put: + summary: Update information about a GitHub Pages site + description: >- + Updates information for a GitHub Pages site. For more information, see + "[About GitHub + Pages](/github/working-with-github-pages/about-github-pages). + + + The authenticated user must be a repository administrator, maintainer, + or have the 'manage GitHub Pages settings' permission. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/update-information-about-pages-site + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cname: + type: string + description: >- + Specify a custom domain for the repository. Sending a `null` + value will remove the custom domain. For more about custom + domains, see "[Using a custom domain with GitHub + Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + nullable: true + https_enforced: + type: boolean + description: Specify whether HTTPS should be enforced for the repository. + build_type: + type: string + description: >- + The process by which the GitHub Pages site will be built. + `workflow` means that the site is built by a custom GitHub + Actions workflow. `legacy` means that the site is built by + GitHub when changes are pushed to a specific branch. + enum: + - legacy + - workflow + source: + type: string + description: >- + Update the source for the repository. Must include the + branch name, and may optionally specify the subdirectory + `/docs`. Possible values are `"gh-pages"`, `"master"`, and + `"master /docs"`. + enum: + - gh-pages + - master + - master /docs + properties: + branch: + type: string + description: >- + The repository branch used to publish your site's source + files. + path: + type: string + description: >- + The repository directory that includes the source files + for the Pages site. Allowed paths are `/` or `/docs`. + enum: + - / + - /docs + required: + - branch + - path + required: + - build_type + - source + - cname + - public + - https_enforced + examples: + default: + value: + cname: octocatblog.com + source: + branch: main + path: / + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + delete: + summary: Delete a GitHub Pages site + description: >- + Deletes a GitHub Pages site. For more information, see "[About GitHub + Pages](/github/working-with-github-pages/about-github-pages). + + + The authenticated user must be a repository administrator, maintainer, + or have the 'manage GitHub Pages settings' permission. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/delete-pages-site + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/builds: + get: + summary: List GitHub Pages builds + description: >- + Lists builts of a GitHub Pages site. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/list-pages-builds + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/page-build' + examples: + default: + $ref: '#/components/examples/page-build-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + post: + summary: Request a GitHub Pages build + description: >- + You can request that your site be built from the latest revision on the + default branch. This has the same effect as pushing a commit to your + default branch, but does not require an additional commit. Manually + triggering page builds can be helpful when diagnosing build warnings and + failures. + + + Build requests are limited to one concurrent build per repository and + one concurrent build per requester. If you request a build while another + is still in progress, the second request will be queued until the first + completes. + tags: + - repos + operationId: repos/request-pages-build + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-build-status' + examples: + default: + $ref: '#/components/examples/page-build-status' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/builds/latest: + get: + summary: Get latest Pages build + description: >- + Gets information about the single most recent build of a GitHub Pages + site. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/get-latest-pages-build + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-latest-pages-build + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-build' + examples: + default: + $ref: '#/components/examples/page-build' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/builds/{build_id}: + get: + summary: Get GitHub Pages build + description: >- + Gets information about a GitHub Pages build. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/get-pages-build + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: build_id + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-build' + examples: + default: + $ref: '#/components/examples/page-build' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/deployments: + post: + summary: Create a GitHub Pages deployment + description: |- + Create a GitHub Pages deployment for a repository. + + The authenticated user must have write permission to the repository. + tags: + - repos + operationId: repos/create-pages-deployment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The object used to create GitHub Pages deployment + properties: + artifact_id: + type: number + description: >- + The ID of an artifact that contains the .zip or .tar of + static assets to deploy. The artifact belongs to the + repository. Either `artifact_id` or `artifact_url` are + required. + artifact_url: + type: string + description: >- + The URL of an artifact that contains the .zip or .tar of + static assets to deploy. The artifact belongs to the + repository. Either `artifact_id` or `artifact_url` are + required. + environment: + type: string + description: The target environment for this GitHub Pages deployment. + default: github-pages + pages_build_version: + type: string + description: >- + A unique string that represents the version of the build for + this deployment. + default: GITHUB_SHA + oidc_token: + type: string + description: >- + The OIDC token issued by GitHub Actions certifying the + origin of the deployment. + required: + - pages_build_version + - oidc_token + examples: + default: + value: + artifact_url: https://downloadcontent/ + environment: github-pages + pages_build_version: 4fd754f7e594640989b406850d0bc8f06a121251 + oidc_token: >- + eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-deployment' + examples: + default: + $ref: '#/components/examples/page-deployment' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}: + get: + summary: Get the status of a GitHub Pages deployment + description: >- + Gets the current status of a GitHub Pages deployment. + + + The authenticated user must have read permission for the GitHub Pages + site. + tags: + - repos + operationId: repos/get-pages-deployment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pages-deployment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pages-deployment-status' + examples: + default: + $ref: '#/components/examples/pages-deployment-status' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel: + post: + summary: Cancel a GitHub Pages deployment + description: >- + Cancels a GitHub Pages deployment. + + + The authenticated user must have write permissions for the GitHub Pages + site. + tags: + - repos + operationId: repos/cancel-pages-deployment + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pages-deployment-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/health: + get: + summary: Get a DNS health check for GitHub Pages + description: >- + Gets a health check of the DNS settings for the `CNAME` record + configured for a repository's GitHub Pages. + + + The first request to this endpoint returns a `202 Accepted` status and + starts an asynchronous background task to get the results for the + domain. After the background task completes, subsequent requests to this + endpoint return a `200 OK` status with the health check results in the + response. + + + The authenticated user must be a repository administrator, maintainer, + or have the 'manage GitHub Pages settings' permission to use this + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - repos + operationId: repos/get-pages-health-check + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pages-health-check' + examples: + default: + $ref: '#/components/examples/pages-health-check' + '202': + description: Empty response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '400': + description: Custom domains are not available for GitHub Pages + '404': + $ref: '#/components/responses/not_found' + '422': + description: There isn't a CNAME for this page + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/private-vulnerability-reporting: + get: + summary: Check if private vulnerability reporting is enabled for a repository + description: >- + Returns a boolean indicating whether or not private vulnerability + reporting is enabled for the repository. For more information, see + "[Evaluating the security settings of a + repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + tags: + - repos + operationId: repos/check-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Private vulnerability reporting status + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: >- + Whether or not private vulnerability reporting is enabled + for the repository. + required: + - enabled + examples: + default: + value: + enabled: true + '422': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable private vulnerability reporting for a repository + description: >- + Enables private vulnerability reporting for a repository. The + authenticated user must have admin access to the repository. For more + information, see "[Privately reporting a security + vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + tags: + - repos + operationId: repos/enable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '422': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable private vulnerability reporting for a repository + description: >- + Disables private vulnerability reporting for a repository. The + authenticated user must have admin access to the repository. For more + information, see "[Privately reporting a security + vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + tags: + - repos + operationId: repos/disable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '422': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/properties/values: + get: + summary: Get all custom property values for a repository + description: |- + Gets all custom property values that are set for a repository. + Users with read access to the repository can use this endpoint. + tags: + - repos + operationId: repos/custom-properties-for-repos-get-repository-values + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom-property-value' + examples: + default: + $ref: '#/components/examples/custom-property-values' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties + x-stackQL-resource: custom_properties + patch: + summary: Create or update custom property values for a repository + description: >- + Create new or update existing custom property values for a repository. + + Using a value of `null` for a custom property will remove or 'unset' the + property value from the repository. + + + Repository admins and other users with the repository-level "edit custom + property values" fine-grained permission can use this endpoint. + tags: + - repos + operationId: repos/custom-properties-for-repos-create-or-update-repository-values + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: >- + A list of custom property names and associated values to + apply to the repositories. + items: + $ref: '#/components/schemas/custom-property-value' + required: + - properties + examples: + default: + $ref: >- + #/components/examples/create-or-update-custom-properties-values + responses: + '204': + description: >- + No Content when custom property values are successfully created or + updated + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties + x-stackQL-resource: custom_properties + /repos/{owner}/{repo}/readme: + get: + summary: Get a repository README + description: >- + Gets the preferred README for a repository. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw file contents. + This is the default if you do not specify a media type. + + - **`application/vnd.github.html+json`**: Returns the README in HTML. + Markup languages are rendered to HTML using GitHub's open-source [Markup + library](https://github.com/github/markup). + tags: + - repos + operationId: repos/get-readme + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#get-a-repository-readme + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: >- + The name of the commit/branch/tag. Default: the repository’s default + branch. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/content-file' + examples: + default: + $ref: '#/components/examples/content-file' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/readme/{dir}: + get: + summary: Get a repository README for a directory + description: >- + Gets the README from a repository directory. + + + This endpoint supports the following custom media types. For more + information, see "[Media + types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + + - **`application/vnd.github.raw+json`**: Returns the raw file contents. + This is the default if you do not specify a media type. + + - **`application/vnd.github.html+json`**: Returns the README in HTML. + Markup languages are rendered to HTML using GitHub's open-source [Markup + library](https://github.com/github/markup). + tags: + - repos + operationId: repos/get-readme-in-directory + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: >- + The name of the commit/branch/tag. Default: the repository’s default + branch. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/content-file' + examples: + default: + $ref: '#/components/examples/content-file' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/releases: + get: + summary: List releases + description: >- + This returns a list of releases, which does not include regular Git tags + that have not been associated with a release. To get a list of Git tags, + use the [Repository Tags + API](https://docs.github.com/rest/repos/repos#list-repository-tags). + + + Information about published releases are available to everyone. Only + users with push access will receive listings for draft releases. + tags: + - repos + operationId: repos/list-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#list-releases + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + post: + summary: Create a release + description: >- + Users with push access to the repository can create a release. + + + This endpoint triggers + [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary + rate limiting. For more information, see "[Rate limits for the + API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST + API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - repos + operationId: repos/create-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#create-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tag_name: + type: string + description: The name of the tag. + target_commitish: + type: string + description: >- + Specifies the commitish value that determines where the Git + tag is created from. Can be any branch or commit SHA. Unused + if the Git tag already exists. Default: the repository's + default branch. + name: + type: string + description: The name of the release. + body: + type: string + description: Text describing the contents of the tag. + draft: + type: boolean + description: >- + `true` to create a draft (unpublished) release, `false` to + create a published one. + default: false + prerelease: + type: boolean + description: >- + `true` to identify the release as a prerelease. `false` to + identify the release as a full release. + default: false + discussion_category_name: + type: string + description: >- + If specified, a discussion of the specified category is + created and linked to the release. The value must be a + category that already exists in the repository. For more + information, see "[Managing categories for discussions in + your + repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + generate_release_notes: + type: boolean + description: >- + Whether to automatically generate the name and body for this + release. If `name` is specified, the specified name will be + used; otherwise, a name will be automatically generated. If + `body` is specified, the body will be pre-pended to the + automatically generated notes. + default: false + make_latest: + type: string + description: >- + Specifies whether this release should be set as the latest + release for the repository. Drafts and prereleases cannot be + set as latest. Defaults to `true` for newly published + releases. `legacy` specifies that the latest release should + be determined based on the release creation date and higher + semantic version. + enum: + - 'true' + - 'false' + - legacy + default: 'true' + required: + - tag_name + examples: + default: + value: + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + generate_release_notes: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/releases/1 + schema: + type: string + '404': + description: Not Found if the discussion category name is invalid + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/assets/{asset_id}: + get: + summary: Get a release asset + description: >- + To download the asset's binary content: + + + - If within a browser, fetch the location specified in the + `browser_download_url` key provided in the response. + + - Alternatively, set the `Accept` header of the request to + [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + The API will either redirect the client to the location, or stream it directly if possible. + API clients should handle both a `200` or `302` response. + tags: + - repos + operationId: repos/get-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#get-a-release-asset + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/asset-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release-asset' + examples: + default: + $ref: '#/components/examples/release-asset' + '302': + $ref: '#/components/responses/found' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + patch: + summary: Update a release asset + description: Users with push access to the repository can edit a release asset. + tags: + - repos + operationId: repos/update-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#update-a-release-asset + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/asset-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The file name of the asset. + label: + type: string + description: >- + An alternate short description of the asset. Used in place + of the filename. + state: + type: string + example: '"uploaded"' + examples: + default: + value: + name: foo-1.0.0-osx.zip + label: Mac binary + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release-asset' + examples: + default: + $ref: '#/components/examples/release-asset' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + delete: + summary: Delete a release asset + description: '' + tags: + - repos + operationId: repos/delete-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#delete-a-release-asset + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/asset-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + /repos/{owner}/{repo}/releases/generate-notes: + post: + summary: Generate release notes content for a release + description: >- + Generate a name and body describing a + [release](https://docs.github.com/rest/releases/releases#get-a-release). + The body content will be markdown formatted and contain information like + the changes since last release and users who contributed. The generated + release notes are not saved anywhere. They are intended to be generated + and used when creating a new release. + tags: + - repos + operationId: repos/generate-release-notes + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tag_name: + type: string + description: >- + The tag name for the release. This can be an existing tag or + a new one. + target_commitish: + type: string + description: >- + Specifies the commitish value that will be the target for + the release's tag. Required if the supplied tag_name does + not reference an existing tag. Ignored if the tag_name + already exists. + previous_tag_name: + type: string + description: >- + The name of the previous tag to use as the starting point + for the release notes. Use to manually specify the range for + the set of changes considered as part this release. + configuration_file_path: + type: string + description: >- + Specifies a path to a file in the repository containing + configuration settings used for generating the release + notes. If unspecified, the configuration file located in the + repository at '.github/release.yml' or + '.github/release.yaml' will be used. If that is not present, + the default configuration will be used. + required: + - tag_name + examples: + default: + value: + tag_name: v1.0.0 + target_commitish: main + previous_tag_name: v0.9.2 + configuration_file_path: .github/custom_release_config.yml + responses: + '200': + description: Name and body of generated release notes + content: + application/json: + schema: + $ref: '#/components/schemas/release-notes-content' + examples: + default: + $ref: '#/components/examples/release-notes-content' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/latest: + get: + summary: Get the latest release + description: >- + View the latest published full release for the repository. + + + The latest release is the most recent non-prerelease, non-draft release, + sorted by the `created_at` attribute. The `created_at` attribute is the + date of the commit used for the release, and not the date when the + release was drafted or published. + tags: + - repos + operationId: repos/get-latest-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#get-the-latest-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/tags/{tag}: + get: + summary: Get a release by tag name + description: Get a published release with the specified tag. + tags: + - repos + operationId: repos/get-release-by-tag + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: tag + description: tag parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/{release_id}: + get: + summary: Get a release + description: >- + Gets a public release with the specified release ID. + + + > [!NOTE] + + > This returns an `upload_url` key corresponding to the endpoint for + uploading release assets. This key is a hypermedia resource. For more + information, see "[Getting started with the REST + API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + tags: + - repos + operationId: repos/get-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#get-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + responses: + '200': + description: >- + **Note:** This returns an `upload_url` key corresponding to the + endpoint for uploading release assets. This key is a hypermedia + resource. For more information, see "[Getting started with the REST + API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + patch: + summary: Update a release + description: Users with push access to the repository can edit a release. + tags: + - repos + operationId: repos/update-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#update-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + tag_name: + type: string + description: The name of the tag. + target_commitish: + type: string + description: >- + Specifies the commitish value that determines where the Git + tag is created from. Can be any branch or commit SHA. Unused + if the Git tag already exists. Default: the repository's + default branch. + name: + type: string + description: The name of the release. + body: + type: string + description: Text describing the contents of the tag. + draft: + type: boolean + description: >- + `true` makes the release a draft, and `false` publishes the + release. + prerelease: + type: boolean + description: >- + `true` to identify the release as a prerelease, `false` to + identify the release as a full release. + make_latest: + type: string + description: >- + Specifies whether this release should be set as the latest + release for the repository. Drafts and prereleases cannot be + set as latest. Defaults to `true` for newly published + releases. `legacy` specifies that the latest release should + be determined based on the release creation date and higher + semantic version. + enum: + - 'true' + - 'false' + - legacy + default: 'true' + discussion_category_name: + type: string + description: >- + If specified, a discussion of the specified category is + created and linked to the release. The value must be a + category that already exists in the repository. If there is + already a discussion linked to the release, this parameter + is ignored. For more information, see "[Managing categories + for discussions in your + repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + examples: + default: + value: + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '404': + description: Not Found if the discussion category name is invalid + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + delete: + summary: Delete a release + description: Users with push access to the repository can delete a release. + tags: + - repos + operationId: repos/delete-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#delete-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/{release_id}/assets: + get: + summary: List release assets + description: '' + tags: + - repos + operationId: repos/list-release-assets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#list-release-assets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/release-asset' + examples: + default: + $ref: '#/components/examples/release-asset-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + post: + summary: Upload a release asset + description: >- + This endpoint makes use of a [Hypermedia + relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) + to determine which URL to access. The endpoint you call to upload + release assets is specific to your release. Use the `upload_url` + returned in + + the response of the [Create a release + endpoint](https://docs.github.com/rest/releases/releases#create-a-release) + to upload a release asset. + + + You need to use an HTTP client which supports + [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls + to this endpoint. + + + Most libraries will set the required `Content-Length` header + automatically. Use the required `Content-Type` header to provide the + media type of the asset. For a list of media types, see [Media + Types](https://www.iana.org/assignments/media-types/media-types.xhtml). + For example: + + + `application/zip` + + + GitHub expects the asset data in its raw binary form, rather than JSON. + You will send the raw binary content of the asset as the request body. + Everything else about the endpoint is the same as the rest of the API. + For example, + + you'll still need to pass your authentication to be able to upload an + asset. + + + When an upstream failure occurs, you will receive a `502 Bad Gateway` + status. This may leave an empty asset with a state of `starter`. It can + be safely deleted. + + + **Notes:** + + * GitHub renames asset filenames that have special characters, + non-alphanumeric characters, and leading or trailing periods. The "[List + release + assets](https://docs.github.com/rest/releases/assets#list-release-assets)" + + endpoint lists the renamed filenames. For more information and help, + contact [GitHub + Support](https://support.github.com/contact?tags=dotcom-rest-api). + + * To find the `release_id` query the [`GET + /repos/{owner}/{repo}/releases/latest` + endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). + + * If you upload an asset with the same filename as another uploaded + asset, you'll receive an error and must delete the old file before you + can re-upload the new asset. + tags: + - repos + operationId: repos/upload-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#upload-a-release-asset + servers: + - url: https://uploads.github.com + description: >- + The URL origin (protocol + host name + port) is included in + `upload_url` returned in the response of the "Create a release" + endpoint + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - name: name + in: query + required: true + schema: + type: string + - name: label + in: query + schema: + type: string + requestBody: + required: false + content: + application/octet-stream: + schema: + type: string + format: binary + description: The raw file data + examples: + default: + value: '@example.zip' + responses: + '201': + description: Response for successful upload + content: + application/json: + schema: + $ref: '#/components/schemas/release-asset' + examples: + response-for-successful-upload: + $ref: >- + #/components/examples/release-asset-response-for-successful-upload + '422': + description: >- + Response if you upload an asset with the same filename as another + uploaded asset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + /repos/{owner}/{repo}/rules/branches/{branch}: + get: + summary: Get rules for a branch + description: >- + Returns all active rules that apply to the specified branch. The branch + does not need to exist; rules that would apply + + to a branch with that name will be returned. All active rules that apply + will be returned, regardless of the level + + at which they are configured (e.g. repository or organization). Rules in + rulesets with "evaluate" or "disabled" + + enforcement statuses are not returned. + tags: + - repos + operationId: repos/get-branch-rules + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-rule-detailed' + examples: + default: + $ref: '#/components/examples/repository-rule-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets: + get: + summary: Get all repository rulesets + description: Get all the rulesets for a repository. + tags: + - repos + operationId: repos/get-repo-rulesets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-all-repository-rulesets + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: includes_parents + description: >- + Include rulesets configured at higher levels that apply to this + repository + in: query + required: false + schema: + type: boolean + default: true + - $ref: '#/components/parameters/ruleset-targets' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + post: + summary: Create a repository ruleset + description: Create a ruleset for a repository. + tags: + - repos + operationId: repos/create-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#create-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + default: branch + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/repository-ruleset-conditions' + rules: + type: array + description: An array of rules within the ruleset. + items: + $ref: '#/components/schemas/repository-rule' + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets/rule-suites: + get: + summary: List repository rule suites + description: >- + Lists suites of rule evaluations at the repository level. + + For more information, see "[Managing rulesets for a + repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-repo-rule-suites + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ref-in-query' + - $ref: '#/components/parameters/time-period' + - $ref: '#/components/parameters/actor-name-in-query' + - $ref: '#/components/parameters/rule-suite-result' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suites' + examples: + default: + $ref: '#/components/examples/rule-suite-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rule-suites + x-stackQL-resource: rule_suites + /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}: + get: + summary: Get a repository rule suite + description: >- + Gets information about a suite of rule evaluations from within a + repository. + + For more information, see "[Managing rulesets for a + repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-repo-rule-suite + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/rule-suite-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suite' + examples: + default: + $ref: '#/components/examples/rule-suite' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rule-suites + x-stackQL-resource: rule_suites + /repos/{owner}/{repo}/rulesets/{ruleset_id}: + get: + summary: Get a repository ruleset + description: >- + Get a ruleset for a repository. + + + **Note:** To prevent leaking sensitive information, the `bypass_actors` + property is only returned if the user + + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: includes_parents + description: >- + Include rulesets configured at higher levels that apply to this + repository + in: query + required: false + schema: + type: boolean + default: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + put: + summary: Update a repository ruleset + description: Update a ruleset for a repository. + tags: + - repos + operationId: repos/update-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#update-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/repository-ruleset-conditions' + rules: + description: An array of rules within the ruleset. + type: array + items: + $ref: '#/components/schemas/repository-rule' + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + delete: + summary: Delete a repository ruleset + description: Delete a ruleset for a repository. + tags: + - repos + operationId: repos/delete-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets/{ruleset_id}/history: + get: + summary: Get repository ruleset history + description: Get the history of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-history + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/rules#get-repository-ruleset-history + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ruleset-version' + examples: + default: + $ref: '#/components/examples/ruleset-history' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}: + get: + summary: Get repository ruleset version + description: Get a version of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-version + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/rules#get-repository-ruleset-version + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ruleset-version-with-state' + examples: + default: + $ref: '#/components/examples/repository-ruleset-version-with-state' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + x-stackQL-resource: rules + /repos/{owner}/{repo}/stats/code_frequency: + get: + summary: Get the weekly commit activity + description: >- + Returns a weekly aggregate of the number of additions and deletions + pushed to a repository. + + + > [!NOTE] + + > This endpoint can only be used for repositories with fewer than 10,000 + commits. If the repository contains 10,000 or more commits, a 422 status + code will be returned. + tags: + - repos + operationId: repos/get-code-frequency-stats + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: >- + Returns a weekly aggregate of the number of additions and deletions + pushed to a repository. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-frequency-stat' + examples: + default: + $ref: '#/components/examples/code-frequency-stat-items' + '202': + $ref: '#/components/responses/accepted' + '204': + $ref: '#/components/responses/no_content' + '422': + description: Repository contains more than 10,000 commits + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/commit_activity: + get: + summary: Get the last year of commit activity + description: >- + Returns the last year of commit activity grouped by week. The `days` + array is a group of commits per day, starting on `Sunday`. + tags: + - repos + operationId: repos/get-commit-activity-stats + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit-activity' + examples: + default: + $ref: '#/components/examples/commit-activity-items' + '202': + $ref: '#/components/responses/accepted' + '204': + $ref: '#/components/responses/no_content' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/contributors: + get: + summary: Get all contributor commit activity + description: >- + + Returns the `total` number of commits authored by the contributor. In + addition, the response includes a Weekly Hash (`weeks` array) with the + following information: + + + * `w` - Start of the week, given as a [Unix + timestamp](https://en.wikipedia.org/wiki/Unix_time). + + * `a` - Number of additions + + * `d` - Number of deletions + + * `c` - Number of commits + + + > [!NOTE] + + > This endpoint will return `0` values for all addition and deletion + counts in repositories with 10,000 or more commits. + tags: + - repos + operationId: repos/get-contributors-stats + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/contributor-activity' + examples: + default: + $ref: '#/components/examples/contributor-activity-items' + '202': + $ref: '#/components/responses/accepted' + '204': + $ref: '#/components/responses/no_content' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/participation: + get: + summary: Get the weekly commit count + description: >- + Returns the total commit counts for the `owner` and total commit counts + in `all`. `all` is everyone combined, including the `owner` in the last + 52 weeks. If you'd like to get the commit counts for non-owners, you can + subtract `owner` from `all`. + + + The array order is oldest week (index 0) to most recent week. + + + The most recent week is seven days ago at UTC midnight to today at UTC + midnight. + tags: + - repos + operationId: repos/get-participation-stats + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: The array order is oldest week (index 0) to most recent week. + content: + application/json: + schema: + $ref: '#/components/schemas/participation-stats' + examples: + default: + $ref: '#/components/examples/participation-stats' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/punch_card: + get: + summary: Get the hourly commit count for each day + description: >- + Each array contains the day number, hour number, and number of commits: + + + * `0-6`: Sunday - Saturday + + * `0-23`: Hour of day + + * Number of commits + + + For example, `[2, 14, 25]` indicates that there were 25 total commits, + during the 2:00pm hour on Tuesdays. All times are based on the time zone + of individual commits. + tags: + - repos + operationId: repos/get-punch-card-stats + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: >- + For example, `[2, 14, 25]` indicates that there were 25 total + commits, during the 2:00pm hour on Tuesdays. All times are based on + the time zone of individual commits. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-frequency-stat' + examples: + default: + $ref: '#/components/examples/code-frequency-stat-items-2' + '204': + $ref: '#/components/responses/no_content' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/statuses/{sha}: + post: + summary: Create a commit status + description: >- + Users with push access in a repository can create commit statuses for a + given SHA. + + + Note: there is a limit of 1000 statuses per `sha` and `context` within a + repository. Attempts to create more than 1000 statuses will result in a + validation error. + tags: + - repos + operationId: repos/create-commit-status + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/statuses#create-a-commit-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sha + in: path + required: true + schema: + type: string + x-multi-segment: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: The state of the status. + enum: + - error + - failure + - pending + - success + target_url: + type: string + nullable: true + description: >- + The target URL to associate with this status. This URL will + be linked from the GitHub UI to allow users to easily see + the source of the status. + + For example, if your continuous integration system is + posting build status, you would want to provide the deep + link for the build output for this specific SHA: + + `http://ci.example.com/user/repo/build/sha` + description: + type: string + nullable: true + description: A short description of the status. + context: + type: string + description: >- + A string label to differentiate this status from the status + of other systems. This field is case-insensitive. + default: default + required: + - state + examples: + default: + value: + state: success + target_url: https://example.com/build/status + description: The build succeeded! + context: continuous-integration/jenkins + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/status' + examples: + default: + $ref: '#/components/examples/status' + headers: + Location: + example: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/tags: + get: + summary: List repository tags + description: '' + tags: + - repos + operationId: repos/list-tags + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-tags + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/tag' + examples: + default: + $ref: '#/components/examples/tag-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/tarball/{ref}: + get: + summary: Download a repository archive (tar) + description: >- + Gets a redirect URL to download a tar archive for a repository. If you + omit `:ref`, the repository’s default branch (usually + + `main`) will be used. Please make sure your HTTP framework is configured + to follow redirects or you will need to use + + the `Location` header to make a second `GET` request. + + + > [!NOTE] + + > For private repositories, these links are temporary and expire after + five minutes. + tags: + - repos + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar + operationId: repos/download-tarball-archive + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + in: path + required: true + x-multi-segment: true + schema: + type: string + responses: + '302': + description: Response + headers: + Location: + example: >- + https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/teams: + get: + summary: List repository teams + description: >- + Lists the teams that have access to the specified repository and that + are also visible to the authenticated user. + + + For a public repository, a team is listed only if that team added the + public repository explicitly. + + + OAuth app tokens and personal access tokens (classic) need the + `public_repo` or `repo` scope to use this endpoint with a public + repository, and `repo` scope to use this endpoint with a private + repository. + tags: + - repos + operationId: repos/list-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-teams + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/topics: + get: + summary: Get all repository topics + description: '' + tags: + - repos + operationId: repos/get-all-topics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#get-all-repository-topics + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/topic' + examples: + default: + $ref: '#/components/examples/topic' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Replace all repository topics + description: '' + tags: + - repos + operationId: repos/replace-all-topics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + names: + type: array + description: >- + An array of topics to add to the repository. Pass one or + more topics to _replace_ the set of existing topics. Send an + empty array (`[]`) to clear all topics from the repository. + **Note:** Topic `names` will be saved as lowercase. + items: + type: string + required: + - names + examples: + default: + value: + names: + - octocat + - atom + - electron + - api + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/topic' + examples: + default: + $ref: '#/components/examples/topic' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/traffic/clones: + get: + summary: Get repository clones + description: >- + Get the total number of clones and breakdown per day or week for the + last 14 days. Timestamps are aligned to UTC midnight of the beginning of + the day or week. Week begins on Monday. + tags: + - repos + operationId: repos/get-clones + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-repository-clones + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/clone-traffic' + examples: + default: + $ref: '#/components/examples/clone-traffic' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/traffic/popular/paths: + get: + summary: Get top referral paths + description: Get the top 10 popular contents over the last 14 days. + tags: + - repos + operationId: repos/get-top-paths + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/content-traffic' + examples: + default: + $ref: '#/components/examples/content-traffic-items' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/traffic/popular/referrers: + get: + summary: Get top referral sources + description: Get the top 10 referrers over the last 14 days. + tags: + - repos + operationId: repos/get-top-referrers + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/referrer-traffic' + examples: + default: + $ref: '#/components/examples/referrer-traffic-items' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/traffic/views: + get: + summary: Get page views + description: >- + Get the total number of views and breakdown per day or week for the last + 14 days. Timestamps are aligned to UTC midnight of the beginning of the + day or week. Week begins on Monday. + tags: + - repos + operationId: repos/get-views + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-page-views + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/view-traffic' + examples: + default: + $ref: '#/components/examples/view-traffic' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/transfer: + post: + summary: Transfer a repository + description: >- + A transfer request will need to be accepted by the new owner when + transferring a personal repository to another user. The response will + contain the original `owner`, and the transfer will continue + asynchronously. For more details on the requirements to transfer + personal and organization-owned repositories, see [about repository + transfers](https://docs.github.com/articles/about-repository-transfers/). + tags: + - repos + operationId: repos/transfer + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#transfer-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_owner: + type: string + description: >- + The username or organization name the repository will be + transferred to. + new_name: + type: string + description: The new name to be given to the repository. + team_ids: + type: array + description: >- + ID of the team or teams to add to the repository. Teams can + only be added to organization-owned repositories. + items: + type: integer + required: + - new_owner + examples: + default: + value: + new_owner: github + team_ids: + - 12 + - 345 + new_name: octorepo + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/vulnerability-alerts: + get: + summary: Check if vulnerability alerts are enabled for a repository + description: >- + Shows whether dependency alerts are enabled or disabled for a + repository. The authenticated user must have admin read access to the + repository. For more information, see "[About security alerts for + vulnerable + dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/check-vulnerability-alerts + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response if repository is enabled with vulnerability alerts + '404': + description: Not Found if repository is not enabled with vulnerability alerts + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable vulnerability alerts + description: >- + Enables dependency alerts and the dependency graph for a repository. The + authenticated user must have admin access to the repository. For more + information, see "[About security alerts for vulnerable + dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/enable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable vulnerability alerts + description: >- + Disables dependency alerts and the dependency graph for a repository. + + The authenticated user must have admin access to the repository. For + more information, + + see "[About security alerts for vulnerable + dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/disable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/zipball/{ref}: + get: + summary: Download a repository archive (zip) + description: >- + Gets a redirect URL to download a zip archive for a repository. If you + omit `:ref`, the repository’s default branch (usually + + `main`) will be used. Please make sure your HTTP framework is configured + to follow redirects or you will need to use + + the `Location` header to make a second `GET` request. + + + > [!NOTE] + + > For private repositories, these links are temporary and expire after + five minutes. If the repository is empty, you will receive a 404 when + you follow the redirect. + tags: + - repos + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip + operationId: repos/download-zipball-archive + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + in: path + required: true + x-multi-segment: true + schema: + type: string + responses: + '302': + description: Response + headers: + Location: + example: >- + https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{template_owner}/{template_repo}/generate: + post: + summary: Create a repository using a template + description: >- + Creates a new repository using a repository template. Use the + `template_owner` and `template_repo` route parameters to specify the + repository to use as the template. If the repository is not public, the + authenticated user must own or be a member of an organization that owns + the repository. To check if a repository is available to use as a + template, get the repository's information using the [Get a + repository](https://docs.github.com/rest/repos/repos#get-a-repository) + endpoint and check that the `is_template` key is `true`. + + + OAuth app tokens and personal access tokens (classic) need the + `public_repo` or `repo` scope to create a public repository, and `repo` + scope to create a private repository. + tags: + - repos + operationId: repos/create-using-template + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template + parameters: + - name: template_owner + description: >- + The account owner of the template repository. The name is not case + sensitive. + in: path + required: true + schema: + type: string + - name: template_repo + description: >- + The name of the template repository without the `.git` extension. + The name is not case sensitive. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + description: >- + The organization or person who will own the new repository. + To create a new repository in an organization, the + authenticated user must be a member of the specified + organization. + name: + type: string + description: The name of the new repository. + description: + type: string + description: A short description of the new repository. + include_all_branches: + type: boolean + description: >- + Set to `true` to include the directory structure and files + from all branches in the template repository, and not just + the default branch. Default: `false`. + default: false + private: + type: boolean + description: >- + Either `true` to create a new private repository or `false` + to create a new public one. + default: false + required: + - name + examples: + default: + value: + owner: octocat + name: Hello-World + description: This is your first repository + include_all_branches: false + private: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repositories: + get: + summary: List public repositories + description: >- + Lists all public repositories in the order that they were created. + + + Note: + + - For GitHub Enterprise Server, this endpoint will only list + repositories available to all users on the enterprise. + + - Pagination is powered exclusively by the `since` parameter. Use the + [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) + to get the URL for the next page of repositories. + tags: + - repos + operationId: repos/list-public + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-public-repositories + parameters: + - $ref: '#/components/parameters/since-repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /user/repos: + get: + summary: List repositories for the authenticated user + description: >- + Lists repositories that the authenticated user has explicit permission + (`:read`, `:write`, or `:admin`) to access. + + + The authenticated user has explicit permission to access repositories + they own, repositories where they are a collaborator, and repositories + that they can access through an organization membership. + tags: + - repos + operationId: repos/list-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user + parameters: + - name: visibility + description: Limit results to repositories with the specified visibility. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + default: all + - name: affiliation + description: |- + Comma-separated list of values. Can include: + * `owner`: Repositories that are owned by the authenticated user. + * `collaborator`: Repositories that the user has been added to as a collaborator. + * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + in: query + required: false + schema: + type: string + default: owner,collaborator,organization_member + - name: type + description: >- + Limit results to repositories of the specified type. Will cause a + `422` error if used in the same request as **visibility** or + **affiliation**. + in: query + required: false + schema: + type: string + enum: + - all + - owner + - public + - private + - member + default: all + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - pushed + - full_name + default: full_name + - name: direction + description: >- + The order to sort by. Default: `asc` when using `full_name`, + otherwise `desc`. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/since-repo-date' + - $ref: '#/components/parameters/before-repo-date' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default: + $ref: '#/components/examples/repository-items-default-response' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: repos + subcategory: repos + x-stackQL-resource: repos + post: + summary: Create a repository for the authenticated user + description: >- + Creates a new repository for the authenticated user. + + + OAuth app tokens and personal access tokens (classic) need the + `public_repo` or `repo` scope to create a public repository, and `repo` + scope to create a private repository. + tags: + - repos + operationId: repos/create-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: The name of the repository. + type: string + example: Team Environment + description: + description: A short description of the repository. + type: string + homepage: + description: A URL with more information about the repository. + type: string + private: + description: Whether the repository is private. + default: false + type: boolean + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + team_id: + description: >- + The id of the team that will be granted access to this + repository. This is only valid when creating a repository in + an organization. + type: integer + auto_init: + description: Whether the repository is initialized with a minimal README. + default: false + type: boolean + gitignore_template: + description: The desired language or platform to apply to the .gitignore. + example: Haskell + type: string + license_template: + description: >- + The license keyword of the open source license for this + repository. + example: mit + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: >- + Whether to delete head branches when pull requests are + merged + default: false + type: boolean + example: false + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + Required when using `squash_merge_commit_message`. + + + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if + only one commit) or the pull request's title (when more than + one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: >- + The default value for a squash merge commit message: + + + - `PR_BODY` - default to the pull request's body. + + - `COMMIT_MESSAGES` - default to the branch's commit + messages. + + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + Required when using `merge_commit_message`. + + + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge + message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + is_template: + description: >- + Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + example: true + required: + - name + type: object + examples: + default: + value: + name: Hello-World + description: This is your first repo! + homepage: https://github.com + private: false + is_template: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: repos + subcategory: repos + x-github-breaking-changes: + - changeset: change_create_repo_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: repos + /user/repository_invitations: + get: + summary: List repository invitations for the authenticated user + description: >- + When authenticating as a user, this endpoint will list all currently + open repository invitations for that user. + tags: + - repos + operationId: repos/list-invitations-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-invitation' + examples: + default: + $ref: '#/components/examples/repository-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /user/repository_invitations/{invitation_id}: + patch: + summary: Accept a repository invitation + description: '' + tags: + - repos + operationId: repos/accept-invitation-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation + parameters: + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: collaborators + subcategory: invitations + x-github-breaking-changes: + - changeset: change_accept_repository_invitation_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: invitations + delete: + summary: Decline a repository invitation + description: '' + tags: + - repos + operationId: repos/decline-invitation-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation + parameters: + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /users/{username}/repos: + get: + summary: List repositories for a user + description: Lists public repositories for the specified user. + tags: + - repos + operationId: repos/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - name: type + description: Limit results to repositories of the specified type. + in: query + required: false + schema: + type: string + enum: + - all + - owner + - member + default: owner + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - pushed + - full_name + default: full_name + - name: direction + description: >- + The order to sort by. Default: `asc` when using `full_name`, + otherwise `desc`. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos +components: + schemas: + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + $ref: '#/components/schemas/nullable-repository' + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + $ref: '#/components/schemas/nullable-license-simple' + organization: + $ref: '#/components/schemas/nullable-simple-user' + parent: + $ref: '#/components/schemas/repository' + source: + $ref: '#/components/schemas/repository' + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct-simple' + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + repository-ruleset: + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: + type: string + description: The name of the ruleset + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + - Enterprise + source: + type: string + description: The name of the source + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + current_user_can_bypass: + type: string + description: >- + The bypass type of the user making the API request for this ruleset. + This field is only returned when + + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + - exempt + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: object + nullable: true + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: >- + Array of ref names or patterns to include. One of these + patterns must match for the condition to pass. Also accepts + `~DEFAULT_BRANCH` to include the default branch or `~ALL` to + include all branches. + items: + type: string + exclude: + type: array + description: >- + Array of ref names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + repository_name: + type: object + properties: + include: + type: array + description: >- + Array of repository names or patterns to include. One of + these patterns must match for the condition to pass. Also + accepts `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: >- + Array of repository names or patterns to exclude. The + condition will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + repository_id: + type: object + properties: + repository_ids: + type: array + description: >- + The repository IDs that the ruleset applies to. One of these + IDs must match for the condition to pass. + items: + type: integer + repository_property: + type: object + properties: + include: + type: array + description: >- + The repository properties and values to include. All of + these properties must match for the condition to pass. + items: + $ref: >- + #/components/schemas/repository-ruleset-conditions-repository-property-spec + exclude: + type: array + description: >- + The repository properties and values to exclude. The + condition will not pass if any of these properties match. + items: + $ref: >- + #/components/schemas/repository-ruleset-conditions-repository-property-spec + required: + - repository_name + - repository_id + - repository_property + rules: + type: array + items: + $ref: '#/components/schemas/repository-rule' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + repository-rule-enforcement: + type: string + description: >- + The enforcement level of the ruleset. `evaluate` allows admins to test + rules before enforcing them. Admins can view insights on the Rule + Insights page (`evaluate` is only available with GitHub Enterprise). + enum: + - disabled + - active + - evaluate + repository-ruleset-bypass-actor: + title: Repository Ruleset Bypass Actor + type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + properties: + actor_id: + type: integer + nullable: true + description: >- + The ID of the actor that can bypass a ruleset. Required for + `Integration`, `RepositoryRole`, and `Team` actor types. If + `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If + `actor_type` is `DeployKey`, this should be null. + `OrganizationAdmin` is not applicable for personal repositories. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + description: The type of actor that can bypass a ruleset. + bypass_mode: + type: string + description: >- + When the specified actor can bypass the ruleset. `pull_request` + means that an actor can only bypass rules on pull requests. + `pull_request` is not applicable for the `DeployKey` actor type. + Also, `pull_request` is only applicable to branch rulesets. When + `bypass_mode` is `exempt`, rules will not be run for that actor and + a bypass audit entry will not be created. + enum: + - always + - pull_request + - exempt + default: always + org-ruleset-conditions: + title: Organization ruleset conditions + type: object + description: >- + Conditions for an organization ruleset. + + The branch and tag rulesets conditions object should contain both + `repository_name` and `ref_name` properties, or both `repository_id` and + `ref_name` properties, or both `repository_property` and `ref_name` + properties. + + The push rulesets conditions object does not require the `ref_name` + property. + + For repository policy rulesets, the conditions object should only + contain the `repository_name`, the `repository_id`, or the + `repository_property`. + properties: + ref_name: + type: object + properties: + include: + type: array + description: >- + Array of ref names or patterns to include. One of these patterns + must match for the condition to pass. Also accepts + `~DEFAULT_BRANCH` to include the default branch or `~ALL` to + include all branches. + items: + type: string + exclude: + type: array + description: >- + Array of ref names or patterns to exclude. The condition will + not pass if any of these patterns match. + items: + type: string + repository_name: + type: object + properties: + include: + type: array + description: >- + Array of repository names or patterns to include. One of these + patterns must match for the condition to pass. Also accepts + `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: >- + Array of repository names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + repository_id: + type: object + properties: + repository_ids: + type: array + description: >- + The repository IDs that the ruleset applies to. One of these IDs + must match for the condition to pass. + items: + type: integer + repository_property: + type: object + properties: + include: + type: array + description: >- + The repository properties and values to include. All of these + properties must match for the condition to pass. + items: + $ref: >- + #/components/schemas/repository-ruleset-conditions-repository-property-spec + exclude: + type: array + description: >- + The repository properties and values to exclude. The condition + will not pass if any of these properties match. + items: + $ref: >- + #/components/schemas/repository-ruleset-conditions-repository-property-spec + required: + - repository_name + - repository_id + - repository_property + org-rules: + title: Repository Rule + type: object + description: A repository rule. + required: + - type + properties: + type: + type: string + enum: + - creation + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + rule-suites: + title: Rule Suites + description: Response + type: array + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the rule insight. + actor_id: + type: integer + description: The number that identifies the user. + actor_name: + type: string + description: The handle for the GitHub user account. + before_sha: + type: string + description: The first commit sha before the push evaluation. + after_sha: + type: string + description: The last commit sha in the push evaluation. + ref: + type: string + description: The ref name that the evaluation ran on. + repository_id: + type: integer + description: The ID of the repository associated with the rule evaluation. + repository_name: + type: string + description: The name of the repository without the `.git` extension. + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + result: + type: string + enum: + - pass + - fail + - bypass + description: >- + The result of the rule evaluations for rules with the `active` + enforcement status. + evaluation_result: + type: string + enum: + - pass + - fail + - bypass + description: >- + The result of the rule evaluations for rules with the `active` and + `evaluate` enforcement statuses, demonstrating whether rules would + pass or fail if all rules in the rule suite were `active`. + rule-suite: + title: Rule Suite + description: Response + type: object + properties: + id: + type: integer + description: The unique identifier of the rule insight. + actor_id: + type: integer + description: The number that identifies the user. + nullable: true + actor_name: + type: string + description: The handle for the GitHub user account. + nullable: true + before_sha: + type: string + description: The previous commit SHA of the ref. + after_sha: + type: string + description: The new commit SHA of the ref. + ref: + type: string + description: The ref name that the evaluation ran on. + repository_id: + type: integer + description: The ID of the repository associated with the rule evaluation. + repository_name: + type: string + description: The name of the repository without the `.git` extension. + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + result: + type: string + enum: + - pass + - fail + - bypass + description: >- + The result of the rule evaluations for rules with the `active` + enforcement status. + evaluation_result: + type: string + nullable: true + enum: + - pass + - fail + - bypass + description: >- + The result of the rule evaluations for rules with the `active` and + `evaluate` enforcement statuses, demonstrating whether rules would + pass or fail if all rules in the rule suite were `active`. Null if + no rules with `evaluate` enforcement status were run. + rule_evaluations: + type: array + description: Details on the evaluated rules. + items: + type: object + properties: + rule_source: + type: object + properties: + type: + type: string + description: The type of rule source. + id: + type: integer + nullable: true + description: The ID of the rule source. + name: + type: string + nullable: true + description: The name of the rule source. + enforcement: + type: string + enum: + - active + - evaluate + - deleted ruleset + description: The enforcement level of this rule source. + result: + type: string + enum: + - pass + - fail + description: The result of the evaluation of the individual rule. + rule_type: + type: string + description: The type of rule. + details: + type: string + nullable: true + description: >- + The detailed failure message for the rule. Null if the rule + passed. + activity: + title: Activity + description: Activity + type: object + properties: + id: + type: integer + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + description: The SHA of the commit before the activity. + after: + type: string + example: 827efc6d56897b048c772eb4087f854f46256132 + description: The SHA of the commit after the activity. + ref: + type: string + example: refs/heads/main + description: The full Git reference, formatted as `refs/heads/`. + timestamp: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + description: The time when the activity occurred. + activity_type: + type: string + example: force_push + enum: + - push + - force_push + - branch_deletion + - branch_creation + - pr_merge + - merge_queue_merge + description: The type of the activity that was performed. + actor: + $ref: '#/components/schemas/nullable-simple-user' + required: + - id + - node_id + - before + - after + - ref + - timestamp + - activity_type + - actor + autolink: + title: Autolink reference + description: An autolink reference. + type: object + properties: + id: + type: integer + example: 3 + key_prefix: + description: The prefix of a key that is linkified. + example: TICKET- + type: string + url_template: + description: A template for the target URL that is generated if a key was found. + example: https://example.com/TICKET?query= + type: string + is_alphanumeric: + description: >- + Whether this autolink reference matches alphanumeric characters. If + false, this autolink reference only matches numeric characters. + example: true + type: boolean + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - key_prefix + - url_template + - is_alphanumeric + check-automated-security-fixes: + title: Check Dependabot security updates + description: Check Dependabot security updates + type: object + properties: + enabled: + type: boolean + example: true + description: Whether Dependabot security updates are enabled for the repository. + paused: + type: boolean + example: false + description: Whether Dependabot security updates are paused for the repository. + required: + - enabled + - paused + short-branch: + title: Short Branch + description: Short Branch + type: object + properties: + name: + type: string + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + protected: + type: boolean + protection: + $ref: '#/components/schemas/branch-protection' + protection_url: + type: string + format: uri + required: + - name + - commit + - protected + branch-with-protection: + title: Branch With Protection + description: Branch With Protection + type: object + properties: + name: + type: string + commit: + $ref: '#/components/schemas/commit' + _links: + type: object + properties: + html: + type: string + self: + type: string + format: uri + required: + - html + - self + protected: + type: boolean + protection: + $ref: '#/components/schemas/branch-protection' + protection_url: + type: string + format: uri + pattern: + type: string + example: '"mas*"' + required_approving_review_count: + type: integer + example: 1 + required: + - name + - commit + - _links + - protection + - protected + - protection_url + branch-protection: + title: Branch Protection + description: Branch Protection + type: object + properties: + url: + type: string + enabled: + type: boolean + required_status_checks: + $ref: '#/components/schemas/protected-branch-required-status-check' + enforce_admins: + $ref: '#/components/schemas/protected-branch-admin-enforced' + required_pull_request_reviews: + $ref: '#/components/schemas/protected-branch-pull-request-review' + restrictions: + $ref: '#/components/schemas/branch-restriction-policy' + required_linear_history: + type: object + properties: + enabled: + type: boolean + allow_force_pushes: + type: object + properties: + enabled: + type: boolean + allow_deletions: + type: object + properties: + enabled: + type: boolean + block_creations: + type: object + properties: + enabled: + type: boolean + required_conversation_resolution: + type: object + properties: + enabled: + type: boolean + name: + type: string + example: '"branch/with/protection"' + protection_url: + type: string + example: >- + "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" + required_signatures: + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + example: true + required: + - url + - enabled + lock_branch: + type: object + description: >- + Whether to set the branch as read-only. If this is true, users will + not be able to push to the branch. + properties: + enabled: + default: false + type: boolean + allow_fork_syncing: + type: object + description: >- + Whether users can pull changes from upstream when the branch is + locked. Set to `true` to allow fork syncing. Set to `false` to + prevent fork syncing. + properties: + enabled: + default: false + type: boolean + protected-branch: + title: Protected Branch + description: Branch protections protect branches + type: object + properties: + url: + type: string + format: uri + required_status_checks: + $ref: '#/components/schemas/status-check-policy' + required_pull_request_reviews: + type: object + properties: + url: + type: string + format: uri + dismiss_stale_reviews: + type: boolean + require_code_owner_reviews: + type: boolean + required_approving_review_count: + type: integer + require_last_push_approval: + description: >- + Whether the most recent push must be approved by someone other + than the person who pushed it. + type: boolean + default: false + dismissal_restrictions: + type: object + properties: + url: + type: string + format: uri + users_url: + type: string + format: uri + teams_url: + type: string + format: uri + users: + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + type: array + items: + $ref: '#/components/schemas/team' + apps: + type: array + items: + $ref: '#/components/schemas/integration' + required: + - url + - users_url + - teams_url + - users + - teams + bypass_pull_request_allowances: + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + type: array + items: + $ref: '#/components/schemas/team' + apps: + type: array + items: + $ref: '#/components/schemas/integration' + required: + - users + - teams + required: + - url + required_signatures: + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + example: true + required: + - url + - enabled + enforce_admins: + type: object + properties: + url: + type: string + format: uri + enabled: + type: boolean + additionalProperties: false + required: + - url + - enabled + required_linear_history: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + allow_force_pushes: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + allow_deletions: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + restrictions: + $ref: '#/components/schemas/branch-restriction-policy' + required_conversation_resolution: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + block_creations: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + lock_branch: + type: object + description: >- + Whether to set the branch as read-only. If this is true, users will + not be able to push to the branch. + properties: + enabled: + default: false + type: boolean + additionalProperties: false + allow_fork_syncing: + type: object + description: >- + Whether users can pull changes from upstream when the branch is + locked. Set to `true` to allow fork syncing. Set to `false` to + prevent fork syncing. + properties: + enabled: + default: false + type: boolean + additionalProperties: false + required: + - url + protected-branch-admin-enforced: + title: Protected Branch Admin Enforced + description: Protected Branch Admin Enforced + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: + type: boolean + example: true + required: + - url + - enabled + protected-branch-pull-request-review: + title: Protected Branch Pull Request Review + description: Protected Branch Pull Request Review + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + dismissal_restrictions: + type: object + properties: + users: + description: The list of users with review dismissal access. + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + description: The list of teams with review dismissal access. + type: array + items: + $ref: '#/components/schemas/team' + apps: + description: The list of apps with review dismissal access. + type: array + items: + $ref: '#/components/schemas/integration' + url: + type: string + example: >- + "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" + users_url: + type: string + example: >- + "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" + teams_url: + type: string + example: >- + "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" + bypass_pull_request_allowances: + type: object + description: >- + Allow specific users, teams, or apps to bypass pull request + requirements. + properties: + users: + description: The list of users allowed to bypass pull request requirements. + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + description: The list of teams allowed to bypass pull request requirements. + type: array + items: + $ref: '#/components/schemas/team' + apps: + description: The list of apps allowed to bypass pull request requirements. + type: array + items: + $ref: '#/components/schemas/integration' + dismiss_stale_reviews: + type: boolean + example: true + require_code_owner_reviews: + type: boolean + example: true + required_approving_review_count: + type: integer + minimum: 0 + maximum: 6 + example: 2 + require_last_push_approval: + description: >- + Whether the most recent push must be approved by someone other than + the person who pushed it. + type: boolean + example: true + default: false + required: + - dismiss_stale_reviews + - require_code_owner_reviews + status-check-policy: + title: Status Check Policy + description: Status Check Policy + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: + type: boolean + example: true + contexts: + type: array + example: + - continuous-integration/travis-ci + items: + type: string + checks: + type: array + items: + type: object + properties: + context: + type: string + example: continuous-integration/travis-ci + app_id: + type: integer + nullable: true + required: + - context + - app_id + contexts_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + required: + - url + - contexts_url + - strict + - contexts + - checks + branch-restriction-policy: + title: Branch Restriction Policy + description: Branch Restriction Policy + type: object + properties: + url: + type: string + format: uri + users_url: + type: string + format: uri + teams_url: + type: string + format: uri + apps_url: + type: string + format: uri + users: + type: array + items: + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + user_view_type: + type: string + teams: + type: array + items: + $ref: '#/components/schemas/team' + apps: + type: array + items: + type: object + properties: + id: + type: integer + slug: + type: string + node_id: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + url: + type: string + repos_url: + type: string + events_url: + type: string + hooks_url: + type: string + issues_url: + type: string + members_url: + type: string + public_members_url: + type: string + avatar_url: + type: string + description: + type: string + gravatar_id: + type: string + example: '""' + html_url: + type: string + example: '"https://github.com/testorg-ea8ec76d71c3af4b"' + followers_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" + following_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" + gists_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" + starred_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" + subscriptions_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" + organizations_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" + received_events_url: + type: string + example: >- + "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" + type: + type: string + example: '"Organization"' + site_admin: + type: boolean + example: false + user_view_type: + type: string + example: public + name: + type: string + client_id: + type: string + description: + type: string + external_url: + type: string + html_url: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + metadata: + type: string + contents: + type: string + issues: + type: string + single_file: + type: string + events: + type: array + items: + type: string + required: + - url + - users_url + - teams_url + - apps_url + - users + - teams + - apps + integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + codeowners-errors: + title: CODEOWNERS errors + description: A list of errors found in a repo's CODEOWNERS file + type: object + properties: + errors: + type: array + items: + type: object + properties: + line: + description: The line number where this errors occurs. + type: integer + example: 7 + column: + description: The column number where this errors occurs. + type: integer + example: 3 + source: + description: The contents of the line where the error occurs. + type: string + example: '* user' + kind: + description: The type of error. + type: string + example: Invalid owner + suggestion: + description: >- + Suggested action to fix the error. This will usually be + `null`, but is provided for some common errors. + type: string + nullable: true + example: >- + The pattern `/` will never match anything, did you mean `*` + instead? + message: + description: >- + A human-readable description of the error, combining + information from multiple fields, laid out for display in a + monospaced typeface (for example, a command-line setting). + type: string + example: |- + Invalid owner on line 7: + + * user + ^ + path: + description: The path of the file where the error occured. + type: string + example: .github/CODEOWNERS + required: + - line + - column + - kind + - message + - path + required: + - errors + collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + email: + nullable: true + type: string + name: + nullable: true + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - push + - admin + role_name: + type: string + example: admin + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - role_name + repository-invitation: + title: Repository Invitation + description: Repository invitations let you manage who you collaborate with. + type: object + properties: + id: + description: Unique identifier of the repository invitation. + example: 42 + type: integer + format: int64 + repository: + $ref: '#/components/schemas/minimal-repository' + invitee: + $ref: '#/components/schemas/nullable-simple-user' + inviter: + $ref: '#/components/schemas/nullable-simple-user' + permissions: + description: The permission associated with the invitation. + example: read + type: string + enum: + - read + - write + - admin + - triage + - maintain + created_at: + type: string + format: date-time + example: '2016-06-13T14:52:50-05:00' + expired: + description: Whether or not the invitation has expired + type: boolean + url: + description: URL for the repository invitation + example: https://api.github.com/user/repository-invitations/1 + type: string + html_url: + type: string + example: https://github.com/octocat/Hello-World/invitations + node_id: + type: string + required: + - id + - node_id + - permissions + - inviter + - invitee + - repository + - url + - html_url + - created_at + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + repository-collaborator-permission: + title: Repository Collaborator Permission + description: Repository Collaborator Permission + type: object + properties: + permission: + type: string + role_name: + type: string + example: admin + user: + $ref: '#/components/schemas/nullable-collaborator' + required: + - permission + - role_name + - user + commit-comment: + title: Commit Comment + description: Commit Comment + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - url + - html_url + - id + - node_id + - user + - position + - line + - path + - commit_id + - body + - author_association + - created_at + - updated_at + commit: + title: Commit + description: Commit + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + $ref: '#/components/schemas/nullable-git-user' + committer: + $ref: '#/components/schemas/nullable-git-user' + message: + type: string + example: Fix all the bugs + comment_count: + type: integer + example: 0 + tree: + type: object + properties: + sha: + type: string + example: 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + required: + - sha + - url + verification: + $ref: '#/components/schemas/verification' + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + committer: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + parents: + type: array + items: + type: object + properties: + sha: + type: string + example: 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + required: + - sha + - url + stats: + type: object + properties: + additions: + type: integer + deletions: + type: integer + total: + type: integer + files: + type: array + items: + $ref: '#/components/schemas/diff-entry' + required: + - url + - sha + - node_id + - html_url + - comments_url + - commit + - author + - committer + - parents + branch-short: + title: Branch Short + description: Branch Short + type: object + properties: + name: + type: string + commit: + type: object + properties: + sha: + type: string + url: + type: string + required: + - sha + - url + protected: + type: boolean + required: + - name + - commit + - protected + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + example: 1347 + state: + type: string + example: open + locked: + type: boolean + example: true + title: + type: string + example: new-feature + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + combined-commit-status: + title: Combined Commit Status + description: Combined Commit Status + type: object + properties: + state: + type: string + statuses: + type: array + items: + $ref: '#/components/schemas/simple-commit-status' + sha: + type: string + total_count: + type: integer + repository: + $ref: '#/components/schemas/minimal-repository' + commit_url: + type: string + format: uri + url: + type: string + format: uri + required: + - state + - sha + - total_count + - statuses + - repository + - commit_url + - url + status: + title: Status + description: The status of a commit. + type: object + properties: + url: + type: string + avatar_url: + type: string + nullable: true + id: + type: integer + node_id: + type: string + state: + type: string + description: + type: string + nullable: true + target_url: + type: string + nullable: true + context: + type: string + created_at: + type: string + updated_at: + type: string + creator: + $ref: '#/components/schemas/nullable-simple-user' + required: + - url + - avatar_url + - id + - node_id + - state + - description + - target_url + - context + - created_at + - updated_at + - creator + community-profile: + title: Community Profile + description: Community Profile + type: object + properties: + health_percentage: + type: integer + example: 100 + description: + type: string + example: My first repository on GitHub! + nullable: true + documentation: + type: string + example: example.com + nullable: true + files: + type: object + properties: + code_of_conduct: + $ref: '#/components/schemas/nullable-code-of-conduct-simple' + code_of_conduct_file: + $ref: '#/components/schemas/nullable-community-health-file' + license: + $ref: '#/components/schemas/nullable-license-simple' + contributing: + $ref: '#/components/schemas/nullable-community-health-file' + readme: + $ref: '#/components/schemas/nullable-community-health-file' + issue_template: + $ref: '#/components/schemas/nullable-community-health-file' + pull_request_template: + $ref: '#/components/schemas/nullable-community-health-file' + required: + - code_of_conduct + - code_of_conduct_file + - license + - contributing + - readme + - issue_template + - pull_request_template + updated_at: + type: string + format: date-time + example: '2017-02-28T19:09:29Z' + nullable: true + content_reports_enabled: + type: boolean + example: true + required: + - health_percentage + - description + - documentation + - files + - updated_at + commit-comparison: + title: Commit Comparison + description: Commit Comparison + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/master...topic.patch + base_commit: + $ref: '#/components/schemas/commit' + merge_base_commit: + $ref: '#/components/schemas/commit' + status: + type: string + enum: + - diverged + - ahead + - behind + - identical + example: ahead + ahead_by: + type: integer + example: 4 + behind_by: + type: integer + example: 5 + total_commits: + type: integer + example: 6 + commits: + type: array + items: + $ref: '#/components/schemas/commit' + files: + type: array + items: + $ref: '#/components/schemas/diff-entry' + required: + - url + - html_url + - permalink_url + - diff_url + - patch_url + - base_commit + - merge_base_commit + - status + - ahead_by + - behind_by + - total_commits + - commits + content-tree: + title: Content Tree + description: Content Tree + type: object + properties: + type: + type: string + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + content: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + entries: + type: array + items: + type: object + properties: + type: + type: string + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + encoding: + type: string + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + content-directory: + title: Content Directory + description: A list of directory items + type: array + items: + type: object + properties: + type: + type: string + enum: + - dir + - file + - submodule + - symlink + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + content-file: + title: Content File + description: Content File + type: object + properties: + type: + type: string + enum: + - file + encoding: + type: string + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + example: '"actual/actual.md"' + submodule_git_url: + type: string + example: '"git://example.com/defunkt/dotjs.git"' + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + content-symlink: + title: Symlink Content + description: An object describing a symlink + type: object + properties: + type: + type: string + enum: + - symlink + target: + type: string + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - target + content-submodule: + title: Submodule Content + description: An object describing a submodule + type: object + properties: + type: + type: string + enum: + - submodule + submodule_git_url: + type: string + format: uri + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - submodule_git_url + file-commit: + title: File Commit + description: File Commit + type: object + required: + - content + - commit + properties: + content: + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + size: + type: integer + url: + type: string + html_url: + type: string + git_url: + type: string + download_url: + type: string + type: + type: string + _links: + type: object + properties: + self: + type: string + git: + type: string + html: + type: string + nullable: true + commit: + type: object + properties: + sha: + type: string + node_id: + type: string + url: + type: string + html_url: + type: string + author: + type: object + properties: + date: + type: string + name: + type: string + email: + type: string + committer: + type: object + properties: + date: + type: string + name: + type: string + email: + type: string + message: + type: string + tree: + type: object + properties: + url: + type: string + sha: + type: string + parents: + type: array + items: + type: object + properties: + url: + type: string + html_url: + type: string + sha: + type: string + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + repository-rule-violation-error: + description: Repository rule violation was detected + type: object + properties: + message: + type: string + documentation_url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: >- + #/components/schemas/secret-scanning-push-protection-bypass-placeholder-id + token_type: + type: string + contributor: + title: Contributor + description: Contributor + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + events_url: + type: string + received_events_url: + type: string + format: uri + type: + type: string + site_admin: + type: boolean + contributions: + type: integer + email: + type: string + name: + type: string + user_view_type: + type: string + required: + - contributions + - type + deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + example: 42 + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + sha: + type: string + example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + example: topic-branch + type: string + task: + description: Parameter to specify a task to execute + example: deploy + type: string + payload: + type: object + additionalProperties: true + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: >- + Specifies if the given environment is will no longer exist at some + point in the future. Default: false. + example: true + type: boolean + production_environment: + description: >- + Specifies if the given environment is one that end-users directly + interact with. Default: false. + example: true + type: boolean + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + deployment-status: + title: Deployment Status + description: The status of a deployment. + type: object + properties: + url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: + description: The state of the status. + enum: + - error + - failure + - inactive + - pending + - success + - queued + - in_progress + example: success + type: string + creator: + $ref: '#/components/schemas/nullable-simple-user' + description: + description: A short description of the status. + default: '' + type: string + maxLength: 140 + example: Deployment finished successfully. + environment: + description: The environment of the deployment that the status is for. + default: '' + type: string + example: production + target_url: + description: 'Closing down notice: the URL to associate with this status.' + default: '' + type: string + format: uri + example: https://example.com/deployment/42/output + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + deployment_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/42 + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + environment_url: + description: The URL for accessing your environment. + default: '' + type: string + format: uri + example: https://staging.example.com/ + log_url: + description: The URL to associate with this status. + default: '' + type: string + format: uri + example: https://example.com/deployment/42/output + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - state + - creator + - description + - deployment_url + - target_url + - repository_url + - url + - created_at + - updated_at + environment: + title: Environment + description: Details of a deployment environment + type: object + properties: + id: + description: The id of the environment. + example: 56780428 + type: integer + format: int64 + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: + description: The time that the environment was created, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + updated_at: + description: The time that the environment was last updated, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + protection_rules: + type: array + description: Built-in deployment protection rules for the environment. + items: + anyOf: + - type: object + properties: + id: + type: integer + example: 3515 + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + type: + type: string + example: wait_timer + wait_timer: + $ref: '#/components/schemas/wait-timer' + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + example: 3755 + node_id: + type: string + example: MDQ6R2F0ZTM3NTU= + prevent_self_review: + type: boolean + example: false + description: >- + Whether deployments to this environment can be approved by + the user who created the deployment. + type: + type: string + example: required_reviewers + reviewers: + type: array + description: >- + The people or teams that may approve jobs that reference + the environment. You can list up to six users or teams as + reviewers. The reviewers must have at least read access to + the repository. Only one of the required reviewers needs + to approve the job for it to proceed. + items: + type: object + properties: + type: + $ref: '#/components/schemas/deployment-reviewer-type' + reviewer: + anyOf: + - $ref: '#/components/schemas/simple-user' + - $ref: '#/components/schemas/team' + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + example: 3515 + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + type: + type: string + example: branch_policy + required: + - id + - node_id + - type + deployment_branch_policy: + $ref: '#/components/schemas/deployment-branch-policy-settings' + required: + - id + - node_id + - name + - url + - html_url + - created_at + - updated_at + wait-timer: + type: integer + example: 30 + description: >- + The amount of time to delay a job after the job is initially triggered. + The time (in minutes) must be an integer between 0 and 43,200 (30 days). + prevent-self-review: + type: boolean + example: false + description: >- + Whether or not a user who created the job is prevented from approving + their own job. + deployment-reviewer-type: + type: string + description: The type of reviewer. + enum: + - User + - Team + example: User + deployment-branch-policy-settings: + type: object + description: >- + The type of deployment branch policy for this environment. To allow all + branches to deploy, set to `null`. + properties: + protected_branches: + type: boolean + description: >- + Whether only branches with branch protection rules can deploy to + this environment. If `protected_branches` is `true`, + `custom_branch_policies` must be `false`; if `protected_branches` is + `false`, `custom_branch_policies` must be `true`. + custom_branch_policies: + type: boolean + description: >- + Whether only branches that match the specified name patterns can + deploy to this environment. If `custom_branch_policies` is `true`, + `protected_branches` must be `false`; if `custom_branch_policies` is + `false`, `protected_branches` must be `true`. + nullable: true + required: + - protected_branches + - custom_branch_policies + deployment-branch-policy: + title: Deployment branch policy + description: Details of a deployment branch or tag policy. + type: object + properties: + id: + description: The unique identifier of the branch or tag policy. + type: integer + example: 361471 + node_id: + type: string + example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: + description: >- + The name pattern that branches or tags must match in order to deploy + to the environment. + type: string + example: release/* + type: + description: Whether this rule targets a branch or tag. + type: string + example: branch + enum: + - branch + - tag + deployment-branch-policy-name-pattern-with-type: + title: Deployment branch and tag policy name pattern + type: object + properties: + name: + description: >- + The name pattern that branches or tags must match in order to deploy + to the environment. + + + Wildcard characters will not match `/`. For example, to match + branches that begin with `release/` and contain an additional single + slash, use `release/*/*`. + + For more information about pattern matching syntax, see the [Ruby + File.fnmatch + documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + type: string + example: release/* + type: + description: Whether this rule targets a branch or tag + type: string + example: branch + enum: + - branch + - tag + required: + - name + deployment-branch-policy-name-pattern: + title: Deployment branch policy name pattern + type: object + properties: + name: + description: >- + The name pattern that branches must match in order to deploy to the + environment. + + + Wildcard characters will not match `/`. For example, to match + branches that begin with `release/` and contain an additional single + slash, use `release/*/*`. + + For more information about pattern matching syntax, see the [Ruby + File.fnmatch + documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + type: string + example: release/* + required: + - name + deployment-protection-rule: + title: Deployment protection rule + description: Deployment protection rule + type: object + properties: + id: + type: integer + example: 3515 + description: The unique identifier for the deployment protection rule. + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + description: The node ID for the deployment protection rule. + enabled: + type: boolean + example: true + description: >- + Whether the deployment protection rule is enabled for the + environment. + app: + $ref: '#/components/schemas/custom-deployment-rule-app' + required: + - id + - node_id + - enabled + - app + custom-deployment-rule-app: + title: Custom deployment protection rule app + description: A GitHub App that is providing a custom deployment protection rule. + type: object + properties: + id: + type: integer + example: 3515 + description: The unique identifier of the deployment protection rule integration. + slug: + type: string + example: my-custom-app + description: The slugified name of the deployment protection rule integration. + integration_url: + type: string + example: https://api.github.com/apps/custom-app-slug + description: The URL for the endpoint to get details about the app. + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + description: The node ID for the deployment protection rule integration. + required: + - id + - slug + - integration_url + - node_id + hook: + title: Webhook + description: Webhooks for repositories. + type: object + properties: + type: + type: string + id: + description: Unique identifier of the webhook. + example: 42 + type: integer + name: + description: The name of a valid service, use 'web' for a webhook. + example: web + type: string + active: + description: Determines whether the hook is actually triggered on pushes. + type: boolean + example: true + events: + description: 'Determines what events the hook is triggered for. Default: [''push''].' + type: array + items: + type: string + example: + - push + - pull_request + config: + $ref: '#/components/schemas/webhook-config' + updated_at: + type: string + format: date-time + example: '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + example: '2011-09-06T17:26:27Z' + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1 + test_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test + ping_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + deliveries_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + last_response: + $ref: '#/components/schemas/hook-response' + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + - last_response + - test_url + webhook-config-url: + type: string + description: The URL to which the payloads will be delivered. + example: https://example.com/webhook + format: uri + webhook-config-content-type: + type: string + description: >- + The media type used to serialize the payloads. Supported values include + `json` and `form`. The default is `form`. + example: '"json"' + webhook-config-secret: + type: string + description: >- + If provided, the `secret` will be used as the `key` to generate the HMAC + hex digest value for [delivery signature + headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + example: '"********"' + webhook-config-insecure-ssl: + type: string + description: >- + Determines whether the SSL certificate of the host for `url` will be + verified when delivering payloads. Supported values include `0` + (verification is performed) and `1` (verification is not performed). The + default is `0`. **We strongly recommend not setting this to `1` as you + are subject to man-in-the-middle and other attacks.** + example: '"0"' + webhook-config: + title: Webhook Configuration + description: Configuration object of the webhook + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + hook-delivery-item: + title: Simple webhook delivery + description: Delivery made by a webhook, without request and response information. + type: object + properties: + id: + description: Unique identifier of the webhook delivery. + type: integer + format: int64 + example: 42 + guid: + description: >- + Unique identifier for the event (shared with all deliveries for all + webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + hook-delivery: + title: Webhook delivery + description: Delivery made by a webhook. + type: object + properties: + id: + description: Unique identifier of the delivery. + type: integer + example: 42 + guid: + description: >- + Unique identifier for the event (shared with all deliveries for all + webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Description of the status of the attempted delivery + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + url: + description: The URL target of the delivery. + type: string + example: https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: object + nullable: true + additionalProperties: true + payload: + description: The webhook payload. + type: object + nullable: true + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: object + nullable: true + additionalProperties: true + payload: + description: The response payload received. + type: string + nullable: true + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + check-immutable-releases: + title: Check immutable releases + description: Check immutable releases + type: object + properties: + enabled: + type: boolean + example: true + description: Whether immutable releases are enabled for the repository. + enforced_by_owner: + type: boolean + example: false + description: Whether immutable releases are enforced by the repository owner. + required: + - enabled + - enforced_by_owner + deploy-key: + title: Deploy Key + description: An SSH key granting access to a single repository. + type: object + properties: + id: + type: integer + key: + type: string + url: + type: string + title: + type: string + verified: + type: boolean + created_at: + type: string + read_only: + type: boolean + added_by: + type: string + nullable: true + last_used: + nullable: true + type: string + format: date-time + enabled: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + language: + title: Language + description: Language + type: object + additionalProperties: + type: integer + merged-upstream: + title: Merged upstream + description: Results of a successful merge upstream request + type: object + properties: + message: + type: string + merge_type: + type: string + enum: + - merge + - fast-forward + - none + base_branch: + type: string + page: + title: GitHub Pages + description: The configuration for GitHub Pages for a repository. + type: object + properties: + url: + type: string + description: The API address for accessing this Page resource. + format: uri + example: https://api.github.com/repos/github/hello-world/pages + status: + type: string + description: The status of the most recent build of the Page. + example: built + enum: + - built + - building + - errored + nullable: true + cname: + description: The Pages site's custom domain + example: example.com + type: string + nullable: true + protected_domain_state: + type: string + description: The state if the domain is verified + example: pending + nullable: true + enum: + - pending + - verified + - unverified + pending_domain_unverified_at: + type: string + description: The timestamp when a pending domain becomes unverified. + nullable: true + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + example: false + default: false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + example: https://example.com + build_type: + type: string + description: The process in which the Page will be built. + example: legacy + nullable: true + enum: + - legacy + - workflow + source: + $ref: '#/components/schemas/pages-source-hash' + public: + type: boolean + description: >- + Whether the GitHub Pages site is publicly visible. If set to `true`, + the site is accessible to anyone on the internet. If set to `false`, + the site will only be accessible to users who have at least `read` + access to the repository that published the site. + example: true + https_certificate: + $ref: '#/components/schemas/pages-https-certificate' + https_enforced: + type: boolean + description: Whether https is enabled on the domain + example: true + required: + - url + - status + - cname + - custom_404 + - public + page-build: + title: Page Build + description: Page Build + type: object + properties: + url: + type: string + format: uri + status: + type: string + error: + type: object + properties: + message: + type: string + nullable: true + required: + - message + pusher: + $ref: '#/components/schemas/nullable-simple-user' + commit: + type: string + duration: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - url + - status + - error + - pusher + - commit + - duration + - created_at + - updated_at + page-build-status: + title: Page Build Status + description: Page Build Status + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + example: queued + required: + - url + - status + page-deployment: + title: GitHub Pages + description: The GitHub Pages deployment status. + type: object + properties: + id: + description: >- + The ID of the GitHub Pages deployment. This is the Git SHA of the + deployed commit. + type: integer + status_url: + type: string + description: The URI to monitor GitHub Pages deployment status. + format: uri + example: >- + https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + page_url: + type: string + description: The URI to the deployed GitHub Pages. + format: uri + example: hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + example: monalisa-1231a2312sa32-23sda74.drafts.github.io + required: + - id + - status_url + - page_url + pages-deployment-status: + title: GitHub Pages deployment status + type: object + properties: + status: + type: string + description: The current status of the deployment. + enum: + - deployment_in_progress + - syncing_files + - finished_file_sync + - updating_pages + - purging_cdn + - deployment_cancelled + - deployment_failed + - deployment_content_failed + - deployment_attempt_error + - deployment_lost + - succeed + pages-health-check: + title: Pages Health Check Status + description: Pages Health Check Status + type: object + properties: + domain: + type: object + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: boolean + nullable: true + is_cloudflare_ip: + type: boolean + nullable: true + is_fastly_ip: + type: boolean + nullable: true + is_old_ip_address: + type: boolean + nullable: true + is_a_record: + type: boolean + nullable: true + has_cname_record: + type: boolean + nullable: true + has_mx_records_present: + type: boolean + nullable: true + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: boolean + nullable: true + is_cname_to_github_user_domain: + type: boolean + nullable: true + is_cname_to_pages_dot_github_dot_com: + type: boolean + nullable: true + is_cname_to_fastly: + type: boolean + nullable: true + is_pointed_to_github_pages_ip: + type: boolean + nullable: true + is_non_github_pages_ip_present: + type: boolean + nullable: true + is_pages_domain: + type: boolean + is_served_by_pages: + type: boolean + nullable: true + is_valid: + type: boolean + reason: + type: string + nullable: true + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: string + nullable: true + is_https_eligible: + type: boolean + nullable: true + caa_error: + type: string + nullable: true + alt_domain: + type: object + nullable: true + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: boolean + nullable: true + is_cloudflare_ip: + type: boolean + nullable: true + is_fastly_ip: + type: boolean + nullable: true + is_old_ip_address: + type: boolean + nullable: true + is_a_record: + type: boolean + nullable: true + has_cname_record: + type: boolean + nullable: true + has_mx_records_present: + type: boolean + nullable: true + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: boolean + nullable: true + is_cname_to_github_user_domain: + type: boolean + nullable: true + is_cname_to_pages_dot_github_dot_com: + type: boolean + nullable: true + is_cname_to_fastly: + type: boolean + nullable: true + is_pointed_to_github_pages_ip: + type: boolean + nullable: true + is_non_github_pages_ip_present: + type: boolean + nullable: true + is_pages_domain: + type: boolean + is_served_by_pages: + type: boolean + nullable: true + is_valid: + type: boolean + reason: + type: string + nullable: true + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: string + nullable: true + is_https_eligible: + type: boolean + nullable: true + caa_error: + type: string + nullable: true + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + description: The value assigned to the property + nullable: true + type: string + items: + type: string + required: + - property_name + - value + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: >- + Specifies the commitish value that determines where the Git tag is + created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: >- + true to create a draft (unpublished) release, false to create a + published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + example: Team Environment + label: + type: string + nullable: true + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: string + nullable: true + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + $ref: '#/components/schemas/nullable-simple-user' + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release-notes-content: + title: Generated Release Notes Content + description: Generated name and body describing a release + type: object + properties: + name: + description: The generated name of the release + type: string + example: Release v1.0.0 is now available! + body: + description: >- + The generated body describing the contents of the release supporting + markdown formatting + type: string + required: + - name + - body + repository-rule-detailed: + title: Repository Rule + type: object + description: A repository rule with ruleset details. + required: + - type + properties: + type: + type: string + enum: + - creation + ruleset_source_type: + type: string + description: The type of source for the ruleset that includes this rule. + enum: + - Repository + - Organization + ruleset_source: + type: string + description: The name of the source of the ruleset that includes this rule. + ruleset_id: + type: integer + description: The ID of the ruleset that includes this rule. + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + repository-ruleset-conditions: + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: >- + Array of ref names or patterns to include. One of these patterns + must match for the condition to pass. Also accepts + `~DEFAULT_BRANCH` to include the default branch or `~ALL` to + include all branches. + items: + type: string + exclude: + type: array + description: >- + Array of ref names or patterns to exclude. The condition will + not pass if any of these patterns match. + items: + type: string + repository-rule: + title: Repository Rule + type: object + description: A repository rule. + required: + - type + properties: + type: + type: string + enum: + - creation + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + ruleset-version: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + ruleset-version-with-state: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + - state + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + state: + type: string + description: The state of the ruleset version (opaque JSON object) + code-frequency-stat: + title: Code Frequency Stat + description: Code Frequency Stat + type: array + items: + type: integer + commit-activity: + title: Commit Activity + description: Commit Activity + type: object + properties: + days: + type: array + example: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + items: + type: integer + total: + type: integer + example: 89 + week: + type: integer + example: 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + $ref: '#/components/schemas/nullable-simple-user' + total: + type: integer + example: 135 + weeks: + type: array + example: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + required: + - author + - total + - weeks + participation-stats: + title: Participation Stats + type: object + properties: + all: + type: array + items: + type: integer + owner: + type: array + items: + type: integer + required: + - all + - owner + tag: + title: Tag + description: Tag + type: object + properties: + name: + type: string + example: v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + topic: + title: Topic + description: A topic aggregates entities that are related to a subject. + type: object + properties: + names: + type: array + items: + type: string + required: + - names + clone-traffic: + title: Clone Traffic + description: Clone Traffic + type: object + properties: + count: + type: integer + example: 173 + uniques: + type: integer + example: 128 + clones: + type: array + items: + $ref: '#/components/schemas/traffic' + required: + - uniques + - count + - clones + content-traffic: + title: Content Traffic + description: Content Traffic + type: object + properties: + path: + type: string + example: /github/hubot + title: + type: string + example: 'github/hubot: A customizable life embetterment robot.' + count: + type: integer + example: 3542 + uniques: + type: integer + example: 2225 + required: + - path + - title + - uniques + - count + referrer-traffic: + title: Referrer Traffic + description: Referrer Traffic + type: object + properties: + referrer: + type: string + example: Google + count: + type: integer + example: 4 + uniques: + type: integer + example: 3 + required: + - referrer + - uniques + - count + view-traffic: + title: View Traffic + description: View Traffic + type: object + properties: + count: + type: integer + example: 14850 + uniques: + type: integer + example: 3782 + views: + type: array + items: + $ref: '#/components/schemas/traffic' + required: + - uniques + - count + - views + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + repository-ruleset-conditions-repository-name-target: + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: >- + Array of repository names or patterns to include. One of these + patterns must match for the condition to pass. Also accepts + `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: >- + Array of repository names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + required: + - repository_name + repository-ruleset-conditions-repository-id-target: + title: Repository ruleset conditions for repository IDs + type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: >- + The repository IDs that the ruleset applies to. One of these IDs + must match for the condition to pass. + items: + type: integer + required: + - repository_id + repository-ruleset-conditions-repository-property-target: + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: >- + The repository properties and values to include. All of these + properties must match for the condition to pass. + items: + $ref: >- + #/components/schemas/repository-ruleset-conditions-repository-property-spec + exclude: + type: array + description: >- + The repository properties and values to exclude. The condition + will not pass if any of these properties match. + items: + $ref: >- + #/components/schemas/repository-ruleset-conditions-repository-property-spec + required: + - repository_property + repository-rule-creation: + title: creation + description: Only allow users with bypass permission to create matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + repository-rule-update: + title: update + description: Only allow users with bypass permission to update matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - update + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + repository-rule-deletion: + title: deletion + description: Only allow users with bypass permissions to delete matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + repository-rule-required-linear-history: + title: required_linear_history + description: Prevent merge commits from being pushed to matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_linear_history + repository-rule-required-deployments: + title: required_deployments + description: >- + Choose which environments must be successfully deployed to before refs + can be pushed into a ref that matches this rule. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_deployments + parameters: + type: object + properties: + required_deployment_environments: + type: array + description: >- + The environments that must be successfully deployed to before + branches can be merged. + items: + type: string + required: + - required_deployment_environments + repository-rule-required-signatures: + title: required_signatures + description: Commits pushed to matching refs must have verified signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + repository-rule-pull-request: + title: pull_request + description: >- + Require all commits be made to a non-target branch and submitted via a + pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + allowed_merge_methods: + type: array + description: >- + Array of allowed merge methods. Allowed values include `merge`, + `squash`, and `rebase`. At least one option must be enabled. + items: + type: string + enum: + - merge + - squash + - rebase + dismiss_stale_reviews_on_push: + type: boolean + description: >- + New, reviewable commits pushed will dismiss previous pull + request review approvals. + require_code_owner_review: + type: boolean + description: >- + Require an approving review in pull requests that modify files + that have a designated code owner. + require_last_push_approval: + type: boolean + description: >- + Whether the most recent reviewable push must be approved by + someone other than the person who pushed it. + required_approving_review_count: + type: integer + description: >- + The number of approving reviews that are required before a pull + request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: + type: boolean + description: >- + All conversations on code must be resolved before a pull request + can be merged. + required_reviewers: + type: array + description: >- + > [!NOTE] + + > `required_reviewers` is in beta and subject to change. + + + A collection of reviewers and associated file patterns. Each + reviewer has a list of file patterns which determine the files + that reviewer is required to review. + items: + $ref: >- + #/components/schemas/repository-rule-params-required-reviewer-configuration + required: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + repository-rule-required-status-checks: + title: required_status_checks + description: >- + Choose which status checks must pass before the ref is updated. When + enabled, commits must first be pushed to another ref where the checks + pass. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_status_checks + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: >- + Allow repositories and branches to be created if a check would + otherwise prohibit it. + required_status_checks: + type: array + description: Status checks that are required. + items: + $ref: >- + #/components/schemas/repository-rule-params-status-check-configuration + strict_required_status_checks_policy: + type: boolean + description: >- + Whether pull requests targeting a matching branch must be tested + with the latest code. This setting will not take effect unless + at least one status check is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + repository-rule-non-fast-forward: + title: non_fast_forward + description: Prevent users with push access from force pushing to refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - non_fast_forward + repository-rule-commit-message-pattern: + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-commit-author-email-pattern: + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-committer-email-pattern: + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-branch-name-pattern: + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-tag-name-pattern: + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-file-path-restriction: + title: file_path_restriction + description: >- + Prevent commits that include changes in specified file and folder paths + from being pushed to the commit graph. This includes absolute paths that + contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: >- + The file paths that are restricted from being pushed to the + commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: >- + Prevent commits that include file paths that exceed the specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: >- + Prevent commits that include files with specified file extensions from + being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: >- + The file extensions that are restricted from being pushed to the + commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: >- + Prevent commits with individual files that exceed the specified limit + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: >- + The maximum file size allowed in megabytes. This limit does not + apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + repository-rule-workflows: + title: workflows + description: >- + Require all changes made to a targeted branch to pass the specified + workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: >- + Allow repositories and branches to be created if a check would + otherwise prohibit it. + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + $ref: >- + #/components/schemas/repository-rule-params-workflow-file-reference + required: + - workflows + repository-rule-code-scanning: + title: code_scanning + description: >- + Choose which tools must provide code scanning results before the + reference is updated. When configured, code scanning must be enabled and + have results for both the commit and the reference being updated. + type: object + required: + - type + properties: + type: + type: string + enum: + - code_scanning + parameters: + type: object + properties: + code_scanning_tools: + type: array + description: >- + Tools that must provide code scanning results for this rule to + pass. + items: + $ref: '#/components/schemas/repository-rule-params-code-scanning-tool' + required: + - code_scanning_tools + repository-rule-copilot-code-review: + title: copilot_code_review + description: >- + Request Copilot code review for new pull requests automatically if the + author has access to Copilot code review and their premium requests + quota has not reached the limit. + type: object + required: + - type + properties: + type: + type: string + enum: + - copilot_code_review + parameters: + type: object + properties: + review_draft_pull_requests: + type: boolean + description: >- + Copilot automatically reviews draft pull requests before they + are marked as ready for review. + review_on_push: + type: boolean + description: Copilot automatically reviews each new push to the pull request. + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + protected-branch-required-status-check: + title: Protected Branch Required Status Check + description: Protected Branch Required Status Check + type: object + properties: + url: + type: string + enforcement_level: + type: string + contexts: + type: array + items: + type: string + checks: + type: array + items: + type: object + properties: + context: + type: string + app_id: + type: integer + nullable: true + required: + - context + - app_id + contexts_url: + type: string + strict: + type: boolean + required: + - contexts + - checks + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + nullable-collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + email: + nullable: true + type: string + name: + nullable: true + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - push + - admin + role_name: + type: string + example: admin + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - role_name + nullable: true + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + nullable-git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' + nullable: true + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + nullable: true + example: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + example: file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + example: added + additions: + type: integer + example: 103 + deletions: + type: integer + example: 21 + changes: + type: integer + example: 124 + blob_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + example: >- + https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + example: >- + https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + example: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + previous_filename: + type: string + example: file.txt + required: + - additions + - blob_url + - changes + - contents_url + - deletions + - filename + - raw_url + - sha + - status + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + $ref: '#/components/schemas/simple-user' + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + simple-commit-status: + title: Simple Commit Status + type: object + properties: + description: + type: string + nullable: true + id: + type: integer + node_id: + type: string + state: + type: string + context: + type: string + target_url: + type: string + format: uri + nullable: true + required: + type: boolean + nullable: true + avatar_url: + type: string + nullable: true + format: uri + url: + type: string + format: uri + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - description + - id + - node_id + - state + - context + - target_url + - avatar_url + - url + - created_at + - updated_at + nullable-code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + nullable: true + nullable-community-health-file: + title: Community Health File + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - url + - html_url + nullable: true + secret-scanning-push-protection-bypass-placeholder-id: + description: >- + The ID of the push protection bypass placeholder. This value is returned + on any push protected routes. + type: string + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + hook-response: + title: Hook Response + type: object + properties: + code: + type: integer + nullable: true + status: + type: string + nullable: true + message: + type: string + nullable: true + required: + - code + - status + - message + pages-source-hash: + title: Pages Source Hash + type: object + properties: + branch: + type: string + path: + type: string + required: + - branch + - path + pages-https-certificate: + title: Pages Https Certificate + type: object + properties: + state: + type: string + enum: + - new + - authorization_created + - authorization_pending + - authorized + - authorization_revoked + - issued + - uploaded + - approved + - errored + - bad_authz + - destroy_pending + - dns_changed + example: approved + description: + type: string + example: Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + example: + - example.com + - www.example.com + expires_at: + type: string + format: date + required: + - state + - description + - domains + repository-rule-ruleset-info: + title: repository ruleset data for rule + description: >- + User-defined metadata to store domain-specific information limited to 8 + keys with scalar values. + properties: + ruleset_source_type: + type: string + description: The type of source for the ruleset that includes this rule. + enum: + - Repository + - Organization + ruleset_source: + type: string + description: The name of the source of the ruleset that includes this rule. + ruleset_id: + type: integer + description: The ID of the ruleset that includes this rule. + type: object + repository-rule-merge-queue: + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: >- + Maximum time for a required status check to report a conclusion. + After this much time has elapsed, checks that have not reported + a conclusion will be assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: >- + When set to ALLGREEN, the merge commit created by merge queue + for each PR in the group must pass all required checks to merge. + When set to HEADGREEN, only the commit at the head of the merge + group, i.e. the commit containing changes from all of the PRs in + the group, must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: >- + Limit the number of queued pull requests requesting checks and + workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: >- + The maximum number of PRs that will be merged together in a + group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: >- + The minimum number of PRs that will be merged together in a + group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: >- + The time merge queue should wait after the first PR is added to + the queue for the minimum group size to be met. After this time + has elapsed, the minimum group size will be ignored and a + smaller group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes + traffic: + title: Traffic + type: object + properties: + timestamp: + type: string + format: date-time + uniques: + type: integer + count: + type: integer + required: + - timestamp + - uniques + - count + repository-ruleset-conditions-repository-property-spec: + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository property + properties: + name: + type: string + description: The name of the repository property to target + property_values: + type: array + description: The values to match for the repository property + items: + type: string + source: + type: string + description: >- + The source of the repository property. Defaults to 'custom' if not + specified. + enum: + - custom + - system + required: + - name + - property_values + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: >- + A reviewing team, and file patterns describing which files they must + approve changes to. + type: object + properties: + file_patterns: + type: array + description: >- + Array of file patterns. Pull requests which change matching files + must be approved by the specified team. File patterns use fnmatch + syntax. + items: + type: string + minimum_approvals: + type: integer + description: >- + Minimum number of approvals required from the specified team. If set + to zero, the team will be added to the pull request but approval is + optional. + reviewer: + $ref: '#/components/schemas/repository-rule-params-reviewer' + required: + - file_patterns + - minimum_approvals + - reviewer + repository-rule-params-status-check-configuration: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: + type: string + description: The status check context name that must be present on the commit. + integration_id: + type: integer + description: >- + The optional integration ID that this status check must originate + from. + required: + - context + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: + type: string + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-params-code-scanning-tool: + title: CodeScanningTool + description: A tool that must provide code scanning results for this rule to pass. + type: object + properties: + alerts_threshold: + type: string + description: >- + The severity level at which code scanning results that raise alerts + block a reference update. For more information on alert severity + levels, see "[About code scanning + alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: >- + The severity level at which code scanning results that raise + security alerts block a reference update. For more information on + security severity levels, see "[About code scanning + alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + repository-rule-params-reviewer: + title: Reviewer + description: A required reviewing team + type: object + properties: + id: + type: integer + description: ID of the reviewer which must review changes to matching files. + type: + type: string + description: The type of the reviewer + enum: + - Team + required: + - id + - type + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + temporary_redirect: + description: Temporary Redirect + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + found: + description: Found + not_modified: + description: Not modified + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + no_content: + description: A header with no content is returned. + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + ruleset-targets: + name: targets + description: > + A comma-separated list of rule targets to filter by. + + If provided, only rulesets that apply to the specified targets will be + returned. + + For example, `branch,tag,push`. + in: query + required: false + schema: + type: string + example: branch,tag,push + ref-in-query: + name: ref + description: >- + The name of the ref. Cannot contain wildcard characters. Optionally + prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit + to tags. Omit the prefix to search across all refs. When specified, only + rule evaluations triggered for this ref will be returned. + in: query + schema: + type: string + x-multi-segment: true + repository-name-in-query: + name: repository_name + description: The name of the repository to filter on. + in: query + schema: + type: string + time-period: + name: time_period + description: >- + The time period to filter by. + + + For example, `day` will filter for rule suites that occurred in the past + 24 hours, and `week` will filter for rule suites that occurred in the + past 7 days (168 hours). + in: query + required: false + schema: + type: string + enum: + - hour + - day + - week + - month + default: day + actor-name-in-query: + name: actor_name + description: >- + The handle for the GitHub user account to filter on. When specified, + only rule evaluations triggered by this actor will be returned. + in: query + schema: + type: string + rule-suite-result: + name: rule_suite_result + description: >- + The rule suite results to filter on. When specified, only suites with + this result will be returned. + in: query + schema: + type: string + enum: + - pass + - fail + - bypass + - all + default: all + rule-suite-id: + name: rule_suite_id + description: >- + The unique identifier of the rule suite result. + + To get this ID, you can use [GET + /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + + for repositories and [GET + /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + + for organizations. + in: path + required: true + schema: + type: integer + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + autolink-id: + name: autolink_id + description: The unique identifier of the autolink. + in: path + required: true + schema: + type: integer + branch: + name: branch + description: >- + The name of the branch. Cannot contain wildcard characters. To use + wildcard characters in branch names, use [the GraphQL + API](https://docs.github.com/graphql). + in: path + required: true + schema: + type: string + x-multi-segment: true + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + commit-sha: + name: commit_sha + description: The SHA of the commit. + in: path + required: true + schema: + type: string + x-multi-segment: true + commit-ref: + name: ref + description: >- + The commit reference. Can be a commit SHA, branch name + (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more + information, see "[Git + References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + in: path + required: true + schema: + type: string + x-multi-segment: true + deployment-id: + name: deployment_id + description: deployment_id parameter + in: path + required: true + schema: + type: integer + environment-name: + name: environment_name + in: path + required: true + description: >- + The name of the environment. The name must be URL encoded. For example, + any slashes in the name must be replaced with `%2F`. + schema: + type: string + branch-policy-id: + name: branch_policy_id + in: path + required: true + description: The unique identifier of the branch policy. + schema: + type: integer + protection-rule-id: + name: protection_rule_id + description: The unique identifier of the protection rule. + in: path + required: true + schema: + type: integer + hook-id: + name: hook_id + description: >- + The unique identifier of the hook. You can find this value in the + `X-GitHub-Hook-ID` header of a webhook delivery. + in: path + required: true + schema: + type: integer + cursor: + name: cursor + description: >- + Used for pagination: the starting delivery from which the page of + deliveries is fetched. Refer to the `link` header for the next and + previous page cursors. + in: query + required: false + schema: + type: string + webhook-delivery-status: + name: status + description: >- + Returns webhook deliveries filtered by delivery outcome classification + based on `status_code` range. A `status` of `success` returns deliveries + with a `status_code` in the 200-399 range (inclusive). A `status` of + `failure` returns deliveries with a `status_code` in the 400-599 range + (inclusive). + in: query + required: false + schema: + type: string + enum: + - success + - failure + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + in: path + required: true + schema: + type: integer + key-id: + name: key_id + description: The unique identifier of the key. + in: path + required: true + schema: + type: integer + pages-deployment-id: + name: pages_deployment_id + description: >- + The ID of the Pages deployment. You can also give the commit SHA of the + deployment. + in: path + required: true + schema: + oneOf: + - type: integer + - type: string + asset-id: + name: asset_id + description: The unique identifier of the asset. + in: path + required: true + schema: + type: integer + release-id: + name: release_id + description: The unique identifier of the release. + in: path + required: true + schema: + type: integer + per: + name: per + description: The time frame to display results for. + in: query + required: false + schema: + type: string + enum: + - day + - week + default: day + since-repo: + name: since + description: >- + A repository ID. Only return repositories with an ID greater than this + ID. + in: query + required: false + schema: + type: integer + since-repo-date: + name: since + description: >- + Only show repositories updated after the given time. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + before-repo-date: + name: before + description: >- + Only show repositories updated before the given time. This is a + timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + `YYYY-MM-DDTHH:MM:SSZ`. + in: query + required: false + schema: + type: string + format: date-time + examples: + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + full-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: null + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + org-ruleset-items: + value: + - id: 21 + name: super cool ruleset + source_type: Organization + source: my-org + enforcement: enabled + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/orgs/my-org/rulesets/21 + html: + href: https://github.com/organizations/my-org/settings/rules/21 + created_at: '2023-07-15T08:43:03Z' + updated_at: '2023-08-23T16:29:47Z' + - id: 432 + name: Another ruleset + source_type: Organization + source: my-org + enforcement: enabled + node_id: RRS_lACkVXNlcgQQ + _links: + self: + href: https://api.github.com/orgs/my-org/rulesets/432 + html: + href: https://github.com/organizations/my-org/settings/rules/432 + created_at: '2023-08-15T08:43:03Z' + updated_at: '2023-09-23T16:29:47Z' + org-ruleset: + value: + id: 21 + name: super cool ruleset + target: branch + source_type: Organization + source: my-org + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/orgs/my-org/rulesets/21 + html: + href: https://github.com/organizations/my-org/settings/rules/21 + created_at: '2023-08-15T08:43:03Z' + updated_at: '2023-09-23T16:29:47Z' + rule-suite-items: + value: + - id: 21 + actor_id: 12 + actor_name: octocat + before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d + after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 + ref: refs/heads/i-see-everything + repository_id: 404 + repository_name: octo-repo + pushed_at: '2023-07-06T08:43:03Z' + result: bypass + - id: 25 + actor_id: 11 + actor_name: not-octocat + before_sha: 48994e4e01ccc943624c6231f172702b82b233cc + after_sha: ecfd5a1025fa271a33ca5608d089476a2df3c9a1 + ref: refs/heads/i-am-everything + repository_id: 404 + repository_name: octo-repo + pushed_at: '2023-07-07T08:43:03Z' + result: pass + evaluation_result: fail + rule-suite: + value: + id: 21 + actor_id: 12 + actor_name: octocat + before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d + after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 + ref: refs/heads/i-see-everything + repository_id: 404 + repository_name: octo-repo + pushed_at: '2023-07-06T08:43:03Z' + result: bypass + evaluation_result: fail + rule_evaluations: + - rule_source: + type: ruleset + id: 2 + name: Author email must be a GitHub email address + enforcement: active + result: pass + rule_type: commit_author_email_pattern + - rule_source: + type: protected_branch + enforcement: active + result: fail + rule_type: pull_request + details: Changes must be made through a pull request. + - rule_source: + type: ruleset + id: 3 + name: Evaluate commit message pattern + enforcement: evaluate + result: fail + rule_type: commit_message_pattern + full-repository-default-response: + summary: Default response + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_bypass: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + activity-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: 6dcb09b5b57875f334f61aebed695e2e4193db5e + after: 827efc6d56897b048c772eb4087f854f46256132 + ref: refs/heads/main + pushed_at: '2011-01-26T19:06:43Z' + push_type: normal + pusher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + attestation: + value: + bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + autolink-items: + value: + - id: 1 + key_prefix: TICKET- + url_template: https://example.com/TICKET?query= + is_alphanumeric: true + autolink: + value: + id: 1 + key_prefix: TICKET- + url_template: https://example.com/TICKET?query= + is_alphanumeric: true + short-branch-with-protection-items: + value: + - name: master + commit: + sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + protected: true + protection: + required_status_checks: + enforcement_level: non_admins + contexts: + - ci-test + - linter + protection_url: >- + https://api.github.com/repos/octocat/hello-world/branches/master/protection + branch-get: + value: + name: main + commit: + sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + node_id: >- + MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk + commit: + author: + name: The Octocat + email: octocat@nowhere.com + date: '2012-03-06T23:06:50Z' + committer: + name: The Octocat + email: octocat@nowhere.com + date: '2012-03-06T23:06:50Z' + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + tree: + sha: b4eecafa9be2f2006ce1b709d6857b07069b4608 + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608 + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + comment_count: 77 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + html_url: >- + https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments + author: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - sha: 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + html_url: >- + https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + - sha: 762941318ee16e59dabbacb1b4049eec22f0d303 + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303 + html_url: >- + https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303 + _links: + self: https://api.github.com/repos/octocat/Hello-World/branches/main + html: https://github.com/octocat/Hello-World/tree/main + protected: false + protection: + enabled: false + required_status_checks: + enforcement_level: 'off' + contexts: [] + checks: [] + protection_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/main/protection + branch-protection: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection + required_status_checks: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + contexts: + - continuous-integration/travis-ci + contexts_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + enforcement_level: non_admins + enforce_admins: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: true + required_pull_request_reviews: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews + dismissal_restrictions: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + users_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users + teams_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + restrictions: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions + users_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users + teams_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams + apps_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + required_linear_history: + enabled: true + allow_force_pushes: + enabled: true + allow_deletions: + enabled: true + required_conversation_resolution: + enabled: true + lock_branch: + enabled: true + allow_fork_syncing: + enabled: true + branch-protection-update: + value: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection + required_status_checks: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks + strict: true + contexts: + - continuous-integration/travis-ci + contexts_url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts + checks: + - context: continuous-integration/travis-ci + app_id: null + restrictions: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions + users_url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users + teams_url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams + apps_url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps + users: [] + teams: [] + apps: [] + required_pull_request_reviews: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + dismissal_restrictions: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions + users_url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users + teams_url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams + users: [] + teams: [] + apps: [] + required_signatures: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures + enabled: false + enforce_admins: + url: >- + https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins + enabled: true + required_linear_history: + enabled: true + allow_force_pushes: + enabled: true + allow_deletions: + enabled: true + block_creations: + enabled: true + required_conversation_resolution: + enabled: true + lock_branch: + enabled: true + allow_fork_syncing: + enabled: true + protected-branch-admin-enforced-2: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: true + protected-branch-pull-request-review: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews + dismissal_restrictions: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + users_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users + teams_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + protected-branch-admin-enforced: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: true + status-check-policy: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: true + contexts: + - continuous-integration/travis-ci + contexts_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + branch-restriction-policy: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions + users_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users + teams_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams + apps_url: >- + https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + integration-items: + value: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + branch-with-protection: + value: + name: master + commit: + sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + node_id: MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA== + commit: + author: + name: The Octocat + date: '2012-03-06T15:06:50-08:00' + email: octocat@nowhere.com + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + tree: + sha: b4eecafa9be2f2006ce1b709d6857b07069b4608 + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608 + committer: + name: The Octocat + date: '2012-03-06T15:06:50-08:00' + email: octocat@nowhere.com + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + comment_count: 0 + author: + gravatar_id: '' + avatar_url: >- + https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png + url: https://api.github.com/users/octocat + id: 583231 + login: octocat + node_id: MDQ6VXNlcjE= + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + parents: + - sha: 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + - sha: 762941318ee16e59dabbacb1b4049eec22f0d303 + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303 + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + committer: + gravatar_id: '' + avatar_url: >- + https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png + url: https://api.github.com/users/octocat + id: 583231 + login: octocat + node_id: MDQ6VXNlcjE= + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + _links: + html: https://github.com/octocat/Hello-World/tree/master + self: https://api.github.com/repos/octocat/Hello-World/branches/master + protected: true + protection: + required_status_checks: + enforcement_level: non_admins + contexts: + - ci-test + - linter + protection_url: >- + https://api.github.com/repos/octocat/hello-world/branches/master/protection + codeowners-errors: + value: + errors: + - line: 3 + column: 1 + kind: Invalid pattern + source: '***/*.rb @monalisa' + suggestion: Did you mean `**/*.rb`? + message: |- + Invalid pattern on line 3: Did you mean `**/*.rb`? + + ***/*.rb @monalisa + ^ + path: .github/CODEOWNERS + - line: 7 + column: 7 + kind: Invalid owner + source: '*.txt docs@' + suggestion: null + message: |- + Invalid owner on line 7: + + *.txt docs@ + ^ + path: .github/CODEOWNERS + collaborator-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: + pull: true + triage: true + push: true + maintain: false + admin: false + role_name: write + repository-invitation-response-when-a-new-invitation-is-created: + value: + id: 1 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + invitee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + inviter: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: write + created_at: '2016-06-13T14:52:50-05:00' + url: https://api.github.com/user/repository_invitations/1296269 + html_url: https://github.com/octocat/Hello-World/invitations + repository-collaborator-permission-response-if-user-has-admin-permissions: + value: + permission: admin + role_name: admin + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + commit-comment-items: + value: + - html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 + url: https://api.github.com/repos/octocat/Hello-World/comments/1 + id: 1 + node_id: MDEzOkNvbW1pdENvbW1lbnQx + body: Great stuff + path: file1.txt + position: 4 + line: 14 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + author_association: COLLABORATOR + commit-comment: + value: + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 + url: https://api.github.com/repos/octocat/Hello-World/comments/1 + id: 1 + node_id: MDEzOkNvbW1pdENvbW1lbnQx + body: Great stuff + path: file1.txt + position: 4 + line: 14 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: COLLABORATOR + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + commit-comment-2: + value: + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 + url: https://api.github.com/repos/octocat/Hello-World/comments/1 + id: 1 + node_id: MDEzOkNvbW1pdENvbW1lbnQx + body: Nice change + path: file1.txt + position: 4 + line: 14 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: COLLABORATOR + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + commit-items: + value: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + branch-short-items: + value: + - name: branch_5 + commit: + sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + protected: false + pull-request-simple-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: >- + https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + commit: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + stats: + additions: 104 + deletions: 4 + total: 108 + files: + - filename: file1.txt + additions: 10 + deletions: 2 + changes: 12 + status: modified + raw_url: >- + https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt + blob_url: >- + https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt + patch: |- + @@ -29,7 +29,7 @@ + ..... + diff-media-type: + value: | + diff --git a/testfile b/testfile + index 9bdeaeb..912c7ef 100644 + --- a/testfile + +++ b/testfile + @@ -1 +1 @@ + -test + +test change + patch-media-type: + value: | + From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 + From: Mona Lisa <87831417+monalisa@users.noreply.github.com> + Date: Fri, 6 Mar 2026 11:18:45 +0000 + Subject: [PATCH] Change 'test' to 'test change' in testfile + + --- + testfile | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + + diff --git a/testfile b/testfile + index 9bdeaeb..912c7ef 100644 + --- a/testfile + +++ b/testfile + @@ -1 +1 @@ + -test + +test change + combined-commit-status: + value: + state: success + statuses: + - url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/hubot_happy.gif + id: 1 + node_id: MDY6U3RhdHVzMQ== + state: success + description: Build has completed successfully + target_url: https://ci.example.com/1000/output + context: continuous-integration/jenkins + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + - url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/other_user_happy.gif + id: 2 + node_id: MDY6U3RhdHVzMg== + state: success + description: Testing has completed successfully + target_url: https://ci.example.com/2000/output + context: security/brakeman + created_at: '2012-08-20T01:19:13Z' + updated_at: '2012-08-20T01:19:13Z' + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + total_count: 2 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + commit_url: >- + https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e + url: >- + https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status + status-items: + value: + - url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/hubot_happy.gif + id: 1 + node_id: MDY6U3RhdHVzMQ== + state: success + description: Build has completed successfully + target_url: https://ci.example.com/1000/output + context: continuous-integration/jenkins + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + community-profile: + value: + health_percentage: 100 + description: My first repository on GitHub! + documentation: null + files: + code_of_conduct: + name: Contributor Covenant + key: contributor_covenant + url: https://api.github.com/codes_of_conduct/contributor_covenant + html_url: >- + https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md + code_of_conduct_file: + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md + html_url: >- + https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md + contributing: + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING + html_url: https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING + issue_template: + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE + html_url: https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE + pull_request_template: + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE + html_url: >- + https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE + license: + name: MIT License + key: mit + spdx_id: MIT + url: https://api.github.com/licenses/mit + html_url: https://github.com/octocat/Hello-World/blob/master/LICENSE + node_id: MDc6TGljZW5zZW1pdA== + readme: + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/README.md + html_url: https://github.com/octocat/Hello-World/blob/master/README.md + updated_at: '2017-02-28T19:09:29Z' + content_reports_enabled: true + commit-comparison: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: >- + https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: https://github.com/octocat/Hello-World/compare/master...topic.patch + base_commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + merge_base_commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + status: behind + ahead_by: 1 + behind_by: 2 + total_commits: 1 + commits: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: >- + MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: >- + https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + files: + - sha: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: file1.txt + status: added + additions: 103 + deletions: 21 + changes: 124 + blob_url: >- + https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: >- + https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: >- + https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + content-file-response-if-content-is-a-file: + summary: Response if content is a file + value: + type: file + encoding: base64 + size: 5362 + name: README.md + path: README.md + content: >- + IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\nIHdvcmtmbG93Lgo=\n + sha: 3d21ec53a331a6f037a91c368710b99387d012c1 + url: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + git_url: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + html_url: https://github.com/octokit/octokit.rb/blob/master/README.md + download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md + _links: + git: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + self: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + html: https://github.com/octokit/octokit.rb/blob/master/README.md + content-file-response-if-content-is-a-directory-object: + summary: >- + Response if content is a directory and the + application/vnd.github.v3.object media type is requested + value: + type: dir + size: 0 + name: src + path: src + sha: 2962be1c94eaae9794b3080790ec9d74b2fa8358 + url: https://api.github.com/repos/octocat/octorepo/contents/src?ref=main + git_url: >- + https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html_url: https://github.com/octocat/octorepo/blob/main/src + download_url: https://raw.githubusercontent.com/octocat/octorepo/main/src + _links: + self: https://api.github.com/repos/octocat/octorepo/contents/src + git: >- + https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html: https://github.com/octocat/octorepo/blob/main/src + entries: + - type: file + size: 625 + name: app.js + path: src/app.js + sha: fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + url: https://api.github.com/repos/octocat/octorepo/contents/src/app.js + git_url: >- + https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html_url: https://github.com/octocat/octorepo/blob/main/src/app.js + download_url: https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js + _links: + self: >- + https://api.github.com/repos/octocat/octorepo/contents/src/app.js + git: >- + https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html: https://github.com/octocat/octorepo/blob/main/src/app.js + - type: dir + size: 0 + name: images + path: src/images + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + url: https://api.github.com/repos/octocat/octorepo/contents/src/images + git_url: >- + https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html_url: https://github.com/octocat/octorepo/tree/main/src/images + download_url: null + _links: + self: >- + https://api.github.com/repos/octocat/octorepo/contents/src/images + git: >- + https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html: https://github.com/octocat/octorepo/tree/main/src/images + content-file-response-if-content-is-a-directory: + summary: >- + Response if content is a directory and the application/json media type + is requested + value: + - type: file + size: 625 + name: octokit.rb + path: lib/octokit.rb + sha: fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + url: >- + https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb + git_url: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html_url: https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb + download_url: >- + https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb + _links: + self: >- + https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb + git: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html: https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb + - type: dir + size: 0 + name: octokit + path: lib/octokit + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + url: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit + git_url: >- + https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html_url: https://github.com/octokit/octokit.rb/tree/master/lib/octokit + download_url: null + _links: + self: >- + https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit + git: >- + https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html: https://github.com/octokit/octokit.rb/tree/master/lib/octokit + content-file-response-if-content-is-a-symlink: + summary: >- + Response if content is a symlink and the application/json media type is + requested + value: + type: symlink + target: /path/to/symlink/target + size: 23 + name: some-symlink + path: bin/some-symlink + sha: 452a98979c88e093d682cab404a3ec82babebb48 + url: >- + https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink + git_url: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48 + html_url: https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink + download_url: >- + https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink + _links: + git: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48 + self: >- + https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink + html: https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink + content-file-response-if-content-is-a-submodule: + summary: >- + Response if content is a submodule and the application/json media type + is requested + value: + type: submodule + submodule_git_url: git://github.com/jquery/qunit.git + size: 0 + name: qunit + path: test/qunit + sha: 6ca3721222109997540bd6d9ccd396902e0ad2f9 + url: >- + https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master + git_url: >- + https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9 + html_url: >- + https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 + download_url: null + _links: + git: >- + https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9 + self: >- + https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master + html: >- + https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 + file-commit-example-for-updating-a-file: + value: + content: + name: hello.txt + path: notes/hello.txt + sha: a56507ed892d05a37c6d6128c260937ea4d287bd + size: 9 + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + git_url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd + download_url: >- + https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt + type: file + _links: + self: >- + https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + git: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd + html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + commit: + sha: 18a43cd8e1e3a79c786e3d808a73d23b6d212b16 + node_id: MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg== + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16 + html_url: >- + https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16 + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f + sha: 9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6 + html_url: >- + https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6 + sha: da5a433788da5c255edad7979b328b67d79f53f6 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + file-commit-example-for-creating-a-file: + value: + content: + name: hello.txt + path: notes/hello.txt + sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + size: 9 + url: >- + https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + git_url: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + download_url: >- + https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt + type: file + _links: + self: >- + https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + git: >- + https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + commit: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: >- + https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + html_url: >- + https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + file-commit: + value: + content: null + commit: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== + url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: >- + https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: >- + https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: >- + https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + html_url: >- + https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + contributor-items-response-if-repository-contains-content: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + contributions: 32 + deployment-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + deployment-simple-example: + summary: Simple example + value: + url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + deployment: + value: + url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + deployment-status-items: + value: + - url: >- + https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: 1 + node_id: MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: success + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + description: Deployment finished successfully. + environment: production + target_url: https://example.com/deployment/42/output + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + deployment_url: https://api.github.com/repos/octocat/example/deployments/42 + repository_url: https://api.github.com/repos/octocat/example + environment_url: https://test-branch.lab.acme.com + log_url: https://example.com/deployment/42/output + deployment-status: + value: + url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: 1 + node_id: MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: success + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + description: Deployment finished successfully. + environment: production + target_url: https://example.com/deployment/42/output + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + deployment_url: https://api.github.com/repos/octocat/example/deployments/42 + repository_url: https://api.github.com/repos/octocat/example + environment_url: https://test-branch.lab.acme.com + log_url: https://example.com/deployment/42/output + environments: + value: + total_count: 1 + environments: + - id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: >- + https://api.github.com/repos/github/hello-world/environments/staging + html_url: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + protection_rules: + - id: 3736 + node_id: MDQ6R2F0ZTM3MzY= + type: wait_timer + wait_timer: 30 + - id: 3755 + node_id: MDQ6R2F0ZTM3NTU= + prevent_self_review: false + type: required_reviewers + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: >- + https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: >- + https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + - id: 3756 + node_id: MDQ6R2F0ZTM3NTY= + type: branch_policy + deployment_branch_policy: + protected_branches: false + custom_branch_policies: true + environment: + value: + id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: >- + https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + protection_rules: + - id: 3736 + node_id: MDQ6R2F0ZTM3MzY= + type: wait_timer + wait_timer: 30 + - id: 3755 + node_id: MDQ6R2F0ZTM3NTU= + prevent_self_review: false + type: required_reviewers + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + - id: 3756 + node_id: MDQ6R2F0ZTM3NTY= + type: branch_policy + deployment_branch_policy: + protected_branches: false + custom_branch_policies: true + deployment-branch-policies-list: + value: + total_count: 2 + branch_policies: + - id: 361471 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: release/* + - id: 361472 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI= + name: main + deployment-branch-policy-wildcard: + value: + id: 364662 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= + name: release/* + deployment-branch-policy-single-branch: + value: + id: 364663 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= + name: main + deployment-branch-policy-single-tag: + value: + id: 364663 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= + name: v1 + type: tag + deployment-protection-rules: + value: + - total_count: 2 + - custom_deployment_protection_rules: + - id: 3 + node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv + enabled: true + app: + id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + - id: 4 + node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 + enabled: true + app: + id: 1 + node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy + slug: another-custom-app + integration_url: https://api.github.com/apps/another-custom-app + deployment-protection-rule: + value: + id: 3 + node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv + enabled: true + app: + id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + custom-deployment-protection-rule-apps: + value: + - total_count: 2 + - available_custom_deployment_protection_rule_integrations: + - id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + - id: 2 + node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy + slug: another-custom-app + integration_url: https://api.github.com/apps/another-custom-app + minimal-repository-items-2: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: true + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + hook-items: + value: + - type: Repository + id: 12345678 + name: web + active: true + events: + - push + - pull_request + config: + content_type: json + insecure_ssl: '0' + url: https://example.com/webhook + updated_at: '2019-06-03T00:57:16Z' + created_at: '2019-06-03T00:57:16Z' + url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 + test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test + ping_url: >- + https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings + deliveries_url: >- + https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries + last_response: + code: null + status: unused + message: null + hook: + value: + type: Repository + id: 12345678 + name: web + active: true + events: + - push + - pull_request + config: + content_type: json + insecure_ssl: '0' + url: https://example.com/webhook + updated_at: '2019-06-03T00:57:16Z' + created_at: '2019-06-03T00:57:16Z' + url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 + test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test + ping_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings + deliveries_url: >- + https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries + last_response: + code: null + status: unused + message: null + webhook-config: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + hook-delivery-items: + value: + - id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: '2019-06-03T00:57:16Z' + - id: 123456789 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-04T00:57:16Z' + redelivery: true + duration: 0.28 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: null + hook-delivery: + value: + id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + url: https://www.example.com + throttled_at: '2019-06-03T00:57:16Z' + request: + headers: + X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + Accept: '*/*' + X-GitHub-Hook-ID: '42' + User-Agent: GitHub-Hookshot/b8c71d8 + X-GitHub-Event: issues + X-GitHub-Hook-Installation-Target-ID: '123' + X-GitHub-Hook-Installation-Target-Type: repository + content-type: application/json + X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + payload: + action: opened + issue: + body: foo + repository: + id: 123 + response: + headers: + Content-Type: text/html;charset=utf-8 + payload: ok + repository-invitation-items: + value: + - id: 1 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + invitee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + inviter: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: write + created_at: '2016-06-13T14:52:50-05:00' + url: https://api.github.com/user/repository_invitations/1296269 + html_url: https://github.com/octocat/Hello-World/invitations + node_id: MDQ6VXNlcjE= + repository-invitation: + value: + id: 1 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + invitee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + inviter: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: write + created_at: '2016-06-13T14:52:50-05:00' + expired: false + url: https://api.github.com/user/repository_invitations/1296269 + html_url: https://github.com/octocat/Hello-World/invitations + deploy-key-items: + value: + - id: 1 + key: ssh-rsa AAA... + url: https://api.github.com/repos/octocat/Hello-World/keys/1 + title: octocat@octomac + verified: true + created_at: '2014-12-10T15:53:42Z' + read_only: true + added_by: octocat + last_used: '2022-01-10T15:53:42Z' + enabled: true + deploy-key: + value: + id: 1 + key: ssh-rsa AAA... + url: https://api.github.com/repos/octocat/Hello-World/keys/1 + title: octocat@octomac + verified: true + created_at: '2014-12-10T15:53:42Z' + read_only: true + added_by: octocat + last_used: '2022-01-10T15:53:42Z' + enabled: true + language: + value: + C: 78769 + Python: 7769 + merged-upstream: + value: + message: Successfully fetched and fast-forwarded from upstream defunkt:main + merge_type: fast-forward + base_branch: defunkt:main + page: + value: + url: https://api.github.com/repos/github/developer.github.com/pages + status: built + cname: developer.github.com + custom_404: false + html_url: https://developer.github.com + source: + branch: master + path: / + public: true + pending_domain_unverified_at: '2024-04-30T19:33:31Z' + protected_domain_state: verified + https_certificate: + state: approved + description: Certificate is approved + domains: + - developer.github.com + expires_at: '2021-05-22' + https_enforced: true + page-build-items: + value: + - url: >- + https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 + status: built + error: + message: null + pusher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + commit: 351391cdcb88ffae71ec3028c91f375a8036a26b + duration: 2104 + created_at: '2014-02-10T19:00:49Z' + updated_at: '2014-02-10T19:00:51Z' + page-build-status: + value: + url: >- + https://api.github.com/repos/github/developer.github.com/pages/builds/latest + status: queued + page-build: + value: + url: >- + https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 + status: built + error: + message: null + pusher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + commit: 351391cdcb88ffae71ec3028c91f375a8036a26b + duration: 2104 + created_at: '2014-02-10T19:00:49Z' + updated_at: '2014-02-10T19:00:51Z' + page-deployment: + value: + id: 4fd754f7e594640989b406850d0bc8f06a121251 + status_url: >- + https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + page_url: developer.github.com + pages-deployment-status: + value: + status: succeed + pages-health-check: + value: + domain: + host: example.com + uri: http://example.com/ + nameservers: default + dns_resolves: true + is_proxied: false + is_cloudflare_ip: false + is_fastly_ip: false + is_old_ip_address: false + is_a_record: true + has_cname_record: false + has_mx_records_present: false + is_valid_domain: true + is_apex_domain: true + should_be_a_record: true + is_cname_to_github_user_domain: false + is_cname_to_pages_dot_github_dot_com: false + is_cname_to_fastly: false + is_pointed_to_github_pages_ip: true + is_non_github_pages_ip_present: false + is_pages_domain: false + is_served_by_pages: true + is_valid: true + reason: null + responds_to_https: true + enforces_https: true + https_error: null + is_https_eligible: true + caa_error: null + alt_domain: + host: www.example.com + uri: http://www.example.com/ + nameservers: default + dns_resolves: true + is_proxied: false + is_cloudflare_ip: false + is_fastly_ip: false + is_old_ip_address: false + is_a_record: true + has_cname_record: false + has_mx_records_present: false + is_valid_domain: true + is_apex_domain: true + should_be_a_record: true + is_cname_to_github_user_domain: false + is_cname_to_pages_dot_github_dot_com: false + is_cname_to_fastly: false + is_pointed_to_github_pages_ip: true + is_non_github_pages_ip_present: false + is_pages_domain: false + is_served_by_pages: true + is_valid: true + reason: null + responds_to_https: true + enforces_https: true + https_error: null + is_https_eligible: true + caa_error: null + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + type: object + content-file: + value: + type: file + encoding: base64 + size: 5362 + name: README.md + path: README.md + content: encoded content ... + sha: 3d21ec53a331a6f037a91c368710b99387d012c1 + url: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + git_url: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + html_url: https://github.com/octokit/octokit.rb/blob/master/README.md + download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md + _links: + git: >- + https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + self: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + html: https://github.com/octokit/octokit.rb/blob/master/README.md + release-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/releases/1 + html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 + assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets + upload_url: >- + https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label} + tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0 + zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0 + id: 1 + node_id: MDc6UmVsZWFzZTE= + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + immutable: false + created_at: '2013-02-27T19:35:32Z' + published_at: '2013-02-27T19:35:32Z' + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assets: + - url: >- + https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: >- + https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: >- + sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release: + value: + url: https://api.github.com/repos/octocat/Hello-World/releases/1 + html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 + assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets + upload_url: >- + https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label} + tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0 + zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0 + discussion_url: https://github.com/octocat/Hello-World/discussions/90 + id: 1 + node_id: MDc6UmVsZWFzZTE= + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + immutable: false + created_at: '2013-02-27T19:35:32Z' + published_at: '2013-02-27T19:35:32Z' + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assets: + - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: >- + https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: >- + sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release-asset: + value: + url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: >- + https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: >- + sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release-notes-content: + value: + name: Release v1.0.0 is now available! + body: '##Changes in Release v1.0.0 ... ##Contributors @monalisa' + release-asset-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: >- + https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: >- + sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release-asset-response-for-successful-upload: + value: + url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: >- + https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: >- + sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository-rule-items: + value: + - type: commit_message_pattern + ruleset_source_type: Repository + ruleset_source: monalisa/my-repo + ruleset_id: 42 + parameters: + operator: starts_with + pattern: issue + - type: commit_author_email_pattern + ruleset_source_type: Organization + ruleset_source: my-org + ruleset_id: 73 + parameters: + operator: contains + pattern: github + repository-ruleset-items: + value: + - id: 42 + name: super cool ruleset + source_type: Repository + source: monalisa/my-repo + enforcement: enabled + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/repos/monalisa/my-repo/rulesets/42 + html: + href: https://github.com/monalisa/my-repo/rules/42 + created_at: '2023-07-15T08:43:03Z' + updated_at: '2023-08-23T16:29:47Z' + - id: 314 + name: Another ruleset + source_type: Repository + source: monalisa/my-repo + enforcement: enabled + node_id: RRS_lACkVXNlcgQQ + _links: + self: + href: https://api.github.com/repos/monalisa/my-repo/rulesets/314 + html: + href: https://github.com/monalisa/my-repo/rules/314 + created_at: '2023-08-15T08:43:03Z' + updated_at: '2023-09-23T16:29:47Z' + repository-ruleset: + value: + id: 42 + name: super cool ruleset + target: branch + source_type: Repository + source: monalisa/my-repo + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/repos/monalisa/my-repo/rulesets/42 + html: + href: https://github.com/monalisa/my-repo/rules/42 + created_at: '2023-07-15T08:43:03Z' + updated_at: '2023-08-23T16:29:47Z' + ruleset-history: + value: + - version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + - version_id: 2 + actor: + id: 2 + type: User + updated_at: '2024-09-23T16:29:47Z' + - version_id: 1 + actor: + id: 1 + type: User + updated_at: '2024-08-23T16:29:47Z' + repository-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 42 + name: super cool ruleset + target: branch + source_type: Repository + source: monalisa/my-repo + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + code-frequency-stat-items: + value: + - - 1302998400 + - 1124 + - -435 + commit-activity-items: + value: + - days: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + total: 89 + week: 1336280400 + contributor-activity-items: + value: + - author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + total: 135 + weeks: + - w: 1367712000 + a: 6898 + d: 77 + c: 10 + participation-stats: + value: + all: + - 11 + - 21 + - 15 + - 2 + - 8 + - 1 + - 8 + - 23 + - 17 + - 21 + - 11 + - 10 + - 33 + - 91 + - 38 + - 34 + - 22 + - 23 + - 32 + - 3 + - 43 + - 87 + - 71 + - 18 + - 13 + - 5 + - 13 + - 16 + - 66 + - 27 + - 12 + - 45 + - 110 + - 117 + - 13 + - 8 + - 18 + - 9 + - 19 + - 26 + - 39 + - 12 + - 20 + - 31 + - 46 + - 91 + - 45 + - 10 + - 24 + - 9 + - 29 + - 7 + owner: + - 3 + - 2 + - 3 + - 0 + - 2 + - 0 + - 5 + - 14 + - 7 + - 9 + - 1 + - 5 + - 0 + - 48 + - 19 + - 2 + - 0 + - 1 + - 10 + - 2 + - 23 + - 40 + - 35 + - 8 + - 8 + - 2 + - 10 + - 6 + - 30 + - 0 + - 2 + - 9 + - 53 + - 104 + - 3 + - 3 + - 10 + - 4 + - 7 + - 11 + - 21 + - 4 + - 4 + - 22 + - 26 + - 63 + - 11 + - 2 + - 14 + - 1 + - 10 + - 3 + code-frequency-stat-items-2: + value: + - - 0 + - 0 + - 5 + - - 0 + - 1 + - 43 + - - 0 + - 2 + - 21 + status: + value: + url: >- + https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/hubot_happy.gif + id: 1 + node_id: MDY6U3RhdHVzMQ== + state: success + description: Build has completed successfully + target_url: https://ci.example.com/1000/output + context: continuous-integration/jenkins + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + tag-items: + value: + - name: v0.1 + commit: + sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + url: >- + https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + zipball_url: https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: MDQ6VXNlcjE= + topic: + value: + names: + - octocat + - atom + - electron + - api + clone-traffic: + value: + count: 173 + uniques: 128 + clones: + - timestamp: '2016-10-10T00:00:00Z' + count: 2 + uniques: 1 + - timestamp: '2016-10-11T00:00:00Z' + count: 17 + uniques: 16 + - timestamp: '2016-10-12T00:00:00Z' + count: 21 + uniques: 15 + - timestamp: '2016-10-13T00:00:00Z' + count: 8 + uniques: 7 + - timestamp: '2016-10-14T00:00:00Z' + count: 5 + uniques: 5 + - timestamp: '2016-10-15T00:00:00Z' + count: 2 + uniques: 2 + - timestamp: '2016-10-16T00:00:00Z' + count: 8 + uniques: 7 + - timestamp: '2016-10-17T00:00:00Z' + count: 26 + uniques: 15 + - timestamp: '2016-10-18T00:00:00Z' + count: 19 + uniques: 17 + - timestamp: '2016-10-19T00:00:00Z' + count: 19 + uniques: 14 + - timestamp: '2016-10-20T00:00:00Z' + count: 19 + uniques: 15 + - timestamp: '2016-10-21T00:00:00Z' + count: 9 + uniques: 7 + - timestamp: '2016-10-22T00:00:00Z' + count: 5 + uniques: 5 + - timestamp: '2016-10-23T00:00:00Z' + count: 6 + uniques: 5 + - timestamp: '2016-10-24T00:00:00Z' + count: 7 + uniques: 5 + content-traffic-items: + value: + - path: /github/hubot + title: 'github/hubot: A customizable life embetterment robot.' + count: 3542 + uniques: 2225 + - path: /github/hubot/blob/master/docs/scripting.md + title: hubot/scripting.md at master Β· github/hubot Β· GitHub + count: 1707 + uniques: 804 + - path: /github/hubot/tree/master/docs + title: hubot/docs at master Β· github/hubot Β· GitHub + count: 685 + uniques: 435 + - path: /github/hubot/tree/master/src + title: hubot/src at master Β· github/hubot Β· GitHub + count: 577 + uniques: 347 + - path: /github/hubot/blob/master/docs/index.md + title: hubot/index.md at master Β· github/hubot Β· GitHub + count: 379 + uniques: 259 + - path: /github/hubot/blob/master/docs/adapters.md + title: hubot/adapters.md at master Β· github/hubot Β· GitHub + count: 354 + uniques: 201 + - path: /github/hubot/tree/master/examples + title: hubot/examples at master Β· github/hubot Β· GitHub + count: 340 + uniques: 260 + - path: /github/hubot/blob/master/docs/deploying/heroku.md + title: hubot/heroku.md at master Β· github/hubot Β· GitHub + count: 324 + uniques: 217 + - path: /github/hubot/blob/master/src/robot.coffee + title: hubot/robot.coffee at master Β· github/hubot Β· GitHub + count: 293 + uniques: 191 + - path: /github/hubot/blob/master/LICENSE.md + title: hubot/LICENSE.md at master Β· github/hubot Β· GitHub + count: 281 + uniques: 222 + referrer-traffic-items: + value: + - referrer: Google + count: 4 + uniques: 3 + - referrer: stackoverflow.com + count: 2 + uniques: 2 + - referrer: eggsonbread.com + count: 1 + uniques: 1 + - referrer: yandex.ru + count: 1 + uniques: 1 + view-traffic: + value: + count: 14850 + uniques: 3782 + views: + - timestamp: '2016-10-10T00:00:00Z' + count: 440 + uniques: 143 + - timestamp: '2016-10-11T00:00:00Z' + count: 1308 + uniques: 414 + - timestamp: '2016-10-12T00:00:00Z' + count: 1486 + uniques: 452 + - timestamp: '2016-10-13T00:00:00Z' + count: 1170 + uniques: 401 + - timestamp: '2016-10-14T00:00:00Z' + count: 868 + uniques: 266 + - timestamp: '2016-10-15T00:00:00Z' + count: 495 + uniques: 157 + - timestamp: '2016-10-16T00:00:00Z' + count: 524 + uniques: 175 + - timestamp: '2016-10-17T00:00:00Z' + count: 1263 + uniques: 412 + - timestamp: '2016-10-18T00:00:00Z' + count: 1402 + uniques: 417 + - timestamp: '2016-10-19T00:00:00Z' + count: 1394 + uniques: 424 + - timestamp: '2016-10-20T00:00:00Z' + count: 1492 + uniques: 448 + - timestamp: '2016-10-21T00:00:00Z' + count: 1153 + uniques: 332 + - timestamp: '2016-10-22T00:00:00Z' + count: 566 + uniques: 168 + - timestamp: '2016-10-23T00:00:00Z' + count: 675 + uniques: 184 + - timestamp: '2016-10-24T00:00:00Z' + count: 614 + uniques: 237 + minimal-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + subscribers_count: 42 + network_count: 0 + public-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + repository-items-default-response: + summary: Default response + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + repos: + id: github.repos.repos + name: repos + title: Repos + methods: + list_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1repos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_in_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1repos/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_languages: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1languages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + transfer: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1transfer/post' + response: + mediaType: application/json + openAPIDocKey: '202' + create_using_template: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{template_owner}~1{template_repo}~1generate/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_public: + operation: + $ref: '#/paths/~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1repos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repos/methods/list_for_org' + - $ref: '#/components/x-stackQL-resources/repos/methods/list_for_user' + - $ref: '#/components/x-stackQL-resources/repos/methods/list_public' + insert: + - $ref: >- + #/components/x-stackQL-resources/repos/methods/create_using_template + - $ref: '#/components/x-stackQL-resources/repos/methods/create_in_org' + update: + - $ref: '#/components/x-stackQL-resources/repos/methods/update' + delete: + - $ref: '#/components/x-stackQL-resources/repos/methods/delete' + replace: [] + rules: + id: github.repos.rules + name: rules + title: Rules + methods: + get_org_rulesets: + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_org_ruleset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_org_ruleset: + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets~1{ruleset_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_org_ruleset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets~1{ruleset_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_org_ruleset: + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets~1{ruleset_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_branch_rules: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rules~1branches~1{branch}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_rulesets: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rulesets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_repo_ruleset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rulesets/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_repo_ruleset: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rulesets~1{ruleset_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_repo_ruleset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rulesets~1{ruleset_id}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_repo_ruleset: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rulesets~1{ruleset_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/rules/methods/get_branch_rules' + - $ref: '#/components/x-stackQL-resources/rules/methods/get_repo_ruleset' + - $ref: '#/components/x-stackQL-resources/rules/methods/get_org_ruleset' + - $ref: '#/components/x-stackQL-resources/rules/methods/get_repo_rulesets' + - $ref: '#/components/x-stackQL-resources/rules/methods/get_org_rulesets' + insert: + - $ref: '#/components/x-stackQL-resources/rules/methods/create_repo_ruleset' + - $ref: '#/components/x-stackQL-resources/rules/methods/create_org_ruleset' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_repo_ruleset' + - $ref: '#/components/x-stackQL-resources/rules/methods/delete_org_ruleset' + replace: + - $ref: '#/components/x-stackQL-resources/rules/methods/update_repo_ruleset' + - $ref: '#/components/x-stackQL-resources/rules/methods/update_org_ruleset' + rule_suites: + id: github.repos.rule_suites + name: rule_suites + title: Rule Suites + methods: + get_org_rule_suites: + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets~1rule-suites/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_org_rule_suite: + operation: + $ref: '#/paths/~1orgs~1{org}~1rulesets~1rule-suites~1{rule_suite_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_rule_suites: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1rulesets~1rule-suites/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_rule_suite: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1rulesets~1rule-suites~1{rule_suite_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/rule_suites/methods/get_repo_rule_suite + - $ref: >- + #/components/x-stackQL-resources/rule_suites/methods/get_org_rule_suite + - $ref: >- + #/components/x-stackQL-resources/rule_suites/methods/get_repo_rule_suites + - $ref: >- + #/components/x-stackQL-resources/rule_suites/methods/get_org_rule_suites + insert: [] + update: [] + delete: [] + replace: [] + details: + id: github.repos.details + name: details + title: Details + methods: + get: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/details/methods/get' + insert: [] + update: [] + delete: [] + replace: [] + activities: + id: github.repos.activities + name: activities + title: Activities + methods: + list_activities: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1activity/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/activities/methods/list_activities + insert: [] + update: [] + delete: [] + replace: [] + attestations: + id: github.repos.attestations + name: attestations + title: Attestations + methods: + create_attestation: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1attestations/post' + response: + mediaType: application/json + openAPIDocKey: '201' + list_attestations: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1attestations~1{subject_digest}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attestations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/list_attestations + insert: + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/create_attestation + update: [] + delete: [] + replace: [] + autolinks: + id: github.repos.autolinks + name: autolinks + title: Autolinks + methods: + list_autolinks: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1autolinks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_autolink: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1autolinks/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_autolink: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1autolinks~1{autolink_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_autolink: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1autolinks~1{autolink_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/autolinks/methods/get_autolink' + - $ref: '#/components/x-stackQL-resources/autolinks/methods/list_autolinks' + insert: + - $ref: '#/components/x-stackQL-resources/autolinks/methods/create_autolink' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/autolinks/methods/delete_autolink' + replace: [] + security_fixes: + id: github.repos.security_fixes + name: security_fixes + title: Security Fixes + methods: + check_automated_security_fixes: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1automated-security-fixes/get' + response: + mediaType: application/json + openAPIDocKey: '200' + enable_automated_security_fixes: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1automated-security-fixes/put' + response: + mediaType: application/json + openAPIDocKey: '204' + disable_automated_security_fixes: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1automated-security-fixes/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/security_fixes/methods/check_automated_security_fixes + insert: [] + update: [] + delete: [] + replace: [] + branches: + id: github.repos.branches + name: branches + title: Branches + methods: + list_branches: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1branches/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/branches/methods/list_branches' + insert: [] + update: [] + delete: [] + replace: [] + branch: + id: github.repos.branch + name: branch + title: Branch + methods: + get_branch: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + rename_branch: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1rename/post' + response: + mediaType: application/json + openAPIDocKey: '201' + merge_upstream: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1merge-upstream/post' + response: + mediaType: application/json + openAPIDocKey: '200' + merge: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1merges/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/branch/methods/get_branch' + insert: [] + update: [] + delete: [] + replace: [] + branch_protection: + id: github.repos.branch_protection + name: branch_protection + title: Branch Protection + methods: + get_branch_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_branch_protection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_branch_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/branch_protection/methods/get_branch_protection + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/branch_protection/methods/delete_branch_protection + replace: + - $ref: >- + #/components/x-stackQL-resources/branch_protection/methods/update_branch_protection + admin_branch_protection: + id: github.repos.admin_branch_protection + name: admin_branch_protection + title: Admin Branch Protection + methods: + get_admin_branch_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1enforce_admins/get + response: + mediaType: application/json + openAPIDocKey: '200' + set_admin_branch_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1enforce_admins/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_admin_branch_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1enforce_admins/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/admin_branch_protection/methods/get_admin_branch_protection + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/admin_branch_protection/methods/delete_admin_branch_protection + replace: + - $ref: >- + #/components/x-stackQL-resources/admin_branch_protection/methods/set_admin_branch_protection + pr_review_protection: + id: github.repos.pr_review_protection + name: pr_review_protection + title: Pr Review Protection + methods: + get_pull_request_review_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_pull_request_reviews/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_pull_request_review_protection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_pull_request_reviews/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_pull_request_review_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_pull_request_reviews/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pr_review_protection/methods/get_pull_request_review_protection + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/pr_review_protection/methods/update_pull_request_review_protection + delete: + - $ref: >- + #/components/x-stackQL-resources/pr_review_protection/methods/delete_pull_request_review_protection + replace: [] + commit_signature_protection: + id: github.repos.commit_signature_protection + name: commit_signature_protection + title: Commit Signature Protection + methods: + get_commit_signature_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_signatures/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_commit_signature_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_signatures/post + response: + mediaType: application/json + openAPIDocKey: '200' + delete_commit_signature_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_signatures/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/commit_signature_protection/methods/get_commit_signature_protection + insert: + - $ref: >- + #/components/x-stackQL-resources/commit_signature_protection/methods/create_commit_signature_protection + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/commit_signature_protection/methods/delete_commit_signature_protection + replace: [] + status_check_protection: + id: github.repos.status_check_protection + name: status_check_protection + title: Status Check Protection + methods: + get_status_checks_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_status_check_protection: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks/patch + response: + mediaType: application/json + openAPIDocKey: '200' + remove_status_check_protection: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/status_check_protection/methods/get_status_checks_protection + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/status_check_protection/methods/update_status_check_protection + delete: + - $ref: >- + #/components/x-stackQL-resources/status_check_protection/methods/remove_status_check_protection + replace: [] + status_check_contexts: + id: github.repos.status_check_contexts + name: status_check_contexts + title: Status Check Contexts + methods: + get_all_status_check_contexts: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks~1contexts/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_status_check_contexts: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks~1contexts/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_status_check_contexts: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks~1contexts/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_status_check_contexts: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1required_status_checks~1contexts/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/status_check_contexts/methods/get_all_status_check_contexts + insert: + - $ref: >- + #/components/x-stackQL-resources/status_check_contexts/methods/add_status_check_contexts + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/status_check_contexts/methods/remove_status_check_contexts + replace: + - $ref: >- + #/components/x-stackQL-resources/status_check_contexts/methods/set_status_check_contexts + branch_restrictions: + id: github.repos.branch_restrictions + name: branch_restrictions + title: Branch Restrictions + methods: + get_access_restrictions: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions/get + response: + mediaType: application/json + openAPIDocKey: '200' + delete_access_restrictions: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/branch_restrictions/methods/get_access_restrictions + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/branch_restrictions/methods/delete_access_restrictions + replace: [] + app_access_restrictions: + id: github.repos.app_access_restrictions + name: app_access_restrictions + title: App Access Restrictions + methods: + get_apps_with_access_to_protected_branch: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1apps/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_app_access_restrictions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1apps/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_app_access_restrictions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1apps/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_app_access_restrictions: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1apps/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/app_access_restrictions/methods/get_apps_with_access_to_protected_branch + insert: + - $ref: >- + #/components/x-stackQL-resources/app_access_restrictions/methods/add_app_access_restrictions + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/app_access_restrictions/methods/remove_app_access_restrictions + replace: + - $ref: >- + #/components/x-stackQL-resources/app_access_restrictions/methods/set_app_access_restrictions + team_access_restrictions: + id: github.repos.team_access_restrictions + name: team_access_restrictions + title: Team Access Restrictions + methods: + get_teams_with_access_to_protected_branch: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1teams/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_team_access_restrictions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1teams/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_team_access_restrictions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1teams/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_team_access_restrictions: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1teams/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/team_access_restrictions/methods/get_teams_with_access_to_protected_branch + insert: + - $ref: >- + #/components/x-stackQL-resources/team_access_restrictions/methods/add_team_access_restrictions + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/team_access_restrictions/methods/remove_team_access_restrictions + replace: + - $ref: >- + #/components/x-stackQL-resources/team_access_restrictions/methods/set_team_access_restrictions + user_access_restrictions: + id: github.repos.user_access_restrictions + name: user_access_restrictions + title: User Access Restrictions + methods: + get_users_with_access_to_protected_branch: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1users/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_user_access_restrictions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1users/post + response: + mediaType: application/json + openAPIDocKey: '200' + set_user_access_restrictions: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1users/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_user_access_restrictions: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1branches~1{branch}~1protection~1restrictions~1users/delete + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/user_access_restrictions/methods/get_users_with_access_to_protected_branch + insert: + - $ref: >- + #/components/x-stackQL-resources/user_access_restrictions/methods/add_user_access_restrictions + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/user_access_restrictions/methods/remove_user_access_restrictions + replace: + - $ref: >- + #/components/x-stackQL-resources/user_access_restrictions/methods/set_user_access_restrictions + codeowners: + id: github.repos.codeowners + name: codeowners + title: Codeowners + methods: + codeowners_errors: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1codeowners~1errors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.errors + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/codeowners/methods/codeowners_errors + insert: [] + update: [] + delete: [] + replace: [] + collaborators: + id: github.repos.collaborators + name: collaborators + title: Collaborators + methods: + list_collaborators: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1collaborators/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_collaborator: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + add_collaborator: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '201' + remove_collaborator: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/collaborators/methods/list_collaborators + insert: + - $ref: >- + #/components/x-stackQL-resources/collaborators/methods/add_collaborator + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/collaborators/methods/remove_collaborator + replace: [] + collaborator_permissions: + id: github.repos.collaborator_permissions + name: collaborator_permissions + title: Collaborator Permissions + methods: + get_collaborator_permission_level: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1collaborators~1{username}~1permission/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/collaborator_permissions/methods/get_collaborator_permission_level + insert: [] + update: [] + delete: [] + replace: [] + comments: + id: github.repos.comments + name: comments + title: Comments + methods: + list_commit_comments_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1comments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_commit_comment: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1comments~1{comment_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_commit_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1comments~1{comment_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_commit_comment: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1comments~1{comment_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_comments_for_commit: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1commits~1{commit_sha}~1comments/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_commit_comment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1commits~1{commit_sha}~1comments/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/get_commit_comment + - $ref: >- + #/components/x-stackQL-resources/comments/methods/list_comments_for_commit + - $ref: >- + #/components/x-stackQL-resources/comments/methods/list_commit_comments_for_repo + insert: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/create_commit_comment + update: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/update_commit_comment + delete: + - $ref: >- + #/components/x-stackQL-resources/comments/methods/delete_commit_comment + replace: [] + commits: + id: github.repos.commits + name: commits + title: Commits + methods: + list_commits: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_commit: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{ref}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + compare_commits: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1compare~1{basehead}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commits/methods/get_commit' + - $ref: '#/components/x-stackQL-resources/commits/methods/compare_commits' + - $ref: '#/components/x-stackQL-resources/commits/methods/list_commits' + insert: [] + update: [] + delete: [] + replace: [] + head_commit_branches: + id: github.repos.head_commit_branches + name: head_commit_branches + title: Head Commit Branches + methods: + list_branches_for_head_commit: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1commits~1{commit_sha}~1branches-where-head/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/head_commit_branches/methods/list_branches_for_head_commit + insert: [] + update: [] + delete: [] + replace: [] + commit_pr_branches: + id: github.repos.commit_pr_branches + name: commit_pr_branches + title: Commit Pr Branches + methods: + list_pull_requests_associated_with_commit: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{commit_sha}~1pulls/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/commit_pr_branches/methods/list_pull_requests_associated_with_commit + insert: [] + update: [] + delete: [] + replace: [] + status_combined: + id: github.repos.status_combined + name: status_combined + title: Status Combined + methods: + get_combined_status_for_ref: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{ref}~1status/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/status_combined/methods/get_combined_status_for_ref + insert: [] + update: [] + delete: [] + replace: [] + status_commits: + id: github.repos.status_commits + name: status_commits + title: Status Commits + methods: + list_commit_statuses_for_ref: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{ref}~1statuses/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_commit_status: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1statuses~1{sha}/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/status_commits/methods/list_commit_statuses_for_ref + insert: + - $ref: >- + #/components/x-stackQL-resources/status_commits/methods/create_commit_status + update: [] + delete: [] + replace: [] + community: + id: github.repos.community + name: community + title: Community + methods: + get_community_profile_metrics: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1community~1profile/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/community/methods/get_community_profile_metrics + insert: [] + update: [] + delete: [] + replace: [] + content_tree: + id: github.repos.content_tree + name: content_tree + title: Content Tree + methods: + get_content: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1contents~1{path}/get' + response: + mediaType: application/vnd.github.object + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/content_tree/methods/get_content' + insert: [] + update: [] + delete: [] + replace: [] + contents: + id: github.repos.contents + name: contents + title: Contents + methods: + create_or_update_file_contents: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1contents~1{path}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_file: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1contents~1{path}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get_readme: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1readme/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_readme_in_directory: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1readme~1{dir}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/contents/methods/get_readme_in_directory + - $ref: '#/components/x-stackQL-resources/contents/methods/get_readme' + insert: + - $ref: >- + #/components/x-stackQL-resources/contents/methods/create_or_update_file_contents + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/contents/methods/delete_file' + replace: [] + contributors: + id: github.repos.contributors + name: contributors + title: Contributors + methods: + list_contributors: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1contributors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/contributors/methods/list_contributors + insert: [] + update: [] + delete: [] + replace: [] + deployments: + id: github.repos.deployments + name: deployments + title: Deployments + methods: + list_deployments: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1deployments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_deployment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1deployments/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_deployment: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1deployments~1{deployment_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_deployment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1deployments~1{deployment_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/get_deployment + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/list_deployments + insert: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/create_deployment + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/deployments/methods/delete_deployment + replace: [] + status_deployments: + id: github.repos.status_deployments + name: status_deployments + title: Status Deployments + methods: + list_deployment_statuses: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1deployments~1{deployment_id}~1statuses/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_deployment_status: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1deployments~1{deployment_id}~1statuses/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_deployment_status: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1deployments~1{deployment_id}~1statuses~1{status_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/status_deployments/methods/get_deployment_status + - $ref: >- + #/components/x-stackQL-resources/status_deployments/methods/list_deployment_statuses + insert: + - $ref: >- + #/components/x-stackQL-resources/status_deployments/methods/create_deployment_status + update: [] + delete: [] + replace: [] + repository_dispatches: + id: github.repos.repository_dispatches + name: repository_dispatches + title: Repository Dispatches + methods: + create_dispatch_event: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1dispatches/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/repository_dispatches/methods/create_dispatch_event + update: [] + delete: [] + replace: [] + environments: + id: github.repos.environments + name: environments + title: Environments + methods: + get_all_environments: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1environments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_environment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_or_update_environment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_an_environment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/get_environment + - $ref: >- + #/components/x-stackQL-resources/environments/methods/get_all_environments + insert: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/create_or_update_environment + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/environments/methods/delete_an_environment + replace: [] + branch_policies: + id: github.repos.branch_policies + name: branch_policies + title: Branch Policies + methods: + list_deployment_branch_policies: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment-branch-policies/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_deployment_branch_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment-branch-policies/post + response: + mediaType: application/json + openAPIDocKey: '200' + get_deployment_branch_policy: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment-branch-policies~1{branch_policy_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_deployment_branch_policy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment-branch-policies~1{branch_policy_id}/put + response: + mediaType: application/json + openAPIDocKey: '200' + delete_deployment_branch_policy: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment-branch-policies~1{branch_policy_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/branch_policies/methods/get_deployment_branch_policy + - $ref: >- + #/components/x-stackQL-resources/branch_policies/methods/list_deployment_branch_policies + insert: + - $ref: >- + #/components/x-stackQL-resources/branch_policies/methods/create_deployment_branch_policy + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/branch_policies/methods/delete_deployment_branch_policy + replace: + - $ref: >- + #/components/x-stackQL-resources/branch_policies/methods/update_deployment_branch_policy + protection_rules: + id: github.repos.protection_rules + name: protection_rules + title: Protection Rules + methods: + get_all_deployment_protection_rules: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment_protection_rules/get + response: + mediaType: application/json + openAPIDocKey: '200' + create_deployment_protection_rule: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment_protection_rules/post + response: + mediaType: application/json + openAPIDocKey: '201' + get_custom_deployment_protection_rule: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment_protection_rules~1{protection_rule_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + disable_deployment_protection_rule: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment_protection_rules~1{protection_rule_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/protection_rules/methods/get_custom_deployment_protection_rule + - $ref: >- + #/components/x-stackQL-resources/protection_rules/methods/get_all_deployment_protection_rules + insert: + - $ref: >- + #/components/x-stackQL-resources/protection_rules/methods/create_deployment_protection_rule + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/protection_rules/methods/disable_deployment_protection_rule + replace: [] + deployment_rule_integrations: + id: github.repos.deployment_rule_integrations + name: deployment_rule_integrations + title: Deployment Rule Integrations + methods: + list_custom_deployment_rule_integrations: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1environments~1{environment_name}~1deployment_protection_rules~1apps/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deployment_rule_integrations/methods/list_custom_deployment_rule_integrations + insert: [] + update: [] + delete: [] + replace: [] + forks: + id: github.repos.forks + name: forks + title: Forks + methods: + list_forks: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1forks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_fork: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1forks/post' + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/forks/methods/list_forks' + insert: + - $ref: '#/components/x-stackQL-resources/forks/methods/create_fork' + update: [] + delete: [] + replace: [] + webhooks: + id: github.repos.webhooks + name: webhooks + title: Webhooks + methods: + list_webhooks: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_webhook: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_webhook: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_webhook: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + ping_webhook: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1pings/post' + response: + mediaType: application/json + openAPIDocKey: '204' + test_push_webhook: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1tests/post' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/get_webhook' + - $ref: '#/components/x-stackQL-resources/webhooks/methods/list_webhooks' + insert: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/create_webhook' + update: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/update_webhook' + delete: + - $ref: '#/components/x-stackQL-resources/webhooks/methods/delete_webhook' + replace: [] + webhook_config: + id: github.repos.webhook_config + name: webhook_config + title: Webhook Config + methods: + get_webhook_config_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1config/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_webhook_config_for_repo: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1config/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_config/methods/get_webhook_config_for_repo + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/webhook_config/methods/update_webhook_config_for_repo + delete: [] + replace: [] + webhook_deliveries: + id: github.repos.webhook_deliveries + name: webhook_deliveries + title: Webhook Deliveries + methods: + list_webhook_deliveries: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1deliveries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_deliveries/methods/list_webhook_deliveries + insert: [] + update: [] + delete: [] + replace: [] + webhook_delivery: + id: github.repos.webhook_delivery + name: webhook_delivery + title: Webhook Delivery + methods: + get_webhook_delivery: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1deliveries~1{delivery_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + redeliver_webhook_delivery: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1hooks~1{hook_id}~1deliveries~1{delivery_id}~1attempts/post + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/webhook_delivery/methods/get_webhook_delivery + insert: [] + update: [] + delete: [] + replace: [] + repo_immutable_releases: + id: github.repos.repo_immutable_releases + name: repo_immutable_releases + title: Repo Immutable Releases + methods: + check_immutable_releases: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1immutable-releases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + enable_immutable_releases: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1immutable-releases/put' + response: + mediaType: application/json + openAPIDocKey: '204' + disable_immutable_releases: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1immutable-releases/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_immutable_releases/methods/check_immutable_releases + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/repo_immutable_releases/methods/disable_immutable_releases + replace: + - $ref: >- + #/components/x-stackQL-resources/repo_immutable_releases/methods/enable_immutable_releases + invitations: + id: github.repos.invitations + name: invitations + title: Invitations + methods: + list_invitations: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_invitation: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1invitations~1{invitation_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_invitation: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1invitations~1{invitation_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_invitations_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1repository_invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + accept_invitation_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1repository_invitations~1{invitation_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + decline_invitation_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1repository_invitations~1{invitation_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/list_invitations + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/list_invitations_for_authenticated_user + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/update_invitation + delete: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/delete_invitation + replace: [] + deploy_keys: + id: github.repos.deploy_keys + name: deploy_keys + title: Deploy Keys + methods: + list_deploy_keys: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_deploy_key: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1keys/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_deploy_key: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1keys~1{key_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_deploy_key: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1keys~1{key_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/deploy_keys/methods/get_deploy_key + - $ref: >- + #/components/x-stackQL-resources/deploy_keys/methods/list_deploy_keys + insert: + - $ref: >- + #/components/x-stackQL-resources/deploy_keys/methods/create_deploy_key + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/deploy_keys/methods/delete_deploy_key + replace: [] + pages: + id: github.repos.pages + name: pages + title: Pages + methods: + get_pages: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_pages_site: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update_information_about_pages_site: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages/put' + response: + mediaType: application/json + openAPIDocKey: '204' + delete_pages_site: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/pages/methods/get_pages' + insert: + - $ref: '#/components/x-stackQL-resources/pages/methods/create_pages_site' + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/pages/methods/delete_pages_site' + replace: + - $ref: >- + #/components/x-stackQL-resources/pages/methods/update_information_about_pages_site + page_builds: + id: github.repos.page_builds + name: page_builds + title: Page Builds + methods: + list_pages_builds: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages~1builds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + request_pages_build: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages~1builds/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_pages_build: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages~1builds~1{build_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_pages_deployment: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages~1deployments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/page_builds/methods/get_pages_build + - $ref: >- + #/components/x-stackQL-resources/page_builds/methods/list_pages_builds + insert: + - $ref: >- + #/components/x-stackQL-resources/page_builds/methods/create_pages_deployment + update: [] + delete: [] + replace: [] + page_build_latest: + id: github.repos.page_build_latest + name: page_build_latest + title: Page Build Latest + methods: + get_latest_pages_build: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages~1builds~1latest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/page_build_latest/methods/get_latest_pages_build + insert: [] + update: [] + delete: [] + replace: [] + repo_pages_deployments: + id: github.repos.repo_pages_deployments + name: repo_pages_deployments + title: Repo Pages Deployments + methods: + get_pages_deployment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pages~1deployments~1{pages_deployment_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + cancel_pages_deployment: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1pages~1deployments~1{pages_deployment_id}~1cancel/post + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_pages_deployments/methods/get_pages_deployment + insert: + - $ref: >- + #/components/x-stackQL-resources/repo_pages_deployments/methods/cancel_pages_deployment + update: [] + delete: [] + replace: [] + pages_health_check: + id: github.repos.pages_health_check + name: pages_health_check + title: Pages Health Check + methods: + get_pages_health_check: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1pages~1health/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/pages_health_check/methods/get_pages_health_check + insert: [] + update: [] + delete: [] + replace: [] + private_vulnerability_reporting: + id: github.repos.private_vulnerability_reporting + name: private_vulnerability_reporting + title: Private Vulnerability Reporting + methods: + check_private_vulnerability_reporting: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1private-vulnerability-reporting/get + response: + mediaType: application/json + openAPIDocKey: '200' + enable_private_vulnerability_reporting: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1private-vulnerability-reporting/put + response: + mediaType: application/json + openAPIDocKey: '204' + disable_private_vulnerability_reporting: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1private-vulnerability-reporting/delete + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/private_vulnerability_reporting/methods/check_private_vulnerability_reporting + insert: [] + update: [] + delete: [] + replace: [] + custom_property_values: + id: github.repos.custom_property_values + name: custom_property_values + title: Custom Property Values + methods: + custom_properties_for_repos_get_repository_values: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1properties~1values/get' + response: + mediaType: application/json + openAPIDocKey: '200' + custom_properties_for_repos_create_or_update_repository_values: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1properties~1values/patch' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/custom_property_values/methods/custom_properties_for_repos_get_repository_values + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/custom_property_values/methods/custom_properties_for_repos_create_or_update_repository_values + delete: [] + replace: [] + releases: + id: github.repos.releases + name: releases + title: Releases + methods: + list_releases: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_release: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases/post' + response: + mediaType: application/json + openAPIDocKey: '201' + generate_release_notes: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1generate-notes/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_release_by_tag: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1tags~1{tag}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_release: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_release: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_release: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/releases/methods/get_release_by_tag + - $ref: '#/components/x-stackQL-resources/releases/methods/get_release' + - $ref: '#/components/x-stackQL-resources/releases/methods/list_releases' + insert: + - $ref: '#/components/x-stackQL-resources/releases/methods/create_release' + update: + - $ref: '#/components/x-stackQL-resources/releases/methods/update_release' + delete: + - $ref: '#/components/x-stackQL-resources/releases/methods/delete_release' + replace: [] + assets: + id: github.repos.assets + name: assets + title: Assets + methods: + get_release_asset: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1assets~1{asset_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_release_asset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1assets~1{asset_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + delete_release_asset: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1assets~1{asset_id}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_release_assets: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}~1assets/get + response: + mediaType: application/json + openAPIDocKey: '200' + upload_release_asset: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1releases~1{release_id}~1assets/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/assets/methods/get_release_asset' + - $ref: >- + #/components/x-stackQL-resources/assets/methods/list_release_assets + insert: + - $ref: >- + #/components/x-stackQL-resources/assets/methods/upload_release_asset + update: + - $ref: >- + #/components/x-stackQL-resources/assets/methods/update_release_asset + delete: + - $ref: >- + #/components/x-stackQL-resources/assets/methods/delete_release_asset + replace: [] + releases_latest: + id: github.repos.releases_latest + name: releases_latest + title: Releases Latest + methods: + get_latest_release: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1releases~1latest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/releases_latest/methods/get_latest_release + insert: [] + update: [] + delete: [] + replace: [] + ruleset_history: + id: github.repos.ruleset_history + name: ruleset_history + title: Ruleset History + methods: + get_repo_ruleset_history: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1rulesets~1{ruleset_id}~1history/get + response: + mediaType: application/json + openAPIDocKey: '200' + get_repo_ruleset_version: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1rulesets~1{ruleset_id}~1history~1{version_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.state + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ruleset_history/methods/get_repo_ruleset_version + - $ref: >- + #/components/x-stackQL-resources/ruleset_history/methods/get_repo_ruleset_history + insert: [] + update: [] + delete: [] + replace: [] + stats_code_frequency: + id: github.repos.stats_code_frequency + name: stats_code_frequency + title: Stats Code Frequency + methods: + get_code_frequency_stats: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1stats~1code_frequency/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/stats_code_frequency/methods/get_code_frequency_stats + insert: [] + update: [] + delete: [] + replace: [] + stats_commit_activity: + id: github.repos.stats_commit_activity + name: stats_commit_activity + title: Stats Commit Activity + methods: + get_commit_activity_stats: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1stats~1commit_activity/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/stats_commit_activity/methods/get_commit_activity_stats + insert: [] + update: [] + delete: [] + replace: [] + stats_contributors: + id: github.repos.stats_contributors + name: stats_contributors + title: Stats Contributors + methods: + get_contributors_stats: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1stats~1contributors/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/stats_contributors/methods/get_contributors_stats + insert: [] + update: [] + delete: [] + replace: [] + stats_participation: + id: github.repos.stats_participation + name: stats_participation + title: Stats Participation + methods: + get_participation_stats: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1stats~1participation/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/stats_participation/methods/get_participation_stats + insert: [] + update: [] + delete: [] + replace: [] + stats_punch_cards: + id: github.repos.stats_punch_cards + name: stats_punch_cards + title: Stats Punch Cards + methods: + get_punch_card_stats: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1stats~1punch_card/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/stats_punch_cards/methods/get_punch_card_stats + insert: [] + update: [] + delete: [] + replace: [] + tags: + id: github.repos.tags + name: tags + title: Tags + methods: + list_tags: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1tags/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tags/methods/list_tags' + insert: [] + update: [] + delete: [] + replace: [] + teams: + id: github.repos.teams + name: teams + title: Teams + methods: + list_teams: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teams/methods/list_teams' + insert: [] + update: [] + delete: [] + replace: [] + topics: + id: github.repos.topics + name: topics + title: Topics + methods: + get_all_topics: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1topics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.names + replace_all_topics: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1topics/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/topics/methods/get_all_topics' + insert: [] + update: [] + delete: [] + replace: + - $ref: '#/components/x-stackQL-resources/topics/methods/replace_all_topics' + clone_traffic: + id: github.repos.clone_traffic + name: clone_traffic + title: Clone Traffic + methods: + get_clones: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1traffic~1clones/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/clone_traffic/methods/get_clones' + insert: [] + update: [] + delete: [] + replace: [] + content_traffic: + id: github.repos.content_traffic + name: content_traffic + title: Content Traffic + methods: + get_top_paths: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1traffic~1popular~1paths/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/content_traffic/methods/get_top_paths + insert: [] + update: [] + delete: [] + replace: [] + referrer_traffic: + id: github.repos.referrer_traffic + name: referrer_traffic + title: Referrer Traffic + methods: + get_top_referrers: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1traffic~1popular~1referrers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/referrer_traffic/methods/get_top_referrers + insert: [] + update: [] + delete: [] + replace: [] + view_traffic: + id: github.repos.view_traffic + name: view_traffic + title: View Traffic + methods: + get_views: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1traffic~1views/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/view_traffic/methods/get_views' + insert: [] + update: [] + delete: [] + replace: [] + vulnerability_alerts: + id: github.repos.vulnerability_alerts + name: vulnerability_alerts + title: Vulnerability Alerts + methods: + check_vulnerability_alerts: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1vulnerability-alerts/get' + response: + mediaType: application/json + openAPIDocKey: '204' + enable_vulnerability_alerts: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1vulnerability-alerts/put' + response: + mediaType: application/json + openAPIDocKey: '204' + disable_vulnerability_alerts: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1vulnerability-alerts/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + repos_for_auth_user: + id: github.repos.repos_for_auth_user + name: repos_for_auth_user + title: Repos For Auth User + methods: + list_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1repos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1repos/post' + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repos_for_auth_user/methods/list_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/repos_for_auth_user/methods/create_for_authenticated_user + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/search.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/search.yaml new file mode 100644 index 0000000..fe854a9 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/search.yaml @@ -0,0 +1,4711 @@ +openapi: 3.0.3 +info: + title: search API + description: Search for specific items on GitHub. + version: 1.1.4 +paths: + /search/code: + get: + summary: Search code + description: >- + Searches for query terms inside of a file. This method returns up to 100 + results [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + + 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](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you want to find the definition of the `addClass` + function inside [jQuery](https://github.com/jquery/jquery) repository, + your query would look something like this: + + + `q=addClass+in:file+language:js+repo:jquery/jquery` + + + 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. + + + Considerations for code search: + + + Due to the complexity of searching code, there are a few restrictions on + how searches are performed: + + + * Only the _default branch_ is considered. In most cases, this will be + the `master` branch. + + * Only files smaller than 384 KB are searchable. + + * You must always include at least one search term when searching + source code. For example, searching for + [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) + is not valid, while [`amazing + + language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) + is. + + + > [!NOTE] + + > `repository.description`, `repository.owner.type`, and + `repository.owner.node_id` are closing down on this endpoint and will + return `null` in a future API version. Use the [Get a + repository](https://docs.github.com/rest/repos/repos#get-a-repository) + endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository + metadata. + + + This endpoint requires you to authenticate and limits you to 10 requests + per minute. + tags: + - search + operationId: search/code + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-code + parameters: + - name: q + description: >- + The query contains one or more search keywords and qualifiers. + Qualifiers allow you to limit your search to specific areas of + GitHub. The REST API supports the same qualifiers as the web + interface for GitHub. To learn more about the format of the query, + see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + See "[Searching + code](https://docs.github.com/search-github/searching-on-github/searching-code)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + deprecated: true + description: >- + **This field is closing down.** Sorts the results of your query. Can + only be `indexed`, which indicates how recently a file has been + indexed by the GitHub search infrastructure. Default: [best + match](https://docs.github.com/rest/search/search#ranking-search-results) + in: query + required: false + schema: + type: string + enum: + - indexed + - name: order + description: >- + **This field is closing down.** Determines whether the first search + result returned is the highest number of matches (`desc`) or lowest + number of matches (`asc`). This parameter is ignored unless you + provide `sort`. + in: query + deprecated: true + required: false + schema: + type: string + enum: + - desc + - asc + default: desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/code-search-result-item' + examples: + default: + $ref: '#/components/examples/code-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/commits: + get: + summary: Search commits + description: >- + Find commits via various criteria on the default branch (usually + `main`). This method returns up to 100 results [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + + When searching for commits, you can get text match metadata for the + **message** field when you provide the `text-match` media type. For more + details about how to receive highlighted search results, see [Text match + + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you want to find commits related to CSS in the + [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) + repository. Your query would look something like this: + + + `q=repo:octocat/Spoon-Knife+css` + tags: + - search + operationId: search/commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-commits + parameters: + - name: q + description: >- + The query contains one or more search keywords and qualifiers. + Qualifiers allow you to limit your search to specific areas of + GitHub. The REST API supports the same qualifiers as the web + interface for GitHub. To learn more about the format of the query, + see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + See "[Searching + commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: >- + Sorts the results of your query by `author-date` or + `committer-date`. Default: [best + match](https://docs.github.com/rest/search/search#ranking-search-results) + in: query + required: false + schema: + type: string + enum: + - author-date + - committer-date + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/commit-search-result-item' + examples: + default: + $ref: '#/components/examples/commit-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/issues: + get: + summary: Search issues and pull requests + description: >- + Find issues by state and keyword. This method returns up to 100 results + [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + + When searching for issues, you can get text match metadata for the issue + **title**, issue **body**, and issue **comment body** fields when you + pass the `text-match` media type. For more details about how to receive + highlighted + + search results, see [Text match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you want to find the oldest unresolved Python bugs on + Windows. Your query might look something like this. + + + `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + + + This query searches for the keyword `windows`, within any open issue + that is labeled as `bug`. The search runs across repositories whose + primary language is Python. The results are sorted by creation date in + ascending order, which means the oldest issues appear first in the + search results. + + + > [!NOTE] + + > For requests made by GitHub Apps with a user access token, you can't + retrieve a combination of issues and pull requests in a single query. + Requests that don't include the `is:issue` or `is:pull-request` + qualifier will receive an HTTP `422 Unprocessable Entity` response. To + get results for both issues and pull requests, you must send separate + queries for issues and pull requests. For more information about the + `is` qualifier, see "[Searching only issues or pull + requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + tags: + - search + operationId: search/issues-and-pull-requests + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/search/search#search-issues-and-pull-requests + parameters: + - name: q + description: >- + The query contains one or more search keywords and qualifiers. + Qualifiers allow you to limit your search to specific areas of + GitHub. The REST API supports the same qualifiers as the web + interface for GitHub. To learn more about the format of the query, + see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + See "[Searching issues and pull + requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: >- + Sorts the results of your query by the number of `comments`, + `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, + `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or + `interactions`. You can also sort results by how recently the items + were `created` or `updated`, Default: [best + match](https://docs.github.com/rest/search/search#ranking-search-results) + in: query + required: false + schema: + type: string + enum: + - comments + - reactions + - reactions-+1 + - reactions--1 + - reactions-smile + - reactions-thinking_face + - reactions-heart + - reactions-tada + - interactions + - created + - updated + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/issues-advanced-search' + - $ref: '#/components/parameters/search-type' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + - search_type + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/issue-search-result-item' + search_type: + type: string + description: >- + The type of search that was performed. Possible values are + `lexical`, `semantic`, or `hybrid`. + enum: + - lexical + - semantic + - hybrid + lexical_fallback_reason: + type: array + description: >- + When a semantic or hybrid search falls back to lexical + search, this field contains the reasons for the fallback. + Only present when a fallback occurred. + items: + type: string + enum: + - no_text_terms + - quoted_text + - non_issue_target + - or_boolean_not_supported + - no_accessible_repos + - server_error + - only_non_semantic_fields_requested + examples: + default: + $ref: '#/components/examples/issue-search-result-item-paginated' + lexical-fallback: + $ref: >- + #/components/examples/issue-search-result-item-paginated-lexical-fallback + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/labels: + get: + summary: Search labels + description: >- + Find labels in a repository with names or descriptions that match search + keywords. Returns up to 100 results [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + + When searching for labels, you can get text match metadata for the label + **name** and **description** fields when you pass the `text-match` media + type. For more details about how to receive highlighted search results, + see [Text match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you want to find labels in the `linguist` repository + that match `bug`, `defect`, or `enhancement`. Your query might look like + this: + + + `q=bug+defect+enhancement&repository_id=64778136` + + + The labels that best match the query appear first in the search results. + tags: + - search + operationId: search/labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-labels + parameters: + - name: repository_id + description: The id of the repository. + in: query + required: true + schema: + type: integer + - name: q + description: >- + The search keywords. This endpoint does not accept qualifiers in the + query. To learn more about the format of the query, see + [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + in: query + required: true + schema: + type: string + - name: sort + description: >- + Sorts the results of your query by when the label was `created` or + `updated`. Default: [best + match](https://docs.github.com/rest/search/search#ranking-search-results) + in: query + required: false + schema: + type: string + enum: + - created + - updated + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/label-search-result-item' + examples: + default: + $ref: '#/components/examples/label-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/repositories: + get: + summary: Search repositories + description: >- + Find repositories via various criteria. This method returns up to 100 + results [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + + When searching for repositories, you can get text match metadata for the + **name** and **description** fields when you pass the `text-match` media + type. For more details about how to receive highlighted search results, + see [Text match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you want to search for popular Tetris repositories + written in assembly code, your query might look like this: + + + `q=tetris+language:assembly&sort=stars&order=desc` + + + This query searches for repositories with the word `tetris` in the name, + the description, or the README. The results are limited to repositories + where the primary language is assembly. The results are sorted by stars + in descending order, so that the most popular repositories appear first + in the search results. + tags: + - search + operationId: search/repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-repositories + parameters: + - name: q + description: >- + The query contains one or more search keywords and qualifiers. + Qualifiers allow you to limit your search to specific areas of + GitHub. The REST API supports the same qualifiers as the web + interface for GitHub. To learn more about the format of the query, + see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + See "[Searching for + repositories](https://docs.github.com/articles/searching-for-repositories/)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: >- + Sorts the results of your query by number of `stars`, `forks`, or + `help-wanted-issues` or how recently the items were `updated`. + Default: [best + match](https://docs.github.com/rest/search/search#ranking-search-results) + in: query + required: false + schema: + type: string + enum: + - stars + - forks + - help-wanted-issues + - updated + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/repo-search-result-item' + examples: + default: + $ref: '#/components/examples/repo-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/topics: + get: + summary: Search topics + description: >- + Find topics via various criteria. Results are sorted by best match. This + method returns up to 100 results [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + See "[Searching + topics](https://docs.github.com/articles/searching-topics/)" for a + detailed list of qualifiers. + + + When searching for topics, you can get text match metadata for the + topic's **short\_description**, **description**, **name**, or + **display\_name** field when you pass the `text-match` media type. For + more details about how to receive highlighted search results, see [Text + match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you want to search for topics related to Ruby that are + featured on https://github.com/topics. Your query might look like this: + + + `q=ruby+is:featured` + + + This query searches for topics with the keyword `ruby` and limits the + results to find only topics that are featured. The topics that are the + best match for the query appear first in the search results. + tags: + - search + operationId: search/topics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-topics + parameters: + - name: q + description: >- + The query contains one or more search keywords and qualifiers. + Qualifiers allow you to limit your search to specific areas of + GitHub. The REST API supports the same qualifiers as the web + interface for GitHub. To learn more about the format of the query, + see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + in: query + required: true + schema: + type: string + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/topic-search-result-item' + examples: + default: + $ref: '#/components/examples/topic-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/users: + get: + summary: Search users + description: >- + Find users via various criteria. This method returns up to 100 results + [per + page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + + When searching for users, you can get text match metadata for the issue + **login**, public **email**, and **name** fields when you pass the + `text-match` media type. For more details about highlighting search + results, see [Text match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + For more details about how to receive highlighted search results, see + [Text match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + + For example, if you're looking for a list of popular users, you might + try this query: + + + `q=tom+repos:%3E42+followers:%3E1000` + + + This query searches for users with the name `tom`. The results are + restricted to users with more than 42 repositories and over 1,000 + followers. + + + This endpoint does not accept authentication and will only include + publicly visible users. As an alternative, you can use the GraphQL API. + The GraphQL API requires authentication and will return private users, + including Enterprise Managed Users (EMUs), that you are authorized to + view. For more information, see "[GraphQL + Queries](https://docs.github.com/graphql/reference/queries#search)." + tags: + - search + operationId: search/users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-users + parameters: + - name: q + description: >- + The query contains one or more search keywords and qualifiers. + Qualifiers allow you to limit your search to specific areas of + GitHub. The REST API supports the same qualifiers as the web + interface for GitHub. To learn more about the format of the query, + see [Constructing a search + query](https://docs.github.com/rest/search/search#constructing-a-search-query). + See "[Searching + users](https://docs.github.com/search-github/searching-on-github/searching-users)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: >- + Sorts the results of your query by number of `followers` or + `repositories`, or when the person `joined` GitHub. Default: [best + match](https://docs.github.com/rest/search/search#ranking-search-results) + in: query + required: false + schema: + type: string + enum: + - followers + - repositories + - joined + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/user-search-result-item' + examples: + default: + $ref: '#/components/examples/user-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search +components: + schemas: + code-search-result-item: + title: Code Search Result Item + description: Code Search Result Item + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + html_url: + type: string + format: uri + repository: + $ref: '#/components/schemas/minimal-repository' + score: + type: number + file_size: + type: integer + language: + type: string + nullable: true + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + example: + - 73..77 + - 77..78 + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + required: + - score + - name + - path + - sha + - git_url + - html_url + - url + - repository + commit-search-result-item: + title: Commit Search Result Item + description: Commit Search Result Item + type: object + properties: + url: + type: string + format: uri + sha: + type: string + html_url: + type: string + format: uri + comments_url: + type: string + format: uri + commit: + type: object + properties: + author: + type: object + properties: + name: + type: string + email: + type: string + date: + type: string + format: date-time + required: + - name + - email + - date + committer: + $ref: '#/components/schemas/nullable-git-user' + comment_count: + type: integer + message: + type: string + tree: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + url: + type: string + format: uri + verification: + $ref: '#/components/schemas/verification' + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + $ref: '#/components/schemas/nullable-simple-user' + committer: + $ref: '#/components/schemas/nullable-git-user' + parents: + type: array + items: + type: object + properties: + url: + type: string + html_url: + type: string + sha: + type: string + repository: + $ref: '#/components/schemas/minimal-repository' + score: + type: number + node_id: + type: string + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + required: + - sha + - node_id + - url + - html_url + - author + - committer + - parents + - comments_url + - commit + - repository + - score + issue-search-result-item: + title: Issue Search Result Item + description: Issue Search Result Item + type: object + properties: + url: + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + node_id: + type: string + number: + type: integer + title: + type: string + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + color: + type: string + default: + type: boolean + description: + type: string + nullable: true + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + state: + type: string + state_reason: + type: string + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: string + format: date-time + nullable: true + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + body: + type: string + score: + type: number + author_association: + $ref: '#/components/schemas/author-association' + draft: + type: boolean + repository: + $ref: '#/components/schemas/repository' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - author_association + - created_at + - updated_at + - score + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - author_association + - created_at + - updated_at + - score + type: object + version: '2026-03-10' + label-search-result-item: + title: Label Search Result Item + description: Label Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + name: + type: string + color: + type: string + default: + type: boolean + description: + type: string + nullable: true + score: + type: number + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + required: + - id + - node_id + - url + - name + - color + - default + - description + - score + repo-search-result-item: + title: Repo Search Result Item + description: Repo Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + $ref: '#/components/schemas/nullable-simple-user' + private: + type: boolean + html_url: + type: string + format: uri + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + format: uri + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + pushed_at: + type: string + format: date-time + homepage: + type: string + format: uri + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + forks_count: + type: integer + open_issues_count: + type: integer + master_branch: + type: string + default_branch: + type: string + score: + type: number + forks_url: + type: string + format: uri + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + format: uri + hooks_url: + type: string + format: uri + issue_events_url: + type: string + events_url: + type: string + format: uri + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + format: uri + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + format: uri + stargazers_url: + type: string + format: uri + contributors_url: + type: string + format: uri + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + format: uri + archive_url: + type: string + downloads_url: + type: string + format: uri + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + format: uri + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + format: uri + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + topics: + type: array + items: + type: string + mirror_url: + type: string + format: uri + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + license: + $ref: '#/components/schemas/nullable-license-simple' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - score + topic-search-result-item: + title: Topic Search Result Item + description: Topic Search Result Item + type: object + properties: + name: + type: string + display_name: + type: string + nullable: true + short_description: + type: string + nullable: true + description: + type: string + nullable: true + created_by: + type: string + nullable: true + released: + type: string + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + featured: + type: boolean + curated: + type: boolean + score: + type: number + repository_count: + type: integer + nullable: true + logo_url: + type: string + format: uri + nullable: true + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + related: + type: array + nullable: true + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + aliases: + type: array + nullable: true + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + required: + - name + - display_name + - short_description + - description + - created_by + - released + - created_at + - updated_at + - featured + - curated + - score + user-search-result-item: + title: User Search Result Item + description: User Search Result Item + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + received_events_url: + type: string + format: uri + type: + type: string + score: + type: number + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + events_url: + type: string + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + name: + type: string + nullable: true + bio: + type: string + nullable: true + email: + type: string + format: email + nullable: true + location: + type: string + nullable: true + site_admin: + type: boolean + hireable: + type: boolean + nullable: true + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + blog: + type: string + nullable: true + company: + type: string + nullable: true + suspended_at: + type: string + format: date-time + nullable: true + user_view_type: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - score + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + nullable: true + type: string + property: + type: string + fragment: + type: string + matches: + type: array + items: + type: object + properties: + text: + type: string + indices: + type: array + items: + type: integer + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' + nullable: true + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: >- + Details about the selected option (only present for single_select + fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + nullable-integration: + title: GitHub app + description: >- + GitHub apps are a new way to extend GitHub. They can be installed + directly on organizations and user accounts and granted access to + specific repositories. They come with granular permissions and built-in + webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: >- + The list of events for the GitHub app. Note that the + `installation_target`, `security_advisory`, and `meta` events are + not included because they are global events and not specific to an + installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: >- + The number of installations associated with the GitHub app. Only + returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + order: + name: order + description: >- + Determines whether the first search result returned is the highest + number of matches (`desc`) or lowest number of matches (`asc`). This + parameter is ignored unless you provide `sort`. + in: query + required: false + schema: + type: string + enum: + - desc + - asc + default: desc + issues-advanced-search: + name: advanced_search + description: >- + Set to `true` to use advanced search. + + Example: + `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string + search-type: + name: search_type + description: >- + The type of search to perform on issues. When not specified, the default + is lexical search. + + + - `semantic` β€” performs a pure semantic (vector) search using + embedding-based understanding. + + - `hybrid` β€” combines semantic search with lexical search for best + results. + + + Semantic and hybrid search require authentication and are rate limited + to 10 requests per minute. + + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid + examples: + code-search-result-item-paginated: + value: + total_count: 7 + incomplete_results: false + items: + - name: classes.js + path: src/attributes/classes.js + sha: d7212f9dee2dcc18f084d7df8f417b80846ded5a + url: >- + https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4 + git_url: >- + https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a + html_url: >- + https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js + repository: + id: 167174 + node_id: MDEwOlJlcG9zaXRvcnkxNjcxNzQ= + name: jquery + full_name: jquery/jquery + owner: + login: jquery + id: 70142 + node_id: MDQ6VXNlcjcwMTQy + avatar_url: >- + https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png + gravatar_id: '' + url: https://api.github.com/users/jquery + html_url: https://github.com/jquery + followers_url: https://api.github.com/users/jquery/followers + following_url: https://api.github.com/users/jquery/following{/other_user} + gists_url: https://api.github.com/users/jquery/gists{/gist_id} + starred_url: https://api.github.com/users/jquery/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/jquery/subscriptions + organizations_url: https://api.github.com/users/jquery/orgs + repos_url: https://api.github.com/users/jquery/repos + events_url: https://api.github.com/users/jquery/events{/privacy} + received_events_url: https://api.github.com/users/jquery/received_events + type: Organization + site_admin: false + private: false + html_url: https://github.com/jquery/jquery + description: jQuery JavaScript Library + fork: false + url: https://api.github.com/repos/jquery/jquery + forks_url: https://api.github.com/repos/jquery/jquery/forks + keys_url: https://api.github.com/repos/jquery/jquery/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/jquery/jquery/collaborators{/collaborator} + teams_url: https://api.github.com/repos/jquery/jquery/teams + hooks_url: https://api.github.com/repos/jquery/jquery/hooks + issue_events_url: >- + https://api.github.com/repos/jquery/jquery/issues/events{/number} + events_url: https://api.github.com/repos/jquery/jquery/events + assignees_url: https://api.github.com/repos/jquery/jquery/assignees{/user} + branches_url: https://api.github.com/repos/jquery/jquery/branches{/branch} + tags_url: https://api.github.com/repos/jquery/jquery/tags + blobs_url: https://api.github.com/repos/jquery/jquery/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/jquery/jquery/git/tags{/sha} + git_refs_url: https://api.github.com/repos/jquery/jquery/git/refs{/sha} + trees_url: https://api.github.com/repos/jquery/jquery/git/trees{/sha} + statuses_url: https://api.github.com/repos/jquery/jquery/statuses/{sha} + languages_url: https://api.github.com/repos/jquery/jquery/languages + stargazers_url: https://api.github.com/repos/jquery/jquery/stargazers + contributors_url: https://api.github.com/repos/jquery/jquery/contributors + subscribers_url: https://api.github.com/repos/jquery/jquery/subscribers + subscription_url: https://api.github.com/repos/jquery/jquery/subscription + commits_url: https://api.github.com/repos/jquery/jquery/commits{/sha} + git_commits_url: https://api.github.com/repos/jquery/jquery/git/commits{/sha} + comments_url: https://api.github.com/repos/jquery/jquery/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/jquery/jquery/issues/comments/{number} + contents_url: https://api.github.com/repos/jquery/jquery/contents/{+path} + compare_url: >- + https://api.github.com/repos/jquery/jquery/compare/{base}...{head} + merges_url: https://api.github.com/repos/jquery/jquery/merges + archive_url: >- + https://api.github.com/repos/jquery/jquery/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/jquery/jquery/downloads + issues_url: https://api.github.com/repos/jquery/jquery/issues{/number} + pulls_url: https://api.github.com/repos/jquery/jquery/pulls{/number} + milestones_url: https://api.github.com/repos/jquery/jquery/milestones{/number} + notifications_url: >- + https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/jquery/jquery/labels{/name} + deployments_url: http://api.github.com/repos/octocat/Hello-World/deployments + releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} + score: 1 + commit-search-result-item-paginated: + value: + total_count: 1 + incomplete_results: false + items: + - url: >- + https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + sha: bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + html_url: >- + https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + comments_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments + commit: + url: >- + https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + author: + date: '2014-02-04T14:38:36-08:00' + name: The Octocat + email: octocat@nowhere.com + committer: + date: '2014-02-12T15:18:55-08:00' + name: The Octocat + email: octocat@nowhere.com + message: Create styles.css and updated README + tree: + url: >- + https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68 + sha: a639e96f9038797fba6e0469f94a4b0cc459fa68 + comment_count: 8 + author: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=3 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: {} + parents: + - url: >- + https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4 + html_url: >- + https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4 + sha: a30c19e3f13765a3b48829788bc1cb8b4e95cee4 + repository: + id: 1300192 + node_id: MDEwOlJlcG9zaXRvcnkxMzAwMTky + name: Spoon-Knife + full_name: octocat/Spoon-Knife + owner: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=3 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Spoon-Knife + description: This repo is for demonstration purposes only. + fork: false + url: https://api.github.com/repos/octocat/Spoon-Knife + forks_url: https://api.github.com/repos/octocat/Spoon-Knife/forks + keys_url: https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id} + collaborators_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octocat/Spoon-Knife/teams + hooks_url: https://api.github.com/repos/octocat/Spoon-Knife/hooks + issue_events_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number} + events_url: https://api.github.com/repos/octocat/Spoon-Knife/events + assignees_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user} + branches_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch} + tags_url: https://api.github.com/repos/octocat/Spoon-Knife/tags + blobs_url: https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha} + trees_url: https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha} + statuses_url: https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha} + languages_url: https://api.github.com/repos/octocat/Spoon-Knife/languages + stargazers_url: https://api.github.com/repos/octocat/Spoon-Knife/stargazers + contributors_url: https://api.github.com/repos/octocat/Spoon-Knife/contributors + subscribers_url: https://api.github.com/repos/octocat/Spoon-Knife/subscribers + subscription_url: https://api.github.com/repos/octocat/Spoon-Knife/subscription + commits_url: https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha} + git_commits_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha} + comments_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/comments{/number} + issue_comment_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number} + contents_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path} + compare_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head} + merges_url: https://api.github.com/repos/octocat/Spoon-Knife/merges + archive_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octocat/Spoon-Knife/downloads + issues_url: https://api.github.com/repos/octocat/Spoon-Knife/issues{/number} + pulls_url: https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number} + milestones_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octocat/Spoon-Knife/labels{/name} + releases_url: https://api.github.com/repos/octocat/Spoon-Knife/releases{/id} + deployments_url: https://api.github.com/repos/octocat/Spoon-Knife/deployments + score: 1 + node_id: MDQ6VXNlcjU4MzIzMQ== + issue-search-result-item-paginated: + summary: Hybrid search response + value: + total_count: 280 + incomplete_results: false + search_type: hybrid + items: + - url: >- + https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 + repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit + labels_url: >- + https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name} + comments_url: >- + https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments + events_url: >- + https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events + html_url: https://github.com/batterseapower/pinyin-toolkit/issues/132 + id: 35802 + node_id: MDU6SXNzdWUzNTgwMg== + number: 132 + title: Line Number Indexes Beyond 20 Not Displayed + user: + login: Nick3C + id: 90254 + node_id: MDQ6VXNlcjkwMjU0 + avatar_url: >- + https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png + gravatar_id: '' + url: https://api.github.com/users/Nick3C + html_url: https://github.com/Nick3C + followers_url: https://api.github.com/users/Nick3C/followers + following_url: https://api.github.com/users/Nick3C/following{/other_user} + gists_url: https://api.github.com/users/Nick3C/gists{/gist_id} + starred_url: https://api.github.com/users/Nick3C/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/Nick3C/subscriptions + organizations_url: https://api.github.com/users/Nick3C/orgs + repos_url: https://api.github.com/users/Nick3C/repos + events_url: https://api.github.com/users/Nick3C/events{/privacy} + received_events_url: https://api.github.com/users/Nick3C/received_events + type: User + site_admin: true + labels: + - id: 4 + node_id: MDU6TGFiZWw0 + url: >- + https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug + name: bug + color: ff0000 + state: open + assignee: null + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + comments: 15 + created_at: '2009-07-12T20:10:41Z' + updated_at: '2009-07-19T09:23:43Z' + closed_at: null + pull_request: + url: https://api/github.com/repos/octocat/Hello-World/pull/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + body: ... + score: 1 + locked: true + author_association: COLLABORATOR + state_reason: completed + issue-search-result-item-paginated-lexical-fallback: + summary: Hybrid search with lexical fallback + description: >- + When a hybrid or semantic search falls back to lexical, the response + includes search_type set to "lexical" and lexical_fallback_reason + listing the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - ... + label-search-result-item-paginated: + value: + total_count: 2 + incomplete_results: false + items: + - id: 418327088 + node_id: MDU6TGFiZWw0MTgzMjcwODg= + url: https://api.github.com/repos/octocat/linguist/labels/enhancement + name: enhancement + color: 84b6eb + default: true + description: New feature or request. + score: 1 + - id: 418327086 + node_id: MDU6TGFiZWw0MTgzMjcwODY= + url: https://api.github.com/repos/octocat/linguist/labels/bug + name: bug + color: ee0701 + default: true + description: Something isn't working. + score: 1 + repo-search-result-item-paginated: + value: + total_count: 40 + incomplete_results: false + items: + - id: 3081286 + node_id: MDEwOlJlcG9zaXRvcnkzMDgxMjg2 + name: Tetris + full_name: dtrupenn/Tetris + owner: + login: dtrupenn + id: 872147 + node_id: MDQ6VXNlcjg3MjE0Nw== + avatar_url: >- + https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png + gravatar_id: '' + url: https://api.github.com/users/dtrupenn + received_events_url: https://api.github.com/users/dtrupenn/received_events + type: User + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + site_admin: true + private: false + html_url: https://github.com/dtrupenn/Tetris + description: A C implementation of Tetris using Pennsim through LC4 + fork: false + url: https://api.github.com/repos/dtrupenn/Tetris + created_at: '2012-01-01T00:31:50Z' + updated_at: '2013-01-05T17:58:47Z' + pushed_at: '2012-01-01T00:37:02Z' + homepage: https://github.com + size: 524 + stargazers_count: 1 + watchers_count: 1 + language: Assembly + forks_count: 0 + open_issues_count: 0 + master_branch: master + default_branch: master + score: 1 + archive_url: >- + https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/dtrupenn/Tetris/assignees{/user} + blobs_url: https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha} + branches_url: https://api.github.com/repos/dtrupenn/Tetris/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator} + comments_url: https://api.github.com/repos/dtrupenn/Tetris/comments{/number} + commits_url: https://api.github.com/repos/dtrupenn/Tetris/commits{/sha} + compare_url: >- + https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head} + contents_url: https://api.github.com/repos/dtrupenn/Tetris/contents/{+path} + contributors_url: https://api.github.com/repos/dtrupenn/Tetris/contributors + deployments_url: https://api.github.com/repos/dtrupenn/Tetris/deployments + downloads_url: https://api.github.com/repos/dtrupenn/Tetris/downloads + events_url: https://api.github.com/repos/dtrupenn/Tetris/events + forks_url: https://api.github.com/repos/dtrupenn/Tetris/forks + git_commits_url: https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha} + git_refs_url: https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha} + git_tags_url: https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha} + git_url: git:github.com/dtrupenn/Tetris.git + issue_comment_url: >- + https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number} + issues_url: https://api.github.com/repos/dtrupenn/Tetris/issues{/number} + keys_url: https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id} + labels_url: https://api.github.com/repos/dtrupenn/Tetris/labels{/name} + languages_url: https://api.github.com/repos/dtrupenn/Tetris/languages + merges_url: https://api.github.com/repos/dtrupenn/Tetris/merges + milestones_url: https://api.github.com/repos/dtrupenn/Tetris/milestones{/number} + notifications_url: >- + https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/dtrupenn/Tetris/pulls{/number} + releases_url: https://api.github.com/repos/dtrupenn/Tetris/releases{/id} + ssh_url: git@github.com:dtrupenn/Tetris.git + stargazers_url: https://api.github.com/repos/dtrupenn/Tetris/stargazers + statuses_url: https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha} + subscribers_url: https://api.github.com/repos/dtrupenn/Tetris/subscribers + subscription_url: https://api.github.com/repos/dtrupenn/Tetris/subscription + tags_url: https://api.github.com/repos/dtrupenn/Tetris/tags + teams_url: https://api.github.com/repos/dtrupenn/Tetris/teams + trees_url: https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha} + clone_url: https://github.com/dtrupenn/Tetris.git + mirror_url: git:git.example.com/dtrupenn/Tetris + hooks_url: https://api.github.com/repos/dtrupenn/Tetris/hooks + svn_url: https://svn.github.com/dtrupenn/Tetris + forks: 1 + open_issues: 1 + watchers: 1 + has_issues: true + has_projects: true + has_pages: true + has_wiki: true + has_downloads: true + archived: true + disabled: true + visibility: private + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topic-search-result-item-paginated: + value: + total_count: 6 + incomplete_results: false + items: + - name: ruby + display_name: Ruby + short_description: >- + Ruby is a scripting language designed for simplified + object-oriented programming. + description: "Ruby was developed by\_Yukihiro \"Matz\" Matsumoto\_in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python." + created_by: Yukihiro Matsumoto + released: December 21, 1995 + created_at: '2016-11-28T22:03:59Z' + updated_at: '2017-10-30T18:16:32Z' + featured: true + curated: true + score: 1 + - name: rails + display_name: Rails + short_description: >- + Ruby on Rails (Rails) is a web application framework written in + Ruby. + description: >- + Ruby on Rails (Rails) is a web application framework written in + Ruby. It is meant to help simplify the building of complex + websites. + created_by: David Heinemeier Hansson + released: December 13 2005 + created_at: '2016-12-09T17:03:50Z' + updated_at: '2017-10-30T16:20:19Z' + featured: true + curated: true + score: 1 + - name: python + display_name: Python + short_description: Python is a dynamically typed programming language. + description: >- + Python is a dynamically typed programming language designed by + Guido Van Rossum. Much like the programming language Ruby, Python + was designed to be easily read by programmers. Because of its + large following and many libraries, Python can be implemented and + used to do anything from webpages to scientific research. + created_by: Guido van Rossum + released: February 20, 1991 + created_at: '2016-12-07T00:07:02Z' + updated_at: '2017-10-27T22:45:43Z' + featured: true + curated: true + score: 1 + - name: jekyll + display_name: Jekyll + short_description: Jekyll is a simple, blog-aware static site generator. + description: >- + Jekyll is a blog-aware, site generator written in Ruby. It takes + raw text files, runs it through a renderer and produces a + publishable static website. + created_by: Tom Preston-Werner + released: '2008' + created_at: '2016-12-16T21:53:08Z' + updated_at: '2017-10-27T19:00:24Z' + featured: true + curated: true + score: 1 + - name: sass + display_name: Sass + short_description: Sass is a stable extension to classic CSS. + description: >- + Sass is a stylesheet language with a main implementation in Ruby. + It is an extension of CSS that makes improvements to the old + stylesheet format, such as being able to declare variables and + using a cleaner nesting syntax. + created_by: Hampton Catlin, Natalie Weizenbaum, Chris Eppstein + released: November 28, 2006 + created_at: '2016-12-16T21:53:45Z' + updated_at: '2018-01-16T16:30:40Z' + featured: true + curated: true + score: 1 + - name: homebrew + display_name: Homebrew + short_description: Homebrew is a package manager for macOS. + description: >- + Homebrew is a package manager for Apple's macOS operating system. + It simplifies the installation of software and is popular in the + Ruby on Rails community. + created_by: Max Howell + released: '2009' + created_at: '2016-12-17T20:30:44Z' + updated_at: '2018-02-06T16:14:56Z' + featured: true + curated: true + score: 1 + user-search-result-item-paginated: + value: + total_count: 12 + incomplete_results: false + items: + - login: mojombo + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: >- + https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png + gravatar_id: '' + url: https://api.github.com/users/mojombo + html_url: https://github.com/mojombo + followers_url: https://api.github.com/users/mojombo/followers + subscriptions_url: https://api.github.com/users/mojombo/subscriptions + organizations_url: https://api.github.com/users/mojombo/orgs + repos_url: https://api.github.com/users/mojombo/repos + received_events_url: https://api.github.com/users/mojombo/received_events + type: User + score: 1 + following_url: https://api.github.com/users/mojombo/following{/other_user} + gists_url: https://api.github.com/users/mojombo/gists{/gist_id} + starred_url: https://api.github.com/users/mojombo/starred{/owner}{/repo} + events_url: https://api.github.com/users/mojombo/events{/privacy} + site_admin: true + x-stackQL-resources: + code: + id: github.search.code + name: code + title: Code + methods: + code: + operation: + $ref: '#/paths/~1search~1code/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/code/methods/code' + insert: [] + update: [] + delete: [] + replace: [] + commits: + id: github.search.commits + name: commits + title: Commits + methods: + commits: + operation: + $ref: '#/paths/~1search~1commits/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/commits/methods/commits' + insert: [] + update: [] + delete: [] + replace: [] + issues_and_pull_requests: + id: github.search.issues_and_pull_requests + name: issues_and_pull_requests + title: Issues And Pull Requests + methods: + issues_and_pull_requests: + operation: + $ref: '#/paths/~1search~1issues/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/issues_and_pull_requests/methods/issues_and_pull_requests + insert: [] + update: [] + delete: [] + replace: [] + labels: + id: github.search.labels + name: labels + title: Labels + methods: + labels: + operation: + $ref: '#/paths/~1search~1labels/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/labels/methods/labels' + insert: [] + update: [] + delete: [] + replace: [] + repos: + id: github.search.repos + name: repos + title: Repos + methods: + repos: + operation: + $ref: '#/paths/~1search~1repositories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repos/methods/repos' + insert: [] + update: [] + delete: [] + replace: [] + topics: + id: github.search.topics + name: topics + title: Topics + methods: + topics: + operation: + $ref: '#/paths/~1search~1topics/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/topics/methods/topics' + insert: [] + update: [] + delete: [] + replace: [] + users: + id: github.search.users + name: users + title: Users + methods: + users: + operation: + $ref: '#/paths/~1search~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/users' + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/secret_scanning.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/secret_scanning.yaml new file mode 100644 index 0000000..3f63c9e --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/secret_scanning.yaml @@ -0,0 +1,3296 @@ +openapi: 3.0.3 +info: + title: secret_scanning API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/secret-scanning/alerts: + get: + summary: List secret scanning alerts for an organization + description: >- + Lists secret scanning alerts for eligible repositories in an + organization, from newest to oldest. + + + The authenticated user must be an administrator or security manager for + the organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-scanning-alert-state' + - $ref: '#/components/parameters/secret-scanning-alert-secret-type' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-secret-types' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-providers' + - $ref: '#/components/parameters/secret-scanning-alert-providers' + - $ref: '#/components/parameters/secret-scanning-alert-resolution' + - $ref: '#/components/parameters/secret-scanning-alert-assignee' + - $ref: '#/components/parameters/secret-scanning-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/secret-scanning-pagination-before-org-repo' + - $ref: '#/components/parameters/secret-scanning-pagination-after-org-repo' + - $ref: '#/components/parameters/secret-scanning-alert-validity' + - $ref: '#/components/parameters/secret-scanning-alert-publicly-leaked' + - $ref: '#/components/parameters/secret-scanning-alert-multi-repo' + - $ref: '#/components/parameters/secret-scanning-alert-hide-secret' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-secret-scanning-alert' + examples: + default: + $ref: >- + #/components/examples/organization-secret-scanning-alert-list + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /orgs/{org}/secret-scanning/pattern-configurations: + get: + summary: List organization pattern configurations + description: >- + Lists the secret scanning pattern configurations for an organization. + + + Personal access tokens (classic) need the `read:org` scope to use this + endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-pattern-configuration' + examples: + default: + $ref: '#/components/examples/secret-scanning-pattern-configuration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-stackQL-resource: push_protection + patch: + summary: Update organization pattern configurations + description: >- + Updates the secret scanning pattern configurations for an organization. + + + Personal access tokens (classic) need the `write:org` scope to use this + endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + $ref: '#/components/schemas/secret-scanning-row-version' + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + $ref: '#/components/schemas/secret-scanning-row-version' + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-stackQL-resource: push_protection + /repos/{owner}/{repo}/secret-scanning/alerts: + get: + summary: List secret scanning alerts for a repository + description: >- + Lists secret scanning alerts for an eligible repository, from newest to + oldest. + + + The authenticated user must be an administrator for the repository or + for the organization that owns the repository to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-repo + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-scanning-alert-state' + - $ref: '#/components/parameters/secret-scanning-alert-secret-type' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-secret-types' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-providers' + - $ref: '#/components/parameters/secret-scanning-alert-providers' + - $ref: '#/components/parameters/secret-scanning-alert-resolution' + - $ref: '#/components/parameters/secret-scanning-alert-assignee' + - $ref: '#/components/parameters/secret-scanning-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/secret-scanning-pagination-before-org-repo' + - $ref: '#/components/parameters/secret-scanning-pagination-after-org-repo' + - $ref: '#/components/parameters/secret-scanning-alert-validity' + - $ref: '#/components/parameters/secret-scanning-alert-publicly-leaked' + - $ref: '#/components/parameters/secret-scanning-alert-multi-repo' + - $ref: '#/components/parameters/secret-scanning-alert-hide-secret' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/secret-scanning-alert-list' + '404': + description: >- + Repository is public or secret scanning is disabled for the + repository + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}: + get: + summary: Get a secret scanning alert + description: >- + Gets a single secret scanning alert detected in an eligible repository. + + + The authenticated user must be an administrator for the repository or + for the organization that owns the repository to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - secret-scanning + operationId: secret-scanning/get-alert + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + - $ref: '#/components/parameters/secret-scanning-alert-hide-secret' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/secret-scanning-alert-open' + '304': + $ref: '#/components/responses/not_modified' + '404': + description: >- + Repository is public, or secret scanning is disabled for the + repository, or the resource is not found + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + patch: + summary: Update a secret scanning alert + description: >- + Updates the status of a secret scanning alert in an eligible repository. + + + You can also use this endpoint to assign or unassign an alert to a user + who has write access to the repository. + + + The authenticated user must be an administrator for the repository or + for the organization that owns the repository to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + operationId: secret-scanning/update-alert + tags: + - secret-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + $ref: '#/components/schemas/secret-scanning-alert-state' + resolution: + $ref: '#/components/schemas/secret-scanning-alert-resolution' + resolution_comment: + $ref: >- + #/components/schemas/secret-scanning-alert-resolution-comment + assignee: + $ref: '#/components/schemas/secret-scanning-alert-assignee' + required: + - state + - assignee + - validity + examples: + default: + value: + state: resolved + resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: null + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/secret-scanning-alert-resolved' + '400': + description: >- + Bad request, resolution comment is invalid or the resolution was not + changed. + '404': + description: >- + Repository is public, or secret scanning is disabled for the + repository, or the resource is not found + '422': + description: >- + State does not match the resolution or resolution comment, or + assignee does not have write access to the repository + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations: + get: + summary: List locations for a secret scanning alert + description: >- + Lists all locations for a given secret scanning alert for an eligible + repository. + + + The authenticated user must be an administrator for the repository or + for the organization that owns the repository to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - secret-scanning + operationId: secret-scanning/list-locations-for-alert + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: List of locations where the secret was detected + items: + $ref: '#/components/schemas/secret-scanning-location' + examples: + default: + $ref: '#/components/examples/secret-scanning-location-list' + headers: + Link: + $ref: '#/components/headers/link' + '404': + description: >- + Repository is public, or secret scanning is disabled for the + repository, or the resource is not found + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/push-protection-bypasses: + post: + summary: Create a push protection bypass + description: >- + Creates a bypass for a previously push protected secret. + + + The authenticated user must be the original author of the committed + secret. + + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + operationId: secret-scanning/create-push-protection-bypass + tags: + - secret-scanning + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reason: + $ref: >- + #/components/schemas/secret-scanning-push-protection-bypass-reason + placeholder_id: + $ref: >- + #/components/schemas/secret-scanning-push-protection-bypass-placeholder-id + required: + - reason + - placeholder_id + examples: + default: + value: + reason: will_fix_later + placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass' + examples: + default: + $ref: '#/components/examples/secret-scanning-push-protection-bypass' + '403': + description: User does not have enough permissions to perform this action. + '404': + description: >- + Placeholder ID not found, or push protection is disabled on this + repository. + '422': + description: Bad request, input data missing or incorrect. + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/scan-history: + get: + summary: Get secret scanning scan history for a repository + description: >- + Lists the latest default incremental and backfill scans by type for a + repository. Scans from Copilot Secret Scanning are not included. + + + > [!NOTE] + + > This endpoint requires [GitHub Advanced + Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `security_events` scope to use this endpoint. If this endpoint is only + used with public repositories, the token can use the `public_repo` scope + instead. + tags: + - secret-scanning + operationId: secret-scanning/get-scan-history + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-scan-history' + examples: + default: + $ref: '#/components/examples/secret-scanning-scan-history' + '404': + description: >- + Repository does not have GitHub Advanced Security or secret scanning + enabled + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning +components: + schemas: + organization-secret-scanning-alert: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/nullable-alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + $ref: '#/components/schemas/secret-scanning-alert-state' + resolution: + $ref: '#/components/schemas/secret-scanning-alert-resolution' + resolved_at: + type: string + format: date-time + description: >- + The time that the alert was resolved in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + nullable: true + resolved_by: + $ref: '#/components/schemas/nullable-simple-user' + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: >- + User-friendly name for the detected secret, matching the + `secret_type`. + + For a list of built-in patterns, see "[Supported secret scanning + patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: string + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + description: >- + The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the + `providers` or `exclude_providers` parameters. + nullable: true + secret: + type: string + description: The secret that was detected. + repository: + $ref: '#/components/schemas/simple-repository' + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypassed_at: + type: string + format: date-time + description: >- + The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + nullable: true + push_protection_bypass_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: >- + Whether the detected secret was found in multiple repositories in + the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 encoded + nullable: true + first_location_detected: + $ref: >- + #/components/schemas/nullable-secret-scanning-first-detected-location + has_more_locations: + type: boolean + description: >- + A boolean value representing whether or not the token in the alert + was detected in more than one location. + assigned_to: + $ref: '#/components/schemas/nullable-simple-user' + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: >- + A collection of secret scanning patterns and their settings related to + push protection. + type: object + properties: + pattern_config_version: + $ref: '#/components/schemas/secret-scanning-row-version' + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + $ref: '#/components/schemas/secret-scanning-pattern-override' + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + $ref: '#/components/schemas/secret-scanning-pattern-override' + secret-scanning-row-version: + type: string + description: >- + The version of the entity. This is used to confirm you're updating the + current version of the entity and mitigate unintentionally overriding + someone else's update. + nullable: true + secret-scanning-alert: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/nullable-alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + $ref: '#/components/schemas/secret-scanning-alert-state' + resolution: + $ref: '#/components/schemas/secret-scanning-alert-resolution' + resolved_at: + type: string + format: date-time + description: >- + The time that the alert was resolved in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + nullable: true + resolved_by: + $ref: '#/components/schemas/nullable-simple-user' + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: >- + User-friendly name for the detected secret, matching the + `secret_type`. + + For a list of built-in patterns, see "[Supported secret scanning + patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: string + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + description: >- + The slug identifier for the provider of the secret that was + detected. Use this value for filtering by provider with the + `providers` or `exclude_providers` parameters. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypassed_at: + type: string + format: date-time + description: >- + The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + nullable: true + push_protection_bypass_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: >- + Whether the detected secret was found in multiple repositories under + the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 encoded + nullable: true + first_location_detected: + $ref: >- + #/components/schemas/nullable-secret-scanning-first-detected-location + has_more_locations: + type: boolean + description: >- + A boolean value representing whether or not the token in the alert + was detected in more than one location. + assigned_to: + $ref: '#/components/schemas/nullable-simple-user' + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + secret-scanning-alert-state: + description: >- + Sets the state of the secret scanning alert. You must provide + `resolution` when you set the state to `resolved`. + type: string + enum: + - open + - resolved + secret-scanning-alert-resolution: + type: string + description: >- + **Required when the `state` is `resolved`.** The reason for resolving + the alert. + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + secret-scanning-alert-resolution-comment: + description: >- + An optional comment when closing or reopening an alert. Cannot be + updated or deleted. + type: string + nullable: true + secret-scanning-alert-assignee: + description: >- + The username of the user to assign to the alert. Set to `null` to + unassign the alert. + type: string + nullable: true + secret-scanning-location: + type: object + properties: + type: + type: string + enum: + - commit + - wiki_commit + - issue_title + - issue_body + - issue_comment + - discussion_title + - discussion_body + - discussion_comment + - pull_request_title + - pull_request_body + - pull_request_comment + - pull_request_review + - pull_request_review_comment + description: >- + The location type. Because secrets may be found in different types + of resources (ie. code, comments, issues, pull requests, + discussions), this field identifies the type of resource where the + secret was found. + example: commit + details: + description: >- + Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a + repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: /example/secrets.txt + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: >- + The column at which the secret starts within the start line when + the file is interpreted as 8BIT ASCII + end_column: + type: number + description: >- + The column at which the secret ends within the end line when the + file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + example: >- + https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: >- + https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_comment_url: + type: string + format: uri + description: >- + The API URL to get the issue comment where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: >- + https://github.com/community/community/discussions/39082#discussion-4566270 + discussion_comment_url: + type: string + format: uri + description: >- + The API URL to get the discussion comment where the secret was + detected. + example: >- + https://github.com/community/community/discussions/39082#discussioncomment-4158232 + pull_request_title_url: + type: string + format: uri + description: >- + The API URL to get the pull request where the secret was + detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_body_url: + type: string + format: uri + description: >- + The API URL to get the pull request where the secret was + detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_comment_url: + type: string + format: uri + description: >- + The API URL to get the pull request comment where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + pull_request_review_url: + type: string + format: uri + description: >- + The API URL to get the pull request review where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + pull_request_review_comment_url: + type: string + format: uri + description: >- + The API URL to get the pull request review comment where the + secret was detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - page_url + - issue_title_url + - issue_body_url + - issue_comment_url + - discussion_title_url + - discussion_body_url + - discussion_comment_url + - pull_request_title_url + - pull_request_body_url + - pull_request_comment_url + - pull_request_review_url + - pull_request_review_comment_url + secret-scanning-push-protection-bypass-reason: + description: The reason for bypassing push protection. + type: string + enum: + - false_positive + - used_in_tests + - will_fix_later + secret-scanning-push-protection-bypass-placeholder-id: + description: >- + The ID of the push protection bypass placeholder. This value is returned + on any push protected routes. + type: string + secret-scanning-push-protection-bypass: + type: object + properties: + reason: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-reason' + expire_at: + type: string + format: date-time + description: >- + The time that the bypass will expire in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + nullable: true + token_type: + type: string + description: The token type this bypass is for. + secret-scanning-scan-history: + type: object + properties: + incremental_scans: + type: array + items: + $ref: '#/components/schemas/secret-scanning-scan' + pattern_update_scans: + type: array + items: + $ref: '#/components/schemas/secret-scanning-scan' + backfill_scans: + type: array + items: + $ref: '#/components/schemas/secret-scanning-scan' + custom_pattern_backfill_scans: + type: array + items: + description: >- + Information on a single scan performed by secret scanning on the + repository + type: object + properties: + type: + type: string + description: The type of scan + status: + type: string + description: >- + The state of the scan. Either "completed", "running", or + "pending" + completed_at: + type: string + format: date-time + description: >- + The time that the scan was completed. Empty if the scan is + running + nullable: true + started_at: + type: string + format: date-time + description: >- + The time that the scan was started. Empty if the scan is + pending + nullable: true + pattern_name: + type: string + description: Name of the custom pattern for custom pattern scans + pattern_scope: + type: string + description: >- + Level at which the custom pattern is defined, one of + "repository", "organization", or "enterprise" + alert-number: + type: integer + description: The security alert number. + readOnly: true + alert-created-at: + type: string + description: >- + The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable-alert-updated-at: + type: string + description: >- + The time that the alert was last updated in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`. + format: date-time + readOnly: true + nullable: true + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable-secret-scanning-first-detected-location: + description: > + Details on the location where the token was initially detected. This can + be a commit, wiki commit, issue, discussion, pull request. + nullable: true + type: object + properties: + path: + type: string + description: The file path in the repository + example: /example/secrets.txt + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: >- + The column at which the secret starts within the start line when the + file is interpreted as 8BIT ASCII + end_column: + type: number + description: >- + The column at which the secret ends within the end line when the + file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + example: >- + https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: >- + https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: >- + https://github.com/community/community/discussions/39082#discussion-4566270 + discussion_comment_url: + type: string + format: uri + description: >- + The API URL to get the discussion comment where the secret was + detected. + example: >- + https://github.com/community/community/discussions/39082#discussioncomment-4158232 + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_comment_url: + type: string + format: uri + description: >- + The API URL to get the pull request comment where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + pull_request_review_url: + type: string + format: uri + description: >- + The API URL to get the pull request review where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + pull_request_review_comment_url: + type: string + format: uri + description: >- + The API URL to get the pull request review comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - page_url + - issue_title_url + - issue_body_url + - issue_comment_url + - discussion_title_url + - discussion_body_url + - discussion_comment_url + - pull_request_title_url + - pull_request_body_url + - pull_request_comment_url + - pull_request_review_url + - pull_request_review_comment_url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: >- + The percentage of all alerts that this pattern represents, rounded + to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: >- + The percentage of alerts from this pattern that are false positives, + rounded to the nearest integer. + bypass_rate: + type: integer + description: >- + The percentage of blocks for this pattern that were bypassed, + rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: >- + The push protection setting for this pattern set at the enterprise + level. Only present for partner patterns when the organization has a + parent enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: >- + The current push protection setting for this pattern. If this is + `not-set`, then it inherits either the enterprise setting if it + exists or the default setting. + enum: + - not-set + - disabled + - enabled + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + secret-scanning-location-commit: + description: >- + Represents a 'commit' secret scanning location type. This location type + shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: /example/secrets.txt + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: >- + The column at which the secret starts within the start line when the + file is interpreted as 8BIT ASCII + end_column: + type: number + description: >- + The column at which the secret ends within the end line when the + file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + example: >- + https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: >- + Represents a 'wiki_commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: /example/Home.md + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: >- + The column at which the secret starts within the start line when the + file is interpreted as 8-bit ASCII. + end_column: + type: number + description: >- + The column at which the secret ends within the end line when the + file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: >- + https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: >- + https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: >- + Represents an 'issue_title' secret scanning location type. This location + type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + example: https://github.com/octocat/Hello-World/issues/1 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: >- + Represents an 'issue_body' secret scanning location type. This location + type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + example: https://github.com/octocat/Hello-World/issues/1 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: >- + Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where the secret was detected. + example: >- + https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: >- + Represents a 'discussion_title' secret scanning location type. This + location type shows that a secret was detected in the title of a + discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: >- + Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a + discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: >- + https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: >- + Represents a 'discussion_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on a + discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: >- + The API URL to get the discussion comment where the secret was + detected. + example: >- + https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: >- + Represents a 'pull_request_title' secret scanning location type. This + location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: >- + Represents a 'pull_request_body' secret scanning location type. This + location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: >- + Represents a 'pull_request_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: >- + The API URL to get the pull request comment where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: >- + The GitHub URL for the pull request comment where the secret was + detected. + example: >- + https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: >- + Represents a 'pull_request_review' secret scanning location type. This + location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: >- + The API URL to get the pull request review where the secret was + detected. + example: >- + https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: >- + The GitHub URL for the pull request review where the secret was + detected. + example: >- + https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: >- + Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review + comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: >- + The API URL to get the pull request review comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: >- + The GitHub URL for the pull request review comment where the secret + was detected. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 + required: + - pull_request_review_comment_url + secret-scanning-scan: + description: >- + Information on a single scan performed by secret scanning on the + repository + type: object + properties: + type: + type: string + description: The type of scan + status: + type: string + description: The state of the scan. Either "completed", "running", or "pending" + completed_at: + type: string + format: date-time + description: The time that the scan was completed. Empty if the scan is running + nullable: true + started_at: + type: string + format: date-time + description: The time that the scan was started. Empty if the scan is pending + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_modified: + description: Not modified + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + secret-scanning-alert-state: + name: state + in: query + description: >- + Set to `open` or `resolved` to only list secret scanning alerts in a + specific state. + required: false + schema: + type: string + enum: + - open + - resolved + secret-scanning-alert-secret-type: + name: secret_type + in: query + description: >- + A comma-separated list of secret types to return. All default secret + patterns are returned. To return generic patterns, pass the token + name(s) in the parameter. See "[Supported secret scanning + patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-exclude-secret-types: + name: exclude_secret_types + in: query + description: >- + A comma-separated list of secret types to exclude from the results. All + default secret patterns are returned except those matching the specified + types. Cannot be combined with the `secret_type` parameter. See + "[Supported secret scanning + patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-exclude-providers: + name: exclude_providers + in: query + description: >- + A comma-separated list of provider slugs to exclude from the results. + + Provider slugs use lowercase with underscores (e.g., + `github_secret_scanning`, `clojars`). + + You can find the provider slug in the `provider_slug` field of each + alert. + + Cannot be combined with the `providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-providers: + name: providers + in: query + description: >- + A comma-separated list of provider slugs to filter by. + + Provider slugs use lowercase with underscores (e.g., + `github_secret_scanning`, `clojars`). + + You can find the provider slug in the `provider_slug` field of each + alert. + + Cannot be combined with the `exclude_providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-resolution: + name: resolution + in: query + description: >- + A comma-separated list of resolutions. Only secret scanning alerts with + one of these resolutions are listed. Valid resolutions are + `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, + `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: >- + Filters alerts by assignee. Use `*` to get all assigned alerts, `none` + to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: '*' + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + secret-scanning-alert-sort: + name: sort + description: >- + The property to sort the results by. `created` means when the alert was + created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + secret-scanning-pagination-before-org-repo: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events before this cursor. To + receive an initial cursor on your first request, include an empty + "before" query string. + in: query + required: false + schema: + type: string + secret-scanning-pagination-after-org-repo: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events after this cursor. To + receive an initial cursor on your first request, include an empty + "after" query string. + in: query + required: false + schema: + type: string + secret-scanning-alert-validity: + name: validity + in: query + description: >- + A comma-separated list of validities that, when present, will return + alerts that match the validities in this list. Valid options are + `active`, `inactive`, and `unknown`. + required: false + schema: + type: string + secret-scanning-alert-publicly-leaked: + name: is_publicly_leaked + in: query + description: >- + A boolean value representing whether or not to filter alerts by the + publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-multi-repo: + name: is_multi_repo + in: query + description: >- + A boolean value representing whether or not to filter alerts by the + multi-repo tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-hide-secret: + name: hide_secret + in: query + description: >- + A boolean value representing whether or not to hide literal secrets in + the results. + required: false + schema: + type: boolean + default: false + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + alert-number: + name: alert_number + in: path + description: >- + The number that identifies an alert. You can find this at the end of the + URL for a code scanning alert within GitHub, and in the `number` field + in the response from the `GET + /repos/{owner}/{repo}/code-scanning/alerts` operation. + required: true + schema: + $ref: '#/components/schemas/alert-number' + examples: + organization-secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: /example/secrets.txt + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: >- + https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: >- + https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled + secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: inactive + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: /example/secrets.txt + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: >- + https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: >- + https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + secret-scanning-alert-open: + value: + number: 42 + created_at: '2020-11-06T18:18:30Z' + url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 + html_url: https://github.com/owner/private-repo/security/secret-scanning/42 + locations_url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations + state: open + resolution: null + resolved_at: null + resolved_by: null + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed_by: null + push_protection_bypassed: false + push_protection_bypassed_at: null + push_protection_bypass_request_reviewer: null + push_protection_bypass_request_reviewer_comment: null + push_protection_bypass_request_comment: null + push_protection_bypass_request_html_url: null + resolution_comment: null + validity: unknown + publicly_leaked: false + multi_repo: false + secret-scanning-alert-resolved: + value: + number: 42 + created_at: '2020-11-06T18:18:30Z' + url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 + html_url: https://github.com/owner/private-repo/security/secret-scanning/42 + locations_url: >- + https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations + state: resolved + resolution: used_in_tests + resolved_at: '2020-11-16T22:42:07Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed: false + push_protection_bypassed_by: null + push_protection_bypassed_at: null + push_protection_bypass_request_reviewer: null + push_protection_bypass_request_reviewer_comment: null + push_protection_bypass_request_comment: null + push_protection_bypass_request_html_url: null + resolution_comment: Example comment + validity: unknown + publicly_leaked: false + multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + secret-scanning-location-list: + value: + - type: commit + details: + path: /example/secrets.txt + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: >- + https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: >- + https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + - type: wiki_commit + details: + path: /example/Home.md + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: >- + https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: >- + https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + - type: issue_title + details: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + - type: issue_body + details: + issue_body_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + - type: issue_comment + details: + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + - type: discussion_title + details: + discussion_title_url: https://github.com/community/community/discussions/39082 + - type: discussion_body + details: + discussion_body_url: >- + https://github.com/community/community/discussions/39082#discussion-4566270 + - type: discussion_comment + details: + discussion_comment_url: >- + https://github.com/community/community/discussions/39082#discussioncomment-4158232 + - type: pull_request_title + details: + pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + - type: pull_request_body + details: + pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + - type: pull_request_comment + details: + pull_request_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898 + - type: pull_request_review + details: + pull_request_review_url: >- + https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + - type: pull_request_review_comment + details: + pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + secret-scanning-push-protection-bypass: + value: + reason: will_fix_later + expire_at: '2020-11-06T18:18:30Z' + token_type: mailchimp_api_key + secret-scanning-scan-history: + value: + incremental_scans: + - type: git + status: completed + completed_at: '2024-10-07T02:47:00Z' + backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:50:00Z' + - type: issue + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:49:00Z' + - type: discussion + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:48:00Z' + pattern_update_scans: + - type: discussion + status: in_progress + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:51:00Z' + custom_pattern_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: enterprise + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: organization + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + alerts: + id: github.secret_scanning.alerts + name: alerts + title: Alerts + methods: + list_alerts_for_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1secret-scanning~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_alerts_for_repo: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1secret-scanning~1alerts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_alert: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1secret-scanning~1alerts~1{alert_number}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_alert: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1secret-scanning~1alerts~1{alert_number}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/alerts/methods/get_alert' + - $ref: >- + #/components/x-stackQL-resources/alerts/methods/list_alerts_for_repo + - $ref: >- + #/components/x-stackQL-resources/alerts/methods/list_alerts_for_org + insert: [] + update: + - $ref: '#/components/x-stackQL-resources/alerts/methods/update_alert' + delete: [] + replace: [] + org_secret_scanning_pattern_configurations: + id: github.secret_scanning.org_secret_scanning_pattern_configurations + name: org_secret_scanning_pattern_configurations + title: Org Secret Scanning Pattern Configurations + methods: + list_org_pattern_configs: + operation: + $ref: '#/paths/~1orgs~1{org}~1secret-scanning~1pattern-configurations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_org_pattern_configs: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1secret-scanning~1pattern-configurations/patch + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/org_secret_scanning_pattern_configurations/methods/list_org_pattern_configs + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/org_secret_scanning_pattern_configurations/methods/update_org_pattern_configs + delete: [] + replace: [] + locations: + id: github.secret_scanning.locations + name: locations + title: Locations + methods: + list_locations_for_alert: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1secret-scanning~1alerts~1{alert_number}~1locations/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/locations/methods/list_locations_for_alert + insert: [] + update: [] + delete: [] + replace: [] + repo_push_protection_bypasses: + id: github.secret_scanning.repo_push_protection_bypasses + name: repo_push_protection_bypasses + title: Repo Push Protection Bypasses + methods: + create_push_protection_bypass: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1secret-scanning~1push-protection-bypasses/post + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/repo_push_protection_bypasses/methods/create_push_protection_bypass + update: [] + delete: [] + replace: [] + repo_secret_scan_history: + id: github.secret_scanning.repo_secret_scan_history + name: repo_secret_scan_history + title: Repo Secret Scan History + methods: + get_scan_history: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1secret-scanning~1scan-history/get + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repo_secret_scan_history/methods/get_scan_history + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/security_advisories.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/security_advisories.yaml new file mode 100644 index 0000000..ba1c060 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/security_advisories.yaml @@ -0,0 +1,6688 @@ +openapi: 3.0.3 +info: + title: security_advisories API + description: github API + version: 1.1.4 +paths: + /advisories: + get: + summary: List global security advisories + description: >- + Lists all global security advisories that match the specified + parameters. If no other parameters are defined, the request will return + only GitHub-reviewed advisories that are not malware. + + + By default, all responses will exclude advisories for malware, because + malware are not standard vulnerabilities. To list advisories for + malware, you must include the `type` parameter in your request, with the + value `malware`. For more information about the different types of + security advisories, see "[About the GitHub Advisory + database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + tags: + - security-advisories + operationId: security-advisories/list-global-advisories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories + parameters: + - name: ghsa_id + in: query + description: >- + If specified, only advisories with this GHSA (GitHub Security + Advisory) identifier will be returned. + schema: + type: string + - name: type + in: query + description: >- + If specified, only advisories of this type will be returned. By + default, a request with no other parameters defined will only return + reviewed advisories that are not malware. + schema: + type: string + enum: + - reviewed + - malware + - unreviewed + default: reviewed + - name: cve_id + description: >- + If specified, only advisories with this CVE (Common Vulnerabilities + and Exposures) identifier will be returned. + in: query + schema: + type: string + - name: ecosystem + in: query + description: If specified, only advisories for these ecosystems will be returned. + schema: + $ref: '#/components/schemas/security-advisory-ecosystems' + - name: severity + in: query + description: >- + If specified, only advisories with these severities will be + returned. + schema: + type: string + enum: + - unknown + - low + - medium + - high + - critical + - name: cwes + in: query + description: >- + If specified, only advisories with these Common Weakness + Enumerations (CWEs) will be returned. + + + Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + schema: + oneOf: + - type: string + - type: array + items: + type: string + - name: is_withdrawn + in: query + description: Whether to only return advisories that have been withdrawn. + schema: + type: boolean + - name: affects + in: query + description: >- + If specified, only return advisories that affect any of `package` or + `package@version`. A maximum of 1000 packages can be specified. + + If the query parameter causes the URL to exceed the maximum URL + length supported by your client, you must specify fewer packages. + + + Example: `affects=package1,package2@1.0.0,package3@2.0.0` or + `affects[]=package1&affects[]=package2@1.0.0` + schema: + oneOf: + - type: string + - type: array + maxItems: 1000 + items: + type: string + - name: published + in: query + description: >- + If specified, only return advisories that were published on a date + or date range. + + + For more information on the syntax of the date range, see + "[Understanding the search + syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + schema: + type: string + - name: updated + in: query + description: >- + If specified, only return advisories that were updated on a date or + date range. + + + For more information on the syntax of the date range, see + "[Understanding the search + syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + schema: + type: string + - name: modified + description: >- + If specified, only show advisories that were updated or published on + a date or date range. + + + For more information on the syntax of the date range, see + "[Understanding the search + syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + in: query + schema: + type: string + - name: epss_percentage + in: query + description: >- + If specified, only return advisories that have an EPSS percentage + score that matches the provided value. + + The EPSS percentage represents the likelihood of a CVE being + exploited. + schema: + type: string + - name: epss_percentile + in: query + description: >- + If specified, only return advisories that have an EPSS percentile + score that matches the provided value. + + The EPSS percentile represents the relative rank of the CVE's + likelihood of being exploited compared to other CVEs. + schema: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/direction' + - name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - updated + - published + - epss_percentage + - epss_percentile + default: published + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/global-advisory' + examples: + default: + $ref: '#/components/examples/global-advisory-items' + '422': + $ref: '#/components/responses/validation_failed_simple' + '429': + description: Too many requests + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: global-advisories + x-stackQL-resource: global_advisories + /advisories/{ghsa_id}: + get: + summary: Get a global security advisory + description: >- + Gets a global security advisory using its GitHub Security Advisory + (GHSA) identifier. + tags: + - security-advisories + operationId: security-advisories/get-global-advisory + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory + parameters: + - $ref: '#/components/parameters/ghsa_id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/global-advisory' + examples: + default: + $ref: '#/components/examples/global-advisory' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: global-advisories + x-stackQL-resource: global_advisories + /orgs/{org}/security-advisories: + get: + summary: List repository security advisories for an organization + description: >- + Lists repository security advisories for an organization. + + + The authenticated user must be an owner or security manager for the + organization to use this endpoint. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/list-org-repository-advisories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/direction' + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - published + default: created + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: per_page + description: >- + The number of advisories to return per page. For more information, + see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: state + description: >- + Filter by the state of the repository advisories. Only advisories of + this state will be returned. + in: query + required: false + schema: + type: string + enum: + - triage + - draft + - published + - closed + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/list-repository-advisories' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories: + get: + summary: List repository security advisories + description: >- + Lists security advisories in a repository. + + + The authenticated user can access unpublished security advisories from a + repository if they are a security manager or administrator of that + repository, or if they are a collaborator on any security advisory. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repository_advisories:read` scope to to get a published security + advisory in a private repository, or any unpublished security advisory + that the authenticated user has access to. + tags: + - security-advisories + operationId: security-advisories/list-repository-advisories + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/direction' + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - published + default: created + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: per_page + description: >- + The number of advisories to return per page. For more information, + see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: state + description: >- + Filter by state of the repository advisories. Only advisories of + this state will be returned. + in: query + required: false + schema: + type: string + enum: + - triage + - draft + - published + - closed + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/list-repository-advisories' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + post: + summary: Create a repository security advisory + description: >- + Creates a new repository security advisory. + + + In order to create a draft repository security advisory, the + authenticated user must be a security manager or administrator of that + repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/create-repository-advisory + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory-create' + examples: + default: + value: + summary: A new important advisory + description: A more in-depth description of what the problem is. + severity: high + cve_id: null + vulnerabilities: + - package: + name: a-package + ecosystem: npm + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cwe_ids: + - CWE-1101 + - CWE-20 + credits: + - login: monalisa + type: reporter + - login: octocat + type: analyst + withVectorString: + value: + summary: A new important advisory + description: A more in-depth description of what the problem is. + cvss_vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L + cve_id: null + vulnerabilities: + - package: + name: a-package + ecosystem: npm + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cwe_ids: + - CWE-1101 + - CWE-20 + credits: + - login: monalisa + type: reporter + - login: octocat + type: analyst + minimal: + value: + summary: A new important advisory + description: A more in-depth description of what the problem is. + vulnerabilities: + - package: + ecosystem: npm + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/reports: + post: + summary: Privately report a security vulnerability + description: >- + Report a security vulnerability to the maintainers of the repository. + + See "[Privately reporting a security + vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" + for more information about private vulnerability reporting. + tags: + - security-advisories + operationId: security-advisories/create-private-vulnerability-report + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/private-vulnerability-report-create' + examples: + default: + value: + summary: A newly discovered vulnerability + description: A more in-depth description of what the problem is. + severity: high + vulnerabilities: + - package: + name: a-package + ecosystem: npm + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cwe_ids: + - CWE-123 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory-pvr' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/{ghsa_id}: + get: + summary: Get a repository security advisory + description: >- + Get a repository security advisory using its GitHub Security Advisory + (GHSA) identifier. + + + Anyone can access any published security advisory on a public + repository. + + + The authenticated user can access an unpublished security advisory from + a repository if they are a security manager or administrator of that + repository, or if they are a + + collaborator on the security advisory. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repository_advisories:read` scope to to get a published security + advisory in a private repository, or any unpublished security advisory + that the authenticated user has access to. + tags: + - security-advisories + operationId: security-advisories/get-repository-advisory + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + patch: + summary: Update a repository security advisory + description: >- + Update a repository security advisory using its GitHub Security Advisory + (GHSA) identifier. + + + In order to update any security advisory, the authenticated user must be + a security manager or administrator of that repository, + + or a collaborator on the repository security advisory. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/update-repository-advisory + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory-update' + examples: + default: + summary: Updating the severity and state. + value: + severity: critical + state: published + add_credit: + summary: >- + To add a credit to an advisory, send the whole array of + values. + value: + credits: + - login: monauser + type: remediation_developer + update_vvrs: + summary: >- + To add vulnerable versions, include existing versions in the + array. + value: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + invalid_state_transition: + summary: >- + Example of an invalid state transition, from `published` to + `draft`. + value: + state: draft + update_severity_with_cvss_set: + summary: Severity cannot be updated when the CVSS is already set. + value: + severity: low + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory' + add_credit: + $ref: '#/components/examples/repository-advisory' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + examples: + invalid_state_transition: + value: + message: Invalid state transition from `published` to `draft`. + update_severity_with_cvss_set: + value: + message: Cannot update severity value when CVSS is set. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve: + post: + summary: Request a CVE for a repository security advisory + description: >- + If you want a CVE identification number for the security vulnerability + in your project, and don't already have one, you can request a CVE + identification number from GitHub. For more information see "[Requesting + a CVE identification + number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + + + You may request a CVE for public repositories, but cannot do so for + private repositories. + + + In order to request a CVE for a repository security advisory, the + authenticated user must be a security manager or administrator of that + repository. + + + OAuth app tokens and personal access tokens (classic) need the `repo` or + `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/create-repository-advisory-cve-request + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks: + post: + summary: Create a temporary private fork + description: >- + Create a temporary private fork to collaborate on fixing a security + vulnerability in your repository. + + + > [!NOTE] + + > Forking a repository happens asynchronously. You may have to wait up + to 5 minutes before you can access the fork. + tags: + - security-advisories + operationId: security-advisories/create-fork + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories +components: + schemas: + security-advisory-ecosystems: + type: string + description: The package's language or package management ecosystem. + enum: + - rubygems + - npm + - pip + - maven + - nuget + - composer + - go + - rust + - erlang + - actions + - pub + - other + - swift + global-advisory: + description: A GitHub Security Advisory. + type: object + properties: + ghsa_id: + type: string + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + readOnly: true + url: + type: string + description: The API URL for the advisory. + readOnly: true + html_url: + type: string + format: uri + description: The URL for the advisory. + readOnly: true + repository_advisory_url: + type: string + format: uri + description: The API URL for the repository advisory. + readOnly: true + nullable: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory entails. + maxLength: 65535 + nullable: true + type: + type: string + description: The type of advisory. + readOnly: true + enum: + - reviewed + - unreviewed + - malware + severity: + type: string + description: The severity of the advisory. + enum: + - critical + - high + - medium + - low + - unknown + source_code_location: + type: string + format: uri + description: The URL of the advisory's source code. + nullable: true + identifiers: + type: array + nullable: true + readOnly: true + items: + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + references: + type: array + nullable: true + items: + type: string + description: URLs with more information regarding the advisory. + published_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was published, in ISO 8601 + format. + readOnly: true + updated_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was last updated, in ISO 8601 + format. + readOnly: true + github_reviewed_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was reviewed by GitHub, in + ISO 8601 format. + readOnly: true + nullable: true + nvd_published_at: + type: string + format: date-time + description: >- + The date and time when the advisory was published in the National + Vulnerability Database, in ISO 8601 format. + + This field is only populated when the advisory is imported from the + National Vulnerability Database. + readOnly: true + nullable: true + withdrawn_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was withdrawn, in ISO 8601 + format. + readOnly: true + nullable: true + vulnerabilities: + type: array + description: The products and respective version ranges affected by the advisory. + nullable: true + items: + $ref: '#/components/schemas/vulnerability' + cvss: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS vector. + nullable: true + score: + type: number + description: The CVSS score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_severities: + $ref: '#/components/schemas/cvss-severities' + epss: + $ref: '#/components/schemas/security-advisory-epss' + cwes: + type: array + nullable: true + items: + type: object + properties: + cwe_id: + type: string + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + credits: + type: array + description: The users who contributed to the advisory. + nullable: true + readOnly: true + items: + type: object + properties: + user: + $ref: '#/components/schemas/simple-user' + type: + $ref: '#/components/schemas/security-advisory-credit-types' + required: + - user + - type + required: + - ghsa_id + - cve_id + - url + - html_url + - repository_advisory_url + - summary + - description + - type + - severity + - source_code_location + - identifiers + - references + - published_at + - updated_at + - github_reviewed_at + - nvd_published_at + - withdrawn_at + - vulnerabilities + - cvss + - cwes + - credits + additionalProperties: false + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + properties: + cvss: null + required: + - ghsa_id + - cve_id + - url + - html_url + - repository_advisory_url + - summary + - description + - type + - severity + - source_code_location + - identifiers + - references + - published_at + - updated_at + - github_reviewed_at + - nvd_published_at + - withdrawn_at + - vulnerabilities + - cwes + - credits + type: object + version: '2026-03-10' + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + repository-advisory: + description: A repository security advisory. + type: object + properties: + ghsa_id: + type: string + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + url: + type: string + format: uri + description: The API URL for the advisory. + readOnly: true + html_url: + type: string + format: uri + description: The URL for the advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory entails. + maxLength: 65535 + nullable: true + severity: + type: string + description: The severity of the advisory. + nullable: true + enum: + - critical + - high + - medium + - low + author: + readOnly: true + nullable: true + description: The author of the advisory. + title: Simple User + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + publisher: + readOnly: true + nullable: true + description: The publisher of the advisory. + title: Simple User + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + identifiers: + type: array + items: + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + readOnly: true + state: + type: string + description: The state of the advisory. + enum: + - published + - closed + - withdrawn + - draft + - triage + created_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was created, in ISO 8601 + format. + readOnly: true + nullable: true + updated_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was last updated, in ISO 8601 + format. + readOnly: true + nullable: true + published_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was published, in ISO 8601 + format. + readOnly: true + nullable: true + closed_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was closed, in ISO 8601 + format. + readOnly: true + nullable: true + withdrawn_at: + type: string + format: date-time + description: >- + The date and time of when the advisory was withdrawn, in ISO 8601 + format. + readOnly: true + nullable: true + submission: + type: object + nullable: true + readOnly: true + properties: + accepted: + type: boolean + description: >- + Whether a private vulnerability report was accepted by the + repository's administrators. + readOnly: true + required: + - accepted + vulnerabilities: + type: array + nullable: true + items: + $ref: '#/components/schemas/repository-advisory-vulnerability' + cvss: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS vector. + nullable: true + score: + type: number + description: The CVSS score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_severities: + $ref: '#/components/schemas/cvss-severities' + cwes: + type: array + nullable: true + items: + type: object + properties: + cwe_id: + type: string + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + readOnly: true + cwe_ids: + type: array + description: A list of only the CWE IDs. + nullable: true + items: + type: string + credits: + type: array + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + $ref: '#/components/schemas/security-advisory-credit-types' + credits_detailed: + type: array + nullable: true + items: + $ref: '#/components/schemas/repository-advisory-credit' + readOnly: true + collaborating_users: + type: array + description: A list of users that collaborate on the advisory. + nullable: true + items: + $ref: '#/components/schemas/simple-user' + collaborating_teams: + type: array + description: A list of teams that collaborate on the advisory. + nullable: true + items: + $ref: '#/components/schemas/team' + private_fork: + readOnly: true + nullable: true + description: >- + A temporary private fork of the advisory's repository for + collaborating on a fix. + title: Simple Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the + GitHub API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: >- + A template for the API URL to download the repository as an + archive. + assignees_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob + in the repository. + branches_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in + the repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about + collaborators of the repository. + comments_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on + the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on + the repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: >- + A template for the API URL to get the contents of the + repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits + of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of + the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of + the repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue + comments on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events + on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on + the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys + on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of + the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones + of the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about + notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull + requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on + the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of + a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree + of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + required: + - ghsa_id + - cve_id + - url + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state + - created_at + - updated_at + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cvss + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + additionalProperties: false + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + properties: + cvss: null + required: + - ghsa_id + - cve_id + - url + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state + - created_at + - updated_at + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + type: object + version: '2026-03-10' + repository-advisory-create: + type: object + properties: + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory impacts. + maxLength: 65535 + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + vulnerabilities: + type: array + description: >- + A product affected by the vulnerability detailed in a repository + security advisory. + items: + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + vulnerable_version_range: + type: string + description: >- + The range of the package versions affected by the + vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + additionalProperties: false + cwe_ids: + type: array + description: A list of Common Weakness Enumeration (CWE) IDs. + nullable: true + items: + type: string + credits: + type: array + description: >- + A list of users receiving credit for their participation in the + security advisory. + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + $ref: '#/components/schemas/security-advisory-credit-types' + required: + - login + - type + additionalProperties: false + severity: + type: string + description: >- + The severity of the advisory. You must choose between setting this + field or `cvss_vector_string`. + nullable: true + enum: + - critical + - high + - medium + - low + cvss_vector_string: + type: string + description: >- + The CVSS vector that calculates the severity of the advisory. You + must choose between setting this field or `severity`. + nullable: true + start_private_fork: + type: boolean + description: >- + Whether to create a temporary private fork of the repository to + collaborate on a fix. + default: false + required: + - summary + - description + - vulnerabilities + additionalProperties: false + private-vulnerability-report-create: + type: object + properties: + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory impacts. + maxLength: 65535 + vulnerabilities: + type: array + description: >- + An array of products affected by the vulnerability detailed in a + repository security advisory. + nullable: true + items: + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + vulnerable_version_range: + type: string + description: >- + The range of the package versions affected by the + vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + additionalProperties: false + cwe_ids: + type: array + description: A list of Common Weakness Enumeration (CWE) IDs. + nullable: true + items: + type: string + severity: + type: string + description: >- + The severity of the advisory. You must choose between setting this + field or `cvss_vector_string`. + nullable: true + enum: + - critical + - high + - medium + - low + cvss_vector_string: + type: string + description: >- + The CVSS vector that calculates the severity of the advisory. You + must choose between setting this field or `severity`. + nullable: true + start_private_fork: + type: boolean + description: >- + Whether to create a temporary private fork of the repository to + collaborate on a fix. + default: false + required: + - summary + - description + additionalProperties: false + repository-advisory-update: + type: object + properties: + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory impacts. + maxLength: 65535 + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + vulnerabilities: + type: array + description: >- + A product affected by the vulnerability detailed in a repository + security advisory. + items: + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + vulnerable_version_range: + type: string + description: >- + The range of the package versions affected by the + vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + additionalProperties: false + cwe_ids: + type: array + description: A list of Common Weakness Enumeration (CWE) IDs. + nullable: true + items: + type: string + credits: + type: array + description: >- + A list of users receiving credit for their participation in the + security advisory. + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + $ref: '#/components/schemas/security-advisory-credit-types' + required: + - login + - type + additionalProperties: false + severity: + type: string + description: >- + The severity of the advisory. You must choose between setting this + field or `cvss_vector_string`. + nullable: true + enum: + - critical + - high + - medium + - low + cvss_vector_string: + type: string + description: >- + The CVSS vector that calculates the severity of the advisory. You + must choose between setting this field or `severity`. + nullable: true + state: + type: string + description: The state of the advisory. + enum: + - published + - closed + - draft + collaborating_users: + type: array + description: >- + A list of usernames who have been granted write access to the + advisory. + nullable: true + items: + type: string + collaborating_teams: + type: array + description: >- + A list of team slugs which have been granted write access to the + advisory. + nullable: true + items: + type: string + additionalProperties: false + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + $ref: '#/components/schemas/nullable-repository' + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + $ref: '#/components/schemas/nullable-license-simple' + organization: + $ref: '#/components/schemas/nullable-simple-user' + parent: + $ref: '#/components/schemas/repository' + source: + $ref: '#/components/schemas/repository' + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct-simple' + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + vulnerability: + description: >- + A vulnerability describing the product and its affected versions within + a GitHub Security Advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + first_patched_version: + type: string + description: The package version that resolves the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected by the vulnerability. + nullable: true + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions + cvss-severities: + type: object + nullable: true + properties: + cvss_v3: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 3 vector string. + nullable: true + score: + type: number + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 4 vector string. + nullable: true + score: + type: number + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + security-advisory-epss: + type: object + nullable: true + readOnly: true + description: >- + The EPSS scores as calculated by the [Exploit Prediction Scoring + System](https://www.first.org/epss). + properties: + percentage: + type: number + minimum: 0 + maximum: 100 + percentile: + type: number + minimum: 0 + maximum: 100 + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + security-advisory-credit-types: + type: string + description: The type of credit the user is receiving. + enum: + - analyst + - finder + - reporter + - coordinator + - remediation_developer + - remediation_reviewer + - remediation_verifier + - tool + - sponsor + - other + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + repository-advisory-vulnerability: + description: >- + A product affected by the vulnerability detailed in a repository + security advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + - vulnerable_version_range + - patched_versions + - vulnerable_functions + additionalProperties: false + repository-advisory-credit: + description: A credit given to a user for a repository security advisory. + type: object + properties: + user: + $ref: '#/components/schemas/simple-user' + type: + $ref: '#/components/schemas/security-advisory-credit-types' + state: + type: string + description: The state of the user's acceptance of the credit. + enum: + - accepted + - declined + - pending + required: + - user + - type + - state + additionalProperties: false + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: >- + The URL to get more information about the repository from the GitHub + API. + archive_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: >- + A template for the API URL to list the available assignees for + issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git blob in + the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: >- + A template for the API URL to get information about branches in the + repository. + collaborators_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: >- + A template for the API URL to get information about collaborators of + the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: >- + A template for the API URL to get information about comments on the + repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: >- + A template for the API URL to get information about commits on the + repository. + compare_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: >- + A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: >- + A template for the API URL to get information about Git commits of + the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: >- + A template for the API URL to get information about Git refs of the + repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: >- + A template for the API URL to get information about Git tags of the + repository. + issue_comment_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: >- + A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: >- + A template for the API URL to get information about issue events on + the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: >- + A template for the API URL to get information about issues on the + repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: >- + A template for the API URL to get information about deploy keys on + the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: >- + A template for the API URL to get information about labels of the + repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: >- + The API URL to get information about the languages of the + repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: >- + A template for the API URL to get information about milestones of + the repository. + notifications_url: + type: string + example: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: >- + A template for the API URL to get information about notifications on + the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: >- + A template for the API URL to get information about pull requests on + the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: >- + A template for the API URL to get information about releases on the + repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: >- + A template for the API URL to get information about statuses of a + commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: >- + A template for the API URL to create or retrieve a raw Git tree of + the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: >- + Whether or not a pull request head branch that is behind its base + branch can always be updated even if it is not required to be up to + date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: >- + Whether a squash merge commit can use the pull request title as + default. **This property is closing down. Please use + `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: >- + The default value for a squash merge commit title: + + + - `PR_TITLE` - default to the pull request's title. + + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one + commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: >- + The default value for a merge commit title. + + + - `PR_TITLE` - default to the pull request's title. + + - `MERGE_MESSAGE` - default to the classic title for a merge message + (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + parameters: + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + ghsa_id: + name: ghsa_id + description: The GHSA (GitHub Security Advisory) identifier of the advisory. + in: path + required: true + schema: + type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + examples: + global-advisory-items: + value: + - id: 1 + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/advisories/GHSA-abcd-1234-efgh + repository_advisory_url: >- + https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh + summary: Heartbleed security advisory + description: >- + This bug allows an attacker to read portions of the affected + server’s memory, potentially disclosing sensitive information. + type: reviewed + severity: high + source_code_location: https://github.com/project/a-package + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + references: + - https://nvd.nist.gov/vuln/detail/CVE-2050-00000 + published_at: '2023-03-23T02:30:56Z' + updated_at: '2023-03-24T02:30:56Z' + github_reviewed_at: '2023-03-23T02:30:56Z' + nvd_published_at: '2023-03-25T02:30:56Z' + withdrawn_at: null + vulnerabilities: + - package: + ecosystem: npm + name: a-package + first_patched_version: 1.0.3 + vulnerable_version_range: <=1.0.2 + vulnerable_functions: + - a_function + cvss: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-400 + name: Uncontrolled Resource Consumption + epss: + percentage: 0.00045 + percentile: '0.16001e0' + credits: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + global-advisory: + value: + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/advisories/GHSA-abcd-1234-efgh + repository_advisory_url: >- + https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + type: reviewed + severity: high + source_code_location: https://github.com/project/a-package + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + references: + - https://nvd.nist.gov/vuln/detail/CVE-2050-00000 + published_at: '2023-03-23T02:30:56Z' + updated_at: '2023-03-24T02:30:56Z' + github_reviewed_at: '2023-03-23T02:30:56Z' + nvd_published_at: '2023-03-25T02:30:56Z' + withdrawn_at: null + vulnerabilities: + - package: + ecosystem: npm + name: a-package + first_patched_version: 1.0.3 + vulnerable_version_range: <=1.0.2 + vulnerable_functions: + - a_function + cvss: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-400 + name: Uncontrolled Resource Consumption + credits: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + list-repository-advisories: + value: + - ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: >- + https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: >- + https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: critical + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + state: published + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: '2020-01-03T00:00:00Z' + closed_at: null + withdrawn_at: null + submission: null + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: analyst + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: null + - ghsa_id: GHSA-1234-5678-9012 + cve_id: CVE-2051-0000 + url: >- + https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 + html_url: >- + https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: low + author: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + publisher: + login: monalisa + id: 3 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-1234-5678-9012 + - type: CVE + value: CVE-2051-00000 + state: published + created_at: '2020-01-03T00:00:00Z' + updated_at: '2020-01-04T00:00:00Z' + published_at: '2020-01-04T00:00:00Z' + closed_at: null + withdrawn_at: null + submission: + accepted: true + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + cvss_v4: + vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 7.1 + cwes: + - cwe_id: CWE-456 + name: A CWE 2.0 + cwe_ids: + - CWE-456 + credits: + - login: monauser + type: reporter + credits_detailed: + - user: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + type: reporter + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-1234-5678-9012 + full_name: octo-org/octo-repo-ghsa-1234-5678-9012 + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012 + description: null + fork: false + url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012 + archive_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number} + commits_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha} + compare_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors + deployments_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments + downloads_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads + events_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events + forks_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks + git_commits_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha} + hooks_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks + issue_comment_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number} + keys_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name} + languages_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages + merges_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges + milestones_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number} + releases_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id} + stargazers_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers + statuses_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers + subscription_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription + tags_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags + teams_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams + trees_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha} + repository-advisory: + value: + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: >- + https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: >- + https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: critical + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + state: published + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: '2020-01-03T00:00:00Z' + closed_at: null + withdrawn_at: null + submission: null + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: analyst + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-abcd-1234-efgh + full_name: octo-org/octo-repo-ghsa-abcd-1234-efgh + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh + archive_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number} + commits_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha} + compare_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors + deployments_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments + downloads_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads + events_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events + forks_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks + git_commits_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha} + hooks_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks + issue_comment_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number} + keys_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name} + languages_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages + merges_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges + milestones_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number} + releases_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id} + stargazers_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers + statuses_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers + subscription_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription + tags_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags + teams_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams + trees_url: >- + https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} + repository-advisory-pvr: + value: + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: >- + https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: >- + https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A newly discovered vulnerability + description: A more in-depth description of what the problem is. + severity: high + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: null + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: null + state: triage + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: null + closed_at: null + withdrawn_at: null + submission: + accepted: false + vulnerabilities: + - package: + ecosystem: npm + name: a-package + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cvss: null + cvss_severities: + cvss_v3: null + cvss_v4: null + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: finder + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: finder + state: accepted + collaborating_users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: null + full-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: null + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: >- + https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + x-stackQL-resources: + global_advisories: + id: github.security_advisories.global_advisories + name: global_advisories + title: Global Advisories + methods: + list_global_advisories: + operation: + $ref: '#/paths/~1advisories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_global_advisory: + operation: + $ref: '#/paths/~1advisories~1{ghsa_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/global_advisories/methods/get_global_advisory + - $ref: >- + #/components/x-stackQL-resources/global_advisories/methods/list_global_advisories + insert: [] + update: [] + delete: [] + replace: [] + repository_advisories: + id: github.security_advisories.repository_advisories + name: repository_advisories + title: Repository Advisories + methods: + list_org_repository_advisories: + operation: + $ref: '#/paths/~1orgs~1{org}~1security-advisories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_repository_advisories: + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1security-advisories/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_repository_advisory: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1repos~1{owner}~1{repo}~1security-advisories/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_repository_advisory: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1security-advisories~1{ghsa_id}/get + response: + mediaType: application/json + openAPIDocKey: '200' + update_repository_advisory: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1security-advisories~1{ghsa_id}/patch + response: + mediaType: application/json + openAPIDocKey: '200' + create_repository_advisory_cve_request: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1security-advisories~1{ghsa_id}~1cve/post + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/repository_advisories/methods/get_repository_advisory + - $ref: >- + #/components/x-stackQL-resources/repository_advisories/methods/list_repository_advisories + - $ref: >- + #/components/x-stackQL-resources/repository_advisories/methods/list_org_repository_advisories + insert: + - $ref: >- + #/components/x-stackQL-resources/repository_advisories/methods/create_repository_advisory_cve_request + - $ref: >- + #/components/x-stackQL-resources/repository_advisories/methods/create_repository_advisory + update: + - $ref: >- + #/components/x-stackQL-resources/repository_advisories/methods/update_repository_advisory + delete: [] + replace: [] + private_vulnerability_reports: + id: github.security_advisories.private_vulnerability_reports + name: private_vulnerability_reports + title: Private Vulnerability Reports + methods: + create_private_vulnerability_report: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1security-advisories~1reports/post + response: + mediaType: application/json + openAPIDocKey: '201' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/private_vulnerability_reports/methods/create_private_vulnerability_report + update: [] + delete: [] + replace: [] + security_advisory_forks: + id: github.security_advisories.security_advisory_forks + name: security_advisory_forks + title: Security Advisory Forks + methods: + create_fork: + operation: + $ref: >- + #/paths/~1repos~1{owner}~1{repo}~1security-advisories~1{ghsa_id}~1forks/post + response: + mediaType: application/json + openAPIDocKey: '202' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/security_advisory_forks/methods/create_fork + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/teams.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/teams.yaml new file mode 100644 index 0000000..d7c9102 --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/teams.yaml @@ -0,0 +1,4975 @@ +openapi: 3.0.3 +info: + title: teams API + description: Interact with GitHub Teams. + version: 1.1.4 +paths: + /orgs/{org}/teams: + get: + summary: List teams + description: >- + Lists all teams in an organization that are visible to the authenticated + user. + tags: + - teams + operationId: teams/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-teams + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/team-type' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + post: + summary: Create a team + description: >- + To create a team, the authenticated user must be a member or owner of + `{org}`. By default, organization members can create teams. Organization + owners can limit team creation to organization owners. For more + information, see "[Setting team creation + permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)." + + + When you create a new team, you automatically become a team maintainer + without explicitly adding yourself to the optional array of + `maintainers`. For more information, see "[About + teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". + tags: + - teams + operationId: teams/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#create-a-team + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: string + description: The description of the team. + maintainers: + type: array + description: >- + List GitHub usernames for organization members who will + become team maintainers. + items: + type: string + repo_names: + type: array + description: >- + The full name (e.g., "organization-name/repository-name") of + repositories to add the team to. + items: + type: string + privacy: + type: string + description: >- + The level of privacy this team should have. The options + are: + + **For a non-nested team:** + * `secret` - only visible to organization owners and members of this team. + * `closed` - visible to all members of this organization. + Default: `secret` + + **For a parent or child team:** + * `closed` - visible to all members of this organization. + Default for child team: `closed` + enum: + - secret + - closed + notification_setting: + type: string + description: >- + The notification setting the team has chosen. The options + are: + * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * `notifications_disabled` - no one receives notifications. + Default: `notifications_enabled` + enum: + - notifications_enabled + - notifications_disabled + permission: + type: string + description: >- + **Closing down notice**. The permission that new + repositories will be added to the team with when none is + specified. + enum: + - pull + - push + default: pull + parent_team_id: + type: integer + description: The ID of a team to set as the parent team. + required: + - name + examples: + default: + value: + name: Justice League + description: A great team + permission: push + notification_setting: notifications_enabled + privacy: closed + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-github-breaking-changes: + - changeset: remove_team_permission + patch: + requestBody: + required: true + content: + application/json: + schema: + properties: + permission: null + type: object + version: '2026-03-10' + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}: + get: + summary: Get a team by name + description: >- + Gets a team using the team's `slug`. To create the `slug`, GitHub + replaces special characters in the `name` string, changes all words to + lowercase, and replaces spaces with a `-` separator. For example, `"My + TEam NΓ€me"` would become `my-team-name`. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `GET /organizations/{org_id}/team/{team_id}`. + tags: + - teams + operationId: teams/get-by-name + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#get-a-team-by-name + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + patch: + summary: Update a team + description: >- + To edit a team, the authenticated user must either be an organization + owner or a team maintainer. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `PATCH /organizations/{org_id}/team/{team_id}`. + tags: + - teams + operationId: teams/update-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#update-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: string + description: The description of the team. + privacy: + type: string + description: >- + The level of privacy this team should have. Editing teams + without specifying this parameter leaves `privacy` intact. + When a team is nested, the `privacy` for parent teams cannot + be `secret`. The options are: + + **For a non-nested team:** + * `secret` - only visible to organization owners and members of this team. + * `closed` - visible to all members of this organization. + **For a parent or child team:** + * `closed` - visible to all members of this organization. + enum: + - secret + - closed + notification_setting: + type: string + description: >- + The notification setting the team has chosen. Editing teams + without specifying this parameter leaves + `notification_setting` intact. The options are: + * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * `notifications_disabled` - no one receives notifications. + enum: + - notifications_enabled + - notifications_disabled + permission: + type: string + description: >- + **Closing down notice**. The permission that new + repositories will be added to the team with when none is + specified. + enum: + - pull + - push + - admin + default: pull + parent_team_id: + type: integer + description: The ID of a team to set as the parent team. + nullable: true + examples: + default: + value: + name: new team name + description: new team description + privacy: closed + notification_setting: notifications_enabled + responses: + '200': + description: Response when the updated information already exists + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + delete: + summary: Delete a team + description: >- + To delete a team, the authenticated user must be an organization owner + or team maintainer. + + + If you are an organization owner, deleting a parent team will delete all + of its child teams as well. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `DELETE /organizations/{org_id}/team/{team_id}`. + tags: + - teams + operationId: teams/delete-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#delete-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/enterprise_team_unsupported' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}/invitations: + get: + summary: List pending team invitations + description: >- + The return hash contains a `role` field which refers to the Organization + Invitation role and will be one of the following values: + `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or + `reinstate`. If the invitee is not a GitHub member, the `login` field in + the return hash will be `null`. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `GET /organizations/{org_id}/team/{team_id}/invitations`. + tags: + - teams + operationId: teams/list-pending-invitations-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#list-pending-team-invitations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/enterprise_team_unsupported' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + /orgs/{org}/teams/{team_slug}/members: + get: + summary: List team members + description: >- + Team members will include the members of child teams. + + + To list members in a team, the team must be visible to the authenticated + user. + tags: + - teams + operationId: teams/list-members-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#list-team-members + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - name: role + description: Filters members returned by their role in the team. + in: query + required: false + schema: + type: string + enum: + - member + - maintainer + - all + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + /orgs/{org}/teams/{team_slug}/memberships/{username}: + get: + summary: Get team membership for a user + description: >- + Team members will include the members of child teams. + + + To get a user's membership with a team, the team must be visible to the + authenticated user. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + + + > [!NOTE] + + > The response contains the `state` of the membership and the member's + `role`. + + + The `role` for organization owners is set to `maintainer`. For more + information about `maintainer` roles, see [Create a + team](https://docs.github.com/rest/teams/teams#create-a-team). + tags: + - teams + operationId: teams/get-membership-for-user-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#get-team-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-user-is-a-team-maintainer: + $ref: >- + #/components/examples/team-membership-response-if-user-is-a-team-maintainer + '404': + description: if user has no team membership + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + put: + summary: Add or update team membership for a user + description: >- + Adds an organization member to a team. An authenticated organization + owner or team maintainer can add organization members to a team. + + + Team synchronization is available for organizations using GitHub + Enterprise Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + > [!NOTE] + + > When you have team synchronization set up for a team with your + organization's identity provider (IdP), you will see an error if you + attempt to use the API for making changes to the team's membership. If + you have access to manage group membership in your IdP, you can manage + GitHub team membership through your identity provider, which + automatically adds and removes team members in an organization. For more + information, see "[Synchronizing teams between your identity provider + and + GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + + An organization owner can add someone who is not part of the team's + organization to a team. When an organization owner adds someone to a + team who is not an organization member, this endpoint will send an + invitation to the person via email. This newly-created membership will + be in the "pending" state until the person accepts the invitation, at + which point the membership will transition to the "active" state and the + user will be added as a member of the team. + + + If the user is already a member of the team, this endpoint will update + the role of the team member's role. To update the membership of a team + member, the authenticated user must be an organization owner or a team + maintainer. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + tags: + - teams + operationId: teams/add-or-update-membership-for-user-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: The role that this user should have in the team. + enum: + - member + - maintainer + default: member + examples: + default: + summary: Add or update team membership for an organization member + value: + role: maintainer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-users-membership-with-team-is-now-pending: + $ref: >- + #/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending + '403': + description: Forbidden if team synchronization is set up + '422': + description: Unprocessable Entity if you attempt to add an organization to a team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + delete: + summary: Remove team membership for a user + description: >- + To remove a membership between a user and a team, the authenticated user + must have 'admin' permissions to the team or be an owner of the + organization that the team is associated with. Removing team membership + does not delete the user, it just removes their membership from the + team. + + + Team synchronization is available for organizations using GitHub + Enterprise Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + > [!NOTE] + + > When you have team synchronization set up for a team with your + organization's identity provider (IdP), you will see an error if you + attempt to use the API for making changes to the team's membership. If + you have access to manage group membership in your IdP, you can manage + GitHub team membership through your identity provider, which + automatically adds and removes team members in an organization. For more + information, see "[Synchronizing teams between your identity provider + and + GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + tags: + - teams + operationId: teams/remove-membership-for-user-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + description: Forbidden if team synchronization is set up + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + /orgs/{org}/teams/{team_slug}/repos: + get: + summary: List team repositories + description: >- + Lists a team's repositories visible to the authenticated user. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `GET /organizations/{org_id}/team/{team_id}/repos`. + tags: + - teams + operationId: teams/list-repos-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-team-repositories + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}: + get: + summary: Check team permissions for a repository + description: >- + Checks whether a team has `admin`, `push`, `maintain`, `triage`, or + `pull` permission for a repository. Repositories inherited through a + parent team will also be checked. + + + You can also get information about the specified repository, including + what permissions the team grants on it, by passing the following custom + [media + type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) + via the `application/vnd.github.v3.repository+json` accept header. + + + If a team doesn't have permission for the repository, you will receive a + `404 Not Found` response status. + + + If the repository is private, you must have at least `read` permission + for that repository, and your token must have the `repo` or `admin:org` + scope. Otherwise, you will receive a `404 Not Found` response status. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + tags: + - teams + operationId: teams/check-permissions-for-repo-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Alternative response with repository permissions + content: + application/json: + schema: + $ref: '#/components/schemas/team-repository' + examples: + alternative-response-with-repository-permissions: + $ref: >- + #/components/examples/team-repository-alternative-response-with-repository-permissions + '204': + description: >- + Response if team has permission for the repository. This is the + response when the repository media type hasn't been provded in the + Accept header. + '404': + description: Not Found if team does not have permission for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + put: + summary: Add or update team repository permissions + description: >- + To add a repository to a team or update the team's permission on a + repository, the authenticated user must have admin access to the + repository, and must be able to see the team. The repository must be + owned by the organization, or a direct fork of a repository owned by the + organization. You will get a `422 Unprocessable Entity` status if you + attempt to add a repository to a team that is not owned by the + organization. Note that, if you choose not to pass any parameters, + you'll need to set `Content-Length` to zero when calling out to this + endpoint. For more information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + + + For more information about the permission levels, see "[Repository + permission levels for an + organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + tags: + - teams + operationId: teams/add-or-update-repo-permissions-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: >- + The permission to grant the team on this repository. We + accept the following permissions to be set: `pull`, + `triage`, `push`, `maintain`, `admin` and you can also + specify a custom repository role name, if the owning + organization has defined any. If no permission is specified, + the team's `permission` attribute will be used to determine + what permission to grant the team on this repository. + examples: + default: + summary: >- + Adding a team to an organization repository with the write + role + value: + permission: push + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + delete: + summary: Remove a repository from a team + description: >- + If the authenticated user is an organization owner or a team maintainer, + they can remove any repositories from the team. To remove a repository + from a team as an organization member, the authenticated user must have + admin access to the repository and must be able to see the team. This + does not delete the repository, it just removes it from the team. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + tags: + - teams + operationId: teams/remove-repo-in-org + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}/teams: + get: + summary: List child teams + description: >- + Lists the child teams of the team specified by `{team_slug}`. + + + > [!NOTE] + + > You can also specify a team by `org_id` and `team_id` using the route + `GET /organizations/{org_id}/team/{team_id}/teams`. + tags: + - teams + operationId: teams/list-child-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-child-teams + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: if child teams exist + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + response-if-child-teams-exist: + $ref: >- + #/components/examples/team-items-response-if-child-teams-exist + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /teams/{team_id}: + get: + summary: Get a team (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the [Get a team by + name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) + endpoint. + tags: + - teams + operationId: teams/get-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#get-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + patch: + summary: Update a team (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Update a + team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + + + To edit a team, the authenticated user must either be an organization + owner or a team maintainer. + + + > [!NOTE] + + > With nested teams, the `privacy` for parent teams cannot be `secret`. + tags: + - teams + operationId: teams/update-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#update-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: string + description: The description of the team. + privacy: + type: string + description: >- + The level of privacy this team should have. Editing teams + without specifying this parameter leaves `privacy` intact. + The options are: + + **For a non-nested team:** + * `secret` - only visible to organization owners and members of this team. + * `closed` - visible to all members of this organization. + **For a parent or child team:** + * `closed` - visible to all members of this organization. + enum: + - secret + - closed + notification_setting: + type: string + description: >- + The notification setting the team has chosen. Editing teams + without specifying this parameter leaves + `notification_setting` intact. The options are: + * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * `notifications_disabled` - no one receives notifications. + enum: + - notifications_enabled + - notifications_disabled + permission: + type: string + description: >- + **Closing down notice**. The permission that new + repositories will be added to the team with when none is + specified. + enum: + - pull + - push + - admin + default: pull + parent_team_id: + type: integer + description: The ID of a team to set as the parent team. + nullable: true + required: + - name + examples: + default: + value: + name: new team name + description: new team description + privacy: closed + notification_setting: notifications_enabled + responses: + '200': + description: Response when the updated information already exists + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + delete: + summary: Delete a team (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Delete a + team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + + + To delete a team, the authenticated user must be an organization owner + or team maintainer. + + + If you are an organization owner, deleting a parent team will delete all + of its child teams as well. + tags: + - teams + operationId: teams/delete-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /teams/{team_id}/invitations: + get: + summary: List pending team invitations (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [`List pending team + invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) + endpoint. + + + The return hash contains a `role` field which refers to the Organization + Invitation role and will be one of the following values: + `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or + `reinstate`. If the invitee is not a GitHub member, the `login` field in + the return hash will be `null`. + tags: + - teams + operationId: teams/list-pending-invitations-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/members: + get: + summary: List team members (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [`List team + members`](https://docs.github.com/rest/teams/members#list-team-members) + endpoint. + + + Team members will include the members of child teams. + tags: + - teams + operationId: teams/list-members-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#list-team-members-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - name: role + description: Filters members returned by their role in the team. + in: query + required: false + schema: + type: string + enum: + - member + - maintainer + - all + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/members/{username}: + get: + summary: Get team member (Legacy) + description: >- + The "Get team member" endpoint (described below) is closing down. + + + We recommend using the [Get team membership for a + user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) + endpoint instead. It allows you to get both active and pending + memberships. + + + To list members in a team, the team must be visible to the authenticated + user. + tags: + - teams + operationId: teams/get-member-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#get-team-member-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: if user is a member + '404': + description: if user is not a member + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + put: + summary: Add team member (Legacy) + description: >- + The "Add team member" endpoint (described below) is closing down. + + + We recommend using the [Add or update team membership for a + user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) + endpoint instead. It allows you to invite new organization members to + your teams. + + + Team synchronization is available for organizations using GitHub + Enterprise Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + To add someone to a team, the authenticated user must be an organization + owner or a team maintainer in the team they're changing. The person + being added to the team must be a member of the team's organization. + + + > [!NOTE] + + > When you have team synchronization set up for a team with your + organization's identity provider (IdP), you will see an error if you + attempt to use the API for making changes to the team's membership. If + you have access to manage group membership in your IdP, you can manage + GitHub team membership through your identity provider, which + automatically adds and removes team members in an organization. For more + information, see "[Synchronizing teams between your identity provider + and + GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + + Note that you'll need to set `Content-Length` to zero when calling out + to this endpoint. For more information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - teams + operationId: teams/add-member-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#add-team-member-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if team synchronization is set up + '422': + description: >- + Unprocessable Entity if you attempt to add an organization to a team + or you attempt to add a user to a team when they are not a member of + at least one other team in the same organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + delete: + summary: Remove team member (Legacy) + description: >- + The "Remove team member" endpoint (described below) is closing down. + + + We recommend using the [Remove team membership for a + user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) + endpoint instead. It allows you to remove both active and pending + memberships. + + + Team synchronization is available for organizations using GitHub + Enterprise Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + To remove a team member, the authenticated user must have 'admin' + permissions to the team or be an owner of the org that the team is + associated with. Removing a team member does not delete the user, it + just removes them from the team. + + + > [!NOTE] + + > When you have team synchronization set up for a team with your + organization's identity provider (IdP), you will see an error if you + attempt to use the API for making changes to the team's membership. If + you have access to manage group membership in your IdP, you can manage + GitHub team membership through your identity provider, which + automatically adds and removes team members in an organization. For more + information, see "[Synchronizing teams between your identity provider + and + GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + tags: + - teams + operationId: teams/remove-member-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#remove-team-member-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '404': + description: Not Found if team synchronization is setup + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/memberships/{username}: + get: + summary: Get team membership for a user (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Get team membership for a + user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) + endpoint. + + + Team members will include the members of child teams. + + + To get a user's membership with a team, the team must be visible to the + authenticated user. + + + **Note:** + + The response contains the `state` of the membership and the member's + `role`. + + + The `role` for organization owners is set to `maintainer`. For more + information about `maintainer` roles, see [Create a + team](https://docs.github.com/rest/teams/teams#create-a-team). + tags: + - teams + operationId: teams/get-membership-for-user-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-user-is-a-team-maintainer: + $ref: >- + #/components/examples/team-membership-response-if-user-is-a-team-maintainer + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + put: + summary: Add or update team membership for a user (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Add or update team membership for a + user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) + endpoint. + + + Team synchronization is available for organizations using GitHub + Enterprise Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + If the user is already a member of the team's organization, this + endpoint will add the user to the team. To add a membership between an + organization member and a team, the authenticated user must be an + organization owner or a team maintainer. + + + > [!NOTE] + + > When you have team synchronization set up for a team with your + organization's identity provider (IdP), you will see an error if you + attempt to use the API for making changes to the team's membership. If + you have access to manage group membership in your IdP, you can manage + GitHub team membership through your identity provider, which + automatically adds and removes team members in an organization. For more + information, see "[Synchronizing teams between your identity provider + and + GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + + If the user is unaffiliated with the team's organization, this endpoint + will send an invitation to the user via email. This newly-created + membership will be in the "pending" state until the user accepts the + invitation, at which point the membership will transition to the + "active" state and the user will be added as a member of the team. To + add a membership between an unaffiliated user and a team, the + authenticated user must be an organization owner. + + + If the user is already a member of the team, this endpoint will update + the role of the team member's role. To update the membership of a team + member, the authenticated user must be an organization owner or a team + maintainer. + tags: + - teams + operationId: teams/add-or-update-membership-for-user-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: The role that this user should have in the team. + enum: + - member + - maintainer + default: member + examples: + default: + summary: Assign the member role for a user in a team + value: + role: member + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-users-membership-with-team-is-now-pending: + $ref: >- + #/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending + '403': + description: Forbidden if team synchronization is set up + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity if you attempt to add an organization to a team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + delete: + summary: Remove team membership for a user (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Remove team membership for a + user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) + endpoint. + + + Team synchronization is available for organizations using GitHub + Enterprise Cloud. For more information, see [GitHub's + products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + + To remove a membership between a user and a team, the authenticated user + must have 'admin' permissions to the team or be an owner of the + organization that the team is associated with. Removing team membership + does not delete the user, it just removes their membership from the + team. + + + > [!NOTE] + + > When you have team synchronization set up for a team with your + organization's identity provider (IdP), you will see an error if you + attempt to use the API for making changes to the team's membership. If + you have access to manage group membership in your IdP, you can manage + GitHub team membership through your identity provider, which + automatically adds and removes team members in an organization. For more + information, see "[Synchronizing teams between your identity provider + and + GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + tags: + - teams + operationId: teams/remove-membership-for-user-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + description: if team synchronization is set up + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/repos: + get: + summary: List team repositories (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [List team + repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) + endpoint. + tags: + - teams + operationId: teams/list-repos-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /teams/{team_id}/repos/{owner}/{repo}: + get: + summary: Check team permissions for a repository (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Check team permissions for a + repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) + endpoint. + + + > [!NOTE] + + > Repositories inherited through a parent team will also be checked. + + + You can also get information about the specified repository, including + what permissions the team grants on it, by passing the following custom + [media + type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) + via the `Accept` header: + tags: + - teams + operationId: teams/check-permissions-for-repo-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Alternative response with extra repository information + content: + application/json: + schema: + $ref: '#/components/schemas/team-repository' + examples: + alternative-response-with-extra-repository-information: + $ref: >- + #/components/examples/team-repository-alternative-response-with-extra-repository-information + '204': + description: Response if repository is managed by this team + '404': + description: Not Found if repository is not managed by this team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + put: + summary: Add or update team repository permissions (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new "[Add or update team repository + permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" + endpoint. + + + To add a repository to a team or update the team's permission on a + repository, the authenticated user must have admin access to the + repository, and must be able to see the team. The repository must be + owned by the organization, or a direct fork of a repository owned by the + organization. You will get a `422 Unprocessable Entity` status if you + attempt to add a repository to a team that is not owned by the + organization. + + + Note that, if you choose not to pass any parameters, you'll need to set + `Content-Length` to zero when calling out to this endpoint. For more + information, see "[HTTP + method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - teams + operationId: teams/add-or-update-repo-permissions-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: >- + The permission to grant the team on this repository. If no + permission is specified, the team's `permission` attribute + will be used to determine what permission to grant the team + on this repository. + enum: + - pull + - push + - admin + examples: + default: + summary: Example of setting permission to pull + value: + permission: push + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + delete: + summary: Remove a repository from a team (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [Remove a repository from a + team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) + endpoint. + + + If the authenticated user is an organization owner or a team maintainer, + they can remove any repositories from the team. To remove a repository + from a team as an organization member, the authenticated user must have + admin access to the repository and must be able to see the team. NOTE: + This does not delete the repository, it just removes it from the team. + tags: + - teams + operationId: teams/remove-repo-legacy + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /teams/{team_id}/teams: + get: + summary: List child teams (Legacy) + description: >- + > [!WARNING] + + > **Endpoint closing down notice:** This endpoint route is closing down + and will be removed from the Teams API. We recommend migrating your + existing code to use the new [`List child + teams`](https://docs.github.com/rest/teams/teams#list-child-teams) + endpoint. + tags: + - teams + operationId: teams/list-child-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: if child teams exist + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + response-if-child-teams-exist: + $ref: >- + #/components/examples/team-items-response-if-child-teams-exist + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /user/teams: + get: + summary: List teams for the authenticated user + description: >- + List all of the teams across all of the organizations to which the + authenticated + + user belongs. + + + OAuth app tokens and personal access tokens (classic) need the `user`, + `repo`, or `read:org` scope to use this endpoint. + + + When using a fine-grained personal access token, the resource owner of + the token must be a single organization, and the response will only + include the teams from that organization. + tags: + - teams + operationId: teams/list-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: teams + subcategory: teams + x-stackQL-resource: teams +components: + schemas: + team: + title: Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + team-full: + title: Full Team + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + example: 42 + type: integer + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + example: https://api.github.com/organizations/1/team/1 + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + name: + description: Name of the team + example: Developers + type: string + slug: + type: string + example: justice-league + description: + type: string + example: A great team. + nullable: true + privacy: + description: The level of privacy this team should have + type: string + enum: + - closed + - secret + example: closed + notification_setting: + description: The notification setting the team has set + type: string + enum: + - notifications_enabled + - notifications_disabled + example: notifications_enabled + permission: + description: Permission that the team will have for its repositories + example: push + type: string + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + parent: + $ref: '#/components/schemas/nullable-team-simple' + members_count: + type: integer + example: 3 + repos_count: + type: integer + example: 10 + created_at: + type: string + format: date-time + example: '2017-07-14T16:53:42Z' + updated_at: + type: string + format: date-time + example: '2017-08-17T12:37:15Z' + organization: + $ref: '#/components/schemas/team-organization' + ldap_dn: + $ref: '#/components/schemas/ldap-dn' + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + - created_at + - updated_at + - members_count + - repos_count + - organization + organization-invitation: + title: Organization Invitation + description: Organization Invitation + type: object + properties: + id: + type: integer + format: int64 + login: + type: string + nullable: true + email: + type: string + nullable: true + role: + type: string + created_at: + type: string + failed_at: + type: string + nullable: true + failed_reason: + type: string + nullable: true + inviter: + $ref: '#/components/schemas/simple-user' + team_count: + type: integer + node_id: + type: string + example: '"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x"' + invitation_teams_url: + type: string + example: '"https://api.github.com/organizations/16/invitations/1/teams"' + invitation_source: + type: string + example: '"member"' + required: + - id + - login + - email + - role + - created_at + - inviter + - team_count + - invitation_teams_url + - node_id + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + team-membership: + title: Team Membership + description: Team Membership + type: object + properties: + url: + type: string + format: uri + role: + description: The role of the user in the team. + enum: + - member + - maintainer + default: member + example: member + type: string + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: >- + The size of the repository, in kilobytes. Size is calculated hourly. + When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: >- + The policy controlling who can create pull requests: all or + collaborators_only. + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: >- + The custom properties that were defined for the repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + role_name: + type: string + example: admin + owner: + $ref: '#/components/schemas/nullable-simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: >- + http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: >- + Whether this repository acts as a template that can be used to + generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + example: false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + example: false + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable-team-simple: + title: Team Simple + description: >- + Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + team-organization: + title: Team Organization + description: Team Organization + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + name: + type: string + example: github + company: + type: string + example: GitHub + blog: + type: string + format: uri + example: https://github.com/blog + location: + type: string + example: San Francisco + email: + type: string + format: email + example: octocat@github.com + twitter_username: + type: string + example: github + nullable: true + is_verified: + type: boolean + example: true + has_organization_projects: + type: boolean + example: true + has_repository_projects: + type: boolean + example: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + html_url: + type: string + format: uri + example: https://github.com/octocat + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + type: + type: string + example: Organization + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + private_gists: + type: integer + example: 81 + nullable: true + disk_usage: + type: integer + example: 10000 + nullable: true + collaborators: + type: integer + example: 8 + nullable: true + billing_email: + type: string + format: email + example: org@example.com + nullable: true + plan: + type: object + properties: + name: + type: string + space: + type: integer + private_repos: + type: integer + filled_seats: + type: integer + seats: + type: integer + required: + - name + - space + - private_repos + default_repository_permission: + type: string + nullable: true + members_can_create_repositories: + type: boolean + example: true + nullable: true + two_factor_requirement_enabled: + type: boolean + example: true + nullable: true + members_allowed_repository_creation_type: + type: string + example: all + members_can_create_public_repositories: + type: boolean + example: true + members_can_create_private_repositories: + type: boolean + example: true + members_can_create_internal_repositories: + type: boolean + example: true + members_can_create_pages: + type: boolean + example: true + members_can_create_public_pages: + type: boolean + example: true + members_can_create_private_pages: + type: boolean + example: true + members_can_fork_private_repositories: + type: boolean + example: false + nullable: true + web_commit_signoff_required: + type: boolean + example: false + updated_at: + type: string + format: date-time + archived_at: + type: string + format: date-time + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + - html_url + - has_organization_projects + - has_repository_projects + - public_repos + - public_gists + - followers + - following + - type + - created_at + - updated_at + - archived_at + ldap-dn: + type: string + description: >- + The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of + the LDAP entry to map to a team. + example: cn=Enterprise Ops,ou=teams,dc=github,dc=com + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: > + # Contributor Covenant Code of Conduct + + + ## Our Pledge + + + In the interest of fostering an open and welcoming environment, we + as contributors and maintainers pledge to making participation in + our project and our community a harassment-free experience for + everyone, regardless of age, body size, disability, ethnicity, + gender identity and expression, level of experience, nationality, + personal appearance, race, religion, or sexual identity and + orientation. + + + ## Our Standards + + + Examples of behavior that contributes to creating a positive + environment include: + + + * Using welcoming and inclusive language + + * Being respectful of differing viewpoints and experiences + + * Gracefully accepting constructive criticism + + * Focusing on what is best for the community + + * Showing empathy towards other community members + + + Examples of unacceptable behavior by participants include: + + + * The use of sexualized language or imagery and unwelcome sexual + attention or advances + + * Trolling, insulting/derogatory comments, and personal or political + attacks + + * Public or private harassment + + * Publishing others' private information, such as a physical or + electronic address, without explicit permission + + * Other conduct which could reasonably be considered inappropriate + in a professional setting + + + ## Our Responsibilities + + + Project maintainers are responsible for clarifying the standards of + acceptable behavior and are expected to take appropriate and fair + corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, + edit, or reject comments, commits, code, wiki edits, issues, and + other contributions that are not aligned to this Code of Conduct, or + to ban temporarily or permanently any contributor for other + behaviors that they deem inappropriate, threatening, offensive, or + harmful. + + + ## Scope + + + This Code of Conduct applies both within project spaces and in + public spaces when an individual is representing the project or its + community. Examples of representing a project or community include + using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + + Instances of abusive, harassing, or otherwise unacceptable behavior + may be reported by contacting the project team at [EMAIL]. The + project team will review and investigate all complaints, and will + respond in a way that it deems appropriate to the circumstances. The + project team is obligated to maintain confidentiality with regard to + the reporter of an incident. Further details of specific enforcement + policies may be posted separately. + + + Project maintainers who do not follow or enforce the Code of Conduct + in good faith may face temporary or permanent repercussions as + determined by other members of the project's leadership. + + + ## Attribution + + + This Code of Conduct is adapted from the [Contributor + Covenant](http://contributor-covenant.org), version 1.4, available + at + [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: > + Enable or disable GitHub Advanced Security for the repository. + + + For standalone Code Scanning or Secret Protection products, this + parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: >- + The enablement status of Dependabot security updates for the + repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + enterprise_team_unsupported: + description: >- + Unprocessable entity if you attempt to modify an enterprise team at the + organization level. + not_modified: + description: Not modified + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + team-type: + name: team_type + description: >- + Filter team results by their type. For more information, see "[What kind + of team should I + use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" + in: query + required: false + schema: + type: string + enum: + - all + - enterprise + - organization + default: all + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: >- + The name of the repository without the `.git` extension. The name is not + case sensitive. + in: path + required: true + schema: + type: string + team-id: + name: team_id + description: The unique identifier of the team. + in: path + required: true + schema: + type: integer + examples: + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + team-full: + value: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + members_count: 3 + repos_count: 10 + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: github + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + is_verified: true + has_organization_projects: true + has_repository_projects: true + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + html_url: https://github.com/octocat + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + organization-invitation-items: + value: + - id: 1 + login: monalisa + node_id: MDQ6VXNlcjE= + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + failed_at: '' + failed_reason: '' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams + invitation_source: member + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + team-membership-response-if-user-is-a-team-maintainer: + summary: Response if user is a team maintainer + value: + url: https://api.github.com/teams/1/memberships/octocat + role: maintainer + state: active + team-membership-response-if-users-membership-with-team-is-now-pending: + summary: Response if user's membership with team is now pending + value: + url: https://api.github.com/teams/1/memberships/octocat + role: member + state: pending + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + team-repository-alternative-response-with-repository-permissions: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + maintain: false + push: false + triage: false + pull: true + role_name: read + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + team-items-response-if-child-teams-exist: + value: + - id: 2 + node_id: MDQ6VGVhbTI= + url: https://api.github.com/teams/2 + name: Original Roster + slug: original-roster + description: Started it all. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/2/members{/member} + repositories_url: https://api.github.com/teams/2/repos + parent: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + html_url: https://github.com/orgs/rails/teams/core + team-repository-alternative-response-with-extra-repository-information: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: >- + https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: >- + https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: >- + https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: >- + https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: >- + https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + maintain: false + push: false + triage: false + pull: true + role_name: read + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + team-full-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + members_count: 3 + repos_count: 10 + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: github + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + is_verified: true + has_organization_projects: true + has_repository_projects: true + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + html_url: https://github.com/octocat + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + teams: + id: github.teams.teams + name: teams + title: Teams + methods: + list: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1teams/post' + response: + mediaType: application/json + openAPIDocKey: '201' + update_in_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_in_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + get_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_legacy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1teams~1{team_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/teams/methods/list' + - $ref: '#/components/x-stackQL-resources/teams/methods/get_legacy' + insert: + - $ref: '#/components/x-stackQL-resources/teams/methods/create' + update: + - $ref: '#/components/x-stackQL-resources/teams/methods/update_in_org' + - $ref: '#/components/x-stackQL-resources/teams/methods/update_legacy' + delete: + - $ref: '#/components/x-stackQL-resources/teams/methods/delete_in_org' + - $ref: '#/components/x-stackQL-resources/teams/methods/delete_legacy' + replace: [] + details: + id: github.teams.details + name: details + title: Details + methods: + get_by_name: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/details/methods/get_by_name' + insert: [] + update: [] + delete: [] + replace: [] + invitations: + id: github.teams.invitations + name: invitations + title: Invitations + methods: + list_pending_invitations_in_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}~1invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_pending_invitations_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1invitations/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/list_pending_invitations_in_org + - $ref: >- + #/components/x-stackQL-resources/invitations/methods/list_pending_invitations_legacy + insert: [] + update: [] + delete: [] + replace: [] + members: + id: github.teams.members + name: members + title: Members + methods: + list_members_in_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_members_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1members/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_member_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1members~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + add_member_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1members~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + remove_member_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1members~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/members/methods/list_members_in_org + - $ref: '#/components/x-stackQL-resources/members/methods/get_member_legacy' + - $ref: >- + #/components/x-stackQL-resources/members/methods/list_members_legacy + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/members/methods/remove_member_legacy + replace: + - $ref: '#/components/x-stackQL-resources/members/methods/add_member_legacy' + membership: + id: github.teams.membership + name: membership + title: Membership + methods: + get_membership_for_user_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1teams~1{team_slug}~1memberships~1{username}/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_or_update_membership_for_user_in_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1teams~1{team_slug}~1memberships~1{username}/put + response: + mediaType: application/json + openAPIDocKey: '200' + remove_membership_for_user_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1teams~1{team_slug}~1memberships~1{username}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + get_membership_for_user_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1memberships~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_or_update_membership_for_user_legacy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1teams~1{team_id}~1memberships~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_membership_for_user_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1memberships~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/membership/methods/get_membership_for_user_in_org + - $ref: >- + #/components/x-stackQL-resources/membership/methods/get_membership_for_user_legacy + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/membership/methods/remove_membership_for_user_in_org + - $ref: >- + #/components/x-stackQL-resources/membership/methods/remove_membership_for_user_legacy + replace: + - $ref: >- + #/components/x-stackQL-resources/membership/methods/add_or_update_membership_for_user_in_org + - $ref: >- + #/components/x-stackQL-resources/membership/methods/add_or_update_membership_for_user_legacy + repos: + id: github.teams.repos + name: repos + title: Repos + methods: + list_repos_in_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}~1repos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_repo_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1teams~1{team_slug}~1repos~1{owner}~1{repo}/delete + response: + mediaType: application/json + openAPIDocKey: '204' + list_repos_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1repos/get' + response: + mediaType: application/json + openAPIDocKey: '200' + remove_repo_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1repos~1{owner}~1{repo}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/repos/methods/list_repos_in_org' + - $ref: '#/components/x-stackQL-resources/repos/methods/list_repos_legacy' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/repos/methods/remove_repo_in_org' + - $ref: '#/components/x-stackQL-resources/repos/methods/remove_repo_legacy' + replace: [] + permissions: + id: github.teams.permissions + name: permissions + title: Permissions + methods: + check_permissions_for_repo_in_org: + operation: + $ref: >- + #/paths/~1orgs~1{org}~1teams~1{team_slug}~1repos~1{owner}~1{repo}/get + response: + mediaType: application/json + openAPIDocKey: '200' + add_or_update_repo_permissions_in_org: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: >- + #/paths/~1orgs~1{org}~1teams~1{team_slug}~1repos~1{owner}~1{repo}/put + response: + mediaType: application/json + openAPIDocKey: '204' + check_permissions_for_repo_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1repos~1{owner}~1{repo}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_or_update_repo_permissions_legacy: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1teams~1{team_id}~1repos~1{owner}~1{repo}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/check_permissions_for_repo_in_org + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/check_permissions_for_repo_legacy + insert: [] + update: [] + delete: [] + replace: + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/add_or_update_repo_permissions_in_org + - $ref: >- + #/components/x-stackQL-resources/permissions/methods/add_or_update_repo_permissions_legacy + child_teams: + id: github.teams.child_teams + name: child_teams + title: Child Teams + methods: + list_child_in_org: + operation: + $ref: '#/paths/~1orgs~1{org}~1teams~1{team_slug}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_child_legacy: + operation: + $ref: '#/paths/~1teams~1{team_id}~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/child_teams/methods/list_child_in_org + - $ref: >- + #/components/x-stackQL-resources/child_teams/methods/list_child_legacy + insert: [] + update: [] + delete: [] + replace: [] + teams_for_auth_user: + id: github.teams.teams_for_auth_user + name: teams_for_auth_user + title: Teams For Auth User + methods: + list_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1teams/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/teams_for_auth_user/methods/list_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/openapi/src/github/v00.00.00000/services/users.yaml b/provider-dev/openapi/src/github/v00.00.00000/services/users.yaml new file mode 100644 index 0000000..f2fd28c --- /dev/null +++ b/provider-dev/openapi/src/github/v00.00.00000/services/users.yaml @@ -0,0 +1,5082 @@ +openapi: 3.0.3 +info: + title: users API + description: Interact with and view information about users and also current user. + version: 1.1.4 +paths: + /user: + get: + summary: Get the authenticated user + description: >- + OAuth app tokens and personal access tokens (classic) need the `user` + scope in order for the response to include private profile information. + tags: + - users + operationId: users/get-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-the-authenticated-user + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + discriminator: + propertyName: user_view_type + mapping: + public: '#/components/schemas/public-user' + private: '#/components/schemas/private-user' + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: >- + https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: >- + https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + additionalProperties: false + examples: + response-with-public-and-private-profile-information: + $ref: >- + #/components/examples/private-user-response-with-public-and-private-profile-information + response-with-public-profile-information: + $ref: >- + #/components/examples/private-user-response-with-public-profile-information + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: users + x-stackQL-resource: users + patch: + summary: Update the authenticated user + description: >- + **Note:** If your email is set to private and you send an `email` + parameter as part of this request to update your profile, your privacy + settings are still enforced: the email address will not be displayed on + your public profile or via the API. + tags: + - users + operationId: users/update-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#update-the-authenticated-user + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + description: The new name of the user. + type: string + example: Omar Jahandar + email: + description: The publicly visible email address of the user. + type: string + example: omar@example.com + blog: + description: The new blog URL of the user. + type: string + example: blog.example.com + twitter_username: + description: The new Twitter username of the user. + type: string + example: therealomarj + nullable: true + company: + description: The new company of the user. + type: string + example: Acme corporation + location: + description: The new location of the user. + type: string + example: Berlin, Germany + hireable: + description: The new hiring availability of the user. + type: boolean + bio: + description: The new short biography of the user. + type: string + examples: + default: + summary: Example of updating blog and name + value: + blog: https://github.com/blog + name: monalisa octocat + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/private-user' + examples: + default: + $ref: '#/components/examples/private-user' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: users + x-stackQL-resource: users + /user/blocks: + get: + summary: List users blocked by the authenticated user + description: List the users you've blocked on your personal account. + tags: + - users + operationId: users/list-blocked-by-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + /user/blocks/{username}: + get: + summary: Check if a user is blocked by the authenticated user + description: >- + Returns a 204 if the given user is blocked by the authenticated user. + Returns a 404 if the given user is not blocked by the authenticated + user, or if the given user account has been identified as spam by + GitHub. + tags: + - users + operationId: users/check-blocked + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: If the user is blocked + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: If the user is not blocked + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + put: + summary: Block a user + description: >- + Blocks the given user and returns a 204. If the authenticated user + cannot block the given user a 422 is returned. + tags: + - users + operationId: users/block + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/blocking#block-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + delete: + summary: Unblock a user + description: Unblocks the given user and returns a 204. + tags: + - users + operationId: users/unblock + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/blocking#unblock-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + /user/email/visibility: + patch: + summary: Set primary email visibility for the authenticated user + description: Sets the visibility for your primary email addresses. + tags: + - users + operationId: users/set-primary-email-visibility-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + visibility: + description: Denotes whether an email is publicly visible. + type: string + enum: + - public + - private + required: + - visibility + type: object + examples: + default: + summary: Example setting the primary email address to private + value: + visibility: private + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items-3' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + /user/emails: + get: + summary: List email addresses for the authenticated user + description: >- + Lists all of your email addresses, and specifies which one is visible + + to the public. + + + OAuth app tokens and personal access tokens (classic) need the + `user:email` scope to use this endpoint. + tags: + - users + operationId: users/list-emails-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items-2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + post: + summary: Add an email address for the authenticated user + description: >- + OAuth app tokens and personal access tokens (classic) need the `user` + scope to use this endpoint. + tags: + - users + operationId: users/add-email-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + emails: + description: >- + Adds one or more email addresses to your GitHub account. + Must contain at least one email address. **Note:** + Alternatively, you can pass a single email address or an + `array` of emails addresses directly, but we recommend that + you pass an object using the `emails` key. + type: array + items: + type: string + example: username@example.com + minItems: 1 + example: [] + required: + - emails + example: + emails: + - octocat@github.com + - mona@github.com + items: + type: string + example: username@example.com + minItems: 1 + examples: + default: + summary: Example adding multiple email addresses + value: + emails: + - octocat@github.com + - mona@github.com + - octocat@octocat.org + responses: + '201': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + delete: + summary: Delete an email address for the authenticated user + description: >- + OAuth app tokens and personal access tokens (classic) need the `user` + scope to use this endpoint. + tags: + - users + operationId: users/delete-email-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user + parameters: [] + requestBody: + content: + application/json: + schema: + type: object + description: >- + Deletes one or more email addresses from your GitHub account. + Must contain at least one email address. **Note:** + Alternatively, you can pass a single email address or an `array` + of emails addresses directly, but we recommend that you pass an + object using the `emails` key. + properties: + emails: + description: Email addresses associated with the GitHub user account. + type: array + items: + type: string + example: username@example.com + minItems: 1 + example: + emails: + - octocat@github.com + - mona@github.com + required: + - emails + items: + type: string + example: username@example.com + minItems: 1 + examples: + default: + summary: Example deleting multiple email accounts + value: + emails: + - octocat@github.com + - mona@github.com + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + /user/followers: + get: + summary: List followers of the authenticated user + description: Lists the people following the authenticated user. + tags: + - users + operationId: users/list-followers-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + /user/following: + get: + summary: List the people the authenticated user follows + description: Lists the people who the authenticated user follows. + tags: + - users + operationId: users/list-followed-by-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + /user/following/{username}: + get: + summary: Check if a person is followed by the authenticated user + description: '' + tags: + - users + operationId: users/check-person-is-followed-by-authenticated + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: if the person is followed by the authenticated user + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: if the person is not followed by the authenticated user + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + put: + summary: Follow a user + description: >- + Note that you'll need to set `Content-Length` to zero when calling out + to this endpoint. For more information, see "[HTTP + verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + + + OAuth app tokens and personal access tokens (classic) need the + `user:follow` scope to use this endpoint. + tags: + - users + operationId: users/follow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#follow-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + delete: + summary: Unfollow a user + description: >- + OAuth app tokens and personal access tokens (classic) need the + `user:follow` scope to use this endpoint. + tags: + - users + operationId: users/unfollow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#unfollow-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + /user/gpg_keys: + get: + summary: List GPG keys for the authenticated user + description: >- + Lists the current user's GPG keys. + + + OAuth app tokens and personal access tokens (classic) need the + `read:gpg_key` scope to use this endpoint. + tags: + - users + operationId: users/list-gpg-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + post: + summary: Create a GPG key for the authenticated user + description: >- + Adds a GPG key to the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `write:gpg_key` scope to use this endpoint. + operationId: users/create-gpg-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: A descriptive name for the new key. + type: string + armored_public_key: + description: A GPG key in ASCII-armored format. + type: string + type: object + required: + - armored_public_key + examples: + default: + value: + name: Octocat's GPG Key + armored_public_key: |- + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1 + + mQINBFnZ2ZIBEADQ2Z7Z7 + -----END PGP PUBLIC KEY BLOCK----- + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + /user/gpg_keys/{gpg_key_id}: + get: + summary: Get a GPG key for the authenticated user + description: >- + View extended details for a single GPG key. + + + OAuth app tokens and personal access tokens (classic) need the + `read:gpg_key` scope to use this endpoint. + tags: + - users + operationId: users/get-gpg-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/gpg-key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + delete: + summary: Delete a GPG key for the authenticated user + description: >- + Removes a GPG key from the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:gpg_key` scope to use this endpoint. + tags: + - users + operationId: users/delete-gpg-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/gpg-key-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + /user/keys: + get: + summary: List public SSH keys for the authenticated user + description: >- + Lists the public SSH keys for the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `read:public_key` scope to use this endpoint. + tags: + - users + operationId: users/list-public-ssh-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/key' + examples: + default: + $ref: '#/components/examples/key-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + post: + summary: Create a public SSH key for the authenticated user + description: >- + Adds a public SSH key to the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `write:public_key` scope to use this endpoint. + operationId: users/create-public-ssh-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + title: + description: A descriptive name for the new key. + type: string + example: Personal MacBook Air + key: + description: The public SSH key to add to your GitHub account. + type: string + pattern: '^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ' + required: + - key + type: object + examples: + default: + value: + title: ssh-rsa AAAAB3NzaC1yc2EAAA + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/key' + examples: + default: + $ref: '#/components/examples/key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + /user/keys/{key_id}: + get: + summary: Get a public SSH key for the authenticated user + description: >- + View extended details for a single public SSH key. + + + OAuth app tokens and personal access tokens (classic) need the + `read:public_key` scope to use this endpoint. + tags: + - users + operationId: users/get-public-ssh-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/key' + examples: + default: + $ref: '#/components/examples/key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + delete: + summary: Delete a public SSH key for the authenticated user + description: >- + Removes a public SSH key from the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:public_key` scope to use this endpoint. + tags: + - users + operationId: users/delete-public-ssh-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/key-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + /user/public_emails: + get: + summary: List public email addresses for the authenticated user + description: >- + Lists your publicly visible email address, which you can set with the + + [Set primary email visibility for the authenticated + user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + + endpoint. + + + OAuth app tokens and personal access tokens (classic) need the + `user:email` scope to use this endpoint. + tags: + - users + operationId: users/list-public-emails-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items-2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + /user/social_accounts: + get: + summary: List social accounts for the authenticated user + description: Lists all of your social accounts. + tags: + - users + operationId: users/list-social-accounts-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/social-account' + examples: + default: + $ref: '#/components/examples/social-account-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + post: + summary: Add social accounts for the authenticated user + description: >- + Add one or more social accounts to the authenticated user's profile. + + + OAuth app tokens and personal access tokens (classic) need the `user` + scope to use this endpoint. + tags: + - users + operationId: users/add-social-account-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + account_urls: + description: Full URLs for the social media profiles to add. + type: array + items: + type: string + example: https://twitter.com/github + example: [] + required: + - account_urls + example: + account_urls: + - https://www.linkedin.com/company/github/ + - https://twitter.com/github + examples: + default: + summary: Adding multiple social accounts + value: + account_urls: + - https://facebook.com/GitHub + - https://www.youtube.com/@GitHub + responses: + '201': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/social-account' + examples: + default: + $ref: '#/components/examples/social-account-items' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + delete: + summary: Delete social accounts for the authenticated user + description: >- + Deletes one or more social accounts from the authenticated user's + profile. + + + OAuth app tokens and personal access tokens (classic) need the `user` + scope to use this endpoint. + tags: + - users + operationId: users/delete-social-account-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + account_urls: + description: Full URLs for the social media profiles to delete. + type: array + items: + type: string + example: https://twitter.com/github + example: [] + required: + - account_urls + example: + account_urls: + - https://www.linkedin.com/company/github/ + - https://twitter.com/github + examples: + default: + summary: Deleting multiple social accounts + value: + account_urls: + - https://facebook.com/GitHub + - https://www.youtube.com/@GitHub + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + /user/ssh_signing_keys: + get: + summary: List SSH signing keys for the authenticated user + description: >- + Lists the SSH signing keys for the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `read:ssh_signing_key` scope to use this endpoint. + tags: + - users + operationId: users/list-ssh-signing-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + post: + summary: Create a SSH signing key for the authenticated user + description: >- + Creates an SSH signing key for the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `write:ssh_signing_key` scope to use this endpoint. + operationId: users/create-ssh-signing-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + title: + description: A descriptive name for the new key. + type: string + example: Personal MacBook Air + key: + description: >- + The public SSH key to add to your GitHub account. For more + information, see "[Checking for existing SSH + keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + type: string + pattern: >- + ^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) + |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com + required: + - key + type: object + examples: + default: + value: + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + /user/ssh_signing_keys/{ssh_signing_key_id}: + get: + summary: Get an SSH signing key for the authenticated user + description: >- + Gets extended details for an SSH signing key. + + + OAuth app tokens and personal access tokens (classic) need the + `read:ssh_signing_key` scope to use this endpoint. + tags: + - users + operationId: users/get-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/ssh-signing-key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + delete: + summary: Delete an SSH signing key for the authenticated user + description: >- + Deletes an SSH signing key from the authenticated user's GitHub account. + + + OAuth app tokens and personal access tokens (classic) need the + `admin:ssh_signing_key` scope to use this endpoint. + tags: + - users + operationId: users/delete-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/ssh-signing-key-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + /user/{account_id}: + get: + summary: Get a user using their ID + description: >- + Provides publicly available information about someone with a GitHub + account. This method takes their durable user `ID` instead of their + `login`, which can change over time. + + + If you are requesting information about an [Enterprise Managed + User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), + or a GitHub App bot that is installed in an organization that uses + Enterprise Managed Users, your requests must be authenticated as a user + or GitHub App that has access to the organization to view that account's + information. If you are not authorized, the request will return a `404 + Not Found` status. + + + The `email` key in the following response is the publicly visible email + address from your GitHub [profile + page](https://github.com/settings/profile). When setting up your + profile, you can select a primary email address to be public which + provides an email entry for this endpoint. If you do not set a public + email address for `email`, then it will have a value of `null`. You only + see publicly visible email addresses when authenticated with GitHub. For + more information, see + [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + + The Emails API enables you to list all of your email addresses, and + toggle a primary email to be visible publicly. For more information, see + [Emails API](https://docs.github.com/rest/users/emails). + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-a-user-using-their-id + parameters: + - $ref: '#/components/parameters/account-id' + responses: + '200': + description: Response + content: + application/json: + schema: + discriminator: + propertyName: user_view_type + mapping: + public: '#/components/schemas/public-user' + private: '#/components/schemas/private-user' + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: >- + https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: >- + https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + additionalProperties: false + examples: + default-response: + $ref: '#/components/examples/public-user-default-response' + response-with-git-hub-plan-information: + $ref: >- + #/components/examples/public-user-response-with-git-hub-plan-information + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users + x-stackQL-resource: users + /users: + get: + summary: List users + description: >- + Lists all users, in the order that they signed up on GitHub. This list + includes personal user accounts and organization accounts. + + + Note: Pagination is powered exclusively by the `since` parameter. Use + the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) + to get the URL for the next page of users. + tags: + - users + operationId: users/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#list-users + parameters: + - $ref: '#/components/parameters/since-user' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users + x-stackQL-resource: users + /users/{username}: + get: + summary: Get a user + description: >- + Provides publicly available information about someone with a GitHub + account. + + + If you are requesting information about an [Enterprise Managed + User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), + or a GitHub App bot that is installed in an organization that uses + Enterprise Managed Users, your requests must be authenticated as a user + or GitHub App that has access to the organization to view that account's + information. If you are not authorized, the request will return a `404 + Not Found` status. + + + The `email` key in the following response is the publicly visible email + address from your GitHub [profile + page](https://github.com/settings/profile). When setting up your + profile, you can select a primary email address to be public which + provides an email entry for this endpoint. If you do not set a public + email address for `email`, then it will have a value of `null`. You only + see publicly visible email addresses when authenticated with GitHub. For + more information, see + [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + + The Emails API enables you to list all of your email addresses, and + toggle a primary email to be visible publicly. For more information, see + [Emails API](https://docs.github.com/rest/users/emails). + tags: + - users + operationId: users/get-by-username + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + discriminator: + propertyName: user_view_type + mapping: + public: '#/components/schemas/public-user' + private: '#/components/schemas/private-user' + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: >- + https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: >- + https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + additionalProperties: false + examples: + default-response: + $ref: '#/components/examples/public-user-default-response' + response-with-git-hub-plan-information: + $ref: >- + #/components/examples/public-user-response-with-git-hub-plan-information + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users + x-stackQL-resource: users + /users/{username}/attestations/bulk-list: + post: + summary: List attestations by bulk subject digests + description: >- + List a collection of artifact attestations associated with any entry in + a list of subject digests owned by a user. + + + The collection of attestations returned by this endpoint is filtered + according to the authenticated user's permissions; if the authenticated + user cannot read a repository, the attestations associated with that + repository will not be included in the response. In addition, when using + a fine-grained access token the `attestations:read` permission is + required. + + + **Please note:** in order to offer meaningful security benefits, an + attestation's signature and timestamps **must** be cryptographically + verified, and the identity of the attestation signer **must** be + validated. Attestations can be verified using the [GitHub CLI + `attestation verify` + command](https://cli.github.com/manual/gh_attestation_verify). For more + information, see [our guide on how to use artifact attestations to + establish a build's + provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations-bulk + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/username' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: >- + Optional filter for fetching attestations with a given + predicate type. + + This option accepts `provenance`, `sbom`, `release`, or + freeform text + + for custom predicate types. + required: + - subject_digests + examples: + default: + $ref: '#/components/examples/bulk-subject-digest-body' + withPredicateType: + $ref: >- + #/components/examples/bulk-subject-digest-body-with-predicate-type + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + nullable: true + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + $ref: '#/components/examples/list-attestations-bulk' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations_subject_digests: + additionalProperties: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /users/{username}/attestations/delete-request: + post: + summary: Delete attestations in bulk + description: >- + Delete artifact attestations in bulk by either subject digests or unique + ID. + tags: + - users + operationId: users/delete-attestations-bulk + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk + parameters: + - $ref: '#/components/parameters/username' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: >- + The request body must include either `subject_digests` or + `attestation_ids`, but not both. + properties: + subject_digests: + type: array + items: + type: string + description: >- + List of subject digests associated with the artifact + attestations to delete. + minItems: 1 + maxItems: 1024 + attestation_ids: + type: array + items: + type: integer + description: >- + List of unique IDs associated with the artifact attestations + to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - attestation_ids + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-stackQL-resource: attestations + /users/{username}/attestations/digest/{subject_digest}: + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - users + operationId: users/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest + parameters: + - $ref: '#/components/parameters/username' + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-stackQL-resource: attestations + /users/{username}/attestations/{attestation_id}: + delete: + summary: Delete attestations by ID + description: >- + Delete an artifact attestation by unique ID that is associated with a + repository owned by a user. + tags: + - users + operationId: users/delete-attestations-by-id + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/attestations#delete-attestations-by-id + parameters: + - $ref: '#/components/parameters/username' + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-stackQL-resource: attestations + /users/{username}/attestations/{subject_digest}: + get: + summary: List attestations + description: >- + List a collection of artifact attestations with a given subject digest + that are associated with repositories owned by a user. + + + The collection of attestations returned by this endpoint is filtered + according to the authenticated user's permissions; if the authenticated + user cannot read a repository, the attestations associated with that + repository will not be included in the response. In addition, when using + a fine-grained access token the `attestations:read` permission is + required. + + + **Please note:** in order to offer meaningful security benefits, an + attestation's signature and timestamps **must** be cryptographically + verified, and the identity of the attestation signer **must** be + validated. Attestations can be verified using the [GitHub CLI + `attestation verify` + command](https://cli.github.com/manual/gh_attestation_verify). For more + information, see [our guide on how to use artifact attestations to + establish a build's + provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/username' + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: predicate_type + description: >- + Optional filter for fetching attestations with a given predicate + type. + + This option accepts `provenance`, `sbom`, `release`, or freeform + text + + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: >- + The attestation's Sigstore Bundle. + + Refer to the [Sigstore Bundle + Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) + for more information. + repository_id: + type: integer + bundle_url: + type: string + initiator: + type: string + examples: + default: + $ref: '#/components/examples/list-attestations' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /users/{username}/followers: + get: + summary: List followers of a user + description: Lists the people following the specified user. + tags: + - users + operationId: users/list-followers-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#list-followers-of-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: followers + x-stackQL-resource: followers + /users/{username}/following: + get: + summary: List the people a user follows + description: Lists the people who the specified user follows. + tags: + - users + operationId: users/list-following-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/followers#list-the-people-a-user-follows + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: followers + x-stackQL-resource: followers + /users/{username}/following/{target_user}: + get: + summary: Check if a user follows another user + description: '' + tags: + - users + operationId: users/check-following-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user + parameters: + - $ref: '#/components/parameters/username' + - name: target_user + in: path + required: true + schema: + type: string + responses: + '204': + description: if the user follows the target user + '404': + description: if the user does not follow the target user + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: followers + x-stackQL-resource: followers + /users/{username}/gpg_keys: + get: + summary: List GPG keys for a user + description: Lists the GPG keys for a user. This information is accessible by anyone. + tags: + - users + operationId: users/list-gpg-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + /users/{username}/hovercard: + get: + summary: Get contextual information for a user + description: >- + Provides hovercard information. You can find out more about someone in + relation to their pull requests, issues, repositories, and + organizations. + + The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + + OAuth app tokens and personal access tokens (classic) need the `repo` + scope to use this endpoint. + tags: + - users + operationId: users/get-context-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/users#get-contextual-information-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - name: subject_type + description: >- + Identifies which additional information you'd like to receive about + the person's hovercard. Can be `organization`, `repository`, + `issue`, `pull_request`. **Required** when using `subject_id`. + in: query + required: false + schema: + type: string + enum: + - organization + - repository + - issue + - pull_request + - name: subject_id + description: >- + Uses the ID for the `subject_type` you specified. **Required** when + using `subject_type`. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hovercard' + examples: + default: + $ref: '#/components/examples/hovercard' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: users + x-stackQL-resource: users + /users/{username}/keys: + get: + summary: List public keys for a user + description: >- + Lists the _verified_ public SSH keys for a user. This is accessible by + anyone. + tags: + - users + operationId: users/list-public-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/key-simple' + examples: + default: + $ref: '#/components/examples/key-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: keys + x-stackQL-resource: keys + /users/{username}/social_accounts: + get: + summary: List social accounts for a user + description: >- + Lists social media accounts for a user. This endpoint is accessible by + anyone. + tags: + - users + operationId: users/list-social-accounts-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/social-account' + examples: + default: + $ref: '#/components/examples/social-account-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + /users/{username}/ssh_signing_keys: + get: + summary: List SSH signing keys for a user + description: >- + Lists the SSH signing keys for a user. This operation is accessible by + anyone. + tags: + - users + operationId: users/list-ssh-signing-keys-for-user + externalDocs: + description: API method documentation + url: >- + https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys +components: + schemas: + private-user: + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + public-user: + title: Public User + description: Public User + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + user_view_type: + type: string + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + events_url: + type: string + received_events_url: + type: string + format: uri + type: + type: string + site_admin: + type: boolean + name: + type: string + nullable: true + company: + type: string + nullable: true + blog: + type: string + nullable: true + location: + type: string + nullable: true + email: + type: string + format: email + nullable: true + notification_email: + type: string + format: email + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + nullable: true + twitter_username: + type: string + nullable: true + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + private_gists: + type: integer + example: 1 + total_private_repos: + type: integer + example: 2 + owned_private_repos: + type: integer + example: 2 + disk_usage: + type: integer + example: 1 + collaborators: + type: integer + example: 3 + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + additionalProperties: false + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + example: octocat@github.com + primary: + type: boolean + example: true + verified: + type: boolean + example: true + visibility: + type: string + example: public + nullable: true + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + format: int64 + example: 3 + name: + type: string + example: Octocat's GPG Key + nullable: true + primary_key_id: + type: integer + nullable: true + key_id: + type: string + example: 3262EFF25BA0D270 + public_key: + type: string + example: xsBNBFayYZ... + emails: + type: array + example: + - email: octocat@users.noreply.github.com + verified: true + items: + type: object + properties: + email: + type: string + verified: + type: boolean + subkeys: + type: array + example: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: null + revoked: false + items: + type: object + properties: + id: + type: integer + format: int64 + primary_key_id: + type: integer + key_id: + type: string + public_key: + type: string + emails: + type: array + items: + type: object + properties: + email: + type: string + verified: + type: boolean + subkeys: + type: array + items: {} + can_sign: + type: boolean + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + created_at: + type: string + expires_at: + type: string + nullable: true + raw_key: + type: string + nullable: true + revoked: + type: boolean + can_sign: + type: boolean + example: true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + example: true + created_at: + type: string + format: date-time + example: '2016-03-24T11:31:04-06:00' + expires_at: + type: string + format: date-time + nullable: true + revoked: + type: boolean + example: true + raw_key: + type: string + nullable: true + required: + - id + - primary_key_id + - key_id + - raw_key + - public_key + - created_at + - expires_at + - can_sign + - can_encrypt_comms + - can_encrypt_storage + - can_certify + - emails + - subkeys + - revoked + key: + title: Key + description: Key + type: object + properties: + key: + type: string + id: + type: integer + format: int64 + url: + type: string + title: + type: string + created_at: + type: string + format: date-time + verified: + type: boolean + read_only: + type: boolean + last_used: + nullable: true + type: string + format: date-time + required: + - key + - id + - url + - title + - created_at + - verified + - read_only + social-account: + title: Social account + description: Social media account + type: object + properties: + provider: + type: string + example: linkedin + url: + type: string + example: https://www.linkedin.com/company/github/ + required: + - provider + - url + ssh-signing-key: + title: SSH Signing Key + description: A public SSH key used to sign Git commits + type: object + properties: + key: + type: string + id: + type: integer + title: + type: string + created_at: + type: string + format: date-time + required: + - key + - id + - title + - created_at + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + hovercard: + title: Hovercard + description: Hovercard + type: object + properties: + contexts: + type: array + items: + type: object + properties: + message: + type: string + octicon: + type: string + required: + - message + - octicon + required: + - contexts + key-simple: + title: Key Simple + description: Key Simple + type: object + properties: + id: + type: integer + key: + type: string + created_at: + type: string + format: date-time + last_used: + nullable: true + type: string + format: date-time + required: + - key + - id + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + per-page: + name: per_page + description: >- + The number of results per page (max 100). For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: >- + The page number of the results to fetch. For more information, see + "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + gpg-key-id: + name: gpg_key_id + description: The unique identifier of the GPG key. + in: path + required: true + schema: + type: integer + key-id: + name: key_id + description: The unique identifier of the key. + in: path + required: true + schema: + type: integer + ssh-signing-key-id: + name: ssh_signing_key_id + description: The unique identifier of the SSH signing key. + in: path + required: true + schema: + type: integer + account-id: + name: account_id + description: account_id parameter + in: path + required: true + schema: + type: integer + since-user: + name: since + description: A user ID. Only return users with an ID greater than this ID. + in: query + required: false + schema: + type: integer + pagination-before: + name: before + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results before this cursor. + For more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: >- + A cursor, as given in the [Link + header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for results after this cursor. For + more information, see "[Using pagination in the REST + API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + examples: + private-user-response-with-public-and-private-profile-information: + summary: Response with public and private profile information + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + private_gists: 81 + total_private_repos: 100 + owned_private_repos: 100 + disk_usage: 10000 + collaborators: 8 + two_factor_authentication: true + plan: + name: Medium + space: 400 + private_repos: 20 + collaborators: 0 + private-user-response-with-public-profile-information: + summary: Response with public profile information + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + private-user: + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + private_gists: 81 + total_private_repos: 100 + owned_private_repos: 100 + disk_usage: 10000 + collaborators: 8 + two_factor_authentication: true + plan: + name: Medium + space: 400 + private_repos: 20 + collaborators: 0 + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + email-items-3: + value: + - email: octocat@github.com + primary: true + verified: true + visibility: private + email-items-2: + value: + - email: octocat@github.com + verified: true + primary: true + visibility: public + email-items: + value: + - email: octocat@octocat.org + primary: false + verified: false + visibility: public + - email: octocat@github.com + primary: false + verified: false + visibility: null + - email: mona@github.com + primary: false + verified: false + visibility: null + gpg-key-items: + value: + - id: 3 + name: Octocat's GPG Key + primary_key_id: 2 + key_id: 3262EFF25BA0D270 + public_key: xsBNBFayYZ... + emails: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + can_sign: true + can_encrypt_comms: false + can_encrypt_storage: false + can_certify: true + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + raw_key: string + gpg-key: + value: + id: 3 + name: Octocat's GPG Key + primary_key_id: 2 + key_id: 3262EFF25BA0D270 + public_key: xsBNBFayYZ... + emails: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + can_sign: true + can_encrypt_comms: false + can_encrypt_storage: false + can_certify: true + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + raw_key: >- + "-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG + v2\n\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\nIts/HFYRLiFgDLmTlxo=\n=+OzK\n-----END + PGP PUBLIC KEY BLOCK-----" + key-items: + value: + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + verified: false + read_only: false + key: + value: + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + social-account-items: + value: + - provider: twitter + url: https://twitter.com/github + ssh-signing-key-items: + value: + - id: 2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + - id: 3 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + ssh-signing-key: + value: + id: 2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + public-user-default-response: + summary: Default response + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + public-user-response-with-git-hub-plan-information: + summary: Response with GitHub plan information + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + plan: + name: pro + space: 976562499 + collaborators: 0 + private_repos: 9999 + bulk-subject-digest-body: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + bulk-subject-digest-body-with-predicate-type: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + predicateType: provenance + list-attestations-bulk: + value: + attestations_subject_digests: + - sha256:abc: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: >- + MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: >- + rekor.sigstore.dev - + 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” + rekor.sigstore.dev + wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: >- + eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: >- + MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: >- + eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: >- + MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + hovercard: + value: + contexts: + - message: Owns this repository + octicon: repo + key-simple-items: + value: + - id: 1 + key: ssh-rsa AAA... + headers: + link: + example: >- + ; rel="next", + ; rel="last" + schema: + type: string + x-stackQL-resources: + users: + id: github.users.users + name: users + title: Users + methods: + get_authenticated: + operation: + $ref: '#/paths/~1user/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update_authenticated: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_id: + operation: + $ref: '#/paths/~1user~1{account_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_by_username: + operation: + $ref: '#/paths/~1users~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/users/methods/get_by_id' + - $ref: '#/components/x-stackQL-resources/users/methods/get_by_username' + - $ref: '#/components/x-stackQL-resources/users/methods/get_authenticated' + insert: [] + update: + - $ref: >- + #/components/x-stackQL-resources/users/methods/update_authenticated + delete: [] + replace: [] + blocking: + id: github.users.blocking + name: blocking + title: Blocking + methods: + list_blocked_by_authenticated_user: + operation: + $ref: '#/paths/~1user~1blocks/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_blocked: + operation: + $ref: '#/paths/~1user~1blocks~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + block: + operation: + $ref: '#/paths/~1user~1blocks~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unblock: + operation: + $ref: '#/paths/~1user~1blocks~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/blocking/methods/list_blocked_by_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + emails: + id: github.users.emails + name: emails + title: Emails + methods: + set_primary_email_visibility_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1email~1visibility/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + list_emails_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1emails/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_email_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1emails/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_email_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1emails/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/emails/methods/list_emails_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/emails/methods/add_email_for_authenticated_user + update: + - $ref: >- + #/components/x-stackQL-resources/emails/methods/set_primary_email_visibility_for_authenticated_user + delete: + - $ref: >- + #/components/x-stackQL-resources/emails/methods/delete_email_for_authenticated_user + replace: [] + followers: + id: github.users.followers + name: followers + title: Followers + methods: + list_followers_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1followers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + list_followers_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1followers/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/followers/methods/list_followers_for_user + - $ref: >- + #/components/x-stackQL-resources/followers/methods/list_followers_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + following: + id: github.users.following + name: following + title: Following + methods: + list_followed_by_authenticated_user: + operation: + $ref: '#/paths/~1user~1following/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_person_is_followed_by_authenticated: + operation: + $ref: '#/paths/~1user~1following~1{username}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + follow: + operation: + $ref: '#/paths/~1user~1following~1{username}/put' + response: + mediaType: application/json + openAPIDocKey: '204' + unfollow: + operation: + $ref: '#/paths/~1user~1following~1{username}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_following_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1following/get' + response: + mediaType: application/json + openAPIDocKey: '200' + check_following_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1following~1{target_user}/get' + response: + mediaType: application/json + openAPIDocKey: '204' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/following/methods/list_following_for_user + - $ref: >- + #/components/x-stackQL-resources/following/methods/list_followed_by_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + gpg_keys: + id: github.users.gpg_keys + name: gpg_keys + title: Gpg Keys + methods: + list_gpg_keys_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1gpg_keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_gpg_key_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1gpg_keys/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_gpg_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1gpg_keys~1{gpg_key_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_gpg_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1gpg_keys~1{gpg_key_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_gpg_keys_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1gpg_keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/gpg_keys/methods/get_gpg_key_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/gpg_keys/methods/list_gpg_keys_for_user + - $ref: >- + #/components/x-stackQL-resources/gpg_keys/methods/list_gpg_keys_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/gpg_keys/methods/create_gpg_key_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/gpg_keys/methods/delete_gpg_key_for_authenticated_user + replace: [] + keys: + id: github.users.keys + name: keys + title: Keys + methods: + list_public_ssh_keys_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_public_ssh_key_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1keys/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_public_ssh_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1keys~1{key_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_public_ssh_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1keys~1{key_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_public_keys_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/get_public_ssh_key_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/keys/methods/list_public_keys_for_user + - $ref: >- + #/components/x-stackQL-resources/keys/methods/list_public_ssh_keys_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/create_public_ssh_key_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/keys/methods/delete_public_ssh_key_for_authenticated_user + replace: [] + public_emails: + id: github.users.public_emails + name: public_emails + title: Public Emails + methods: + list_public_emails_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1public_emails/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/public_emails/methods/list_public_emails_for_authenticated_user + insert: [] + update: [] + delete: [] + replace: [] + social_accounts: + id: github.users.social_accounts + name: social_accounts + title: Social Accounts + methods: + list_social_accounts_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1social_accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + add_social_account_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1social_accounts/post' + response: + mediaType: application/json + openAPIDocKey: '201' + delete_social_account_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1social_accounts/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_social_accounts_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1social_accounts/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/social_accounts/methods/list_social_accounts_for_user + - $ref: >- + #/components/x-stackQL-resources/social_accounts/methods/list_social_accounts_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/social_accounts/methods/add_social_account_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/social_accounts/methods/delete_social_account_for_authenticated_user + replace: [] + ssh_signing_keys: + id: github.users.ssh_signing_keys + name: ssh_signing_keys + title: Ssh Signing Keys + methods: + list_ssh_signing_keys_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1ssh_signing_keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_ssh_signing_key_for_authenticated_user: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1user~1ssh_signing_keys/post' + response: + mediaType: application/json + openAPIDocKey: '201' + get_ssh_signing_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1ssh_signing_keys~1{ssh_signing_key_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + delete_ssh_signing_key_for_authenticated_user: + operation: + $ref: '#/paths/~1user~1ssh_signing_keys~1{ssh_signing_key_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '204' + list_ssh_signing_keys_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1ssh_signing_keys/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/ssh_signing_keys/methods/get_ssh_signing_key_for_authenticated_user + - $ref: >- + #/components/x-stackQL-resources/ssh_signing_keys/methods/list_ssh_signing_keys_for_user + - $ref: >- + #/components/x-stackQL-resources/ssh_signing_keys/methods/list_ssh_signing_keys_for_authenticated_user + insert: + - $ref: >- + #/components/x-stackQL-resources/ssh_signing_keys/methods/create_ssh_signing_key_for_authenticated_user + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/ssh_signing_keys/methods/delete_ssh_signing_key_for_authenticated_user + replace: [] + public_users: + id: github.users.public_users + name: public_users + title: Public Users + methods: + list: + operation: + $ref: '#/paths/~1users/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/public_users/methods/list' + insert: [] + update: [] + delete: [] + replace: [] + attestations_bulk_list: + id: github.users.attestations_bulk_list + name: attestations_bulk_list + title: Attestations Bulk List + methods: + list_attestations_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{username}~1attestations~1bulk-list/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: >- + #/components/x-stackQL-resources/attestations_bulk_list/methods/list_attestations_bulk + update: [] + delete: [] + replace: [] + attestations_bulk_deletes: + id: github.users.attestations_bulk_deletes + name: attestations_bulk_deletes + title: Attestations Bulk Deletes + methods: + delete_attestations_bulk: + config: + requestBodyTranslate: + algorithm: naive + operation: + $ref: '#/paths/~1users~1{username}~1attestations~1delete-request/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + replace: [] + attestations: + id: github.users.attestations + name: attestations + title: Attestations + methods: + delete_attestations_by_subject_digest: + operation: + $ref: >- + #/paths/~1users~1{username}~1attestations~1digest~1{subject_digest}/delete + response: + mediaType: application/json + openAPIDocKey: '200' + delete_attestations_by_id: + operation: + $ref: '#/paths/~1users~1{username}~1attestations~1{attestation_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + list_attestations: + operation: + $ref: '#/paths/~1users~1{username}~1attestations~1{subject_digest}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.attestations + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/list_attestations + insert: [] + update: [] + delete: + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/delete_attestations_by_subject_digest + - $ref: >- + #/components/x-stackQL-resources/attestations/methods/delete_attestations_by_id + replace: [] + hovercard: + id: github.users.hovercard + name: hovercard + title: Hovercard + methods: + get_context_for_user: + operation: + $ref: '#/paths/~1users~1{username}~1hovercard/get' + response: + mediaType: application/json + openAPIDocKey: '200' + objectKey: $.contexts + sqlVerbs: + select: + - $ref: >- + #/components/x-stackQL-resources/hovercard/methods/get_context_for_user + insert: [] + update: [] + delete: [] + replace: [] +servers: + - url: https://api.github.com diff --git a/provider-dev/source/.gitkeep b/provider-dev/source/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/provider-dev/source/actions.yaml b/provider-dev/source/actions.yaml new file mode 100644 index 0000000..1c33be3 --- /dev/null +++ b/provider-dev/source/actions.yaml @@ -0,0 +1,13475 @@ +openapi: 3.0.3 +info: + title: actions API + description: Endpoints to manage GitHub Actions using the REST API. + version: 1.1.4 +paths: + /enterprises/{enterprise}/actions/cache/retention-limit: + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-retention-limit-for-enterprise' + examples: + default: + $ref: '#/components/examples/actions-cache-retention-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-retention-limit-for-enterprise' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-retention-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /enterprises/{enterprise}/actions/cache/storage-limit: + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-enterprise' + examples: + default: + $ref: '#/components/examples/actions-cache-storage-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-enterprise' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-storage-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /organizations/{org}/actions/cache/retention-limit: + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-retention-limit-for-organization' + examples: + default: + $ref: '#/components/examples/actions-cache-retention-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-retention-limit-for-organization' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-retention-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /organizations/{org}/actions/cache/storage-limit: + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-organization' + examples: + default: + $ref: '#/components/examples/actions-cache-storage-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-organization' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-storage-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /orgs/{org}/actions/cache/usage: + get: + summary: Get GitHub Actions cache usage for an organization + description: |- + Gets the total GitHub Actions cache usage for an organization. + The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + + OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-usage-org-enterprise' + examples: + default: + $ref: '#/components/examples/actions-cache-usage-org-enterprise' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /orgs/{org}/actions/cache/usage-by-repository: + get: + summary: List repositories with GitHub Actions cache usage for an organization + description: |- + Lists repositories and their GitHub Actions cache usage for an organization. + The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + + OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-by-repo-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repository_cache_usages + properties: + total_count: + type: integer + repository_cache_usages: + type: array + items: + $ref: '#/components/schemas/actions-cache-usage-by-repository' + examples: + default: + $ref: '#/components/examples/org-actions-cache-usage-by-repo' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /orgs/{org}/actions/hosted-runners: + get: + summary: List GitHub-hosted runners for an organization + description: |- + Lists all GitHub-hosted runners configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-hosted-runners-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + post: + summary: Create a GitHub-hosted runner for an organization + description: |- + Creates a GitHub-hosted runner for an organization. + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/create-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + image: + description: The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. + type: object + properties: + id: + description: The unique identifier of the runner image. + type: string + source: + description: The source of the runner image. + type: string + enum: + - github + - partner + - custom + version: + description: The version of the runner image to deploy. This is relevant only for runners using custom images. + type: string + nullable: true + size: + description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. + type: integer + enable_static_ip: + description: Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` + type: boolean + image_gen: + description: Whether this runner should be used to generate custom images. + type: boolean + default: false + required: + - name + - image + - size + - runner_group_id + examples: + default: + value: + name: My Hosted runner + image: + id: ubuntu-latest + source: github + runner_group_id: 1 + size: 4-core + maximum_runners: 50 + enable_static_ip: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom: + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-custom-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-custom-image-versions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}: + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner-custom-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-custom-image' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions: + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - $ref: '#/components/parameters/actions-custom-image-definition-id' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-custom-image-version' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-custom-image-versions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}: + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + - $ref: '#/components/parameters/actions-custom-image-version' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner-custom-image-version' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-custom-image-version' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/actions-custom-image-definition-id' + - $ref: '#/components/parameters/actions-custom-image-version' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/github-owned: + get: + summary: Get GitHub-owned images for GitHub-hosted runners in an organization + description: Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + operationId: actions/get-hosted-runners-github-owned-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-curated-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-curated-image' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/images/partner: + get: + summary: Get partner images for GitHub-hosted runners in an organization + description: Get the list of partner images available for GitHub-hosted runners for an organization. + operationId: actions/get-hosted-runners-partner-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-curated-image' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-curated-image' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/limits: + get: + summary: Get limits on GitHub-hosted runners for an organization + description: Get the GitHub-hosted runners limits for an organization. + operationId: actions/get-hosted-runners-limits-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner-limits' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-limits-default' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/machine-sizes: + get: + summary: Get GitHub-hosted runners machine specs for an organization + description: Get the list of machine specs available for GitHub-hosted runners for an organization. + operationId: actions/get-hosted-runners-machine-specs-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machine_specs + properties: + total_count: + type: integer + machine_specs: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner-machine-spec' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-machine-spec' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/platforms: + get: + summary: Get platforms for GitHub-hosted runners in an organization + description: Get the list of platforms available for GitHub-hosted runners for an organization. + operationId: actions/get-hosted-runners-platforms-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - platforms + properties: + total_count: + type: integer + platforms: + type: array + items: + type: string + examples: + default: + value: + total_count: 1 + platforms: + - linux-x64 + - win-x64 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/hosted-runners/{hosted_runner_id}: + get: + summary: Get a GitHub-hosted runner for an organization + description: |- + Gets a GitHub-hosted runner configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hosted-runner-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + patch: + summary: Update a GitHub-hosted runner for an organization + description: |- + Updates a GitHub-hosted runner for an organization. + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/update-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hosted-runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. + type: integer + enable_static_ip: + description: Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` + type: boolean + size: + description: The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` + type: string + image_id: + description: The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`. + type: string + image_version: + description: The version of the runner image to deploy. This is relevant only for runners using custom images. + type: string + nullable: true + examples: + default: + value: + name: My larger runner + runner_group_id: 1 + maximum_runners: 50 + enable_static_ip: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + delete: + summary: Delete a GitHub-hosted runner for an organization + description: Deletes a GitHub-hosted runner for an organization. + operationId: actions/delete-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hosted-runner-id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners + x-stackQL-resource: hosted_runners + /orgs/{org}/actions/permissions: + get: + summary: Get GitHub Actions permissions for an organization + description: |- + Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/get-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-organization-permissions' + examples: + default: + $ref: '#/components/examples/actions-organization-permissions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set GitHub Actions permissions for an organization + description: |- + Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + $ref: '#/components/schemas/enabled-repositories' + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: all + allowed_actions: selected + sha_pinning_required: true + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/artifact-and-log-retention: + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-artifact-and-log-retention-response' + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-artifact-and-log-retention' + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/fork-pr-contributor-approval: + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-contributor-approval' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/fork-pr-workflows-private-repos: + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-workflows-private-repos' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-workflows-private-repos' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-workflows-private-repos-request' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-workflows-private-repos' + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/repositories: + get: + summary: List selected repositories enabled for GitHub Actions in an organization + description: |- + Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: number + repositories: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default: + $ref: '#/components/examples/repository-paginated' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set selected repositories enabled for GitHub Actions in an organization + description: |- + Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-selected-repositories-enabled-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 42 + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/repositories/{repository_id}: + put: + summary: Enable a selected repository for GitHub Actions in an organization + description: |- + Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/enable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + delete: + summary: Disable a selected repository for GitHub Actions in an organization + description: |- + Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/disable-selected-repository-github-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/selected-actions: + get: + summary: Get allowed actions and reusable workflows for an organization + description: |- + Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + default: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set allowed actions and reusable workflows for an organization + description: |- + Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + selected_actions: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/self-hosted-runners: + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/self-hosted-runners-settings' + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/self-hosted-runners/repositories: + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default: + $ref: '#/components/examples/repository-paginated' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}: + put: + summary: Add a repository to the list of repositories allowed to use self-hosted runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No content + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/permissions/workflow: + get: + summary: Get default workflow permissions for an organization + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, + as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-get-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set default workflow permissions for an organization + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions + can submit approving pull request reviews. For more information, see + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Success response + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/actions-set-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /orgs/{org}/actions/runner-groups: + get: + summary: List self-hosted runner groups for an organization + description: |- + Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runner-groups-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/visible-to-repository' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runner_groups + properties: + total_count: + type: number + runner_groups: + type: array + items: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-groups-org' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + post: + summary: Create a self-hosted runner group for an organization + description: |- + Creates a new self-hosted runner group for an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/create-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + type: string + enum: + - selected + - all + - private + default: all + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + allows_public_repositories: + description: Whether the runner group can be used by `public` repositories. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_repository_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-group' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}: + get: + summary: Get a self-hosted runner group for an organization + description: |- + Gets a specific self-hosted runner group for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/get-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-group-item' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + patch: + summary: Update a self-hosted runner group for an organization + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/update-self-hosted-runner-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner group. + type: string + visibility: + description: Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + type: string + enum: + - selected + - all + - private + allows_public_repositories: + description: Whether the runner group can be used by `public` repositories. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + nullable: true + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner-groups-org' + examples: + default: + $ref: '#/components/examples/runner-group' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + delete: + summary: Delete a self-hosted runner group from an organization + description: |- + Deletes a self-hosted runner group for an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/delete-self-hosted-runner-group-from-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners: + get: + summary: List GitHub-hosted runners in a group for an organization + description: |- + Lists the GitHub-hosted runners in an organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-github-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + $ref: '#/components/schemas/actions-hosted-runner' + examples: + default: + $ref: '#/components/examples/actions-hosted-runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories: + get: + summary: List repository access to a self-hosted runner group in an organization + description: |- + Lists the repositories with access to a self-hosted runner group configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: number + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-paginated' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + put: + summary: Set repository access for a self-hosted runner group in an organization + description: |- + Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs that can access the runner group. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}: + put: + summary: Add repository access to a self-hosted runner group in an organization + description: |- + Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/add-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + delete: + summary: Remove repository access to a self-hosted runner group in an organization + description: |- + Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/remove-repo-access-to-self-hosted-runner-group-in-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/runners: + get: + summary: List self-hosted runners in a group for an organization + description: |- + Lists self-hosted runners that are in a specific organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + put: + summary: Set self-hosted runners in a group for an organization + description: |- + Replaces the list of self-hosted runners that are part of an organization runner group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-self-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + runners: + description: List of runner IDs to add to the runner group. + type: array + items: + type: integer + description: Unique identifier of the runner. + required: + - runners + examples: + default: + value: + runners: + - 9 + - 2 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}: + put: + summary: Add a self-hosted runner to a group for an organization + description: |- + Adds a self-hosted runner to a runner group configured in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/add-self-hosted-runner-to-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + delete: + summary: Remove a self-hosted runner from a group for an organization + description: |- + Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/remove-self-hosted-runner-from-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-group-id' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups + x-stackQL-resource: self_hosted_runner_groups + /orgs/{org}/actions/runners: + get: + summary: List self-hosted runners for an organization + description: |- + Lists all self-hosted runners configured in an organization. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/downloads: + get: + summary: List runner applications for an organization + description: |- + Lists binaries for the runner application that you can download and run. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-runner-applications-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/runner-application' + examples: + default: + $ref: '#/components/examples/runner-application-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/generate-jitconfig: + post: + summary: Create configuration for a just-in-time runner for an organization + description: |- + Generates a configuration that can be passed to the runner application at startup. + + The authenticated user must have admin access to the organization. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - name + - runner_group_id + - labels + properties: + name: + type: string + description: The name of the new runner. + runner_group_id: + type: integer + description: The ID of the runner group to register the runner to. + labels: + type: array + minItems: 1 + maxItems: 100 + items: + type: string + description: 'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.' + work_folder: + type: string + description: The working directory to be used for job execution, relative to the runner install directory. + default: _work + examples: + default: + value: + name: New runner + runner_group_id: 1 + labels: + - self-hosted + - X64 + - macOS + - no-gpu + work_folder: _work + responses: + '201': + $ref: '#/components/responses/actions_runner_jitconfig' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/registration-token: + post: + summary: Create a registration token for an organization + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + + ``` + ./config.sh --url https://github.com/octo-org --token TOKEN + ``` + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-registration-token-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/remove-token: + post: + summary: Create a remove token for an organization + description: |- + 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. + + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + + ``` + ./config.sh remove --token TOKEN + ``` + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-remove-token-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/{runner_id}: + get: + summary: Get a self-hosted runner for an organization + description: |- + Gets a specific self-hosted runner configured in an organization. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/get-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Delete a self-hosted runner from an organization + description: |- + Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-self-hosted-runner-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/{runner_id}/labels: + get: + summary: List labels for a self-hosted runner for an organization + description: |- + Lists all labels for a self-hosted runner configured in an organization. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-labels-for-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + post: + summary: Add custom labels to a self-hosted runner for an organization + description: |- + Adds custom labels to a self-hosted runner configured in an organization. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - actions + operationId: actions/add-custom-labels-to-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 1 + maxItems: 100 + description: The names of the custom labels to add to the runner. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + put: + summary: Set custom labels for a self-hosted runner for an organization + description: |- + Remove all previous custom labels and set the new custom labels for a specific + self-hosted runner configured in an organization. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/set-custom-labels-for-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 0 + maxItems: 100 + description: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Remove all custom labels from a self-hosted runner for an organization + description: |- + Remove all custom labels from a self-hosted runner configured in an + organization. Returns the remaining read-only labels from the runner. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels_readonly' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/runners/{runner_id}/labels/{name}: + delete: + summary: Remove a custom label from a self-hosted runner for an organization + description: |- + Remove a custom label from a self-hosted runner configured + in an organization. Returns the remaining labels from the runner. + + This endpoint returns a `404 Not Found` status if the custom label is not + present on the runner. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-custom-label-from-self-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/runner-id' + - $ref: '#/components/parameters/runner-label-name' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /orgs/{org}/actions/secrets: + get: + summary: List organization secrets + description: |- + Lists all secrets available in an organization without revealing their + encrypted values. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-org-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-organization-secrets + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/organization-actions-secret' + examples: + default: + $ref: '#/components/examples/organization-actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/public-key: + get: + summary: Get an organization public key + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + The authenticated user must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-public-key' + examples: + default: + $ref: '#/components/examples/actions-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/{secret_name}: + get: + summary: Get an organization secret + description: |- + Gets a single organization secret without revealing its encrypted value. + + The authenticated user must have collaborator access to a repository to create, update, or read secrets + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-actions-secret' + examples: + default: + $ref: '#/components/examples/organization-actions-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update an organization secret + description: |- + Creates or updates an organization secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + visibility: + type: string + description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. + items: + type: integer + required: + - encrypted_value + - key_id + - visibility + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete an organization secret + description: |- + Deletes a secret in an organization using the secret name. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for an organization secret + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Set selected repositories for an organization secret + description: |- + Replaces all repositories for an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/set-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization secret + description: |- + Adds a repository to an organization secret when the `visibility` for + repository access is set to `selected`. For more information about setting the visibility, see [Create or + update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/add-selected-repo-to-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '409': + description: Conflict when visibility type is not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Remove selected repository from an organization secret + description: |- + Removes a repository from an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-selected-repo-from-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response when repository was removed from the selected list + '409': + description: Conflict when visibility type not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/actions/variables: + get: + summary: List organization variables + description: |- + Lists all organization variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-org-variables + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-organization-variables + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/organization-actions-variable' + examples: + default: + $ref: '#/components/examples/organization-actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + post: + summary: Create an organization variable + description: |- + Creates an organization variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#create-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + visibility: + type: string + description: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. + items: + type: integer + required: + - name + - value + - visibility + examples: + default: + value: + name: USERNAME + value: octocat + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a variable + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /orgs/{org}/actions/variables/{name}: + get: + summary: Get an organization variable + description: |- + Gets a specific variable in an organization. + + The authenticated user must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#get-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-actions-variable' + examples: + default: + $ref: '#/components/examples/organization-actions-variable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + patch: + summary: Update an organization variable + description: |- + Updates an organization variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/update-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#update-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + visibility: + type: string + description: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. + items: + type: integer + examples: + default: + value: + name: USERNAME + value: octocat + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Delete an organization variable + description: |- + Deletes an organization variable using the variable name. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /orgs/{org}/actions/variables/{name}/repositories: + get: + summary: List selected repositories for an organization variable + description: |- + Lists all repositories that can access an organization variable + that is available to selected repositories. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/list-selected-repos-for-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + '409': + description: Response when the visibility of the variable is not set to `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + put: + summary: Set selected repositories for an organization variable + description: |- + Replaces all repositories for an organization variable that is available + to selected repositories. Organization variables that are available to selected + repositories have their `visibility` field set to `selected`. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/set-selected-repos-for-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: The IDs of the repositories that can access the organization variable. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + '409': + description: Response when the visibility of the variable is not set to `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /orgs/{org}/actions/variables/{name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization variable + description: |- + Adds a repository to an organization variable that is available to selected repositories. + Organization variables that are available to selected repositories have their `visibility` field set to `selected`. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/add-selected-repo-to-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '409': + description: Response when the visibility of the variable is not set to `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Remove selected repository from an organization variable + description: |- + Removes a repository from an organization variable that is + available to selected repositories. Organization variables that are available to + selected repositories have their `visibility` field set to `selected`. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + tags: + - actions + operationId: actions/remove-selected-repo-from-org-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/variable-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '409': + description: Response when the visibility of the variable is not set to `selected` + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/artifacts: + get: + summary: List artifacts for a repository + description: |- + Lists all artifacts for a repository. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-artifacts-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/artifact-name' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - artifacts + properties: + total_count: + type: integer + artifacts: + type: array + items: + $ref: '#/components/schemas/artifact' + examples: + default: + $ref: '#/components/examples/artifact-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/artifacts/{artifact_id}: + get: + summary: Get an artifact + description: |- + Gets a specific artifact for a workflow run. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-artifact + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#get-an-artifact + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/artifact-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/artifact' + examples: + default: + $ref: '#/components/examples/artifact' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + delete: + summary: Delete an artifact + description: |- + Deletes an artifact for a workflow run. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-artifact + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/artifact-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}: + get: + summary: Download an artifact + description: |- + Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in + the response header to find the URL for the download. The `:archive_format` must be `zip`. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-artifact + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#download-an-artifact + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/artifact-id' + - name: archive_format + in: path + required: true + schema: + type: string + responses: + '302': + description: Response + headers: + Location: + $ref: '#/components/headers/location' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/cache/retention-limit: + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-retention-limit-for-repository' + examples: + default: + $ref: '#/components/examples/actions-cache-retention-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-retention-limit-for-repository' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-retention-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/cache/storage-limit: + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-repository' + examples: + default: + $ref: '#/components/examples/actions-cache-storage-limit' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-storage-limit-for-repository' + examples: + selected_actions: + $ref: '#/components/examples/actions-cache-storage-limit' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/cache/usage: + get: + summary: Get GitHub Actions cache usage for a repository + description: |- + Gets GitHub Actions cache usage for a repository. + The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-usage-by-repository' + examples: + default: + $ref: '#/components/examples/actions-cache-usage' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/caches: + get: + summary: List GitHub Actions caches for a repository + description: |- + Lists the GitHub Actions caches for a repository. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/actions-cache-git-ref-full' + - $ref: '#/components/parameters/actions-cache-key' + - $ref: '#/components/parameters/actions-cache-list-sort' + - $ref: '#/components/parameters/direction' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-list' + examples: + default: + $ref: '#/components/examples/actions-cache-list' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: cache + x-stackQL-resource: cache + delete: + summary: Delete GitHub Actions caches for a repository (using a cache key) + description: |- + Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-actions-cache-by-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/actions-cache-key-required' + - $ref: '#/components/parameters/actions-cache-git-ref-full' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-cache-list' + examples: + default: + $ref: '#/components/examples/actions-cache-list' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/caches/{cache_id}: + delete: + summary: Delete a GitHub Actions cache for a repository (using a cache ID) + description: |- + Deletes a GitHub Actions cache for a repository, using a cache ID. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-actions-cache-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/cache-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + x-stackQL-resource: cache + /repos/{owner}/{repo}/actions/jobs/{job_id}: + get: + summary: Get a job for a workflow run + description: |- + Gets a specific job in a workflow run. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-job-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/job-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/job' + examples: + default: + $ref: '#/components/examples/job' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/jobs/{job_id}/logs: + get: + summary: Download job logs for a workflow run + description: |- + Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look + for `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-job-logs-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/job-id' + responses: + '302': + description: Response + headers: + Location: + example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun: + post: + summary: Re-run a job from a workflow run + description: |- + Re-run a job and its dependent jobs in a workflow run. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/re-run-job-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/job-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + enable_debug_logging: + type: boolean + default: false + description: Whether to enable debug logging for the re-run. + examples: + default: + value: null + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/oidc/customization/sub: + get: + summary: Get the customization template for an OIDC subject claim for a repository + description: |- + Gets the customization template for an OpenID Connect (OIDC) subject claim. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-oidc-sub-claim-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Status response + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-sub-repo' + examples: + default: + $ref: '#/components/examples/oidc-custom-sub-repo' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: oidc + x-stackQL-resource: oidc + put: + summary: Set the customization template for an OIDC subject claim for a repository + description: |- + Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-custom-oidc-sub-claim-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + title: Actions OIDC subject customization for a repository + description: Actions OIDC subject customization for a repository + type: object + required: + - use_default + properties: + use_default: + description: Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. + type: boolean + include_claim_keys: + description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. + type: array + items: + type: string + examples: + default: + value: + use_default: false + include_claim_keys: + - repo + - context + responses: + '201': + description: Empty response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /repos/{owner}/{repo}/actions/organization-secrets: + get: + summary: List repository organization secrets + description: |- + Lists all organization secrets shared with a repository without revealing their encrypted + values. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-organization-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/organization-variables: + get: + summary: List repository organization variables + description: |- + Lists all organization variables shared with a repository. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-organization-variables + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/permissions: + get: + summary: Get GitHub Actions permissions for a repository + description: |- + Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-repository-permissions' + examples: + default: + $ref: '#/components/examples/actions-repository-permissions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set GitHub Actions permissions for a repository + description: |- + Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled: + $ref: '#/components/schemas/actions-enabled' + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled + examples: + default: + value: + enabled: true + allowed_actions: selected + sha_pinning_required: true + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/access: + get: + summary: Get the level of access for workflows outside of the repository + description: |- + Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. + This endpoint only applies to private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-workflow-access-to-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-workflow-access-to-repository' + examples: + default: + $ref: '#/components/examples/actions-workflow-access-to-repository' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set the level of access for workflows outside of the repository + description: |- + Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. + This endpoint only applies to private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-workflow-access-to-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-workflow-access-to-repository' + examples: + default: + $ref: '#/components/examples/actions-workflow-access-to-repository' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention: + get: + summary: Get artifact and log retention settings for a repository + description: |- + Gets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-artifact-and-log-retention-response' + examples: + default: + value: + days: 90 + maximum_allowed_days: 365 + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set artifact and log retention settings for a repository + description: |- + Sets artifact and log retention settings for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Empty response for successful settings update + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-artifact-and-log-retention' + examples: + default: + summary: Set retention days + value: + days: 90 + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval: + get: + summary: Get fork PR contributor approval permissions for a repository + description: |- + Gets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-contributor-approval' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set fork PR contributor approval permissions for a repository + description: |- + Sets the fork PR contributor approval policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-contributor-approval' + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos: + get: + summary: Get private repo fork PR workflow settings for a repository + description: |- + Gets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-workflows-private-repos' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-workflows-private-repos' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set private repo fork PR workflow settings for a repository + description: |- + Sets the settings for whether workflows from fork pull requests can run on a private repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-fork-pr-workflows-private-repos-request' + examples: + default: + $ref: '#/components/examples/actions-fork-pr-workflows-private-repos' + responses: + '204': + description: Empty response for successful settings update + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/selected-actions: + get: + summary: Get allowed actions and reusable workflows for a repository + description: |- + Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + default: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set allowed actions and reusable workflows for a repository + description: |- + Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/selected-actions' + examples: + selected_actions: + $ref: '#/components/examples/selected-actions' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/permissions/workflow: + get: + summary: Get default workflow permissions for a repository + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, + as well as if GitHub Actions can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-get-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + put: + summary: Set default workflow permissions for a repository + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions + can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Success response + '409': + description: Conflict response when changing a setting is prevented by the owning organization + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/actions-set-default-workflow-permissions' + examples: + default: + $ref: '#/components/examples/actions-default-workflow-permissions' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + x-stackQL-resource: permissions + /repos/{owner}/{repo}/actions/runners: + get: + summary: List self-hosted runners for a repository + description: |- + Lists all self-hosted runners configured in a repository. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/downloads: + get: + summary: List runner applications for a repository + description: |- + Lists binaries for the runner application that you can download and run. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-runner-applications-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/runner-application' + examples: + default: + $ref: '#/components/examples/runner-application-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/generate-jitconfig: + post: + summary: Create configuration for a just-in-time runner for a repository + description: |- + Generates a configuration that can be passed to the runner application at startup. + + The authenticated user must have admin access to the repository. + + OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - name + - runner_group_id + - labels + properties: + name: + type: string + description: The name of the new runner. + runner_group_id: + type: integer + description: The ID of the runner group to register the runner to. + labels: + type: array + minItems: 1 + maxItems: 100 + items: + type: string + description: 'The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.' + work_folder: + type: string + description: The working directory to be used for job execution, relative to the runner install directory. + default: _work + examples: + default: + value: + name: New runner + runner_group_id: 1 + labels: + - self-hosted + - X64 + - macOS + - no-gpu + work_folder: _work + responses: + '201': + $ref: '#/components/responses/actions_runner_jitconfig' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/registration-token: + post: + summary: Create a registration token for a repository + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + + ``` + ./config.sh --url https://github.com/octo-org --token TOKEN + ``` + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-registration-token-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/remove-token: + post: + summary: Create a remove token for a repository + description: |- + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. + + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + + ``` + ./config.sh remove --token TOKEN + ``` + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-remove-token-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authentication-token' + examples: + default: + $ref: '#/components/examples/authentication-token-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/{runner_id}: + get: + summary: Get a self-hosted runner for a repository + description: |- + Gets a specific self-hosted runner configured in a repository. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/runner' + examples: + default: + $ref: '#/components/examples/runner' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Delete a self-hosted runner from a repository + description: |- + Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-self-hosted-runner-from-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/{runner_id}/labels: + get: + summary: List labels for a self-hosted runner for a repository + description: |- + Lists all labels for a self-hosted runner configured in a repository. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-labels-for-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + post: + summary: Add custom labels to a self-hosted runner for a repository + description: |- + Adds custom labels to a self-hosted runner configured in a repository. + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 1 + maxItems: 100 + description: The names of the custom labels to add to the runner. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + put: + summary: Set custom labels for a self-hosted runner for a repository + description: |- + Remove all previous custom labels and set the new custom labels for a specific + self-hosted runner configured in a repository. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - labels + properties: + labels: + type: array + minItems: 0 + maxItems: 100 + description: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. + items: + type: string + examples: + default: + value: + labels: + - gpu + - accelerated + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + delete: + summary: Remove all custom labels from a self-hosted runner for a repository + description: |- + Remove all custom labels from a self-hosted runner configured in a + repository. Returns the remaining read-only labels from the runner. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels_readonly' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}: + delete: + summary: Remove a custom label from a self-hosted runner for a repository + description: |- + Remove a custom label from a self-hosted runner configured + in a repository. Returns the remaining labels from the runner. + + This endpoint returns a `404 Not Found` status if the custom label is not + present on the runner. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/runner-id' + - $ref: '#/components/parameters/runner-label-name' + responses: + '200': + $ref: '#/components/responses/actions_runner_labels' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + x-stackQL-resource: self_hosted_runners + /repos/{owner}/{repo}/actions/runs: + get: + summary: List workflow runs for a repository + description: |- + Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + + This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + tags: + - actions + operationId: actions/list-workflow-runs-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/actor' + - $ref: '#/components/parameters/workflow-run-branch' + - $ref: '#/components/parameters/event' + - $ref: '#/components/parameters/workflow-run-status' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/created' + - $ref: '#/components/parameters/exclude-pull-requests' + - $ref: '#/components/parameters/workflow-run-check-suite-id' + - $ref: '#/components/parameters/workflow-run-head-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - workflow_runs + properties: + total_count: + type: integer + workflow_runs: + type: array + items: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}: + get: + summary: Get a workflow run + description: |- + Gets a specific workflow run. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/exclude-pull-requests' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + delete: + summary: Delete a workflow run + description: |- + Deletes a specific workflow run. + + Anyone with write access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/delete-workflow-run + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/approvals: + get: + summary: Get the review history for a workflow run + description: |- + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-reviews-for-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/environment-approvals' + examples: + default: + $ref: '#/components/examples/environment-approvals-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/approve: + post: + summary: Approve a workflow run for a fork pull request + description: |- + Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/approve-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts: + get: + summary: List workflow run artifacts + description: |- + Lists artifacts for a workflow run. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-workflow-run-artifacts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/artifact-name' + - $ref: '#/components/parameters/direction' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - artifacts + properties: + total_count: + type: integer + artifacts: + type: array + items: + $ref: '#/components/schemas/artifact' + examples: + default: + $ref: '#/components/examples/artifact-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: artifacts + x-stackQL-resource: artifacts + /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}: + get: + summary: Get a workflow run attempt + description: |- + Gets a specific workflow run attempt. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-run-attempt + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/attempt-number' + - $ref: '#/components/parameters/exclude-pull-requests' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs: + get: + summary: List jobs for a workflow run attempt + description: |- + Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-jobs-for-workflow-run-attempt + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/attempt-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - jobs + properties: + total_count: + type: integer + jobs: + type: array + items: + $ref: '#/components/schemas/job' + examples: + default: + $ref: '#/components/examples/job-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs: + get: + summary: Download workflow run attempt logs + description: |- + Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after + 1 minute. Look for `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-workflow-run-attempt-logs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - $ref: '#/components/parameters/attempt-number' + responses: + '302': + description: Response + headers: + Location: + example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/cancel: + post: + summary: Cancel a workflow run + description: |- + Cancels a workflow run using its `id`. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/cancel-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule: + post: + summary: Review custom deployment protection rules for a workflow run + description: |- + Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + > [!NOTE] + > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/review-custom-gates-for-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + environment_name: + type: string + description: The name of the environment to approve or reject. + comment: + type: string + description: Comment associated with the pending deployment protection rule. **Required when state is not provided.** + state: + type: string + description: Whether to approve or reject deployment to the specified environments. + enum: + - approved + - rejected + required: + - environment_name + - comment + - state + examples: + default: + value: + environment_name: prod-eus + state: approved + comment: All health checks passed. + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel: + post: + summary: Force cancel a workflow run + description: |- + Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/force-cancel-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/jobs: + get: + summary: List jobs for a workflow run + description: |- + Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-jobs-for-workflow-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + - name: filter + description: Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. + in: query + required: false + schema: + type: string + enum: + - latest + - all + default: latest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - jobs + properties: + total_count: + type: integer + jobs: + type: array + items: + $ref: '#/components/schemas/job' + examples: + default: + $ref: '#/components/examples/job-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-jobs + x-stackQL-resource: workflow_jobs + /repos/{owner}/{repo}/actions/runs/{run_id}/logs: + get: + summary: Download workflow run logs + description: |- + Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for + `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/download-workflow-run-logs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '302': + description: Response + headers: + Location: + example: https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + delete: + summary: Delete workflow run logs + description: |- + Deletes all logs for a workflow run. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-workflow-run-logs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments: + get: + summary: Get pending deployments for a workflow run + description: |- + Get all deployment environments for a workflow run that are waiting for protection rules to pass. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-pending-deployments-for-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pending-deployment' + examples: + default: + $ref: '#/components/examples/pending-deployment-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + post: + summary: Review pending deployments for a workflow run + description: |- + Approve or reject pending deployments that are waiting on approval by a required reviewer. + + Required reviewers with read access to the repository contents and deployments can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/review-pending-deployments-for-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + environment_ids: + type: array + description: The list of environment ids to approve or reject + example: + - 161171787 + - 161171795 + items: + type: integer + example: 161171787 + state: + type: string + description: Whether to approve or reject deployment to the specified environments. + enum: + - approved + - rejected + example: approved + comment: + type: string + description: A comment to accompany the deployment review + example: Ship it! + required: + - environment_ids + - state + - comment + examples: + default: + value: + environment_ids: + - 161171787 + state: approved + comment: Ship it! + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deployment' + examples: + default: + $ref: '#/components/examples/deployment-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/rerun: + post: + summary: Re-run a workflow + description: |- + Re-runs your workflow run using its `id`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/re-run-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + enable_debug_logging: + type: boolean + default: false + description: Whether to enable debug logging for the re-run. + examples: + default: + value: null + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs: + post: + summary: Re-run failed jobs from a workflow run + description: |- + Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/re-run-workflow-failed-jobs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + enable_debug_logging: + type: boolean + default: false + description: Whether to enable debug logging for the re-run. + examples: + default: + value: null + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/runs/{run_id}/timing: + get: + summary: Get workflow run usage + description: |- + > [!WARNING] + > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + + Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-run-usage + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-run-usage' + examples: + default: + $ref: '#/components/examples/workflow-run-usage' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/secrets: + get: + summary: List repository secrets + description: |- + Lists all secrets available in a repository without revealing their encrypted + values. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-repository-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/secrets/public-key: + get: + summary: Get a repository public key + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-repo-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-public-key' + examples: + default: + $ref: '#/components/examples/actions-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/secrets/{secret_name}: + get: + summary: Get a repository secret + description: |- + Gets a single repository secret without revealing its encrypted value. + + The authenticated user must have collaborator access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update a repository secret + description: |- + Creates or updates a repository secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete a repository secret + description: |- + Deletes a secret in a repository using the secret name. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/actions/variables: + get: + summary: List repository variables + description: |- + Lists all repository variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-repo-variables + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-repository-variables + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + post: + summary: Create a repository variable + description: |- + Creates a repository variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-repo-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#create-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + required: + - name + - value + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/variables/{name}: + get: + summary: Get a repository variable + description: |- + Gets a specific variable in a repository. + + The authenticated user must have collaborator access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-repo-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#get-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + patch: + summary: Update a repository variable + description: |- + Updates a repository variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/update-repo-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#update-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Delete a repository variable + description: |- + Deletes a repository variable using the variable name. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-repo-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/actions/workflows: + get: + summary: List repository workflows + description: |- + Lists the workflows in a repository. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/list-repo-workflows + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#list-repository-workflows + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - workflows + properties: + total_count: + type: integer + workflows: + type: array + items: + $ref: '#/components/schemas/workflow' + examples: + default: + $ref: '#/components/examples/workflow-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}: + get: + summary: Get a workflow + description: |- + Gets a specific workflow. You can replace `workflow_id` with the workflow + file name. For example, you could use `main.yaml`. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#get-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow' + examples: + default: + $ref: '#/components/examples/workflow' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable: + put: + summary: Disable a workflow + description: |- + Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/disable-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#disable-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches: + post: + summary: Create a workflow dispatch event + description: |- + You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/create-workflow-dispatch + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '200': + description: Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-dispatch-response' + examples: + default: + $ref: '#/components/examples/workflow-dispatch-response' + '204': + description: Empty response when `return_run_details` parameter is `false`. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ref: + type: string + description: The git reference for the workflow. The reference can be a branch or tag name. + inputs: + type: object + description: Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. + additionalProperties: true + maxProperties: 25 + return_run_details: + type: boolean + description: Whether the response should include the workflow run ID and URLs. + required: + - ref + examples: + default: + value: + ref: topic-branch + inputs: + name: Mona the Octocat + home: San Francisco, CA + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-github-breaking-changes: + - changeset: change_workflow_dispatch_response_status + patch: + - op: remove + path: /responses/204 + - op: remove + path: /requestBody/content/application~1json/schema/properties/return_run_details + version: '2026-03-10' + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable: + put: + summary: Enable a workflow + description: |- + Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/enable-workflow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#enable-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs: + get: + summary: List workflow runs for a workflow + description: |- + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + Anyone with read access to the repository can use this endpoint + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + + This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + tags: + - actions + operationId: actions/list-workflow-runs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + - $ref: '#/components/parameters/actor' + - $ref: '#/components/parameters/workflow-run-branch' + - $ref: '#/components/parameters/event' + - $ref: '#/components/parameters/workflow-run-status' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/created' + - $ref: '#/components/parameters/exclude-pull-requests' + - $ref: '#/components/parameters/workflow-run-check-suite-id' + - $ref: '#/components/parameters/workflow-run-head-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - workflow_runs + properties: + total_count: + type: integer + workflow_runs: + type: array + items: + $ref: '#/components/schemas/workflow-run' + examples: + default: + $ref: '#/components/examples/workflow-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: workflow-runs + x-stackQL-resource: workflow_runs + /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing: + get: + summary: Get workflow usage + description: |- + > [!WARNING] + > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + + Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + + You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - actions + operationId: actions/get-workflow-usage + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/workflows#get-workflow-usage + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/workflow-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/workflow-usage' + examples: + default: + $ref: '#/components/examples/workflow-usage' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: workflows + x-stackQL-resource: workflows + /repos/{owner}/{repo}/environments/{environment_name}/secrets: + get: + summary: List environment secrets + description: |- + Lists all secrets available in an environment without revealing their + encrypted values. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-environment-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key: + get: + summary: Get an environment public key + description: |- + Get the public key for an environment, which you need to encrypt environment + secrets. You need to encrypt a secret before you can create or update secrets. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-public-key' + examples: + default: + $ref: '#/components/examples/actions-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}: + get: + summary: Get an environment secret + description: |- + Gets a single environment secret without revealing its encrypted value. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-secret' + examples: + default: + $ref: '#/components/examples/actions-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update an environment secret + description: |- + Creates or updates an environment secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete an environment secret + description: |- + Deletes a secret in an environment using the secret name. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Default response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/environments/{environment_name}/variables: + get: + summary: List environment variables + description: |- + Lists all environment variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-variables + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-environment-variables + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/variables-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variables-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + post: + summary: Create an environment variable + description: |- + Create an environment variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#create-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + required: + - name + - value + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + /repos/{owner}/{repo}/environments/{environment_name}/variables/{name}: + get: + summary: Get an environment variable + description: |- + Gets a specific variable in an environment. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#get-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/variable-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/actions-variable' + examples: + default: + $ref: '#/components/examples/actions-variable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + patch: + summary: Update an environment variable + description: |- + Updates an environment variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/update-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#update-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables + delete: + summary: Delete an environment variable + description: |- + Deletes an environment variable using the variable name. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/variable-name' + - $ref: '#/components/parameters/environment-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + x-stackQL-resource: variables +components: + schemas: + actions-cache-retention-limit-for-enterprise: + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + type: integer + example: 14 + actions-cache-storage-limit-for-enterprise: + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + type: integer + example: 10 + actions-cache-retention-limit-for-organization: + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + type: integer + example: 14 + actions-cache-storage-limit-for-organization: + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + type: integer + example: 10 + actions-cache-usage-org-enterprise: + type: object + properties: + total_active_caches_count: + type: integer + description: The count of active caches across all repositories of an enterprise or an organization. + total_active_caches_size_in_bytes: + type: integer + description: The total size in bytes of all active cache items across all repositories of an enterprise or an organization. + required: + - total_active_caches_count + - total_active_caches_size_in_bytes + actions-cache-usage-by-repository: + title: Actions Cache Usage by repository + description: GitHub Actions Cache Usage by repository. + type: object + properties: + full_name: + description: The repository owner and name for the cache usage being shown. + type: string + example: octo-org/Hello-World + active_caches_size_in_bytes: + description: The sum of the size in bytes of all the active cache items in the repository. + type: integer + example: 2322142 + active_caches_count: + description: The number of active caches in the repository. + type: integer + example: 3 + required: + - full_name + - active_caches_size_in_bytes + - active_caches_count + actions-hosted-runner: + title: GitHub-hosted hosted runner + description: A Github-hosted hosted runner. + type: object + properties: + id: + description: The unique identifier of the hosted runner. + type: integer + example: 5 + name: + description: The name of the hosted runner. + type: string + example: my-github-hosted-runner + runner_group_id: + description: The unique identifier of the group that the hosted runner belongs to. + type: integer + example: 2 + image_details: + $ref: '#/components/schemas/nullable-actions-hosted-runner-pool-image' + machine_size_details: + $ref: '#/components/schemas/actions-hosted-runner-machine-spec' + status: + description: The status of the runner. + type: string + example: Ready + enum: + - Ready + - Provisioning + - Shutdown + - Deleting + - Stuck + platform: + description: The operating system of the image. + type: string + example: linux-x64 + maximum_runners: + description: The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + type: integer + default: 10 + example: 5 + public_ip_enabled: + description: Whether public IP is enabled for the hosted runners. + type: boolean + example: true + public_ips: + description: The public IP ranges when public IP is enabled for the hosted runners. + type: array + items: + $ref: '#/components/schemas/public-ip' + last_active_on: + description: The time at which the runner was last used, in ISO 8601 format. + type: string + format: date-time + example: '2022-10-09T23:39:01Z' + nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. + required: + - id + - name + - image_details + - machine_size_details + - status + - public_ip_enabled + - platform + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + actions-hosted-runner-curated-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + type: string + example: ubuntu-20.04 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + required: + - id + - platform + - size_gb + - display_name + - source + actions-hosted-runner-limits: + type: object + properties: + public_ips: + title: Static public IP Limits for GitHub-hosted Hosted Runners. + description: Provides details of static public IP limits for GitHub-hosted Hosted Runners + type: object + properties: + maximum: + type: integer + description: The maximum number of static public IP addresses that can be used for Hosted Runners. + example: 50 + current_usage: + type: integer + description: The current number of static public IP addresses in use by Hosted Runners. + example: 17 + required: + - maximum + - current_usage + required: + - public_ips + actions-hosted-runner-machine-spec: + title: Github-owned VM details. + description: Provides details of a particular machine spec. + type: object + properties: + id: + description: The ID used for the `size` parameter when creating a new runner. + type: string + example: 8-core + cpu_cores: + description: The number of cores. + type: integer + example: 8 + memory_gb: + description: The available RAM for the machine spec. + type: integer + example: 32 + storage_gb: + description: The available SSD storage for the machine spec. + type: integer + example: 300 + required: + - id + - cpu_cores + - memory_gb + - storage_gb + actions-organization-permissions: + type: object + properties: + enabled_repositories: + $ref: '#/components/schemas/enabled-repositories' + selected_repositories_url: + type: string + description: The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + selected_actions_url: + $ref: '#/components/schemas/selected-actions-url' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled_repositories + enabled-repositories: + type: string + description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. + enum: + - all + - none + - selected + allowed-actions: + type: string + description: The permissions policy that controls the actions and reusable workflows that are allowed to run. + enum: + - all + - local_only + - selected + sha-pinning-required: + type: boolean + description: Whether actions must be pinned to a full-length commit SHA. + actions-artifact-and-log-retention-response: + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + actions-artifact-and-log-retention: + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + actions-fork-pr-contributor-approval: + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require approval from a maintainer. + required: + - approval_policy + actions-fork-pr-workflows-private-repos: + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. + actions-fork-pr-workflows-private-repos-request: + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + selected-actions: + type: object + properties: + github_owned_allowed: + type: boolean + description: Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. + verified_allowed: + type: boolean + description: Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. + patterns_allowed: + type: array + description: |- + Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. + + > [!NOTE] + > The `patterns_allowed` setting only applies to public repositories. + items: + type: string + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories for self-hosted runners in the organization + actions-get-default-workflow-permissions: + type: object + properties: + default_workflow_permissions: + $ref: '#/components/schemas/actions-default-workflow-permissions' + can_approve_pull_request_reviews: + $ref: '#/components/schemas/actions-can-approve-pull-request-reviews' + required: + - default_workflow_permissions + - can_approve_pull_request_reviews + actions-set-default-workflow-permissions: + type: object + properties: + default_workflow_permissions: + $ref: '#/components/schemas/actions-default-workflow-permissions' + can_approve_pull_request_reviews: + $ref: '#/components/schemas/actions-can-approve-pull-request-reviews' + runner-groups-org: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_repositories_url: + description: Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` + type: string + runners_url: + type: string + hosted_runners_url: + type: string + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + inherited: + type: boolean + inherited_allows_public_repositories: + type: boolean + allows_public_repositories: + type: boolean + workflow_restrictions_read_only: + description: If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + type: boolean + default: false + restricted_to_workflows: + description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. + type: boolean + default: false + selected_workflows: + description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. + type: array + items: + type: string + description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. + example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + runner: + title: Self hosted runners + description: A self hosted runner + type: object + properties: + id: + description: The ID of the runner. + type: integer + example: 5 + runner_group_id: + description: The ID of the runner group. + type: integer + example: 1 + name: + description: The name of the runner. + type: string + example: iMac + os: + description: The Operating System of the runner. + type: string + example: macos + status: + description: The status of the runner. + type: string + example: online + busy: + type: boolean + labels: + type: array + items: + $ref: '#/components/schemas/runner-label' + ephemeral: + type: boolean + required: + - id + - name + - os + - status + - busy + - labels + runner-application: + title: Runner Application + description: Runner Application + type: object + properties: + os: + type: string + architecture: + type: string + download_url: + type: string + filename: + type: string + temp_download_token: + description: A short lived bearer token used to download the runner, if needed. + type: string + sha256_checksum: + type: string + required: + - os + - architecture + - download_url + - filename + authentication-token: + title: Authentication Token + description: Authentication Token + type: object + properties: + token: + description: The token used for authentication + type: string + example: v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + example: '2016-07-11T22:14:10Z' + permissions: + type: string + example: + issues: read + deployments: write + description: (opaque JSON object) + repositories: + description: The repositories this token has access to + type: array + items: + $ref: '#/components/schemas/repository' + single_file: + type: string + example: config.yaml + nullable: true + repository_selection: + description: Describe whether all repositories have been selected or there's a selection involved + type: string + enum: + - all + - selected + required: + - token + - expires_at + organization-actions-secret: + title: Actions Secret for an Organization + description: Secrets for GitHub Actions for an organization. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + visibility: + description: Visibility of a secret + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/org/secrets/my_secret/repositories + required: + - name + - created_at + - updated_at + - visibility + actions-public-key: + title: ActionsPublicKey + description: The public key used for setting Actions Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + example: 2 + url: + type: string + example: https://api.github.com/user/keys/2 + title: + type: string + example: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + example: '2011-01-26T19:01:12Z' + required: + - key_id + - key + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + organization-actions-variable: + title: Actions Variable for an Organization + description: Organization variable for GitHub Actions. + type: object + properties: + name: + description: The name of the variable. + example: USERNAME + type: string + value: + description: The value of the variable. + example: octocat + type: string + created_at: + description: The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + example: '2019-01-24T22:45:36.000Z' + type: string + format: date-time + updated_at: + description: The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + example: '2019-01-24T22:45:36.000Z' + type: string + format: date-time + visibility: + description: Visibility of a variable + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/org/variables/USERNAME/repositories + required: + - name + - value + - created_at + - updated_at + - visibility + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + example: 5 + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + example: AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + example: 12345 + url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip + expired: + description: Whether or not the artifact has expired. + type: boolean + created_at: + type: string + format: date-time + nullable: true + expires_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + digest: + type: string + description: The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + nullable: true + example: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + type: object + nullable: true + properties: + id: + example: 10 + type: integer + repository_id: + example: 42 + type: integer + head_repository_id: + example: 42 + type: integer + head_branch: + example: main + type: string + head_sha: + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-retention-limit-for-repository: + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this repository. + type: integer + example: 14 + actions-cache-storage-limit-for-repository: + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, in gigabytes. + type: integer + example: 10 + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + example: 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + example: 2 + ref: + type: string + example: refs/heads/main + key: + type: string + example: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + example: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + example: 1024 + required: + - total_count + - actions_caches + job: + title: Job + description: Information of a job execution in a workflow run + type: object + properties: + id: + description: The id of the job. + example: 21 + type: integer + run_id: + description: The id of the associated workflow run. + example: 5 + type: integer + run_url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5 + run_attempt: + type: integer + description: Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. + example: 1 + node_id: + type: string + example: MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: string + example: https://github.com/github/hello-world/runs/4 + nullable: true + status: + description: The phase of the lifecycle that the job is currently in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + conclusion: + description: The outcome of the job. + example: success + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + created_at: + description: The time that the job created, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + started_at: + description: The time that the job started, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + completed_at: + description: The time that the job finished, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + name: + description: The name of the job. + example: test-coverage + type: string + steps: + description: Steps in this job. + type: array + items: + type: object + required: + - name + - status + - conclusion + - number + properties: + status: + description: The phase of the lifecycle that the job is currently in. + example: queued + type: string + enum: + - queued + - in_progress + - completed + conclusion: + description: The outcome of the job. + example: success + type: string + nullable: true + name: + description: The name of the job. + example: test-coverage + type: string + number: + type: integer + example: 1 + started_at: + description: The time that the step started, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + completed_at: + description: The time that the job finished, in ISO 8601 format. + example: '2019-08-08T08:00:00-07:00' + format: date-time + type: string + nullable: true + check_run_url: + type: string + example: https://api.github.com/repos/github/hello-world/check-runs/4 + labels: + type: array + items: + type: string + description: Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. + example: + - self-hosted + - foo + - bar + runner_id: + type: integer + nullable: true + example: 1 + description: The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) + runner_name: + type: string + nullable: true + example: my runner + description: The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) + runner_group_id: + type: integer + nullable: true + example: 2 + description: The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) + runner_group_name: + type: string + nullable: true + example: my runner group + description: The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) + workflow_name: + type: string + description: The name of the workflow. + nullable: true + example: Build + head_branch: + type: string + description: The name of the current branch. + nullable: true + example: main + required: + - id + - node_id + - run_id + - run_url + - head_sha + - workflow_name + - head_branch + - name + - url + - html_url + - status + - conclusion + - started_at + - completed_at + - check_run_url + - labels + - runner_id + - runner_name + - runner_group_id + - runner_group_name + - created_at + oidc-custom-sub-repo: + title: Actions OIDC subject customization for a repository + description: Actions OIDC subject customization for a repository + type: object + properties: + use_default: + description: Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. + type: boolean + include_claim_keys: + description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. + type: array + items: + type: string + required: + - use_default + actions-secret: + title: Actions Secret + description: Set secrets for GitHub Actions. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + actions-variable: + title: Actions Variable + type: object + properties: + name: + description: The name of the variable. + example: USERNAME + type: string + value: + description: The value of the variable. + example: octocat + type: string + created_at: + description: The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + updated_at: + description: The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + example: '2019-01-24T22:45:36.000Z' + required: + - name + - value + - created_at + - updated_at + actions-repository-permissions: + type: object + properties: + enabled: + $ref: '#/components/schemas/actions-enabled' + allowed_actions: + $ref: '#/components/schemas/allowed-actions' + selected_actions_url: + $ref: '#/components/schemas/selected-actions-url' + sha_pinning_required: + $ref: '#/components/schemas/sha-pinning-required' + required: + - enabled + actions-enabled: + type: boolean + description: Whether GitHub Actions is enabled on the repository. + actions-workflow-access-to-repository: + type: object + properties: + access_level: + type: string + description: |- + Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the + repository. + + `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. + enum: + - none + - user + - organization + required: + - access_level + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + example: 5 + name: + type: string + description: The name of the workflow run. + nullable: true + example: Build + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + example: 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + example: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: string + nullable: true + example: master + head_sha: + description: The SHA of the head commit that points to the version of the workflow being run. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + path: + description: The full path of the workflow + example: octocat/octo-repo/.github/workflows/ci.yml@main + type: string + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + example: 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. + example: 1 + referenced_workflows: + type: array + nullable: true + items: + $ref: '#/components/schemas/referenced-workflow' + event: + type: string + example: push + status: + type: string + nullable: true + example: completed + conclusion: + type: string + nullable: true + example: neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + example: 5 + url: + type: string + description: The URL to the workflow run. + example: https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + example: https://github.com/github/hello-world/suites/4 + pull_requests: + description: Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. + type: array + nullable: true + items: + $ref: '#/components/schemas/pull-request-minimal' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + actor: + $ref: '#/components/schemas/simple-user' + triggering_actor: + $ref: '#/components/schemas/simple-user' + run_started_at: + type: string + format: date-time + description: The start time of the latest run. Resets on re-run. + jobs_url: + description: The URL to the jobs for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs + logs_url: + description: The URL to download the logs for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs + check_suite_url: + description: The URL to the associated check suite. + type: string + example: https://api.github.com/repos/github/hello-world/check-suites/12 + artifacts_url: + description: The URL to the artifacts for the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts + cancel_url: + description: The URL to cancel the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + nullable: true + description: The URL to the previous attempted run of this workflow, if one exists. + type: string + example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + $ref: '#/components/schemas/nullable-simple-commit' + repository: + $ref: '#/components/schemas/minimal-repository' + head_repository: + $ref: '#/components/schemas/minimal-repository' + head_repository_id: + type: integer + example: 5 + display_title: + type: string + example: Simple Workflow + description: The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. + required: + - id + - node_id + - head_branch + - run_number + - display_title + - event + - status + - conclusion + - head_sha + - path + - workflow_id + - url + - html_url + - created_at + - updated_at + - head_commit + - head_repository + - repository + - jobs_url + - logs_url + - check_suite_url + - cancel_url + - rerun_url + - artifacts_url + - workflow_url + - pull_requests + environment-approvals: + title: Environment Approval + description: An entry in the reviews log for environment deployments + type: object + properties: + environments: + description: The list of environments that were approved or rejected + type: array + items: + type: object + properties: + id: + description: The id of the environment. + example: 56780428 + type: integer + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: + description: The time that the environment was created, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + updated_at: + description: The time that the environment was last updated, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + state: + description: Whether deployment to the environment(s) was approved or rejected or pending (with comments) + enum: + - approved + - rejected + - pending + example: approved + type: string + user: + $ref: '#/components/schemas/simple-user' + comment: + type: string + description: The comment submitted with the deployment review + example: Ship it! + required: + - environments + - state + - user + - comment + review-custom-gates-comment-required: + type: object + properties: + environment_name: + type: string + description: The name of the environment to approve or reject. + comment: + type: string + description: Comment associated with the pending deployment protection rule. **Required when state is not provided.** + required: + - environment_name + - comment + review-custom-gates-state-required: + type: object + properties: + environment_name: + type: string + description: The name of the environment to approve or reject. + state: + type: string + description: Whether to approve or reject deployment to the specified environments. + enum: + - approved + - rejected + comment: + type: string + description: Optional comment to include with the review. + required: + - environment_name + - state + pending-deployment: + title: Pending Deployment + description: Details of a deployment that is waiting for protection rules to pass + type: object + properties: + environment: + type: object + properties: + id: + description: The id of the environment. + type: integer + format: int64 + example: 56780428 + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + example: 30 + wait_timer_started_at: + description: The time that the wait timer began. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + nullable: true + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + example: true + reviewers: + type: array + description: The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + items: + type: object + properties: + type: + $ref: '#/components/schemas/deployment-reviewer-type' + reviewer: + anyOf: + - $ref: '#/components/schemas/simple-user' + - $ref: '#/components/schemas/team' + required: + - environment + - wait_timer + - wait_timer_started_at + - current_user_can_approve + - reviewers + deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + example: 42 + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + sha: + type: string + example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + example: topic-branch + type: string + task: + description: Parameter to specify a task to execute + example: deploy + type: string + payload: + type: object + additionalProperties: true + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' + example: true + type: boolean + production_environment: + description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' + example: true + type: boolean + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow-run-usage: + title: Workflow Run Usage + description: Workflow Run Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + MACOS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + WINDOWS: + type: object + required: + - total_ms + - jobs + properties: + total_ms: + type: integer + jobs: + type: integer + job_runs: + type: array + items: + type: object + required: + - job_id + - duration_ms + properties: + job_id: + type: integer + duration_ms: + type: integer + run_duration_ms: + type: integer + required: + - billable + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + example: 5 + node_id: + type: string + example: MDg6V29ya2Zsb3cxMg== + name: + type: string + example: CI + path: + type: string + example: ruby.yaml + state: + type: string + example: active + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + created_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + url: + type: string + example: https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + example: '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + workflow-dispatch-response: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + $ref: '#/components/schemas/workflow-run-id' + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url + workflow-usage: + title: Workflow Usage + description: Workflow Usage + type: object + properties: + billable: + type: object + properties: + UBUNTU: + type: object + properties: + total_ms: + type: integer + MACOS: + type: object + properties: + total_ms: + type: integer + WINDOWS: + type: object + properties: + total_ms: + type: integer + required: + - billable + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-actions-hosted-runner-pool-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + type: string + example: ubuntu-20.04 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest + required: + - id + - size_gb + - display_name + - source + nullable: true + public-ip: + title: Public IP for a GitHub-hosted larger runners. + description: Provides details of Public IP for a GitHub-hosted larger runners + type: object + properties: + enabled: + description: Whether public IP is enabled. + type: boolean + example: true + prefix: + description: The prefix for the public IP. + type: string + example: 20.80.208.150 + length: + description: The length of the IP prefix. + type: integer + example: 28 + selected-actions-url: + type: string + description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + actions-default-workflow-permissions: + type: string + description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. + enum: + - read + - write + actions-can-approve-pull-request-reviews: + type: boolean + description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + runner-label: + title: Self hosted runner label + description: A label for a self hosted runner + type: object + properties: + id: + type: integer + description: Unique identifier of the label. + name: + type: string + description: Name of the label. + type: + type: string + description: The type of label. Read-only labels are applied automatically when the runner is configured. + enum: + - read-only + - custom + required: + - name + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + referenced-workflow: + title: Referenced workflow + description: A workflow referenced/reused by the initial caller workflow + type: object + properties: + path: + type: string + sha: + type: string + ref: + type: string + required: + - path + - sha + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + nullable-simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + timestamp: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + author: + type: object + description: Information about the Git author + properties: + name: + description: Name of the commit's author + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's author + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + committer: + type: object + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's committer + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + required: + - id + - tree_id + - message + - timestamp + - author + - committer + nullable: true + deployment-reviewer-type: + type: string + description: The type of reviewer. + enum: + - User + - Team + example: User + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + workflow-run-id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + actions_runner_jitconfig: + description: Response + content: + application/json: + schema: + type: object + required: + - runner + - encoded_jit_config + properties: + runner: + $ref: '#/components/schemas/runner' + encoded_jit_config: + type: string + description: The base64 encoded runner configuration. + examples: + default: + $ref: '#/components/examples/runner-jitconfig' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + actions_runner_labels: + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - labels + properties: + total_count: + type: integer + labels: + type: array + items: + $ref: '#/components/schemas/runner-label' + examples: + default: + $ref: '#/components/examples/runner-labels' + actions_runner_labels_readonly: + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - labels + properties: + total_count: + type: integer + labels: + type: array + items: + $ref: '#/components/schemas/runner-label' + examples: + default: + $ref: '#/components/examples/runner-labels-readonly' + gone: + description: Gone + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true + schema: + type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: ^\d+\.\d+\.\d+$ + hosted-runner-id: + name: hosted_runner_id + description: Unique identifier of the GitHub-hosted runner. + in: path + required: true + schema: + type: integer + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + visible-to-repository: + name: visible_to_repository + description: Only return runner groups that are allowed to be used by this repository. + in: query + required: false + schema: + type: string + runner-group-id: + name: runner_group_id + description: Unique identifier of the self-hosted runner group. + in: path + required: true + schema: + type: integer + runner-id: + name: runner_id + description: Unique identifier of the self-hosted runner. + in: path + required: true + schema: + type: integer + runner-label-name: + name: name + description: The name of a self-hosted runner's custom label. + in: path + required: true + schema: + type: string + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + variables-per-page: + name: per_page + description: The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 10 + variable-name: + name: name + description: The name of the variable. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + artifact-name: + name: name + description: The name field of an artifact. When specified, only artifacts with this name will be returned. + in: query + required: false + schema: + type: string + artifact-id: + name: artifact_id + description: The unique identifier of the artifact. + in: path + required: true + schema: + type: integer + actions-cache-git-ref-full: + name: ref + description: The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. + in: query + required: false + schema: + type: string + actions-cache-key: + name: key + description: An explicit key or prefix for identifying the cache + in: query + required: false + schema: + type: string + actions-cache-list-sort: + name: sort + description: The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. + in: query + required: false + schema: + type: string + enum: + - created_at + - last_accessed_at + - size_in_bytes + default: last_accessed_at + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + actions-cache-key-required: + name: key + description: A key for identifying the cache. + in: query + required: true + schema: + type: string + cache-id: + name: cache_id + description: The unique identifier of the GitHub Actions cache. + in: path + required: true + schema: + type: integer + job-id: + name: job_id + description: The unique identifier of the job. + in: path + required: true + schema: + type: integer + actor: + name: actor + description: Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. + in: query + required: false + schema: + type: string + workflow-run-branch: + name: branch + description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. + in: query + required: false + schema: + type: string + event: + name: event + description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." + in: query + required: false + schema: + type: string + workflow-run-status: + name: status + description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. + in: query + required: false + schema: + type: string + enum: + - completed + - action_required + - cancelled + - failure + - neutral + - skipped + - stale + - success + - timed_out + - in_progress + - queued + - requested + - waiting + - pending + created: + name: created + description: Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + in: query + required: false + schema: + type: string + format: date-time + exclude-pull-requests: + name: exclude_pull_requests + description: If `true` pull requests are omitted from the response (empty array). + in: query + required: false + schema: + type: boolean + default: false + workflow-run-check-suite-id: + name: check_suite_id + description: Returns workflow runs with the `check_suite_id` that you specify. + in: query + schema: + type: integer + workflow-run-head-sha: + name: head_sha + description: Only returns workflow runs that are associated with the specified `head_sha`. + in: query + required: false + schema: + type: string + run-id: + name: run_id + description: The unique identifier of the workflow run. + in: path + required: true + schema: + type: integer + attempt-number: + name: attempt_number + description: The attempt number of the workflow run. + in: path + required: true + schema: + type: integer + workflow-id: + name: workflow_id + in: path + description: The ID of the workflow. You can also pass the workflow file name as a string. + required: true + schema: + oneOf: + - type: integer + - type: string + environment-name: + name: environment_name + in: path + required: true + description: The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. + schema: + type: string + examples: + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 + actions-cache-usage-org-enterprise: + value: + total_active_caches_size_in_bytes: 3344284 + total_active_caches_count: 5 + org-actions-cache-usage-by-repo: + value: + total_count: 2 + repository_cache_usages: + - full_name: octo-org/Hello-World + active_caches_size_in_bytes: 2322142 + active_caches_count: 3 + - full_name: octo-org/server + active_caches_size_in_bytes: 1022142 + active_caches_count: 2 + actions-hosted-runner-paginated: + value: + total_count: 2 + runners: + - id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + - id: 7 + name: My hosted Windows runner + runner_group_id: 2 + platform: win-x64 + image: + id: windows-latest + size: 256 + machine_size_details: + id: 8-core + cpu_cores: 8 + memory_gb: 32 + storage_gb: 300 + status: Ready + maximum_runners: 20 + public_ip_enabled: false + public_ips: [] + last_active_on: '2023-04-26T15:23:37Z' + actions-hosted-runner: + value: + id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-curated-image: + value: + id: ubuntu-20.04 + platform: linux-x64 + size_gb: 86 + display_name: '20.04' + source: github + actions-hosted-runner-limits-default: + value: + public_ips: + current_usage: 17 + maximum: 50 + actions-hosted-runner-machine-spec: + value: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + actions-organization-permissions: + value: + enabled_repositories: all + allowed_actions: selected + selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions + sha_pinning_required: true + actions-fork-pr-contributor-approval: + value: + approval_policy: first_time_contributors + actions-fork-pr-workflows-private-repos: + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true + repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + selected-actions: + value: + github_owned_allowed: true + verified_allowed: false + patterns_allowed: + - monalisa/octocat@* + - docker/* + actions-default-workflow-permissions: + summary: Give read-only permission, and allow approving PRs. + value: + default_workflow_permissions: read + can_approve_pull_request_reviews: true + runner-groups-org: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + inherited: true + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: true + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners + inherited: false + allows_public_repositories: true + restricted_to_workflows: false + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-item: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories + runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners + hosted_runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners + network_configuration_id: EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA + inherited: false + allows_public_repositories: true + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: null + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 + runner-paginated: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + ephemeral: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 11 + name: Linux + type: read-only + - id: 24 + name: mac_runner + os: macos + status: offline + busy: false + ephemeral: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + runner-application-items: + value: + - os: osx + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz + filename: actions-runner-osx-x64-2.164.0.tar.gz + - os: linux + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz + filename: actions-runner-linux-x64-2.164.0.tar.gz + - os: linux + architecture: arm + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz + filename: actions-runner-linux-arm-2.164.0.tar.gz + - os: win + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip + filename: actions-runner-win-x64-2.164.0.zip + - os: linux + architecture: arm64 + download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz + filename: actions-runner-linux-arm64-2.164.0.tar.gz + authentication-token: + value: + token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 + expires_at: '2020-01-22T12:13:35.123-08:00' + authentication-token-2: + value: + token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 + expires_at: '2020-01-29T12:13:35.123-08:00' + runner: + value: + id: 23 + name: MBP + os: macos + status: online + busy: true + ephemeral: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + organization-actions-secret-paginated: + value: + total_count: 3 + secrets: + - name: GIST_ID + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: private + - name: DEPLOY_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories + actions-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + organization-actions-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + organization-actions-variables-paginated: + value: + total_count: 3 + variables: + - name: USERNAME + value: octocat + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: private + - name: ACTIONS_RUNNER_DEBUG + value: true + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + - name: ADMIN_EMAIL + value: octocat@github.com + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories + organization-actions-variable: + value: + name: USERNAME + value: octocat + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories + artifact-paginated: + value: + total_count: 2 + artifacts: + - id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + - id: 13 + node_id: MDg6QXJ0aWZhY3QxMw== + name: Test output + size_in_bytes: 453 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-03-21T14:59:22Z' + updated_at: '2020-02-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + id: 2332942 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 + artifact: + value: + id: 11 + node_id: MDg6QXJ0aWZhY3QxMQ== + name: Rails + size_in_bytes: 556 + url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11 + archive_download_url: https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip + expired: false + created_at: '2020-01-10T14:59:22Z' + expires_at: '2020-01-21T14:59:22Z' + updated_at: '2020-01-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + workflow_run: + id: 2332938 + repository_id: 1296269 + head_repository_id: 1296269 + head_branch: main + head_sha: 328faa0536e6fef19753d9d91dc96a9931694ce3 + actions-cache-usage: + value: + full_name: octo-org/Hello-World + active_caches_size_in_bytes: 2322142 + active_caches_count: 3 + actions-cache-list: + value: + total_count: 1 + actions_caches: + - id: 505 + ref: refs/heads/main + key: Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: '2019-01-24T22:45:36.000Z' + created_at: '2019-01-24T22:45:36.000Z' + size_in_bytes: 1024 + job: + value: + id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + workflow_name: CI + head_branch: main + oidc-custom-sub-repo: + value: + use_default: false + include_claim_keys: + - repo + - context + actions-secret-paginated: + value: + total_count: 2 + secrets: + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: GIST_ID + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + actions-variables-paginated: + value: + total_count: 2 + variables: + - name: USERNAME + value: octocat + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: EMAIL + value: octocat@github.com + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + actions-repository-permissions: + value: + enabled: true + allowed_actions: selected + selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions + sha_pinning_required: true + actions-workflow-access-to-repository: + value: + access_level: organization + workflow-run-paginated: + value: + total_count: 1 + workflow_runs: + - id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: master + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: .github/workflows/build.yml@main + run_number: 562 + event: push + display_title: Update README.md + status: queued + conclusion: null + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + workflow-run: + value: + id: 30433642 + name: Build + node_id: MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ== + check_suite_id: 42 + check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: main + head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: .github/workflows/build.yml@main + run_number: 562 + event: push + display_title: Update README.md + status: queued + conclusion: null + workflow_id: 159038 + url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642 + html_url: https://github.com/octo-org/octo-repo/actions/runs/30433642 + pull_requests: [] + created_at: '2020-01-22T19:33:08Z' + updated_at: '2020-01-22T19:33:08Z' + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + run_attempt: 1 + referenced_workflows: + - path: octocat/Hello-World/.github/workflows/deploy.yml@main + sha: 86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db + ref: refs/heads/main + - path: octo-org/octo-repo/.github/workflows/report.yml@v2 + sha: 79e9790903e1c3373b1a3e3a941d57405478a232 + ref: refs/tags/v2 + - path: octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e + sha: 1595d4b6de6a9e9751fb270a41019ce507d4099e + run_started_at: '2020-01-22T19:33:08Z' + triggering_actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + jobs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs + logs_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs + check_suite_url: https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374 + artifacts_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts + cancel_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel + rerun_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun + previous_attempt_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1 + workflow_url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038 + head_commit: + id: acb5820ced9479c074f688cc328bf03f341a511d + tree_id: d23f6eedb1e1b9610bbc754ddb5197bfe7271223 + message: Create linter.yaml + timestamp: '2020-01-22T19:33:05Z' + author: + name: Octo Cat + email: octocat@github.com + committer: + name: GitHub + email: noreply@github.com + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + head_repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + private: true + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + html_url: https://github.com/octo-org/octo-repo + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + events_url: https://api.github.com/repos/octo-org/octo-repo/events + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + environment-approvals-items: + value: + - state: approved + comment: Ship it! + environments: + - id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + job-paginated: + value: + total_count: 1 + jobs: + - id: 399444496 + run_id: 29679449 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449 + node_id: MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng== + head_sha: f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0 + url: https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496 + html_url: https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496 + status: completed + conclusion: success + started_at: '2020-01-20T17:42:40Z' + completed_at: '2020-01-20T17:44:39Z' + name: build + steps: + - name: Set up job + status: completed + conclusion: success + number: 1 + started_at: '2020-01-20T09:42:40.000-08:00' + completed_at: '2020-01-20T09:42:41.000-08:00' + - name: Run actions/checkout@v2 + status: completed + conclusion: success + number: 2 + started_at: '2020-01-20T09:42:41.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Set up Ruby + status: completed + conclusion: success + number: 3 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:45.000-08:00' + - name: Run actions/cache@v3 + status: completed + conclusion: success + number: 4 + started_at: '2020-01-20T09:42:45.000-08:00' + completed_at: '2020-01-20T09:42:48.000-08:00' + - name: Install Bundler + status: completed + conclusion: success + number: 5 + started_at: '2020-01-20T09:42:48.000-08:00' + completed_at: '2020-01-20T09:42:52.000-08:00' + - name: Install Gems + status: completed + conclusion: success + number: 6 + started_at: '2020-01-20T09:42:52.000-08:00' + completed_at: '2020-01-20T09:42:53.000-08:00' + - name: Run Tests + status: completed + conclusion: success + number: 7 + started_at: '2020-01-20T09:42:53.000-08:00' + completed_at: '2020-01-20T09:42:59.000-08:00' + - name: Deploy to Heroku + status: completed + conclusion: success + number: 8 + started_at: '2020-01-20T09:42:59.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Post actions/cache@v3 + status: completed + conclusion: success + number: 16 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + - name: Complete job + status: completed + conclusion: success + number: 17 + started_at: '2020-01-20T09:44:39.000-08:00' + completed_at: '2020-01-20T09:44:39.000-08:00' + check_run_url: https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496 + labels: + - self-hosted + - foo + - bar + runner_id: 1 + runner_name: my runner + runner_group_id: 2 + runner_group_name: my runner group + workflow_name: CI + head_branch: main + pending-deployment-items: + value: + - environment: + id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: 30 + wait_timer_started_at: '2020-11-23T22:00:40Z' + current_user_can_approve: true + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + deployment-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + workflow-run-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + jobs: 1 + job_runs: + - job_id: 1 + duration_ms: 180000 + MACOS: + total_ms: 240000 + jobs: 4 + job_runs: + - job_id: 2 + duration_ms: 60000 + - job_id: 3 + duration_ms: 60000 + - job_id: 4 + duration_ms: 60000 + - job_id: 5 + duration_ms: 60000 + WINDOWS: + total_ms: 300000 + jobs: 2 + job_runs: + - job_id: 6 + duration_ms: 150000 + - job_id: 7 + duration_ms: 150000 + run_duration_ms: 500000 + actions-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + actions-variable: + value: + name: USERNAME + value: octocat + created_at: '2021-08-10T14:59:22Z' + updated_at: '2022-01-10T14:59:22Z' + workflow-paginated: + value: + total_count: 2 + workflows: + - id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: .github/workflows/blank.yaml + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + - id: 269289 + node_id: MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ== + name: Linter + path: .github/workflows/linter.yaml + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 + badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg + workflow: + value: + id: 161335 + node_id: MDg6V29ya2Zsb3cxNjEzMzU= + name: CI + path: .github/workflows/blank.yaml + state: active + created_at: '2020-01-08T23:48:37.000-08:00' + updated_at: '2020-01-08T23:50:21.000-08:00' + url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 + html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 + badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + workflow-dispatch-response: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 + workflow-usage: + value: + billable: + UBUNTU: + total_ms: 180000 + MACOS: + total_ms: 240000 + WINDOWS: + total_ms: 300000 + runner-jitconfig: + value: + runner: + id: 23 + name: New runner + os: unknown + status: offline + busy: false + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + encoded_jit_config: abc123 + runner-labels: + value: + total_count: 4 + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + - id: 21 + name: no-gpu + type: custom + runner-labels-readonly: + value: + total_count: 3 + labels: + - id: 5 + name: self-hosted + type: read-only + - id: 7 + name: X64 + type: read-only + - id: 20 + name: macOS + type: read-only + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string + location: + example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/activity.yaml b/provider-dev/source/activity.yaml new file mode 100644 index 0000000..a5d850a --- /dev/null +++ b/provider-dev/source/activity.yaml @@ -0,0 +1,6824 @@ +openapi: 3.0.3 +info: + title: activity API + description: Activity APIs provide access to notifications, subscriptions, and timelines. + version: 1.1.4 +paths: + /events: + get: + summary: List public events + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-public-events + parameters: + - $ref: '#/components/parameters/public-events-per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/public-events-items' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /feeds: + get: + summary: Get feeds + description: |- + Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. + + * **Timeline**: The GitHub global public timeline + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Current user public**: The public timeline for the authenticated user + * **Current user**: The private timeline for the authenticated user + * **Current user actor**: The private timeline for activity created by the authenticated user + * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + + By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + > [!NOTE] + > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + tags: + - activity + operationId: activity/get-feeds + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/feeds#get-feeds + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/feed' + examples: + default: + $ref: '#/components/examples/feed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: feeds + x-stackQL-resource: feeds + /networks/{owner}/{repo}/events: + get: + summary: List public events for a network of repositories + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-events-for-repo-network + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/public-repo-events-items' + '301': + $ref: '#/components/responses/moved_permanently' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /notifications: + get: + summary: List notifications for the authenticated user + description: List all notifications for the current user, sorted by most recently updated. + tags: + - activity + operationId: activity/list-notifications-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/all' + - $ref: '#/components/parameters/participating' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/before' + - $ref: '#/components/parameters/page' + - name: per_page + description: The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 50 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/thread' + examples: + default: + $ref: '#/components/examples/thread-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + put: + summary: Mark notifications as read + description: Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + tags: + - activity + operationId: activity/mark-notifications-as-read + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#mark-notifications-as-read + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + last_read_at: + description: 'Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.' + type: string + format: date-time + read: + description: Whether the notification has been read. + type: boolean + examples: + default: + value: + last_read_at: '2022-06-10T00:00:00Z' + read: true + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + default: + $ref: '#/components/examples/notifications-mark-read' + '205': + description: Reset Content + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /notifications/threads/{thread_id}: + get: + summary: Get a thread + description: Gets information about a notification thread. + tags: + - activity + operationId: activity/get-thread + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#get-a-thread + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/thread' + examples: + default: + $ref: '#/components/examples/thread' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + patch: + summary: Mark a thread as read + description: 'Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-read + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '205': + description: Reset Content + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + delete: + summary: Mark a thread as done + description: 'Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '204': + description: No content + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /notifications/threads/{thread_id}/subscription: + get: + summary: Get a thread subscription for the authenticated user + description: |- + This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription). + + Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + tags: + - activity + operationId: activity/get-thread-subscription-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/thread-subscription' + examples: + default: + $ref: '#/components/examples/thread-subscription' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + put: + summary: Set a thread subscription + description: |- + If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. + + You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + + Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. + tags: + - activity + operationId: activity/set-thread-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription + parameters: + - $ref: '#/components/parameters/thread-id' + requestBody: + required: false + content: + application/json: + schema: + properties: + ignored: + description: Whether to block all notifications from a thread. + default: false + type: boolean + type: object + examples: + default: + value: + ignored: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/thread-subscription' + examples: + default: + $ref: '#/components/examples/thread-subscription' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + delete: + summary: Delete a thread subscription + description: Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + tags: + - activity + operationId: activity/delete-thread-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription + parameters: + - $ref: '#/components/parameters/thread-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /orgs/{org}/events: + get: + summary: List public organization events + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-org-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-public-organization-events + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + 200-response: + $ref: '#/components/examples/public-org-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/events: + get: + summary: List repository events + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-repo-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-repository-events + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + 200-response: + $ref: '#/components/examples/repo-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/notifications: + get: + summary: List repository notifications for the authenticated user + description: Lists all notifications for the current user in the specified repository. + tags: + - activity + operationId: activity/list-repo-notifications-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/all' + - $ref: '#/components/parameters/participating' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/before' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/thread' + examples: + default: + $ref: '#/components/examples/thread-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + put: + summary: Mark repository notifications as read + description: Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + tags: + - activity + operationId: activity/mark-repo-notifications-as-read + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + last_read_at: + type: string + format: date-time + description: 'Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.' + examples: + default: + value: + last_read_at: '2019-01-01T00:00:00Z' + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background. + '205': + description: Reset Content + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications + x-stackQL-resource: notifications + /repos/{owner}/{repo}/stargazers: + get: + summary: List stargazers + description: |- + Lists the people that have starred the repository. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + tags: + - activity + operationId: activity/list-stargazers-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#list-stargazers + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default-response: + $ref: '#/components/examples/simple-user-items-default-response' + alternative-response-with-star-creation-timestamps: + $ref: '#/components/examples/stargazer-items-alternative-response-with-star-creation-timestamps' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: starring + x-stackQL-resource: starring + /repos/{owner}/{repo}/subscribers: + get: + summary: List watchers + description: Lists the people watching the specified repository. + tags: + - activity + operationId: activity/list-watchers-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#list-watchers + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: watching + x-stackQL-resource: watching + /repos/{owner}/{repo}/subscription: + get: + summary: Get a repository subscription + description: Gets information about whether the authenticated user is subscribed to the repository. + tags: + - activity + operationId: activity/get-repo-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: if you subscribe to the repository + content: + application/json: + schema: + $ref: '#/components/schemas/repository-subscription' + examples: + response-if-you-subscribe-to-the-repository: + $ref: '#/components/examples/repository-subscription-response-if-you-subscribe-to-the-repository' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if you don't subscribe to the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + put: + summary: Set a repository subscription + description: If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. + tags: + - activity + operationId: activity/set-repo-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + subscribed: + type: boolean + description: Determines if notifications should be received from this repository. + ignored: + type: boolean + description: Determines if all notifications should be blocked from this repository. + examples: + default: + value: + subscribed: true + ignored: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-subscription' + examples: + default: + $ref: '#/components/examples/repository-subscription' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + delete: + summary: Delete a repository subscription + description: This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). + tags: + - activity + operationId: activity/delete-repo-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + /user/starred: + get: + summary: List repositories starred by the authenticated user + description: |- + Lists repositories the authenticated user has starred. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + tags: + - activity + operationId: activity/list-repos-starred-by-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/sort-starred' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default-response: + $ref: '#/components/examples/repository-items-default-response' + application/vnd.github.v3.star+json: + schema: + type: array + items: + $ref: '#/components/schemas/starred-repository' + examples: + alternative-response-with-star-creation-timestamps: + $ref: '#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + /user/starred/{owner}/{repo}: + get: + summary: Check if a repository is starred by the authenticated user + description: Whether the authenticated user has starred the repository. + tags: + - activity + operationId: activity/check-repo-is-starred-by-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response if this repository is starred by you + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if this repository is not starred by you + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + put: + summary: Star a repository for the authenticated user + description: Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - activity + operationId: activity/star-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + delete: + summary: Unstar a repository for the authenticated user + description: Unstar a repository that the authenticated user has previously starred. + tags: + - activity + operationId: activity/unstar-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: starring + x-stackQL-resource: starring + /user/subscriptions: + get: + summary: List repositories watched by the authenticated user + description: Lists repositories the authenticated user is watching. + tags: + - activity + operationId: activity/list-watched-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: watching + x-stackQL-resource: watching + /users/{username}/events: + get: + summary: List events for the authenticated user + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-events-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/events/orgs/{org}: + get: + summary: List organization events for the authenticated user + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-org-events-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-org-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/events/public: + get: + summary: List public events for a user + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-public-events-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-public-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/received_events: + get: + summary: List events received by the authenticated user + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-received-events-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-received-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/received_events/public: + get: + summary: List public events received by a user + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + tags: + - activity + operationId: activity/list-received-public-events-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/event' + examples: + default: + $ref: '#/components/examples/user-received-public-events-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: events + x-stackQL-resource: events + /users/{username}/starred: + get: + summary: List repositories starred by a user + description: |- + Lists repositories a user has starred. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + tags: + - activity + operationId: activity/list-repos-starred-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/sort-starred' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/starred-repository' + examples: + default-response: + $ref: '#/components/examples/repository-items-default-response' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: starring + x-stackQL-resource: starring + /users/{username}/subscriptions: + get: + summary: List repositories watched by a user + description: Lists repositories a user is watching. + tags: + - activity + operationId: activity/list-repos-watched-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: activity + subcategory: watching + x-stackQL-resource: watching +components: + schemas: + event: + title: Event + description: Event + type: object + properties: + id: + type: string + type: + type: string + nullable: true + actor: + $ref: '#/components/schemas/actor' + repo: + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - name + - url + org: + $ref: '#/components/schemas/actor' + payload: + title: CreateEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + master_branch: + type: string + description: + type: string + nullable: true + pusher_type: + type: string + action: + type: string + discussion: + $ref: '#/components/schemas/discussion' + issue: + $ref: '#/components/schemas/issue' + assignee: + $ref: '#/components/schemas/simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + label: + $ref: '#/components/schemas/label' + labels: + type: array + items: + $ref: '#/components/schemas/label' + comment: + $ref: '#/components/schemas/issue-comment' + forkee: + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + private: + type: boolean + owner: + $ref: '#/components/schemas/simple-user' + html_url: + type: string + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + forks_url: + type: string + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + hooks_url: + type: string + issue_events_url: + type: string + events_url: + type: string + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + stargazers_url: + type: string + contributors_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + archive_url: + type: string + downloads_url: + type: string + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + pushed_at: + type: string + format: date-time + nullable: true + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + homepage: + type: string + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_downloads: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + forks_count: + type: integer + mirror_url: + type: string + nullable: true + archived: + type: boolean + disabled: + type: boolean + open_issues_count: + type: integer + license: + $ref: '#/components/schemas/nullable-license-simple' + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + topics: + type: array + items: + type: string + visibility: + type: string + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + default_branch: + type: string + public: + type: boolean + pages: + type: array + items: + type: object + properties: + page_name: + type: string + nullable: true + title: + type: string + nullable: true + summary: + type: string + nullable: true + action: + type: string + sha: + type: string + html_url: + type: string + member: + $ref: '#/components/schemas/simple-user' + repository_id: + type: integer + push_id: + type: integer + head: + type: string + before: + type: string + number: + type: integer + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + review: + type: object + properties: + id: + type: integer + node_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + commit_id: + type: string + submitted_at: + type: string + nullable: true + state: + type: string + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + updated_at: + type: string + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: Specifies the commitish value that determines where the Git tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: true to create a draft (unpublished) release, false to create a published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + is_short_description_html_truncated: + type: boolean + short_description_html: + type: string + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + required: + - ref + - ref_type + - full_ref + - master_branch + - pusher_type + - action + - discussion + - issue + - comment + - forkee + - pages + - member + - repository_id + - push_id + - head + - before + - number + - pull_request + - review + - release + description: (opaque JSON object) + public: + type: boolean + created_at: + type: string + format: date-time + nullable: true + required: + - id + - type + - actor + - repo + - payload + - public + - created_at + feed: + title: Feed + description: Feed + type: object + properties: + timeline_url: + type: string + example: https://github.com/timeline + user_url: + type: string + example: https://github.com/{user} + current_user_public_url: + type: string + example: https://github.com/octocat + current_user_url: + type: string + example: https://github.com/octocat.private?token=abc123 + current_user_actor_url: + type: string + example: https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: + type: string + example: https://github.com/octocat-org + current_user_organization_urls: + type: array + example: + - https://github.com/organizations/github/octocat.private.atom?token=abc123 + items: + type: string + format: uri + security_advisories_url: + type: string + example: https://github.com/security-advisories + repository_discussions_url: + type: string + example: https://github.com/{user}/{repo}/discussions + description: A feed of discussions for a given repository. + repository_discussions_category_url: + type: string + example: https://github.com/{user}/{repo}/discussions/categories/{category} + description: A feed of discussions for a given repository and category. + _links: + type: object + properties: + timeline: + $ref: '#/components/schemas/link-with-type' + user: + $ref: '#/components/schemas/link-with-type' + security_advisories: + $ref: '#/components/schemas/link-with-type' + current_user: + $ref: '#/components/schemas/link-with-type' + current_user_public: + $ref: '#/components/schemas/link-with-type' + current_user_actor: + $ref: '#/components/schemas/link-with-type' + current_user_organization: + $ref: '#/components/schemas/link-with-type' + current_user_organizations: + type: array + items: + $ref: '#/components/schemas/link-with-type' + repository_discussions: + $ref: '#/components/schemas/link-with-type' + repository_discussions_category: + $ref: '#/components/schemas/link-with-type' + required: + - timeline + - user + required: + - _links + - timeline_url + - user_url + thread: + title: Thread + description: Thread + type: object + properties: + id: + type: string + repository: + $ref: '#/components/schemas/minimal-repository' + subject: + type: object + properties: + title: + type: string + url: + type: string + latest_comment_url: + type: string + type: + type: string + required: + - title + - url + - latest_comment_url + - type + reason: + type: string + unread: + type: boolean + updated_at: + type: string + last_read_at: + type: string + nullable: true + url: + type: string + subscription_url: + type: string + example: https://api.github.com/notifications/threads/2/subscription + required: + - id + - unread + - reason + - updated_at + - last_read_at + - subject + - repository + - url + - subscription_url + thread-subscription: + title: Thread Subscription + description: Thread Subscription + type: object + properties: + subscribed: + type: boolean + example: true + ignored: + type: boolean + reason: + type: string + nullable: true + created_at: + type: string + format: date-time + example: '2012-10-06T21:34:12Z' + nullable: true + url: + type: string + format: uri + example: https://api.github.com/notifications/threads/1/subscription + thread_url: + type: string + format: uri + example: https://api.github.com/notifications/threads/1 + repository_url: + type: string + format: uri + example: https://api.github.com/repos/1 + required: + - created_at + - ignored + - reason + - url + - subscribed + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - starred_at + - user + repository-subscription: + title: Repository Invitation + description: Repository invitations let you manage who you collaborate with. + type: object + properties: + subscribed: + description: Determines if notifications should be received from this repository. + type: boolean + example: true + ignored: + description: Determines if all notifications should be blocked from this repository. + type: boolean + reason: + type: string + nullable: true + created_at: + type: string + format: date-time + example: '2012-10-06T21:34:12Z' + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + required: + - created_at + - ignored + - reason + - subscribed + - url + - repository_url + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + starred-repository: + title: Starred Repository + description: Starred Repository + type: object + properties: + starred_at: + type: string + format: date-time + repo: + $ref: '#/components/schemas/repository' + required: + - starred_at + - repo + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + actor: + title: Actor + description: Actor + type: object + properties: + id: + type: integer + login: + type: string + display_login: + type: string + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + avatar_url: + type: string + format: uri + required: + - id + - login + - gravatar_id + - url + - avatar_url + create-event: + title: CreateEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + master_branch: + type: string + description: + type: string + nullable: true + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - master_branch + - pusher_type + delete-event: + title: DeleteEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - pusher_type + discussion-event: + title: DiscussionEvent + type: object + properties: + action: + type: string + discussion: + $ref: '#/components/schemas/discussion' + required: + - action + - discussion + issues-event: + title: IssuesEvent + type: object + properties: + action: + type: string + issue: + $ref: '#/components/schemas/issue' + assignee: + $ref: '#/components/schemas/simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + label: + $ref: '#/components/schemas/label' + labels: + type: array + items: + $ref: '#/components/schemas/label' + required: + - action + - issue + issue-comment-event: + title: IssueCommentEvent + type: object + properties: + action: + type: string + issue: + $ref: '#/components/schemas/issue' + comment: + $ref: '#/components/schemas/issue-comment' + required: + - action + - issue + - comment + fork-event: + title: ForkEvent + type: object + properties: + action: + type: string + forkee: + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + private: + type: boolean + owner: + $ref: '#/components/schemas/simple-user' + html_url: + type: string + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + forks_url: + type: string + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + hooks_url: + type: string + issue_events_url: + type: string + events_url: + type: string + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + stargazers_url: + type: string + contributors_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + archive_url: + type: string + downloads_url: + type: string + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + pushed_at: + type: string + format: date-time + nullable: true + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + homepage: + type: string + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_downloads: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + forks_count: + type: integer + mirror_url: + type: string + nullable: true + archived: + type: boolean + disabled: + type: boolean + open_issues_count: + type: integer + license: + $ref: '#/components/schemas/nullable-license-simple' + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + topics: + type: array + items: + type: string + visibility: + type: string + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + default_branch: + type: string + public: + type: boolean + required: + - action + - forkee + gollum-event: + title: GollumEvent + type: object + properties: + pages: + type: array + items: + type: object + properties: + page_name: + type: string + nullable: true + title: + type: string + nullable: true + summary: + type: string + nullable: true + action: + type: string + sha: + type: string + html_url: + type: string + required: + - pages + member-event: + title: MemberEvent + type: object + properties: + action: + type: string + member: + $ref: '#/components/schemas/simple-user' + required: + - action + - member + public-event: + title: PublicEvent + type: string + description: (opaque JSON object) + push-event: + title: PushEvent + type: object + properties: + repository_id: + type: integer + push_id: + type: integer + ref: + type: string + head: + type: string + before: + type: string + required: + - repository_id + - push_id + - ref + - head + - before + pull-request-event: + title: PullRequestEvent + type: object + properties: + action: + type: string + number: + type: integer + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + assignee: + $ref: '#/components/schemas/simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + label: + $ref: '#/components/schemas/label' + labels: + type: array + items: + $ref: '#/components/schemas/label' + required: + - action + - number + - pull_request + pull-request-review-comment-event: + title: PullRequestReviewCommentEvent + type: object + properties: + action: + type: string + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + comment: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + pull_request_review_id: + type: integer + nullable: true + diff_hunk: + type: string + path: + type: string + position: + type: integer + nullable: true + original_position: + type: integer + subject_type: + type: string + nullable: true + commit_id: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + body: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + original_commit_id: + type: string + reactions: + title: Reactions + type: object + properties: + '+1': + type: integer + '-1': + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + in_reply_to_id: + type: integer + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - _links + - reactions + required: + - action + - comment + - pull_request + pull-request-review-event: + title: PullRequestReviewEvent + type: object + properties: + action: + type: string + review: + type: object + properties: + id: + type: integer + node_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + commit_id: + type: string + submitted_at: + type: string + nullable: true + state: + type: string + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + updated_at: + type: string + pull_request: + $ref: '#/components/schemas/pull-request-minimal' + required: + - action + - review + - pull_request + commit-comment-event: + title: CommitCommentEvent + type: object + properties: + action: + type: string + comment: + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - action + - comment + release-event: + title: ReleaseEvent + type: object + properties: + action: + type: string + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: Specifies the commitish value that determines where the Git tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: true to create a draft (unpublished) release, false to create a published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + is_short_description_html_truncated: + type: boolean + short_description_html: + type: string + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + required: + - action + - release + watch-event: + title: WatchEvent + type: object + properties: + action: + type: string + required: + - action + link-with-type: + title: Link With Type + description: Hypermedia Link with Type + type: object + properties: + href: + type: string + type: + type: string + required: + - href + - type + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: string + nullable: true + answer_chosen_at: + type: string + nullable: true + answer_chosen_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + answer_html_url: + type: string + nullable: true + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + category: + type: object + properties: + created_at: + type: string + format: date-time + description: + type: string + emoji: + type: string + id: + type: integer + is_answerable: + type: boolean + name: + type: string + node_id: + type: string + repository_id: + type: integer + slug: + type: string + updated_at: + type: string + required: + - id + - repository_id + - emoji + - name + - description + - created_at + - updated_at + - slug + - is_answerable + comments: + type: integer + created_at: + type: string + format: date-time + html_url: + type: string + id: + type: integer + locked: + type: boolean + node_id: + type: string + number: + type: integer + reactions: + title: Reactions + type: object + properties: + '+1': + type: integer + '-1': + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + state: + type: string + description: |- + The current state of the discussion. + `converting` means that the discussion is being converted from an issue. + `transferring` means that the discussion is being transferred from another repository. + enum: + - open + - closed + - locked + - converting + - transferring + state_reason: + description: The reason for the current state + example: resolved + type: string + nullable: true + enum: + - resolved + - outdated + - duplicate + - reopened + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + format: int64 + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + labels: + type: array + items: + $ref: '#/components/schemas/label' + required: + - repository_url + - category + - answer_html_url + - answer_chosen_at + - answer_chosen_by + - html_url + - id + - node_id + - number + - title + - user + - state + - state_reason + - locked + - comments + - created_at + - updated_at + - active_lock_reason + - body + issue: + title: Issue + description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + label: + title: Label + description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + example: 208045946 + node_id: + type: string + example: MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + example: https://api.github.com/repositories/42/labels/bug + type: string + format: uri + name: + description: The name of the label. + example: bug + type: string + description: + description: Optional description of the label, such as its purpose. + type: string + example: Something isn't working + nullable: true + color: + description: '6-character hex code, without the leading #, identifying the color' + example: FFFFFF + type: string + default: + description: Whether this label comes by default in a new repository. + type: boolean + example: true + required: + - id + - node_id + - url + - name + - description + - color + - default + issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: Specifies the commitish value that determines where the Git tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: true to create a draft (unpublished) release, false to create a published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: Details about the selected option (only present for single_select fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + example: Team Environment + label: + type: string + nullable: true + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: string + nullable: true + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + $ref: '#/components/schemas/nullable-simple-user' + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + public-events-per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 15 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + all: + name: all + description: If `true`, show notifications marked as read. + in: query + required: false + schema: + type: boolean + default: false + participating: + name: participating + description: If `true`, only shows notifications in which the user is directly participating or mentioned. + in: query + required: false + schema: + type: boolean + default: false + since: + name: since + description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + before: + name: before + description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + thread-id: + name: thread_id + description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). + in: path + required: true + schema: + type: integer + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + sort-starred: + name: sort + description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + public-events-items: + value: + - id: '22249084947' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-07T07:50:26Z' + feed: + value: + timeline_url: https://github.com/timeline + user_url: https://github.com/{user} + current_user_public_url: https://github.com/octocat + current_user_url: https://github.com/octocat.private?token=abc123 + current_user_actor_url: https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: '' + current_user_organization_urls: + - https://github.com/organizations/github/octocat.private.atom?token=abc123 + security_advisories_url: https://github.com/security-advisories + _links: + timeline: + href: https://github.com/timeline + type: application/atom+xml + user: + href: https://github.com/{user} + type: application/atom+xml + current_user_public: + href: https://github.com/octocat + type: application/atom+xml + current_user: + href: https://github.com/octocat.private?token=abc123 + type: application/atom+xml + current_user_actor: + href: https://github.com/octocat.private.actor?token=abc123 + type: application/atom+xml + current_user_organization: + href: '' + type: '' + current_user_organizations: + - href: https://github.com/organizations/github/octocat.private.atom?token=abc123 + type: application/atom+xml + security_advisories: + href: https://github.com/security-advisories + type: application/atom+xml + public-repo-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + thread-items: + value: + - id: '1' + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + subject: + title: Greetings + url: https://api.github.com/repos/octokit/octokit.rb/issues/123 + latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 + type: Issue + reason: subscribed + unread: true + updated_at: '2014-11-07T22:01:45Z' + last_read_at: '2014-11-07T22:01:45Z' + url: https://api.github.com/notifications/threads/1 + subscription_url: https://api.github.com/notifications/threads/1/subscription + notifications-mark-read: + value: + message: Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background. + thread: + value: + id: '1' + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + subject: + title: Greetings + url: https://api.github.com/repos/octokit/octokit.rb/issues/123 + latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 + type: Issue + reason: subscribed + unread: true + updated_at: '2014-11-07T22:01:45Z' + last_read_at: '2014-11-07T22:01:45Z' + url: https://api.github.com/notifications/threads/1 + subscription_url: https://api.github.com/notifications/threads/1/subscription + thread-subscription: + value: + subscribed: true + ignored: false + reason: null + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/notifications/threads/1/subscription + thread_url: https://api.github.com/notifications/threads/1 + public-org-events-items: + value: + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + repo-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + simple-user-items-default-response: + summary: Default response + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + stargazer-items-alternative-response-with-star-creation-timestamps: + summary: Alternative response with star creation timestamps + value: + - starred_at: '2011-01-16T19:06:43Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository-subscription-response-if-you-subscribe-to-the-repository: + value: + subscribed: true + ignored: false + reason: null + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/repos/octocat/example/subscription + repository_url: https://api.github.com/repos/octocat/example + repository-subscription: + value: + subscribed: true + ignored: false + reason: null + created_at: '2012-10-06T21:34:12Z' + url: https://api.github.com/repos/octocat/example/subscription + repository_url: https://api.github.com/repos/octocat/example + repository-items-default-response: + summary: Default response + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + starred-repository-items-alternative-response-with-star-creation-timestamps: + summary: Alternative response with star creation timestamps + value: + - starred_at: '2011-01-16T19:06:43Z' + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + user-events-items: + value: + - id: '22249084947' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: false + created_at: '2022-06-07T07:50:26Z' + user-org-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: false + created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + - id: '22196946742' + type: CreateEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo + payload: + ref: master + ref_type: repository + full_ref: refs/heads/master + master_branch: master + description: null + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? + user-public-events-items: + value: + - id: '22249084947' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-08T23:29:25Z' + user-received-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22196946742' + type: CreateEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + ref: master + ref_type: repository + full_ref: refs/heads/master + master_branch: master + description: null + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + user-received-public-events-items: + value: + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + repository_id: 1296269 + push_id: 10115855396 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22196946742' + type: CreateEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + ref: master + ref_type: repository + full_ref: refs/heads/master + master_branch: master + description: null + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/agent_tasks.yaml b/provider-dev/source/agent_tasks.yaml new file mode 100644 index 0000000..a7a6fda --- /dev/null +++ b/provider-dev/source/agent_tasks.yaml @@ -0,0 +1,2390 @@ +openapi: 3.0.3 +info: + title: agent_tasks API + description: github API + version: 1.1.4 +paths: + /agents/repos/{owner}/{repo}/tasks: + get: + summary: List tasks for repository + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for a specific repository + tags: + - agent-tasks + operationId: agent-tasks/list-tasks-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks-for-repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + - name: creator_id + in: query + schema: + type: integer + description: Filter tasks by creator user ID + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="prev" (when current page > 1), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: | + Type of artifact. Available Values: `pull`, `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + post: + summary: Create a task + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Creates a new task for a repository. + tags: + - agent-tasks + operationId: agent-tasks/create-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#create-a-task + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - prompt + properties: + prompt: + type: string + description: The user's prompt for the agent + model: + type: string + description: 'The model to use for this task. The allowed models may change over time and depend on the user''s GitHub Copilot plan and organization policies. Currently supported values: `claude-sonnet-4.6`, `claude-opus-4.6`, `gpt-5.2-codex`, `gpt-5.3-codex`, `gpt-5.4`, `claude-sonnet-4.5`, `claude-opus-4.5`' + create_pull_request: + type: boolean + description: Whether to create a PR. + default: false + base_ref: + type: string + description: Base ref for new branch/PR + examples: + default: + value: + prompt: Fix the login button on the homepage + base_ref: main + responses: + '201': + description: Task created successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + description: The entity who created this task + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: | + Type of artifact. Available Values: `pull`, `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: queued + session_count: 1 + artifacts: [] + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T00:00:00Z' + '400': + description: Problems parsing JSON + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + /agents/repos/{owner}/{repo}/tasks/{task_id}: + get: + summary: Get a task by repo + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID scoped to an owner/repo path + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-repo-and-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: owner + in: path + required: true + schema: + type: string + description: The account owner of the repository. The name is not case sensitive. + - name: repo + in: path + required: true + schema: + type: string + description: The name of the repository. The name is not case sensitive. + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: | + Type of artifact. Available Values: `pull`, `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + prompt: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + model: claude-sonnet-4.6 + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + /agents/tasks: + get: + summary: List tasks + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a list of tasks for the authenticated user + tags: + - agent-tasks + operationId: agent-tasks/list-tasks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#list-tasks + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: per_page + in: query + schema: + type: integer + default: 30 + minimum: 1 + maximum: 100 + description: The number of results per page (max 100). + - name: page + in: query + schema: + type: integer + default: 1 + minimum: 1 + description: The page number of the results to fetch. + - name: sort + in: query + schema: + type: string + default: updated_at + enum: + - updated_at + - created_at + description: The field to sort results by. Can be `updated_at` or `created_at`. + - name: direction + in: query + schema: + type: string + default: desc + enum: + - asc + - desc + description: The direction to sort results. Can be `asc` or `desc`. + - name: state + in: query + schema: + type: string + description: 'Comma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`.' + - name: is_archived + in: query + schema: + type: boolean + default: false + description: Filter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`. + - name: since + in: query + schema: + type: string + format: date-time + description: Only show tasks updated at or after this time (ISO 8601 timestamp) + responses: + '200': + description: Tasks retrieved successfully + headers: + Link: + description: | + Pagination links. Contains rel="first" (always), + rel="next" (when more pages exist), and rel="last" (when on the final page). + schema: + type: string + example: ; rel="next", ; rel="first" + content: + application/json: + schema: + type: object + required: + - tasks + properties: + tasks: + type: array + items: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: | + Type of artifact. Available Values: `pull`, `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + description: List of tasks + total_active_count: + type: integer + format: int32 + description: Total count of active (non-archived) tasks + total_archived_count: + type: integer + format: int32 + description: Total count of archived tasks + examples: + default: + value: + tasks: + - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + '400': + description: Bad request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks + /agents/tasks/{task_id}: + get: + summary: Get a task by ID + description: | + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Returns a task by ID with its associated sessions + tags: + - agent-tasks + operationId: agent-tasks/get-task-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/agent-tasks/agent-tasks#get-a-task-by-id + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: agent-tasks + subcategory: agent-tasks + parameters: + - name: task_id + in: path + required: true + schema: + type: string + description: The unique identifier of the task. + responses: + '200': + description: Task retrieved successfully + content: + application/json: + schema: + type: object + required: + - id + - state + - created_at + properties: + id: + type: string + description: Unique task identifier + url: + type: string + description: API URL for this task + html_url: + type: string + description: Web URL for this task + name: + type: string + description: Human-readable name derived from the task prompt + creator: + oneOf: + - type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: The entity who created this task + creator_type: + type: string + description: Type of the task creator + enum: + - user + - organization + user_collaborators: + type: array + items: + type: object + description: A GitHub user + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + description: User objects of collaborators on this task + deprecated: true + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this task belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + state: + type: string + description: Current state of the task, derived from its most recent session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + session_count: + type: integer + format: int32 + description: Number of sessions in this task + artifacts: + type: array + items: + type: object + description: A resource generated by the task + required: + - provider + - type + - data + properties: + provider: + type: string + enum: + - github + description: Provider namespace + type: + type: string + enum: + - pull + - branch + description: | + Type of artifact. Available Values: `pull`, `branch`. + data: + oneOf: + - type: object + description: A GitHub resource (pull request, issue, etc.) + required: + - id + properties: + id: + type: integer + format: int64 + description: GitHub resource ID + global_id: + type: string + description: GraphQL global ID + - type: object + description: A Git branch reference + required: + - head_ref + - base_ref + properties: + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + description: Resource data (shape depends on type) + description: Resources created by this task (PRs, branches, etc.) + archived_at: + type: string + format: date-time + nullable: true + description: Timestamp when the task was archived, null if not archived + updated_at: + type: string + format: date-time + description: Timestamp of the most recent update + created_at: + type: string + format: date-time + description: Timestamp when the task was created + sessions: + type: array + items: + type: object + description: Full session details within a task + required: + - id + - state + - created_at + properties: + id: + type: string + description: Session ID + name: + type: string + description: Session name + user: + description: The user who created this session + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + owner: + description: The owner of the repository + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the user + repository: + description: The repository this session belongs to + type: object + properties: + id: + type: integer + format: int64 + description: The unique identifier of the repository + task_id: + type: string + description: Task ID this session belongs to + state: + type: string + description: Current state of a session + enum: + - queued + - in_progress + - completed + - failed + - idle + - waiting_for_user + - timed_out + - cancelled + created_at: + type: string + format: date-time + description: Creation timestamp + updated_at: + type: string + format: date-time + description: Last update timestamp + completed_at: + type: string + format: date-time + description: Completion timestamp + prompt: + type: string + description: Content of the triggering event + head_ref: + type: string + description: Head branch name + base_ref: + type: string + description: Base branch name + model: + type: string + description: Model used for this session + error: + type: object + description: Error details for a failed session + properties: + message: + type: string + description: Error message + description: Sessions associated with this task + examples: + default: + value: + id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + url: https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + html_url: https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + creator: + id: 1 + creator_type: user + owner: + id: 1 + repository: + id: 1296269 + state: completed + session_count: 1 + artifacts: + - provider: github + type: pull + data: + id: 42 + archived_at: null + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + sessions: + - id: s1a2b3c4-d5e6-7890-abcd-ef1234567890 + name: Fix the login button on the homepage + user: + id: 1 + owner: + id: 1 + repository: + id: 1296269 + task_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 + state: completed + created_at: '2025-01-01T00:00:00Z' + updated_at: '2025-01-01T01:00:00Z' + completed_at: '2025-01-01T01:00:00Z' + prompt: Fix the login button on the homepage + head_ref: copilot/fix-1 + base_ref: main + model: claude-sonnet-4.6 + '400': + description: Problems parsing request + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '401': + description: Authentication required + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '403': + description: Insufficient permissions + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '404': + description: Resource not found + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + '422': + description: Validation Failed + content: + application/json: + schema: + type: object + description: |- + Structured error response following GitHub REST API conventions. + For 422 Unprocessable Entity the errors array contains validation + details; for other error status codes only message and + documentation_url are returned. + required: + - message + - documentation_url + properties: + message: + type: string + description: Summary message (e.g. "Validation Failed", "Not Found") + errors: + type: array + items: + type: object + description: A single validation error + required: + - code + properties: + code: + type: string + enum: + - missing + - missing_field + - invalid + - already_exists + - unprocessable + - custom + description: Machine-readable error code + message: + type: string + description: Human-readable message (populated when code is "custom") + description: List of validation errors (present only for 422 responses) + documentation_url: + type: string + description: URL to relevant API documentation + x-stackQL-resource: agent_tasks +components: {} +servers: + - url: https://api.github.com diff --git a/provider-dev/source/apps.yaml b/provider-dev/source/apps.yaml new file mode 100644 index 0000000..75aa7a5 --- /dev/null +++ b/provider-dev/source/apps.yaml @@ -0,0 +1,6572 @@ +openapi: 3.0.3 +info: + title: apps API + description: Information for integrations and installations. + version: 1.1.4 +paths: + /app: + get: + summary: Get the authenticated app + description: |- + Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-the-authenticated-app + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app-manifests/{code}/conversions: + post: + summary: Create a GitHub App from a manifest + description: Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + tags: + - apps + operationId: apps/create-from-manifest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest + parameters: + - name: code + in: path + required: true + schema: + type: string + responses: + '201': + description: Response + content: + application/json: + schema: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + client_secret: + type: string + webhook_secret: + type: string + nullable: true + pem: + type: string + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + - client_id + - client_secret + - webhook_secret + - pem + additionalProperties: true + examples: + default: + $ref: '#/components/examples/integration-from-manifest' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/hook/config: + get: + summary: Get a webhook configuration for an app + description: |- + Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-webhook-config-for-app + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a webhook configuration for an app + description: |- + Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/update-webhook-config-for-app + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + examples: + default: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/hook/deliveries: + get: + summary: List deliveries for an app webhook + description: |- + Returns a list of webhook deliveries for the webhook configured for a GitHub App. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/list-webhook-deliveries + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/cursor' + - $ref: '#/components/parameters/webhook-delivery-status' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook-delivery-item' + examples: + default: + $ref: '#/components/examples/hook-delivery-items' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/hook/deliveries/{delivery_id}: + get: + summary: Get a delivery for an app webhook + description: |- + Returns a delivery for the webhook configured for a GitHub App. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-webhook-delivery + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook + parameters: + - $ref: '#/components/parameters/delivery-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook-delivery' + examples: + default: + $ref: '#/components/examples/hook-delivery' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/hook/deliveries/{delivery_id}/attempts: + post: + summary: Redeliver a delivery for an app webhook + description: |- + Redeliver a delivery for the webhook configured for a GitHub App. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/redeliver-webhook-delivery + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook + parameters: + - $ref: '#/components/parameters/delivery-id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: webhooks + x-stackQL-resource: webhooks + /app/installation-requests: + get: + summary: List installation requests for the authenticated app + description: Lists all the pending installation requests for the authenticated GitHub App. + tags: + - apps + operationId: apps/list-installation-requests-for-authenticated-app + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: List of integration installation requests + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration-installation-request' + examples: + exampleKey1: + $ref: '#/components/examples/integration-installation-request-paginated' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/installations: + get: + summary: List installations for the authenticated app + description: |- + The permissions the installation has are included under the `permissions` key. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/list-installations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/since' + - name: outdated + in: query + required: false + schema: + type: string + responses: + '200': + description: The permissions the installation has are included under the `permissions` key. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/base-installation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/installations/{installation_id}: + get: + summary: Get an installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find an installation's information using the installation id. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/base-installation' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + delete: + summary: Delete an installation for the authenticated app + description: |- + Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/delete-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-github-breaking-changes: + - changeset: change_delete_installation_success_status + patch: + responses: + '202': + description: Response + '204': null + version: '2026-03-10' + x-stackQL-resource: apps + /app/installations/{installation_id}/access_tokens: + post: + summary: Create an installation access token for an app + description: |- + Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + + Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + + Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/create-installation-access-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app + parameters: + - $ref: '#/components/parameters/installation-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + repositories: + description: List of repository names that the token should have access to + type: array + items: + type: string + example: rails + repository_ids: + description: List of repository IDs that the token should have access to + example: + - 1 + type: array + items: + type: integer + permissions: + $ref: '#/components/schemas/app-permissions' + examples: + default: + value: + repositories: + - Hello-World + permissions: + issues: write + contents: read + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation-token' + examples: + default: + $ref: '#/components/examples/installation-token' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /app/installations/{installation_id}/suspended: + put: + summary: Suspend an app installation + description: |- + Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/suspend-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#suspend-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + delete: + summary: Unsuspend an app installation + description: |- + Removes a GitHub App installation suspension. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/unsuspend-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /applications/{client_id}/grant: + delete: + summary: Delete an app authorization + description: |- + OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. + Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + operationId: apps/delete-authorization + tags: + - apps + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + description: The OAuth access token used to authenticate to the GitHub API. + required: + - access_token + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + /applications/{client_id}/token: + post: + summary: Check a token + description: OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. + tags: + - apps + operationId: apps/check-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/oauth-applications#check-a-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + access_token: + description: The access_token of the OAuth or GitHub application. + type: string + required: + - access_token + type: object + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authorization' + examples: + default: + $ref: '#/components/examples/authorization-with-user' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + patch: + summary: Reset a token + description: OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. + tags: + - apps + operationId: apps/reset-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/oauth-applications#reset-a-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + access_token: + description: The access_token of the OAuth or GitHub application. + type: string + required: + - access_token + type: object + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authorization' + examples: + default: + $ref: '#/components/examples/authorization-with-user' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + delete: + summary: Delete an app token + description: OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. + tags: + - apps + operationId: apps/delete-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + description: The OAuth access token used to authenticate to the GitHub API. + required: + - access_token + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: oauth-applications + x-stackQL-resource: oauth_applications + /applications/{client_id}/token/scoped: + post: + summary: Create a scoped access token + description: |- + Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + which repositories the token can access and which permissions are granted to the + token. + + Invalid tokens will return `404 NOT FOUND`. + tags: + - apps + operationId: apps/scope-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#create-a-scoped-access-token + parameters: + - $ref: '#/components/parameters/client-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + access_token: + type: string + description: The access token used to authenticate to the GitHub API. + example: e72e16c7e42f292c6912e7710c838347ae178b4a + target: + description: The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified. + type: string + example: octocat + target_id: + description: The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified. + example: 1 + type: integer + repositories: + description: The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. + type: array + items: + type: string + example: rails + repository_ids: + description: The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. + example: + - 1 + type: array + items: + type: integer + permissions: + $ref: '#/components/schemas/app-permissions' + required: + - access_token + examples: + default: + value: + access_token: e72e16c7e42f292c6912e7710c838347ae178b4a + target: octocat + permissions: + metadata: read + issues: write + contents: read + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/authorization' + examples: + default: + $ref: '#/components/examples/scope-token' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /apps/{app_slug}: + get: + summary: Get an app + description: |- + > [!NOTE] + > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + tags: + - apps + operationId: apps/get-by-slug + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-an-app + parameters: + - $ref: '#/components/parameters/app-slug' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: apps + x-stackQL-resource: apps + /installation/repositories: + get: + summary: List repositories accessible to the app installation + description: List repositories that an app installation can access. + tags: + - apps + operationId: apps/list-repos-accessible-to-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + repository_selection: + type: string + example: selected + examples: + default: + $ref: '#/components/examples/repository-paginated-2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: installations + x-stackQL-resource: installations + /installation/token: + delete: + summary: Revoke an installation access token + description: |- + Revokes the installation token you're using to authenticate as an installation and access this endpoint. + + Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + tags: + - apps + operationId: apps/revoke-installation-access-token + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token + parameters: [] + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: apps + subcategory: installations + x-stackQL-resource: installations + /marketplace_listing/accounts/{account_id}: + get: + summary: Get a subscription plan for an account + description: |- + Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + + GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/get-subscription-plan-for-account + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account + parameters: + - $ref: '#/components/parameters/account-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + description: Not Found when the account has not purchased the listing + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/plans: + get: + summary: List plans + description: |- + Lists all plans that are part of your GitHub Marketplace listing. + + GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-plans + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-plans + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-listing-plan' + examples: + default: + $ref: '#/components/examples/marketplace-listing-plan-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/plans/{plan_id}/accounts: + get: + summary: List accounts for a plan + description: |- + Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + + GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-accounts-for-plan + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan + parameters: + - $ref: '#/components/parameters/plan-id' + - $ref: '#/components/parameters/sort' + - name: direction + description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/stubbed/accounts/{account_id}: + get: + summary: Get a subscription plan for an account (stubbed) + description: |- + Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + + GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/get-subscription-plan-for-account-stubbed + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed + parameters: + - $ref: '#/components/parameters/account-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + description: Not Found when the account has not purchased the listing + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/stubbed/plans: + get: + summary: List plans (stubbed) + description: |- + Lists all plans that are part of your GitHub Marketplace listing. + + GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-plans-stubbed + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-plans-stubbed + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-listing-plan' + examples: + default: + $ref: '#/components/examples/marketplace-listing-plan-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /marketplace_listing/stubbed/plans/{plan_id}/accounts: + get: + summary: List accounts for a plan (stubbed) + description: |- + Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. + + GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + tags: + - apps + operationId: apps/list-accounts-for-plan-stubbed + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed + parameters: + - $ref: '#/components/parameters/plan-id' + - $ref: '#/components/parameters/sort' + - name: direction + description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/marketplace-purchase' + examples: + default: + $ref: '#/components/examples/marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /orgs/{org}/installation: + get: + summary: Get an organization installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find the organization's installation information. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-org-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /repos/{owner}/{repo}/installation: + get: + summary: Get a repository installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-repo-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps + /user/installations: + get: + summary: List app installations accessible to the user access token + description: |- + Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + + The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + + You can find the permissions for the installation under the `permissions` key. + tags: + - apps + operationId: apps/list-installations-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: You can find the permissions for the installation under the `permissions` key. + content: + application/json: + schema: + type: object + required: + - total_count + - installations + properties: + total_count: + type: integer + installations: + type: array + items: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/base-installation-for-auth-user-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + /user/installations/{installation_id}/repositories: + get: + summary: List repositories accessible to the user access token + description: |- + List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. + + The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + + The access the user has to each repository is included in the hash under the `permissions` key. + tags: + - apps + operationId: apps/list-installation-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token + parameters: + - $ref: '#/components/parameters/installation-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: The access the user has to each repository is included in the hash under the `permissions` key. + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repository_selection: + type: string + repositories: + type: array + items: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + examples: + default: + $ref: '#/components/examples/repository-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + /user/installations/{installation_id}/repositories/{repository_id}: + put: + summary: Add a repository to an app installation + description: |- + Add a single repository to an installation. The authenticated user must have admin access to the repository. + + This endpoint only works for PATs (classic) with the `repo` scope. + tags: + - apps + operationId: apps/add-repo-to-installation-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + delete: + summary: Remove a repository from an app installation + description: |- + Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. + + This endpoint only works for PATs (classic) with the `repo` scope. + tags: + - apps + operationId: apps/remove-repo-from-installation-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation + parameters: + - $ref: '#/components/parameters/installation-id' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: installations + x-stackQL-resource: installations + /user/marketplace_purchases: + get: + summary: List subscriptions for the authenticated user + description: Lists the active subscriptions for the authenticated user. + tags: + - apps + operationId: apps/list-subscriptions-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/user-marketplace-purchase' + examples: + default: + $ref: '#/components/examples/user-marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /user/marketplace_purchases/stubbed: + get: + summary: List subscriptions for the authenticated user (stubbed) + description: Lists the active subscriptions for the authenticated user. + tags: + - apps + operationId: apps/list-subscriptions-for-authenticated-user-stubbed + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/user-marketplace-purchase' + examples: + default: + $ref: '#/components/examples/user-marketplace-purchase-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: marketplace + x-stackQL-resource: marketplace + /users/{username}/installation: + get: + summary: Get a user installation for the authenticated app + description: |- + Enables an authenticated GitHub App to find the user’s installation information. + + You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + tags: + - apps + operationId: apps/get-user-installation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app + parameters: + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: apps + subcategory: apps + x-stackQL-resource: apps +components: + schemas: + integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + webhook-config: + title: Webhook Configuration + description: Configuration object of the webhook + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + webhook-config-url: + type: string + description: The URL to which the payloads will be delivered. + example: https://example.com/webhook + format: uri + webhook-config-content-type: + type: string + description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. + example: '"json"' + webhook-config-secret: + type: string + description: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + example: '"********"' + webhook-config-insecure-ssl: + type: string + description: Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** + example: '"0"' + hook-delivery-item: + title: Simple webhook delivery + description: Delivery made by a webhook, without request and response information. + type: object + properties: + id: + description: Unique identifier of the webhook delivery. + type: integer + format: int64 + example: 42 + guid: + description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + hook-delivery: + title: Webhook delivery + description: Delivery made by a webhook. + type: object + properties: + id: + description: Unique identifier of the delivery. + type: integer + example: 42 + guid: + description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Description of the status of the attempted delivery + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + url: + description: The URL target of the delivery. + type: string + example: https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: object + nullable: true + additionalProperties: true + payload: + description: The webhook payload. + type: object + nullable: true + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: object + nullable: true + additionalProperties: true + payload: + description: The response payload received. + type: string + nullable: true + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + integration-installation-request: + title: Integration Installation Request + description: Request to install an integration on a target + type: object + properties: + id: + description: Unique identifier of the request installation. + type: integer + example: 42 + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + account: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + requester: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-07-08T16:18:44-04:00' + required: + - id + - account + - requester + - created_at + installation: + title: Installation + description: Installation + type: object + properties: + id: + description: The ID of the installation. + type: integer + example: 1 + account: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + repository_selection: + description: Describe whether all repositories have been selected or there's a selection involved + type: string + enum: + - all + - selected + access_tokens_url: + type: string + format: uri + example: https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + example: https://api.github.com/installation/repositories + html_url: + type: string + format: uri + example: https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + example: 1 + client_id: + type: string + example: Iv1.ab1112223334445c + target_id: + description: The ID of the user or organization this token is being scoped to. + type: integer + target_type: + type: string + example: Organization + permissions: + $ref: '#/components/schemas/app-permissions' + events: + type: array + items: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + single_file_name: + type: string + example: config.yaml + nullable: true + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: + type: string + example: github-actions + suspended_by: + $ref: '#/components/schemas/nullable-simple-user' + suspended_at: + type: string + format: date-time + nullable: true + contact_email: + type: string + example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + nullable: true + required: + - id + - app_id + - app_slug + - target_id + - target_type + - single_file_name + - repository_selection + - access_tokens_url + - html_url + - repositories_url + - events + - account + - permissions + - created_at + - updated_at + - suspended_by + - suspended_at + app-permissions: + title: App Permissions + type: object + description: The permissions granted to the user access token. + properties: + actions: + type: string + description: The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. + enum: + - read + - write + administration: + type: string + description: The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. + enum: + - read + - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create and retrieve build artifact metadata records. + enum: + - read + - write + attestations: + type: string + description: The level of permission to create and retrieve the access token for repository attestations. + enum: + - read + - write + checks: + type: string + description: The level of permission to grant the access token for checks on code. + enum: + - read + - write + codespaces: + type: string + description: The level of permission to grant the access token to create, edit, delete, and list Codespaces. + enum: + - read + - write + contents: + type: string + description: The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. + enum: + - read + - write + dependabot_secrets: + type: string + description: The level of permission to grant the access token to manage Dependabot secrets. + enum: + - read + - write + deployments: + type: string + description: The level of permission to grant the access token for deployments and deployment statuses. + enum: + - read + - write + discussions: + type: string + description: The level of permission to grant the access token for discussions and related comments and labels. + enum: + - read + - write + environments: + type: string + description: The level of permission to grant the access token for managing repository environments. + enum: + - read + - write + issues: + type: string + description: The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. + enum: + - read + - write + merge_queues: + type: string + description: The level of permission to grant the access token to manage the merge queues for a repository. + enum: + - read + - write + metadata: + type: string + description: The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. + enum: + - read + - write + packages: + type: string + description: The level of permission to grant the access token for packages published to GitHub Packages. + enum: + - read + - write + pages: + type: string + description: The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. + enum: + - read + - write + pull_requests: + type: string + description: The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. + enum: + - read + - write + repository_custom_properties: + type: string + description: The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + enum: + - read + - write + repository_hooks: + type: string + description: The level of permission to grant the access token to manage the post-receive hooks for a repository. + enum: + - read + - write + repository_projects: + type: string + description: The level of permission to grant the access token to manage repository projects, columns, and cards. + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + description: The level of permission to grant the access token to view and manage secret scanning alerts. + enum: + - read + - write + secrets: + type: string + description: The level of permission to grant the access token to manage repository secrets. + enum: + - read + - write + security_events: + type: string + description: The level of permission to grant the access token to view and manage security events like code scanning alerts. + enum: + - read + - write + single_file: + type: string + description: The level of permission to grant the access token to manage just a single file. + enum: + - read + - write + statuses: + type: string + description: The level of permission to grant the access token for commit statuses. + enum: + - read + - write + vulnerability_alerts: + type: string + description: The level of permission to grant the access token to manage Dependabot alerts. + enum: + - read + - write + workflows: + type: string + description: The level of permission to grant the access token to update GitHub Actions workflow files. + enum: + - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + enum: + - read + - write + members: + type: string + description: The level of permission to grant the access token for organization teams and members. + enum: + - read + - write + organization_administration: + type: string + description: The level of permission to grant the access token to manage access to an organization. + enum: + - read + - write + organization_custom_roles: + type: string + description: The level of permission to grant the access token for custom repository roles management. + enum: + - read + - write + organization_custom_org_roles: + type: string + description: The level of permission to grant the access token for custom organization roles management. + enum: + - read + - write + organization_custom_properties: + type: string + description: The level of permission to grant the access token for repository custom properties management at the organization level. + enum: + - read + - write + - admin + organization_copilot_seat_management: + type: string + description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. + enum: + - write + organization_copilot_agent_settings: + type: string + description: The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization. + enum: + - read + - write + organization_announcement_banners: + type: string + description: The level of permission to grant the access token to view and manage announcement banners for an organization. + enum: + - read + - write + organization_events: + type: string + description: The level of permission to grant the access token to view events triggered by an activity in an organization. + enum: + - read + organization_hooks: + type: string + description: The level of permission to grant the access token to manage the post-receive hooks for an organization. + enum: + - read + - write + organization_personal_access_tokens: + type: string + description: The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. + enum: + - read + - write + organization_personal_access_token_requests: + type: string + description: The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. + enum: + - read + - write + organization_plan: + type: string + description: The level of permission to grant the access token for viewing an organization's plan. + enum: + - read + organization_projects: + type: string + description: The level of permission to grant the access token to manage organization projects and projects public preview (where available). + enum: + - read + - write + - admin + organization_packages: + type: string + description: The level of permission to grant the access token for organization packages published to GitHub Packages. + enum: + - read + - write + organization_secrets: + type: string + description: The level of permission to grant the access token to manage organization secrets. + enum: + - read + - write + organization_self_hosted_runners: + type: string + description: The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. + enum: + - read + - write + organization_user_blocking: + type: string + description: The level of permission to grant the access token to view and manage users blocked by the organization. + enum: + - read + - write + email_addresses: + type: string + description: The level of permission to grant the access token to manage the email addresses belonging to a user. + enum: + - read + - write + followers: + type: string + description: The level of permission to grant the access token to manage the followers belonging to a user. + enum: + - read + - write + git_ssh_keys: + type: string + description: The level of permission to grant the access token to manage git SSH keys. + enum: + - read + - write + gpg_keys: + type: string + description: The level of permission to grant the access token to view and manage GPG keys belonging to a user. + enum: + - read + - write + interaction_limits: + type: string + description: The level of permission to grant the access token to view and manage interaction limits on a repository. + enum: + - read + - write + profile: + type: string + description: The level of permission to grant the access token to manage the profile settings belonging to a user. + enum: + - write + starring: + type: string + description: The level of permission to grant the access token to list and manage repositories a user is starring. + enum: + - read + - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization custom properties management at the enterprise level. + enum: + - read + - write + - admin + example: + contents: read + issues: read + deployments: write + single_file: read + installation-token: + title: Installation Token + description: Authentication token for a GitHub App installed on a user or org. + type: object + properties: + token: + type: string + expires_at: + type: string + permissions: + $ref: '#/components/schemas/app-permissions' + repository_selection: + type: string + enum: + - all + - selected + repositories: + type: array + items: + $ref: '#/components/schemas/repository' + single_file: + type: string + example: README.md + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + required: + - token + - expires_at + authorization: + title: Authorization + description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + format: uri + scopes: + description: A list of scopes that this authorization is in. + type: array + items: + type: string + nullable: true + token: + type: string + token_last_eight: + type: string + nullable: true + hashed_token: + type: string + nullable: true + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + note: + type: string + nullable: true + note_url: + type: string + format: uri + nullable: true + updated_at: + type: string + format: date-time + created_at: + type: string + format: date-time + fingerprint: + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + installation: + $ref: '#/components/schemas/nullable-scoped-installation' + expires_at: + type: string + format: date-time + nullable: true + required: + - app + - id + - note + - note_url + - scopes + - token + - hashed_token + - token_last_eight + - fingerprint + - url + - created_at + - updated_at + - expires_at + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + marketplace-purchase: + title: Marketplace Purchase + description: Marketplace Purchase + type: object + properties: + url: + type: string + type: + type: string + id: + type: integer + login: + type: string + organization_billing_email: + type: string + email: + type: string + nullable: true + marketplace_pending_change: + type: object + properties: + is_installed: + type: boolean + effective_date: + type: string + unit_count: + type: integer + nullable: true + id: + type: integer + plan: + $ref: '#/components/schemas/marketplace-listing-plan' + nullable: true + marketplace_purchase: + type: object + properties: + billing_cycle: + type: string + next_billing_date: + type: string + nullable: true + is_installed: + type: boolean + unit_count: + type: integer + nullable: true + on_free_trial: + type: boolean + free_trial_ends_on: + type: string + nullable: true + updated_at: + type: string + plan: + $ref: '#/components/schemas/marketplace-listing-plan' + required: + - url + - id + - type + - login + - marketplace_purchase + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + marketplace-listing-plan: + title: Marketplace Listing Plan + description: Marketplace Listing Plan + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: + type: string + format: uri + example: https://api.github.com/marketplace_listing/plans/1313/accounts + id: + type: integer + example: 1313 + number: + type: integer + example: 3 + name: + type: string + example: Pro + description: + type: string + example: A professional-grade CI solution + monthly_price_in_cents: + type: integer + example: 1099 + yearly_price_in_cents: + type: integer + example: 11870 + price_model: + type: string + enum: + - FREE + - FLAT_RATE + - PER_UNIT + example: FLAT_RATE + has_free_trial: + type: boolean + example: true + unit_name: + type: string + nullable: true + state: + type: string + example: published + bullets: + type: array + items: + type: string + example: + - Up to 25 private repositories + - 11 concurrent builds + required: + - url + - accounts_url + - id + - number + - name + - description + - has_free_trial + - price_model + - unit_name + - monthly_price_in_cents + - state + - yearly_price_in_cents + - bullets + user-marketplace-purchase: + title: User Marketplace Purchase + description: User Marketplace Purchase + type: object + properties: + billing_cycle: + type: string + example: monthly + next_billing_date: + type: string + format: date-time + example: '2017-11-11T00:00:00Z' + nullable: true + unit_count: + type: integer + nullable: true + on_free_trial: + type: boolean + example: true + free_trial_ends_on: + type: string + format: date-time + example: '2017-11-11T00:00:00Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2017-11-02T01:12:12Z' + nullable: true + account: + $ref: '#/components/schemas/marketplace-account' + plan: + $ref: '#/components/schemas/marketplace-listing-plan' + required: + - billing_cycle + - next_billing_date + - unit_count + - updated_at + - on_free_trial + - free_trial_ends_on + - account + - plan + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-scoped-installation: + title: Scoped Installation + type: object + properties: + permissions: + $ref: '#/components/schemas/app-permissions' + repository_selection: + description: Describe whether all repositories have been selected or there's a selection involved + type: string + enum: + - all + - selected + single_file_name: + type: string + example: config.yaml + nullable: true + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + repositories_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + account: + $ref: '#/components/schemas/simple-user' + required: + - permissions + - repository_selection + - single_file_name + - repositories_url + - account + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + marketplace-account: + title: Marketplace Account + type: object + properties: + url: + type: string + format: uri + id: + type: integer + type: + type: string + node_id: + type: string + login: + type: string + email: + type: string + nullable: true + format: email + organization_billing_email: + type: string + nullable: true + format: email + required: + - url + - id + - type + - login + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + cursor: + name: cursor + description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.' + in: query + required: false + schema: + type: string + webhook-delivery-status: + name: status + description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive). + in: query + required: false + schema: + type: string + enum: + - success + - failure + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + since: + name: since + description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + installation-id: + name: installation_id + description: The unique identifier of the installation. + in: path + required: true + schema: + type: integer + examples: + default: + value: 1 + client-id: + name: client_id + in: path + required: true + description: The client ID of the GitHub app. + schema: + type: string + examples: + default: + value: Iv1.8a61f9b3a7aba766 + app-slug: + name: app_slug + in: path + required: true + schema: + type: string + account-id: + name: account_id + description: account_id parameter + in: path + required: true + schema: + type: integer + plan-id: + name: plan_id + description: The unique identifier of the plan. + in: path + required: true + schema: + type: integer + sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + integration: + value: + id: 1 + slug: octoapp + client_id: Iv1.ab1112223334445c + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + integration-from-manifest: + value: + id: 1 + slug: octoapp + node_id: MDxOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + client_id: Iv1.8a61f9b3a7aba766 + client_secret: 1726be1638095a19edd134c77bde3aa2ece1e5d8 + webhook_secret: e340154128314309424b7c8e90325147d99fdafa + pem: | + -----BEGIN RSA PRIVATE KEY----- + MIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM + 9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP + X0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/ + 6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm + oNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma + szdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ + dBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva + KOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo + gDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP + kYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX + NuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd + NBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE + ZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG + J4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv + eDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3 + FI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk + 77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH + Pza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB + 1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c + 57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8 + M5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic + I9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN + 6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK + fgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG + ZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu + -----END RSA PRIVATE KEY----- + webhook-config: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + hook-delivery-items: + value: + - id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: '2019-06-03T00:57:16Z' + - id: 123456789 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-04T00:57:16Z' + redelivery: true + duration: 0.28 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: null + hook-delivery: + value: + id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + url: https://www.example.com + throttled_at: '2019-06-03T00:57:16Z' + request: + headers: + X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + Accept: '*/*' + X-GitHub-Hook-ID: '42' + User-Agent: GitHub-Hookshot/b8c71d8 + X-GitHub-Event: issues + X-GitHub-Hook-Installation-Target-ID: '123' + X-GitHub-Hook-Installation-Target-Type: repository + content-type: application/json + X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + payload: + action: opened + issue: + body: foo + repository: + id: 123 + response: + headers: + Content-Type: text/html;charset=utf-8 + payload: ok + integration-installation-request-paginated: + value: + - id: 25381 + node_id: MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA== + account: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + requester: + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2022-07-08T16:18:44-04:00' + base-installation-items: + value: + - id: 1 + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: selected + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + base-installation: + value: + id: 1 + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: selected + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + installation-token: + value: + token: ghs_16C7e42F292c6912E7710c838347Ae178B4a + expires_at: '2016-07-11T22:14:10Z' + permissions: + issues: write + contents: read + repository_selection: selected + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + authorization-with-user: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + - user + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: Iv1.8a61f9b3a7aba766 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + fingerprint: jklmnop12345678 + expires_at: '2011-09-08T17:26:27Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + scope-token: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: [] + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: Iv1.8a61f9b3a7aba766 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + fingerprint: jklmnop12345678 + expires_at: '2011-09-08T17:26:27Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + installation: + permissions: + metadata: read + issues: write + contents: read + repository_selection: selected + single_file_name: .github/workflow.yml + repositories_url: https://api.github.com/user/repos + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + has_multiple_single_files: false + single_file_paths: [] + repository-paginated-2: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + marketplace-purchase: + value: + url: https://api.github.com/orgs/github + type: Organization + id: 4 + login: github + organization_billing_email: billing@github.com + email: billing@github.com + marketplace_pending_change: + effective_date: '2017-11-11T00:00:00Z' + unit_count: null + id: 77 + plan: + url: https://api.github.com/marketplace_listing/plans/1111 + accounts_url: https://api.github.com/marketplace_listing/plans/1111/accounts + id: 1111 + number: 2 + name: Startup + description: A professional-grade CI solution + monthly_price_in_cents: 699 + yearly_price_in_cents: 7870 + price_model: FLAT_RATE + has_free_trial: true + state: published + unit_name: null + bullets: + - Up to 10 private repositories + - 3 concurrent builds + marketplace_purchase: + billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: null + on_free_trial: true + free_trial_ends_on: '2017-11-11T00:00:00Z' + updated_at: '2017-11-02T01:12:12Z' + plan: + url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + marketplace-listing-plan-items: + value: + - url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + marketplace-purchase-items: + value: + - url: https://api.github.com/orgs/github + type: Organization + id: 4 + login: github + organization_billing_email: billing@github.com + marketplace_pending_change: + effective_date: '2017-11-11T00:00:00Z' + unit_count: null + id: 77 + plan: + url: https://api.github.com/marketplace_listing/plans/1111 + accounts_url: https://api.github.com/marketplace_listing/plans/1111/accounts + id: 1111 + number: 2 + name: Startup + description: A professional-grade CI solution + monthly_price_in_cents: 699 + yearly_price_in_cents: 7870 + price_model: FLAT_RATE + has_free_trial: true + state: published + unit_name: null + bullets: + - Up to 10 private repositories + - 3 concurrent builds + marketplace_purchase: + billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: null + on_free_trial: true + free_trial_ends_on: '2017-11-11T00:00:00Z' + updated_at: '2017-11-02T01:12:12Z' + plan: + url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + installation: + value: + id: 1 + account: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/orgs/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + repository_selection: all + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + client_id: Iv1.ab1112223334445c + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + created_at: '2018-02-09T20:51:14Z' + updated_at: '2018-02-09T20:51:14Z' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: github-actions + suspended_at: null + suspended_by: null + base-installation-for-auth-user-paginated: + value: + total_count: 2 + installations: + - id: 1 + account: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: all + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + - id: 3 + account: + login: octocat + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + access_tokens_url: https://api.github.com/app/installations/1/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/github/settings/installations/1 + app_id: 1 + target_id: 1 + target_type: Organization + permissions: + checks: write + metadata: read + contents: read + events: + - push + - pull_request + single_file_name: config.yaml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + repository_selection: all + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app_slug: github-actions + suspended_at: null + suspended_by: null + repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + user-marketplace-purchase-items: + value: + - billing_cycle: monthly + next_billing_date: '2017-11-11T00:00:00Z' + unit_count: null + on_free_trial: true + free_trial_ends_on: '2017-11-11T00:00:00Z' + updated_at: '2017-11-02T01:12:12Z' + account: + login: github + id: 4 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + email: null + organization_billing_email: billing@github.com + type: Organization + plan: + url: https://api.github.com/marketplace_listing/plans/1313 + accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts + id: 1313 + number: 3 + name: Pro + description: A professional-grade CI solution + monthly_price_in_cents: 1099 + yearly_price_in_cents: 11870 + price_model: FLAT_RATE + has_free_trial: true + unit_name: null + state: published + bullets: + - Up to 25 private repositories + - 11 concurrent builds + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/billing.yaml b/provider-dev/source/billing.yaml new file mode 100644 index 0000000..6efc95e --- /dev/null +++ b/provider-dev/source/billing.yaml @@ -0,0 +1,1567 @@ +openapi: 3.0.3 +info: + title: billing API + description: Monitor charges and usage from Actions and Packages. + version: 1.1.4 +paths: + /organizations/{org}/settings/billing/budgets: + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + Each page returns up to 10 budgets. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: page + description: The page number of the results to fetch. + in: query + schema: + type: integer + default: 1 + - name: per_page + description: The number of results per page (max 10). + in: query + schema: + type: integer + default: 10 + - name: scope + description: Filter budgets by scope type. + in: query + schema: + type: string + enum: + - enterprise + - organization + - repository + - cost_center + responses: + '200': + $ref: '#/components/responses/get_all_budgets' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + x-stackQL-resource: budgets + /organizations/{org}/settings/billing/budgets/{budget_id}: + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/budget' + responses: + '200': + $ref: '#/components/responses/budget' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + x-stackQL-resource: budgets + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/budget' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + description: The type of pricing for the budget + type: string + enum: + - ProductPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + description: The type of pricing for the budget + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the budget + examples: + update-budget: + $ref: '#/components/examples/update-budget' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found. + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + '422': + $ref: '#/components/responses/validation_failed' + '500': + description: Internal server error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: budgets + x-stackQL-resource: budgets + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/budget' + responses: + '200': + $ref: '#/components/responses/delete-budget' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + x-stackQL-resource: budgets + /organizations/{org}/settings/billing/premium_request/usage: + get: + summary: Get billing premium request usage report for an organization + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-premium-request-usage-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-user' + - $ref: '#/components/parameters/billing-usage-report-model' + - $ref: '#/components/parameters/billing-usage-report-product' + responses: + '200': + $ref: '#/components/responses/billing_premium_request_usage_report_org' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /organizations/{org}/settings/billing/usage: + get: + summary: Get billing usage report for an organization + description: |- + Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + tags: + - billing + operationId: billing/get-github-billing-usage-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month' + - $ref: '#/components/parameters/billing-usage-report-day' + responses: + '200': + $ref: '#/components/responses/billing_usage_report_org' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /organizations/{org}/settings/billing/usage/summary: + get: + summary: Get billing usage summary for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-usage-summary-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-repository' + - $ref: '#/components/parameters/billing-usage-report-product' + - $ref: '#/components/parameters/billing-usage-report-sku' + responses: + '200': + $ref: '#/components/responses/billing_usage_summary_report_org' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /users/{username}/settings/billing/premium_request/usage: + get: + summary: Get billing premium request usage report for a user + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-premium-request-usage-report-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-model' + - $ref: '#/components/parameters/billing-usage-report-product' + responses: + '200': + $ref: '#/components/responses/billing_premium_request_usage_report_user' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /users/{username}/settings/billing/usage: + get: + summary: Get billing usage report for a user + description: |- + Gets a report of the total usage for a user. + + **Note:** This endpoint is only available to users with access to the enhanced billing platform. + tags: + - billing + operationId: billing/get-github-billing-usage-report-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month' + - $ref: '#/components/parameters/billing-usage-report-day' + responses: + '200': + $ref: '#/components/responses/billing_usage_report_user' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage + /users/{username}/settings/billing/usage/summary: + get: + summary: Get billing usage summary for a user + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a summary report of usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-usage-summary-report-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/billing-usage-report-year' + - $ref: '#/components/parameters/billing-usage-report-month-default' + - $ref: '#/components/parameters/billing-usage-report-day' + - $ref: '#/components/parameters/billing-usage-report-repository' + - $ref: '#/components/parameters/billing-usage-report-product' + - $ref: '#/components/parameters/billing-usage-report-sku' + responses: + '200': + $ref: '#/components/responses/billing_usage_summary_report_user' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage + x-stackQL-resource: usage +components: + schemas: + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + $ref: '#/components/schemas/budget' + description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available (maps to hasNextPage from billing platform) + total_count: + type: integer + description: Total number of budgets matching the query + required: + - budgets + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + type: string + enum: + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + delete-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the deletion operation + id: + type: string + description: The ID of the deleted budget + required: + - message + - id + billing-premium-request-usage-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + user: + type: string + description: The name of the user for the usage report. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems + billing-usage-report: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + organizationName: + type: string + description: Name of the organization. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + - organizationName + billing-usage-summary-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems + billing-premium-request-usage-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems + billing-usage-report-user: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + billing-usage-summary-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + description: The type of pricing for the budget + example: SkuPricing + type: string + enum: + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not require a name). + example: octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + responses: + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + $ref: '#/components/schemas/get_all_budgets' + examples: + default: + $ref: '#/components/examples/get_all_budgets' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + budget: + description: Response when updating a budget + content: + application/json: + schema: + $ref: '#/components/schemas/get-budget' + examples: + default: + $ref: '#/components/examples/get-budget' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + $ref: '#/components/schemas/delete-budget' + examples: + default: + $ref: '#/components/examples/delete-budget' + billing_premium_request_usage_report_org: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + $ref: '#/components/schemas/billing-premium-request-usage-report-org' + examples: + default: + $ref: '#/components/examples/billing-premium-request-usage-report-org' + billing_usage_report_org: + description: Billing usage report response for an organization + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-report' + examples: + default: + $ref: '#/components/examples/billing-usage-report' + billing_usage_summary_report_org: + description: Response when getting a billing usage summary + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-summary-report-org' + examples: + default: + $ref: '#/components/examples/billing-usage-summary-report-org' + billing_premium_request_usage_report_user: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + $ref: '#/components/schemas/billing-premium-request-usage-report-user' + examples: + default: + $ref: '#/components/examples/billing-premium-request-usage-report-user' + billing_usage_report_user: + description: Response when getting a billing usage report + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-report-user' + examples: + default: + $ref: '#/components/examples/billing-usage-report-user' + billing_usage_summary_report_user: + description: Response when getting a billing usage summary + content: + application/json: + schema: + $ref: '#/components/schemas/billing-usage-summary-report-user' + examples: + default: + $ref: '#/components/examples/billing-usage-summary-report-user' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + budget: + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + billing-usage-report-year: + name: year + description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. + in: query + required: false + schema: + type: integer + billing-usage-report-month-default: + name: month + description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. + in: query + required: false + schema: + type: integer + billing-usage-report-day: + name: day + description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. + in: query + required: false + schema: + type: integer + billing-usage-report-user: + name: user + description: The user name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-model: + name: model + description: The model name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-product: + name: product + description: The product name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-month: + name: month + description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. + in: query + required: false + schema: + type: integer + billing-usage-report-repository: + name: repository + description: The repository name to query for usage in the format owner/repository. + in: query + required: false + schema: + type: string + billing-usage-report-sku: + name: sku + description: The SKU to query for usage. + in: query + required: false + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + has_next_page: false + total_count: 3 + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + delete-budget: + value: + message: Budget successfully deleted. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + billing-premium-request-usage-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 100 + netAmount: 4 + billing-usage-report: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + organizationName: GitHub + repositoryName: github/example + billing-usage-summary-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 1000 + netAmount: 8 + billing-premium-request-usage-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 100 + netAmount: 4 + billing-usage-report-user: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + repositoryName: user/example + billing-usage-summary-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8 + discountQuantity: 0 + discountAmount: 0 + netQuantity: 1000 + netAmount: 8 +servers: + - url: https://api.github.com diff --git a/provider-dev/source/campaigns.yaml b/provider-dev/source/campaigns.yaml new file mode 100644 index 0000000..4749fc5 --- /dev/null +++ b/provider-dev/source/campaigns.yaml @@ -0,0 +1,906 @@ +openapi: 3.0.3 +info: + title: campaigns API + description: Endpoints to manage campaigns via the REST API. + version: 1.1.4 +paths: + /orgs/{org}/campaigns: + get: + summary: List campaigns for an organization + description: |- + Lists campaigns in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/list-org-campaigns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - name: state + description: If specified, only campaigns with this state will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/campaign-state' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - ends_at + - published + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-org-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + post: + summary: Create a campaign for an organization + description: |- + Create a campaign for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + + Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + in the campaign. + tags: + - campaigns + operationId: campaigns/create-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + description: The login of each manager + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: The end date and time of the campaign. The date must be in the future. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: string + format: uri + nullable: true + code_scanning_alerts: + description: The code scanning alerts to include in this campaign + type: array + minItems: 1 + items: + type: object + additionalProperties: false + properties: + repository_id: + type: integer + description: The repository id + alert_numbers: + type: array + description: The alert numbers + minItems: 1 + items: + type: integer + required: + - repository_id + - alert_numbers + nullable: true + generate_issues: + description: If true, will automatically generate issues for the campaign. The default is false. + type: boolean + default: false + required: + - name + - description + - ends_at + - code_scanning_alerts + - secret_scanning_alerts + examples: + default: + value: + name: Critical CodeQL alerts + description: Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage. + managers: + - octocat + ends_at: '2024-03-14T00:00:00Z' + code_scanning_alerts: + - repository_id: 1296269 + alert_numbers: + - 1 + - 2 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-summary' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '429': + description: Too Many Requests + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + /orgs/{org}/campaigns/{campaign_number}: + get: + summary: Get a campaign for an organization + description: |- + Gets a campaign for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/get-campaign-summary + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-summary' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + patch: + summary: Update a campaign + description: |- + Updates a campaign in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/update-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign + parameters: + - $ref: '#/components/parameters/org' + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: string + format: uri + nullable: true + state: + $ref: '#/components/schemas/campaign-state' + examples: + default: + value: + name: Critical CodeQL alerts + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/campaign-summary' + examples: + default: + $ref: '#/components/examples/campaign-summary' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns + delete: + summary: Delete a campaign for an organization + description: |- + Deletes a campaign in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/delete-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Deletion successful + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + x-stackQL-resource: campaigns +components: + schemas: + campaign-state: + title: Campaign state + description: Indicates whether a campaign is open or closed + type: string + enum: + - open + - closed + campaign-summary: + title: Campaign summary + description: The campaign metadata and alert stats. + type: object + properties: + number: + type: integer + description: The number of the newly created campaign + created_at: + type: string + format: date-time + description: The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + name: + type: string + description: The campaign name + description: + type: string + description: The campaign description + managers: + description: The campaign managers + type: array + items: + $ref: '#/components/schemas/simple-user' + team_managers: + description: The campaign team managers + type: array + items: + $ref: '#/components/schemas/team' + published_at: + description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + ends_at: + description: The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + closed_at: + description: The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + type: string + format: date-time + nullable: true + state: + $ref: '#/components/schemas/campaign-state' + contact_link: + description: The contact link of the campaign. + type: string + format: uri + nullable: true + alert_stats: + type: object + additionalProperties: false + properties: + open_count: + type: integer + description: The number of open alerts + closed_count: + type: integer + description: The number of closed alerts + in_progress_count: + type: integer + description: The number of in-progress alerts + required: + - open_count + - closed_count + - in_progress_count + required: + - number + - created_at + - updated_at + - description + - managers + - ends_at + - state + - contact_link + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + examples: + campaign-org-items: + value: + - number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage. + managers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + ends_at: '2024-03-14T12:29:18Z' + closed_at: null + state: open + - number: 4 + created_at: '2024-03-30T12:29:18Z' + updated_at: '2024-03-30T12:29:18Z' + name: Mitre top 10 KEV + description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) to enhance security by addressing vulnerabilities actively exploited by attackers. This reduces risk, prevents breaches and can help protect sensitive data. + managers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + ends_at: '2024-04-30T12:29:18Z' + closed_at: null + state: open + campaign-summary: + value: + number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: Address critical alerts before they are exploited to prevent breaches, protect sensitive data, and mitigate financial and reputational damage. + managers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + published_at: '2024-02-14T12:29:18Z' + ends_at: '2024-03-14T12:29:18Z' + closed_at: null + state: open + alert_stats: + open_count: 10 + closed_count: 3 + in_progress_count: 3 + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/checks.yaml b/provider-dev/source/checks.yaml new file mode 100644 index 0000000..d46a4ef --- /dev/null +++ b/provider-dev/source/checks.yaml @@ -0,0 +1,3488 @@ +openapi: 3.0.3 +info: + title: checks API + description: Rich interactions with checks run by your integrations. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/check-runs: + post: + summary: Create a check run + description: |- + Creates a new check run for a specific commit in a repository. + + To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. + + In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + tags: + - checks + operationId: checks/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#create-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the check. For example, "code-coverage". + head_sha: + type: string + description: The SHA of the commit. + details_url: + type: string + description: The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. + external_id: + type: string + description: A reference for the run on the integrator's system. + status: + type: string + description: The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + default: queued + started_at: + type: string + format: date-time + description: 'The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + conclusion: + type: string + description: |- + **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + enum: + - action_required + - cancelled + - failure + - neutral + - success + - skipped + - stale + - timed_out + completed_at: + type: string + format: date-time + description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + output: + type: object + description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. + properties: + title: + type: string + description: The title of the check run. + summary: + type: string + maxLength: 65535 + description: 'The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.' + text: + type: string + maxLength: 65535 + description: 'The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.' + annotations: + type: array + description: Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". + maxItems: 50 + items: + type: object + properties: + path: + type: string + description: The path of the file to add an annotation to. For example, `assets/css/main.css`. + start_line: + type: integer + description: The start line of the annotation. Line numbers start at 1. + end_line: + type: integer + description: The end line of the annotation. + start_column: + type: integer + description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. + end_column: + type: integer + description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. + annotation_level: + type: string + description: The level of the annotation. + enum: + - notice + - warning + - failure + message: + type: string + description: A short description of the feedback for these lines of code. The maximum size is 64 KB. + title: + type: string + description: The title that represents the annotation. The maximum size is 255 characters. + raw_details: + type: string + description: Details about this annotation. The maximum size is 64 KB. + required: + - path + - start_line + - end_line + - annotation_level + - message + images: + type: array + description: Adds images to the output displayed in the GitHub pull request UI. + items: + type: object + properties: + alt: + type: string + description: The alternative text for the image. + image_url: + type: string + description: The full URL of the image. + caption: + type: string + description: A short image description. + required: + - alt + - image_url + required: + - title + - summary + actions: + type: array + description: Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + maxItems: 3 + items: + type: object + properties: + label: + type: string + maxLength: 20 + description: The text to be displayed on a button in the web UI. The maximum size is 20 characters. + description: + type: string + maxLength: 40 + description: A short explanation of what this action would do. The maximum size is 40 characters. + identifier: + type: string + maxLength: 20 + description: A reference for the action on the integrator's system. The maximum size is 20 characters. + required: + - label + - description + - identifier + required: + - name + - head_sha + - status + - conclusion + discriminator: + propertyName: status + additionalProperties: true + examples: + example-of-in-progress-conclusion: + summary: Example of an in_progress conclusion + value: + name: mighty_readme + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + status: in_progress + external_id: '42' + started_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: '' + text: '' + example-of-completed-conclusion: + summary: Example of a completed conclusion + value: + name: mighty_readme + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + status: completed + started_at: '2017-11-30T19:39:10Z' + conclusion: success + completed_at: '2017-11-30T19:49:10Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notices. + text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. + annotations: + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'banaas'. + raw_details: Do you mean 'bananas' or 'banana'? + start_line: 2 + end_line: 2 + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'aples' + raw_details: Do you mean 'apples' or 'Naples' + start_line: 4 + end_line: 4 + images: + - alt: Super bananas + image_url: http://example.com/images/42 + actions: + - label: Fix + identifier: fix_errors + description: Allow us to fix these errors for you + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-run' + examples: + example-of-completed-conclusion: + $ref: '#/components/examples/check-run-example-of-completed-conclusion' + example-of-in-progress-conclusion: + $ref: '#/components/examples/check-run-example-of-in-progress-conclusion' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-runs/{check_run_id}: + get: + summary: Get a check run + description: |- + Gets a single check run using its `id`. + + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#get-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + patch: + summary: Update a check run + description: |- + Updates a check run for a specific commit in a repository. + + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#update-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the check. For example, "code-coverage". + details_url: + type: string + description: The URL of the integrator's site that has the full details of the check. + external_id: + type: string + description: A reference for the run on the integrator's system. + started_at: + type: string + format: date-time + description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + status: + type: string + description: The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + conclusion: + type: string + description: |- + **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + enum: + - action_required + - cancelled + - failure + - neutral + - success + - skipped + - stale + - timed_out + completed_at: + type: string + format: date-time + description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + output: + type: object + description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. + properties: + title: + type: string + description: '**Required**.' + summary: + type: string + description: Can contain Markdown. + maxLength: 65535 + text: + type: string + description: Can contain Markdown. + maxLength: 65535 + annotations: + type: array + description: Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". + maxItems: 50 + items: + type: object + properties: + path: + type: string + description: The path of the file to add an annotation to. For example, `assets/css/main.css`. + start_line: + type: integer + description: The start line of the annotation. Line numbers start at 1. + end_line: + type: integer + description: The end line of the annotation. + start_column: + type: integer + description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. + end_column: + type: integer + description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. + annotation_level: + type: string + description: The level of the annotation. + enum: + - notice + - warning + - failure + message: + type: string + description: A short description of the feedback for these lines of code. The maximum size is 64 KB. + title: + type: string + description: The title that represents the annotation. The maximum size is 255 characters. + raw_details: + type: string + description: Details about this annotation. The maximum size is 64 KB. + required: + - path + - start_line + - end_line + - annotation_level + - message + images: + type: array + description: Adds images to the output displayed in the GitHub pull request UI. + items: + type: object + properties: + alt: + type: string + description: The alternative text for the image. + image_url: + type: string + description: The full URL of the image. + caption: + type: string + description: A short image description. + required: + - alt + - image_url + required: + - summary + actions: + type: array + description: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + maxItems: 3 + items: + type: object + properties: + label: + type: string + maxLength: 20 + description: The text to be displayed on a button in the web UI. The maximum size is 20 characters. + description: + type: string + maxLength: 40 + description: A short explanation of what this action would do. The maximum size is 40 characters. + identifier: + type: string + maxLength: 20 + description: A reference for the action on the integrator's system. The maximum size is 20 characters. + required: + - label + - description + - identifier + required: + - conclusion + additionalProperties: true + examples: + default: + value: + name: mighty_readme + started_at: '2018-05-04T01:14:52Z' + status: completed + conclusion: success + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notices. + text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. + annotations: + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'banaas'. + raw_details: Do you mean 'bananas' or 'banana'? + start_line: 2 + end_line: 2 + - path: README.md + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'aples' + raw_details: Do you mean 'apples' or 'Naples' + start_line: 4 + end_line: 4 + images: + - alt: Super bananas + image_url: http://example.com/images/42 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations: + get: + summary: List check run annotations + description: |- + Lists annotations for a check run using the annotation `id`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-annotations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#list-check-run-annotations + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/check-annotation' + examples: + default: + $ref: '#/components/examples/check-annotation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest: + post: + summary: Rerequest a check run + description: |- + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. + + For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + tags: + - checks + operationId: checks/rerequest-run + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-run-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + description: Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Validation error if the check run is not rerequestable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-suites: + post: + summary: Create a check suite + description: |- + Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". + + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/create-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#create-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + head_sha: + type: string + description: The sha of the head commit. + required: + - head_sha + examples: + default: + value: + head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 + responses: + '200': + description: Response when the suite already exists + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite' + '201': + description: Response when the suite was created + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/check-suites/preferences: + patch: + summary: Update repository preferences for check suites + description: |- + Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + You must have admin permissions in the repository to set preferences for check suites. + tags: + - checks + operationId: checks/set-suites-preferences + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + auto_trigger_checks: + type: array + description: Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. + items: + type: object + properties: + app_id: + type: integer + description: The `id` of the GitHub App. + setting: + type: boolean + description: Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. + default: true + required: + - app_id + - setting + examples: + default: + value: + auto_trigger_checks: + - app_id: 4 + setting: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite-preference' + examples: + default: + $ref: '#/components/examples/check-suite-preference' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/check-suites/{check_suite_id}: + get: + summary: Get a check suite + description: |- + Gets a single check suite using its `id`. + + > [!NOTE] + > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/get-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#get-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-suite-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs: + get: + summary: List check runs in a check suite + description: |- + Lists check runs for a check suite using its `id`. + + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-for-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-suite-id' + - $ref: '#/components/parameters/check-name' + - $ref: '#/components/parameters/status' + - name: filter + description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. + in: query + required: false + schema: + type: string + enum: + - latest + - all + default: latest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - check_runs + properties: + total_count: + type: integer + check_runs: + type: array + items: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest: + post: + summary: Rerequest a check suite + description: Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + tags: + - checks + operationId: checks/rerequest-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/check-suite-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites + /repos/{owner}/{repo}/commits/{ref}/check-runs: + get: + summary: List check runs for a Git reference + description: |- + Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. + + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-for-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - $ref: '#/components/parameters/check-name' + - $ref: '#/components/parameters/status' + - name: filter + description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. + in: query + required: false + schema: + type: string + enum: + - latest + - all + default: latest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: app_id + in: query + required: false + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - check_runs + properties: + total_count: + type: integer + check_runs: + type: array + items: + $ref: '#/components/schemas/check-run' + examples: + default: + $ref: '#/components/examples/check-run-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: runs + x-stackQL-resource: runs + /repos/{owner}/{repo}/commits/{ref}/check-suites: + get: + summary: List check suites for a Git reference + description: |- + Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. + + > [!NOTE] + > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + tags: + - checks + operationId: checks/list-suites-for-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - name: app_id + description: Filters check suites by GitHub App `id`. + in: query + required: false + schema: + type: integer + example: 1 + - $ref: '#/components/parameters/check-name' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - check_suites + properties: + total_count: + type: integer + check_suites: + type: array + items: + $ref: '#/components/schemas/check-suite' + examples: + default: + $ref: '#/components/examples/check-suite-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: checks + subcategory: suites + x-stackQL-resource: suites +components: + schemas: + check-run: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + id: + description: The id of the check. + example: 21 + type: integer + format: int64 + head_sha: + description: The SHA of the commit that is being checked. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + node_id: + type: string + example: MDg6Q2hlY2tSdW40 + external_id: + type: string + example: '42' + nullable: true + url: + type: string + example: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: + type: string + example: https://github.com/github/hello-world/runs/4 + nullable: true + details_url: + type: string + example: https://example.com + nullable: true + status: + description: The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. + example: queued + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + conclusion: + type: string + example: neutral + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + nullable: true + started_at: + type: string + format: date-time + example: '2018-05-04T01:14:52Z' + nullable: true + completed_at: + type: string + format: date-time + example: '2018-05-04T01:14:52Z' + nullable: true + output: + type: object + properties: + title: + type: string + nullable: true + summary: + type: string + nullable: true + text: + type: string + nullable: true + annotations_count: + type: integer + annotations_url: + type: string + format: uri + required: + - title + - summary + - text + - annotations_count + - annotations_url + name: + description: The name of the check. + example: test-coverage + type: string + check_suite: + type: object + properties: + id: + type: integer + required: + - id + nullable: true + app: + $ref: '#/components/schemas/nullable-integration' + pull_requests: + description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. + type: array + items: + $ref: '#/components/schemas/pull-request-minimal' + deployment: + $ref: '#/components/schemas/deployment-simple' + required: + - id + - node_id + - head_sha + - name + - url + - html_url + - details_url + - status + - conclusion + - started_at + - completed_at + - external_id + - check_suite + - output + - app + - pull_requests + check-annotation: + title: Check Annotation + description: Check Annotation + type: object + properties: + path: + type: string + example: README.md + start_line: + type: integer + example: 2 + end_line: + type: integer + example: 2 + start_column: + type: integer + example: 5 + nullable: true + end_column: + type: integer + example: 10 + nullable: true + annotation_level: + type: string + example: warning + nullable: true + title: + type: string + example: Spell Checker + nullable: true + message: + type: string + example: Check your spelling for 'banaas'. + nullable: true + raw_details: + type: string + example: Do you mean 'bananas' or 'banana'? + nullable: true + blob_href: + type: string + required: + - path + - blob_href + - start_line + - end_line + - start_column + - end_column + - annotation_level + - title + - message + - raw_details + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + check-suite: + title: CheckSuite + description: A suite of checks performed on the code of a given code change + type: object + properties: + id: + type: integer + example: 5 + format: int64 + node_id: + type: string + example: MDEwOkNoZWNrU3VpdGU1 + head_branch: + type: string + example: master + nullable: true + head_sha: + description: The SHA of the head commit that is being checked. + example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d + type: string + status: + type: string + description: The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. + example: completed + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + nullable: true + conclusion: + type: string + example: neutral + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - startup_failure + - stale + - null + nullable: true + url: + type: string + example: https://api.github.com/repos/github/hello-world/check-suites/5 + nullable: true + before: + type: string + example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + nullable: true + after: + type: string + example: d6fde92930d4715a2b49857d24b940956b26d2d3 + nullable: true + pull_requests: + type: array + items: + $ref: '#/components/schemas/pull-request-minimal' + nullable: true + app: + $ref: '#/components/schemas/nullable-integration' + repository: + $ref: '#/components/schemas/minimal-repository' + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + head_commit: + $ref: '#/components/schemas/simple-commit' + latest_check_runs_count: + type: integer + check_runs_url: + type: string + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + required: + - id + - node_id + - head_branch + - status + - conclusion + - head_sha + - url + - before + - after + - created_at + - updated_at + - app + - head_commit + - repository + - latest_check_runs_count + - check_runs_url + - pull_requests + check-suite-preference: + title: Check Suite Preference + description: Check suite configuration preferences for a repository. + type: object + required: + - preferences + - repository + properties: + preferences: + type: object + properties: + auto_trigger_checks: + type: array + items: + type: object + properties: + app_id: + type: integer + setting: + type: boolean + required: + - app_id + - setting + repository: + $ref: '#/components/schemas/minimal-repository' + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + deployment-simple: + title: Deployment + description: A deployment created as the result of an Actions check run from a workflow that references an environment + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + example: 42 + type: integer + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + task: + description: Parameter to specify a task to execute + example: deploy + type: string + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' + example: true + type: boolean + production_environment: + description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' + example: true + type: boolean + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - task + - environment + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + timestamp: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + author: + type: object + description: Information about the Git author + properties: + name: + description: Name of the commit's author + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's author + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + committer: + type: object + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + example: Monalisa Octocat + type: string + email: + description: Git email address of the commit's committer + example: monalisa.octocat@example.com + type: string + format: email + required: + - name + - email + nullable: true + required: + - id + - tree_id + - message + - timestamp + - author + - committer + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + check-run-id: + name: check_run_id + description: The unique identifier of the check run. + in: path + required: true + schema: + type: integer + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + check-suite-id: + name: check_suite_id + description: The unique identifier of the check suite. + in: path + required: true + schema: + type: integer + check-name: + name: check_name + description: Returns check runs with the specified `name`. + in: query + required: false + schema: + type: string + status: + name: status + description: Returns check runs with the specified `status`. + in: query + required: false + schema: + type: string + enum: + - queued + - in_progress + - completed + commit-ref: + name: ref + description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + in: path + required: true + schema: + type: string + x-multi-segment: true + examples: + check-run-example-of-completed-conclusion: + summary: Response for completed conclusion + value: + id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '42' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: completed + conclusion: neutral + started_at: '2018-05-04T01:14:52Z' + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-run-example-of-in-progress-conclusion: + summary: Response for in_progress conclusion + value: + id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '42' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: in_progress + conclusion: null + started_at: '2018-05-04T01:14:52Z' + completed_at: null + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-run: + value: + id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: completed + conclusion: neutral + started_at: '2018-05-04T01:14:52Z' + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-annotation-items: + value: + - path: README.md + start_line: 2 + end_line: 2 + start_column: 5 + end_column: 10 + annotation_level: warning + title: Spell Checker + message: Check your spelling for 'banaas'. + raw_details: Do you mean 'bananas' or 'banana'? + blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc + check-suite: + value: + id: 5 + node_id: MDEwOkNoZWNrU3VpdGU1 + head_branch: master + head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 + status: completed + conclusion: neutral + url: https://api.github.com/repos/github/hello-world/check-suites/5 + before: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: [] + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + head_commit: + id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + timestamp: '2016-10-10T00:00:00Z' + author: + name: The Octocat + email: octocat@nowhere.com + committer: + name: The Octocat + email: octocat@nowhere.com + latest_check_runs_count: 1 + check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs + check-suite-preference: + value: + preferences: + auto_trigger_checks: + - app_id: 2 + setting: true + - app_id: 4 + setting: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + check-run-paginated: + value: + total_count: 1 + check_runs: + - id: 4 + head_sha: ce587453ced02b1526dfb4cb910479d431683101 + node_id: MDg6Q2hlY2tSdW40 + external_id: '' + url: https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: https://github.com/github/hello-world/runs/4 + details_url: https://example.com + status: completed + conclusion: neutral + started_at: '2018-05-04T01:14:52Z' + completed_at: '2018-05-04T01:14:52Z' + output: + title: Mighty Readme report + summary: There are 0 failures, 2 warnings, and 1 notice. + text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app. + annotations_count: 2 + annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations + name: mighty_readme + check_suite: + id: 5 + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + pull_requests: + - url: https://api.github.com/repos/github/hello-world/pulls/1 + id: 1934 + number: 3956 + head: + ref: say-hello + sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390 + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + base: + ref: master + sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f + repo: + id: 526 + url: https://api.github.com/repos/github/hello-world + name: hello-world + check-suite-paginated: + value: + total_count: 1 + check_suites: + - id: 5 + node_id: MDEwOkNoZWNrU3VpdGU1 + head_branch: master + head_sha: d6fde92930d4715a2b49857d24b940956b26d2d3 + status: completed + conclusion: neutral + url: https://api.github.com/repos/github/hello-world/check-suites/5 + before: 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: [] + app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + head_commit: + id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + tree_id: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + timestamp: '2016-10-10T00:00:00Z' + author: + name: The Octocat + email: octocat@nowhere.com + committer: + name: The Octocat + email: octocat@nowhere.com + latest_check_runs_count: 1 + check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/classroom.yaml b/provider-dev/source/classroom.yaml new file mode 100644 index 0000000..f26d82b --- /dev/null +++ b/provider-dev/source/classroom.yaml @@ -0,0 +1,821 @@ +openapi: 3.0.3 +info: + title: classroom API + description: Interact with GitHub Classroom. + version: 1.1.4 +paths: + /assignments/{assignment_id}: + get: + summary: Get an assignment + description: Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + tags: + - classroom + operationId: classroom/get-an-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#get-an-assignment + parameters: + - $ref: '#/components/parameters/assignment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/classroom-assignment' + examples: + default: + $ref: '#/components/examples/classroom-assignment' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /assignments/{assignment_id}/accepted_assignments: + get: + summary: List accepted assignments for an assignment + description: Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + tags: + - classroom + operationId: classroom/list-accepted-assignments-for-an-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment + parameters: + - $ref: '#/components/parameters/assignment-id' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/classroom-accepted-assignment' + examples: + default: + $ref: '#/components/examples/classroom-accepted-assignment' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /assignments/{assignment_id}/grades: + get: + summary: Get assignment grades + description: Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + tags: + - classroom + operationId: classroom/get-assignment-grades + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades + parameters: + - $ref: '#/components/parameters/assignment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/classroom-assignment-grade' + examples: + default: + $ref: '#/components/examples/classroom-assignment-grades' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /classrooms: + get: + summary: List classrooms + description: Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. + tags: + - classroom + operationId: classroom/list-classrooms + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#list-classrooms + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-classroom' + examples: + default: + $ref: '#/components/examples/simple-classroom' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /classrooms/{classroom_id}: + get: + summary: Get a classroom + description: Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. + tags: + - classroom + operationId: classroom/get-a-classroom + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#get-a-classroom + parameters: + - $ref: '#/components/parameters/classroom-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/classroom' + examples: + default: + $ref: '#/components/examples/classroom' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom + /classrooms/{classroom_id}/assignments: + get: + summary: List assignments for a classroom + description: Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. + tags: + - classroom + operationId: classroom/list-assignments-for-a-classroom + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom + parameters: + - $ref: '#/components/parameters/classroom-id' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-classroom-assignment' + examples: + default: + $ref: '#/components/examples/simple-classroom-assignment' + x-github: + enabledForGitHubApps: true + category: classroom + subcategory: classroom + x-stackQL-resource: classroom +components: + schemas: + classroom-assignment: + title: Classroom Assignment + description: A GitHub Classroom assignment + type: object + properties: + id: + description: Unique identifier of the repository. + type: integer + example: 42 + public_repo: + description: Whether an accepted assignment creates a public repository. + type: boolean + example: true + title: + description: Assignment title. + type: string + example: Intro to Binaries + type: + description: Whether it's a group assignment or individual assignment. + type: string + example: individual + enum: + - individual + - group + invite_link: + description: The link that a student can use to accept the assignment. + type: string + example: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: + description: Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. + type: boolean + example: true + slug: + description: Sluggified name of the assignment. + type: string + example: intro-to-binaries + students_are_repo_admins: + description: Whether students are admins on created repository when a student accepts the assignment. + type: boolean + example: true + feedback_pull_requests_enabled: + description: Whether feedback pull request will be created when a student accepts the assignment. + type: boolean + example: true + max_teams: + description: The maximum allowable teams for the assignment. + nullable: true + type: integer + example: 0 + max_members: + description: The maximum allowable members per team. + nullable: true + type: integer + example: 0 + editor: + description: The selected editor for the assignment. + type: string + example: codespaces + accepted: + description: The number of students that have accepted the assignment. + type: integer + example: 25 + submitted: + description: The number of students that have submitted the assignment. + type: integer + example: 10 + passing: + description: The number of students that have passed the assignment. + type: integer + example: 10 + language: + description: The programming language used in the assignment. + type: string + example: elixir + deadline: + description: The time at which the assignment is due. + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + starter_code_repository: + $ref: '#/components/schemas/simple-classroom-repository' + classroom: + $ref: '#/components/schemas/classroom' + required: + - id + - public_repo + - title + - type + - invite_link + - invitations_enabled + - slug + - students_are_repo_admins + - feedback_pull_requests_enabled + - max_teams + - max_members + - editor + - accepted + - submitted + - passing + - language + - deadline + - starter_code_repository + - classroom + classroom-accepted-assignment: + title: Classroom Accepted Assignment + description: A GitHub Classroom accepted assignment + type: object + properties: + id: + description: Unique identifier of the repository. + type: integer + example: 42 + submitted: + description: Whether an accepted assignment has been submitted. + type: boolean + example: true + passing: + description: Whether a submission passed. + type: boolean + example: true + commit_count: + description: Count of student commits. + type: integer + example: 5 + grade: + description: Most recent grade. + type: string + example: 10/10 + students: + type: array + items: + $ref: '#/components/schemas/simple-classroom-user' + repository: + $ref: '#/components/schemas/simple-classroom-repository' + assignment: + $ref: '#/components/schemas/simple-classroom-assignment' + required: + - id + - submitted + - passing + - commit_count + - grade + - students + - repository + - assignment + classroom-assignment-grade: + title: Classroom Assignment Grade + description: Grade for a student or groups GitHub Classroom assignment + type: object + properties: + assignment_name: + description: Name of the assignment + type: string + assignment_url: + description: URL of the assignment + type: string + starter_code_url: + description: URL of the starter code for the assignment + type: string + github_username: + description: GitHub username of the student + type: string + roster_identifier: + description: Roster identifier of the student + type: string + student_repository_name: + description: Name of the student's assignment repository + type: string + student_repository_url: + description: URL of the student's assignment repository + type: string + submission_timestamp: + description: Timestamp of the student's assignment submission + type: string + points_awarded: + description: Number of points awarded to the student + type: integer + points_available: + description: Number of points available for the assignment + type: integer + group_name: + description: If a group assignment, name of the group the student is in + type: string + required: + - assignment_name + - assignment_url + - starter_code_url + - github_username + - roster_identifier + - student_repository_name + - student_repository_url + - submission_timestamp + - points_awarded + - points_available + simple-classroom: + title: Simple Classroom + description: A GitHub Classroom classroom + type: object + properties: + id: + description: Unique identifier of the classroom. + example: 42 + type: integer + name: + description: The name of the classroom. + type: string + example: Programming Elixir + archived: + description: Returns whether classroom is archived or not. + type: boolean + example: false + url: + description: The url of the classroom on GitHub Classroom. + type: string + example: https://classroom.github.com/classrooms/1-programming-elixir + required: + - id + - name + - archived + - url + classroom: + title: Classroom + description: A GitHub Classroom classroom + type: object + properties: + id: + description: Unique identifier of the classroom. + example: 42 + type: integer + name: + description: The name of the classroom. + type: string + example: Programming Elixir + archived: + description: Whether classroom is archived. + type: boolean + example: false + organization: + $ref: '#/components/schemas/simple-classroom-organization' + url: + description: The URL of the classroom on GitHub Classroom. + type: string + example: https://classroom.github.com/classrooms/1-programming-elixir + required: + - id + - name + - archived + - organization + - url + simple-classroom-assignment: + title: Simple Classroom Assignment + description: A GitHub Classroom assignment + type: object + properties: + id: + description: Unique identifier of the repository. + type: integer + example: 42 + public_repo: + description: Whether an accepted assignment creates a public repository. + type: boolean + example: true + title: + description: Assignment title. + type: string + example: Intro to Binaries + type: + description: Whether it's a Group Assignment or Individual Assignment. + type: string + example: individual + enum: + - individual + - group + invite_link: + description: The link that a student can use to accept the assignment. + type: string + example: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: + description: Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. + type: boolean + example: true + slug: + description: Sluggified name of the assignment. + type: string + example: intro-to-binaries + students_are_repo_admins: + description: Whether students are admins on created repository on accepted assignment. + type: boolean + example: true + feedback_pull_requests_enabled: + description: Whether feedback pull request will be created on assignment acceptance. + type: boolean + example: true + max_teams: + description: The maximum allowable teams for the assignment. + nullable: true + type: integer + example: 0 + max_members: + description: The maximum allowable members per team. + nullable: true + type: integer + example: 0 + editor: + description: The selected editor for the assignment. + type: string + example: codespaces + accepted: + description: The number of students that have accepted the assignment. + type: integer + example: 25 + submitted: + description: The number of students that have submitted the assignment. + type: integer + example: 10 + passing: + description: The number of students that have passed the assignment. + type: integer + example: 10 + language: + description: The programming language used in the assignment. + type: string + example: elixir + deadline: + description: The time at which the assignment is due. + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + classroom: + $ref: '#/components/schemas/simple-classroom' + required: + - id + - public_repo + - title + - type + - invite_link + - invitations_enabled + - slug + - students_are_repo_admins + - feedback_pull_requests_enabled + - editor + - accepted + - submitted + - passing + - language + - deadline + - classroom + simple-classroom-repository: + title: Simple Classroom Repository + description: A GitHub repository view for Classroom + type: object + properties: + id: + type: integer + example: 1296269 + description: A unique identifier of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique name of the repository. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + private: + type: boolean + description: Whether the repository is private. + default_branch: + type: string + example: main + description: The default branch for the repository. + required: + - id + - full_name + - html_url + - node_id + - private + - default_branch + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-classroom-user: + title: Simple Classroom User + description: A GitHub user simplified for Classroom. + type: object + properties: + id: + type: integer + example: 1 + login: + type: string + example: octocat + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + html_url: + type: string + format: uri + example: https://github.com/octocat + required: + - id + - login + - avatar_url + - html_url + simple-classroom-organization: + title: Organization Simple for Classroom + description: A GitHub organization. + type: object + properties: + id: + type: integer + example: 1 + login: + type: string + example: github + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + html_url: + type: string + format: uri + example: https://github.com/github + name: + type: string + example: Github - Code thigns happen here + nullable: true + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + required: + - id + - login + - node_id + - html_url + - name + - avatar_url + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + assignment-id: + name: assignment_id + description: The unique identifier of the classroom assignment. + in: path + required: true + schema: + type: integer + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + classroom-id: + name: classroom_id + description: The unique identifier of the classroom. + in: path + required: true + schema: + type: integer + examples: + classroom-assignment: + value: + id: 12, + public_repo: false, + title: Intro to Binaries + type: individual + invite_link: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: true, + slug: intro-to-binaries + students_are_repo_admins: false + feedback_pull_requests_enabled: true + max_teams: 0 + max_members: 0 + editor: codespaces + accepted: 100 + submitted: 40 + passing: 10 + language: ruby + deadline: '2011-01-26T19:06:43Z' + stater_code_repository: + id: 1296269 + full_name: octocat/Hello-World + html_url: https://github.com/octocat/Hello-World + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + private: false + default_branch: main + classroom: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + classroom-accepted-assignment: + value: + id: 12, + submitted: false, + passing: false, + commit_count: 5 + grade: 5/10 + students: + - id: 1 + login: octocat + avatar_url: https://github.com/images/error/octocat_happy.gif + html_url: https://github.com/octocat + repository: + id: 1296269 + full_name: octocat/Hello-World + html_url: https://github.com/octocat/Hello-World + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + private: false + default_branch: main + assignment: + id: 12, + public_repo: false, + title: Intro to Binaries + type: individual + invite_link: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: true, + slug: intro-to-binaries + students_are_repo_admins: false + feedback_pull_requests_enabled: true + max_teams: 0 + max_members: 0 + editor: codespaces + accepted: 100 + submitted: 40 + passing: 10 + language: ruby + classroom: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + classroom-assignment-grades: + value: + - assignment_name: Introduction to Strings + assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337 + starter_code_url: '' + github_username: octocat + roster_identifier: octocat@github.com + student_repository_name: intro-to-strings-1337-octocat + student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-octocat + submission_timestamp: 2018-11-12 01:02 + points_awarded: 10 + points_available: 15 + group_name: octocat-and-friends + - assignment_name: Introduction to Strings + assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337 + starter_code_url: '' + github_username: monalisa + roster_identifier: monalisa@github.com + student_repository_name: intro-to-strings-1337-monalisa + student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-monalisa + submission_timestamp: 2018-11-12 01:11 + points_awarded: 15 + points_available: 15 + group_name: monalisa-and-friends + simple-classroom: + value: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir + classroom: + value: + id: 1296269 + name: Programming Elixir + archived: false, + organization: + id: 1 + login: programming-elixir + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + html_url: https://github.com/programming-elixir + name: Learn how to build fault tolerant applications + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + url: https://classroom.github.com/classrooms/1-programming-elixir + simple-classroom-assignment: + value: + id: 12, + public_repo: false, + title: Intro to Binaries + type: individual + invite_link: https://classroom.github.com/a/Lx7jiUgx + invitations_enabled: true, + slug: intro-to-binaries + students_are_repo_admins: false + feedback_pull_requests_enabled: true + max_teams: 0 + max_members: 0 + editor: codespaces + accepted: 100 + submitted: 40 + passing: 10 + language: ruby + deadline: '2020-01-11T11:59:22Z' + classroom: + id: 1296269 + name: Programming Elixir + archived: false, + url: https://classroom.github.com/classrooms/1-programming-elixir +servers: + - url: https://api.github.com diff --git a/provider-dev/source/code_scanning.yaml b/provider-dev/source/code_scanning.yaml new file mode 100644 index 0000000..81eb7d7 --- /dev/null +++ b/provider-dev/source/code_scanning.yaml @@ -0,0 +1,3980 @@ +openapi: 3.0.3 +info: + title: code_scanning API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/code-scanning/alerts: + get: + summary: List code scanning alerts for an organization + description: |- + Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/tool-name' + - $ref: '#/components/parameters/tool-guid' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - name: state + description: If specified, only code scanning alerts with this state will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-state-query' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + - name: severity + description: If specified, only code scanning alerts with this severity will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-severity' + - name: assignees + description: | + Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-organization-alert-items' + examples: + default: + $ref: '#/components/examples/code-scanning-organization-alert-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts: + get: + summary: List code scanning alerts for a repository + description: |- + Lists code scanning alerts. + + The response includes a `most_recent_instance` object. + This provides details of the most recent instance of this alert + for the default branch (or for the specified Git reference if you used `ref` in the request). + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/tool-name' + - $ref: '#/components/parameters/tool-guid' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/git-ref' + - $ref: '#/components/parameters/pr-alias' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + - name: state + description: If specified, only code scanning alerts with this state will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-state-query' + - name: severity + description: If specified, only code scanning alerts with this severity will be returned. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-alert-severity' + - name: assignees + description: | + Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-alert-items' + examples: + default: + $ref: '#/components/examples/code-scanning-alert-items' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}: + get: + summary: Get a code scanning alert + description: |- + Gets a single code scanning alert. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-alert + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-alert' + examples: + default: + $ref: '#/components/examples/code-scanning-alert' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + patch: + summary: Update a code scanning alert + description: |- + Updates the status of a single code scanning alert. + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + operationId: code-scanning/update-alert + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + $ref: '#/components/schemas/code-scanning-alert-set-state' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + create_request: + $ref: '#/components/schemas/code-scanning-alert-create-request' + assignees: + $ref: '#/components/schemas/code-scanning-alert-assignees' + required: + - state + - assignees + examples: + default: + value: + state: dismissed + dismissed_reason: false positive + dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + create_request: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-alert' + examples: + default: + $ref: '#/components/examples/code-scanning-alert-dismissed' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix: + get: + summary: Get the status of an autofix for a code scanning alert + description: |- + Gets the status and description of an autofix for a code scanning alert. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix' + '400': + $ref: '#/components/responses/code_scanning_bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + post: + summary: Create an autofix for a code scanning alert + description: |- + Creates an autofix for a code scanning alert. + + If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + + If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/create-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix' + '202': + description: Accepted + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix-pending' + '400': + $ref: '#/components/responses/code_scanning_bad_request' + '403': + $ref: '#/components/responses/code_scanning_autofix_create_forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits: + post: + summary: Commit an autofix for a code scanning alert + description: |- + Commits an autofix for a code scanning alert. + + If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/commit-autofix + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix-commits' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix-commits' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-autofix-commits-response' + examples: + default: + $ref: '#/components/examples/code-scanning-autofix-commits-response' + '400': + $ref: '#/components/responses/code_scanning_bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances: + get: + summary: List instances of a code scanning alert + description: |- + Lists all instances of the specified code scanning alert. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/list-alert-instances + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/git-ref' + - $ref: '#/components/parameters/pr-alias' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-alert-instance-list' + examples: + default: + $ref: '#/components/examples/code-scanning-alert-instances' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/analyses: + get: + summary: List code scanning analyses for a repository + description: |- + Lists the details of all code scanning analyses for a repository, + starting with the most recent. + The response is paginated and you can use the `page` and `per_page` parameters + to list the analyses you're interested in. + By default 30 analyses are listed per page. + + The `rules_count` field in the response give the number of rules + that were run in the analysis. + For very old analyses this data is not available, + and `0` is returned in this field. + + > [!WARNING] + > **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + operationId: code-scanning/list-recent-analyses + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/tool-name' + - $ref: '#/components/parameters/tool-guid' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pr-alias' + - name: ref + in: query + description: The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. + required: false + schema: + $ref: '#/components/schemas/code-scanning-ref' + - name: sarif_id + in: query + description: Filter analyses belonging to the same SARIF upload. + required: false + schema: + $ref: '#/components/schemas/code-scanning-analysis-sarif-id' + - $ref: '#/components/parameters/direction' + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-analysis' + examples: + default: + $ref: '#/components/examples/code-scanning-analysis-items' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}: + get: + summary: Get a code scanning analysis for a repository + description: |- + Gets a specified code scanning analysis for a repository. + + The default JSON response contains fields that describe the analysis. + This includes the Git reference and commit SHA to which the analysis relates, + the datetime of the analysis, the name of the code scanning tool, + and the number of alerts. + + The `rules_count` field in the default response give the number of rules + that were run in the analysis. + For very old analyses this data is not available, + and `0` is returned in this field. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + operationId: code-scanning/get-analysis + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: analysis_id + in: path + description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-analysis' + examples: + response: + $ref: '#/components/examples/code-scanning-analysis-default' + application/sarif+json: + schema: + type: object + additionalProperties: true + examples: + response: + $ref: '#/components/examples/code-scanning-analysis-sarif' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/unprocessable_analysis' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + delete: + summary: Delete a code scanning analysis from a repository + description: |- + Deletes a specified code scanning analysis from a repository. + + You can delete one analysis at a time. + To delete a series of analyses, start with the most recent analysis and work backwards. + Conceptually, the process is similar to the undo function in a text editor. + + When you list the analyses for a repository, + one or more will be identified as deletable in the response: + + ``` + "deletable": true + ``` + + An analysis is deletable when it's the most recent in a set of analyses. + Typically, a repository will have multiple sets of analyses + for each enabled code scanning tool, + where a set is determined by a unique combination of analysis values: + + * `ref` + * `tool` + * `category` + + If you attempt to delete an analysis that is not the most recent in a set, + you'll get a 400 response with the message: + + ``` + Analysis specified is not deletable. + ``` + + The response from a successful `DELETE` operation provides you with + two alternative URLs for deleting the next analysis in the set: + `next_analysis_url` and `confirm_delete_url`. + Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + in a set. This is a useful option if you want to preserve at least one analysis + for the specified tool in your repository. + Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + in the 200 response is `null`. + + As an example of the deletion process, + let's imagine that you added a workflow that configured a particular code scanning tool + to analyze the code in a repository. This tool has added 15 analyses: + 10 on the default branch, and another 5 on a topic branch. + You therefore have two separate sets of analyses for this tool. + You've now decided that you want to remove all of the analyses for the tool. + To do this you must make 15 separate deletion requests. + To start, you must find an analysis that's identified as deletable. + Each set of analyses always has one that's identified as deletable. + Having found the deletable analysis for one of the two sets, + delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + Then repeat the process for the second set. + The procedure therefore consists of a nested loop: + + **Outer loop**: + * List the analyses for the repository, filtered by tool. + * Parse this list to find a deletable analysis. If found: + + **Inner loop**: + * Delete the identified analysis. + * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + + The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + operationId: code-scanning/delete-analysis + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: analysis_id + in: path + description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. + required: true + schema: + type: integer + - name: confirm_delete + in: query + description: 'Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you''ll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`' + required: false + schema: + type: string + nullable: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-analysis-deletion' + examples: + default-response: + $ref: '#/components/examples/code-scanning-analysis-deletion' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/databases: + get: + summary: List CodeQL databases for a repository + description: |- + Lists the CodeQL databases that are available in a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/list-codeql-databases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-scanning-codeql-database' + examples: + default: + $ref: '#/components/examples/code-scanning-codeql-databases' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}: + get: + summary: Get a CodeQL database for a repository + description: |- + Gets a CodeQL database for a language in a repository. + + By default this endpoint returns JSON metadata about the CodeQL database. To + download the CodeQL database binary content, set the `Accept` header of the request + to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure + your HTTP client is configured to follow redirects or use the `Location` header + to make a second request to get the redirect URL. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-codeql-database + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: language + in: path + description: The language of the CodeQL database. + schema: + type: string + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-codeql-database' + examples: + default: + $ref: '#/components/examples/code-scanning-codeql-database' + '302': + $ref: '#/components/responses/found' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + delete: + summary: Delete a CodeQL database + description: |- + Deletes a CodeQL database for a language in a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/delete-codeql-database + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: language + in: path + description: The language of the CodeQL database. + schema: + type: string + required: true + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses: + post: + summary: Create a CodeQL variant analysis + description: |- + Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + + Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + + Use the `owner` and `repo` parameters in the URL to specify the controller repository that + will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - code-scanning + operationId: code-scanning/create-variant-analysis + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + language: + $ref: '#/components/schemas/code-scanning-variant-analysis-language' + query_pack: + description: A Base64-encoded tarball containing a CodeQL query and all its dependencies + type: string + repositories: + type: array + description: List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. + items: + type: string + repository_lists: + description: List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. + type: array + maxItems: 1 + items: + type: string + repository_owners: + description: List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. + type: array + maxItems: 1 + items: + type: string + required: + - language + - query_pack + - repositories + - repository_lists + - repository_owners + examples: + repositories_parameter: + summary: Using the "repositories" field. "query_pack" is abridged for brevity. + value: + language: csharp + query_pack: aGVsbG8= + repositories: + - octocat/Hello-World + - octocat/example + repository_owners: + summary: Using the "repository_owners" field. "query_pack" is abridged. + value: + language: csharp + query_pack: aGVsbG8= + repository_owners: + - octocat + repository_lists: + summary: Using the "repository_lists" field. "query_pack" is abridged. + value: + language: csharp + query_pack: aGVsbG8= + repository_lists: + - top-100-csharp + responses: + '201': + description: Variant analysis submitted for processing + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-variant-analysis' + examples: + repositories_parameter: + summary: Response for a successful variant analysis submission + value: + $ref: '#/components/examples/code-scanning-variant-analysis' + repository_owners: + summary: Response for a successful variant analysis submission + value: + $ref: '#/components/examples/code-scanning-variant-analysis' + repository_lists: + summary: Response for a successful variant analysis submission + value: + $ref: '#/components/examples/code-scanning-variant-analysis' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unable to process variant analysis submission + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}: + get: + summary: Get the summary of a CodeQL variant analysis + description: |- + Gets the summary of a CodeQL variant analysis. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-variant-analysis + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: codeql_variant_analysis_id + in: path + description: The unique identifier of the variant analysis. + schema: + type: integer + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-variant-analysis' + examples: + default: + $ref: '#/components/examples/code-scanning-variant-analysis' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}: + get: + summary: Get the analysis status of a repository in a CodeQL variant analysis + description: |- + Gets the analysis status of a repository in a CodeQL variant analysis. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-variant-analysis-repo-task + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis + parameters: + - $ref: '#/components/parameters/owner' + - name: repo + in: path + description: The name of the controller repository. + schema: + type: string + required: true + - name: codeql_variant_analysis_id + in: path + description: The ID of the variant analysis. + schema: + type: integer + required: true + - name: repo_owner + in: path + description: The account owner of the variant analysis repository. The name is not case sensitive. + schema: + type: string + required: true + - name: repo_name + in: path + description: The name of the variant analysis repository. + schema: + type: string + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-variant-analysis-repo-task' + examples: + default: + $ref: '#/components/examples/code-scanning-variant-analysis-repo-task' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/default-setup: + get: + summary: Get a code scanning default setup configuration + description: |- + Gets a code scanning default setup configuration. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/get-default-setup + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-default-setup' + examples: + default: + $ref: '#/components/examples/code-scanning-default-setup' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + patch: + summary: Update a code scanning default setup configuration + description: |- + Updates a code scanning default setup configuration. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + tags: + - code-scanning + operationId: code-scanning/update-default-setup + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-default-setup-update' + examples: + default: + $ref: '#/components/examples/code-scanning-default-setup-update' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-default-setup-update-response' + examples: + default: + $ref: '#/components/examples/code-scanning-default-setup-update-response' + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/code_scanning_conflict' + '422': + $ref: '#/components/responses/code_scanning_invalid_state' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/sarifs: + post: + summary: Upload an analysis as SARIF data + description: "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.\n\nThis endpoint is limited to 1,000 requests per hour for each user or app installation calling it." + operationId: code-scanning/upload-sarif + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + commit_sha: + $ref: '#/components/schemas/code-scanning-analysis-commit-sha' + ref: + $ref: '#/components/schemas/code-scanning-ref-full' + sarif: + $ref: '#/components/schemas/code-scanning-analysis-sarif-file' + checkout_uri: + description: |- + The base directory used in the analysis, as it appears in the SARIF file. + This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + example: file:///github/workspace/ + type: string + format: uri + started_at: + description: 'The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + type: string + tool_name: + description: The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. + type: string + validate: + description: |- + Whether the SARIF file will be validated according to the code scanning specifications. + This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. + type: boolean + additionalProperties: false + required: + - commit_sha + - ref + - sarif + examples: + default: + value: + commit_sha: 4b6472266afd7b471e86085a6659e8c7f2b119da + ref: refs/heads/master + sarif: H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-sarifs-receipt' + examples: + default: + $ref: '#/components/examples/code-scanning-sarif-upload' + '400': + description: Bad Request if the sarif field is invalid + '403': + $ref: '#/components/responses/code_scanning_forbidden_write' + '404': + $ref: '#/components/responses/not_found' + '413': + description: Payload Too Large if the sarif field is too large + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning + /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}: + get: + summary: Get information about a SARIF upload + description: |- + Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + operationId: code-scanning/get-sarif + tags: + - code-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sarif_id + description: The SARIF ID obtained after uploading. + in: path + schema: + type: string + required: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-scanning-sarifs-status' + examples: + default: + $ref: '#/components/examples/code-scanning-sarif-upload-status' + '403': + $ref: '#/components/responses/code_scanning_forbidden_read' + '404': + description: Not Found if the sarif id does not match any upload + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: code-scanning + subcategory: code-scanning + x-stackQL-resource: code_scanning +components: + schemas: + code-scanning-alert-state-query: + type: string + description: State of a code scanning alert. + enum: + - open + - closed + - dismissed + - fixed + code-scanning-alert-severity: + type: string + description: Severity of a code scanning alert. + enum: + - critical + - high + - medium + - low + - warning + - note + - error + code-scanning-organization-alert-items: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + instances_url: + $ref: '#/components/schemas/alert-instances-url' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + rule: + $ref: '#/components/schemas/code-scanning-alert-rule-summary' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + most_recent_instance: + $ref: '#/components/schemas/code-scanning-alert-instance' + repository: + $ref: '#/components/schemas/simple-repository' + dismissal_approved_by: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + - repository + code-scanning-alert-items: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + instances_url: + $ref: '#/components/schemas/alert-instances-url' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + rule: + $ref: '#/components/schemas/code-scanning-alert-rule-summary' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + most_recent_instance: + $ref: '#/components/schemas/code-scanning-alert-instance' + dismissal_approved_by: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + code-scanning-alert: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + instances_url: + $ref: '#/components/schemas/alert-instances-url' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_reason: + $ref: '#/components/schemas/code-scanning-alert-dismissed-reason' + dismissed_comment: + $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' + rule: + $ref: '#/components/schemas/code-scanning-alert-rule' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + most_recent_instance: + $ref: '#/components/schemas/code-scanning-alert-instance' + dismissal_approved_by: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + code-scanning-alert-set-state: + description: Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. + type: string + enum: + - open + - dismissed + code-scanning-alert-dismissed-reason: + type: string + description: '**Required when the state is dismissed.** The reason for dismissing or closing the alert.' + nullable: true + enum: + - false positive + - won't fix + - used in tests + code-scanning-alert-dismissed-comment: + type: string + description: The dismissal comment associated with the dismissal of the alert. + nullable: true + maxLength: 280 + code-scanning-alert-create-request: + type: boolean + description: If `true`, attempt to create an alert dismissal request. + code-scanning-alert-assignees: + description: The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. + type: array + items: + type: string + code-scanning-autofix: + type: object + properties: + status: + $ref: '#/components/schemas/code-scanning-autofix-status' + description: + $ref: '#/components/schemas/code-scanning-autofix-description' + started_at: + $ref: '#/components/schemas/code-scanning-autofix-started-at' + required: + - status + - description + - started_at + code-scanning-autofix-commits: + description: Commit an autofix for a code scanning alert + type: object + properties: + target_ref: + description: The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + type: string + message: + description: Commit message to be used. + type: string + nullable: true + code-scanning-autofix-commits-response: + type: object + properties: + target_ref: + type: string + description: The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + sha: + type: string + description: SHA of commit with autofix. + code-scanning-alert-instance-list: + type: object + properties: + ref: + $ref: '#/components/schemas/code-scanning-ref' + analysis_key: + $ref: '#/components/schemas/code-scanning-analysis-analysis-key' + environment: + $ref: '#/components/schemas/code-scanning-alert-environment' + category: + $ref: '#/components/schemas/code-scanning-analysis-category' + state: + $ref: '#/components/schemas/code-scanning-alert-instance-state' + commit_sha: + type: string + message: + type: object + properties: + text: + type: string + location: + $ref: '#/components/schemas/code-scanning-alert-location' + html_url: + type: string + classifications: + type: array + description: |- + Classifications that have been applied to the file that triggered the alert. + For example identifying it as documentation, or a generated file. + items: + $ref: '#/components/schemas/code-scanning-alert-classification' + code-scanning-ref: + type: string + description: |- + The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + `refs/heads/` or simply ``. + code-scanning-analysis-sarif-id: + type: string + description: An identifier for the upload. + example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 + code-scanning-analysis: + type: object + properties: + ref: + $ref: '#/components/schemas/code-scanning-ref' + commit_sha: + $ref: '#/components/schemas/code-scanning-analysis-commit-sha' + analysis_key: + $ref: '#/components/schemas/code-scanning-analysis-analysis-key' + environment: + $ref: '#/components/schemas/code-scanning-analysis-environment' + category: + $ref: '#/components/schemas/code-scanning-analysis-category' + error: + type: string + example: error reading field xyz + created_at: + $ref: '#/components/schemas/code-scanning-analysis-created-at' + results_count: + type: integer + description: The total number of results in the analysis. + rules_count: + type: integer + description: The total number of rules used in the analysis. + id: + type: integer + description: Unique identifier for this analysis. + url: + $ref: '#/components/schemas/code-scanning-analysis-url' + sarif_id: + $ref: '#/components/schemas/code-scanning-analysis-sarif-id' + tool: + $ref: '#/components/schemas/code-scanning-analysis-tool' + deletable: + type: boolean + warning: + type: string + description: Warning generated when processing the analysis + example: 123 results were ignored + required: + - ref + - commit_sha + - analysis_key + - environment + - error + - created_at + - results_count + - rules_count + - id + - url + - sarif_id + - tool + - deletable + - warning + code-scanning-analysis-deletion: + title: Analysis deletion + description: Successful deletion of a code scanning analysis + type: object + properties: + next_analysis_url: + type: string + description: Next deletable analysis in chain, without last analysis deletion confirmation + format: uri + readOnly: true + nullable: true + confirm_delete_url: + type: string + description: Next deletable analysis in chain, with last analysis deletion confirmation + format: uri + readOnly: true + nullable: true + required: + - next_analysis_url + - confirm_delete_url + code-scanning-codeql-database: + title: CodeQL Database + description: A CodeQL database. + type: object + properties: + id: + type: integer + description: The ID of the CodeQL database. + name: + type: string + description: The name of the CodeQL database. + language: + type: string + description: The language of the CodeQL database. + uploader: + $ref: '#/components/schemas/simple-user' + content_type: + type: string + description: The MIME type of the CodeQL database file. + size: + type: integer + description: The size of the CodeQL database file in bytes. + created_at: + type: string + format: date-time + description: The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + url: + type: string + format: uri + description: The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. + commit_oid: + type: string + description: The commit SHA of the repository at the time the CodeQL database was created. + nullable: true + required: + - id + - name + - language + - uploader + - content_type + - size + - created_at + - updated_at + - url + code-scanning-variant-analysis-language: + type: string + description: The language targeted by the CodeQL query + enum: + - actions + - cpp + - csharp + - go + - java + - javascript + - python + - ruby + - rust + - swift + code-scanning-variant-analysis: + title: Variant Analysis + description: A run of a CodeQL query against one or more repositories. + type: object + properties: + id: + type: integer + description: The ID of the variant analysis. + controller_repo: + $ref: '#/components/schemas/simple-repository' + actor: + $ref: '#/components/schemas/simple-user' + query_language: + $ref: '#/components/schemas/code-scanning-variant-analysis-language' + query_pack_url: + type: string + description: The download url for the query pack. + created_at: + type: string + format: date-time + description: The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + completed_at: + type: string + format: date-time + nullable: true + description: The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + status: + type: string + enum: + - in_progress + - succeeded + - failed + - cancelled + actions_workflow_run_id: + type: integer + description: The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. + failure_reason: + type: string + enum: + - no_repos_queried + - actions_workflow_run_failed + - internal_error + description: The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. + scanned_repositories: + type: array + items: + type: object + properties: + repository: + $ref: '#/components/schemas/code-scanning-variant-analysis-repository' + analysis_status: + $ref: '#/components/schemas/code-scanning-variant-analysis-status' + result_count: + type: integer + description: The number of results in the case of a successful analysis. This is only available for successful analyses. + artifact_size_in_bytes: + type: integer + description: The size of the artifact. This is only available for successful analyses. + failure_message: + type: string + description: The reason of the failure of this repo task. This is only available if the repository task has failed. + required: + - repository + - analysis_status + skipped_repositories: + type: object + description: Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. + properties: + access_mismatch_repos: + $ref: '#/components/schemas/code-scanning-variant-analysis-skipped-repo-group' + not_found_repos: + type: object + properties: + repository_count: + type: integer + description: The total number of repositories that were skipped for this reason. + example: 2 + repository_full_names: + type: array + description: A list of full repository names that were skipped. This list may not include all repositories that were skipped. + items: + type: string + required: + - repository_count + - repository_full_names + no_codeql_db_repos: + $ref: '#/components/schemas/code-scanning-variant-analysis-skipped-repo-group' + over_limit_repos: + $ref: '#/components/schemas/code-scanning-variant-analysis-skipped-repo-group' + required: + - access_mismatch_repos + - not_found_repos + - no_codeql_db_repos + - over_limit_repos + required: + - id + - controller_repo + - actor + - query_language + - query_pack_url + - status + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + code-scanning-variant-analysis-repo-task: + type: object + properties: + repository: + $ref: '#/components/schemas/simple-repository' + analysis_status: + $ref: '#/components/schemas/code-scanning-variant-analysis-status' + artifact_size_in_bytes: + type: integer + description: The size of the artifact. This is only available for successful analyses. + result_count: + type: integer + description: The number of results in the case of a successful analysis. This is only available for successful analyses. + failure_message: + type: string + description: The reason of the failure of this repo task. This is only available if the repository task has failed. + database_commit_sha: + type: string + description: The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. + source_location_prefix: + type: string + description: The source location prefix to use. This is only available for successful analyses. + artifact_url: + type: string + description: The URL of the artifact. This is only available for successful analyses. + required: + - repository + - analysis_status + code-scanning-default-setup: + description: Configuration for code scanning default setup. + type: object + properties: + state: + description: Code scanning default setup has been configured or not. + type: string + enum: + - configured + - not-configured + languages: + description: Languages to be analyzed. + type: array + items: + type: string + enum: + - actions + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - javascript + - python + - ruby + - typescript + - swift + runner_type: + description: Runner type to be used. + nullable: true + type: string + enum: + - standard + - labeled + runner_label: + description: Runner label to be used if the runner type is labeled. + nullable: true + type: string + example: code-scanning + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + threat_model: + description: Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + type: string + enum: + - remote + - remote_and_local + updated_at: + description: Timestamp of latest configuration update. + nullable: true + type: string + format: date-time + example: '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + nullable: true + type: string + enum: + - weekly + x-github-breaking-changes: + - changeset: remove_single_js_ts + patch: + properties: + languages: + items: + enum: + - actions + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - python + - ruby + - swift + type: object + version: '2026-03-10' + code-scanning-default-setup-update: + description: Configuration for code scanning default setup. + type: object + properties: + state: + description: The desired state of code scanning default setup. + type: string + enum: + - configured + - not-configured + runner_type: + description: Runner type to be used. + type: string + enum: + - standard + - labeled + runner_label: + nullable: true + description: Runner label to be used if the runner type is labeled. + type: string + example: code-scanning + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + threat_model: + description: Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + type: string + enum: + - remote + - remote_and_local + languages: + description: CodeQL languages to be analyzed. + type: array + items: + type: string + enum: + - actions + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - python + - ruby + - swift + additionalProperties: false + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + code-scanning-default-setup-update-response: + description: |- + You can use `run_url` to track the status of the run. This includes a property status and conclusion. + You should not rely on this always being an actions workflow run object. + type: object + properties: + run_id: + description: ID of the corresponding run. + type: integer + run_url: + description: URL of the corresponding run. + type: string + code-scanning-analysis-commit-sha: + description: The SHA of the commit to which the analysis you are uploading relates. + type: string + minLength: 40 + maxLength: 40 + pattern: ^[0-9a-fA-F]+$ + code-scanning-ref-full: + type: string + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + pattern: ^refs/(heads|tags|pull)/.*$ + example: refs/heads/main + code-scanning-analysis-sarif-file: + description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." + type: string + code-scanning-sarifs-receipt: + type: object + properties: + id: + $ref: '#/components/schemas/code-scanning-analysis-sarif-id' + url: + type: string + description: The REST API URL for checking the status of the upload. + format: uri + readOnly: true + code-scanning-sarifs-status: + type: object + properties: + processing_status: + type: string + enum: + - pending + - complete + - failed + description: '`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed.' + analyses_url: + type: string + description: The REST API URL for getting the analyses associated with the upload. + format: uri + readOnly: true + nullable: true + errors: + type: array + items: + type: string + description: Any errors that ocurred during processing of the delivery. + readOnly: true + nullable: true + code-scanning-analysis-tool-name: + type: string + description: The name of the tool used to generate the code scanning analysis. + code-scanning-analysis-tool-guid: + nullable: true + type: string + description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. + alert-number: + type: integer + description: The security alert number. + readOnly: true + alert-created-at: + type: string + description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + alert-instances-url: + type: string + description: The REST API URL for fetching the list of instances for an alert. + format: uri + readOnly: true + code-scanning-alert-state: + type: string + description: State of a code scanning alert. + nullable: true + enum: + - open + - dismissed + - fixed + alert-fixed-at: + type: string + description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + alert-dismissed-at: + type: string + description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + code-scanning-alert-rule-summary: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect the alert. + name: + type: string + description: The name of the rule used to detect the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + security_severity_level: + nullable: true + type: string + description: The security severity of the alert. + enum: + - low + - medium + - high + - critical + description: + type: string + description: A short description of the rule used to detect the alert. + full_description: + type: string + description: A description of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string + help: + nullable: true + type: string + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + nullable: true + type: string + description: A link to the documentation for the rule used to detect the alert. + code-scanning-analysis-tool: + type: object + properties: + name: + $ref: '#/components/schemas/code-scanning-analysis-tool-name' + version: + $ref: '#/components/schemas/code-scanning-analysis-tool-version' + guid: + $ref: '#/components/schemas/code-scanning-analysis-tool-guid' + code-scanning-alert-instance: + type: object + properties: + ref: + $ref: '#/components/schemas/code-scanning-ref' + analysis_key: + $ref: '#/components/schemas/code-scanning-analysis-analysis-key' + environment: + $ref: '#/components/schemas/code-scanning-alert-environment' + category: + $ref: '#/components/schemas/code-scanning-analysis-category' + state: + $ref: '#/components/schemas/code-scanning-alert-state' + commit_sha: + type: string + message: + type: object + properties: + text: + type: string + markdown: + type: string + description: The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance. + location: + $ref: '#/components/schemas/code-scanning-alert-location' + html_url: + type: string + classifications: + type: array + description: |- + Classifications that have been applied to the file that triggered the alert. + For example identifying it as documentation, or a generated file. + items: + $ref: '#/components/schemas/code-scanning-alert-classification' + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-scanning-alert-rule: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect the alert. + name: + type: string + description: The name of the rule used to detect the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + security_severity_level: + nullable: true + type: string + description: The security severity of the alert. + enum: + - low + - medium + - high + - critical + description: + type: string + description: A short description of the rule used to detect the alert. + full_description: + type: string + description: A description of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string + help: + nullable: true + type: string + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + nullable: true + type: string + description: A link to the documentation for the rule used to detect the alert. + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + code-scanning-autofix-status: + type: string + description: The status of an autofix. + enum: + - pending + - error + - success + - outdated + code-scanning-autofix-description: + type: string + description: The description of an autofix. + nullable: true + code-scanning-autofix-started-at: + type: string + description: 'The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-analysis-analysis-key: + type: string + description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. + code-scanning-alert-environment: + type: string + description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. + code-scanning-analysis-category: + type: string + description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. + code-scanning-alert-instance-state: + type: string + description: State of a code scanning alert instance. + nullable: true + enum: + - open + - fixed + code-scanning-alert-location: + type: object + description: Describe a region within a file for the alert. + properties: + path: + type: string + start_line: + type: integer + end_line: + type: integer + start_column: + type: integer + end_column: + type: integer + code-scanning-alert-classification: + type: string + description: A classification of the file. For example to identify it as generated. + nullable: true + enum: + - source + - generated + - test + - library + code-scanning-analysis-environment: + type: string + description: Identifies the variable values associated with the environment in which this analysis was performed. + code-scanning-analysis-created-at: + type: string + description: 'The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-analysis-url: + type: string + description: The REST API URL of the analysis resource. + format: uri + readOnly: true + code-scanning-variant-analysis-repository: + title: Repository Identifier + description: Repository Identifier + type: object + properties: + id: + type: integer + example: 1296269 + description: A unique identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + private: + type: boolean + description: Whether the repository is private. + stargazers_count: + type: integer + example: 80 + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + required: + - full_name + - id + - name + - private + - stargazers_count + - updated_at + code-scanning-variant-analysis-status: + type: string + description: The new status of the CodeQL variant analysis repository task. + enum: + - pending + - in_progress + - succeeded + - failed + - canceled + - timed_out + code-scanning-variant-analysis-skipped-repo-group: + type: object + properties: + repository_count: + type: integer + description: The total number of repositories that were skipped for this reason. + example: 2 + repositories: + type: array + description: A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. + items: + $ref: '#/components/schemas/code-scanning-variant-analysis-repository' + required: + - repository_count + - repositories + code-scanning-analysis-tool-version: + nullable: true + type: string + description: The version of the tool used to generate the code scanning analysis. + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + not_modified: + description: Not modified + code_scanning_forbidden_read: + description: Response if GitHub Advanced Security is not enabled for this repository + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + code_scanning_forbidden_write: + description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + code_scanning_bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + default: + $ref: '#/components/examples/code-scanning-bad-request' + code_scanning_autofix_create_forbidden: + description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + unprocessable_analysis: + description: Response if analysis could not be processed + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + found: + description: Found + code_scanning_conflict: + description: Response if there is already a validation run in progress with a different default setup configuration + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + code_scanning_invalid_state: + description: Response if the configuration change cannot be made because the repository is not in the required state + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + tool-name: + name: tool_name + description: The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-analysis-tool-name' + tool-guid: + name: tool_guid + description: The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-analysis-tool-guid' + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + git-ref: + name: ref + description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-ref' + pr-alias: + name: pr + description: The number of the pull request for the results you want to list. + in: query + required: false + schema: + type: integer + alert-number: + name: alert_number + in: path + description: The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. + required: true + schema: + $ref: '#/components/schemas/alert-number' + examples: + code-scanning-organization-alert-items: + value: + - number: 4 + created_at: '2020-02-13T12:29:18Z' + url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 + html_url: https://github.com/octocat/hello-world/code-scanning/4 + state: open + dismissed_by: null + dismissed_at: null + dismissed_reason: null + dismissed_comment: null + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + - number: 3 + created_at: '2020-02-13T12:29:18Z' + url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 + html_url: https://github.com/octocat/hello-world/code-scanning/3 + state: dismissed + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: lib/ab12-gen.js + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: [] + instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + code-scanning-alert-items: + value: + - number: 4 + created_at: '2020-02-13T12:29:18Z' + url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4 + html_url: https://github.com/octocat/hello-world/code-scanning/4 + state: open + fixed_at: null + dismissed_by: null + dismissed_at: null + dismissed_reason: null + dismissed_comment: null + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances + - number: 3 + created_at: '2020-02-13T12:29:18Z' + url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3 + html_url: https://github.com/octocat/hello-world/code-scanning/3 + state: dismissed + fixed_at: null + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + rule: + id: js/zipslip + severity: error + tags: + - security + - external/cwe/cwe-022 + description: Arbitrary file write during zip extraction + name: js/zipslip + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: lib/ab12-gen.js + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: [] + instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances + code-scanning-alert: + value: + number: 42 + created_at: '2020-06-19T11:21:34Z' + url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 + html_url: https://github.com/octocat/hello-world/code-scanning/42 + state: dismissed + fixed_at: null + dismissed_by: + login: octocat + id: 54933897 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-02-14T12:29:18Z' + dismissed_reason: false positive + dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + rule: + id: js/zipslip + severity: error + security_severity_level: high + description: Arbitrary file write during zip extraction ("Zip Slip") + name: js/zipslip + full_description: Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten. + tags: + - security + - external/cwe/cwe-022 + help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...' + help_uri: https://codeql.github.com/ + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: dismissed + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances + code-scanning-alert-dismissed: + value: + number: 42 + created_at: '2020-08-25T21:28:36Z' + url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 + html_url: https://github.com/octocat/hello-world/code-scanning/42 + state: dismissed + fixed_at: null + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_at: '2020-09-02T22:34:56Z' + dismissed_reason: false positive + dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + rule: + id: js/zipslip + severity: error + security_severity_level: high + description: Arbitrary file write during zip extraction ("Zip Slip") + name: js/zipslip + full_description: Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten. + tags: + - security + - external/cwe/cwe-022 + help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...' + help_uri: https://codeql.github.com/ + tool: + name: CodeQL + guid: null + version: 2.4.0 + most_recent_instance: + ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '{}' + state: dismissed + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: spec-main/api-session-spec.ts + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - test + instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances + code-scanning-autofix: + value: + status: success + description: This fixes an XSS vulnerability by escaping the user input. + started_at: '2024-02-14T12:29:18Z' + code-scanning-autofix-pending: + value: + status: pending + description: null + started_at: '2024-02-14T12:29:18Z' + code-scanning-autofix-commits: + value: + target_ref: refs/heads/fix-bug + message: Let's fix this πŸͺ²! + code-scanning-autofix-commits-response: + value: + target_ref: refs/heads/main + sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 + code-scanning-alert-instances: + value: + - ref: refs/heads/main + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '' + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + state: open + commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 + message: + text: This path depends on a user-provided value. + location: + path: lib/ab12-gen.js + start_line: 917 + end_line: 917 + start_column: 7 + end_column: 18 + classifications: + - library + - ref: refs/pull/3740/merge + analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build + environment: '' + category: .github/workflows/codeql-analysis.yml:CodeQL-Build + state: fixed + commit_sha: b09da05606e27f463a2b49287684b4ae777092f2 + message: + text: This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1. + location: + path: app/script.js + start_line: 2 + end_line: 2 + start_column: 10 + end_column: 50 + classifications: + - source + code-scanning-analysis-items: + value: + - ref: refs/heads/main + commit_sha: d99612c3e1f2970085cfbaeadf8f010ef69bad83 + analysis_key: .github/workflows/codeql-analysis.yml:analyze + environment: '{"language":"python"}' + error: '' + category: .github/workflows/codeql-analysis.yml:analyze/language:python + created_at: '2020-08-27T15:05:21Z' + results_count: 17 + rules_count: 49 + id: 201 + url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201 + sarif_id: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 + tool: + name: CodeQL + guid: null + version: 2.4.0 + deletable: true + warning: '' + - ref: refs/heads/my-branch + commit_sha: c8cff6510d4d084fb1b4aa13b64b97ca12b07321 + analysis_key: .github/workflows/shiftleft.yml:build + environment: '{}' + error: '' + category: .github/workflows/shiftleft.yml:build/ + created_at: '2020-08-31T22:46:44Z' + results_count: 17 + rules_count: 32 + id: 200 + url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200 + sarif_id: 8981cd8e-b078-4ac3-a3be-1dad7dbd0b582 + tool: + name: Python Security Analysis + guid: null + version: 1.2.0 + deletable: true + warning: '' + code-scanning-analysis-default: + summary: application/json response + value: + ref: refs/heads/main + commit_sha: c18c69115654ff0166991962832dc2bd7756e655 + analysis_key: .github/workflows/codeql-analysis.yml:analyze + environment: '{"language":"javascript"}' + error: '' + category: .github/workflows/codeql-analysis.yml:analyze/language:javascript + created_at: '2021-01-13T11:55:49Z' + results_count: 3 + rules_count: 67 + id: 3602840 + url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201 + sarif_id: 47177e22-5596-11eb-80a1-c1e54ef945c6 + tool: + name: CodeQL + guid: null + version: 2.4.0 + deletable: true + warning: '' + code-scanning-analysis-sarif: + summary: application/sarif+json response + value: + runs: + - tool: + driver: + name: CodeQL + organization: GitHub + semanticVersion: 1.0.0 + rules: + - id: js/unused-local-variable + name: js/unused-local-variable + results: + - guid: 326aa09f-9af8-13cf-9851-3d0e5183ec38 + message: + text: Unused variable foo. + locations: + - physicalLocation: + artifactLocation: + uri: file1.js + region: + startLine: 1 + ruleId: js/unused-local-variable + properties: + - github/alertNumber: 2 + - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 + type: object + code-scanning-analysis-deletion: + summary: Default response + value: + next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 + confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete + code-scanning-codeql-databases: + value: + - id: 1 + name: database.zip + language: java + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: application/zip + size: 1024 + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c + - id: 2 + name: database.zip + language: ruby + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: application/zip + size: 1024 + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c + code-scanning-codeql-database: + value: + id: 1 + name: database.zip + language: java + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: application/zip + size: 1024 + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c + code-scanning-variant-analysis: + summary: Default response + value: + id: 1 + controller_repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + query_language: python + query_pack_url: https://www.example.com + created_at: '2022-09-12T12:14:32Z' + updated_at: '2022-09-12T12:14:32Z' + completed_at: '2022-09-12T13:15:33Z' + status: succeeded + actions_workflow_run_id: 3453588 + scanned_repositories: + - repository: + id: 1296269 + name: Hello-World + full_name: octocat/Hello-World + private: false + analysis_status: succeeded + result_count: 532 + artifact_size_in_bytes: 12345 + skipped_repositories: + access_mismatch_repos: + repository_count: 2 + repositories: + - id: 1 + name: octo-repo1 + full_name: octo-org/octo-repo1 + private: false + - id: 2 + name: octo-repo2 + full_name: octo-org/octo-repo2 + private: false + not_found_repos: + repository_count: 3 + repository_full_names: + - octo-org/octo-repo4 + - octo-org/octo-repo5 + - octo-org/octo-repo6 + no_codeql_db_repos: + repository_count: 2 + repositories: + - id: 7 + name: octo-repo7 + full_name: octo-org/octo-repo7 + private: false + - id: 8 + name: octo-repo8 + full_name: octo-org/octo-repo8 + private: false + over_limit_repos: + repository_count: 2 + repositories: + - id: 9 + name: octo-repo9 + full_name: octo-org/octo-repo9 + private: false + - id: 10 + name: octo-repo10 + full_name: octo-org/octo-repo10 + private: false + code-scanning-variant-analysis-repo-task: + summary: Default response + value: + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + analysis_status: succeeded + artifact_size_in_bytes: 12345 + result_count: 532 + database_commit_sha: 2d870c2a717a524627af38fa2da382188a096f90 + source_location_prefix: / + artifact_url: https://example.com + code-scanning-default-setup: + value: + state: configured + languages: + - ruby + - python + query_suite: default + threat_model: remote + updated_at: '2023-01-19T11:21:34Z' + schedule: weekly + code-scanning-default-setup-update: + value: + state: configured + threat_model: remote_and_local + code-scanning-default-setup-update-response: + value: + run_id: 42 + run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 + code-scanning-sarif-upload: + summary: Default response + value: + id: 47177e22-5596-11eb-80a1-c1e54ef945c6 + url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 + code-scanning-sarif-upload-status: + summary: Default response + value: + processing_status: complete + analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 + code-scanning-bad-request: + value: + message: The alert_number is not valid + documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + status: '400' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/code_security.yaml b/provider-dev/source/code_security.yaml new file mode 100644 index 0000000..765033a --- /dev/null +++ b/provider-dev/source/code_security.yaml @@ -0,0 +1,2907 @@ +openapi: 3.0.3 +info: + title: code_security API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/code-security/configurations: + get: + summary: Get code security configurations for an enterprise + description: |- + Lists all code security configurations available in an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configurations-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - name: per_page + in: query + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration-list' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + post: + summary: Create a code security configuration for an enterprise + description: |- + Creates a code security configuration in an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be unique within the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + default: false + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non provider patterns + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: High rish settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/defaults: + get: + summary: Get default code security configurations for an enterprise + description: |- + Lists the default code security configurations for an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-default-configurations' + examples: + default: + $ref: '#/components/examples/code-security-default-configurations' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}: + get: + summary: Retrieve a code security configuration of an enterprise + description: |- + Gets a code security configuration available in an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-single-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + patch: + summary: Update a custom code security configuration for an enterprise + description: |- + Updates a code security configuration in an enterprise. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/update-enterprise-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be unique across the enterprise. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-enterprise recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/enterprise-code-security-configuration' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + delete: + summary: Delete a code security configuration for an enterprise + description: |- + Deletes a code security configuration from an enterprise. + Repositories attached to the configuration will retain their settings but will no longer be associated with + the configuration. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach: + post: + summary: Attach an enterprise configuration to repositories + description: |- + Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + + If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-enterprise-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration to. + enum: + - all + - all_without_configurations + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: all + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults: + put: + summary: Set a code security configuration as a default for an enterprise + description: |- + Sets a code security configuration as a default to be applied to new repositories in your enterprise. + + This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + + The authenticated user must be an administrator for the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specify which types of repository this security configuration should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: Set this configuration to be enabled by default on all new repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specifies which types of repository this security configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + value: + default_for_new_repos: all + configuration: + $ref: '#/components/examples/code-security-configuration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories: + get: + summary: Get repositories associated with an enterprise code security configuration + description: |- + Lists the repositories associated with an enterprise code security configuration in an organization. + + The authenticated user must be an administrator of the enterprise in order to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-repositories-for-enterprise-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/configuration-id' + - name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: status + description: |- + A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + + Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + in: query + required: false + schema: + type: string + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-security-configuration-repositories' + examples: + default: + summary: Example of code security configuration repositories + value: + - status: attached + repository: + $ref: '#/components/examples/simple-repository' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations: + get: + summary: Get code security configurations for an organization + description: |- + Lists all code security configurations available in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: target_type + in: query + description: The target type of the code security configuration + required: false + schema: + type: string + enum: + - global + - all + default: all + - name: per_page + in: query + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration-list' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + post: + summary: Create a code security configuration + description: |- + Creates a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/create-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be unique within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + default: enabled + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + default: disabled + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + default: false + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + default: not_set + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non provider patterns + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + default: disabled + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + default: enforced + required: + - name + - description + examples: + default: + summary: Example for a code security configuration + value: + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependabot_alerts: enabled + dependabot_security_updates: not_set + secret_scanning: enabled + responses: + '201': + description: Successfully created code security configuration + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/defaults: + get: + summary: Get default code security configurations + description: |- + Lists the default code security configurations for an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-default-configurations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-default-configurations' + examples: + default: + $ref: '#/components/examples/code-security-default-configurations' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/detach: + delete: + summary: Detach configurations from repositories + description: |- + Detach code security configuration(s) from a set of repositories. + Repositories will retain their settings but will no longer be associated with the configuration. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/detach-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + selected_repository_ids: + type: array + description: An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. + minItems: 1 + maxItems: 250 + items: + type: integer + description: Unique identifier of the repository. + examples: + default: + summary: Example for detaching repositories from configurations. + value: + selected_repository_ids: + - 32 + - 91 + responses: + '204': + $ref: '#/components/responses/no_content' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}: + get: + summary: Get a code security configuration + description: |- + Gets a code security configuration available in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + patch: + summary: Update a code security configuration + description: |- + Updates a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/update-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + type: string + description: The name of the code security configuration. Must be unique within the organization. + description: + type: string + description: A description of the code security configuration + maxLength: 255 + advanced_security: + type: string + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + $ref: '#/components/schemas/code-scanning-default-setup-options' + code_scanning_options: + $ref: '#/components/schemas/code-scanning-options' + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + examples: + default: + summary: Example for updating a code security configuration + value: + name: octo-org recommended settings v2 + secret_scanning: disabled + code_scanning_default_setup: enabled + responses: + '200': + description: Response when a configuration is updated + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + $ref: '#/components/examples/code-security-configuration-updated' + '204': + description: Response when no new updates are made + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + delete: + summary: Delete a code security configuration + description: |- + Deletes the desired code security configuration from an organization. + Repositories attached to the configuration will retain their settings but will no longer be associated with + the configuration. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/delete-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}/attach: + post: + summary: Attach a configuration to repositories + description: |- + Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + + If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/attach-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + scope: + type: string + description: The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + enum: + - all + - all_without_configurations + - public + - private_or_internal + - selected + selected_repository_ids: + type: array + description: An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. + items: + type: integer + description: Unique identifier of the repository. + required: + - scope + examples: + default: + summary: Example for attaching a configuration to some repositories + value: + scope: selected + selected_repository_ids: + - 32 + - 91 + responses: + '202': + $ref: '#/components/responses/accepted' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}/defaults: + put: + summary: Set a code security configuration as a default for an organization + description: |- + Sets a code security configuration as a default to be applied to new repositories in your organization. + + This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/set-configuration-as-default + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specify which types of repository this security configuration should be applied to by default. + enum: + - all + - none + - private_and_internal + - public + examples: + default: + summary: Set this configuration to be enabled by default on all new repositories. + value: + default_for_new_repos: all + responses: + '200': + description: Default successfully changed. + content: + application/json: + schema: + type: object + properties: + default_for_new_repos: + type: string + description: Specifies which types of repository this security configuration is applied to by default. + enum: + - all + - none + - private_and_internal + - public + configuration: + $ref: '#/components/schemas/code-security-configuration' + examples: + default: + value: + default_for_new_repos: all + configuration: + $ref: '#/components/examples/code-security-configuration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /orgs/{org}/code-security/configurations/{configuration_id}/repositories: + get: + summary: Get repositories associated with a code security configuration + description: |- + Lists the repositories associated with a code security configuration in an organization. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-repositories-for-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/configuration-id' + - name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + default: 30 + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: status + description: |- + A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + + Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + in: query + required: false + schema: + type: string + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-security-configuration-repositories' + examples: + default: + summary: Example of code security configuration repositories + value: + - status: attached + repository: + $ref: '#/components/examples/simple-repository' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations + /repos/{owner}/{repo}/code-security-configuration: + get: + summary: Get the code security configuration associated with a repository + description: |- + Get the code security configuration that manages a repository's code security settings. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - code-security + operationId: code-security/get-configuration-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-security-configuration-for-repository' + examples: + default: + $ref: '#/components/examples/code-security-configuration-for-repository' + '204': + $ref: '#/components/responses/no_content' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: code-security + subcategory: configurations + x-stackQL-resource: configurations +components: + schemas: + code-security-configuration: + type: object + description: A code security configuration + properties: + id: + type: integer + description: The ID of the code security configuration + name: + type: string + description: The name of the code security configuration. Must be unique within the organization. + target_type: + type: string + description: The type of the code security configuration. + enum: + - global + - organization + - enterprise + description: + type: string + description: A description of the code security configuration + advanced_security: + type: string + description: The enablement status of GitHub Advanced Security + enum: + - enabled + - disabled + - code_security + - secret_protection + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action: + type: string + description: The enablement status of Automatic dependency submission + enum: + - enabled + - disabled + - not_set + dependency_graph_autosubmit_action_options: + type: object + description: Feature options for Automatic dependency submission + properties: + labeled_runners: + type: boolean + description: Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + dependabot_alerts: + type: string + description: The enablement status of Dependabot alerts + enum: + - enabled + - disabled + - not_set + dependabot_security_updates: + type: string + description: The enablement status of Dependabot security updates + enum: + - enabled + - disabled + - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true + properties: + allow_advanced: + nullable: true + type: boolean + description: Whether to allow repos which use advanced setup + code_scanning_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + code_scanning_default_setup_options: + type: object + description: Feature options for code scanning default setup + nullable: true + properties: + runner_type: + nullable: true + type: string + enum: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + nullable: true + type: string + description: The label of the runner to use for code scanning when runner_type is 'labeled'. + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning: + type: string + description: The enablement status of secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_push_protection: + type: string + description: The enablement status of secret scanning push protection + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass: + type: string + description: The enablement status of secret scanning delegated bypass + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_bypass_options: + type: object + description: Feature options for secret scanning delegated bypass + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + security_configuration_id: + type: integer + description: The ID of the security configuration associated with this bypass reviewer + secret_scanning_validity_checks: + type: string + description: The enablement status of secret scanning validity checks + enum: + - enabled + - disabled + - not_set + secret_scanning_non_provider_patterns: + type: string + description: The enablement status of secret scanning non-provider patterns + enum: + - enabled + - disabled + - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + private_vulnerability_reporting: + type: string + description: The enablement status of private vulnerability reporting + enum: + - enabled + - disabled + - not_set + enforcement: + type: string + description: The enforcement status for a security configuration + enum: + - enforced + - unenforced + url: + type: string + format: uri + description: The URL of the configuration + html_url: + type: string + format: uri + description: The URL of the configuration + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + code-scanning-options: + type: object + description: Security Configuration feature options for code scanning + nullable: true + properties: + allow_advanced: + nullable: true + type: boolean + description: Whether to allow repos which use advanced setup + code-scanning-default-setup-options: + type: object + description: Feature options for code scanning default setup + nullable: true + properties: + runner_type: + type: string + enum: + - standard + - labeled + - not_set + description: Whether to use labeled runners or standard GitHub runners. + runner_label: + nullable: true + type: string + description: The label of the runner to use for code scanning default setup when runner_type is 'labeled'. + code-security-default-configurations: + type: array + description: A list of default code security configurations + items: + type: object + properties: + default_for_new_repos: + enum: + - public + - private_and_internal + - all + description: The visibility of newly created repositories for which the code security configuration will be applied to by default + configuration: + $ref: '#/components/schemas/code-security-configuration' + code-security-configuration-repositories: + type: object + description: Repositories associated with a code security configuration and attachment status + properties: + status: + type: string + description: The attachment status of the code security configuration on the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + repository: + $ref: '#/components/schemas/simple-repository' + code-security-configuration-for-repository: + type: object + description: Code security configuration associated with a repository and attachment status + properties: + status: + type: string + description: The attachment status of the code security configuration on the repository. + enum: + - attached + - attaching + - detached + - removed + - enforced + - failed + - updating + - removed_by_enterprise + configuration: + $ref: '#/components/schemas/code-security-configuration' + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + not_modified: + description: Not modified + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + no_content: + description: A header with no content is returned. + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + configuration-id: + name: configuration_id + description: The unique identifier of the code security configuration. + in: path + required: true + schema: + type: integer + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + enterprise-code-security-configuration-list: + value: + - id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17 + html_url: https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise high risk repositories + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326 + html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + enterprise-code-security-configuration: + value: + id: 1325 + target_type: enterprise + name: High risk settings + description: This is a code security configuration for octo-enterprise + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 + html_url: https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1325/edit + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-default-configurations: + value: + - default_for_new_repos: public + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + - default_for_new_repos: private_and_internal + configuration: + id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + code-security-configuration: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 1325 + reviewer_id: 5678 + reviewer_type: TEAM + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + simple-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + code-security-configuration-list: + value: + - id: 17 + target_type: global + name: GitHub recommended + description: Suggested settings for Dependabot, secret scanning, and code scanning. + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: not_set + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: enabled + secret_scanning_non_provider_patterns: enabled + secret_scanning_delegated_alert_dismissal: not_set + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/17 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/view + created_at: '2023-12-04T15:58:07Z' + updated_at: '2023-12-04T15:58:07Z' + - id: 1326 + target_type: organization + name: High risk settings + description: This is a code security configuration for octo-org high risk repositories + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: enabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1326 + created_at: '2024-05-10T00:00:00Z' + updated_at: '2024-05-10T00:00:00Z' + code-security-configuration-updated: + value: + id: 1325 + target_type: organization + name: octo-org recommended settings v2 + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + code_scanning_default_setup_options: + runner_type: not_set + runner_label: null + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: disabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' + code-security-configuration-for-repository: + value: + status: attached + configuration: + id: 1325 + target_type: organization + name: octo-org recommended settings + description: This is a code security configuration for octo-org + advanced_security: enabled + dependency_graph: enabled + dependency_graph_autosubmit_action: enabled + dependency_graph_autosubmit_action_options: + labeled_runners: false + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: disabled + secret_scanning: enabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled + private_vulnerability_reporting: disabled + enforcement: enforced + url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 + html_url: https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325 + created_at: '2024-05-01T00:00:00Z' + updated_at: '2024-05-01T00:00:00Z' +servers: + - url: https://api.github.com diff --git a/provider-dev/source/codes_of_conduct.yaml b/provider-dev/source/codes_of_conduct.yaml new file mode 100644 index 0000000..41d9eaa --- /dev/null +++ b/provider-dev/source/codes_of_conduct.yaml @@ -0,0 +1,234 @@ +openapi: 3.0.3 +info: + title: codes_of_conduct API + description: github API + version: 1.1.4 +paths: + /codes_of_conduct: + get: + summary: Get all codes of conduct + description: Returns array of all GitHub's codes of conduct. + tags: + - codes-of-conduct + operationId: codes-of-conduct/get-all-codes-of-conduct + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-of-conduct' + examples: + default: + $ref: '#/components/examples/code-of-conduct-simple-items' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codes-of-conduct + subcategory: codes-of-conduct + x-stackQL-resource: codes_of_conduct + /codes_of_conduct/{key}: + get: + summary: Get a code of conduct + description: Returns information about the specified GitHub code of conduct. + tags: + - codes-of-conduct + operationId: codes-of-conduct/get-conduct-code + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct + parameters: + - name: key + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/code-of-conduct' + examples: + default: + $ref: '#/components/examples/code-of-conduct' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codes-of-conduct + subcategory: codes-of-conduct + x-stackQL-resource: codes_of_conduct +components: + schemas: + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + code-of-conduct-simple-items: + value: + - key: citizen_code_of_conduct + name: Citizen Code of Conduct + url: https://api.github.com/codes_of_conduct/citizen_code_of_conduct + html_url: http://citizencodeofconduct.org/ + - key: contributor_covenant + name: Contributor Covenant + url: https://api.github.com/codes_of_conduct/contributor_covenant + html_url: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ + code-of-conduct: + value: + key: contributor_covenant + name: Contributor Covenant + url: https://api.github.com/codes_of_conduct/contributor_covenant + body: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: http://contributor-covenant.org/version/1/4/ +servers: + - url: https://api.github.com diff --git a/provider-dev/source/codespaces.yaml b/provider-dev/source/codespaces.yaml new file mode 100644 index 0000000..1317ded --- /dev/null +++ b/provider-dev/source/codespaces.yaml @@ -0,0 +1,7554 @@ +openapi: 3.0.3 +info: + title: codespaces API + description: Endpoints to manage Codespaces using the REST API. + version: 1.1.4 +paths: + /orgs/{org}/codespaces: + get: + summary: List codespaces for the organization + description: |- + Lists the codespaces associated to a specified organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-in-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/codespaces/access: + put: + summary: Manage access control for organization codespaces + description: |- + Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-codespaces-access + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces + parameters: + - $ref: '#/components/parameters/org' + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + visibility: + type: string + description: Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. + enum: + - disabled + - selected_members + - all_members + - all_members_and_outside_collaborators + selected_usernames: + type: array + description: The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. + items: + type: string + maxItems: 100 + required: + - visibility + examples: + default: + value: + visibility: selected_members + selected_usernames: + - johnDoe + - atomIO + responses: + '204': + description: Response when successfully modifying permissions. + '304': + $ref: '#/components/responses/not_modified' + '400': + description: Users are neither members nor collaborators of this organization. + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/codespaces/access/selected_users: + post: + summary: Add users to Codespaces access for an organization + description: |- + Codespaces for the specified users will be billed to the organization. + + To use this endpoint, the access settings for the organization must be set to `selected_members`. + For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-codespaces-access-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization. + items: + type: string + maxItems: 100 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - johnDoe + - atomIO + responses: + '204': + description: Response when successfully modifying permissions. + '304': + $ref: '#/components/responses/not_modified' + '400': + description: Users are neither members nor collaborators of this organization. + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + delete: + summary: Remove users from Codespaces access for an organization + description: |- + Codespaces for the specified users will no longer be billed to the organization. + + To use this endpoint, the access settings for the organization must be set to `selected_members`. + For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-codespaces-access-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization + deprecated: true + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: The usernames of the organization members and outside collaborators whose codespaces should not be billed to the organization. + items: + type: string + maxItems: 100 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - johnDoe + - atomIO + responses: + '204': + description: Response when successfully modifying permissions. + '304': + $ref: '#/components/responses/not_modified' + '400': + description: Users are neither members nor collaborators of this organization. + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/codespaces/secrets: + get: + summary: List organization secrets + description: |- + Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-org-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/codespaces-org-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/public-key: + get: + summary: Get an organization public key + description: |- + Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-public-key' + examples: + default: + $ref: '#/components/examples/codespaces-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/{secret_name}: + get: + summary: Get an organization secret + description: |- + Gets an organization development environment secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-org-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + put: + summary: Create or update an organization secret + description: |- + Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-or-update-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: The ID of the key you used to encrypt the secret. + visibility: + type: string + description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. + items: + type: integer + required: + - visibility + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + delete: + summary: Delete an organization secret + description: |- + Deletes an organization development environment secret using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for an organization secret + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + put: + summary: Set selected repositories for an organization secret + description: |- + Replaces all repositories for an organization development environment secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict when visibility type not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization secret + description: |- + Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/add-selected-repo-to-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict when visibility type is not set to selected + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + delete: + summary: Remove selected repository from an organization secret + description: |- + Removes a repository from an organization development environment secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/remove-selected-repo-from-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response when repository was removed from the selected list + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict when visibility type not set to selected + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organization-secrets + x-stackQL-resource: organization_secrets + /orgs/{org}/members/{username}/codespaces: + get: + summary: List codespaces for a user in organization + description: |- + Lists the codespaces that a member of an organization has for repositories in that organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-codespaces-for-user-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/members/{username}/codespaces/{codespace_name}: + delete: + summary: Delete a codespace from the organization + description: |- + Deletes a user's codespace. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-from-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/codespace-name' + responses: + '202': + $ref: '#/components/responses/accepted' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop: + post: + summary: Stop a codespace for an organization user + description: |- + Stops a user's codespace. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/stop-in-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: organizations + x-stackQL-resource: organizations + /repos/{owner}/{repo}/codespaces: + get: + summary: List codespaces in a repository for the authenticated user + description: |- + Lists the codespaces associated to a specified repository and the authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-in-repository-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list-for-repository' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + post: + summary: Create a codespace in a repository + description: |- + Creates a codespace owned by the authenticated user in the specified repository. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-with-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + nullable: true + properties: + ref: + description: Git ref (typically a branch name) for this codespace + type: string + location: + description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. + type: string + geo: + description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. + type: string + enum: + - EuropeWest + - SoutheastAsia + - UsEast + - UsWest + client_ip: + description: IP for location auto-detection when proxying a request + type: string + machine: + description: Machine type to use for this codespace + type: string + devcontainer_path: + description: Path to devcontainer.json config to use for this codespace + type: string + multi_repo_permissions_opt_out: + description: Whether to authorize requested permissions from devcontainer.json + type: boolean + working_directory: + description: Working directory for this codespace + type: string + idle_timeout_minutes: + description: Time in minutes before codespace stops from inactivity + type: integer + display_name: + description: Display name for this codespace + type: string + retention_period_minutes: + description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + examples: + default: + value: + ref: main + machine: standardLinux32gb + responses: + '201': + description: Response when the codespace was successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '202': + description: Response when the codespace creation partially failed but is being retried in the background + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/devcontainers: + get: + summary: List devcontainer configurations in a repository for the authenticated user + description: |- + Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files + specify launchpoint configurations for codespaces created within the repository. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - devcontainers + properties: + total_count: + type: integer + devcontainers: + type: array + items: + type: object + required: + - path + properties: + path: + type: string + name: + type: string + display_name: + type: string + examples: + default: + $ref: '#/components/examples/codespaces-list-devcontainers-for-repository' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/machines: + get: + summary: List available machine types for a repository + description: |- + List the machine types available for a given repository based on its configuration. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/repo-machines-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: location + description: The location to check for available machines. Assigned by IP if not provided. + in: query + schema: + type: string + example: WestUs2 + - name: client_ip + description: IP for location auto-detection when proxying a request + in: query + schema: + type: string + - name: ref + description: The branch or commit to check for prebuild availability and devcontainer restrictions. + in: query + schema: + type: string + example: main + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machines + properties: + total_count: + type: integer + machines: + type: array + items: + $ref: '#/components/schemas/codespace-machine' + examples: + default: + $ref: '#/components/examples/codespace-machines-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: machines + x-stackQL-resource: machines + /repos/{owner}/{repo}/codespaces/new: + get: + summary: Get default attributes for a codespace + description: |- + Gets the default attributes for codespaces created by the user with the repository. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/pre-flight-with-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. + in: query + schema: + type: string + example: main + - name: client_ip + description: An alternative IP for default location auto-detection, such as when proxying a request. + in: query + schema: + type: string + example: 1.2.3.4 + responses: + '200': + description: Response when a user is able to create codespaces from the repository. + content: + application/json: + schema: + type: object + properties: + billable_owner: + $ref: '#/components/schemas/simple-user' + defaults: + type: object + required: + - location + - devcontainer_path + properties: + location: + type: string + devcontainer_path: + type: string + nullable: true + examples: + default: + $ref: '#/components/examples/codespaces-default-attributes-for-a-codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/permissions_check: + get: + summary: Check if permissions defined by a devcontainer have been accepted by the authenticated user + description: |- + Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/check-permissions-for-devcontainer + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + in: query + required: true + schema: + type: string + example: master + - name: devcontainer_path + description: Path to the devcontainer.json configuration to use for the permission check. + in: query + required: true + schema: + type: string + example: .devcontainer/example/devcontainer.json + responses: + '200': + description: Response when the permission check is successful + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-permissions-check-for-devcontainer' + examples: + default: + $ref: '#/components/examples/codespaces-permissions-check-for-devcontainer' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /repos/{owner}/{repo}/codespaces/secrets: + get: + summary: List repository secrets + description: |- + Lists all development environment secrets available in a repository without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-repo-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/repo-codespaces-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + /repos/{owner}/{repo}/codespaces/secrets/public-key: + get: + summary: Get a repository public key + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-repo-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-public-key' + examples: + default: + $ref: '#/components/examples/codespaces-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + /repos/{owner}/{repo}/codespaces/secrets/{secret_name}: + get: + summary: Get a repository secret + description: |- + Gets a single repository development environment secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repo-codespaces-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + put: + summary: Create or update a repository secret + description: |- + Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. + tags: + - codespaces + operationId: codespaces/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + delete: + summary: Delete a repository secret + description: |- + Deletes a development environment secret in a repository using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. + tags: + - codespaces + operationId: codespaces/delete-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: codespaces + subcategory: repository-secrets + x-stackQL-resource: repository_secrets + /repos/{owner}/{repo}/pulls/{pull_number}/codespaces: + post: + summary: Create a codespace from a pull request + description: |- + Creates a codespace owned by the authenticated user for the specified pull request. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-with-pr-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + nullable: true + properties: + location: + description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. + type: string + geo: + description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. + type: string + enum: + - EuropeWest + - SoutheastAsia + - UsEast + - UsWest + client_ip: + description: IP for location auto-detection when proxying a request + type: string + machine: + description: Machine type to use for this codespace + type: string + devcontainer_path: + description: Path to devcontainer.json config to use for this codespace + type: string + multi_repo_permissions_opt_out: + description: Whether to authorize requested permissions from devcontainer.json + type: boolean + working_directory: + description: Working directory for this codespace + type: string + idle_timeout_minutes: + description: Time in minutes before codespace stops from inactivity + type: integer + display_name: + description: Display name for this codespace + type: string + retention_period_minutes: + description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + examples: + default: + value: + repository_id: 1 + ref: main + responses: + '201': + description: Response when the codespace was successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '202': + description: Response when the codespace creation partially failed but is being retried in the background + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces: + get: + summary: List codespaces for the authenticated user + description: |- + Lists the authenticated user's codespaces. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/repository-id-in-query' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - codespaces + properties: + total_count: + type: integer + codespaces: + type: array + items: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespaces-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + post: + summary: Create a codespace for the authenticated user + description: |- + Creates a new codespace, owned by the authenticated user. + + This endpoint requires either a `repository_id` OR a `pull_request` but not both. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - repository_id + - pull_request + properties: + repository_id: + description: Repository id for this codespace + type: integer + ref: + description: Git ref (typically a branch name) for this codespace + type: string + location: + description: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. + type: string + geo: + description: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. + type: string + enum: + - EuropeWest + - SoutheastAsia + - UsEast + - UsWest + client_ip: + description: IP for location auto-detection when proxying a request + type: string + machine: + description: Machine type to use for this codespace + type: string + devcontainer_path: + description: Path to devcontainer.json config to use for this codespace + type: string + multi_repo_permissions_opt_out: + description: Whether to authorize requested permissions from devcontainer.json + type: boolean + working_directory: + description: Working directory for this codespace + type: string + idle_timeout_minutes: + description: Time in minutes before codespace stops from inactivity + type: integer + display_name: + description: Display name for this codespace + type: string + retention_period_minutes: + description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + pull_request: + required: + - pull_request_number + - repository_id + description: Pull request number for this codespace + type: object + properties: + pull_request_number: + description: Pull request number + type: integer + repository_id: + description: Repository id for this codespace + type: integer + examples: + default: + value: + repository_id: 1 + ref: main + geo: UsWest + responses: + '201': + description: Response when the codespace was successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '202': + description: Response when the codespace creation partially failed but is being retried in the background + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/secrets: + get: + summary: List secrets for the authenticated user + description: |- + Lists all development environment secrets available for a user's codespaces without revealing their + encrypted values. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-secrets-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/codespaces-secret' + examples: + default: + $ref: '#/components/examples/repo-codespaces-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/public-key: + get: + summary: Get public key for the authenticated user + description: |- + Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-public-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-user-public-key' + examples: + default: + $ref: '#/components/examples/codespaces-user-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/{secret_name}: + get: + summary: Get a secret for the authenticated user + description: |- + Gets a development environment secret available to a user's codespaces without revealing its encrypted value. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespaces-secret' + examples: + default: + $ref: '#/components/examples/user-codespaces-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update a secret for the authenticated user + description: |- + Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/create-or-update-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + selected_repository_ids: + type: array + description: An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. + items: + anyOf: + - type: integer + - type: string + required: + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + selected_repository_ids: + - '1234567' + - '2345678' + responses: + '201': + description: Response after successfully creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response after successfully updating a secret + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete a secret for the authenticated user + description: |- + Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for a user secret + description: |- + List the repositories that have been granted the ability to use a user's development environment secret. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/list-repositories-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-paginated' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Set selected repositories for a user secret + description: |- + Select the repositories that will use a user's development environment secret. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/set-repositories-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - '1296269' + - '1296280' + responses: + '204': + description: No Content when repositories were added to the selected list + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add a selected repository to a user secret + description: |- + Adds a repository to the selected repositories for a user's development environment secret. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/add-repository-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Remove a selected repository from a user secret + description: |- + Removes a repository from the selected repositories for a user's development environment secret. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/remove-repository-for-secret-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret + parameters: + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was removed from the selected list + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: secrets + x-stackQL-resource: secrets + /user/codespaces/{codespace_name}: + get: + summary: Get a codespace for the authenticated user + description: |- + Gets information about a user's codespace. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + patch: + summary: Update a codespace for the authenticated user + description: |- + Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. + + If you specify a new machine type it will be applied the next time your codespace is started. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/update-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + machine: + description: A valid machine to transition this codespace to. + type: string + display_name: + description: Display name for this codespace + type: string + recent_folders: + description: Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. + type: array + items: + type: string + examples: + default: + value: + machine: standardLinux + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + delete: + summary: Delete a codespace for the authenticated user + description: |- + Deletes a user's codespace. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/delete-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '202': + $ref: '#/components/responses/accepted' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/exports: + post: + summary: Export a codespace for the authenticated user + description: |- + Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. + + If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/export-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace-export-details' + examples: + default: + $ref: '#/components/examples/user-export-details' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/exports/{export_id}: + get: + summary: Get details about a codespace export + description: |- + Gets information about an export of a codespace. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/get-export-details-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export + parameters: + - $ref: '#/components/parameters/codespace-name' + - $ref: '#/components/parameters/export-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace-export-details' + examples: + default: + $ref: '#/components/examples/user-export-details' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/machines: + get: + summary: List machine types for a codespace + description: |- + List the machine types a codespace can transition to use. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/codespace-machines-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machines + properties: + total_count: + type: integer + machines: + type: array + items: + $ref: '#/components/schemas/codespace-machine' + examples: + default: + $ref: '#/components/examples/codespace-machines-list' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: machines + x-stackQL-resource: machines + /user/codespaces/{codespace_name}/publish: + post: + summary: Create a repository from an unpublished codespace + description: |- + Publishes an unpublished codespace, creating a new repository and assigning it to the codespace. + + The codespace's token is granted write permissions to the repository, allowing the user to push their changes. + + This will fail for a codespace that is already published, meaning it has an associated repository. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/publish-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace + parameters: + - $ref: '#/components/parameters/codespace-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: A name for the new repository. + type: string + private: + description: Whether the new repository should be private. + type: boolean + default: false + examples: + default: + value: + repository: monalisa-octocat-hello-world-g4wpq6h95q + private: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace-with-full-repository' + examples: + default: + $ref: '#/components/examples/codespace-with-full-repository' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/start: + post: + summary: Start a codespace for the authenticated user + description: |- + Starts a user's codespace. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/start-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '402': + description: Payment required + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces + /user/codespaces/{codespace_name}/stop: + post: + summary: Stop a codespace for the authenticated user + description: |- + Stops a user's codespace. + + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + tags: + - codespaces + operationId: codespaces/stop-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/codespace-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codespace' + examples: + default: + $ref: '#/components/examples/codespace' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: codespaces + subcategory: codespaces + x-stackQL-resource: codespaces +components: + schemas: + codespace: + type: object + title: Codespace + description: A codespace. + properties: + id: + type: integer + format: int64 + example: 1 + name: + description: Automatically generated name of this codespace. + type: string + example: monalisa-octocat-hello-world-g4wpq6h95q + display_name: + description: Display name for this codespace. + type: string + example: bookish space pancake + nullable: true + environment_id: + description: UUID identifying this codespace's environment. + type: string + example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + nullable: true + owner: + $ref: '#/components/schemas/simple-user' + billable_owner: + $ref: '#/components/schemas/simple-user' + repository: + $ref: '#/components/schemas/minimal-repository' + machine: + $ref: '#/components/schemas/nullable-codespace-machine' + devcontainer_path: + description: Path to devcontainer.json from repo root used to create Codespace. + type: string + example: .devcontainer/example/devcontainer.json + nullable: true + prebuild: + description: Whether the codespace was created from a prebuild. + type: boolean + example: false + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + last_used_at: + description: Last known time this codespace was started. + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + state: + description: State of this codespace. + enum: + - Unknown + - Created + - Queued + - Provisioning + - Available + - Awaiting + - Unavailable + - Deleted + - Moved + - Shutdown + - Archived + - Starting + - ShuttingDown + - Failed + - Exporting + - Updating + - Rebuilding + example: Available + type: string + url: + description: API URL for this codespace. + type: string + format: uri + git_status: + description: Details about the codespace's git repository. + type: object + properties: + ahead: + description: The number of commits the local repository is ahead of the remote. + type: integer + example: 0 + behind: + description: The number of commits the local repository is behind the remote. + type: integer + example: 0 + has_unpushed_changes: + description: Whether the local repository has unpushed changes. + type: boolean + has_uncommitted_changes: + description: Whether the local repository has uncommitted changes. + type: boolean + ref: + description: The current branch (or SHA if in detached HEAD state) of the local repository. + type: string + example: main + location: + description: The initally assigned location of a new codespace. + enum: + - EastUs + - SouthEastAsia + - WestEurope + - WestUs2 + example: WestUs2 + type: string + idle_timeout_minutes: + description: The number of minutes of inactivity after which this codespace will be automatically stopped. + type: integer + example: 60 + nullable: true + web_url: + description: URL to access this codespace on the web. + type: string + format: uri + machines_url: + description: API URL to access available alternate machine types for this codespace. + type: string + format: uri + start_url: + description: API URL to start this codespace. + type: string + format: uri + stop_url: + description: API URL to stop this codespace. + type: string + format: uri + publish_url: + description: API URL to publish this codespace to a new repository. + type: string + format: uri + nullable: true + pulls_url: + description: API URL for the Pull Request associated with this codespace, if any. + type: string + format: uri + nullable: true + recent_folders: + type: array + items: + type: string + runtime_constraints: + type: object + properties: + allowed_port_privacy_settings: + description: The privacy settings a user can select from when forwarding a port. + type: array + items: + type: string + nullable: true + pending_operation: + description: Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + type: boolean + nullable: true + pending_operation_disabled_reason: + description: Text to show user when codespace is disabled by a pending operation + type: string + nullable: true + idle_timeout_notice: + description: Text to show user when codespace idle timeout minutes has been overriden by an organization policy + type: string + nullable: true + retention_period_minutes: + description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + example: 60 + nullable: true + retention_expires_at: + description: When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" + type: string + format: date-time + example: '2011-01-26T20:01:12Z' + nullable: true + last_known_stop_notice: + description: The text to display to a user when a codespace has been stopped for a potentially actionable reason. + type: string + example: you've used 100% of your spending limit for Codespaces + nullable: true + required: + - id + - name + - environment_id + - owner + - billable_owner + - repository + - machine + - prebuild + - created_at + - updated_at + - last_used_at + - state + - url + - git_status + - location + - idle_timeout_minutes + - web_url + - machines_url + - start_url + - stop_url + - pulls_url + - recent_folders + codespaces-org-secret: + title: Codespaces Secret + description: Secrets for a GitHub Codespace. + type: object + properties: + name: + description: The name of the secret + example: SECRET_NAME + type: string + created_at: + description: The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + updated_at: + description: The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + visibility: + description: The type of repositories in the organization that the secret is visible to + enum: + - all + - private + - selected + type: string + selected_repositories_url: + description: The API URL at which the list of repositories this secret is visible to can be retrieved + type: string + format: uri + example: https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories + required: + - name + - created_at + - updated_at + - visibility + codespaces-public-key: + title: CodespacesPublicKey + description: The public key used for setting Codespaces secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + example: 2 + url: + type: string + example: https://api.github.com/user/keys/2 + title: + type: string + example: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + example: '2011-01-26T19:01:12Z' + required: + - key_id + - key + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + codespace-machine: + type: object + title: Codespace machine + description: A description of the machine powering a codespace. + properties: + name: + type: string + description: The name of the machine. + example: standardLinux + display_name: + type: string + description: The display name of the machine includes cores, memory, and storage. + example: 4 cores, 16 GB RAM, 64 GB storage + operating_system: + type: string + description: The operating system of the machine. + example: linux + storage_in_bytes: + type: integer + description: How much storage is available to the codespace. + example: 68719476736 + memory_in_bytes: + type: integer + description: How much memory is available to the codespace. + example: 17179869184 + cpus: + type: integer + description: How many cores are available to the codespace. + example: 4 + prebuild_availability: + type: string + description: Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. + example: ready + enum: + - none + - ready + - in_progress + nullable: true + required: + - name + - display_name + - operating_system + - storage_in_bytes + - memory_in_bytes + - cpus + - prebuild_availability + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + codespaces-permissions-check-for-devcontainer: + title: Codespaces Permissions Check + description: Permission check result for a given devcontainer config. + type: object + properties: + accepted: + description: Whether the user has accepted the permissions defined by the devcontainer config + example: true + type: boolean + required: + - accepted + repo-codespaces-secret: + title: Codespaces Secret + description: Set repository secrets for GitHub Codespaces. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + codespaces-secret: + title: Codespaces Secret + description: Secrets for a GitHub Codespace. + type: object + properties: + name: + description: The name of the secret + example: SECRET_NAME + type: string + created_at: + description: The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + updated_at: + description: The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + visibility: + description: The type of repositories in the organization that the secret is visible to + enum: + - all + - private + - selected + type: string + selected_repositories_url: + description: The API URL at which the list of repositories this secret is visible to can be retrieved + type: string + format: uri + example: https://api.github.com/user/secrets/SECRET_NAME/repositories + required: + - name + - created_at + - updated_at + - visibility + - selected_repositories_url + codespaces-user-public-key: + title: CodespacesUserPublicKey + description: The public key used for setting user Codespaces' Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + codespace-export-details: + type: object + title: Fetches information about an export of a codespace. + description: An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest + properties: + state: + type: string + description: State of the latest export + nullable: true + example: succeeded | failed | in_progress + completed_at: + description: Completion time of the last export operation + type: string + format: date-time + nullable: true + example: '2021-01-01T19:01:12Z' + branch: + type: string + description: Name of the exported branch + nullable: true + example: codespace-monalisa-octocat-hello-world-g4wpq6h95q + sha: + type: string + description: Git commit SHA of the exported branch + nullable: true + example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 + id: + type: string + description: Id for the export details + example: latest + export_url: + type: string + description: Url for fetching export details + example: https://api.github.com/user/codespaces/:name/exports/latest + html_url: + type: string + nullable: true + description: Web url for the exported branch + example: https://github.com/octocat/hello-world/tree/:branch + codespace-with-full-repository: + type: object + title: Codespace + description: A codespace. + properties: + id: + type: integer + format: int64 + example: 1 + name: + description: Automatically generated name of this codespace. + type: string + example: monalisa-octocat-hello-world-g4wpq6h95q + display_name: + description: Display name for this codespace. + type: string + example: bookish space pancake + nullable: true + environment_id: + description: UUID identifying this codespace's environment. + type: string + example: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + nullable: true + owner: + $ref: '#/components/schemas/simple-user' + billable_owner: + $ref: '#/components/schemas/simple-user' + repository: + $ref: '#/components/schemas/full-repository' + machine: + $ref: '#/components/schemas/nullable-codespace-machine' + devcontainer_path: + description: Path to devcontainer.json from repo root used to create Codespace. + type: string + example: .devcontainer/example/devcontainer.json + nullable: true + prebuild: + description: Whether the codespace was created from a prebuild. + type: boolean + example: false + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + last_used_at: + description: Last known time this codespace was started. + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + state: + description: State of this codespace. + enum: + - Unknown + - Created + - Queued + - Provisioning + - Available + - Awaiting + - Unavailable + - Deleted + - Moved + - Shutdown + - Archived + - Starting + - ShuttingDown + - Failed + - Exporting + - Updating + - Rebuilding + example: Available + type: string + url: + description: API URL for this codespace. + type: string + format: uri + git_status: + description: Details about the codespace's git repository. + type: object + properties: + ahead: + description: The number of commits the local repository is ahead of the remote. + type: integer + example: 0 + behind: + description: The number of commits the local repository is behind the remote. + type: integer + example: 0 + has_unpushed_changes: + description: Whether the local repository has unpushed changes. + type: boolean + has_uncommitted_changes: + description: Whether the local repository has uncommitted changes. + type: boolean + ref: + description: The current branch (or SHA if in detached HEAD state) of the local repository. + type: string + example: main + location: + description: The initally assigned location of a new codespace. + enum: + - EastUs + - SouthEastAsia + - WestEurope + - WestUs2 + example: WestUs2 + type: string + idle_timeout_minutes: + description: The number of minutes of inactivity after which this codespace will be automatically stopped. + type: integer + example: 60 + nullable: true + web_url: + description: URL to access this codespace on the web. + type: string + format: uri + machines_url: + description: API URL to access available alternate machine types for this codespace. + type: string + format: uri + start_url: + description: API URL to start this codespace. + type: string + format: uri + stop_url: + description: API URL to stop this codespace. + type: string + format: uri + publish_url: + description: API URL to publish this codespace to a new repository. + type: string + format: uri + nullable: true + pulls_url: + description: API URL for the Pull Request associated with this codespace, if any. + type: string + format: uri + nullable: true + recent_folders: + type: array + items: + type: string + runtime_constraints: + type: object + properties: + allowed_port_privacy_settings: + description: The privacy settings a user can select from when forwarding a port. + type: array + items: + type: string + nullable: true + pending_operation: + description: Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. + type: boolean + nullable: true + pending_operation_disabled_reason: + description: Text to show user when codespace is disabled by a pending operation + type: string + nullable: true + idle_timeout_notice: + description: Text to show user when codespace idle timeout minutes has been overriden by an organization policy + type: string + nullable: true + retention_period_minutes: + description: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). + type: integer + example: 60 + nullable: true + retention_expires_at: + description: When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" + type: string + format: date-time + example: '2011-01-26T20:01:12Z' + nullable: true + required: + - id + - name + - environment_id + - owner + - billable_owner + - repository + - machine + - prebuild + - created_at + - updated_at + - last_used_at + - state + - url + - git_status + - location + - idle_timeout_minutes + - web_url + - machines_url + - start_url + - stop_url + - pulls_url + - recent_folders + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + nullable-codespace-machine: + type: object + title: Codespace machine + description: A description of the machine powering a codespace. + properties: + name: + type: string + description: The name of the machine. + example: standardLinux + display_name: + type: string + description: The display name of the machine includes cores, memory, and storage. + example: 4 cores, 16 GB RAM, 64 GB storage + operating_system: + type: string + description: The operating system of the machine. + example: linux + storage_in_bytes: + type: integer + description: How much storage is available to the codespace. + example: 68719476736 + memory_in_bytes: + type: integer + description: How much memory is available to the codespace. + example: 17179869184 + cpus: + type: integer + description: How many cores are available to the codespace. + example: 4 + prebuild_availability: + type: string + description: Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. + example: ready + enum: + - none + - ready + - in_progress + nullable: true + required: + - name + - display_name + - operating_system + - storage_in_bytes + - memory_in_bytes + - cpus + - prebuild_availability + nullable: true + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + $ref: '#/components/schemas/nullable-repository' + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + $ref: '#/components/schemas/nullable-license-simple' + organization: + $ref: '#/components/schemas/nullable-simple-user' + parent: + $ref: '#/components/schemas/repository' + source: + $ref: '#/components/schemas/repository' + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct-simple' + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + responses: + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + codespace-name: + name: codespace_name + in: path + required: true + description: The name of the codespace. + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + pull-number: + name: pull_number + description: The number that identifies the pull request. + in: path + required: true + schema: + type: integer + repository-id-in-query: + name: repository_id + description: ID of the Repository to filter on + in: query + schema: + type: integer + export-id: + name: export_id + in: path + required: true + description: The ID of the export operation, or `latest`. Currently only `latest` is currently supported. + schema: + type: string + examples: + codespaces-list: + value: + total_count: 3 + codespaces: + - id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + recent_folders: [] + - id: 1 + name: monalisa-octocat-hello-world-3f89ada1j3 + environment_id: 526ce4d7-46da-494f-a4f9-cfd25b818719 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/foobar/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3 + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-3f89ada1j3.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop + recent_folders: [] + - id: 1 + name: monalisa-octocat-hello-world-f8adfad99a + environment_id: 6ac8cd6d-a2d0-4ae3-8cea-e135059264df + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-f8adfad99a.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop + recent_folders: [] + repo-codespaces-secret-paginated: + value: + total_count: 2 + secrets: + - name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + - name: GIST_ID + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + visibility: all + codespaces-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + repo-codespaces-secret: + value: + name: GH_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: all + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + codespace: + value: + id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + retention_period_minutes: 43200 + retention_expires_at: null + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + recent_folders: [] + template: null + codespaces-list-for-repository: + value: + total_count: 2 + codespaces: + - id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + recent_folders: [] + - id: 2 + name: monalisa-octocat-hello-world-3f89ada1j3 + environment_id: 526ce4d7-46da-494f-a4f9-cfd25b818719 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3 + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + web_url: https://monalisa-octocat-hello-world-3f89ada1j3.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop + recent_folders: [] + codespaces-list-devcontainers-for-repository: + value: + devcontainers: + - path: .devcontainer/foobar/devcontainer.json + name: foobar + display_name: foobar + - path: .devcontainer/devcontainer.json + name: kitchensink + display_name: kitchensink + - path: .devcontainer.json + display_name: Default project configuration + total_count: 3 + codespace-machines-list: + value: + total_count: 2 + machines: + - name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + - name: premiumLinux + display_name: 8 cores, 32 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 34359738368 + cpus: 8 + codespaces-default-attributes-for-a-codespace: + value: + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + defaults: + location: EastUs + devcontainer_path: .devcontainer/devcontainer.json + codespaces-permissions-check-for-devcontainer: + value: + accepted: true + codespaces-user-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + user-codespaces-secret: + value: + name: CODESPACE_GH_SECRET + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/user/codespaces/secrets/CODESPACE_GH_SECRET/repositories + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: null + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 + user-export-details: + value: + state: succeeded + completed_at: '2022-01-01T14:59:22Z' + branch: codespace-monalisa-octocat-hello-world-g4wpq6h95q + sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 + id: latest + export_url: https://api.github.com/user/codespaces/:name/exports/latest + codespace-with-full-repository: + value: + id: 1 + name: monalisa-octocat-hello-world-g4wpq6h95q + environment_id: 26a7c758-7299-4a73-b978-5a92a7ae98a0 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + billable_owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: null + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + machine: + name: standardLinux + display_name: 4 cores, 16 GB RAM, 64 GB storage + operating_system: linux + storage_in_bytes: 68719476736 + memory_in_bytes: 17179869184 + cpus: 4 + prebuild: false + devcontainer_path: .devcontainer/devcontainer.json + created_at: '2021-10-14T00:53:30-06:00' + updated_at: '2021-10-14T00:53:32-06:00' + last_used_at: '2021-10-14T00:53:30-06:00' + state: Available + url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q + git_status: + ahead: 0 + behind: 0 + has_unpushed_changes: false + has_uncommitted_changes: false + ref: main + location: WestUs2 + idle_timeout_minutes: 60 + retention_period_minutes: 43200 + retention_expires_at: null + web_url: https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev + machines_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines + start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start + stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + recent_folders: [] + template: null + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/copilot.yaml b/provider-dev/source/copilot.yaml new file mode 100644 index 0000000..8c05930 --- /dev/null +++ b/provider-dev/source/copilot.yaml @@ -0,0 +1,3632 @@ +openapi: 3.0.3 +info: + title: copilot API + description: Endpoints to manage Copilot using the REST API. + version: 1.1.4 +paths: + /enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day: + get: + summary: Get Copilot enterprise usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest: + get: + summary: Get Copilot enterprise usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-usage-metrics + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /enterprises/{enterprise}/copilot/metrics/reports/users-1-day: + get: + summary: Get Copilot users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest: + get: + summary: Get Copilot users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/billing: + get: + summary: Get Copilot seat information and settings for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets information about an organization's Copilot subscription, including seat breakdown + and feature policies. To configure these settings, go to your organization's settings on GitHub.com. + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)." + + Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/get-copilot-organization-details + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-organization-details' + examples: + default: + $ref: '#/components/examples/copilot-organization-details' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: There is a problem with your account's associated payment method. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/billing/seats: + get: + summary: List all Copilot seat assignments for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + Only organization owners can view assigned seats. + + Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/list-copilot-seats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 50 + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_seats: + type: integer + description: Total number of Copilot seats for the organization currently being billed. + seats: + type: array + items: + $ref: '#/components/schemas/copilot-seat-details' + examples: + default: + $ref: '#/components/examples/copilot-seats-list' + headers: + Link: + $ref: '#/components/headers/link' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/billing/selected_teams: + post: + summary: Add teams to the Copilot subscription for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Purchases a GitHub Copilot seat for all users within each specified team. + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + + The response contains the total number of new seats that were created and existing seats that were refreshed. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/add-copilot-seats-for-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_teams: + type: array + description: List of team names within the organization to which to grant access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_teams + examples: + default: + value: + selected_teams: + - engteam1 + - engteam2 + - engteam3 + required: true + responses: + '201': + description: OK + content: + application/json: + schema: + type: object + description: The total number of seats created for members of the specified team(s). + properties: + seats_created: + type: integer + required: + - seats_created + examples: + default: + value: + seats_created: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + delete: + summary: Remove teams from the Copilot subscription for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Sets seats for all members of each team specified to "pending cancellation". + This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + + Only organization owners can cancel Copilot seats for their organization members. + + The response contains the total number of seats set to "pending cancellation". + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/cancel-copilot-seat-assignment-for-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_teams: + type: array + description: The names of teams from which to revoke access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_teams + examples: + default: + value: + selected_teams: + - engteam1 + - engteam2 + - engteam3 + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: The total number of seats set to "pending cancellation" for members of the specified team(s). + properties: + seats_cancelled: + type: integer + required: + - seats_cancelled + examples: + default: + value: + seats_cancelled: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/billing/selected_users: + post: + summary: Add users to the Copilot subscription for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Purchases a GitHub Copilot seat for each user specified. + The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." + + Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." + + The response contains the total number of new seats that were created and existing seats that were refreshed. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/add-copilot-seats-for-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: The usernames of the organization members to be granted access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - cooluser1 + - hacker2 + - octocat + required: true + responses: + '201': + description: OK + content: + application/json: + schema: + type: object + description: The total number of seats created for the specified user(s). + properties: + seats_created: + type: integer + required: + - seats_created + examples: + default: + value: + seats_created: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + delete: + summary: Remove users from the Copilot subscription for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Sets seats for all users specified to "pending cancellation". + This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." + + Only organization owners can cancel Copilot seats for their organization members. + + The response contains the total number of seats set to "pending cancellation". + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/cancel-copilot-seat-assignment-for-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + content: + application/json: + schema: + type: object + properties: + selected_usernames: + type: array + description: The usernames of the organization members for which to revoke access to GitHub Copilot. + items: + type: string + minItems: 1 + required: + - selected_usernames + examples: + default: + value: + selected_usernames: + - cooluser1 + - hacker2 + - octocat + required: true + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: The total number of seats set to "pending cancellation" for the specified users. + properties: + seats_cancelled: + type: integer + required: + - seats_cancelled + examples: + default: + value: + seats_cancelled: 5 + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/copilot/coding-agent/permissions: + get: + summary: Get Copilot coding agent permissions for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets information about which repositories in an organization have been enabled + or disabled for the Copilot coding agent. + + Organization owners can configure whether Copilot coding agent is enabled for + all repositories, selected repositories, or no repositories owned by organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/get-copilot-coding-agent-permissions-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#get-copilot-coding-agent-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + type: string + description: The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`. + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`. + required: + - enabled_repositories + examples: + all_enabled: + summary: All repositories enabled + value: + enabled_repositories: all + selected_enabled: + summary: Selected repositories enabled + value: + enabled_repositories: selected + selected_repositories_url: https://api.github.com/orgs/my-org/copilot/coding-agent/permissions/repositories + none_enabled: + summary: No repositories enabled + value: + enabled_repositories: none + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + put: + summary: Set Copilot coding agent permissions for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Sets the policy for which repositories in an organization can use Copilot coding agent. + + Organization owners can configure whether Copilot coding agent is enabled for + all repositories, selected repositories, or no repositories owned by the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/set-copilot-coding-agent-permissions-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-copilot-coding-agent-permissions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_repositories: + type: string + description: The policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`. + enum: + - all + - selected + - none + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: selected + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + /orgs/{org}/copilot/coding-agent/permissions/repositories: + get: + summary: List repositories enabled for Copilot coding agent in an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Lists the selected repositories that are enabled for Copilot coding agent in an organization. + + Organization owners can use this endpoint when the coding agent repository policy + is set to `selected` to see which repositories have been enabled. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/list-copilot-coding-agent-selected-repositories-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#list-repositories-enabled-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + required: + - total_count + - repositories + examples: + default: + $ref: '#/components/examples/minimal-repository-paginated' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + put: + summary: Set selected repositories for Copilot coding agent in an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Replaces the list of selected repositories that are enabled for Copilot coding + agent in an organization. This method can only be called when the coding agent + repository policy is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/set-copilot-coding-agent-selected-repositories-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-selected-repositories-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + description: List of repository IDs to enable for Copilot coding agent. + type: array + items: + type: integer + description: Unique identifier of the repository. + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 32 + - 42 + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + /orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}: + put: + summary: Enable a repository for Copilot coding agent in an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Adds a repository to the list of selected repositories enabled for Copilot + coding agent in an organization. This method can only be called when the + coding agent repository policy is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - copilot + operationId: copilot/enable-copilot-coding-agent-for-repository-in-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#enable-a-repository-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + delete: + summary: Disable a repository for Copilot coding agent in an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Removes a repository from the list of selected repositories enabled for Copilot + coding agent in an organization. This method can only be called when the + coding agent repository policy is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/disable-copilot-coding-agent-for-repository-in-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-coding-agent-management#disable-a-repository-for-copilot-coding-agent-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-coding-agent-management + x-stackQL-resource: copilot_coding_agent_management + /orgs/{org}/copilot/content_exclusion: + get: + summary: Get Copilot content exclusion rules for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets information about an organization's Copilot content exclusion path rules. + To configure these settings, go to the organization's settings on GitHub. + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + + Organization owners can view details about Copilot content exclusion rules for the organization. + + OAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint. + + > [!CAUTION] + > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. + tags: + - copilot + operationId: copilot/copilot-content-exclusion-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-organization-content-exclusion-details' + examples: + default: + $ref: '#/components/examples/copilot-organization-content-exclusion-details' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-content-exclusion-management + x-stackQL-resource: copilot_content_exclusion_management + put: + summary: Set Copilot content exclusion rules for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Sets Copilot content exclusion path rules for an organization. + To configure these settings, go to the organization's settings on GitHub. + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + + Organization owners can set Copilot content exclusion rules for the organization. + + OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + + > [!CAUTION] + > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + tags: + - copilot + operationId: copilot/set-copilot-content-exclusion-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + description: The content exclusion rules to set + required: true + content: + application/json: + schema: + type: object + additionalProperties: + type: array + items: + anyOf: + - type: string + description: The path to the file that will be excluded. + - type: object + properties: + ifAnyMatch: + type: array + items: + type: string + required: + - ifAnyMatch + additionalProperties: false + - type: object + properties: + ifNoneMatch: + type: array + items: + type: string + required: + - ifNoneMatch + additionalProperties: false + examples: + default: + summary: Example of content exclusion paths + value: + octo-repo: + - /src/some-dir/kernel.rs + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + default: + value: + message: Content exclusion rules updated successfully. + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '413': + $ref: '#/components/responses/too_large' + '422': + $ref: '#/components/responses/validation_failed_simple' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: null + enabledForGitHubApps: true + category: copilot + subcategory: copilot-content-exclusion-management + x-stackQL-resource: copilot_content_exclusion_management + /orgs/{org}/copilot/metrics: + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/page' + - name: per_page + description: The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 100 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/copilot-usage-metrics-day' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-for-day' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/usage_metrics_api_disabled' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics + x-stackQL-resource: copilot_metrics + /orgs/{org}/copilot/metrics/reports/organization-1-day: + get: + summary: Get Copilot organization usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/metrics/reports/organization-28-day/latest: + get: + summary: Get Copilot organization usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization. + + The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-usage-metrics + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/metrics/reports/users-1-day: + get: + summary: Get Copilot organization users usage metrics for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-one-day-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics-for-a-specific-day + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/day' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-1-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-1-day-report' + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/copilot/metrics/reports/users-28-day/latest: + get: + summary: Get Copilot organization users usage metrics + description: |- + Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization. + + The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement. + + Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-users-usage-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-users-usage-metrics + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-usage-metrics-28-day-report' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-28-day-report' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics + x-stackQL-resource: copilot_usage_metrics + /orgs/{org}/members/{username}/copilot: + get: + summary: Get Copilot seat assignment details for a user + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + + The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). + + Only organization owners can view Copilot seat assignment details for members of their organization. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/get-copilot-seat-details-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '200': + description: The user's GitHub Copilot seat details, including usage. + content: + application/json: + schema: + $ref: '#/components/schemas/copilot-seat-details' + examples: + default: + $ref: '#/components/examples/copilot-seat-detail-active' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + x-stackQL-resource: copilot_user_management + /orgs/{org}/team/{team_slug}/copilot/metrics: + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/page' + - name: per_page + description: The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 100 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/copilot-usage-metrics-day' + examples: + default: + $ref: '#/components/examples/copilot-usage-metrics-for-day' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/usage_metrics_api_disabled' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics + x-stackQL-resource: copilot_metrics +components: + schemas: + copilot-usage-metrics-1-day-report: + type: object + title: Copilot Metrics 1 Day Report + description: Links to download the Copilot usage metrics report for an enterprise/organization for a specific day. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day. + report_day: + type: string + format: date + description: The day of the report in `YYYY-MM-DD` format. + required: + - download_links + - report_day + copilot-usage-metrics-28-day-report: + type: object + title: Copilot Metrics 28 Day Report + description: Links to download the latest Copilot usage metrics report for an enterprise/organization. + properties: + download_links: + type: array + items: + type: string + format: uri + description: The URLs to download the latest Copilot usage metrics report for the enterprise/organization. + report_start_day: + type: string + format: date + description: The start date of the report period in `YYYY-MM-DD` format. + report_end_day: + type: string + format: date + description: The end date of the report period in `YYYY-MM-DD` format. + required: + - download_links + - report_start_day + - report_end_day + copilot-organization-details: + title: Copilot Organization Details + description: Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. + type: object + properties: + seat_breakdown: + $ref: '#/components/schemas/copilot-organization-seat-breakdown' + public_code_suggestions: + type: string + description: The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). + enum: + - allow + - block + - unconfigured + ide_chat: + type: string + description: The organization policy for allowing or disallowing Copilot Chat in the IDE. + enum: + - enabled + - disabled + - unconfigured + platform_chat: + type: string + description: The organization policy for allowing or disallowing Copilot features on GitHub.com. + enum: + - enabled + - disabled + - unconfigured + cli: + type: string + description: The organization policy for allowing or disallowing Copilot CLI. + enum: + - enabled + - disabled + - unconfigured + seat_management_setting: + type: string + description: The mode of assigning new seats. + enum: + - assign_all + - assign_selected + - disabled + - unconfigured + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, when applicable. + enum: + - business + - enterprise + required: + - seat_breakdown + - public_code_suggestions + - seat_management_setting + additionalProperties: true + copilot-seat-details: + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, team, or organization. + type: object + properties: + assignee: + $ref: '#/components/schemas/nullable-simple-user' + organization: + $ref: '#/components/schemas/nullable-organization-simple' + assigning_team: + description: The team through which the assignee is granted access to GitHub Copilot, if applicable. + nullable: true + title: Team + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + sync_to_organizations: + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: Justice League + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + - created_at + - updated_at + - group_id + pending_cancellation_date: + type: string + format: date + nullable: true + description: The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. + last_activity_at: + type: string + format: date-time + nullable: true + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. + last_activity_editor: + type: string + nullable: true + description: Last editor that was used by the user for a GitHub Copilot completion. + last_authenticated_at: + type: string + format: date-time + nullable: true + description: Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: '**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee''s GitHub Copilot access was last updated, in ISO 8601 format.' + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, when applicable. + enum: + - business + - enterprise + - unknown + required: + - created_at + additionalProperties: false + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + copilot-organization-content-exclusion-details: + title: Copilot Organization Content Exclusion Details + description: List all Copilot Content Exclusion rules for an organization. + type: object + additionalProperties: + type: array + items: + type: string + description: The path to the file that will be excluded. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. + copilot_ide_code_completions: + $ref: '#/components/schemas/copilot-ide-code-completions' + copilot_ide_chat: + $ref: '#/components/schemas/copilot-ide-chat' + copilot_dotcom_chat: + $ref: '#/components/schemas/copilot-dotcom-chat' + copilot_dotcom_pull_requests: + $ref: '#/components/schemas/copilot-dotcom-pull-requests' + required: + - date + additionalProperties: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + copilot-organization-seat-breakdown: + title: Copilot Seat Breakdown + description: The breakdown of Copilot Business seats for the organization. + type: object + properties: + total: + type: integer + description: The total number of seats being billed for the organization as of the current billing cycle. + added_this_cycle: + type: integer + description: Seats added during the current billing cycle. + pending_cancellation: + type: integer + description: The number of seats that are pending cancellation at the end of the current billing cycle. + pending_invitation: + type: integer + description: The number of users who have been invited to receive a Copilot seat through this organization. + active_this_cycle: + type: integer + description: The number of seats that have used Copilot during the current billing cycle. + inactive_this_cycle: + type: integer + description: The number of seats that have not used Copilot during the current billing cycle. + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + nullable: true + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: Justice League + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - name + - html_url + - slug + - created_at + - updated_at + - group_id + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for the given editor. + items: + type: object + description: Usage metrics for a given language for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by Copilot code completions for the given editor, for the given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. + copilot-ide-chat: + type: object + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. + copilot-dotcom-chat: + type: object + description: Usage metrics for Copilot Chat in GitHub.com + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + description: The training date for the custom model (if applicable). + nullable: true + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: object + description: Usage metrics for Copilot for pull requests. + nullable: true + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: string + nullable: true + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + too_large: + description: Payload Too Large + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + usage_metrics_api_disabled: + description: Copilot Usage Metrics API setting is disabled at the organization or enterprise level. + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + no_content: + description: A header with no content is returned. + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + day: + name: day + description: The day to request data for, in `YYYY-MM-DD` format. + in: query + required: true + schema: + type: string + format: date + example: '2025-10-13' + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + examples: + copilot-usage-metrics-1-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_day: '2025-07-01' + copilot-usage-metrics-28-day-report: + value: + download_links: + - https://example.com/copilot-usage-report-1.json + - https://example.com/copilot-usage-report-2.json + report_start_day: '2025-07-01' + report_end_day: '2025-07-28' + copilot-organization-details: + value: + seat_breakdown: + total: 12 + added_this_cycle: 9 + pending_invitation: 0 + pending_cancellation: 0 + active_this_cycle: 12 + inactive_this_cycle: 11 + seat_management_setting: assign_selected + ide_chat: enabled + platform_chat: enabled + cli: enabled + public_code_suggestions: block + plan_type: business + copilot-seats-list: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: null + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + minimal-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + organization: null + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + forks: 1 + open_issues: 1 + watchers: 1 + copilot-organization-content-exclusion-details: + value: + octo-repo: + - /src/some-dir/kernel.rs + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: null + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + copilot-seat-detail-active: + value: + created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: null + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/credentials.yaml b/provider-dev/source/credentials.yaml new file mode 100644 index 0000000..3b30169 --- /dev/null +++ b/provider-dev/source/credentials.yaml @@ -0,0 +1,127 @@ +openapi: 3.0.3 +info: + title: credentials API + description: Revoke compromised or leaked GitHub credentials. + version: 1.1.4 +paths: + /credentials/revoke: + post: + summary: Revoke a list of credentials + description: |- + Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + + This endpoint currently accepts the following credential types: + - Personal access tokens (classic) (`ghp_`) + - Fine-grained personal access tokens (`github_pat_`) + - OAuth app access tokens (`gho_`) + - User-to-server tokens from GitHub Apps (`ghu_`) + - Refresh tokens from GitHub Apps (`ghr_`) + + + Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + + To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + + > [!NOTE] + > Any authenticated requests will return a 403. + tags: + - credentials + operationId: credentials/revoke + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + description: A list of credentials to be revoked, up to 1000 per request. + items: + type: string + minItems: 1 + maxItems: 1000 + required: + - credentials + examples: + default: + value: + credentials: + - ghp_1234567890abcdef1234567890abcdef12345678 + - github_pat_0A1B2C3D4E5F6G7H8I9J0K_ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456 + - gho_1234567890abcdef1234567890abcdef12345678 + - ghu_1234567890abcdef1234567890abcdef12345678 + - ghr_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab + responses: + '202': + $ref: '#/components/responses/accepted' + '422': + $ref: '#/components/responses/validation_failed_simple' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: credentials + subcategory: revoke + x-stackQL-resource: revoke +components: + schemas: + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' +servers: + - url: https://api.github.com diff --git a/provider-dev/source/dependabot.yaml b/provider-dev/source/dependabot.yaml new file mode 100644 index 0000000..23bcef2 --- /dev/null +++ b/provider-dev/source/dependabot.yaml @@ -0,0 +1,4192 @@ +openapi: 3.0.3 +info: + title: dependabot API + description: Endpoints to manage Dependabot. + version: 1.1.4 +paths: + /enterprises/{enterprise}/dependabot/alerts: + get: + summary: List Dependabot alerts for an enterprise + description: |- + Lists Dependabot alerts for repositories that are owned by the specified enterprise. + + The authenticated user must be a member of the enterprise to use this endpoint. + + Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-classifications' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-epss' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-has' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-assignees' + - $ref: '#/components/parameters/dependabot-alert-scope' + - $ref: '#/components/parameters/dependabot-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dependabot-alert-with-repository' + examples: + default: + $ref: '#/components/examples/dependabot-alerts-for-organization' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /organizations/{org}/dependabot/repository-access: + get: + summary: Lists the repositories Dependabot can access in an organization + description: |- + Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + > [!NOTE] + > This operation supports both server-to-server and user-to-server access. + Unauthorized users will not see the existence of this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-repository-access-details' + examples: + default: + $ref: '#/components/examples/dependabot-repository-access-details' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + x-stackQL-resource: repository_access + patch: + summary: Updates Dependabot's repository access list for an organization + description: |- + Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + + > [!NOTE] + > This operation supports both server-to-server and user-to-server access. + Unauthorized users will not see the existence of this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + x-stackQL-resource: repository_access + /organizations/{org}/dependabot/repository-access/default-level: + put: + summary: Set the default repository access level for Dependabot + description: |- + Sets the default level of repository access Dependabot will have while performing an update. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + Unauthorized users will not see the existence of this endpoint. + + This operation supports both server-to-server and user-to-server access. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + x-stackQL-resource: repository_access + /orgs/{org}/dependabot/alerts: + get: + summary: List Dependabot alerts for an organization + description: |- + Lists Dependabot alerts for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - dependabot + operationId: dependabot/list-alerts-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-classifications' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-epss' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-artifact-registry' + - $ref: '#/components/parameters/dependabot-alert-org-scope-comma-separated-has' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-assignees' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-runtime-risk' + - $ref: '#/components/parameters/dependabot-alert-scope' + - $ref: '#/components/parameters/dependabot-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dependabot-alert-with-repository' + examples: + default: + $ref: '#/components/examples/dependabot-alerts-for-organization' + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /orgs/{org}/dependabot/secrets: + get: + summary: List organization secrets + description: |- + Lists all secrets available in an organization without revealing their + encrypted values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-org-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/organization-dependabot-secret' + examples: + default: + $ref: '#/components/examples/organization-dependabot-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/public-key: + get: + summary: Get an organization public key + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-public-key' + examples: + default: + $ref: '#/components/examples/dependabot-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/{secret_name}: + get: + summary: Get an organization secret + description: |- + Gets a single organization secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/get-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-dependabot-secret' + examples: + default: + $ref: '#/components/examples/organization-dependabot-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update an organization secret + description: |- + Creates or updates an organization secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/create-or-update-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + visibility: + type: string + description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + enum: + - all + - private + - selected + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. + items: + anyOf: + - type: integer + - type: string + required: + - visibility + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-github-breaking-changes: + - changeset: remove_string_type_from_repo_id_param + patch: + - op: replace + path: /requestBody/content/application~1json/schema/properties/selected_repository_ids/items + value: + type: integer + version: '2026-03-10' + x-stackQL-resource: secrets + delete: + summary: Delete an organization secret + description: |- + Deletes a secret in an organization using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/delete-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/{secret_name}/repositories: + get: + summary: List selected repositories for an organization secret + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Set selected repositories for an organization secret + description: |- + Replaces all repositories for an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/set-selected-repos-for-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}: + put: + summary: Add selected repository to an organization secret + description: |- + Adds a repository to an organization secret when the `visibility` for + repository access is set to `selected`. The visibility is set when you [Create or + update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/add-selected-repo-to-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: No Content when repository was added to the selected list + '409': + description: Conflict when visibility type is not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Remove selected repository from an organization secret + description: |- + Removes a repository from an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/remove-selected-repo-from-org-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + - name: repository_id + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response when repository was removed from the selected list + '409': + description: Conflict when visibility type not set to selected + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/dependabot/alerts: + get: + summary: List Dependabot alerts for a repository + description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - dependabot + operationId: dependabot/list-alerts-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-classifications' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-states' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-severities' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-ecosystems' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-packages' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-manifests' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-epss' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-has' + - $ref: '#/components/parameters/dependabot-alert-comma-separated-assignees' + - $ref: '#/components/parameters/dependabot-alert-scope' + - $ref: '#/components/parameters/dependabot-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/dependabot-alert' + examples: + default: + $ref: '#/components/examples/dependabot-alerts-for-repository' + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /repos/{owner}/{repo}/dependabot/alerts/{alert_number}: + get: + summary: Get a Dependabot alert + description: OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - dependabot + operationId: dependabot/get-alert + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/dependabot-alert-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-alert' + examples: + default: + $ref: '#/components/examples/dependabot-alert-open' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + patch: + summary: Update a Dependabot alert + description: |- + The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - dependabot + operationId: dependabot/update-alert + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/dependabot-alert-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: |- + The state of the Dependabot alert. + A `dismissed_reason` must be provided when setting the state to `dismissed`. + enum: + - dismissed + - open + dismissed_reason: + type: string + description: '**Required when `state` is `dismissed`.** A reason for dismissing the alert.' + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + dismissed_comment: + type: string + description: An optional comment associated with dismissing the alert. + maxLength: 280 + assignees: + type: array + description: |- + Usernames to assign to this Dependabot Alert. + Pass one or more user logins to _replace_ the set of assignees on this alert. + Send an empty array (`[]`) to clear all assignees from the alert. + items: + type: string + additionalProperties: false + required: + - state + - assignees + examples: + default: + value: + state: dismissed + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-alert' + examples: + default: + $ref: '#/components/examples/dependabot-alert-dismissed' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: dependabot + subcategory: alerts + x-stackQL-resource: alerts + /repos/{owner}/{repo}/dependabot/secrets: + get: + summary: List repository secrets + description: |- + Lists all secrets available in a repository without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/list-repo-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + $ref: '#/components/schemas/dependabot-secret' + examples: + default: + $ref: '#/components/examples/dependabot-secret-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/dependabot/secrets/public-key: + get: + summary: Get a repository public key + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. Anyone with read access + to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + tags: + - dependabot + operationId: dependabot/get-repo-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-public-key' + examples: + default: + $ref: '#/components/examples/dependabot-public-key' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + /repos/{owner}/{repo}/dependabot/secrets/{secret_name}: + get: + summary: Get a repository secret + description: |- + Gets a single repository secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/get-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependabot-secret' + examples: + default: + $ref: '#/components/examples/dependabot-secret' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + put: + summary: Create or update a repository secret + description: |- + Creates or updates a repository secret with an encrypted value. Encrypt your secret using + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/create-or-update-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + type: string + description: ID of the key you used to encrypt the secret. + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets + delete: + summary: Delete a repository secret + description: |- + Deletes a secret in a repository using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - dependabot + operationId: dependabot/delete-repo-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: secrets + x-stackQL-resource: secrets +components: + schemas: + dependabot-alert-with-repository: + type: object + description: A Dependabot alert. + properties: + number: + $ref: '#/components/schemas/alert-number' + state: + type: string + description: The state of the Dependabot alert. + readOnly: true + enum: + - auto_dismissed + - dismissed + - fixed + - open + dependency: + type: object + description: Details for the vulnerable dependency. + readOnly: true + properties: + package: + $ref: '#/components/schemas/dependabot-alert-package' + manifest_path: + type: string + description: The full path to the dependency manifest file, relative to the root of the repository. + readOnly: true + scope: + type: string + description: The execution scope of the vulnerable dependency. + readOnly: true + nullable: true + enum: + - development + - runtime + relationship: + type: string + description: | + The vulnerable dependency's relationship to your project. + + > [!NOTE] + > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + readOnly: true + nullable: true + enum: + - unknown + - direct + - transitive + - inconclusive + security_advisory: + $ref: '#/components/schemas/dependabot-alert-security-advisory' + security_vulnerability: + $ref: '#/components/schemas/dependabot-alert-security-vulnerability' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_reason: + type: string + description: The reason that the alert was dismissed. + nullable: true + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + dismissed_comment: + type: string + description: An optional comment associated with the alert's dismissal. + nullable: true + maxLength: 280 + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + auto_dismissed_at: + $ref: '#/components/schemas/alert-auto-dismissed-at' + dismissal_request: + $ref: '#/components/schemas/dependabot-alert-dismissal-request-simple' + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + $ref: '#/components/schemas/simple-user' + repository: + $ref: '#/components/schemas/simple-repository' + required: + - number + - state + - dependency + - security_advisory + - security_vulnerability + - url + - html_url + - created_at + - updated_at + - dismissed_at + - dismissed_by + - dismissed_reason + - dismissed_comment + - fixed_at + - repository + additionalProperties: false + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + $ref: '#/components/schemas/nullable-simple-repository' + additionalProperties: false + organization-dependabot-secret: + title: Dependabot Secret for an Organization + description: Secrets for GitHub Dependabot for an organization. + type: object + properties: + name: + description: The name of the secret. + example: SECRET_TOKEN + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + visibility: + description: Visibility of a secret + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories + required: + - name + - created_at + - updated_at + - visibility + dependabot-public-key: + title: DependabotPublicKey + description: The public key used for setting Dependabot Secrets. + type: object + properties: + key_id: + description: The identifier for the key. + type: string + example: '1234567' + key: + description: The Base64 encoded public key. + type: string + example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + dependabot-alert: + type: object + description: A Dependabot alert. + properties: + number: + $ref: '#/components/schemas/alert-number' + state: + type: string + description: The state of the Dependabot alert. + readOnly: true + enum: + - auto_dismissed + - dismissed + - fixed + - open + dependency: + type: object + description: Details for the vulnerable dependency. + readOnly: true + properties: + package: + $ref: '#/components/schemas/dependabot-alert-package' + manifest_path: + type: string + description: The full path to the dependency manifest file, relative to the root of the repository. + readOnly: true + scope: + type: string + description: The execution scope of the vulnerable dependency. + readOnly: true + nullable: true + enum: + - development + - runtime + relationship: + type: string + description: | + The vulnerable dependency's relationship to your project. + + > [!NOTE] + > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + readOnly: true + nullable: true + enum: + - unknown + - direct + - transitive + - inconclusive + security_advisory: + $ref: '#/components/schemas/dependabot-alert-security-advisory' + security_vulnerability: + $ref: '#/components/schemas/dependabot-alert-security-vulnerability' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/alert-updated-at' + dismissed_at: + $ref: '#/components/schemas/alert-dismissed-at' + dismissed_by: + $ref: '#/components/schemas/nullable-simple-user' + dismissed_reason: + type: string + description: The reason that the alert was dismissed. + nullable: true + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + dismissed_comment: + type: string + description: An optional comment associated with the alert's dismissal. + nullable: true + maxLength: 280 + fixed_at: + $ref: '#/components/schemas/alert-fixed-at' + auto_dismissed_at: + $ref: '#/components/schemas/alert-auto-dismissed-at' + dismissal_request: + $ref: '#/components/schemas/dependabot-alert-dismissal-request-simple' + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + $ref: '#/components/schemas/simple-user' + required: + - number + - state + - dependency + - security_advisory + - security_vulnerability + - url + - html_url + - created_at + - updated_at + - dismissed_at + - dismissed_by + - dismissed_reason + - dismissed_comment + - fixed_at + additionalProperties: false + dependabot-secret: + title: Dependabot Secret + description: Set secrets for Dependabot. + type: object + properties: + name: + description: The name of the secret. + example: MY_ARTIFACTORY_PASSWORD + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - created_at + - updated_at + alert-number: + type: integer + description: The security alert number. + readOnly: true + dependabot-alert-package: + type: object + description: Details for the vulnerable package. + readOnly: true + properties: + ecosystem: + type: string + description: The package's language or package management ecosystem. + readOnly: true + name: + type: string + description: The unique package name within its ecosystem. + readOnly: true + required: + - ecosystem + - name + additionalProperties: false + dependabot-alert-security-advisory: + type: object + description: Details for the GitHub Security Advisory. + readOnly: true + properties: + ghsa_id: + type: string + description: The unique GitHub Security Advisory ID assigned to the advisory. + readOnly: true + cve_id: + type: string + description: The unique CVE ID assigned to the advisory. + readOnly: true + nullable: true + summary: + type: string + description: A short, plain text summary of the advisory. + readOnly: true + maxLength: 1024 + description: + type: string + description: A long-form Markdown-supported description of the advisory. + readOnly: true + vulnerabilities: + type: array + description: Vulnerable version range information for the advisory. + readOnly: true + items: + $ref: '#/components/schemas/dependabot-alert-security-vulnerability' + severity: + type: string + description: The severity of the advisory. + readOnly: true + enum: + - low + - medium + - high + - critical + classification: + type: string + description: The classification of the advisory. + readOnly: true + enum: + - general + - malware + cvss: + type: object + description: Details for the advisory pertaining to the Common Vulnerability Scoring System. + readOnly: true + properties: + score: + type: number + description: The overall CVSS score of the advisory. + minimum: 0 + maximum: 10 + readOnly: true + vector_string: + type: string + description: The full CVSS vector string for the advisory. + readOnly: true + nullable: true + required: + - score + - vector_string + additionalProperties: false + cvss_severities: + $ref: '#/components/schemas/cvss-severities' + epss: + $ref: '#/components/schemas/security-advisory-epss' + cwes: + type: array + description: Details for the advisory pertaining to Common Weakness Enumeration. + readOnly: true + items: + type: object + description: A CWE weakness assigned to the advisory. + readOnly: true + properties: + cwe_id: + type: string + description: The unique CWE ID. + readOnly: true + name: + type: string + description: The short, plain text name of the CWE. + readOnly: true + required: + - cwe_id + - name + additionalProperties: false + identifiers: + type: array + description: Values that identify this advisory among security information sources. + readOnly: true + items: + type: object + description: An advisory identifier. + readOnly: true + properties: + type: + type: string + description: The type of advisory identifier. + readOnly: true + enum: + - CVE + - GHSA + value: + type: string + description: The value of the advisory identifer. + readOnly: true + required: + - value + - type + additionalProperties: false + references: + type: array + description: Links to additional advisory information. + readOnly: true + items: + type: object + description: A link to additional advisory information. + readOnly: true + properties: + url: + type: string + description: The URL of the reference. + format: uri + readOnly: true + required: + - url + additionalProperties: false + published_at: + type: string + description: 'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + updated_at: + type: string + description: 'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + withdrawn_at: + type: string + description: 'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cvss + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + additionalProperties: false + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + properties: + cvss: null + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + type: object + version: '2026-03-10' + dependabot-alert-security-vulnerability: + type: object + description: Details pertaining to one vulnerable version range for the advisory. + readOnly: true + properties: + package: + $ref: '#/components/schemas/dependabot-alert-package' + severity: + type: string + description: The severity of the vulnerability. + readOnly: true + enum: + - low + - medium + - high + - critical + vulnerable_version_range: + type: string + description: Conditions that identify vulnerable versions of this vulnerability's package. + readOnly: true + first_patched_version: + type: object + description: Details pertaining to the package version that patches this vulnerability. + readOnly: true + nullable: true + properties: + identifier: + type: string + description: The package version that patches this vulnerability. + readOnly: true + required: + - identifier + additionalProperties: false + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + additionalProperties: false + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + alert-created-at: + type: string + description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + alert-dismissed-at: + type: string + description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + alert-fixed-at: + type: string + description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + alert-auto-dismissed-at: + type: string + description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + dependabot-alert-dismissal-request-simple: + title: Dependabot alert dismissal request + description: Information about an active dismissal request for this Dependabot alert. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the dismissal request. + status: + type: string + description: The current status of the dismissal request. + enum: + - pending + - approved + - rejected + - cancelled + requester: + type: object + description: The user who requested the dismissal. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The login name of the user. + created_at: + type: string + format: date-time + description: The date and time when the dismissal request was created. + url: + type: string + format: uri + description: The API URL to get more information about this dismissal request. + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + nullable-simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable: true + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + cvss-severities: + type: object + nullable: true + properties: + cvss_v3: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 3 vector string. + nullable: true + score: + type: number + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 4 vector string. + nullable: true + score: + type: number + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + security-advisory-epss: + type: object + nullable: true + readOnly: true + description: The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + properties: + percentage: + type: number + minimum: 0 + maximum: 100 + percentile: + type: number + minimum: 0 + maximum: 100 + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + dependabot-alert-comma-separated-classifications: + name: classification + in: query + description: |- + A comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned. + + Can be: `malware`, `general` + schema: + type: string + dependabot-alert-comma-separated-states: + name: state + in: query + description: |- + A comma-separated list of states. If specified, only alerts with these states will be returned. + + Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` + schema: + type: string + dependabot-alert-comma-separated-severities: + name: severity + in: query + description: |- + A comma-separated list of severities. If specified, only alerts with these severities will be returned. + + Can be: `low`, `medium`, `high`, `critical` + schema: + type: string + dependabot-alert-comma-separated-ecosystems: + name: ecosystem + in: query + description: |- + A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + + Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` + schema: + type: string + dependabot-alert-comma-separated-packages: + name: package + in: query + description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. + schema: + type: string + dependabot-alert-comma-separated-epss: + name: epss_percentage + in: query + description: |- + CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + - An exact number (`n`) + - Comparators such as `>n`, `=n`, `<=n` + - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + + Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. + schema: + type: string + dependabot-alert-comma-separated-has: + name: has + in: query + description: |- + Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + dependabot-alert-comma-separated-assignees: + name: assignee + in: query + description: |- + Filter alerts by assignees. + Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + schema: + type: string + dependabot-alert-scope: + name: scope + in: query + description: The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. + schema: + type: string + enum: + - development + - runtime + dependabot-alert-sort: + name: sort + in: query + description: |- + The property by which to sort the results. + `created` means when the alert was created. + `updated` means when the alert's state last changed. + `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. + schema: + type: string + enum: + - created + - updated + - epss_percentage + default: created + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. + schema: + type: string + dependabot-alert-comma-separated-artifact-registry: + name: artifact_registry + in: query + description: |- + A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + + Can be: `jfrog-artifactory` + schema: + type: string + dependabot-alert-org-scope-comma-separated-has: + name: has + in: query + description: |- + Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + Multiple `has` filters can be passed to filter for alerts that have all of the values. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + - deployment + dependabot-alert-comma-separated-runtime-risk: + name: runtime_risk + in: query + description: |- + A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + + Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + schema: + type: string + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + dependabot-alert-comma-separated-manifests: + name: manifest + in: query + description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. + schema: + type: string + dependabot-alert-number: + name: alert_number + in: path + description: |- + The number that identifies a Dependabot alert in its repository. + You can find this at the end of the URL for a Dependabot alert within GitHub, + or in `number` fields in the response from the + `GET /repos/{owner}/{repo}/dependabot/alerts` operation. + required: true + schema: + $ref: '#/components/schemas/alert-number' + examples: + dependabot-alerts-for-organization: + value: + - number: 2 + state: dismissed + dependency: + package: + ecosystem: pip + name: django + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-rf4j-j272-fj86 + cve_id: CVE-2018-6188 + summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive + description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive. + vulnerabilities: + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 1.11.8, < 1.11.10' + first_patched_version: + identifier: 1.11.10 + severity: high + cvss: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N + score: 8.7 + epss: + percentage: 0.00045 + percentile: '0.16001e0' + cwes: + - cwe_id: CWE-200 + name: Exposure of Sensitive Information to an Unauthorized Actor + identifiers: + - type: GHSA + value: GHSA-rf4j-j272-fj86 + - type: CVE + value: CVE-2018-6188 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 + - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 + - url: https://usn.ubuntu.com/3559-1/ + - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ + - url: http://www.securitytracker.com/id/1040422 + published_at: '2018-10-03T21:13:54Z' + updated_at: '2022-04-26T18:35:37Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + url: https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2 + html_url: https://github.com/octo-org/octo-repo/security/dependabot/2 + created_at: '2022-06-15T07:43:03Z' + updated_at: '2022-08-23T14:29:47Z' + dismissed_at: '2022-08-23T14:29:47Z' + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + fixed_at: null + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo + full_name: octo-org/octo-repo + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo + archive_url: https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo/events + forks_url: https://api.github.com/repos/octo-org/octo-repo/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo/subscription + tags_url: https://api.github.com/repos/octo-org/octo-repo/tags + teams_url: https://api.github.com/repos/octo-org/octo-repo/teams + trees_url: https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha} + - number: 1 + state: open + dependency: + package: + ecosystem: pip + name: ansible + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-8f4m-hccc-8qph + cve_id: CVE-2021-20191 + summary: Insertion of Sensitive Information into Log File in ansible + description: A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality. + vulnerabilities: + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.9.0, < 2.9.18' + first_patched_version: + identifier: 2.9.18 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.10.0, < 2.10.7' + first_patched_version: + identifier: 2.10.7 + severity: medium + cvss: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_v4: + vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 8.5 + cwes: + - cwe_id: CWE-532 + name: Insertion of Sensitive Information into Log File + identifiers: + - type: GHSA + value: GHSA-8f4m-hccc-8qph + - type: CVE + value: CVE-2021-20191 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 + - url: https://access.redhat.com/security/cve/cve-2021-20191 + - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 + published_at: '2021-06-01T17:38:00Z' + updated_at: '2021-08-12T23:06:00Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + url: https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1 + html_url: https://github.com/octo-org/hello-world/security/dependabot/1 + created_at: '2022-06-14T15:21:52Z' + updated_at: '2022-06-14T15:21:52Z' + dismissed_at: null + dismissed_by: null + dismissed_reason: null + dismissed_comment: null + fixed_at: null + assignees: [] + repository: + id: 664700648 + node_id: MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg= + name: hello-world + full_name: octo-org/hello-world + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/hello-world + description: null + fork: false + url: https://api.github.com/repos/octo-org/hello-world + archive_url: https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/hello-world/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/hello-world/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/hello-world/comments{/number} + commits_url: https://api.github.com/repos/octo-org/hello-world/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/hello-world/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/hello-world/contributors + deployments_url: https://api.github.com/repos/octo-org/hello-world/deployments + downloads_url: https://api.github.com/repos/octo-org/hello-world/downloads + events_url: https://api.github.com/repos/octo-org/hello-world/events + forks_url: https://api.github.com/repos/octo-org/hello-world/forks + git_commits_url: https://api.github.com/repos/octo-org/hello-world/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/hello-world/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/hello-world/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/hello-world/hooks + issue_comment_url: https://api.github.com/repos/octo-org/hello-world/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/hello-world/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/hello-world/issues{/number} + keys_url: https://api.github.com/repos/octo-org/hello-world/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/hello-world/labels{/name} + languages_url: https://api.github.com/repos/octo-org/hello-world/languages + merges_url: https://api.github.com/repos/octo-org/hello-world/merges + milestones_url: https://api.github.com/repos/octo-org/hello-world/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/hello-world/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/hello-world/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/hello-world/stargazers + statuses_url: https://api.github.com/repos/octo-org/hello-world/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/hello-world/subscribers + subscription_url: https://api.github.com/repos/octo-org/hello-world/subscription + tags_url: https://api.github.com/repos/octo-org/hello-world/tags + teams_url: https://api.github.com/repos/octo-org/hello-world/teams + trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} + dependabot-repository-access-details: + value: + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + organization-dependabot-secret-paginated: + value: + total_count: 3 + secrets: + - name: MY_ARTIFACTORY_PASSWORD + created_at: '2021-08-10T14:59:22Z' + updated_at: '2021-12-10T14:59:22Z' + visibility: private + - name: NPM_TOKEN + created_at: '2021-08-10T14:59:22Z' + updated_at: '2021-12-10T14:59:22Z' + visibility: all + - name: GH_TOKEN + created_at: '2021-08-10T14:59:22Z' + updated_at: '2021-12-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories + dependabot-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + organization-dependabot-secret: + value: + name: NPM_TOKEN + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + dependabot-alerts-for-repository: + value: + - number: 2 + state: dismissed + dependency: + package: + ecosystem: pip + name: django + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-rf4j-j272-fj86 + cve_id: CVE-2018-6188 + summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive + description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive. + vulnerabilities: + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 1.11.8, < 1.11.10' + first_patched_version: + identifier: 1.11.10 + severity: high + cvss: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N + score: 8.7 + epss: + percentage: 0.00045 + percentile: '0.16001e0' + cwes: + - cwe_id: CWE-200 + name: Exposure of Sensitive Information to an Unauthorized Actor + identifiers: + - type: GHSA + value: GHSA-rf4j-j272-fj86 + - type: CVE + value: CVE-2018-6188 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 + - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 + - url: https://usn.ubuntu.com/3559-1/ + - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ + - url: http://www.securitytracker.com/id/1040422 + published_at: '2018-10-03T21:13:54Z' + updated_at: '2022-04-26T18:35:37Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 + html_url: https://github.com/octocat/hello-world/security/dependabot/2 + created_at: '2022-06-15T07:43:03Z' + updated_at: '2022-08-23T14:29:47Z' + dismissed_at: '2022-08-23T14:29:47Z' + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + fixed_at: null + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - number: 1 + state: open + dependency: + package: + ecosystem: pip + name: ansible + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-8f4m-hccc-8qph + cve_id: CVE-2021-20191 + summary: Insertion of Sensitive Information into Log File in ansible + description: A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality. + vulnerabilities: + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.9.0, < 2.9.18' + first_patched_version: + identifier: 2.9.18 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.10.0, < 2.10.7' + first_patched_version: + identifier: 2.10.7 + severity: medium + cvss: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_v4: + vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 8.5 + cwes: + - cwe_id: CWE-532 + name: Insertion of Sensitive Information into Log File + identifiers: + - type: GHSA + value: GHSA-8f4m-hccc-8qph + - type: CVE + value: CVE-2021-20191 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 + - url: https://access.redhat.com/security/cve/cve-2021-20191 + - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 + published_at: '2021-06-01T17:38:00Z' + updated_at: '2021-08-12T23:06:00Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 + html_url: https://github.com/octocat/hello-world/security/dependabot/1 + created_at: '2022-06-14T15:21:52Z' + updated_at: '2022-06-14T15:21:52Z' + dismissed_at: null + dismissed_by: null + dismissed_reason: null + dismissed_comment: null + fixed_at: null + assignees: [] + dependabot-alert-open: + value: + number: 1 + state: open + dependency: + package: + ecosystem: pip + name: ansible + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-8f4m-hccc-8qph + cve_id: CVE-2021-20191 + summary: Insertion of Sensitive Information into Log File in ansible + description: A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality. + vulnerabilities: + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.9.0, < 2.9.18' + first_patched_version: + identifier: 2.9.18 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + - package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: '>= 2.10.0, < 2.10.7' + first_patched_version: + identifier: 2.10.7 + severity: medium + cvss: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N + score: 5.5 + cvss_v4: + vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 8.5 + epss: + percentage: 0.00045 + percentile: '0.16001e0' + cwes: + - cwe_id: CWE-532 + name: Insertion of Sensitive Information into Log File + identifiers: + - type: GHSA + value: GHSA-8f4m-hccc-8qph + - type: CVE + value: CVE-2021-20191 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2021-20191 + - url: https://access.redhat.com/security/cve/cve-2021-20191 + - url: https://bugzilla.redhat.com/show_bug.cgi?id=1916813 + published_at: '2021-06-01T17:38:00Z' + updated_at: '2021-08-12T23:06:00Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: ansible + severity: medium + vulnerable_version_range: < 2.8.19 + first_patched_version: + identifier: 2.8.19 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1 + html_url: https://github.com/octocat/hello-world/security/dependabot/1 + created_at: '2022-06-14T15:21:52Z' + updated_at: '2022-06-14T15:21:52Z' + dismissed_at: null + dismissed_by: null + dismissed_reason: null + dismissed_comment: null + fixed_at: null + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dependabot-alert-dismissed: + value: + number: 2 + state: dismissed + dependency: + package: + ecosystem: pip + name: django + manifest_path: path/to/requirements.txt + scope: runtime + security_advisory: + ghsa_id: GHSA-rf4j-j272-fj86 + cve_id: CVE-2018-6188 + summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive + description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive. + vulnerabilities: + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + - package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 1.11.8, < 1.11.10' + first_patched_version: + identifier: 1.11.10 + severity: high + cvss: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N + score: 7.5 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N + score: 8.7 + cwes: + - cwe_id: CWE-200 + name: Exposure of Sensitive Information to an Unauthorized Actor + identifiers: + - type: GHSA + value: GHSA-rf4j-j272-fj86 + - type: CVE + value: CVE-2018-6188 + references: + - url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188 + - url: https://github.com/advisories/GHSA-rf4j-j272-fj86 + - url: https://usn.ubuntu.com/3559-1/ + - url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/ + - url: http://www.securitytracker.com/id/1040422 + published_at: '2018-10-03T21:13:54Z' + updated_at: '2022-04-26T18:35:37Z' + withdrawn_at: null + security_vulnerability: + package: + ecosystem: pip + name: django + severity: high + vulnerable_version_range: '>= 2.0.0, < 2.0.2' + first_patched_version: + identifier: 2.0.2 + url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2 + html_url: https://github.com/octocat/hello-world/security/dependabot/2 + created_at: '2022-06-15T07:43:03Z' + updated_at: '2022-08-23T14:29:47Z' + dismissed_at: '2022-08-23T14:29:47Z' + dismissed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + dismissed_reason: tolerable_risk + dismissed_comment: This alert is accurate but we use a sanitizer. + fixed_at: null + assignees: [] + dependabot-secret-paginated: + value: + total_count: 2 + secrets: + - name: AZURE_DEVOPS_PAT + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + - name: MY_ARTIFACTORY_PASSWORD + created_at: '2020-01-10T10:59:22Z' + updated_at: '2020-01-11T11:59:22Z' + dependabot-secret: + value: + name: MY_ARTIFACTORY_PASSWORD + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/dependency_graph.yaml b/provider-dev/source/dependency_graph.yaml new file mode 100644 index 0000000..ebd8b33 --- /dev/null +++ b/provider-dev/source/dependency_graph.yaml @@ -0,0 +1,692 @@ +openapi: 3.0.3 +info: + title: dependency_graph API + description: github API + version: 1.1.4 +paths: + /repos/{owner}/{repo}/dependency-graph/compare/{basehead}: + get: + summary: Get a diff of the dependencies between commits + description: Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. + tags: + - dependency-graph + operationId: dependency-graph/diff-range + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: basehead + description: The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. + in: path + required: true + schema: + type: string + - $ref: '#/components/parameters/manifest-path' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependency-graph-diff' + examples: + default: + $ref: '#/components/examples/diff-range-response' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/dependency_review_forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + category: dependency-graph + subcategory: dependency-review + x-stackQL-resource: dependency_review + /repos/{owner}/{repo}/dependency-graph/sbom: + get: + summary: Export a software bill of materials (SBOM) for a repository. + description: Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. + tags: + - dependency-graph + operationId: dependency-graph/export-sbom + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/dependency-graph-spdx-sbom' + examples: + default: + $ref: '#/components/examples/dependency-graph-export-sbom-response' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + category: dependency-graph + subcategory: sboms + x-stackQL-resource: sboms + /repos/{owner}/{repo}/dependency-graph/snapshots: + post: + summary: Create a snapshot of dependencies for a repository + description: |- + Create a new snapshot of a repository's dependencies. + + The authenticated user must have access to the repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - dependency-graph + operationId: dependency-graph/create-repository-snapshot + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/snapshot' + examples: + example-of-a-dependency-submission: + $ref: '#/components/examples/dependency-graph-create-snapshot-request' + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + required: + - id + - created_at + - result + - message + properties: + id: + type: integer + description: ID of the created snapshot. + created_at: + type: string + description: The time at which the snapshot was created. + result: + type: string + description: Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. + message: + type: string + description: A message providing further details about the result, such as why the dependencies were not updated. + examples: + example-of-a-dependency-submission: + $ref: '#/components/examples/dependency-graph-create-snapshot-success' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependency-graph + subcategory: dependency-submission + x-stackQL-resource: dependency_submission +components: + schemas: + dependency-graph-diff: + title: Dependency Graph Diff + description: A diff of the dependencies between two commits. + type: array + items: + type: object + properties: + change_type: + type: string + enum: + - added + - removed + manifest: + type: string + example: path/to/package-lock.json + ecosystem: + type: string + example: npm + name: + type: string + example: '@actions/core' + version: + type: string + example: 1.0.0 + package_url: + type: string + nullable: true + example: pkg:/npm/%40actions/core@1.1.0 + license: + type: string + nullable: true + example: MIT + source_repository_url: + type: string + nullable: true + example: https://github.com/github/actions + vulnerabilities: + type: array + items: + type: object + properties: + severity: + type: string + example: critical + advisory_ghsa_id: + type: string + example: GHSA-rf4j-j272-fj86 + advisory_summary: + type: string + example: A summary of the advisory. + advisory_url: + type: string + example: https://github.com/advisories/GHSA-rf4j-j272-fj86 + required: + - severity + - advisory_ghsa_id + - advisory_summary + - advisory_url + scope: + description: Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment. + type: string + enum: + - unknown + - runtime + - development + required: + - change_type + - manifest + - ecosystem + - name + - version + - package_url + - license + - source_repository_url + - vulnerabilities + - scope + dependency-graph-spdx-sbom: + title: Dependency Graph SPDX SBOM + description: A schema for the SPDX JSON format returned by the Dependency Graph. + type: object + properties: + sbom: + type: object + properties: + SPDXID: + type: string + example: SPDXRef-DOCUMENT + description: The SPDX identifier for the SPDX document. + spdxVersion: + type: string + example: SPDX-2.3 + description: The version of the SPDX specification that this document conforms to. + comment: + type: string + example: 'Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' + description: An optional comment about the SPDX document. + creationInfo: + type: object + properties: + created: + type: string + example: '2021-11-03T00:00:00Z' + description: The date and time the SPDX document was created. + creators: + type: array + items: + type: string + example: GitHub + description: The tools that were used to generate the SPDX document. + required: + - created + - creators + name: + type: string + example: github/github + description: The name of the SPDX document. + dataLicense: + type: string + example: CC0-1.0 + description: The license under which the SPDX document is licensed. + documentNamespace: + type: string + example: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + description: The namespace for the SPDX document. + packages: + type: array + items: + type: object + properties: + SPDXID: + type: string + example: SPDXRef-Package + description: A unique SPDX identifier for the package. + name: + type: string + example: github/github + description: The name of the package. + versionInfo: + type: string + example: 1.0.0 + description: |- + The version of the package. If the package does not have an exact version specified, + a version range is given. + downloadLocation: + type: string + example: NOASSERTION + description: |- + The location where the package can be downloaded, + or NOASSERTION if this has not been determined. + filesAnalyzed: + type: boolean + example: false + description: |- + Whether the package's file content has been subjected to + analysis during the creation of the SPDX document. + licenseConcluded: + type: string + example: MIT + description: The license of the package as determined while creating the SPDX document. + licenseDeclared: + type: string + example: NOASSERTION + description: |- + The license of the package as declared by its author, or NOASSERTION if this information + was not available when the SPDX document was created. + supplier: + type: string + example: NOASSERTION + description: The distribution source of this package, or NOASSERTION if this was not determined. + copyrightText: + type: string + example: Copyright (c) 1985 GitHub.com + description: The copyright holders of the package, and any dates present with those notices, if available. + externalRefs: + type: array + items: + type: object + properties: + referenceCategory: + type: string + example: PACKAGE-MANAGER + description: The category of reference to an external resource this reference refers to. + referenceLocator: + type: string + example: pkg:gem/rails@6.0.1 + description: A locator for the particular external resource this reference refers to. + referenceType: + type: string + example: purl + description: The category of reference to an external resource this reference refers to. + required: + - referenceCategory + - referenceLocator + - referenceType + required: + - SPDXID + - name + - versionInfo + - downloadLocation + - filesAnalyzed + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + example: DEPENDS_ON + description: The type of relationship between the two SPDX elements. + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement + required: + - SPDXID + - spdxVersion + - creationInfo + - name + - dataLicense + - documentNamespace + - packages + required: + - sbom + snapshot: + title: snapshot + description: Create a new snapshot of a repository's dependencies. + type: object + properties: + version: + description: The version of the repository snapshot submission. + type: integer + job: + type: object + properties: + id: + type: string + description: The external ID of the job. + example: 5622a2b0-63f6-4732-8c34-a1ab27e102a11 + correlator: + type: string + description: Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation. + example: yourworkflowname_yourjobname + html_url: + type: string + description: The url for the job. + example: http://example.com/build + required: + - id + - correlator + additionalProperties: false + sha: + description: 'The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.' + type: string + example: ddc951f4b1293222421f2c8df679786153acf689 + minLength: 40 + maxLength: 40 + ref: + description: The repository branch that triggered this snapshot. + type: string + pattern: ^refs/ + example: refs/heads/main + detector: + type: object + description: A description of the detector used. + properties: + name: + type: string + description: The name of the detector used. + example: docker buildtime detector + version: + type: string + description: The version of the detector used. + example: 1.0.0 + url: + type: string + description: The url of the detector used. + example: http://example.com/docker-buildtimer-detector + required: + - name + - version + - url + additionalProperties: false + metadata: + $ref: '#/components/schemas/metadata' + manifests: + type: object + description: A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. + additionalProperties: + $ref: '#/components/schemas/manifest' + scanned: + type: string + format: date-time + description: The time at which the snapshot was scanned. + example: '2020-06-13T14:52:50-05:00' + required: + - detector + - version + - ref + - sha + - job + - scanned + additionalProperties: false + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + metadata: + title: metadata + description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + type: object + maxProperties: 8 + additionalProperties: + nullable: true + anyOf: + - type: string + - type: number + - type: boolean + manifest: + type: object + properties: + name: + type: string + description: The name of the manifest. + example: package-lock.json + file: + type: object + properties: + source_location: + type: string + description: The path of the manifest file relative to the root of the Git repository. + example: /src/build/package-lock.json + additionalProperties: false + metadata: + $ref: '#/components/schemas/metadata' + resolved: + type: object + description: A collection of resolved package dependencies. + additionalProperties: + $ref: '#/components/schemas/dependency' + required: + - name + additionalProperties: false + dependency: + type: object + properties: + package_url: + type: string + description: Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. + example: pkg:/npm/%40actions/http-client@1.0.11 + pattern: ^pkg + metadata: + $ref: '#/components/schemas/metadata' + relationship: + type: string + description: A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. + example: direct + enum: + - direct + - indirect + scope: + type: string + description: A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. + example: runtime + enum: + - runtime + - development + dependencies: + type: array + description: Array of package-url (PURLs) of direct child dependencies. + example: '@actions/http-client' + items: + type: string + additionalProperties: false + responses: + dependency_review_forbidden: + description: Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + manifest-path: + name: name + description: The full path, relative to the repository root, of the dependency manifest file. + in: query + required: false + schema: + type: string + examples: + diff-range-response: + value: + - change_type: removed + manifest: package.json + ecosystem: npm + name: helmet + version: 4.6.0 + package_url: pkg:npm/helmet@4.6.0 + license: MIT + source_repository_url: https://github.com/helmetjs/helmet + vulnerabilities: [] + - change_type: added + manifest: package.json + ecosystem: npm + name: helmet + version: 5.0.0 + package_url: pkg:npm/helmet@5.0.0 + license: MIT + source_repository_url: https://github.com/helmetjs/helmet + vulnerabilities: [] + - change_type: added + manifest: Gemfile + ecosystem: rubygems + name: ruby-openid + version: 2.7.0 + package_url: pkg:gem/ruby-openid@2.7.0 + license: null + source_repository_url: https://github.com/openid/ruby-openid + vulnerabilities: + - severity: critical + advisory_ghsa_id: GHSA-fqfj-cmh6-hj49 + advisory_summary: Ruby OpenID + advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 + dependency-graph-export-sbom-response: + value: + sbom: + SPDXID: SPDXRef-DOCUMENT + spdxVersion: SPDX-2.3 + creationInfo: + created: '2021-09-01T00:00:00Z' + creators: + - 'Tool: GitHub.com-Dependency-Graph' + name: github/example + dataLicense: CC0-1.0 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + packages: + - name: rails + SPDXID: SPDXRef-Package + versionInfo: 1.0.0 + downloadLocation: NOASSERTION + filesAnalyzed: false + licenseConcluded: MIT + licenseDeclared: MIT + copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository + dependency-graph-create-snapshot-request: + value: + version: 0 + sha: ce587453ced02b1526dfb4cb910479d431683101 + ref: refs/heads/main + job: + correlator: yourworkflowname_youractionname + id: yourrunid + detector: + name: octo-detector + version: 0.0.1 + url: https://github.com/octo-org/octo-repo + scanned: '2022-06-14T20:25:00Z' + manifests: + package-lock.json: + name: package-lock.json + file: + source_location: src/package-lock.json + resolved: + '@actions/core': + package_url: pkg:/npm/%40actions/core@1.1.9 + dependencies: + - '@actions/http-client' + '@actions/http-client': + package_url: pkg:/npm/%40actions/http-client@1.0.7 + dependencies: + - tunnel + tunnel: + package_url: pkg:/npm/tunnel@0.0.6 + dependency-graph-create-snapshot-success: + value: + id: 12345 + created_at: '2018-05-04T01:14:52Z' + message: Dependency results for the repo have been successfully updated. + result: SUCCESS + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/emojis.yaml b/provider-dev/source/emojis.yaml new file mode 100644 index 0000000..9520e1d --- /dev/null +++ b/provider-dev/source/emojis.yaml @@ -0,0 +1,1922 @@ +openapi: 3.0.3 +info: + title: emojis API + description: List emojis available to use on GitHub. + version: 1.1.4 +paths: + /emojis: + get: + summary: Get emojis + description: Lists all the emojis available to use on GitHub. + operationId: emojis/get + tags: + - emojis + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/emojis/emojis#get-emojis + parameters: [] + responses: + '200': + content: + application/json: + schema: + type: object + additionalProperties: + type: string + examples: + default: + $ref: '#/components/examples/emojis-get' + description: Response + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: emojis + subcategory: emojis + x-stackQL-resource: emojis +components: + responses: + not_modified: + description: Not modified + examples: + emojis-get: + value: + '100': https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8 + '1234': https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8 + '+1': https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8 + '-1': https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8 + 1st_place_medal: https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8 + 2nd_place_medal: https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8 + 3rd_place_medal: https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8 + 8ball: https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8 + a: https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8 + ab: https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8 + abacus: https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8 + abc: https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8 + abcd: https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8 + accept: https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8 + accessibility: https://github.githubassets.com/images/icons/emoji/accessibility.png?v8 + accordion: https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8 + adhesive_bandage: https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8 + adult: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8 + aerial_tramway: https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8 + afghanistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8 + airplane: https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8 + aland_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8 + alarm_clock: https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8 + albania: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8 + alembic: https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8 + algeria: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8 + alien: https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8 + ambulance: https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8 + american_samoa: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8 + amphora: https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8 + anatomical_heart: https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8 + anchor: https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8 + andorra: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8 + angel: https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8 + anger: https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8 + angola: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8 + angry: https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8 + anguilla: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8 + anguished: https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8 + ant: https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8 + antarctica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8 + antigua_barbuda: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8 + apple: https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8 + aquarius: https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8 + argentina: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8 + aries: https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8 + armenia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8 + arrow_backward: https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8 + arrow_double_down: https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8 + arrow_double_up: https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8 + arrow_down: https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8 + arrow_down_small: https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8 + arrow_forward: https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8 + arrow_heading_down: https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8 + arrow_heading_up: https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8 + arrow_left: https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8 + arrow_lower_left: https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8 + arrow_lower_right: https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8 + arrow_right: https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8 + arrow_right_hook: https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8 + arrow_up: https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8 + arrow_up_down: https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8 + arrow_up_small: https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8 + arrow_upper_left: https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8 + arrow_upper_right: https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8 + arrows_clockwise: https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8 + arrows_counterclockwise: https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8 + art: https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8 + articulated_lorry: https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8 + artificial_satellite: https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8 + artist: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8 + aruba: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8 + ascension_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8 + asterisk: https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8 + astonished: https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8 + astronaut: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8 + athletic_shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8 + atm: https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8 + atom: https://github.githubassets.com/images/icons/emoji/atom.png?v8 + atom_symbol: https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8 + australia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8 + austria: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8 + auto_rickshaw: https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8 + avocado: https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8 + axe: https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8 + azerbaijan: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8 + b: https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8 + baby: https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8 + baby_bottle: https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8 + baby_chick: https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8 + baby_symbol: https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8 + back: https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8 + bacon: https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8 + badger: https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8 + badminton: https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8 + bagel: https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8 + baggage_claim: https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8 + baguette_bread: https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8 + bahamas: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8 + bahrain: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8 + balance_scale: https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8 + bald_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8 + bald_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8 + ballet_shoes: https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8 + balloon: https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8 + ballot_box: https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8 + ballot_box_with_check: https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8 + bamboo: https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8 + banana: https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8 + bangbang: https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8 + bangladesh: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8 + banjo: https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8 + bank: https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8 + bar_chart: https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8 + barbados: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8 + barber: https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8 + baseball: https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8 + basecamp: https://github.githubassets.com/images/icons/emoji/basecamp.png?v8 + basecampy: https://github.githubassets.com/images/icons/emoji/basecampy.png?v8 + basket: https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8 + basketball: https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8 + basketball_man: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8 + basketball_woman: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8 + bat: https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8 + bath: https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8 + bathtub: https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8 + battery: https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8 + beach_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8 + bear: https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8 + bearded_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8 + beaver: https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8 + bed: https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8 + bee: https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8 + beer: https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8 + beers: https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8 + beetle: https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8 + beginner: https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8 + belarus: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8 + belgium: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8 + belize: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8 + bell: https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8 + bell_pepper: https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8 + bellhop_bell: https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8 + benin: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8 + bento: https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8 + bermuda: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8 + beverage_box: https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8 + bhutan: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8 + bicyclist: https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8 + bike: https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8 + biking_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8 + biking_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8 + bikini: https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8 + billed_cap: https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8 + biohazard: https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8 + bird: https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8 + birthday: https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8 + bison: https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8 + black_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8 + black_circle: https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8 + black_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8 + black_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8 + black_joker: https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8 + black_large_square: https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8 + black_medium_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8 + black_medium_square: https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8 + black_nib: https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8 + black_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8 + black_square_button: https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8 + blond_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8 + blond_haired_person: https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8 + blond_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8 + blonde_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8 + blossom: https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8 + blowfish: https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8 + blue_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8 + blue_car: https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8 + blue_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8 + blue_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8 + blueberries: https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8 + blush: https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8 + boar: https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8 + boat: https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8 + bolivia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8 + bomb: https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8 + bone: https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8 + book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8 + bookmark: https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8 + bookmark_tabs: https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8 + books: https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8 + boom: https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8 + boomerang: https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8 + boot: https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8 + bosnia_herzegovina: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8 + botswana: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8 + bouncing_ball_man: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8 + bouncing_ball_person: https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8 + bouncing_ball_woman: https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8 + bouquet: https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8 + bouvet_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8 + bow: https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8 + bow_and_arrow: https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8 + bowing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8 + bowing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8 + bowl_with_spoon: https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8 + bowling: https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8 + bowtie: https://github.githubassets.com/images/icons/emoji/bowtie.png?v8 + boxing_glove: https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8 + boy: https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8 + brain: https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8 + brazil: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8 + bread: https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8 + breast_feeding: https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8 + bricks: https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8 + bride_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8 + bridge_at_night: https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8 + briefcase: https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8 + british_indian_ocean_territory: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8 + british_virgin_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8 + broccoli: https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8 + broken_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8 + broom: https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8 + brown_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8 + brown_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8 + brown_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8 + brunei: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8 + bubble_tea: https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8 + bucket: https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8 + bug: https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8 + building_construction: https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8 + bulb: https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8 + bulgaria: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8 + bullettrain_front: https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8 + bullettrain_side: https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8 + burkina_faso: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8 + burrito: https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8 + burundi: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8 + bus: https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8 + business_suit_levitating: https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8 + busstop: https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8 + bust_in_silhouette: https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8 + busts_in_silhouette: https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8 + butter: https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8 + butterfly: https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8 + cactus: https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8 + cake: https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8 + calendar: https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8 + call_me_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8 + calling: https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8 + cambodia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8 + camel: https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8 + camera: https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8 + camera_flash: https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8 + cameroon: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8 + camping: https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8 + canada: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8 + canary_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8 + cancer: https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8 + candle: https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8 + candy: https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8 + canned_food: https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8 + canoe: https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8 + cape_verde: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8 + capital_abcd: https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8 + capricorn: https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8 + car: https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8 + card_file_box: https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8 + card_index: https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8 + card_index_dividers: https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8 + caribbean_netherlands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8 + carousel_horse: https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8 + carpentry_saw: https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8 + carrot: https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8 + cartwheeling: https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8 + cat: https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8 + cat2: https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8 + cayman_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8 + cd: https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8 + central_african_republic: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8 + ceuta_melilla: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8 + chad: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8 + chains: https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8 + chair: https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8 + champagne: https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8 + chart: https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8 + chart_with_downwards_trend: https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8 + chart_with_upwards_trend: https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8 + checkered_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8 + cheese: https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8 + cherries: https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8 + cherry_blossom: https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8 + chess_pawn: https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8 + chestnut: https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8 + chicken: https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8 + child: https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8 + children_crossing: https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8 + chile: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8 + chipmunk: https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8 + chocolate_bar: https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8 + chopsticks: https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8 + christmas_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8 + christmas_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8 + church: https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8 + cinema: https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8 + circus_tent: https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8 + city_sunrise: https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8 + city_sunset: https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8 + cityscape: https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8 + cl: https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8 + clamp: https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8 + clap: https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8 + clapper: https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8 + classical_building: https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8 + climbing: https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8 + climbing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8 + climbing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8 + clinking_glasses: https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8 + clipboard: https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8 + clipperton_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8 + clock1: https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8 + clock10: https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8 + clock1030: https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8 + clock11: https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8 + clock1130: https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8 + clock12: https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8 + clock1230: https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8 + clock130: https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8 + clock2: https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8 + clock230: https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8 + clock3: https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8 + clock330: https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8 + clock4: https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8 + clock430: https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8 + clock5: https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8 + clock530: https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8 + clock6: https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8 + clock630: https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8 + clock7: https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8 + clock730: https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8 + clock8: https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8 + clock830: https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8 + clock9: https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8 + clock930: https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8 + closed_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8 + closed_lock_with_key: https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8 + closed_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8 + cloud: https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8 + cloud_with_lightning: https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8 + cloud_with_lightning_and_rain: https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8 + cloud_with_rain: https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8 + cloud_with_snow: https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8 + clown_face: https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8 + clubs: https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8 + cn: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8 + coat: https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8 + cockroach: https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8 + cocktail: https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8 + coconut: https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8 + cocos_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8 + coffee: https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8 + coffin: https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8 + coin: https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8 + cold_face: https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8 + cold_sweat: https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8 + collision: https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8 + colombia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8 + comet: https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8 + comoros: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8 + compass: https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8 + computer: https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8 + computer_mouse: https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8 + confetti_ball: https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8 + confounded: https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8 + confused: https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8 + congo_brazzaville: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8 + congo_kinshasa: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8 + congratulations: https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8 + construction: https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8 + construction_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8 + construction_worker_man: https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8 + construction_worker_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8 + control_knobs: https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8 + convenience_store: https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8 + cook: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8 + cook_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8 + cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 + cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 + cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 + copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 + corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 + costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 + cote_divoire: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8 + couch_and_lamp: https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8 + couple: https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8 + couple_with_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8 + couple_with_heart_man_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8 + couple_with_heart_woman_man: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8 + couple_with_heart_woman_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8 + couplekiss: https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8 + couplekiss_man_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8 + couplekiss_man_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8 + couplekiss_woman_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8 + cow: https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8 + cow2: https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8 + cowboy_hat_face: https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8 + crab: https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8 + crayon: https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8 + credit_card: https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8 + crescent_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8 + cricket: https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8 + cricket_game: https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8 + croatia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8 + crocodile: https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8 + croissant: https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8 + crossed_fingers: https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8 + crossed_flags: https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8 + crossed_swords: https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8 + crown: https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8 + cry: https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8 + crying_cat_face: https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8 + crystal_ball: https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8 + cuba: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8 + cucumber: https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8 + cup_with_straw: https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8 + cupcake: https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8 + cupid: https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8 + curacao: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8 + curling_stone: https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8 + curly_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8 + curly_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8 + curly_loop: https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8 + currency_exchange: https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8 + curry: https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8 + cursing_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8 + custard: https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8 + customs: https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8 + cut_of_meat: https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8 + cyclone: https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8 + cyprus: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8 + czech_republic: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8 + dagger: https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8 + dancer: https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8 + dancers: https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8 + dancing_men: https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8 + dancing_women: https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8 + dango: https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8 + dark_sunglasses: https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8 + dart: https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8 + dash: https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8 + date: https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8 + de: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8 + deaf_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8 + deaf_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8 + deaf_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8 + deciduous_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8 + deer: https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8 + denmark: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8 + department_store: https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8 + dependabot: https://github.githubassets.com/images/icons/emoji/dependabot.png?v8 + derelict_house: https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8 + desert: https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8 + desert_island: https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8 + desktop_computer: https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8 + detective: https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8 + diamond_shape_with_a_dot_inside: https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8 + diamonds: https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8 + diego_garcia: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8 + disappointed: https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8 + disappointed_relieved: https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8 + disguised_face: https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8 + diving_mask: https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8 + diya_lamp: https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8 + dizzy: https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8 + dizzy_face: https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8 + djibouti: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8 + dna: https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8 + do_not_litter: https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8 + dodo: https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8 + dog: https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8 + dog2: https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8 + dollar: https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8 + dolls: https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8 + dolphin: https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8 + dominica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8 + dominican_republic: https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8 + door: https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8 + doughnut: https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8 + dove: https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8 + dragon: https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8 + dragon_face: https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8 + dress: https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8 + dromedary_camel: https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8 + drooling_face: https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8 + drop_of_blood: https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8 + droplet: https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8 + drum: https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8 + duck: https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8 + dumpling: https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8 + dvd: https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8 + e-mail: https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8 + eagle: https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8 + ear: https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8 + ear_of_rice: https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8 + ear_with_hearing_aid: https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8 + earth_africa: https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8 + earth_americas: https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8 + earth_asia: https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8 + ecuador: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8 + egg: https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8 + eggplant: https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8 + egypt: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8 + eight: https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8 + eight_pointed_black_star: https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8 + eight_spoked_asterisk: https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8 + eject_button: https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8 + el_salvador: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8 + electric_plug: https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8 + electron: https://github.githubassets.com/images/icons/emoji/electron.png?v8 + elephant: https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8 + elevator: https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8 + elf: https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8 + elf_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8 + elf_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8 + email: https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8 + end: https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8 + england: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8 + envelope: https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8 + envelope_with_arrow: https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8 + equatorial_guinea: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8 + eritrea: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8 + es: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8 + estonia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8 + ethiopia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8 + eu: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8 + euro: https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8 + european_castle: https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8 + european_post_office: https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8 + european_union: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8 + evergreen_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8 + exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8 + exploding_head: https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8 + expressionless: https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8 + eye: https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8 + eye_speech_bubble: https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8 + eyeglasses: https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8 + eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8 + face_exhaling: https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8 + face_in_clouds: https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8 + face_with_head_bandage: https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8 + face_with_spiral_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8 + face_with_thermometer: https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8 + facepalm: https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8 + facepunch: https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 + factory: https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8 + factory_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8 + fairy: https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8 + fairy_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8 + fairy_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8 + falafel: https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8 + falkland_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8 + fallen_leaf: https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8 + family: https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8 + family_man_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8 + family_man_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8 + family_man_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8 + family_man_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8 + family_man_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8 + family_man_man_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8 + family_man_man_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8 + family_man_man_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8 + family_man_man_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8 + family_man_man_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8 + family_man_woman_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8 + family_man_woman_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8 + family_man_woman_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8 + family_man_woman_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8 + family_man_woman_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8 + family_woman_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8 + family_woman_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8 + family_woman_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8 + family_woman_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8 + family_woman_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8 + family_woman_woman_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8 + family_woman_woman_boy_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8 + family_woman_woman_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8 + family_woman_woman_girl_boy: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8 + family_woman_woman_girl_girl: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8 + farmer: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8 + faroe_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8 + fast_forward: https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8 + fax: https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8 + fearful: https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8 + feather: https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8 + feelsgood: https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8 + feet: https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8 + female_detective: https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8 + female_sign: https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8 + ferris_wheel: https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8 + ferry: https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8 + field_hockey: https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8 + fiji: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8 + file_cabinet: https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8 + file_folder: https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8 + film_projector: https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8 + film_strip: https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8 + finland: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8 + finnadie: https://github.githubassets.com/images/icons/emoji/finnadie.png?v8 + fire: https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8 + fire_engine: https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8 + fire_extinguisher: https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8 + firecracker: https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8 + firefighter: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8 + fireworks: https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8 + first_quarter_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8 + first_quarter_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8 + fish: https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8 + fish_cake: https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8 + fishsticks: https://github.githubassets.com/images/icons/emoji/fishsticks.png?v8 + fishing_pole_and_fish: https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8 + fist: https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8 + fist_left: https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8 + fist_oncoming: https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 + fist_raised: https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8 + fist_right: https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8 + five: https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8 + flags: https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8 + flamingo: https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8 + flashlight: https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8 + flat_shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8 + flatbread: https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8 + fleur_de_lis: https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8 + flight_arrival: https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8 + flight_departure: https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8 + flipper: https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8 + floppy_disk: https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8 + flower_playing_cards: https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8 + flushed: https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8 + fly: https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8 + flying_disc: https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8 + flying_saucer: https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8 + fog: https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8 + foggy: https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8 + fondue: https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8 + foot: https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8 + football: https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8 + footprints: https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8 + fork_and_knife: https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8 + fortune_cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8 + fountain: https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8 + fountain_pen: https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8 + four: https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8 + four_leaf_clover: https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8 + fox_face: https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8 + fr: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8 + framed_picture: https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8 + free: https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8 + french_guiana: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8 + french_polynesia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8 + french_southern_territories: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8 + fried_egg: https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8 + fried_shrimp: https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8 + fries: https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8 + frog: https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8 + frowning: https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8 + frowning_face: https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8 + frowning_man: https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8 + frowning_person: https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8 + frowning_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8 + fu: https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8 + fuelpump: https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8 + full_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8 + full_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8 + funeral_urn: https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8 + gabon: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8 + gambia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8 + game_die: https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8 + garlic: https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8 + gb: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8 + gear: https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8 + gem: https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8 + gemini: https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8 + genie: https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8 + genie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8 + genie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8 + georgia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8 + ghana: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8 + ghost: https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8 + gibraltar: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8 + gift: https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8 + gift_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8 + giraffe: https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8 + girl: https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8 + globe_with_meridians: https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8 + gloves: https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8 + goal_net: https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8 + goat: https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8 + goberserk: https://github.githubassets.com/images/icons/emoji/goberserk.png?v8 + godmode: https://github.githubassets.com/images/icons/emoji/godmode.png?v8 + goggles: https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8 + golf: https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8 + golfing: https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8 + golfing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8 + golfing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8 + gorilla: https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8 + grapes: https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8 + greece: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8 + green_apple: https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8 + green_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8 + green_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8 + green_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8 + green_salad: https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8 + green_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8 + greenland: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8 + grenada: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8 + grey_exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8 + grey_question: https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8 + grimacing: https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8 + grin: https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8 + grinning: https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8 + guadeloupe: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8 + guam: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8 + guard: https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8 + guardsman: https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8 + guardswoman: https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8 + guatemala: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8 + guernsey: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8 + guide_dog: https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8 + guinea: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8 + guinea_bissau: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8 + guitar: https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8 + gun: https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8 + guyana: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8 + haircut: https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8 + haircut_man: https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8 + haircut_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8 + haiti: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8 + hamburger: https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8 + hammer: https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8 + hammer_and_pick: https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8 + hammer_and_wrench: https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8 + hamster: https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8 + hand: https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8 + hand_over_mouth: https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8 + handbag: https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8 + handball_person: https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8 + handshake: https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8 + hankey: https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8 + hash: https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8 + hatched_chick: https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8 + hatching_chick: https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8 + headphones: https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8 + headstone: https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8 + health_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8 + hear_no_evil: https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8 + heard_mcdonald_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8 + heart: https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8 + heart_decoration: https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8 + heart_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8 + heart_eyes_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8 + heart_on_fire: https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8 + heartbeat: https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8 + heartpulse: https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8 + hearts: https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8 + heavy_check_mark: https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8 + heavy_division_sign: https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8 + heavy_dollar_sign: https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8 + heavy_exclamation_mark: https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8 + heavy_heart_exclamation: https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8 + heavy_minus_sign: https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8 + heavy_multiplication_x: https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8 + heavy_plus_sign: https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8 + hedgehog: https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8 + helicopter: https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8 + herb: https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8 + hibiscus: https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8 + high_brightness: https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8 + high_heel: https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8 + hiking_boot: https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8 + hindu_temple: https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8 + hippopotamus: https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8 + hocho: https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8 + hole: https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8 + honduras: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8 + honey_pot: https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8 + honeybee: https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8 + hong_kong: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8 + hook: https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8 + horse: https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8 + horse_racing: https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8 + hospital: https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8 + hot_face: https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8 + hot_pepper: https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8 + hotdog: https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8 + hotel: https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8 + hotsprings: https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8 + hourglass: https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8 + hourglass_flowing_sand: https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8 + house: https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8 + house_with_garden: https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8 + houses: https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8 + hugs: https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8 + hungary: https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8 + hurtrealbad: https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8 + hushed: https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8 + hut: https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8 + ice_cream: https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8 + ice_cube: https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8 + ice_hockey: https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8 + ice_skate: https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8 + icecream: https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8 + iceland: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8 + id: https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8 + ideograph_advantage: https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8 + imp: https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8 + inbox_tray: https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8 + incoming_envelope: https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8 + india: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8 + indonesia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8 + infinity: https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8 + information_desk_person: https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8 + information_source: https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8 + innocent: https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8 + interrobang: https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8 + iphone: https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8 + iran: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8 + iraq: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8 + ireland: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8 + isle_of_man: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8 + israel: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8 + it: https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8 + izakaya_lantern: https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8 + jack_o_lantern: https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8 + jamaica: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8 + japan: https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8 + japanese_castle: https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8 + japanese_goblin: https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8 + japanese_ogre: https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8 + jeans: https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8 + jersey: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8 + jigsaw: https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8 + jordan: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8 + joy: https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8 + joy_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8 + joystick: https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8 + jp: https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8 + judge: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8 + juggling_person: https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8 + kangaroo: https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8 + kazakhstan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8 + kenya: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8 + key: https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8 + keyboard: https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8 + keycap_ten: https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8 + kick_scooter: https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8 + kimono: https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8 + kiribati: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8 + kiss: https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8 + kissing: https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8 + kissing_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8 + kissing_closed_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8 + kissing_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8 + kissing_smiling_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8 + kite: https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8 + kiwi_fruit: https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8 + kneeling_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8 + kneeling_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8 + kneeling_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8 + knife: https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8 + knot: https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8 + koala: https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8 + koko: https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8 + kosovo: https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8 + kr: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8 + kuwait: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8 + kyrgyzstan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8 + lab_coat: https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8 + label: https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8 + lacrosse: https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8 + ladder: https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8 + lady_beetle: https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8 + lantern: https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8 + laos: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8 + large_blue_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8 + large_blue_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8 + large_orange_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8 + last_quarter_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8 + last_quarter_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8 + latin_cross: https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8 + latvia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8 + laughing: https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8 + leafy_green: https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8 + leaves: https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8 + lebanon: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8 + ledger: https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8 + left_luggage: https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8 + left_right_arrow: https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8 + left_speech_bubble: https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8 + leftwards_arrow_with_hook: https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8 + leg: https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8 + lemon: https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8 + leo: https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8 + leopard: https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8 + lesotho: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8 + level_slider: https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8 + liberia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8 + libra: https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8 + libya: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8 + liechtenstein: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8 + light_rail: https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8 + link: https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8 + lion: https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8 + lips: https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8 + lipstick: https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8 + lithuania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8 + lizard: https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8 + llama: https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8 + lobster: https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8 + lock: https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8 + lock_with_ink_pen: https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8 + lollipop: https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8 + long_drum: https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8 + loop: https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8 + lotion_bottle: https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8 + lotus_position: https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8 + lotus_position_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8 + lotus_position_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8 + loud_sound: https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8 + loudspeaker: https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8 + love_hotel: https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8 + love_letter: https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8 + love_you_gesture: https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8 + low_brightness: https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8 + luggage: https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8 + lungs: https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8 + luxembourg: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8 + lying_face: https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8 + m: https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8 + macau: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8 + macedonia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8 + madagascar: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8 + mag: https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8 + mag_right: https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8 + mage: https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8 + mage_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8 + mage_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8 + magic_wand: https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8 + magnet: https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8 + mahjong: https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8 + mailbox: https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8 + mailbox_closed: https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8 + mailbox_with_mail: https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8 + mailbox_with_no_mail: https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8 + malawi: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8 + malaysia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8 + maldives: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8 + male_detective: https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8 + male_sign: https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8 + mali: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8 + malta: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8 + mammoth: https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8 + man: https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8 + man_artist: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8 + man_astronaut: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8 + man_beard: https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8 + man_cartwheeling: https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8 + man_cook: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8 + man_dancing: https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8 + man_facepalming: https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8 + man_factory_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8 + man_farmer: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8 + man_feeding_baby: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8 + man_firefighter: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8 + man_health_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8 + man_in_manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8 + man_in_motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8 + man_in_tuxedo: https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8 + man_judge: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8 + man_juggling: https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8 + man_mechanic: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8 + man_office_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8 + man_pilot: https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8 + man_playing_handball: https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8 + man_playing_water_polo: https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8 + man_scientist: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8 + man_shrugging: https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8 + man_singer: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8 + man_student: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8 + man_teacher: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8 + man_technologist: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8 + man_with_gua_pi_mao: https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8 + man_with_probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8 + man_with_turban: https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8 + man_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8 + mandarin: https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 + mango: https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8 + mans_shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8 + mantelpiece_clock: https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8 + manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8 + maple_leaf: https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8 + marshall_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8 + martial_arts_uniform: https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8 + martinique: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8 + mask: https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8 + massage: https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8 + massage_man: https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8 + massage_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8 + mate: https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8 + mauritania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8 + mauritius: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8 + mayotte: https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8 + meat_on_bone: https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8 + mechanic: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8 + mechanical_arm: https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8 + mechanical_leg: https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8 + medal_military: https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8 + medal_sports: https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8 + medical_symbol: https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8 + mega: https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8 + melon: https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8 + memo: https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8 + men_wrestling: https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8 + mending_heart: https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8 + menorah: https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8 + mens: https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8 + mermaid: https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8 + merman: https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8 + merperson: https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8 + metal: https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8 + metro: https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8 + mexico: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8 + microbe: https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8 + micronesia: https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8 + microphone: https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8 + microscope: https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8 + middle_finger: https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8 + military_helmet: https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8 + milk_glass: https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8 + milky_way: https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8 + minibus: https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8 + minidisc: https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8 + mirror: https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8 + mobile_phone_off: https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8 + moldova: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8 + monaco: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8 + money_mouth_face: https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8 + money_with_wings: https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8 + moneybag: https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8 + mongolia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8 + monkey: https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8 + monkey_face: https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8 + monocle_face: https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8 + monorail: https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8 + montenegro: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8 + montserrat: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8 + moon: https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8 + moon_cake: https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8 + morocco: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8 + mortar_board: https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8 + mosque: https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8 + mosquito: https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8 + motor_boat: https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8 + motor_scooter: https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8 + motorcycle: https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8 + motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8 + motorway: https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8 + mount_fuji: https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8 + mountain: https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8 + mountain_bicyclist: https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8 + mountain_biking_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8 + mountain_biking_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8 + mountain_cableway: https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8 + mountain_railway: https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8 + mountain_snow: https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8 + mouse: https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8 + mouse2: https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8 + mouse_trap: https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8 + movie_camera: https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8 + moyai: https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8 + mozambique: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8 + mrs_claus: https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8 + muscle: https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8 + mushroom: https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8 + musical_keyboard: https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8 + musical_note: https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8 + musical_score: https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8 + mute: https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8 + mx_claus: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8 + myanmar: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8 + nail_care: https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8 + name_badge: https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8 + namibia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8 + national_park: https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8 + nauru: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8 + nauseated_face: https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8 + nazar_amulet: https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8 + neckbeard: https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8 + necktie: https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8 + negative_squared_cross_mark: https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8 + nepal: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8 + nerd_face: https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8 + nesting_dolls: https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8 + netherlands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8 + neutral_face: https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8 + new: https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8 + new_caledonia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8 + new_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8 + new_moon_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8 + new_zealand: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8 + newspaper: https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8 + newspaper_roll: https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8 + next_track_button: https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8 + ng: https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8 + ng_man: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8 + ng_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8 + nicaragua: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8 + niger: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8 + nigeria: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8 + night_with_stars: https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8 + nine: https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8 + ninja: https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8 + niue: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8 + no_bell: https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8 + no_bicycles: https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8 + no_entry: https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8 + no_entry_sign: https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8 + no_good: https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8 + no_good_man: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8 + no_good_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8 + no_mobile_phones: https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8 + no_mouth: https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8 + no_pedestrians: https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8 + no_smoking: https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8 + non-potable_water: https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8 + norfolk_island: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8 + north_korea: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8 + northern_mariana_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8 + norway: https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8 + nose: https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8 + notebook: https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8 + notebook_with_decorative_cover: https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8 + notes: https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8 + nut_and_bolt: https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8 + o: https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8 + o2: https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8 + ocean: https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8 + octocat: https://github.githubassets.com/images/icons/emoji/octocat.png?v8 + octopus: https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8 + oden: https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8 + office: https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8 + office_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8 + oil_drum: https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8 + ok: https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8 + ok_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8 + ok_man: https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8 + ok_person: https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8 + ok_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8 + old_key: https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8 + older_adult: https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8 + older_man: https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8 + older_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8 + olive: https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8 + om: https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8 + oman: https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8 + 'on': https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8 + oncoming_automobile: https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8 + oncoming_bus: https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8 + oncoming_police_car: https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8 + oncoming_taxi: https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8 + one: https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8 + one_piece_swimsuit: https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8 + onion: https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8 + open_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8 + open_file_folder: https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8 + open_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8 + open_mouth: https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8 + open_umbrella: https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8 + ophiuchus: https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8 + orange: https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 + orange_book: https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8 + orange_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8 + orange_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8 + orange_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8 + orangutan: https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8 + orthodox_cross: https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8 + otter: https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8 + outbox_tray: https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8 + owl: https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8 + ox: https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8 + oyster: https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8 + package: https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8 + page_facing_up: https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8 + page_with_curl: https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8 + pager: https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8 + paintbrush: https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8 + pakistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8 + palau: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8 + palestinian_territories: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8 + palm_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8 + palms_up_together: https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8 + panama: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8 + pancakes: https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8 + panda_face: https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8 + paperclip: https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8 + paperclips: https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8 + papua_new_guinea: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8 + parachute: https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8 + paraguay: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8 + parasol_on_ground: https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8 + parking: https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8 + parrot: https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8 + part_alternation_mark: https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8 + partly_sunny: https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8 + partying_face: https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8 + passenger_ship: https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8 + passport_control: https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8 + pause_button: https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8 + paw_prints: https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8 + peace_symbol: https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8 + peach: https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8 + peacock: https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8 + peanuts: https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8 + pear: https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8 + pen: https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8 + pencil: https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8 + pencil2: https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8 + penguin: https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8 + pensive: https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8 + people_holding_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8 + people_hugging: https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8 + performing_arts: https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8 + persevere: https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8 + person_bald: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8 + person_curly_hair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8 + person_feeding_baby: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8 + person_fencing: https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8 + person_in_manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8 + person_in_motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8 + person_in_tuxedo: https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8 + person_red_hair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8 + person_white_hair: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8 + person_with_probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8 + person_with_turban: https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8 + person_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8 + peru: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8 + petri_dish: https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8 + philippines: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8 + phone: https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8 + pick: https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8 + pickup_truck: https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8 + pie: https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8 + pig: https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8 + pig2: https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8 + pig_nose: https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8 + pill: https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8 + pilot: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8 + pinata: https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8 + pinched_fingers: https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8 + pinching_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8 + pineapple: https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8 + ping_pong: https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8 + pirate_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8 + pisces: https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8 + pitcairn_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8 + pizza: https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8 + placard: https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8 + place_of_worship: https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8 + plate_with_cutlery: https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8 + play_or_pause_button: https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8 + pleading_face: https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8 + plunger: https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8 + point_down: https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8 + point_left: https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8 + point_right: https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8 + point_up: https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8 + point_up_2: https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8 + poland: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8 + polar_bear: https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8 + police_car: https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8 + police_officer: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + policeman: https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8 + policewoman: https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8 + poodle: https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8 + poop: https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8 + popcorn: https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8 + portugal: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8 + post_office: https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8 + postal_horn: https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8 + postbox: https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8 + potable_water: https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8 + potato: https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8 + potted_plant: https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8 + pouch: https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8 + poultry_leg: https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8 + pound: https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8 + pout: https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8 + pouting_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8 + pouting_face: https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8 + pouting_man: https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8 + pouting_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8 + pray: https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8 + prayer_beads: https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8 + pregnant_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8 + pretzel: https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8 + previous_track_button: https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8 + prince: https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8 + princess: https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8 + printer: https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8 + probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8 + puerto_rico: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8 + punch: https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8 + purple_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8 + purple_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8 + purple_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8 + purse: https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8 + pushpin: https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8 + put_litter_in_its_place: https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8 + qatar: https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8 + question: https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8 + rabbit: https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8 + rabbit2: https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8 + raccoon: https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8 + racehorse: https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8 + racing_car: https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8 + radio: https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8 + radio_button: https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8 + radioactive: https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8 + rage: https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8 + rage1: https://github.githubassets.com/images/icons/emoji/rage1.png?v8 + rage2: https://github.githubassets.com/images/icons/emoji/rage2.png?v8 + rage3: https://github.githubassets.com/images/icons/emoji/rage3.png?v8 + rage4: https://github.githubassets.com/images/icons/emoji/rage4.png?v8 + railway_car: https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8 + railway_track: https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8 + rainbow: https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8 + rainbow_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8 + raised_back_of_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8 + raised_eyebrow: https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8 + raised_hand: https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8 + raised_hand_with_fingers_splayed: https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8 + raised_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8 + raising_hand: https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8 + raising_hand_man: https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8 + raising_hand_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8 + ram: https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8 + ramen: https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8 + rat: https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8 + razor: https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8 + receipt: https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8 + record_button: https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8 + recycle: https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8 + red_car: https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8 + red_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8 + red_envelope: https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8 + red_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8 + red_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8 + red_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8 + registered: https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8 + relaxed: https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8 + relieved: https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8 + reminder_ribbon: https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8 + repeat: https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8 + repeat_one: https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8 + rescue_worker_helmet: https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8 + restroom: https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8 + reunion: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8 + revolving_hearts: https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8 + rewind: https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8 + rhinoceros: https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8 + ribbon: https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8 + rice: https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8 + rice_ball: https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8 + rice_cracker: https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8 + rice_scene: https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8 + right_anger_bubble: https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8 + ring: https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8 + ringed_planet: https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8 + robot: https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8 + rock: https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8 + rocket: https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8 + rofl: https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8 + roll_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8 + roll_of_paper: https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8 + roller_coaster: https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8 + roller_skate: https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8 + romania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8 + rooster: https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8 + rose: https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8 + rosette: https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8 + rotating_light: https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8 + round_pushpin: https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8 + rowboat: https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8 + rowing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8 + rowing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8 + ru: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8 + rugby_football: https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8 + runner: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8 + running: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8 + running_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8 + running_shirt_with_sash: https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8 + running_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8 + rwanda: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8 + sa: https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8 + safety_pin: https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8 + safety_vest: https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8 + sagittarius: https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8 + sailboat: https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8 + sake: https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8 + salt: https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8 + samoa: https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8 + san_marino: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8 + sandal: https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8 + sandwich: https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8 + santa: https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8 + sao_tome_principe: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8 + sari: https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8 + sassy_man: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8 + sassy_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8 + satellite: https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8 + satisfied: https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8 + saudi_arabia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8 + sauna_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8 + sauna_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8 + sauna_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8 + sauropod: https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8 + saxophone: https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8 + scarf: https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8 + school: https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8 + school_satchel: https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8 + scientist: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8 + scissors: https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8 + scorpion: https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8 + scorpius: https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8 + scotland: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8 + scream: https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8 + scream_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8 + screwdriver: https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8 + scroll: https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8 + seal: https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8 + seat: https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8 + secret: https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8 + see_no_evil: https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8 + seedling: https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8 + selfie: https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8 + senegal: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8 + serbia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8 + service_dog: https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8 + seven: https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8 + sewing_needle: https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8 + seychelles: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8 + shallow_pan_of_food: https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8 + shamrock: https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8 + shark: https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8 + shaved_ice: https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8 + sheep: https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8 + shell: https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8 + shield: https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8 + shinto_shrine: https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8 + ship: https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8 + shipit: https://github.githubassets.com/images/icons/emoji/shipit.png?v8 + shirt: https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8 + shoe: https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8 + shopping: https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8 + shopping_cart: https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8 + shorts: https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8 + shower: https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8 + shrimp: https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8 + shrug: https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8 + shushing_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8 + sierra_leone: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8 + signal_strength: https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8 + singapore: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8 + singer: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8 + sint_maarten: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8 + six: https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8 + six_pointed_star: https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8 + skateboard: https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8 + ski: https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8 + skier: https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8 + skull: https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8 + skull_and_crossbones: https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8 + skunk: https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8 + sled: https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8 + sleeping: https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8 + sleeping_bed: https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8 + sleepy: https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8 + slightly_frowning_face: https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8 + slightly_smiling_face: https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8 + slot_machine: https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8 + sloth: https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8 + slovakia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8 + slovenia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8 + small_airplane: https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8 + small_blue_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8 + small_orange_diamond: https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8 + small_red_triangle: https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8 + small_red_triangle_down: https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8 + smile: https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8 + smile_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8 + smiley: https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8 + smiley_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8 + smiling_face_with_tear: https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8 + smiling_face_with_three_hearts: https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8 + smiling_imp: https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8 + smirk: https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8 + smirk_cat: https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8 + smoking: https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8 + snail: https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8 + snake: https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8 + sneezing_face: https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8 + snowboarder: https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8 + snowflake: https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8 + snowman: https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8 + snowman_with_snow: https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8 + soap: https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8 + sob: https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8 + soccer: https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8 + socks: https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8 + softball: https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8 + solomon_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8 + somalia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8 + soon: https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8 + sos: https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8 + sound: https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8 + south_africa: https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8 + south_georgia_south_sandwich_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8 + south_sudan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8 + space_invader: https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8 + spades: https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8 + spaghetti: https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8 + sparkle: https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8 + sparkler: https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8 + sparkles: https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8 + sparkling_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8 + speak_no_evil: https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8 + speaker: https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8 + speaking_head: https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8 + speech_balloon: https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8 + speedboat: https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8 + spider: https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8 + spider_web: https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8 + spiral_calendar: https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8 + spiral_notepad: https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8 + sponge: https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8 + spoon: https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8 + squid: https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8 + sri_lanka: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8 + st_barthelemy: https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8 + st_helena: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8 + st_kitts_nevis: https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8 + st_lucia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8 + st_martin: https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8 + st_pierre_miquelon: https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8 + st_vincent_grenadines: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8 + stadium: https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8 + standing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8 + standing_person: https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8 + standing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8 + star: https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8 + star2: https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8 + star_and_crescent: https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8 + star_of_david: https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8 + star_struck: https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8 + stars: https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8 + station: https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8 + statue_of_liberty: https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8 + steam_locomotive: https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8 + stethoscope: https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8 + stew: https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8 + stop_button: https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8 + stop_sign: https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8 + stopwatch: https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8 + straight_ruler: https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8 + strawberry: https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8 + stuck_out_tongue: https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8 + stuck_out_tongue_closed_eyes: https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8 + stuck_out_tongue_winking_eye: https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8 + student: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8 + studio_microphone: https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8 + stuffed_flatbread: https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8 + sudan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8 + sun_behind_large_cloud: https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8 + sun_behind_rain_cloud: https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8 + sun_behind_small_cloud: https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8 + sun_with_face: https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8 + sunflower: https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8 + sunglasses: https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8 + sunny: https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8 + sunrise: https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8 + sunrise_over_mountains: https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8 + superhero: https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8 + superhero_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8 + superhero_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8 + supervillain: https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8 + supervillain_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8 + supervillain_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8 + surfer: https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8 + surfing_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8 + surfing_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8 + suriname: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8 + sushi: https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8 + suspect: https://github.githubassets.com/images/icons/emoji/suspect.png?v8 + suspension_railway: https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8 + svalbard_jan_mayen: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8 + swan: https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8 + swaziland: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8 + sweat: https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8 + sweat_drops: https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8 + sweat_smile: https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8 + sweden: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8 + sweet_potato: https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8 + swim_brief: https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8 + swimmer: https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8 + swimming_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8 + swimming_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8 + switzerland: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8 + symbols: https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8 + synagogue: https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8 + syria: https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8 + syringe: https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8 + t-rex: https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8 + taco: https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8 + tada: https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8 + taiwan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8 + tajikistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8 + takeout_box: https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8 + tamale: https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8 + tanabata_tree: https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8 + tangerine: https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8 + tanzania: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8 + taurus: https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8 + taxi: https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8 + tea: https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8 + teacher: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8 + teapot: https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8 + technologist: https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8 + teddy_bear: https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8 + telephone: https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8 + telephone_receiver: https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8 + telescope: https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8 + tennis: https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8 + tent: https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8 + test_tube: https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8 + thailand: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8 + thermometer: https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8 + thinking: https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8 + thong_sandal: https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8 + thought_balloon: https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8 + thread: https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8 + three: https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8 + thumbsdown: https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8 + thumbsup: https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8 + ticket: https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8 + tickets: https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8 + tiger: https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8 + tiger2: https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8 + timer_clock: https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8 + timor_leste: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8 + tipping_hand_man: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8 + tipping_hand_person: https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8 + tipping_hand_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8 + tired_face: https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8 + tm: https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8 + togo: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8 + toilet: https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8 + tokelau: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8 + tokyo_tower: https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8 + tomato: https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8 + tonga: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8 + tongue: https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8 + toolbox: https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8 + tooth: https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8 + toothbrush: https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8 + top: https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8 + tophat: https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8 + tornado: https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8 + tr: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8 + trackball: https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8 + tractor: https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8 + traffic_light: https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8 + train: https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8 + train2: https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8 + tram: https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8 + transgender_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8 + transgender_symbol: https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8 + triangular_flag_on_post: https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8 + triangular_ruler: https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8 + trident: https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8 + trinidad_tobago: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8 + tristan_da_cunha: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8 + triumph: https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8 + trolleybus: https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8 + trollface: https://github.githubassets.com/images/icons/emoji/trollface.png?v8 + trophy: https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8 + tropical_drink: https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8 + tropical_fish: https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8 + truck: https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8 + trumpet: https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8 + tshirt: https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8 + tulip: https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8 + tumbler_glass: https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8 + tunisia: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8 + turkey: https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8 + turkmenistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8 + turks_caicos_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8 + turtle: https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8 + tuvalu: https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8 + tv: https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8 + twisted_rightwards_arrows: https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8 + two: https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8 + two_hearts: https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8 + two_men_holding_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8 + two_women_holding_hands: https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8 + u5272: https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8 + u5408: https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8 + u55b6: https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8 + u6307: https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8 + u6708: https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8 + u6709: https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8 + u6e80: https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8 + u7121: https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8 + u7533: https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8 + u7981: https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8 + u7a7a: https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8 + uganda: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8 + uk: https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8 + ukraine: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8 + umbrella: https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8 + unamused: https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8 + underage: https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8 + unicorn: https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8 + united_arab_emirates: https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8 + united_nations: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8 + unlock: https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8 + up: https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8 + upside_down_face: https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8 + uruguay: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8 + us: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8 + us_outlying_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8 + us_virgin_islands: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8 + uzbekistan: https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8 + v: https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8 + vampire: https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8 + vampire_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8 + vampire_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8 + vanuatu: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8 + vatican_city: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8 + venezuela: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8 + vertical_traffic_light: https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8 + vhs: https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8 + vibration_mode: https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8 + video_camera: https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8 + video_game: https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8 + vietnam: https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8 + violin: https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8 + virgo: https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8 + volcano: https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8 + volleyball: https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8 + vomiting_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8 + vs: https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8 + vulcan_salute: https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8 + waffle: https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8 + wales: https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8 + walking: https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8 + walking_man: https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8 + walking_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8 + wallis_futuna: https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8 + waning_crescent_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8 + waning_gibbous_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8 + warning: https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8 + wastebasket: https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8 + watch: https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8 + water_buffalo: https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8 + water_polo: https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8 + watermelon: https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8 + wave: https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8 + wavy_dash: https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8 + waxing_crescent_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8 + waxing_gibbous_moon: https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8 + wc: https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8 + weary: https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8 + wedding: https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8 + weight_lifting: https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8 + weight_lifting_man: https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8 + weight_lifting_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8 + western_sahara: https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8 + whale: https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8 + whale2: https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8 + wheel_of_dharma: https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8 + wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8 + white_check_mark: https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8 + white_circle: https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8 + white_flag: https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8 + white_flower: https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8 + white_haired_man: https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8 + white_haired_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8 + white_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8 + white_large_square: https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8 + white_medium_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8 + white_medium_square: https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8 + white_small_square: https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8 + white_square_button: https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8 + wilted_flower: https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8 + wind_chime: https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8 + wind_face: https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8 + window: https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8 + wine_glass: https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8 + wink: https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8 + wolf: https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8 + woman: https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8 + woman_artist: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8 + woman_astronaut: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8 + woman_beard: https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8 + woman_cartwheeling: https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8 + woman_cook: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8 + woman_dancing: https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8 + woman_facepalming: https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8 + woman_factory_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8 + woman_farmer: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8 + woman_feeding_baby: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8 + woman_firefighter: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8 + woman_health_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8 + woman_in_manual_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8 + woman_in_motorized_wheelchair: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8 + woman_in_tuxedo: https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8 + woman_judge: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8 + woman_juggling: https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8 + woman_mechanic: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8 + woman_office_worker: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8 + woman_pilot: https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8 + woman_playing_handball: https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8 + woman_playing_water_polo: https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8 + woman_scientist: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8 + woman_shrugging: https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8 + woman_singer: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8 + woman_student: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8 + woman_teacher: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8 + woman_technologist: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8 + woman_with_headscarf: https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8 + woman_with_probing_cane: https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8 + woman_with_turban: https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8 + woman_with_veil: https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8 + womans_clothes: https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8 + womans_hat: https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8 + women_wrestling: https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8 + womens: https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8 + wood: https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8 + woozy_face: https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8 + world_map: https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8 + worm: https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8 + worried: https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8 + wrench: https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8 + wrestling: https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8 + writing_hand: https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8 + x: https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8 + yarn: https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8 + yawning_face: https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8 + yellow_circle: https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8 + yellow_heart: https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8 + yellow_square: https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8 + yemen: https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8 + yen: https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8 + yin_yang: https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8 + yo_yo: https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8 + yum: https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8 + zambia: https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8 + zany_face: https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8 + zap: https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8 + zebra: https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8 + zero: https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8 + zimbabwe: https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8 + zipper_mouth_face: https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8 + zombie: https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8 + zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 + zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 + zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 +servers: + - url: https://api.github.com diff --git a/provider-dev/source/enterprise_team_memberships.yaml b/provider-dev/source/enterprise_team_memberships.yaml new file mode 100644 index 0000000..774a076 --- /dev/null +++ b/provider-dev/source/enterprise_team_memberships.yaml @@ -0,0 +1,434 @@ +openapi: 3.0.3 +info: + title: enterprise_team_memberships API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/teams/{enterprise_team}/memberships: + get: + summary: List members in an enterprise team + description: Lists all team members in an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + /enterprises/{enterprise}/teams/{enterprise_team}/memberships/add: + post: + summary: Bulk add team members + description: Add multiple team members to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to add to the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully added team members. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + /enterprises/{enterprise}/teams/{enterprise_team}/memberships/remove: + post: + summary: Bulk remove team members + description: Remove multiple team members from an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to be removed from the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully removed team members. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + /enterprises/{enterprise}/teams/{enterprise_team}/memberships/{username}: + get: + summary: Get enterprise team membership + description: Returns whether the user is a member of the enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/username' + responses: + '200': + description: User is a member of the enterprise team. + content: + application/json: + schema: + $ref: '#/components/schemas/simple-user' + examples: + exampleKey1: + $ref: '#/components/examples/simple-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + put: + summary: Add team member + description: Add a team member to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/username' + responses: + '201': + description: Successfully added team member + content: + application/json: + schema: + $ref: '#/components/schemas/simple-user' + examples: + exampleKey1: + $ref: '#/components/examples/simple-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members + delete: + summary: Remove team membership + description: Remove membership of a specific user from a particular team in an enterprise. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + x-stackQL-resource: enterprise_team_members +components: + schemas: + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + enterprise-team: + name: enterprise-team + description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + simple-user: + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/enterprise_team_organizations.yaml b/provider-dev/source/enterprise_team_organizations.yaml new file mode 100644 index 0000000..bd80a19 --- /dev/null +++ b/provider-dev/source/enterprise_team_organizations.yaml @@ -0,0 +1,342 @@ +openapi: 3.0.3 +info: + title: enterprise_team_organizations API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/teams/{enterprise_team}/organizations: + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + /enterprises/{enterprise}/teams/{enterprise_team}/organizations/add: + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + /enterprises/{enterprise}/teams/{enterprise_team}/organizations/remove: + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + /enterprises/{enterprise}/teams/{enterprise_team}/organizations/{org}: + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/org' + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple' + '404': + description: The team is not assigned to the organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/org' + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/enterprise-team' + - $ref: '#/components/parameters/org' + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + x-stackQL-resource: enterprise_team_organizations +components: + schemas: + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + enterprise-team: + name: enterprise-team + description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization +servers: + - url: https://api.github.com diff --git a/provider-dev/source/enterprise_teams.yaml b/provider-dev/source/enterprise_teams.yaml new file mode 100644 index 0000000..026e5b1 --- /dev/null +++ b/provider-dev/source/enterprise_teams.yaml @@ -0,0 +1,396 @@ +openapi: 3.0.3 +info: + title: enterprise_teams API + description: github API + version: 1.1.4 +paths: + /enterprises/{enterprise}/teams: + get: + summary: List enterprise teams + description: List all teams in the enterprise for the authenticated user + tags: + - enterprise-teams + operationId: enterprise-teams/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + post: + summary: Create an enterprise team + description: To create an enterprise team, the authenticated user must be an owner of the enterprise. + tags: + - enterprise-teams + operationId: enterprise-teams/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + nullable: true + type: string + description: A description of the team. + sync_to_organizations: + type: string + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be set. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + nullable: true + type: string + description: The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). + required: + - name + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-item' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + /enterprises/{enterprise}/teams/{team_slug}: + get: + summary: Get an enterprise team + description: Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam NΓ€me" would become `ent:my-team-name`. + tags: + - enterprise-teams + operationId: enterprise-teams/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/team-slug' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-item' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + patch: + summary: Update an enterprise team + description: To edit a team, the authenticated user must be an enterprise owner. + tags: + - enterprise-teams + operationId: enterprise-teams/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/team-slug' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + nullable: true + type: string + description: A new name for the team. + description: + nullable: true + type: string + description: A new description for the team. + sync_to_organizations: + type: string + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be changed. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + nullable: true + type: string + description: The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/enterprise-team' + examples: + default: + $ref: '#/components/examples/enterprise-teams-item' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams + delete: + summary: Delete an enterprise team + description: |- + To delete an enterprise team, the authenticated user must be an enterprise owner. + + If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + tags: + - enterprise-teams + operationId: enterprise-teams/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team + parameters: + - $ref: '#/components/parameters/enterprise' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + x-stackQL-resource: enterprise_teams +components: + schemas: + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: + nullable: true + type: string + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + description: 'Retired: this field will not be returned with GHEC enterprise teams.' + example: Justice League + html_url: + type: string + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - name + - html_url + - slug + - created_at + - updated_at + - group_id + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + examples: + enterprise-teams-items: + value: + - id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + enterprise-teams-item: + value: + id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/gists.yaml b/provider-dev/source/gists.yaml new file mode 100644 index 0000000..2f22fca --- /dev/null +++ b/provider-dev/source/gists.yaml @@ -0,0 +1,2272 @@ +openapi: 3.0.3 +info: + title: gists API + description: View, modify your gists. + version: 1.1.4 +paths: + /gists: + get: + summary: List gists for the authenticated user + description: 'Lists the authenticated user''s gists or if called anonymously, this endpoint returns all public gists:' + tags: + - gists + operationId: gists/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + post: + summary: Create a gist + description: |- + Allows you to add a new gist with one or more files. + + > [!NOTE] + > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + operationId: gists/create + tags: + - gists + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#create-a-gist + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: Description of the gist + example: Example Ruby script + type: string + files: + description: Names and content for the files that make up the gist + example: + hello.rb: + content: puts "Hello, World!" + type: object + additionalProperties: + type: object + properties: + content: + description: Content of the file + readOnly: false + type: string + required: + - content + public: + description: Flag indicating whether the gist is public + example: true + type: boolean + default: false + enum: + - 'true' + - 'false' + required: + - files + type: object + examples: + default: + summary: Creating a gist + value: + description: Example of a gist + public: false + files: + README.md: + content: Hello World + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist' + headers: + Location: + example: https://api.github.com/gists/aa5a315d61ae9438b18d + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/public: + get: + summary: List public gists + description: |- + List public gists sorted by most recently updated to least recently updated. + + Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + tags: + - gists + operationId: gists/list-public + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-public-gists + parameters: + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/starred: + get: + summary: List starred gists + description: 'List the authenticated user''s starred gists:' + tags: + - gists + operationId: gists/list-starred + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-starred-gists + parameters: + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}: + get: + summary: Get a gist + description: |- + Gets a specified gist. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#get-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden_gist' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + patch: + summary: Update a gist + description: |- + Allows you to update a gist's description and to update, delete, or rename gist files. Files + from the previous version of the gist that aren't explicitly changed during an edit + are unchanged. + + At least one of `description` or `files` is required. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#update-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: The description of the gist. + example: Example Ruby script + type: string + files: + description: |- + The gist files to be updated, renamed, or deleted. Each `key` must match the current filename + (including extension) of the targeted gist file. For example: `hello.py`. + + To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be + deleted if the specified object does not contain at least one of `content` or `filename`. + example: + hello.rb: + content: blah + filename: goodbye.rb + type: object + additionalProperties: + type: object + nullable: true + properties: + content: + description: The new content of the file. + type: string + filename: + description: The new filename for the file. + type: string + nullable: true + type: object + nullable: true + examples: + updateGist: + summary: Updating a gist + value: + description: An updated gist description + files: + README.md: + content: Hello World from GitHub + deleteFile: + summary: Deleting a gist file + value: + files: + hello.py: null + renameFile: + summary: Renaming a gist file + value: + files: + hello.py: + filename: goodbye.py + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + updateGist: + $ref: '#/components/examples/gist' + deleteFile: + $ref: '#/components/examples/delete-gist-file' + renameFile: + $ref: '#/components/examples/rename-gist-file' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + delete: + summary: Delete a gist + description: '' + tags: + - gists + operationId: gists/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#delete-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/comments: + get: + summary: List gist comments + description: |- + Lists the comments on a gist. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#list-gist-comments + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create a gist comment + description: |- + Creates a comment on a gist. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#create-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + body: + description: The comment text. + type: string + maxLength: 65535 + example: Body of the attachment + type: object + required: + - body + examples: + default: + summary: Creating a comment in a gist + value: + body: This is a comment to a gist + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment' + headers: + Location: + example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + /gists/{gist_id}/comments/{comment_id}: + get: + summary: Get a gist comment + description: |- + Gets a comment on a gist. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#get-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden_gist' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update a gist comment + description: |- + Updates a comment on a gist. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#update-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + properties: + body: + description: The comment text. + type: string + maxLength: 65535 + example: Body of the attachment + type: object + required: + - body + examples: + default: + summary: Updating a comment in a gist + value: + body: This is an update to a comment in a gist + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-comment' + examples: + default: + $ref: '#/components/examples/gist-comment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete a gist comment + description: '' + tags: + - gists + operationId: gists/delete-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: comments + x-stackQL-resource: comments + /gists/{gist_id}/commits: + get: + summary: List gist commits + description: '' + tags: + - gists + operationId: gists/list-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gist-commits + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gist-commit' + examples: + default: + $ref: '#/components/examples/gist-commit-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/forks: + get: + summary: List gist forks + description: '' + tags: + - gists + operationId: gists/list-forks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gist-forks + parameters: + - $ref: '#/components/parameters/gist-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist-fork-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + post: + summary: Fork a gist + description: '' + tags: + - gists + operationId: gists/fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#fork-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist' + headers: + Location: + example: https://api.github.com/gists/aa5a315d61ae9438b18d + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/star: + get: + summary: Check if a gist is starred + description: '' + tags: + - gists + operationId: gists/check-is-starred + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response if gist is starred + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if gist is not starred + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + put: + summary: Star a gist + description: Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - gists + operationId: gists/star + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#star-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + delete: + summary: Unstar a gist + description: '' + tags: + - gists + operationId: gists/unstar + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#unstar-a-gist + parameters: + - $ref: '#/components/parameters/gist-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /gists/{gist_id}/{sha}: + get: + summary: Get a gist revision + description: |- + Gets a specified gist revision. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + tags: + - gists + operationId: gists/get-revision + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#get-a-gist-revision + parameters: + - $ref: '#/components/parameters/gist-id' + - name: sha + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gist-simple' + examples: + default: + $ref: '#/components/examples/gist' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists + /users/{username}/gists: + get: + summary: List gists for a user + description: 'Lists public gists for the specified user:' + tags: + - gists + operationId: gists/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/base-gist' + examples: + default: + $ref: '#/components/examples/base-gist-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: gists + subcategory: gists + x-stackQL-resource: gists +components: + schemas: + base-gist: + title: Base Gist + description: Base Gist + type: object + properties: + url: + type: string + format: uri + forks_url: + type: string + format: uri + commits_url: + type: string + format: uri + id: + type: string + node_id: + type: string + git_pull_url: + type: string + format: uri + git_push_url: + type: string + format: uri + html_url: + type: string + format: uri + files: + type: object + additionalProperties: + type: object + properties: + filename: + type: string + type: + type: string + language: + type: string + raw_url: + type: string + size: + type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + default: utf-8 + public: + type: boolean + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + description: + type: string + nullable: true + comments: + type: integer + comments_enabled: + type: boolean + user: + $ref: '#/components/schemas/nullable-simple-user' + comments_url: + type: string + format: uri + owner: + $ref: '#/components/schemas/simple-user' + truncated: + type: boolean + forks: + type: array + items: {} + history: + type: array + items: {} + required: + - id + - node_id + - url + - forks_url + - commits_url + - git_pull_url + - git_push_url + - html_url + - comments_url + - public + - description + - comments + - user + - files + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + user: null + required: + - id + - node_id + - url + - forks_url + - commits_url + - git_pull_url + - git_push_url + - html_url + - comments_url + - public + - description + - comments + - files + - created_at + - updated_at + type: object + version: '2026-03-10' + - changeset: remove_forks_history_from_base_gist + patch: + - op: remove + path: /properties/forks + - op: remove + path: /properties/history + version: '2026-03-10' + gist-simple: + title: Gist Simple + description: Gist Simple + type: object + properties: + forks: + deprecated: true + nullable: true + type: array + items: + type: object + properties: + id: + type: string + url: + type: string + format: uri + user: + $ref: '#/components/schemas/public-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + history: + deprecated: true + nullable: true + type: array + items: + $ref: '#/components/schemas/gist-history' + fork_of: + nullable: true + title: Gist + description: Gist + type: object + properties: + url: + type: string + format: uri + forks_url: + type: string + format: uri + commits_url: + type: string + format: uri + id: + type: string + node_id: + type: string + git_pull_url: + type: string + format: uri + git_push_url: + type: string + format: uri + html_url: + type: string + format: uri + files: + type: object + additionalProperties: + type: object + properties: + filename: + type: string + type: + type: string + language: + type: string + raw_url: + type: string + size: + type: integer + public: + type: boolean + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + description: + type: string + nullable: true + comments: + type: integer + comments_enabled: + type: boolean + user: + $ref: '#/components/schemas/nullable-simple-user' + comments_url: + type: string + format: uri + owner: + $ref: '#/components/schemas/nullable-simple-user' + truncated: + type: boolean + forks: + type: array + items: {} + history: + type: array + items: {} + required: + - id + - node_id + - url + - forks_url + - commits_url + - git_pull_url + - git_push_url + - html_url + - comments_url + - public + - description + - comments + - user + - files + - created_at + - updated_at + url: + type: string + forks_url: + type: string + commits_url: + type: string + id: + type: string + node_id: + type: string + git_pull_url: + type: string + git_push_url: + type: string + html_url: + type: string + files: + type: object + additionalProperties: + nullable: true + type: object + properties: + filename: + type: string + type: + type: string + language: + type: string + raw_url: + type: string + size: + type: integer + truncated: + type: boolean + content: + type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + default: utf-8 + public: + type: boolean + created_at: + type: string + updated_at: + type: string + description: + type: string + nullable: true + comments: + type: integer + comments_enabled: + type: boolean + user: + type: string + nullable: true + comments_url: + type: string + owner: + $ref: '#/components/schemas/simple-user' + truncated: + type: boolean + x-github-breaking-changes: + - changeset: remove_forks_history_from_base_gist + patch: + - op: remove + path: /properties/forks + - op: remove + path: /properties/history + version: '2026-03-10' + gist-comment: + title: Gist Comment + description: A comment made to a gist. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDExOkdpc3RDb21tZW50MQ== + url: + type: string + format: uri + example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: + description: The comment text. + type: string + maxLength: 65535 + example: Body of the attachment + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-18T23:23:56Z' + updated_at: + type: string + format: date-time + example: '2011-04-18T23:23:56Z' + author_association: + $ref: '#/components/schemas/author-association' + required: + - url + - id + - node_id + - user + - body + - author_association + - created_at + - updated_at + gist-commit: + title: Gist Commit + description: Gist Commit + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: + type: string + example: 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + $ref: '#/components/schemas/nullable-simple-user' + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + committed_at: + type: string + format: date-time + example: '2010-04-14T02:15:15Z' + required: + - url + - user + - version + - committed_at + - change_status + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + public-user: + title: Public User + description: Public User + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + user_view_type: + type: string + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + events_url: + type: string + received_events_url: + type: string + format: uri + type: + type: string + site_admin: + type: boolean + name: + type: string + nullable: true + company: + type: string + nullable: true + blog: + type: string + nullable: true + location: + type: string + nullable: true + email: + type: string + format: email + nullable: true + notification_email: + type: string + format: email + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + nullable: true + twitter_username: + type: string + nullable: true + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + private_gists: + type: integer + example: 1 + total_private_repos: + type: integer + example: 2 + owned_private_repos: + type: integer + example: 2 + disk_usage: + type: integer + example: 1 + collaborators: + type: integer + example: 3 + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + additionalProperties: false + gist-history: + title: Gist History + description: Gist History + type: object + properties: + user: + $ref: '#/components/schemas/nullable-simple-user' + version: + type: string + committed_at: + type: string + format: date-time + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + url: + type: string + format: uri + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden_gist: + description: Forbidden Gist + content: + application/json: + schema: + type: object + properties: + block: + type: object + properties: + reason: + type: string + created_at: + type: string + html_url: + type: string + nullable: true + message: + type: string + documentation_url: + type: string + parameters: + since: + name: since + description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + gist-id: + name: gist_id + description: The unique identifier of the gist. + in: path + required: true + schema: + type: string + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + base-gist-items: + value: + - url: https://api.github.com/gists/aa5a315d61ae9438b18d + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + files: + hello_world.rb: + filename: hello_world.rb + type: application/x-ruby + language: Ruby + raw_url: https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb + size: 167 + public: true + created_at: '2010-04-14T02:15:15Z' + updated_at: '2011-06-20T11:34:15Z' + description: Hello World Examples + comments: 0 + user: null + comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + truncated: false + gist: + value: + url: https://api.github.com/gists/2decf6c462d9b4418f2 + forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks + commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits + id: 2decf6c462d9b4418f2 + node_id: G_kwDOBhHyLdZDliNDQxOGYy + git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git + git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git + html_url: https://gist.github.com/2decf6c462d9b4418f2 + files: + README.md: + filename: README.md + type: text/markdown + language: Markdown + raw_url: https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md + size: 23 + truncated: false + content: Hello world from GitHub + encoding: utf-8 + public: true + created_at: '2022-09-20T12:11:58Z' + updated_at: '2022-09-21T10:28:06Z' + description: An updated gist description. + comments: 0 + comments_enabled: true + user: null + comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments + owner: + login: monalisa + id: 104456405 + node_id: U_kgDOBhHyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + forks: [] + history: + - user: + login: monalisa + id: 104456405 + node_id: U_kgyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + version: 468aac8caed5f0c3b859b8286968 + committed_at: '2022-09-21T10:28:06Z' + change_status: + total: 2 + additions: 1 + deletions: 1 + url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 + truncated: false + delete-gist-file: + value: + url: https://api.github.com/gists/2decf6c462d9b4418f2 + forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks + commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits + id: 2decf6c462d9b4418f2 + node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy + git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git + git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git + html_url: https://gist.github.com/2decf6c462d9b4418f2 + files: null + public: true + created_at: '2022-09-20T12:11:58Z' + updated_at: '2022-09-21T10:28:06Z' + description: A gist description. + comments: 0 + user: null + comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments + owner: + login: monalisa + id: 104456405 + node_id: U_kgDOBhHyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + forks: [] + history: + - user: + login: monalisa + id: 104456405 + node_id: U_kgyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + version: 9cc352a89178a6d4 + committed_at: '2022-09-21T10:28:06Z' + change_status: + total: 1 + additions: 0 + deletions: 1 + url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 + truncated: false + rename-gist-file: + value: + url: https://api.github.com/gists/2decf6c462d9b4418f2 + forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks + commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits + id: 2decf6c462d9b4418f2 + node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy + git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git + git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git + html_url: https://gist.github.com/2decf6c462d9b4418f2 + files: + goodbye.py: + filename: goodbye.py + type: application/x-python + language: Python + raw_url: https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py + size: 4 + truncated: false + content: '# Hello world' + public: true + created_at: '2022-09-20T12:11:58Z' + updated_at: '2022-09-21T10:28:06Z' + description: A gist description. + comments: 0 + user: null + comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments + owner: + login: monalisa + id: 104456405 + node_id: U_kgDOBhHyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + forks: [] + history: + - user: + login: monalisa + id: 104456405 + node_id: U_kgyLQ + avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4 + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + version: 468aac8caed5f0c3b859b8286968 + committed_at: '2022-09-21T10:28:06Z' + change_status: + total: 0 + additions: 0 + deletions: 0 + url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968 + truncated: false + gist-comment-items: + value: + - id: 1 + node_id: MDExOkdpc3RDb21tZW50MQ== + url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: Just commenting for the sake of commenting + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-18T23:23:56Z' + updated_at: '2011-04-18T23:23:56Z' + author_association: COLLABORATOR + gist-comment: + value: + id: 1 + node_id: MDExOkdpc3RDb21tZW50MQ== + url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: Just commenting for the sake of commenting + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-18T23:23:56Z' + updated_at: '2011-04-18T23:23:56Z' + author_association: COLLABORATOR + gist-commit-items: + value: + - url: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + change_status: + deletions: 0 + additions: 180 + total: 180 + committed_at: '2010-04-14T02:15:15Z' + gist-fork-items: + value: + - url: https://api.github.com/gists/aa5a315d61ae9438b18d + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + files: + hello_world.rb: + filename: hello_world.rb + type: application/x-ruby + language: Ruby + raw_url: https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb + size: 167 + public: true + created_at: '2010-04-14T02:15:15Z' + updated_at: '2011-06-20T11:34:15Z' + description: Hello World Examples + comments: 1 + user: null + comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + base-gist: + value: + url: https://api.github.com/gists/aa5a315d61ae9438b18d + forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks + commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits + id: aa5a315d61ae9438b18d + node_id: MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk + git_pull_url: https://gist.github.com/aa5a315d61ae9438b18d.git + git_push_url: https://gist.github.com/aa5a315d61ae9438b18d.git + html_url: https://gist.github.com/aa5a315d61ae9438b18d + files: + hello_world.rb: + filename: hello_world.rb + type: application/x-ruby + language: Ruby + raw_url: https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb + size: 167 + public: true + created_at: '2010-04-14T02:15:15Z' + updated_at: '2011-06-20T11:34:15Z' + description: Hello World Examples + comments: 0 + user: null + comments_url: https://api.github.com/gists/aa5a315d61ae9438b18d/comments/ + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + truncated: false + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/git.yaml b/provider-dev/source/git.yaml new file mode 100644 index 0000000..4795599 --- /dev/null +++ b/provider-dev/source/git.yaml @@ -0,0 +1,1626 @@ +openapi: 3.0.3 +info: + title: git API + description: Raw Git functionality. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/git/blobs: + post: + summary: Create a blob + description: '' + tags: + - git + operationId: git/create-blob + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/blobs#create-a-blob + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The new blob's content. + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + default: utf-8 + required: + - content + examples: + default: + value: + content: Content of the blob + encoding: utf-8 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/short-blob' + examples: + default: + $ref: '#/components/examples/short-blob' + headers: + Location: + example: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + description: Validation failed + content: + application/json: + schema: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id' + token_type: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: blobs + x-stackQL-resource: blobs + /repos/{owner}/{repo}/git/blobs/{file_sha}: + get: + summary: Get a blob + description: |- + The `content` in the response will always be Base64 encoded. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw blob data. + - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + + **Note** This endpoint supports blobs up to 100 megabytes in size. + tags: + - git + operationId: git/get-blob + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/blobs#get-a-blob + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: file_sha + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/blob' + examples: + default: + $ref: '#/components/examples/blob' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: blobs + x-stackQL-resource: blobs + /repos/{owner}/{repo}/git/commits: + post: + summary: Create a commit + description: |- + Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - git + operationId: git/create-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/commits#create-a-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The commit message + tree: + type: string + description: The SHA of the tree object this commit points to + parents: + type: array + description: The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + items: + type: string + author: + type: object + description: Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + date: + type: string + format: date-time + description: 'Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + required: + - name + - email + committer: + type: object + description: Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + date: + type: string + format: date-time + description: 'Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + signature: + type: string + description: The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. + required: + - message + - tree + examples: + default: + value: + message: my commit message + author: + name: Mona Octocat + email: octocat@github.com + date: '2008-07-09T16:13:30+12:00' + parents: + - 7d1b31e74ee336d15cbd21741bc88a537ed063a0 + tree: 827efc6d56897b048c772eb4087f854f46256132 + signature: | + -----BEGIN PGP SIGNATURE----- + + iQIzBAABAQAdFiEESn/54jMNIrGSE6Tp6cQjvhfv7nAFAlnT71cACgkQ6cQjvhfv + 7nCWwA//XVqBKWO0zF+bZl6pggvky3Oc2j1pNFuRWZ29LXpNuD5WUGXGG209B0hI + DkmcGk19ZKUTnEUJV2Xd0R7AW01S/YSub7OYcgBkI7qUE13FVHN5ln1KvH2all2n + 2+JCV1HcJLEoTjqIFZSSu/sMdhkLQ9/NsmMAzpf/iIM0nQOyU4YRex9eD1bYj6nA + OQPIDdAuaTQj1gFPHYLzM4zJnCqGdRlg0sOM/zC5apBNzIwlgREatOYQSCfCKV7k + nrU34X8b9BzQaUx48Qa+Dmfn5KQ8dl27RNeWAqlkuWyv3pUauH9UeYW+KyuJeMkU + +NyHgAsWFaCFl23kCHThbLStMZOYEnGagrd0hnm1TPS4GJkV4wfYMwnI4KuSlHKB + jHl3Js9vNzEUQipQJbgCgTiWvRJoK3ENwBTMVkKHaqT4x9U4Jk/XZB6Q8MA09ezJ + 3QgiTjTAGcum9E9QiJqMYdWQPWkaBIRRz5cET6HPB48YNXAAUsfmuYsGrnVLYbG+ + UpC6I97VybYHTy2O9XSGoaLeMI9CsFn38ycAxxbWagk5mhclNTP5mezIq6wKSwmr + X11FW3n1J23fWZn5HJMBsRnUCgzqzX3871IqLYHqRJ/bpZ4h20RhTyPj5c/z7QXp + eSakNQMfbbMcljkha+ZMuVQX1K9aRlVqbmv3ZMWh+OijLYVU2bc= + =5Io4 + -----END PGP SIGNATURE----- + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-commit' + examples: + default: + $ref: '#/components/examples/git-commit' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/git/commits/{commit_sha}: + get: + summary: Get a commit object + description: |- + Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + + To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - git + operationId: git/get-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/commits#get-a-commit-object + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-commit' + examples: + default: + $ref: '#/components/examples/git-commit-2' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/git/matching-refs/{ref}: + get: + summary: List matching references + description: |- + Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. + + When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + + If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + tags: + - git + operationId: git/list-matching-refs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#list-matching-references + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref-items' + headers: + Link: + $ref: '#/components/headers/link' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/ref/{ref}: + get: + summary: Get a reference + description: |- + Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. + + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + tags: + - git + operationId: git/get-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#get-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/refs: + post: + summary: Create a reference + description: Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. + tags: + - git + operationId: git/create-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#create-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ref: + type: string + description: 'The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn''t start with ''refs'' and have at least two slashes, it will be rejected.' + sha: + type: string + description: The SHA1 value for this reference. + required: + - ref + - sha + examples: + default: + value: + ref: refs/heads/featureA + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA + schema: + type: string + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/refs/{ref}: + patch: + summary: Update a reference + description: Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + tags: + - git + operationId: git/update-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#update-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sha: + type: string + description: The SHA1 value to set this reference to + force: + type: boolean + description: Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. + default: false + required: + - sha + examples: + default: + value: + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + force: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-ref' + examples: + default: + $ref: '#/components/examples/git-ref' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + delete: + summary: Delete a reference + description: Deletes the provided reference. + tags: + - git + operationId: git/delete-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/refs#delete-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref-only' + responses: + '204': + description: Response + '409': + $ref: '#/components/responses/conflict' + '422': + description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: refs + x-stackQL-resource: refs + /repos/{owner}/{repo}/git/tags: + post: + summary: Create a tag object + description: |- + Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. + + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - git + operationId: git/create-tag + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/tags#create-a-tag-object + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tag: + type: string + description: The tag's name. This is typically a version (e.g., "v0.0.1"). + message: + type: string + description: The tag message. + object: + type: string + description: The SHA of the git object this is tagging. + type: + type: string + description: The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. + enum: + - commit + - tree + - blob + tagger: + type: object + description: An object with information about the individual creating the tag. + properties: + name: + type: string + description: The name of the author of the tag + email: + type: string + description: The email of the author of the tag + date: + type: string + format: date-time + description: 'When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + required: + - name + - email + required: + - tag + - message + - object + - type + examples: + default: + value: + tag: v0.0.1 + message: initial version + object: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c + type: commit + tagger: + name: Monalisa Octocat + email: octocat@github.com + date: '2011-06-17T14:53:35-07:00' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tag' + examples: + default: + $ref: '#/components/examples/git-tag' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + schema: + type: string + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: tags + x-stackQL-resource: tags + /repos/{owner}/{repo}/git/tags/{tag_sha}: + get: + summary: Get a tag + description: |- + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - git + operationId: git/get-tag + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/tags#get-a-tag + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: tag_sha + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tag' + examples: + default: + $ref: '#/components/examples/git-tag' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: tags + x-stackQL-resource: tags + /repos/{owner}/{repo}/git/trees: + post: + summary: Create a tree + description: |- + The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. + + If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." + + Returns an error if you try to delete a file that does not exist. + tags: + - git + operationId: git/create-tree + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/trees#create-a-tree + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tree: + type: array + description: Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. + items: + type: object + properties: + path: + type: string + description: The file referenced in the tree. + mode: + type: string + description: The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. + enum: + - '100644' + - '100755' + - '040000' + - '160000' + - '120000' + type: + type: string + description: Either `blob`, `tree`, or `commit`. + enum: + - blob + - tree + - commit + sha: + type: string + description: |- + The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + + **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. + nullable: true + content: + type: string + description: |- + The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + + **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. + base_tree: + type: string + description: |- + The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + required: + - tree + examples: + default: + value: + base_tree: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 + tree: + - path: file.rb + mode: '100644' + type: blob + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tree' + examples: + default: + $ref: '#/components/examples/git-tree' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: trees + x-stackQL-resource: trees + /repos/{owner}/{repo}/git/trees/{tree_sha}: + get: + summary: Get a tree + description: |- + Returns a single tree using the SHA1 value or ref name for that tree. + + If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + + > [!NOTE] + > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + tags: + - git + operationId: git/get-tree + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/git/trees#get-a-tree + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: tree_sha + description: The SHA1 value or ref (branch or tag) name of the tree. + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: recursive + description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees.' + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/git-tree' + examples: + default-response: + $ref: '#/components/examples/git-tree-default-response' + response-recursively-retrieving-a-tree: + $ref: '#/components/examples/git-tree-response-recursively-retrieving-a-tree' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: git + subcategory: trees + x-stackQL-resource: trees +components: + schemas: + short-blob: + title: Short Blob + description: Short Blob + type: object + properties: + url: + type: string + sha: + type: string + required: + - url + - sha + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + repository-rule-violation-error: + description: Repository rule violation was detected + type: object + properties: + message: + type: string + documentation_url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id' + token_type: + type: string + blob: + title: Blob + description: Blob + type: object + properties: + content: + type: string + encoding: + type: string + url: + type: string + format: uri + sha: + type: string + size: + type: integer + nullable: true + node_id: + type: string + highlighted_content: + type: string + required: + - sha + - url + - node_id + - size + - content + - encoding + git-commit: + title: Git Commit + description: Low-level Git commit operations within a repository + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + node_id: + type: string + url: + type: string + format: uri + author: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + tree: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - sha + - url + - html_url + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - signature + - payload + - verified_at + html_url: + type: string + format: uri + required: + - sha + - node_id + - url + - html_url + - author + - committer + - tree + - message + - parents + - verification + git-ref: + title: Git Reference + description: Git references within a repository + type: object + properties: + ref: + type: string + node_id: + type: string + url: + type: string + format: uri + object: + type: object + properties: + type: + type: string + sha: + description: SHA for the reference + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + minLength: 40 + maxLength: 40 + url: + type: string + format: uri + required: + - type + - sha + - url + required: + - ref + - node_id + - url + - object + git-tag: + title: Git Tag + description: Metadata for a Git tag + type: object + properties: + node_id: + type: string + example: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: + description: Name of the tag + example: v0.0.1 + type: string + sha: + type: string + example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: + description: URL for the tag + example: https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + type: string + format: uri + message: + description: Message describing the purpose of the tag + example: Initial public release + type: string + tagger: + type: object + properties: + date: + type: string + email: + type: string + name: + type: string + required: + - date + - email + - name + object: + type: object + properties: + sha: + type: string + type: + type: string + url: + type: string + format: uri + required: + - sha + - type + - url + verification: + $ref: '#/components/schemas/verification' + required: + - sha + - url + - node_id + - tagger + - object + - tag + - message + git-tree: + title: Git Tree + description: The hierarchy between files in a Git repository. + type: object + properties: + sha: + type: string + url: + type: string + format: uri + truncated: + type: boolean + tree: + description: Objects specifying a tree structure + type: array + items: + type: object + required: + - path + - mode + - type + - sha + properties: + path: + type: string + example: test/file.rb + mode: + type: string + example: '040000' + type: + type: string + example: tree + sha: + type: string + example: 23f6827669e43831def8a7ad935069c8bd418261 + size: + type: integer + example: 12 + url: + type: string + example: https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 + example: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + required: + - sha + - tree + - truncated + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + secret-scanning-push-protection-bypass-placeholder-id: + description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. + type: string + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + commit-sha: + name: commit_sha + description: The SHA of the commit. + in: path + required: true + schema: + type: string + x-multi-segment: true + git-ref-only: + name: ref + description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + in: path + required: true + example: heads/feature-a + schema: + type: string + x-multi-segment: true + examples: + short-blob: + value: + url: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + sha: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + blob: + value: + content: Q29udGVudCBvZiB0aGUgYmxvYg== + encoding: base64 + url: https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + sha: 3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 + size: 19 + node_id: Q29udGVudCBvZiB0aGUgYmxvYg== + git-commit: + value: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132 + sha: 827efc6d56897b048c772eb4087f854f46256132 + parents: + - url: https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0 + sha: 7d1b31e74ee336d15cbd21741bc88a537ed063a0 + html_url: https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + git-commit-2: + value: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: added readme, because im a good github citizen + tree: + url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + html_url: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + git-ref-items: + value: + - ref: refs/heads/feature-a + node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE= + url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a + object: + type: commit + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd + - ref: refs/heads/feature-b + node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI= + url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b + object: + type: commit + sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac + url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac + git-ref: + value: + ref: refs/heads/featureA + node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== + url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA + object: + type: commit + sha: aa218f56b14c9653891f9e74264a383fa43fefbd + url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd + git-tag: + value: + node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: v0.0.1 + sha: 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + message: initial version + tagger: + name: Monalisa Octocat + email: octocat@github.com + date: '2014-11-07T22:01:45Z' + object: + type: commit + sha: c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c + url: https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + git-tree: + value: + sha: cd8274d15fa3ae2ab983129fb037999f264ba9a7 + url: https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 + tree: + - path: file.rb + mode: '100644' + type: blob + size: 132 + sha: 7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + truncated: true + git-tree-default-response: + summary: Default response + value: + sha: 9fb037999f264ba9a7fc6274d15fa3ae2ab98312 + url: https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312 + tree: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + - path: subdir + mode: '040000' + type: tree + sha: f484d249c660418515fb01c2b9662073663c242e + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e + - path: exec_file + mode: '100755' + type: blob + size: 75 + sha: 45b983be36b73c0788dc9cbcb76cbb80fc7bb057 + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057 + truncated: false + git-tree-response-recursively-retrieving-a-tree: + summary: Response recursively retrieving a tree + value: + sha: fc6274d15fa3ae2ab983129fb037999f264ba9a7 + url: https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7 + tree: + - path: subdir/file.txt + mode: '100644' + type: blob + size: 132 + sha: 7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + url: https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b + truncated: false + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/gitignore.yaml b/provider-dev/source/gitignore.yaml new file mode 100644 index 0000000..60ccc23 --- /dev/null +++ b/provider-dev/source/gitignore.yaml @@ -0,0 +1,143 @@ +openapi: 3.0.3 +info: + title: gitignore API + description: View gitignore templates + version: 1.1.4 +paths: + /gitignore/templates: + get: + summary: Get all gitignore templates + description: List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). + operationId: gitignore/get-all-templates + tags: + - gitignore + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - Actionscript + - Android + - AppceleratorTitanium + - Autotools + - Bancha + - C + - C++ + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: gitignore + subcategory: gitignore + x-stackQL-resource: gitignore + /gitignore/templates/{name}: + get: + summary: Get a gitignore template + description: |- + Get the content of a gitignore template. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + operationId: gitignore/get-template + tags: + - gitignore + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template + parameters: + - name: name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gitignore-template' + examples: + default: + $ref: '#/components/examples/gitignore-template' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: gitignore + subcategory: gitignore + x-stackQL-resource: gitignore +components: + schemas: + gitignore-template: + title: Gitignore Template + description: Gitignore Template + type: object + properties: + name: + type: string + example: C + source: + type: string + example: | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + required: + - name + - source + responses: + not_modified: + description: Not modified + examples: + gitignore-template: + value: + name: C + source: | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app +servers: + - url: https://api.github.com diff --git a/provider-dev/source/hosted_compute.yaml b/provider-dev/source/hosted_compute.yaml new file mode 100644 index 0000000..c1a1667 --- /dev/null +++ b/provider-dev/source/hosted_compute.yaml @@ -0,0 +1,446 @@ +openapi: 3.0.3 +info: + title: hosted_compute API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/settings/network-configurations: + get: + summary: List hosted compute network configurations for an organization + description: |- + Lists all hosted compute network configurations configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/list-network-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - network_configurations + properties: + total_count: + type: integer + network_configurations: + type: array + items: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configurations-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + post: + summary: Create a hosted compute network configuration for an organization + description: |- + Creates a hosted compute network configuration for an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/create-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: The hosted compute service to use for the network configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 1 + maxItems: 1 + description: A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. + items: + type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is enabled. + required: + - name + - network_settings_ids + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configuration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + /orgs/{org}/settings/network-configurations/{network_configuration_id}: + get: + summary: Get a hosted compute network configuration for an organization + description: |- + Gets a hosted compute network configuration configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-configuration-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configuration' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + patch: + summary: Update a hosted compute network configuration for an organization + description: |- + Updates a hosted compute network configuration for an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/update-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-configuration-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: The hosted compute service to use for the network configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. + items: + type: string + failover_network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. + items: + type: string + failover_network_enabled: + type: boolean + description: Indicates whether the failover network resource is enabled. + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-configuration' + examples: + default: + $ref: '#/components/examples/network-configuration' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + delete: + summary: Delete a hosted compute network configuration from an organization + description: |- + Deletes a hosted compute network configuration from an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/delete-network-configuration-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-configuration-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations + /orgs/{org}/settings/network-settings/{network_settings_id}: + get: + summary: Get a hosted compute network settings resource for an organization + description: |- + Gets a hosted compute network settings resource configured for an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-settings-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/network-settings-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/network-settings' + examples: + default: + $ref: '#/components/examples/network-settings' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + x-stackQL-resource: network_configurations +components: + schemas: + network-configuration: + title: Hosted compute network configuration + description: A hosted compute network configuration. + type: object + properties: + id: + description: The unique identifier of the network configuration. + type: string + example: 123ABC456DEF789 + name: + description: The name of the network configuration. + type: string + example: my-network-configuration + compute_service: + description: The hosted compute service the network configuration supports. + type: string + enum: + - none + - actions + - codespaces + network_settings_ids: + description: The unique identifier of each network settings in the configuration. + type: array + items: + type: string + example: 123ABC456DEF789 + failover_network_settings_ids: + description: The unique identifier of each failover network settings in the configuration. + type: array + items: + type: string + example: 123ABC456DEF789 + failover_network_enabled: + description: Indicates whether the failover network resource is enabled. + type: boolean + example: true + created_on: + description: The time at which the network configuration was created, in ISO 8601 format. + type: string + format: date-time + example: '2024-04-26T11:31:07Z' + nullable: true + required: + - id + - name + - created_on + network-settings: + title: Hosted compute network settings resource + description: A hosted compute network settings resource. + type: object + properties: + id: + description: The unique identifier of the network settings resource. + type: string + example: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: + description: The identifier of the network configuration that is using this settings resource. + type: string + example: 934E208B3EE0BD60CF5F752C426BFB53562 + name: + description: The name of the network settings resource. + type: string + example: my-network-settings + subnet_id: + description: The subnet this network settings resource is configured for. + type: string + example: /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + region: + description: The location of the subnet this network settings resource is configured for. + type: string + example: eastus + required: + - id + - name + - subnet_id + - region + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + network-configuration-id: + name: network_configuration_id + description: Unique identifier of the hosted compute network configuration. + in: path + required: true + schema: + type: string + network-settings-id: + name: network_settings_id + description: Unique identifier of the hosted compute network settings. + in: path + required: true + schema: + type: string + examples: + network-configurations-paginated: + value: + total_count: 2 + network_configurations: + - id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + - id: 456789ABDCEF123 + name: My other configuration + compute_service: none + network_settings_ids: + - 56789ABDCEF1234 + - 6789ABDCEF12345 + created_on: '2023-04-26T15:23:37Z' + network-configuration: + value: + id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + network-settings: + value: + id: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 + name: my_network_settings + subnet_id: /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + region: eastus + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/interactions.yaml b/provider-dev/source/interactions.yaml new file mode 100644 index 0000000..ebe8e98 --- /dev/null +++ b/provider-dev/source/interactions.yaml @@ -0,0 +1,458 @@ +openapi: 3.0.3 +info: + title: interactions API + description: Owner or admin management of users interactions. + version: 1.1.4 +paths: + /orgs/{org}/interaction-limits: + get: + summary: Get interaction restrictions for an organization + description: Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. + tags: + - interactions + operationId: interactions/get-restrictions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + additionalProperties: false + examples: + default: + $ref: '#/components/examples/interaction-limit-response' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs + x-stackQL-resource: orgs + put: + summary: Set interaction restrictions for an organization + description: Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. + tags: + - interactions + operationId: interactions/set-restrictions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit' + examples: + default: + value: + limit: collaborators_only + expiry: one_month + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit-response' + examples: + default: + $ref: '#/components/examples/interaction-limit-response' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs + x-stackQL-resource: orgs + delete: + summary: Remove interaction restrictions for an organization + description: Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. + tags: + - interactions + operationId: interactions/remove-restrictions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: orgs + x-stackQL-resource: orgs + /repos/{owner}/{repo}/interaction-limits: + get: + summary: Get interaction restrictions for a repository + description: Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. + tags: + - interactions + operationId: interactions/get-restrictions-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + additionalProperties: false + examples: + default: + $ref: '#/components/examples/interaction-limit-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: repos + x-stackQL-resource: repos + put: + summary: Set interaction restrictions for a repository + description: Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + tags: + - interactions + operationId: interactions/set-restrictions-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit' + examples: + default: + summary: Example request body + value: + limit: collaborators_only + expiry: one_day + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit-response' + examples: + default: + $ref: '#/components/examples/interaction-limit-2' + '409': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Remove interaction restrictions for a repository + description: Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + tags: + - interactions + operationId: interactions/remove-restrictions-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '409': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: interactions + subcategory: repos + x-stackQL-resource: repos + /user/interaction-limits: + get: + summary: Get interaction restrictions for your public repositories + description: Shows which type of GitHub user can interact with your public repositories and when the restriction expires. + tags: + - interactions + operationId: interactions/get-restrictions-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories + responses: + '200': + description: Default response + content: + application/json: + schema: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + additionalProperties: false + examples: + default: + $ref: '#/components/examples/interaction-limit-response' + '204': + description: Response when there are no restrictions + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: interactions + subcategory: user + x-stackQL-resource: user + put: + summary: Set interaction restrictions for your public repositories + description: Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. + tags: + - interactions + operationId: interactions/set-restrictions-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit' + examples: + default: + value: + limit: collaborators_only + expiry: one_month + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/interaction-limit-response' + examples: + default: + $ref: '#/components/examples/interaction-limit-user' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: interactions + subcategory: user + x-stackQL-resource: user + delete: + summary: Remove interaction restrictions from your public repositories + description: Removes any interaction restrictions from your public repositories. + tags: + - interactions + operationId: interactions/remove-restrictions-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: interactions + subcategory: user + x-stackQL-resource: user +components: + schemas: + interaction-limit-response: + title: Interaction Limits + description: Interaction limit settings. + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + origin: + type: string + example: repository + expires_at: + type: string + format: date-time + example: '2018-08-17T04:18:39Z' + required: + - limit + - origin + - expires_at + interaction-limit: + title: Interaction Restrictions + description: Limit interactions to a specific type of user for a specified duration + type: object + properties: + limit: + $ref: '#/components/schemas/interaction-group' + expiry: + $ref: '#/components/schemas/interaction-expiry' + required: + - limit + interaction-group: + type: string + description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. + example: collaborators_only + enum: + - existing_users + - contributors_only + - collaborators_only + interaction-expiry: + type: string + description: 'The duration of the interaction restriction. Default: `one_day`.' + example: one_month + enum: + - one_day + - three_days + - one_week + - one_month + - six_months + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + interaction-limit-response: + value: + limit: collaborators_only + origin: organization + expires_at: '2018-08-17T04:18:39Z' + interaction-limit-2: + value: + limit: collaborators_only + origin: repository + expires_at: '2018-08-17T04:18:39Z' + interaction-limit-user: + value: + limit: collaborators_only + origin: user + expires_at: '2018-08-17T04:18:39Z' +servers: + - url: https://api.github.com diff --git a/provider-dev/source/issues.yaml b/provider-dev/source/issues.yaml new file mode 100644 index 0000000..32c2bee --- /dev/null +++ b/provider-dev/source/issues.yaml @@ -0,0 +1,9416 @@ +openapi: 3.0.3 +info: + title: issues API + description: Interact with GitHub Issues. + version: 1.1.4 +paths: + /issues: + get: + summary: List issues assigned to the authenticated user + description: |- + List issues assigned to the authenticated user across all visible repositories including owned repositories, member + repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + necessarily assigned to you. + + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user + parameters: + - name: filter + description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. + in: query + required: false + schema: + type: string + enum: + - assigned + - created + - mentioned + - subscribed + - repos + - all + default: assigned + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - $ref: '#/components/parameters/labels' + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - name: collab + in: query + required: false + schema: + type: boolean + - name: orgs + in: query + required: false + schema: + type: boolean + - name: owned + in: query + required: false + schema: + type: boolean + - name: pulls + in: query + required: false + schema: + type: boolean + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-with-repo-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: issues + subcategory: issues + x-stackQL-resource: issues + /orgs/{org}/issues: + get: + summary: List organization issues assigned to the authenticated user + description: |- + List issues in an organization assigned to the authenticated user. + + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + - name: filter + description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. + in: query + required: false + schema: + type: string + enum: + - assigned + - created + - mentioned + - subscribed + - repos + - all + default: assigned + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - $ref: '#/components/parameters/labels' + - name: type + description: Can be the name of an issue type. + in: query + required: false + schema: + type: string + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-with-repo-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: issues + subcategory: issues + x-stackQL-resource: issues + /repos/{owner}/{repo}/assignees: + get: + summary: List assignees + description: Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + tags: + - issues + operationId: issues/list-assignees + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/assignees#list-assignees + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/assignees/{assignee}: + get: + summary: Check if a user can be assigned + description: |- + Checks if a user has permission to be assigned to an issue in this repository. + + If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + + Otherwise a `404` status code is returned. + tags: + - issues + operationId: issues/check-user-can-be-assigned + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: assignee + in: path + required: true + schema: + type: string + responses: + '204': + description: If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + '404': + description: Otherwise a `404` status code is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/issues: + get: + summary: List repository issues + description: |- + List issues in a repository. Only open issues will be listed. + + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#list-repository-issues + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: milestone + description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. + in: query + required: false + schema: + type: string + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - name: assignee + description: Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. + in: query + required: false + schema: + type: string + - name: type + description: Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. + in: query + required: false + schema: + type: string + - name: creator + description: The user that created the issue. + in: query + required: false + schema: + type: string + - name: mentioned + description: A user that's mentioned in the issue. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/labels' + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + post: + summary: Create an issue + description: |- + Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#create-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + description: The title of the issue. + type: string + body: + type: string + description: The contents of the issue. + assignee: + type: string + description: 'Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_' + nullable: true + milestone: + nullable: true + type: string + description: 'The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._' + labels: + type: array + description: 'Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._' + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + assignees: + type: array + description: 'Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._' + items: + type: string + type: + type: string + description: 'The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._' + nullable: true + example: Epic + required: + - title + examples: + default: + value: + title: Found a bug + body: I'm having a problem with this. + assignees: + - octocat + milestone: 1 + labels: + - bug + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + schema: + type: string + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + requestBody: + content: + application/json: + schema: + properties: + assignee: null + type: object + version: '2026-03-10' + x-stackQL-resource: issues + /repos/{owner}/{repo}/issues/comments: + get: + summary: List issue comments for a repository + description: |- + You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. + + By default, issue comments are ordered by ascending ID. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-comments-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/sort' + - name: direction + description: Either `asc` or `desc`. Ignored without the `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/comments/{comment_id}: + get: + summary: Get an issue comment + description: |- + You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#get-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update an issue comment + description: |- + You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#update-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment. + required: + - body + examples: + default: + value: + body: Me too + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete an issue comment + description: You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + tags: + - issues + operationId: issues/delete-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/comments/{comment_id}/pin: + put: + summary: Pin an issue comment + description: |- + You can use the REST API to pin comments on issues. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/pin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment-pinned' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Unpin an issue comment + description: You can use the REST API to unpin comments on issues. + tags: + - issues + operationId: issues/unpin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/events: + get: + summary: List issue events for a repository + description: Lists events for a repository. + tags: + - issues + operationId: issues/list-events-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-event' + examples: + default: + $ref: '#/components/examples/issue-event-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/issues/events/{event_id}: + get: + summary: Get an issue event + description: Gets a single event by the event id. + tags: + - issues + operationId: issues/get-event + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/events#get-an-issue-event + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: event_id + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-event' + examples: + default: + $ref: '#/components/examples/issue-event' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/issues/{issue_number}: + get: + summary: Get an issue + description: |- + The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe + to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. + + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#get-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + summary: Issue + value: + $ref: '#/components/examples/issue' + pinned_comment: + summary: Issue with pinned comment + value: + $ref: '#/components/examples/issue-with-pinned-comment' + '301': + $ref: '#/components/responses/moved_permanently' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + patch: + summary: Update an issue + description: |- + Issue owners and users with push access or Triage role can edit an issue. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#update-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + description: The title of the issue. + nullable: true + type: string + body: + type: string + description: The contents of the issue. + nullable: true + assignee: + type: string + nullable: true + description: Username to assign to this issue. **This field is closing down.** + state: + type: string + description: The open or closed state of the issue. + enum: + - open + - closed + state_reason: + type: string + enum: + - completed + - not_planned + - duplicate + - reopened + nullable: true + description: The reason for the state change. Ignored unless `state` is changed. + example: not_planned + milestone: + nullable: true + type: string + description: The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped. + labels: + type: array + description: Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + assignees: + type: array + description: Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. + items: + type: string + issue_field_values: + type: array + description: An array of issue field values to set on this issue. Each field value must include the field ID and the value to set. Only users with push access can set field values for issues + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + value: + oneOf: + - type: string + - type: number + description: The value to set for the field + required: + - field_id + - value + additionalProperties: false + type: + type: string + description: The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + nullable: true + example: Epic + examples: + default: + value: + title: Found a bug + body: I'm having a problem with this. + assignees: + - octocat + milestone: 1 + state: open + labels: + - bug + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '301': + $ref: '#/components/responses/moved_permanently' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + requestBody: + content: + application/json: + schema: + properties: + assignee: null + type: object + version: '2026-03-10' + x-stackQL-resource: issues + /repos/{owner}/{repo}/issues/{issue_number}/assignees: + post: + summary: Add assignees to an issue + description: Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. + tags: + - issues + operationId: issues/add-assignees + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + assignees: + type: array + description: 'Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._' + items: + type: string + examples: + default: + value: + assignees: + - hubot + - other_user + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + delete: + summary: Remove assignees from an issue + description: Removes one or more assignees from an issue. + tags: + - issues + operationId: issues/remove-assignees + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + content: + application/json: + schema: + type: object + properties: + assignees: + type: array + description: 'Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._' + items: + type: string + examples: + default: + value: + assignees: + - hubot + - other_user + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}: + get: + summary: Check if a user can be assigned to a issue + description: |- + Checks if a user has permission to be assigned to a specific issue. + + If the `assignee` can be assigned to this issue, a `204` status code with no content is returned. + + Otherwise a `404` status code is returned. + tags: + - issues + operationId: issues/check-user-can-be-assigned-to-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: assignee + in: path + required: true + schema: + type: string + responses: + '204': + description: Response if `assignee` can be assigned to `issue_number` + '404': + description: Response if `assignee` can not be assigned to `issue_number` + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: assignees + x-stackQL-resource: assignees + /repos/{owner}/{repo}/issues/{issue_number}/comments: + get: + summary: List issue comments + description: |- + You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + Issue comments are ordered by ascending ID. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#list-issue-comments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create an issue comment + description: |- + You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#create-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment. + required: + - body + examples: + default: + value: + body: Me too + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-comment' + examples: + default: + $ref: '#/components/examples/issue-comment' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by: + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + $ref: '#/components/responses/moved_permanently' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}: + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '301': + $ref: '#/components/responses/moved_permanently' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + /repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking: + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + x-stackQL-resource: issue_dependencies + /repos/{owner}/{repo}/issues/{issue_number}/events: + get: + summary: List issue events + description: Lists all events for an issue. + tags: + - issues + operationId: issues/list-events + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/events#list-issue-events + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-event-for-issue' + examples: + default: + $ref: '#/components/examples/issue-event-for-issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: events + x-stackQL-resource: events + /repos/{owner}/{repo}/issues/{issue_number}/issue-field-values: + get: + summary: List issue field values for an issue + description: Lists all issue field values for an issue. + tags: + - issues + operationId: issues/list-issue-field-values-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#list-issue-field-values-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + examples: + default: + $ref: '#/components/examples/issue-field-value-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + /repos/{owner}/{repo}/issues/{issue_number}/labels: + get: + summary: List labels for an issue + description: Lists all labels for an issue. + tags: + - issues + operationId: issues/list-labels-on-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + post: + summary: Add labels to an issue + description: Adds labels to an issue. + tags: + - issues + operationId: issues/add-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + labels: + type: array + minItems: 1 + description: The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." + items: + type: string + items: + type: string + properties: + name: + type: string + required: + - name + examples: + default: + value: + labels: + - bug + - enhancement + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + put: + summary: Set labels for an issue + description: Removes any previous labels and sets the new labels for an issue. + tags: + - issues + operationId: issues/set-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + labels: + type: array + minItems: 1 + description: The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." + items: + type: string + minItems: 1 + items: + type: string + properties: + name: + type: string + required: + - name + examples: + default: + value: + labels: + - bug + - enhancement + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + delete: + summary: Remove all labels from an issue + description: Removes all labels from an issue. + tags: + - issues + operationId: issues/remove-all-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '204': + description: Response + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}: + delete: + summary: Remove a label from an issue + description: Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. + tags: + - issues + operationId: issues/remove-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items-2' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/issues/{issue_number}/lock: + put: + summary: Lock an issue + description: |- + Users with push access can lock an issue or pull request's conversation. + + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - issues + operationId: issues/lock + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#lock-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + lock_reason: + type: string + description: |- + The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * `off-topic` + * `too heated` + * `resolved` + * `spam` + enum: + - off-topic + - too heated + - resolved + - spam + examples: + default: + summary: Example of locking an issue as off-topic + value: + lock_reason: off-topic + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + delete: + summary: Unlock an issue + description: Users with push access can unlock an issue's conversation. + tags: + - issues + operationId: issues/unlock + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#unlock-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issues + x-stackQL-resource: issues + /repos/{owner}/{repo}/issues/{issue_number}/parent: + get: + summary: Get parent issue + description: |- + You can use the REST API to get the parent issue of a sub-issue. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/get-parent + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/sub_issue: + delete: + summary: Remove sub-issue + description: |- + You can use the REST API to remove a sub-issue from an issue. + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to remove + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue + schema: + type: string + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/sub_issues: + get: + summary: List sub-issues + description: |- + You can use the REST API to list the sub-issues on an issue. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-sub-issues + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + post: + summary: Add sub-issue + description: |- + You can use the REST API to add sub-issues to issues. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue + replace_parent: + type: boolean + description: Option that, when true, instructs the operation to replace the sub-issues current parent issue + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority: + patch: + summary: Reprioritize sub-issue + description: You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + tags: + - issues + operationId: issues/reprioritize-sub-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + sub_issue_id: + type: integer + description: The id of the sub-issue to reprioritize + after_id: + type: integer + description: The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). + before_id: + type: integer + description: The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). + required: + - sub_issue_id + examples: + default: + value: + sub_issue_id: 6 + after_id: 5 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues + x-stackQL-resource: sub_issues + /repos/{owner}/{repo}/issues/{issue_number}/timeline: + get: + summary: List timeline events for an issue + description: List all timeline events for an issue. + tags: + - issues + operationId: issues/list-events-for-timeline + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/timeline-issue-events' + examples: + default: + $ref: '#/components/examples/timeline-issue-events' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: timeline + x-stackQL-resource: timeline + /repos/{owner}/{repo}/labels: + get: + summary: List labels for a repository + description: Lists all labels for a repository. + tags: + - issues + operationId: issues/list-labels-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + post: + summary: Create a label + description: Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). + tags: + - issues + operationId: issues/create-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#create-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." + color: + type: string + description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + description: + type: string + description: A short description of the label. Must be 100 characters or fewer. + required: + - name + examples: + default: + value: + name: bug + description: Something isn't working + color: f29513 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/labels/bug + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/labels/{name}: + get: + summary: Get a label + description: Gets a label using the given name. + tags: + - issues + operationId: issues/get-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#get-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: name + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + patch: + summary: Update a label + description: Updates a label using the given label name. + tags: + - issues + operationId: issues/update-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#update-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: name + in: path + required: true + schema: + type: string + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + new_name: + type: string + description: The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." + color: + type: string + description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. + description: + type: string + description: A short description of the label. Must be 100 characters or fewer. + examples: + default: + value: + new_name: 'bug :bug:' + description: Small bug fix required + color: b01f26 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + delete: + summary: Delete a label + description: Deletes a label using the given label name. + tags: + - issues + operationId: issues/delete-label + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#delete-a-label + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: name + in: path + required: true + schema: + type: string + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repos/{owner}/{repo}/milestones: + get: + summary: List milestones + description: Lists milestones for a repository. + tags: + - issues + operationId: issues/list-milestones + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#list-milestones + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: state + description: The state of the milestone. Either `open`, `closed`, or `all`. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - name: sort + description: What to sort results by. Either `due_on` or `completeness`. + in: query + required: false + schema: + type: string + enum: + - due_on + - completeness + default: due_on + - name: direction + description: The direction of the sort. Either `asc` or `desc`. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: asc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + post: + summary: Create a milestone + description: Creates a milestone. + tags: + - issues + operationId: issues/create-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#create-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the milestone. + state: + type: string + description: The state of the milestone. Either `open` or `closed`. + enum: + - open + - closed + default: open + description: + type: string + description: A description of the milestone. + due_on: + type: string + format: date-time + description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + required: + - title + examples: + default: + value: + title: v1.0 + state: open + description: Tracking milestone for version 1.0 + due_on: '2012-10-09T23:39:01Z' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + /repos/{owner}/{repo}/milestones/{milestone_number}: + get: + summary: Get a milestone + description: Gets a milestone using the given milestone number. + tags: + - issues + operationId: issues/get-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#get-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + patch: + summary: Update a milestone + description: '' + tags: + - issues + operationId: issues/update-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#update-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the milestone. + state: + type: string + description: The state of the milestone. Either `open` or `closed`. + enum: + - open + - closed + default: open + description: + type: string + description: A description of the milestone. + due_on: + type: string + format: date-time + description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + examples: + default: + value: + title: v1.0 + state: open + description: Tracking milestone for version 1.0 + due_on: '2012-10-09T23:39:01Z' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/milestone' + examples: + default: + $ref: '#/components/examples/milestone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + delete: + summary: Delete a milestone + description: Deletes a milestone using the given milestone number. + tags: + - issues + operationId: issues/delete-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/milestones#delete-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: milestones + x-stackQL-resource: milestones + /repos/{owner}/{repo}/milestones/{milestone_number}/labels: + get: + summary: List labels for issues in a milestone + description: Lists labels for issues in a milestone. + tags: + - issues + operationId: issues/list-labels-for-milestone + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/milestone-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/label' + examples: + default: + $ref: '#/components/examples/label-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: labels + x-stackQL-resource: labels + /repositories/{repository_id}/issues/{issue_number}/issue-field-values: + post: + summary: Add issue field values to an issue + description: |- + Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization. + Adding an empty array will clear all existing field values for the issue. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/add-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#add-issue-field-values-to-an-issue + parameters: + - $ref: '#/components/parameters/repository-id' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to add to this issue. Each field value must include the field ID and the value to set. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Add multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Add a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after adding the new values + items: + $ref: '#/components/schemas/issue-field-value' + examples: + default: + $ref: '#/components/examples/issue-field-value-items' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + put: + summary: Set issue field values for an issue + description: |- + Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization. + + This endpoint supports the following field data types: + - **`text`**: String values for text fields + - **`single_select`**: Option names for single-select fields (must match an existing option name) + - **`number`**: Numeric values for number fields + - **`date`**: ISO 8601 date strings for date fields + + This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead. + + Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/set-issue-field-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#set-issue-field-values-for-an-issue + parameters: + - $ref: '#/components/parameters/repository-id' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_values: + type: array + description: An array of issue field values to set for this issue. Each field value must include the field ID and the value to set. All existing field values will be replaced. + items: + type: object + properties: + field_id: + type: integer + description: The ID of the issue field to set + example: 123 + value: + oneOf: + - type: string + description: The value to set for text, single_select, or date fields + - type: number + description: The value to set for number fields + description: |- + The value to set for the field. The type depends on the field's data type: + - For text fields: provide a string value + - For single_select fields: provide the option name as a string (must match an existing option) + - For number fields: provide a numeric value + - For date fields: provide an ISO 8601 date string + example: Critical + required: + - field_id + - value + additionalProperties: false + maxItems: 25 + examples: + default: + summary: Set multiple field values + value: + issue_field_values: + - field_id: 123 + value: Critical + - field_id: 456 + value: 5 + - field_id: 789 + value: '2024-12-31' + single-field: + summary: Set a single field value + value: + issue_field_values: + - field_id: 123 + value: High Priority + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: The current issue field values for this issue after setting the new values + items: + $ref: '#/components/schemas/issue-field-value' + examples: + default: + $ref: '#/components/examples/issue-field-value-items' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + /repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}: + delete: + summary: Delete an issue field value from an issue + description: |- + Remove a specific custom field value from an issue. + + Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response. + + If the specified field does not have a value set on the issue, this operation will return a `404` error. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - issues + operationId: issues/delete-issue-field-value + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-field-values#delete-an-issue-field-value-from-an-issue + parameters: + - $ref: '#/components/parameters/repository-id' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/issue-field-id' + responses: + '204': + description: Issue field value deleted successfully + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-field-values + x-stackQL-resource: issue_field_values + /user/issues: + get: + summary: List user account issues assigned to the authenticated user + description: |- + List issues across owned and member repositories assigned to the authenticated user. + + > [!NOTE] + > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user + parameters: + - name: filter + description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. + in: query + required: false + schema: + type: string + enum: + - assigned + - created + - mentioned + - subscribed + - repos + - all + default: assigned + - name: state + description: Indicates the state of the issues to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - $ref: '#/components/parameters/labels' + - name: sort + description: What to sort results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - comments + default: created + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue' + examples: + default: + $ref: '#/components/examples/issue-with-repo-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: issues + subcategory: issues + x-stackQL-resource: issues +components: + schemas: + issue: + title: Issue + description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + issue-event: + title: Issue Event + description: Issue Event + type: object + properties: + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDEwOklzc3VlRXZlbnQx + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + $ref: '#/components/schemas/nullable-simple-user' + event: + type: string + example: closed + commit_id: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + nullable: true + commit_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + nullable: true + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue: + $ref: '#/components/schemas/nullable-issue' + label: + $ref: '#/components/schemas/issue-event-label' + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assigner: + $ref: '#/components/schemas/nullable-simple-user' + review_requester: + $ref: '#/components/schemas/nullable-simple-user' + requested_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + requested_team: + $ref: '#/components/schemas/team' + dismissed_review: + $ref: '#/components/schemas/issue-event-dismissed-review' + milestone: + $ref: '#/components/schemas/issue-event-milestone' + project_card: + $ref: '#/components/schemas/issue-event-project-card' + rename: + $ref: '#/components/schemas/issue-event-rename' + author_association: + $ref: '#/components/schemas/author-association' + lock_reason: + type: string + nullable: true + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + issue-event-for-issue: + title: Issue Event for Issue + description: Issue Event for Issue + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + assignee: + $ref: '#/components/schemas/simple-user' + assigner: + $ref: '#/components/schemas/simple-user' + milestone: + type: object + properties: + title: + type: string + required: + - title + rename: + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + nullable: true + type: string + dismissal_commit_id: + type: string + required: + - state + - review_id + - dismissal_message + lock_reason: + type: string + example: '"off-topic"' + nullable: true + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + - assigner + - milestone + - rename + - review_requester + - dismissed_review + - lock_reason + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: Details about the selected option (only present for single_select fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + label: + title: Label + description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + example: 208045946 + node_id: + type: string + example: MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + example: https://api.github.com/repositories/42/labels/bug + type: string + format: uri + name: + description: The name of the label. + example: bug + type: string + description: + description: Optional description of the label, such as its purpose. + type: string + example: Something isn't working + nullable: true + color: + description: '6-character hex code, without the leading #, identifying the color' + example: FFFFFF + type: string + default: + description: Whether this label comes by default in a new repository. + type: boolean + example: true + required: + - id + - node_id + - url + - name + - description + - color + - default + timeline-issue-events: + title: Timeline Event + description: Timeline Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + milestone: + type: object + properties: + title: + type: string + required: + - title + rename: + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + nullable: true + type: string + dismissal_commit_id: + type: string + required: + - state + - review_id + - dismissal_message + lock_reason: + type: string + example: '"off-topic"' + nullable: true + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/simple-user' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + source: + type: object + properties: + type: + type: string + issue: + $ref: '#/components/schemas/issue' + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + author: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + tree: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - sha + - url + - html_url + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - signature + - payload + - verified_at + state: + type: string + example: CHANGES_REQUESTED + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + comments: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + assignee: + $ref: '#/components/schemas/simple-user' + state_reason: + type: string + nullable: true + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - milestone + - rename + - review_requester + - dismissed_review + - lock_reason + - html_url + - issue_url + - author_association + - user + - updated_at + - source + - sha + - author + - committer + - tree + - message + - parents + - verification + - body + - state + - pull_request_url + - _links + - assignee + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + nullable-issue: + title: Issue + description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + issue-event-label: + title: Issue Event Label + description: Issue Event Label + type: object + properties: + name: + type: string + nullable: true + color: + type: string + nullable: true + required: + - name + - color + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + issue-event-dismissed-review: + title: Issue Event Dismissed Review + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + type: string + nullable: true + dismissal_commit_id: + type: string + nullable: true + required: + - state + - review_id + - dismissal_message + issue-event-milestone: + title: Issue Event Milestone + description: Issue Event Milestone + type: object + properties: + title: + type: string + required: + - title + issue-event-project-card: + title: Issue Event Project Card + description: Issue Event Project Card + type: object + properties: + url: + type: string + format: uri + id: + type: integer + project_url: + type: string + format: uri + project_id: + type: integer + column_name: + type: string + previous_column_name: + type: string + required: + - url + - id + - project_url + - project_id + - column_name + issue-event-rename: + title: Issue Event Rename + description: Issue Event Rename + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + labeled-issue-event: + title: Labeled Issue Event + description: Labeled Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + unlabeled-issue-event: + title: Unlabeled Issue Event + description: Unlabeled Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + label: + type: object + properties: + name: + type: string + color: + type: string + required: + - name + - color + required: + - label + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + assigned-issue-event: + title: Assigned Issue Event + description: Assigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/integration' + assignee: + $ref: '#/components/schemas/simple-user' + assigner: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + - assigner + unassigned-issue-event: + title: Unassigned Issue Event + description: Unassigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + assignee: + $ref: '#/components/schemas/simple-user' + assigner: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + - assigner + milestoned-issue-event: + title: Milestoned Issue Event + description: Milestoned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + milestone: + type: object + properties: + title: + type: string + required: + - title + required: + - milestone + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + demilestoned-issue-event: + title: Demilestoned Issue Event + description: Demilestoned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + milestone: + type: object + properties: + title: + type: string + required: + - title + required: + - milestone + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + renamed-issue-event: + title: Renamed Issue Event + description: Renamed Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + rename: + type: object + properties: + from: + type: string + to: + type: string + required: + - from + - to + required: + - rename + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + review-requested-issue-event: + title: Review Requested Issue Event + description: Review Requested Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + required: + - review_requester + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + review-request-removed-issue-event: + title: Review Request Removed Issue Event + description: Review Request Removed Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + review_requester: + $ref: '#/components/schemas/simple-user' + requested_team: + $ref: '#/components/schemas/team' + requested_reviewer: + $ref: '#/components/schemas/simple-user' + required: + - review_requester + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + review-dismissed-issue-event: + title: Review Dismissed Issue Event + description: Review Dismissed Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + nullable: true + type: string + dismissal_commit_id: + type: string + required: + - state + - review_id + - dismissal_message + required: + - dismissed_review + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + locked-issue-event: + title: Locked Issue Event + description: Locked Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + lock_reason: + type: string + example: '"off-topic"' + nullable: true + required: + - lock_reason + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + added-to-project-issue-event: + title: Added to Project Issue Event + description: Added to Project Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + moved-column-in-project-issue-event: + title: Moved Column in Project Issue Event + description: Moved Column in Project Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + removed-from-project-issue-event: + title: Removed from Project Issue Event + description: Removed from Project Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + converted-note-to-issue-issue-event: + title: Converted Note to Issue Issue Event + description: Converted Note to Issue Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/integration' + project_card: + type: object + properties: + id: + type: integer + url: + type: string + format: uri + project_id: + type: integer + project_url: + type: string + format: uri + column_name: + type: string + previous_column_name: + type: string + required: + - id + - url + - project_id + - project_url + - column_name + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + timeline-comment-event: + title: Timeline Comment Event + description: Timeline Comment Event + type: object + properties: + event: + type: string + actor: + $ref: '#/components/schemas/simple-user' + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - event + - actor + - id + - node_id + - html_url + - issue_url + - author_association + - user + - url + - created_at + - updated_at + timeline-cross-referenced-event: + title: Timeline Cross Referenced Event + description: Timeline Cross Referenced Event + type: object + properties: + event: + type: string + actor: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + source: + type: object + properties: + type: + type: string + issue: + $ref: '#/components/schemas/issue' + required: + - event + - created_at + - updated_at + - source + timeline-committed-event: + title: Timeline Committed Event + description: Timeline Committed Event + type: object + properties: + event: + type: string + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + node_id: + type: string + url: + type: string + format: uri + author: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + example: '2014-08-09T08:02:04+12:00' + format: date-time + type: string + email: + type: string + description: Git email address of the user + example: monalisa.octocat@example.com + name: + description: Name of the git user + example: Monalisa Octocat + type: string + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + example: 'Fix #42' + type: string + tree: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + example: 7638417db6d59f3c431d3e1f261cc637155684cd + type: string + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - sha + - url + - html_url + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - signature + - payload + - verified_at + html_url: + type: string + format: uri + required: + - sha + - node_id + - url + - html_url + - author + - committer + - tree + - message + - parents + - verification + timeline-reviewed-event: + title: Timeline Reviewed Event + description: Timeline Reviewed Event + type: object + properties: + event: + type: string + id: + description: Unique identifier of the review + example: 42 + type: integer + node_id: + type: string + example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + $ref: '#/components/schemas/simple-user' + body: + nullable: true + description: The text of the review. + example: This looks great. + type: string + state: + type: string + example: CHANGES_REQUESTED + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + updated_at: + type: string + nullable: true + format: date-time + commit_id: + description: A commit SHA for the review. + example: 54bb654c9e6025347f57900a4a5c2313a96b8035 + type: string + body_html: + type: string + body_text: + type: string + author_association: + $ref: '#/components/schemas/author-association' + required: + - event + - id + - node_id + - user + - body + - state + - commit_id + - html_url + - pull_request_url + - _links + - author_association + timeline-line-commented-event: + title: Timeline Line Commented Event + description: Timeline Line Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + comments: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + timeline-commit-commented-event: + title: Timeline Commit Commented Event + description: Timeline Commit Commented Event + type: object + properties: + event: + type: string + node_id: + type: string + commit_id: + type: string + comments: + type: array + items: + $ref: '#/components/schemas/commit-comment' + timeline-assigned-issue-event: + title: Timeline Assigned Issue Event + description: Timeline Assigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + assignee: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + timeline-unassigned-issue-event: + title: Timeline Unassigned Issue Event + description: Timeline Unassigned Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + assignee: + $ref: '#/components/schemas/simple-user' + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + - assignee + state-change-issue-event: + title: State Change Issue Event + description: State Change Issue Event + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + actor: + $ref: '#/components/schemas/simple-user' + event: + type: string + commit_id: + type: string + nullable: true + commit_url: + type: string + nullable: true + created_at: + type: string + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + state_reason: + type: string + nullable: true + required: + - id + - node_id + - url + - actor + - event + - commit_id + - commit_url + - created_at + - performed_via_github_app + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + pull-request-review-comment: + title: Pull Request Review Comment + description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. + type: object + properties: + url: + description: URL for the pull request review comment + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + type: string + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: integer + format: int64 + example: 42 + nullable: true + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + example: 1 + node_id: + description: The node ID of the pull request review comment. + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: + description: The relative path of the file to which the comment applies. + example: config/database.yaml + type: string + position: + description: The line index in the diff to which the comment applies. This field is closing down; use `line` instead. + example: 1 + type: integer + original_position: + description: The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. + example: 4 + type: integer + commit_id: + description: The SHA of the commit to which the comment applies. + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + type: string + in_reply_to_id: + description: The comment ID to reply to. + example: 8 + type: integer + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + description: The text of the comment. + example: We should probably include a check for null values here. + type: string + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + description: URL for the pull request that the review comment belongs to. + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + $ref: '#/components/schemas/author-association' + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + original_start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment + example: 2 + type: integer + original_line: + description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment + example: 2 + type: integer + side: + description: The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + subject_type: + description: The level at which the comment is targeted, can be a diff line or a file. + type: string + enum: + - line + - file + reactions: + $ref: '#/components/schemas/reaction-rollup' + body_html: + type: string + example: '"

comment body

"' + body_text: + type: string + example: '"comment body"' + required: + - url + - id + - node_id + - pull_request_review_id + - diff_hunk + - path + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + commit-comment: + title: Commit Comment + description: Commit Comment + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - url + - html_url + - id + - node_id + - user + - position + - line + - path + - commit_id + - body + - author_association + - created_at + - updated_at + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + gone: + description: Gone + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + parameters: + labels: + name: labels + description: 'A list of comma separated label names. Example: `bug,ui,@high`' + in: query + required: false + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + since: + name: since + description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + issue-number: + name: issue_number + description: The number that identifies the issue. + in: path + required: true + schema: + type: integer + milestone-number: + name: milestone_number + description: The number that identifies the milestone. + in: path + required: true + schema: + type: integer + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + issue-field-id: + name: issue_field_id + description: The unique identifier of the issue field. + in: path + required: true + schema: + type: integer + examples: + issue-with-repo-items: + value: + - id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + author_association: COLLABORATOR + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + issue-items: + value: + - id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + issue: + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + issue-comment-items: + value: + - id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + issue-comment: + value: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + pin: null + issue-comment-pinned: + value: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + issue-event-items: + value: + - id: 1 + node_id: MDEwOklzc3VlRXZlbnQx + url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + event: closed + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: '2011-04-14T16:00:49Z' + issue: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + author_association: COLLABORATOR + state_reason: completed + issue-event: + value: + id: 1 + node_id: MDEwOklzc3VlRXZlbnQx + url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + event: closed + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: '2011-04-14T16:00:49Z' + issue: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: null + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + performed_via_github_app: + id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + events: + - push + - pull_request + comments: 0 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + author_association: COLLABORATOR + state_reason: completed + issue-with-pinned-comment: + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pinned_comment: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 1 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: null + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + author_association: COLLABORATOR + state_reason: completed + issue-event-for-issue-items: + value: + - id: 1 + node_id: MDEwOklzc3VlRXZlbnQx + url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + event: closed + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: '2011-04-14T16:00:49Z' + performed_via_github_app: null + label: + name: label + color: red + issue-field-value-items: + value: + - issue_field_id: 1 + node_id: IFT_GDKND + data_type: text + value: DRI + - issue_field_id: 2 + node_id: IFSS_SADMS + data_type: single_select + value: 1 + single_select_option: + id: 1 + name: High + color: red + - issue_field_id: 3 + node_id: IFN_POINTS + data_type: number + value: 42 + - issue_field_id: 4 + node_id: IFD_DUEDATE + data_type: date + value: '2025-12-25' + label-items: + value: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + - id: 208045947 + node_id: MDU6TGFiZWwyMDgwNDU5NDc= + url: https://api.github.com/repos/octocat/Hello-World/labels/enhancement + name: enhancement + description: New feature or request + color: a2eeef + default: false + label-items-2: + value: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + timeline-issue-events: + value: + - id: 6430295168 + node_id: LOE_lADODwFebM5HwC0kzwAAAAF_RoSA + url: https://api.github.com/repos/github/roadmap/issues/events/6430295168 + actor: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + event: locked + commit_id: null + commit_url: null + created_at: '2022-04-13T20:49:13Z' + lock_reason: null + performed_via_github_app: null + - id: 6430296748 + node_id: LE_lADODwFebM5HwC0kzwAAAAF_Roqs + url: https://api.github.com/repos/github/roadmap/issues/events/6430296748 + actor: + login: github-product-roadmap + id: 67656570 + node_id: MDQ6VXNlcjY3NjU2NTcw + avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 + gravatar_id: '' + url: https://api.github.com/users/github-product-roadmap + html_url: https://github.com/github-product-roadmap + followers_url: https://api.github.com/users/github-product-roadmap/followers + following_url: https://api.github.com/users/github-product-roadmap/following{/other_user} + gists_url: https://api.github.com/users/github-product-roadmap/gists{/gist_id} + starred_url: https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions + organizations_url: https://api.github.com/users/github-product-roadmap/orgs + repos_url: https://api.github.com/users/github-product-roadmap/repos + events_url: https://api.github.com/users/github-product-roadmap/events{/privacy} + received_events_url: https://api.github.com/users/github-product-roadmap/received_events + type: User + site_admin: false + event: labeled + commit_id: null + commit_url: null + created_at: '2022-04-13T20:49:34Z' + label: + name: beta + color: 99dd88 + performed_via_github_app: null + - id: 6635165802 + node_id: RTE_lADODwFebM5HwC0kzwAAAAGLfJhq + url: https://api.github.com/repos/github/roadmap/issues/events/6635165802 + actor: + login: github-product-roadmap + id: 67656570 + node_id: MDQ6VXNlcjY3NjU2NTcw + avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 + gravatar_id: '' + url: https://api.github.com/users/github-product-roadmap + html_url: https://github.com/github-product-roadmap + followers_url: https://api.github.com/users/github-product-roadmap/followers + following_url: https://api.github.com/users/github-product-roadmap/following{/other_user} + gists_url: https://api.github.com/users/github-product-roadmap/gists{/gist_id} + starred_url: https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions + organizations_url: https://api.github.com/users/github-product-roadmap/orgs + repos_url: https://api.github.com/users/github-product-roadmap/repos + events_url: https://api.github.com/users/github-product-roadmap/events{/privacy} + received_events_url: https://api.github.com/users/github-product-roadmap/received_events + type: User + site_admin: false + event: renamed + commit_id: null + commit_url: null + created_at: '2022-05-18T19:29:01Z' + rename: + from: 'Secret scanning: dry-runs for enterprise-level custom patterns (cloud)' + to: 'Secret scanning: dry-runs for enterprise-level custom patterns' + performed_via_github_app: null + - url: https://api.github.com/repos/github/roadmap/issues/comments/1130876857 + html_url: https://github.com/github/roadmap/issues/493#issuecomment-1130876857 + issue_url: https://api.github.com/repos/github/roadmap/issues/493 + id: 1130876857 + node_id: IC_kwDODwFebM5DZ8-5 + user: + login: octocat + id: 94867353 + node_id: U_kgDOBaePmQ + avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + created_at: '2022-05-19T00:52:15Z' + updated_at: '2022-05-19T00:52:15Z' + author_association: COLLABORATOR + body: '🚒 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/' + reactions: + url: https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions + total_count: 0 + '+1': 0 + '-1': 0 + laugh: 0 + hooray: 0 + confused: 0 + heart: 0 + rocket: 0 + eyes: 0 + performed_via_github_app: null + event: commented + actor: + login: octocat + id: 94867353 + node_id: U_kgDOBaePmQ + avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + label: + value: + id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + label-2: + value: + id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: 'https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + description: Small bug fix required + color: b01f26 + default: true + milestone-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + milestone: + value: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/licenses.yaml b/provider-dev/source/licenses.yaml new file mode 100644 index 0000000..fb2ad54 --- /dev/null +++ b/provider-dev/source/licenses.yaml @@ -0,0 +1,554 @@ +openapi: 3.0.3 +info: + title: licenses API + description: View various OSS licenses. + version: 1.1.4 +paths: + /licenses: + get: + summary: Get all commonly used licenses + description: Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + tags: + - licenses + operationId: licenses/get-all-commonly-used + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses + parameters: + - name: featured + in: query + required: false + schema: + type: boolean + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/license-simple' + examples: + default: + $ref: '#/components/examples/license-simple-items' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: licenses + subcategory: licenses + x-stackQL-resource: licenses + /licenses/{license}: + get: + summary: Get a license + description: Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + tags: + - licenses + operationId: licenses/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/licenses/licenses#get-a-license + parameters: + - name: license + in: path + required: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/license' + examples: + default: + $ref: '#/components/examples/license' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: licenses + subcategory: licenses + x-stackQL-resource: licenses + /repos/{owner}/{repo}/license: + get: + summary: Get the license for a repository + description: |- + This method returns the contents of the repository's license file, if one is detected. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + tags: + - licenses + operationId: licenses/get-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/git-ref' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/license-content' + examples: + default: + $ref: '#/components/examples/license-content' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: licenses + subcategory: licenses + x-stackQL-resource: licenses +components: + schemas: + license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + license: + title: License + description: License + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + spdx_id: + type: string + example: MIT + nullable: true + url: + type: string + format: uri + example: https://api.github.com/licenses/mit + nullable: true + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + example: http://choosealicense.com/licenses/mit/ + description: + type: string + example: A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. + implementation: + type: string + example: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. + permissions: + type: array + example: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + items: + type: string + conditions: + type: array + example: + - include-copyright + items: + type: string + limitations: + type: array + example: + - no-liability + items: + type: string + body: + type: string + example: | + + + The MIT License (MIT) + + Copyright (c) [year] [fullname] + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + featured: + type: boolean + example: true + required: + - key + - name + - url + - spdx_id + - node_id + - html_url + - description + - implementation + - permissions + - conditions + - limitations + - body + - featured + license-content: + title: License Content + description: License Content + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + size: + type: integer + url: + type: string + format: uri + html_url: + type: string + format: uri + nullable: true + git_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + license: + $ref: '#/components/schemas/nullable-license-simple' + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + - license + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + code-scanning-ref: + type: string + description: |- + The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + `refs/heads/` or simply ``. + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + git-ref: + name: ref + description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. + in: query + required: false + schema: + $ref: '#/components/schemas/code-scanning-ref' + examples: + license-simple-items: + value: + - key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + - key: lgpl-3.0 + name: GNU Lesser General Public License v3.0 + spdx_id: LGPL-3.0 + url: https://api.github.com/licenses/lgpl-3.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: mpl-2.0 + name: Mozilla Public License 2.0 + spdx_id: MPL-2.0 + url: https://api.github.com/licenses/mpl-2.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: agpl-3.0 + name: GNU Affero General Public License v3.0 + spdx_id: AGPL-3.0 + url: https://api.github.com/licenses/agpl-3.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: unlicense + name: The Unlicense + spdx_id: Unlicense + url: https://api.github.com/licenses/unlicense + node_id: MDc6TGljZW5zZW1pdA== + - key: apache-2.0 + name: Apache License 2.0 + spdx_id: Apache-2.0 + url: https://api.github.com/licenses/apache-2.0 + node_id: MDc6TGljZW5zZW1pdA== + - key: gpl-3.0 + name: GNU General Public License v3.0 + spdx_id: GPL-3.0 + url: https://api.github.com/licenses/gpl-3.0 + node_id: MDc6TGljZW5zZW1pdA== + license: + value: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + html_url: http://choosealicense.com/licenses/mit/ + description: A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. + implementation: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. + permissions: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + conditions: + - include-copyright + limitations: + - no-liability + body: | + + + The MIT License (MIT) + + Copyright (c) [year] [fullname] + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + featured: true + license-content: + value: + name: LICENSE + path: LICENSE + sha: 401c59dcc4570b954dd6d345e76199e1f4e76266 + size: 1077 + url: https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master + html_url: https://github.com/benbalter/gman/blob/master/LICENSE + git_url: https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 + download_url: https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true + type: file + content: | + VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu + IEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv + ZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0 + aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls + ZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg + d2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh + dGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg + cHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg + Y29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z + IHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK + c3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv + dmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj + ZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50 + aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ + UyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL + SU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ + TUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG + SVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO + R0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ + UklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF + UyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G + IENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP + VVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU + SEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K + encoding: base64 + _links: + self: https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master + git: https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 + html: https://github.com/benbalter/gman/blob/master/LICENSE + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== +servers: + - url: https://api.github.com diff --git a/provider-dev/source/markdown.yaml b/provider-dev/source/markdown.yaml new file mode 100644 index 0000000..b1e8ae5 --- /dev/null +++ b/provider-dev/source/markdown.yaml @@ -0,0 +1,139 @@ +openapi: 3.0.3 +info: + title: markdown API + description: Render GitHub flavored Markdown + version: 1.1.4 +paths: + /markdown: + post: + summary: Render a Markdown document + description: Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + operationId: markdown/render + tags: + - markdown + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/markdown/markdown#render-a-markdown-document + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + text: + description: The Markdown text to render in HTML. + type: string + mode: + description: The rendering mode. + enum: + - markdown + - gfm + default: markdown + example: markdown + type: string + context: + description: The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. + type: string + required: + - text + type: object + examples: + default: + summary: Rendering markdown + value: + text: Hello **world** + responses: + '200': + description: Response + headers: + Content-Type: + $ref: '#/components/headers/content-type' + Content-Length: + example: '279' + schema: + type: string + X-CommonMarker-Version: + $ref: '#/components/headers/x-common-marker-version' + content: + text/html: + schema: + type: string + examples: + default: + summary: Example response + value:

Hello world

+ '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: markdown + subcategory: markdown + x-stackQL-resource: markdown + /markdown/raw: + post: + summary: Render a Markdown document in raw mode + description: You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. + operationId: markdown/render-raw + tags: + - markdown + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode + parameters: [] + requestBody: + required: false + content: + text/plain: + schema: + type: string + examples: + default: + value: + text: Hello **world** + text/x-markdown: + schema: + type: string + examples: + default: + summary: Rendering markdown + value: + text: Hello **world** + responses: + '200': + description: Response + headers: + X-CommonMarker-Version: + $ref: '#/components/headers/x-common-marker-version' + content: + text/html: + schema: + type: string + examples: + default: + summary: Example response + value:

Hello world

+ '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: markdown + subcategory: markdown + x-stackQL-resource: markdown +components: + responses: + not_modified: + description: Not modified + headers: + content-type: + example: text/html + schema: + type: string + x-common-marker-version: + example: 0.17.4 + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/meta.yaml b/provider-dev/source/meta.yaml new file mode 100644 index 0000000..7de404b --- /dev/null +++ b/provider-dev/source/meta.yaml @@ -0,0 +1,620 @@ +openapi: 3.0.3 +info: + title: meta API + description: Endpoints that give information about the API. + version: 1.1.4 +paths: + /: + get: + summary: GitHub API Root + description: Get Hypermedia links to resources accessible in GitHub's REST API + tags: + - meta + operationId: meta/root + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/root' + examples: + default: + $ref: '#/components/examples/root' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#github-api-root + x-stackQL-resource: meta + /meta: + get: + summary: Get GitHub meta information + description: |- + Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." + + The API's response also includes a list of GitHub's domain names. + + The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. + + > [!NOTE] + > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + tags: + - meta + operationId: meta/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-apiname-meta-information + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-overview' + examples: + default: + $ref: '#/components/examples/api-overview' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta + /octocat: + get: + summary: Get Octocat + description: Get the octocat as ASCII art + tags: + - meta + operationId: meta/get-octocat + parameters: + - name: s + in: query + description: The words to show in Octocat's speech bubble + schema: + type: string + required: false + responses: + '200': + description: Response + content: + application/octocat-stream: + schema: + type: string + examples: + default: + $ref: '#/components/examples/octocat' + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-octocat + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta + /versions: + get: + summary: Get all API versions + description: Get all supported GitHub API versions. + tags: + - meta + operationId: meta/get-all-versions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-all-api-versions + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + format: date + example: '2021-01-01' + examples: + default: + value: + - '2021-01-01' + - '2021-06-01' + - '2022-01-01' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta + /zen: + get: + summary: Get the Zen of GitHub + description: Get a random sentence from the Zen of GitHub + tags: + - meta + operationId: meta/get-zen + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/meta/meta#get-the-zen-of-github + responses: + '200': + description: Response + content: + text/plain: + schema: + type: string + examples: + default: + summary: Example response + value: Responsive is better than fast + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta + x-stackQL-resource: meta +components: + schemas: + root: + type: object + properties: + current_user_url: + type: string + format: uri-template + current_user_authorizations_html_url: + type: string + format: uri-template + authorizations_url: + type: string + format: uri-template + code_search_url: + type: string + format: uri-template + commit_search_url: + type: string + format: uri-template + emails_url: + type: string + format: uri-template + emojis_url: + type: string + format: uri-template + events_url: + type: string + format: uri-template + feeds_url: + type: string + format: uri-template + followers_url: + type: string + format: uri-template + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + hub_url: + type: string + format: uri-template + deprecated: true + issue_search_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + label_search_url: + type: string + format: uri-template + notifications_url: + type: string + format: uri-template + organization_url: + type: string + format: uri-template + organization_repositories_url: + type: string + format: uri-template + organization_teams_url: + type: string + format: uri-template + public_gists_url: + type: string + format: uri-template + rate_limit_url: + type: string + format: uri-template + repository_url: + type: string + format: uri-template + repository_search_url: + type: string + format: uri-template + current_user_repositories_url: + type: string + format: uri-template + starred_url: + type: string + format: uri-template + starred_gists_url: + type: string + format: uri-template + topic_search_url: + type: string + format: uri-template + user_url: + type: string + format: uri-template + user_organizations_url: + type: string + format: uri-template + user_repositories_url: + type: string + format: uri-template + user_search_url: + type: string + format: uri-template + required: + - current_user_url + - current_user_authorizations_html_url + - authorizations_url + - code_search_url + - commit_search_url + - emails_url + - emojis_url + - events_url + - feeds_url + - followers_url + - following_url + - gists_url + - issue_search_url + - issues_url + - keys_url + - label_search_url + - notifications_url + - organization_url + - organization_repositories_url + - organization_teams_url + - public_gists_url + - rate_limit_url + - repository_url + - repository_search_url + - current_user_repositories_url + - starred_url + - starred_gists_url + - user_url + - user_organizations_url + - user_repositories_url + - user_search_url + x-github-breaking-changes: + - changeset: remove_authorizations_url_from_api_root + patch: + - op: remove + path: /properties/authorizations_url + - op: remove + path: /required/2 + version: '2026-03-10' + - changeset: remove_hub_url_from_api_root + patch: + properties: + hub_url: null + type: object + version: '2026-03-10' + api-overview: + title: Api Overview + description: Api Overview + type: object + properties: + verifiable_password_authentication: + type: boolean + example: true + ssh_key_fingerprints: + type: object + properties: + SHA256_RSA: + type: string + SHA256_DSA: + type: string + SHA256_ECDSA: + type: string + SHA256_ED25519: + type: string + ssh_keys: + type: array + items: + type: string + example: + - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ + hooks: + type: array + items: + type: string + example: + - 192.0.2.1 + github_enterprise_importer: + type: array + items: + type: string + example: + - 192.0.2.1 + web: + type: array + items: + type: string + example: + - 192.0.2.1 + api: + type: array + items: + type: string + example: + - 192.0.2.1 + git: + type: array + items: + type: string + example: + - 192.0.2.1 + packages: + type: array + items: + type: string + example: + - 192.0.2.1 + pages: + type: array + items: + type: string + example: + - 192.0.2.1 + importer: + type: array + items: + type: string + example: + - 192.0.2.1 + actions: + type: array + items: + type: string + example: + - 192.0.2.1 + actions_macos: + type: array + items: + type: string + example: + - 192.0.2.1 + codespaces: + type: array + items: + type: string + example: + - 192.0.2.1 + dependabot: + type: array + items: + type: string + example: + - 192.0.2.1 + copilot: + type: array + items: + type: string + example: + - 192.0.2.1 + domains: + type: object + properties: + website: + type: array + items: + type: string + example: + - example.com + codespaces: + type: array + items: + type: string + example: + - example.com + copilot: + type: array + items: + type: string + example: + - example.com + packages: + type: array + items: + type: string + example: + - example.com + actions: + type: array + items: + type: string + example: + - example.com + actions_inbound: + type: object + properties: + full_domains: + type: array + items: + type: string + example: + - example.com + wildcard_domains: + type: array + items: + type: string + example: + - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + example: + - example + services: + type: array + items: + type: string + example: + - example.com + required: + - verifiable_password_authentication + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + root: + value: + current_user_url: https://api.github.com/user + current_user_authorizations_html_url: https://github.com/settings/connections/applications{/client_id} + authorizations_url: https://api.github.com/authorizations + code_search_url: https://api.github.com/search/code?q={query}{&page,per_page,sort,order} + commit_search_url: https://api.github.com/search/commits?q={query}{&page,per_page,sort,order} + emails_url: https://api.github.com/user/emails + emojis_url: https://api.github.com/emojis + events_url: https://api.github.com/events + feeds_url: https://api.github.com/feeds + followers_url: https://api.github.com/user/followers + following_url: https://api.github.com/user/following{/target} + gists_url: https://api.github.com/gists{/gist_id} + hub_url: https://api.github.com/hub + issue_search_url: https://api.github.com/search/issues?q={query}{&page,per_page,sort,order} + issues_url: https://api.github.com/issues + keys_url: https://api.github.com/user/keys + label_search_url: https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page} + notifications_url: https://api.github.com/notifications + organization_url: https://api.github.com/orgs/{org} + organization_repositories_url: https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort} + organization_teams_url: https://api.github.com/orgs/{org}/teams + public_gists_url: https://api.github.com/gists/public + rate_limit_url: https://api.github.com/rate_limit + repository_url: https://api.github.com/repos/{owner}/{repo} + repository_search_url: https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order} + current_user_repositories_url: https://api.github.com/user/repos{?type,page,per_page,sort} + starred_url: https://api.github.com/user/starred{/owner}{/repo} + starred_gists_url: https://api.github.com/gists/starred + topic_search_url: https://api.github.com/search/topics?q={query}{&page,per_page} + user_url: https://api.github.com/users/{user} + user_organizations_url: https://api.github.com/user/orgs + user_repositories_url: https://api.github.com/users/{user}/repos{?type,page,per_page,sort} + user_search_url: https://api.github.com/search/users?q={query}{&page,per_page,sort,order} + x-github-breaking-changes: + - changeset: remove_authorizations_url_from_api_root + patch: + - op: remove + path: /value/authorizations_url + version: '2026-03-10' + - changeset: remove_hub_url_from_api_root + patch: + value: + hub_url: null + version: '2026-03-10' + api-overview: + value: + verifiable_password_authentication: true + ssh_key_fingerprints: + SHA256_RSA: 1234567890 + SHA256_DSA: 1234567890 + SHA256_ECDSA: 1234567890 + SHA256_ED25519: 1234567890 + ssh_keys: + - ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ + - ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ + - ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ + hooks: + - 192.0.2.1 + github_enterprise_importer: + - 192.0.2.1 + web: + - 192.0.2.1 + api: + - 192.0.2.1 + git: + - 192.0.2.1 + packages: + - 192.0.2.1 + pages: + - 192.0.2.1 + importer: + - 192.0.2.1 + actions: + - 192.0.2.1 + actions_macos: + - 192.0.2.1 + dependabot: + - 192.0.2.1 + copilot: + - 192.0.2.1 + domains: + website: + - '*.example.com' + codespaces: + - '*.example.com' + copilot: + - '*.example.com' + packages: + - '*.example.com' + octocat: + value: |2 + MMM. .MMM + MMMMMMMMMMMMMMMMMMM + MMMMMMMMMMMMMMMMMMM ___________________________________ + MMMMMMMMMMMMMMMMMMMMM | | + MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. | + MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________| + MMMM::- -:::::::- -::MMMM |/ + MM~:~ 00~:::::~ 00~:~MM + .. MMMMM::.00:::+:::.00::MMMMM .. + .MM::::: ._. :::::MM. + MMMM;:::::;MMMM + -MM MMMMMMM + ^ M+ MMMMMMMMM + MMMMMMM MM MM MM + MM MM MM MM + MM MM MM MM + .~~MM~MM~MM~MM~~. + ~~~~MM:~MM~~~MM~:MM~~~~ + ~~~~~~==~==~~~==~==~~~~~~ + ~~~~~~==~==~==~==~~~~~~ + :~==~==~==~==~~ +servers: + - url: https://api.github.com diff --git a/provider-dev/source/migrations.yaml b/provider-dev/source/migrations.yaml new file mode 100644 index 0000000..0620bb9 --- /dev/null +++ b/provider-dev/source/migrations.yaml @@ -0,0 +1,4283 @@ +openapi: 3.0.3 +info: + title: migrations API + description: Move projects to or from GitHub. + version: 1.1.4 +paths: + /orgs/{org}/migrations: + get: + summary: List organization migrations + description: |- + Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). + + A list of `repositories` is only returned for export migrations. + tags: + - migrations + operationId: migrations/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-with-short-org-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + post: + summary: Start an organization migration + description: Initiates the generation of a migration archive. + tags: + - migrations + operationId: migrations/start-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repositories: + type: array + description: A list of arrays indicating which repositories should be migrated. + items: + type: string + lock_repositories: + type: boolean + example: true + description: Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + default: false + exclude_metadata: + type: boolean + description: Indicates whether metadata should be excluded and only git source should be included for the migration. + default: false + exclude_git_data: + type: boolean + description: Indicates whether the repository git data should be excluded from the migration. + default: false + exclude_attachments: + type: boolean + example: true + description: Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + default: false + exclude_releases: + type: boolean + example: true + description: Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + default: false + exclude_owner_projects: + type: boolean + example: true + description: Indicates whether projects owned by the organization or users should be excluded. from the migration. + default: false + org_metadata_only: + type: boolean + example: true + description: Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + default: false + exclude: + type: array + description: Exclude related items from being returned in the response in order to improve performance of the request. + items: + type: string + enum: + - repositories + required: + - repositories + examples: + default: + value: + repositories: + - github/Hello-World + lock_repositories: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-with-short-org-2' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}: + get: + summary: Get an organization migration status + description: |- + Fetches the status of a migration. + + The `state` of a migration can be one of the following values: + + * `pending`, which means the migration hasn't started yet. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `failed`, which means the migration failed. + tags: + - migrations + operationId: migrations/get-status-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string + responses: + '200': + description: |- + * `pending`, which means the migration hasn't started yet. + * `exporting`, which means the migration is in progress. + * `exported`, which means the migration finished successfully. + * `failed`, which means the migration failed. + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-with-short-org' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}/archive: + get: + summary: Download an organization migration archive + description: Fetches the URL to a migration archive. + tags: + - migrations + operationId: migrations/download-archive-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + responses: + '302': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + delete: + summary: Delete an organization migration archive + description: Deletes a previous migration archive. Migration archives are automatically deleted after seven days. + tags: + - migrations + operationId: migrations/delete-archive-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock: + delete: + summary: Unlock an organization repository + description: Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + tags: + - migrations + operationId: migrations/unlock-repo-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/repo-name' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/migrations/{migration_id}/repositories: + get: + summary: List repositories in an organization migration + description: List all the repositories for this organization migration. + tags: + - migrations + operationId: migrations/list-repos-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: orgs + x-github-breaking-changes: + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/simple-repository' + version: '2026-03-10' + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + examples: null + version: '2026-03-10' + x-stackQL-resource: orgs + /repos/{owner}/{repo}/import: + get: + summary: Get an import status + description: |- + View the progress of an import. + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + + **Import status** + + This section includes details about the possible values of the `status` field of the Import Progress response. + + An import that does not have errors will progress through these steps: + + * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * `complete` - the import is complete, and the repository is ready on GitHub. + + If there are problems, you will see one of these in the `status` field: + + * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. + * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. + * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. + * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL. + * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. + + **The project_choices field** + + When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + + **Git LFS related fields** + + This section includes details about Git LFS related fields that may be present in the Import Progress response. + + * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + tags: + - migrations + operationId: migrations/get-import-status + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + default: + $ref: '#/components/examples/import' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + put: + summary: Start an import + description: |- + Start a source import to a GitHub repository using GitHub Importer. + Importing into a GitHub repository with GitHub Actions enabled is not supported and will + return a status `422 Unprocessable Entity` response. + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/start-import + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#start-an-import + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + vcs_url: + type: string + description: The URL of the originating repository. + vcs: + type: string + description: The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. + enum: + - subversion + - git + - mercurial + - tfvc + vcs_username: + type: string + description: If authentication is required, the username to provide to `vcs_url`. + vcs_password: + type: string + description: If authentication is required, the password to provide to `vcs_url`. + tfvc_project: + type: string + description: For a tfvc import, the name of the project that is being imported. + required: + - vcs_url + examples: + default: + value: + vcs: subversion + vcs_url: http://svn.mycompany.com/svn/myproject + vcs_username: octocat + vcs_password: secret + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + default: + $ref: '#/components/examples/import-2' + headers: + Location: + example: https://api.github.com/repos/spraints/socm/import + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + patch: + summary: Update an import + description: |- + An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API + request. If no parameters are provided, the import will be restarted. + + Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will + have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. + You can select the project to import by providing one of the objects in the `project_choices` array in the update request. + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/update-import + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#update-an-import + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + vcs_username: + type: string + description: The username to provide to the originating repository. + vcs_password: + type: string + description: The password to provide to the originating repository. + vcs: + type: string + description: The type of version control system you are migrating from. + enum: + - subversion + - tfvc + - git + - mercurial + example: '"git"' + tfvc_project: + type: string + description: For a tfvc import, the name of the project that is being imported. + example: '"project1"' + nullable: true + examples: + example-1: + summary: Update authentication for an import + value: + vcs_username: octocat + vcs_password: secret + example-2: + summary: Updating the project choice + value: + vcs: tfvc + tfvc_project: project1 + human_name: project1 (tfs) + example-3: + summary: Restarting an import + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + example-1: + $ref: '#/components/examples/import-example-1' + example-2: + $ref: '#/components/examples/import-example-2' + example-3: + $ref: '#/components/examples/import-response' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + delete: + summary: Cancel an import + description: |- + Stop an import for a repository. + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/cancel-import + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/authors: + get: + summary: Get commit authors + description: |- + Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. + + This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/get-commit-authors + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/since-user' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/porter-author' + examples: + default: + $ref: '#/components/examples/porter-author-items' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/authors/{author_id}: + patch: + summary: Map a commit author + description: |- + Update an author's identity for the import. Your application can continue updating authors any time before you push + new commits to the repository. + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/map-commit-author + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: author_id + in: path + required: true + schema: + type: integer + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + email: + type: string + description: The new Git author email. + name: + type: string + description: The new Git author name. + additionalProperties: false + examples: + default: + value: + email: hubot@github.com + name: Hubot the Robot + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/porter-author' + examples: + default: + $ref: '#/components/examples/porter-author' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/large_files: + get: + summary: Get large files + description: |- + List files larger than 100MB found during the import + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/get-large-files + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#get-large-files + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/porter-large-file' + examples: + default: + $ref: '#/components/examples/porter-large-file-items' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /repos/{owner}/{repo}/import/lfs: + patch: + summary: Update Git LFS preference + description: |- + You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability + is powered by [Git LFS](https://git-lfs.com). + + You can learn more about our LFS feature and working with large files [on our help + site](https://docs.github.com/repositories/working-with-files/managing-large-files). + + > [!WARNING] + > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + tags: + - migrations + operationId: migrations/set-lfs-preference + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + use_lfs: + type: string + description: Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import. + enum: + - opt_in + - opt_out + required: + - use_lfs + examples: + default: + value: + use_lfs: opt_in + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/import' + examples: + default: + $ref: '#/components/examples/import' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/porter_maintenance' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: migrations + subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true + x-stackQL-resource: source_imports + /user/migrations: + get: + summary: List user migrations + description: Lists all migrations a user has started. + tags: + - migrations + operationId: migrations/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#list-user-migrations + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + post: + summary: Start a user migration + description: Initiates the generation of a user migration archive. + tags: + - migrations + operationId: migrations/start-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#start-a-user-migration + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + lock_repositories: + description: Lock the repositories being migrated at the start of the migration + example: true + readOnly: false + type: boolean + exclude_metadata: + description: Indicates whether metadata should be excluded and only git source should be included for the migration. + example: true + readOnly: false + type: boolean + exclude_git_data: + description: Indicates whether the repository git data should be excluded from the migration. + example: true + readOnly: false + type: boolean + exclude_attachments: + description: Do not include attachments in the migration + example: true + readOnly: false + type: boolean + exclude_releases: + description: Do not include releases in the migration + example: true + readOnly: false + type: boolean + exclude_owner_projects: + description: Indicates whether projects owned by the organization or users should be excluded. + example: true + readOnly: false + type: boolean + org_metadata_only: + type: boolean + example: true + description: Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + default: false + exclude: + description: Exclude attributes from the API response to improve performance + example: + - repositories + readOnly: false + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string + repositories: + type: array + items: + description: Repository path, owner and name + example: acme/widgets + type: string + required: + - repositories + type: object + examples: + default: + value: + repositories: + - octocat/Hello-World + lock_repositories: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration-2' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}: + get: + summary: Get a user migration status + description: |- + Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: + + * `pending` - the migration hasn't started yet. + * `exporting` - the migration is in progress. + * `exported` - the migration finished successfully. + * `failed` - the migration failed. + + Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). + tags: + - migrations + operationId: migrations/get-status-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status + parameters: + - $ref: '#/components/parameters/migration-id' + - name: exclude + in: query + required: false + schema: + type: array + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/migration' + examples: + default: + $ref: '#/components/examples/migration' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}/archive: + get: + summary: Download a user migration archive + description: |- + Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: + + * attachments + * bases + * commit\_comments + * issue\_comments + * issue\_events + * issues + * milestones + * organizations + * projects + * protected\_branches + * pull\_request\_reviews + * pull\_requests + * releases + * repositories + * review\_comments + * schema + * users + + The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + tags: + - migrations + operationId: migrations/get-archive-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive + parameters: + - $ref: '#/components/parameters/migration-id' + responses: + '302': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + delete: + summary: Delete a user migration archive + description: Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + tags: + - migrations + operationId: migrations/delete-archive-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive + parameters: + - $ref: '#/components/parameters/migration-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}/repos/{repo_name}/lock: + delete: + summary: Unlock a user repository + description: Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. + tags: + - migrations + operationId: migrations/unlock-repo-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository + parameters: + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/repo-name' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-stackQL-resource: users + /user/migrations/{migration_id}/repositories: + get: + summary: List repositories for a user migration + description: Lists all the repositories for this user migration. + tags: + - migrations + operationId: migrations/list-repos-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration + parameters: + - $ref: '#/components/parameters/migration-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: migrations + subcategory: users + x-github-breaking-changes: + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + schema: + items: + $ref: '#/components/schemas/simple-repository' + version: '2026-03-10' + - changeset: restrict_repo_fields_in_migration_resource + patch: + responses: + '200': + content: + application/json: + examples: null + version: '2026-03-10' + x-stackQL-resource: users +components: + schemas: + migration: + title: Migration + description: A migration. + type: object + properties: + id: + type: integer + format: int64 + example: 79 + owner: + $ref: '#/components/schemas/nullable-simple-user' + guid: + type: string + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: + type: string + example: pending + lock_repositories: + type: boolean + example: true + exclude_metadata: + type: boolean + exclude_git_data: + type: boolean + exclude_attachments: + type: boolean + exclude_releases: + type: boolean + exclude_owner_projects: + type: boolean + org_metadata_only: + type: boolean + repositories: + type: array + description: The repositories included in the migration. Only returned for export migrations. + items: + $ref: '#/components/schemas/repository' + url: + type: string + format: uri + example: https://api.github.com/orgs/octo-org/migrations/79 + created_at: + type: string + format: date-time + example: '2015-07-06T15:33:38-07:00' + updated_at: + type: string + format: date-time + example: '2015-07-06T15:33:38-07:00' + node_id: + type: string + archive_url: + type: string + format: uri + exclude: + description: 'Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.' + type: array + items: + description: 'Allowed values that can be passed to the exclude parameter. The array can include any of: `"repositories"`.' + type: string + required: + - id + - node_id + - owner + - guid + - state + - lock_repositories + - exclude_metadata + - exclude_git_data + - exclude_attachments + - exclude_releases + - exclude_owner_projects + - org_metadata_only + - repositories + - url + - created_at + - updated_at + x-github-breaking-changes: + - changeset: restrict_repo_fields_in_migration_resource + patch: + - op: replace + path: /properties/repositories + value: + type: array + description: The repositories included in the migration. Only returned for export migrations. + items: + $ref: '#/components/schemas/simple-repository' + version: '2026-03-10' + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + import: + title: Import + description: A repository import from an external source. + type: object + properties: + vcs: + type: string + nullable: true + use_lfs: + type: boolean + vcs_url: + description: The URL of the originating repository. + type: string + svc_root: + type: string + tfvc_project: + type: string + status: + type: string + enum: + - auth + - error + - none + - detecting + - choose + - auth_failed + - importing + - mapping + - waiting_to_push + - pushing + - complete + - setup + - unknown + - detection_found_multiple + - detection_found_nothing + - detection_needs_auth + status_text: + type: string + nullable: true + failed_step: + type: string + nullable: true + error_message: + type: string + nullable: true + import_percent: + type: integer + nullable: true + commit_count: + type: integer + nullable: true + push_percent: + type: integer + nullable: true + has_large_files: + type: boolean + large_files_size: + type: integer + large_files_count: + type: integer + project_choices: + type: array + items: + type: object + properties: + vcs: + type: string + tfvc_project: + type: string + human_name: + type: string + message: + type: string + authors_count: + type: integer + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + authors_url: + type: string + format: uri + repository_url: + type: string + format: uri + svn_root: + type: string + required: + - vcs + - vcs_url + - status + - url + - repository_url + - html_url + - authors_url + porter-author: + title: Porter Author + description: Porter Author + type: object + properties: + id: + type: integer + remote_id: + type: string + remote_name: + type: string + email: + type: string + name: + type: string + url: + type: string + format: uri + import_url: + type: string + format: uri + required: + - id + - remote_id + - remote_name + - email + - name + - url + - import_url + porter-large-file: + title: Porter Large File + description: Porter Large File + type: object + properties: + ref_name: + type: string + path: + type: string + oid: + type: string + size: + type: integer + required: + - oid + - path + - ref_name + - size + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + porter_maintenance: + description: Unavailable due to service under maintenance. + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + migration-id: + name: migration_id + description: The unique identifier of the migration. + in: path + required: true + schema: + type: integer + repo-name: + name: repo_name + description: repo_name parameter + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + since-user: + name: since + description: A user ID. Only return users with an ID greater than this ID. + in: query + required: false + schema: + type: integer + examples: + migration-with-short-org-items: + value: + - id: 79 + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + node_id: MDQ6VXNlcjE= + migration-with-short-org-2: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + migration-with-short-org: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: exported + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + import: + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: complete + status_text: Done + has_large_files: true + large_files_size: 132331036 + large_files_count: 1 + authors_count: 4 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-2: + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: importing + status_text: Importing... + has_large_files: false + large_files_size: 0 + large_files_count: 0 + authors_count: 0 + commit_count: 1042 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-example-1: + summary: Example 1 + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: detecting + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-example-2: + summary: Example 2 + value: + vcs: tfvc + use_lfs: true + vcs_url: http://tfs.mycompany.com/tfs/myproject + tfvc_project: project1 + status: importing + status_text: Importing... + has_large_files: false + large_files_size: 0 + large_files_count: 0 + authors_count: 0 + commit_count: 1042 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + import-response: + summary: Response + value: + vcs: subversion + use_lfs: true + vcs_url: http://svn.mycompany.com/svn/myproject + status: importing + status_text: Importing... + has_large_files: false + large_files_size: 0 + large_files_count: 0 + authors_count: 0 + commit_count: 1042 + url: https://api.github.com/repos/octocat/socm/import + html_url: https://import.github.com/octocat/socm/import + authors_url: https://api.github.com/repos/octocat/socm/import/authors + repository_url: https://api.github.com/repos/octocat/socm + porter-author-items: + value: + - id: 2268557 + remote_id: nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: nobody + email: hubot@github.com + name: Hubot + url: https://api.github.com/repos/octocat/socm/import/authors/2268557 + import_url: https://api.github.com/repos/octocat/socm/import + - id: 2268558 + remote_id: svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: svner + email: svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef + name: svner + url: https://api.github.com/repos/octocat/socm/import/authors/2268558 + import_url: https://api.github.com/repos/octocat/socm/import + - id: 2268559 + remote_id: svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: svner@example.com + email: svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef + name: svner@example.com + url: https://api.github.com/repos/octocat/socm/import/authors/2268559 + import_url: https://api.github.com/repos/octocat/socm/import + porter-author: + value: + id: 2268557 + remote_id: nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef + remote_name: nobody + email: hubot@github.com + name: Hubot + url: https://api.github.com/repos/octocat/socm/import/authors/2268557 + import_url: https://api.github.com/repos/octocat/socm/import + porter-large-file-items: + value: + - ref_name: refs/heads/master + path: foo/bar/1 + oid: d3d9446802a44259755d38e6d163e820 + size: 10485760 + - ref_name: refs/heads/master + path: foo/bar/2 + oid: 6512bd43d9caa6e02c990b0a82652dca + size: 11534336 + - ref_name: refs/heads/master + path: foo/bar/3 + oid: c20ad4d76fe97759aa27a0c99bff6710 + size: 12582912 + migration-items: + value: + - id: 79 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + node_id: MDQ6VXNlcjE= + migration-2: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: pending + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + migration: + value: + id: 79 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: exported + lock_repositories: true + exclude_attachments: false + exclude_releases: false + exclude_owner_projects: false + org_metadata_only: false + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + url: https://api.github.com/orgs/octo-org/migrations/79 + created_at: '2015-07-06T15:33:38-07:00' + updated_at: '2015-07-06T15:33:38-07:00' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/oidc.yaml b/provider-dev/source/oidc.yaml new file mode 100644 index 0000000..59bd340 --- /dev/null +++ b/provider-dev/source/oidc.yaml @@ -0,0 +1,426 @@ +openapi: 3.0.3 +info: + title: oidc API + description: Endpoints to manage GitHub OIDC configuration using the REST API. + version: 1.1.4 +paths: + /enterprises/{enterprise}/actions/oidc/customization/properties/repo: + get: + summary: List OIDC custom property inclusions for an enterprise + description: |- + Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - oidc + operationId: oidc/list-oidc-custom-property-inclusions-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + responses: + '200': + description: A JSON array of OIDC custom property inclusions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + value: + - custom_property_name: environment + inclusion_source: enterprise + - custom_property_name: team + inclusion_source: enterprise + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: oidc + x-stackQL-resource: oidc + post: + summary: Create an OIDC custom property inclusion for an enterprise + description: |- + Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - oidc + operationId: oidc/create-oidc-custom-property-inclusion-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion-input' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + responses: + '201': + description: OIDC custom property inclusion created + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '422': + description: Property inclusion already exists + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /enterprises/{enterprise}/actions/oidc/customization/properties/repo/{custom_property_name}: + delete: + summary: Delete an OIDC custom property inclusion for an enterprise + description: |- + Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - oidc + operationId: oidc/delete-oidc-custom-property-inclusion-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-enterprise + parameters: + - $ref: '#/components/parameters/enterprise' + - name: custom_property_name + in: path + required: true + schema: + type: string + description: The name of the custom property to remove from OIDC token inclusion + responses: + '204': + description: OIDC custom property inclusion deleted + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Property inclusion not found + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /orgs/{org}/actions/oidc/customization/properties/repo: + get: + summary: List OIDC custom property inclusions for an organization + description: |- + Lists the repository custom properties that are included in the OIDC token for repository actions in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/list-oidc-custom-property-inclusions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#list-oidc-custom-property-inclusions-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: A JSON array of OIDC custom property inclusions + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + value: + - property_name: environment + - property_name: team + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + post: + summary: Create an OIDC custom property inclusion for an organization + description: |- + Adds a repository custom property to be included in the OIDC token for repository actions in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/create-oidc-custom-property-inclusion-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#create-an-oidc-custom-property-inclusion-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion-input' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + responses: + '201': + description: OIDC custom property inclusion created + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-property-inclusion' + examples: + default: + $ref: '#/components/examples/oidc-custom-property-inclusion' + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '422': + description: Property inclusion already exists + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /orgs/{org}/actions/oidc/customization/properties/repo/{custom_property_name}: + delete: + summary: Delete an OIDC custom property inclusion for an organization + description: |- + Removes a repository custom property from being included in the OIDC token for repository actions in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/delete-oidc-custom-property-inclusion-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#delete-an-oidc-custom-property-inclusion-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: custom_property_name + in: path + required: true + schema: + type: string + description: The name of the custom property to remove from OIDC token inclusion + responses: + '204': + description: OIDC custom property inclusion deleted + '400': + description: Invalid input + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Property inclusion not found + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + /orgs/{org}/actions/oidc/customization/sub: + get: + summary: Get the customization template for an OIDC subject claim for an organization + description: |- + Gets the customization template for an OpenID Connect (OIDC) subject claim. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/get-oidc-custom-sub-template-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: A JSON serialized template for OIDC subject claim customization + content: + application/json: + schema: + $ref: '#/components/schemas/oidc-custom-sub' + examples: + default: + $ref: '#/components/examples/oidc-custom-sub' + x-github: + enabledForGitHubApps: true + category: actions + subcategory: oidc + x-stackQL-resource: oidc + put: + summary: Set the customization template for an OIDC subject claim for an organization + description: |- + Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - oidc + operationId: oidc/update-oidc-custom-sub-template-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. + type: array + items: + type: string + examples: + default: + $ref: '#/components/examples/oidc-custom-sub' + responses: + '201': + description: Empty response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + enabledForGitHubApps: true + previews: [] + category: actions + subcategory: oidc + x-stackQL-resource: oidc +components: + schemas: + oidc-custom-property-inclusion: + title: Actions OIDC Custom Property Inclusion + description: An OIDC custom property inclusion for repository properties + type: object + properties: + custom_property_name: + type: string + description: The name of the custom property that is included in the OIDC token + inclusion_source: + type: string + description: Whether the inclusion was defined at the organization or enterprise level + enum: + - organization + - enterprise + example: organization + required: + - custom_property_name + - inclusion_source + oidc-custom-property-inclusion-input: + title: Actions OIDC Custom Property Inclusion Input + description: Input for creating an OIDC custom property inclusion + type: object + properties: + custom_property_name: + type: string + description: The name of the custom property to include in the OIDC token + required: + - custom_property_name + oidc-custom-sub: + title: Actions OIDC Subject customization + description: Actions OIDC Subject customization + type: object + properties: + include_claim_keys: + description: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. + type: array + items: + type: string + required: + - include_claim_keys + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + enterprise: + name: enterprise + description: The slug version of the enterprise name. + in: path + required: true + schema: + type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + oidc-custom-property-inclusion: + value: + custom_property_name: environment + oidc-custom-sub: + value: + include_claim_keys: + - repo + - context +servers: + - url: https://api.github.com diff --git a/provider-dev/source/orgs.yaml b/provider-dev/source/orgs.yaml new file mode 100644 index 0000000..172c6f1 --- /dev/null +++ b/provider-dev/source/orgs.yaml @@ -0,0 +1,10636 @@ +openapi: 3.0.3 +info: + title: orgs API + description: Interact with organizations. + version: 1.1.4 +paths: + /organizations: + get: + summary: List organizations + description: |- + Lists all organizations, in the order that they were created. + + > [!NOTE] + > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + tags: + - orgs + operationId: orgs/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-organizations + parameters: + - $ref: '#/components/parameters/since-org' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}: + get: + summary: Get an organization + description: |- + Gets information about an organization. + + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + + To see the full details about an organization, the authenticated user must be an organization owner. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + + To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. + tags: + - orgs + operationId: orgs/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#get-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-full' + examples: + default-response: + $ref: '#/components/examples/organization-full' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + patch: + summary: Update an organization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + + > [!WARNING] + > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + + Updates the organization's profile and member privileges. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + tags: + - orgs + operationId: orgs/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#update-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + billing_email: + type: string + description: Billing email address. This address is not publicized. + company: + type: string + description: The company name. + email: + type: string + description: The publicly visible email address. + twitter_username: + type: string + description: The Twitter username of the company. + location: + type: string + description: The location. + name: + type: string + description: The shorthand name of the company. + description: + type: string + description: The description of the company. The maximum size is 160 characters. + has_organization_projects: + type: boolean + description: Whether an organization can use organization projects. + has_repository_projects: + type: boolean + description: Whether repositories that belong to the organization can use repository projects. + default_repository_permission: + type: string + description: Default permission level members have for organization repositories. + enum: + - read + - write + - admin + - none + default: read + members_can_create_repositories: + type: boolean + description: Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. + default: true + members_can_create_internal_repositories: + type: boolean + description: Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + members_can_create_private_repositories: + type: boolean + description: Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + members_can_create_public_repositories: + type: boolean + description: Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. + members_allowed_repository_creation_type: + type: string + description: |- + Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. + **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + enum: + - all + - private + - none + members_can_create_pages: + type: boolean + description: Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. + default: true + members_can_create_public_pages: + type: boolean + description: Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. + default: true + members_can_create_private_pages: + type: boolean + description: Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. + default: true + members_can_fork_private_repositories: + type: boolean + description: Whether organization members can fork private organization repositories. + default: false + web_commit_signoff_required: + type: boolean + description: Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface. + default: false + blog: + type: string + example: '"http://github.blog"' + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + dependabot_security_updates_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + dependency_graph_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. + deprecated: true + secret_scanning_push_protection_custom_link_enabled: + type: boolean + description: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. + secret_scanning_push_protection_custom_link: + type: string + description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + deploy_keys_enabled_for_repositories: + type: boolean + description: Controls whether or not deploy keys may be added and used for repositories in the organization. + examples: + default: + value: + billing_email: mona@github.com + company: GitHub + email: mona@github.com + twitter_username: github + location: San Francisco + name: github + description: GitHub, the company. + default_repository_permission: read + members_can_create_repositories: true + members_allowed_repository_creation_type: all + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-full' + examples: + default: + $ref: '#/components/examples/organization-full' + '409': + $ref: '#/components/responses/conflict' + '422': + description: Validation failed + content: + application/json: + schema: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-github-breaking-changes: + - changeset: remove_secret_scanning_custom_link_enablement_field + patch: + requestBody: + content: + application/json: + schema: + properties: + secret_scanning_push_protection_custom_link_enabled: null + type: object + version: '2026-03-10' + x-stackQL-resource: orgs + delete: + summary: Delete an organization + description: |- + Deletes an organization and all its repositories. + + The organization login will be unavailable for 90 days after deletion. + + Please review the Terms of Service regarding account deletion before using this endpoint: + + https://docs.github.com/site-policy/github-terms/github-terms-of-service + operationId: orgs/delete + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#delete-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-github-breaking-changes: + - changeset: change_delete_organization_trade_compliance_respose_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: orgs + /orgs/{org}/artifacts/metadata/deployment-record: + post: + summary: Create an artifact deployment record + description: |- + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. + tags: + - orgs + operationId: orgs/create-artifact-deployment-record + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + minLength: 1 + maxLength: 256 + example: libfoo + digest: + type: string + description: The hex encoded digest of the artifact. + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + status: + type: string + description: The status of the artifact. Can be either deployed or decommissioned. + enum: + - deployed + - decommissioned + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + cluster: + type: string + description: The deployment cluster. + maxLength: 128 + deployment_name: + type: string + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + maxLength: 256 + tags: + type: object + description: The tags associated with the deployment. + additionalProperties: + type: string + maxProperties: 5 + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: ^[A-Za-z0-9.\-_]+$ + example: my-github-repo + return_records: + type: boolean + default: true + description: | + If true, the endpoint will return the created or updated record in the response body. + required: + - name + - digest + - status + - logical_environment + - deployment_name + examples: + default: + value: + name: awesome-image + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + status: deployed + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: deployment-pod + tags: + data-access: sensitive + responses: + '200': + description: Artifact deployment record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + $ref: '#/components/schemas/artifact-deployment-record' + required: + - total_count + examples: + default: + $ref: '#/components/examples/artifact-deployment-record-list' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}: + post: + summary: Set cluster deployment records + description: |- + Set deployment records for a given cluster. + If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + If no existing records match, new records will be created. + tags: + - orgs + operationId: orgs/set-cluster-deployment-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records + parameters: + - $ref: '#/components/parameters/org' + - name: cluster + in: path + description: The cluster name. + required: true + schema: + type: string + minLength: 1 + maxLength: 128 + pattern: ^[a-zA-Z0-9._-]+$ + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + deployments: + type: array + description: The list of deployments to record. + maxItems: 1000 + items: + type: object + properties: + name: + type: string + description: | + The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + the name parameter must also be identical across all entries. + minLength: 1 + maxLength: 256 + digest: + type: string + description: | + The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + the name and version parameters must also be identical across all entries. + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + version: + type: string + description: | + The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + the version parameter must also be identical across all entries. + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + status: + type: string + description: The deployment status of the artifact. + default: deployed + enum: + - deployed + - decommissioned + deployment_name: + type: string + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a record set, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. + minLength: 1 + maxLength: 256 + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + maxLength: 100 + pattern: ^[A-Za-z0-9.\-_]+$ + example: my-github-repo + tags: + type: object + description: Key-value pairs to tag the deployment record. + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + required: + - name + - deployment_name + - digest + return_records: + type: boolean + default: true + description: | + If true, the endpoint will return the set records in the response body + required: + - logical_environment + - deployments + examples: + default: + value: + logical_environment: prod + physical_environment: pacific-east + deployments: + - name: awesome-image + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + version: 2.1.0 + status: deployed + deployment_name: deployment-pod + tags: + runtime-risk: sensitive-data + responses: + '200': + description: | + Deployment records created or updated successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + $ref: '#/components/schemas/artifact-deployment-record' + required: + - total_count + examples: + default: + $ref: '#/components/examples/artifact-deployment-record-list' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + insufficient_repo_permissions: + value: + message: + cause: artifact metadata write permission required on one or more repositories + repositories: + - 123 + - 345 + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/metadata/storage-record: + post: + summary: Create artifact metadata storage record + description: |- + Create metadata storage records for artifacts associated with an organization. + This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + associated with a repository owned by the organization. + tags: + - orgs + operationId: orgs/create-artifact-storage-record + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + example: libfoo + minLength: 1 + maxLength: 256 + digest: + type: string + description: The digest of the artifact (algorithm:hex-encoded-digest). + example: sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + artifact_url: + type: string + format: uri + pattern: ^https:// + description: The URL where the artifact is stored. + example: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + path: + type: string + format: uri + description: The path of the artifact. + example: com/github/bar/libfoo-1.2.3 + registry_url: + type: string + format: uri + pattern: ^https:// + description: The base URL of the artifact registry. + example: https://reg.example.com/artifactory/ + minLength: 1 + repository: + type: string + description: The repository name within the registry. + example: bar + status: + type: string + description: The status of the artifact (e.g., active, inactive). + example: active + enum: + - active + - eol + - deleted + default: active + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: ^[A-Za-z0-9.\-_]+$ + example: my-github-repo + return_records: + type: boolean + default: true + description: | + If true, the endpoint will return the created record in the response body. + required: + - name + - digest + - registry_url + examples: + default: + value: + name: libfoo + version: 1.2.3 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + responses: + '200': + description: Artifact metadata storage record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + example: 1 + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + nullable: true + registry_url: + type: string + repository: + type: string + nullable: true + status: + type: string + created_at: + type: string + updated_at: + type: string + required: + - total_count + examples: + default: + value: + total_count: 1 + storage_records: + - name: libfoo + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records: + get: + summary: List artifact deployment records + description: List deployment records for an artifact metadata associated with an organization. + tags: + - orgs + operationId: orgs/list-artifact-deployment-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/subject-digest' + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records for this digest and organization + example: 3 + type: integer + deployment_records: + type: array + items: + $ref: '#/components/schemas/artifact-deployment-record' + examples: + default: + $ref: '#/components/examples/artifact-deployment-record-list' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/artifacts/{subject_digest}/metadata/storage-records: + get: + summary: List artifact storage records + description: |- + List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + + The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + tags: + - orgs + operationId: orgs/list-artifact-storage-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records + parameters: + - $ref: '#/components/parameters/org' + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + example: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + schema: + type: string + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of storage records for this digest and organization + example: 3 + type: integer + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + registry_url: + type: string + repository: + type: string + status: + type: string + created_at: + type: string + updated_at: + type: string + examples: + default: + value: + storage_records: + - name: libfoo-1.2.3 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + x-stackQL-resource: artifact_metadata + /orgs/{org}/attestations/bulk-list: + post: + summary: List attestations by bulk subject digests + description: |- + List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + required: + - subject_digests + examples: + default: + $ref: '#/components/examples/bulk-subject-digest-body' + withPredicateType: + $ref: '#/components/examples/bulk-subject-digest-body-with-predicate-type' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + nullable: true + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + $ref: '#/components/examples/list-attestations-bulk' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations_subject_digests: + additionalProperties: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /orgs/{org}/attestations/delete-request: + post: + summary: Delete attestations in bulk + description: Delete artifact attestations in bulk by either subject digests or unique ID. + tags: + - orgs + operationId: orgs/delete-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The request body must include either `subject_digests` or `attestation_ids`, but not both. + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests associated with the artifact attestations to delete. + minItems: 1 + maxItems: 1024 + attestation_ids: + type: array + items: + type: integer + description: List of unique IDs associated with the artifact attestations to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - attestation_ids + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/digest/{subject_digest}: + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - orgs + operationId: orgs/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest + parameters: + - $ref: '#/components/parameters/org' + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/repositories: + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/org' + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + $ref: '#/components/examples/list-attestation-repositories' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/{attestation_id}: + delete: + summary: Delete attestations by ID + description: Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + tags: + - orgs + operationId: orgs/delete-attestations-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id + parameters: + - $ref: '#/components/parameters/org' + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-stackQL-resource: attestations + /orgs/{org}/attestations/{subject_digest}: + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestations + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/org' + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + nullable: true + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + bundle_url: + type: string + initiator: + type: string + examples: + default: + $ref: '#/components/examples/list-attestations' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /orgs/{org}/blocks: + get: + summary: List users blocked by an organization + description: List the users blocked by an organization. + tags: + - orgs + operationId: orgs/list-blocked-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + /orgs/{org}/blocks/{username}: + get: + summary: Check if a user is blocked by an organization + description: Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. + tags: + - orgs + operationId: orgs/check-blocked-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: If the user is blocked + '404': + description: If the user is not blocked + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + put: + summary: Block a user from an organization + description: Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. + tags: + - orgs + operationId: orgs/block-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + delete: + summary: Unblock a user from an organization + description: Unblocks the given user on behalf of the specified organization. + tags: + - orgs + operationId: orgs/unblock-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: blocking + x-stackQL-resource: blocking + /orgs/{org}/failed_invitations: + get: + summary: List failed organization invitations + description: The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. + tags: + - orgs + operationId: orgs/list-failed-invitations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/hooks: + get: + summary: List organization webhooks + description: |- + List webhooks for an organization. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/list-webhooks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + post: + summary: Create an organization webhook + description: |- + Create a hook that posts payloads in JSON format. + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/create-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: Must be passed as "web". + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + username: + type: string + example: '"kdaigle"' + password: + type: string + example: '"password"' + required: + - url + events: + type: array + description: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + default: + - push + items: + type: string + active: + type: boolean + description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + default: true + required: + - name + - config + examples: + default: + value: + name: web + active: true + events: + - push + - pull_request + config: + url: http://example.com/webhook + content_type: json + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook' + headers: + Location: + example: https://api.github.com/orgs/octocat/hooks/1 + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}: + get: + summary: Get an organization webhook + description: |- + Returns a webhook configured in an organization. To get only the webhook + `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/get-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update an organization webhook + description: |- + Updates a webhook configured in an organization. When you update a webhook, + the `secret` will be overwritten. If you previously had a `secret` set, you must + provide the same `secret` or set a new `secret` or the secret will be removed. If + you are only updating individual webhook `config` properties, use "[Update a webhook + configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/update-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + required: + - url + events: + type: array + description: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + default: + - push + items: + type: string + active: + type: boolean + description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + default: true + name: + type: string + example: '"web"' + examples: + default: + value: + active: true + events: + - pull_request + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-hook' + examples: + default: + $ref: '#/components/examples/org-hook-2' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + delete: + summary: Delete an organization webhook + description: |- + Delete a webhook for an organization. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/delete-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/config: + get: + summary: Get a webhook configuration for an organization + description: |- + Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/get-webhook-config-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a webhook configuration for an organization + description: |- + Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/update-webhook-config-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + examples: + default: + summary: Update an existing webhook + value: + url: http://example.com/webhook + content_type: json + insecure_ssl: '0' + secret: '********' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/deliveries: + get: + summary: List deliveries for an organization webhook + description: |- + Returns a list of webhook deliveries for a webhook configured in an organization. + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/list-webhook-deliveries + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/cursor' + - $ref: '#/components/parameters/webhook-delivery-status' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook-delivery-item' + examples: + default: + $ref: '#/components/examples/hook-delivery-items' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}: + get: + summary: Get a webhook delivery for an organization webhook + description: |- + Returns a delivery for a webhook configured in an organization. + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/get-webhook-delivery + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook-delivery' + examples: + default: + $ref: '#/components/examples/hook-delivery' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts: + post: + summary: Redeliver a delivery for an organization webhook + description: |- + Redeliver a delivery for a webhook configured in an organization. + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/redeliver-webhook-delivery + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/hooks/{hook_id}/pings: + post: + summary: Ping an organization webhook + description: |- + This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + to be sent to the hook. + + You must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + tags: + - orgs + operationId: orgs/ping-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: webhooks + x-stackQL-resource: webhooks + /orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}: + get: + summary: Get route stats by actor + description: Get API request count statistics for an actor broken down by route within a specified time frame. + tags: + - orgs + operationId: api-insights/get-route-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-actor-type' + - $ref: '#/components/parameters/api-insights-actor-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/api-insights-route-stats-sort' + - $ref: '#/components/parameters/api-insights-api-route-substring' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-route-stats' + examples: + default: + $ref: '#/components/examples/api-insights-route-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/subject-stats: + get: + summary: Get subject stats + description: Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + tags: + - orgs + operationId: api-insights/get-subject-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/api-insights-sort' + - $ref: '#/components/parameters/api-insights-subject-name-substring' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-subject-stats' + examples: + default: + $ref: '#/components/examples/api-insights-subject-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/summary-stats: + get: + summary: Get summary stats + description: Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + tags: + - orgs + operationId: api-insights/get-summary-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-summary-stats' + examples: + default: + $ref: '#/components/examples/api-insights-summary-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/summary-stats/users/{user_id}: + get: + summary: Get summary stats by user + description: Get overall statistics of API requests within the organization for a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-user-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-summary-stats' + examples: + default: + $ref: '#/components/examples/api-insights-summary-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}: + get: + summary: Get summary stats by actor + description: Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + tags: + - orgs + operationId: api-insights/get-summary-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-actor-type' + - $ref: '#/components/parameters/api-insights-actor-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-summary-stats' + examples: + default: + $ref: '#/components/examples/api-insights-summary-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/time-stats: + get: + summary: Get time stats + description: Get the number of API requests and rate-limited requests made within an organization over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-timestamp-increment' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-time-stats' + examples: + default: + $ref: '#/components/examples/api-insights-time-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/time-stats/users/{user_id}: + get: + summary: Get time stats by user + description: Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-user-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-timestamp-increment' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-time-stats' + examples: + default: + $ref: '#/components/examples/api-insights-time-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}: + get: + summary: Get time stats by actor + description: Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + tags: + - orgs + operationId: api-insights/get-time-stats-by-actor + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-actor-type' + - $ref: '#/components/parameters/api-insights-actor-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/api-insights-timestamp-increment' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-time-stats' + examples: + default: + $ref: '#/components/examples/api-insights-time-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/insights/api/user-stats/{user_id}: + get: + summary: Get user stats + description: Get API usage statistics within an organization for a user broken down by the type of access. + tags: + - orgs + operationId: api-insights/get-user-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/api-insights#get-user-stats + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/api-insights-user-id' + - $ref: '#/components/parameters/api-insights-min-timestamp' + - $ref: '#/components/parameters/api-insights-max-timestamp' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/api-insights-sort' + - $ref: '#/components/parameters/api-insights-actor-name-substring' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/api-insights-user-stats' + examples: + default: + $ref: '#/components/examples/api-insights-user-stats' + x-github: + enabledForGitHubApps: true + category: orgs + subcategory: api-insights + x-stackQL-resource: api_insights + /orgs/{org}/installations: + get: + summary: List app installations for an organization + description: |- + Lists all GitHub Apps in an organization. The installation count includes + all GitHub Apps installed on repositories in the organization. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-app-installations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - installations + properties: + total_count: + type: integer + installations: + type: array + items: + $ref: '#/components/schemas/installation' + examples: + default: + $ref: '#/components/examples/installation-paginated' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/invitations: + get: + summary: List pending organization invitations + description: |- + The return hash contains a `role` field which refers to the Organization + Invitation role and will be one of the following values: `direct_member`, `admin`, + `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub + member, the `login` field in the return hash will be `null`. + tags: + - orgs + operationId: orgs/list-pending-invitations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: role + description: Filter invitations by their member role. + in: query + required: false + schema: + type: string + enum: + - all + - admin + - direct_member + - billing_manager + - hiring_manager + default: all + - name: invitation_source + description: Filter invitations by their invitation source. + in: query + required: false + schema: + type: string + enum: + - all + - member + - scim + default: all + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + post: + summary: Create an organization invitation + description: |- + Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - orgs + operationId: orgs/create-invitation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + invitee_id: + type: integer + description: '**Required unless you provide `email`**. GitHub user ID for the person you are inviting.' + email: + type: string + description: '**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.' + role: + type: string + description: |- + The role for the new member. + * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + enum: + - admin + - direct_member + - billing_manager + - reinstate + default: direct_member + team_ids: + type: array + description: Specify IDs for the teams you want to invite new members to. + items: + type: integer + examples: + default: + value: + email: octocat@github.com + role: direct_member + team_ids: + - 12 + - 26 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/invitations/{invitation_id}: + delete: + summary: Cancel an organization invitation + description: |- + Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + tags: + - orgs + operationId: orgs/cancel-invitation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/invitations/{invitation_id}/teams: + get: + summary: List organization invitation teams + description: List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + tags: + - orgs + operationId: orgs/list-invitation-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/invitation-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/issue-fields: + get: + summary: List issue fields for an organization + description: Lists all issue fields for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-issue-fields + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-fields#list-issue-fields-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-field' + examples: + default: + $ref: '#/components/examples/issue-field-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + post: + summary: Create issue field for an organization + description: |- + Creates a new issue field for an organization. + + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/create-issue-field + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-fields#create-issue-field-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-create-issue-field' + examples: + default: + value: + name: Priority + description: Level of importance for the issue + data_type: single_select + options: + - name: High + description: High priority + color: red + - name: Medium + description: Medium priority + color: yellow + - name: Low + description: Low priority + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-field' + examples: + default: + $ref: '#/components/examples/issue-field' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + /orgs/{org}/issue-fields/{issue_field_id}: + patch: + summary: Update issue field for an organization + description: |- + Updates an issue field for an organization. + + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/update-issue-field + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-fields#update-issue-field-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-field-id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-update-issue-field' + examples: + default: + summary: Update name and description + description: Update the name and description of an issue field + value: + name: Priority + description: Level of importance for the issue + update-single-select-options: + summary: Update single select options + description: Update the options for a single select issue field + value: + name: Status + description: Current status of the issue + options: + - name: Backlog + description: Items waiting to be prioritized + color: gray + priority: 1 + - name: In Progress + description: Currently being worked on + color: blue + priority: 2 + - name: Done + description: Completed work + color: green + priority: 3 + update-name-only: + summary: Update name only + description: Update only the name of an issue field + value: + name: Updated Field Name + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-field' + examples: + default: + $ref: '#/components/examples/issue-field' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + delete: + summary: Delete issue field for an organization + description: |- + Deletes an issue field for an organization. + + You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/delete-issue-field + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-fields#delete-issue-field-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-field-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-fields + x-stackQL-resource: issue_fields + /orgs/{org}/issue-types: + get: + summary: List issue types for an organization + description: Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-issue-types + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/issue-type' + examples: + default: + $ref: '#/components/examples/issue-type-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + post: + summary: Create issue type for an organization + description: |- + Create a new issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/create-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-create-issue-type' + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-type' + examples: + default: + $ref: '#/components/examples/issue-type' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + /orgs/{org}/issue-types/{issue_type_id}: + put: + summary: Update issue type for an organization + description: |- + Updates an issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/update-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-type-id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/organization-update-issue-type' + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/issue-type' + examples: + default: + $ref: '#/components/examples/issue-type' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + delete: + summary: Delete issue type for an organization + description: |- + Deletes an issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/delete-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/issue-type-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + x-stackQL-resource: issue_types + /orgs/{org}/members: + get: + summary: List organization members + description: List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. + tags: + - orgs + operationId: orgs/list-members + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-organization-members + parameters: + - $ref: '#/components/parameters/org' + - name: filter + description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 2fa_insecure + - all + default: all + - name: role + description: Filter members returned by their role. + in: query + required: false + schema: + type: string + enum: + - all + - admin + - member + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/members/{username}: + get: + summary: Check organization membership for a user + description: Check if a user is, publicly or privately, a member of the organization. + tags: + - orgs + operationId: orgs/check-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response if requester is an organization member and user is a member + '302': + description: Response if requester is not an organization member + headers: + Location: + example: https://api.github.com/orgs/github/public_members/pezra + schema: + type: string + '404': + description: Not Found if requester is an organization member and user is not a member + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + delete: + summary: Remove an organization member + description: |- + Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + + > [!NOTE] + > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. + tags: + - orgs + operationId: orgs/remove-member + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#remove-an-organization-member + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-github-breaking-changes: + - changeset: change_remove_member_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: members + /orgs/{org}/memberships/{username}: + get: + summary: Get organization membership for a user + description: In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. + tags: + - orgs + operationId: orgs/get-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + response-if-user-has-an-active-admin-membership-with-organization: + $ref: '#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + put: + summary: Set organization membership for a user + description: |- + Only authenticated organization owners can add a member to the organization or update the member's role. + + * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + + * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + + **Rate limits** + + To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + tags: + - orgs + operationId: orgs/set-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: |- + The role to give the user in the organization. Can be one of: + * `admin` - The user will become an owner of the organization. + * `member` - The user will become a non-owner member of the organization. + enum: + - admin + - member + default: member + examples: + default: + summary: Set an organization membership role for a user + value: + role: member + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + response-if-user-already-had-membership-with-organization: + $ref: '#/components/examples/org-membership-response-if-user-has-an-active-admin-membership-with-organization' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-github-breaking-changes: + - changeset: change_update_user_membership_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: members + delete: + summary: Remove organization membership for a user + description: |- + In order to remove a user's membership with an organization, the authenticated user must be an organization owner. + + If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + + > [!NOTE] + > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. + tags: + - orgs + operationId: orgs/remove-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/organization-roles: + get: + summary: Get all organization roles for an organization + description: |- + Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-org-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response - list of organization roles + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + description: The total number of organization roles available to the organization. + roles: + type: array + description: The list of organization roles available to the organization. + items: + $ref: '#/components/schemas/organization-role' + examples: + default: + $ref: '#/components/examples/organization-role-list' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/teams/{team_slug}: + delete: + summary: Remove all organization roles for a team + description: |- + Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-org-roles-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}: + put: + summary: Assign an organization role to a team + description: |- + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/assign-team-to-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + '404': + description: Response if the organization, team or role does not exist. + '422': + description: Response if the organization roles feature is not enabled for the organization, or validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + delete: + summary: Remove an organization role from a team + description: |- + Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-org-role-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/users/{username}: + delete: + summary: Remove all organization roles for a user + description: |- + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-org-roles-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/users/{username}/{role_id}: + put: + summary: Assign an organization role to a user + description: |- + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/assign-user-to-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + '404': + description: Response if the organization, user or role does not exist. + '422': + description: Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + delete: + summary: Remove an organization role from a user + description: |- + Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-org-role-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/role-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/{role_id}: + get: + summary: Get an organization role + description: |- + Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/get-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/role-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/organization-role' + examples: + default: + $ref: '#/components/examples/organization-role' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/{role_id}/teams: + get: + summary: List teams that are assigned to an organization role + description: |- + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + To use this endpoint, you must be an administrator for the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-org-role-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/role-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response - List of assigned teams + content: + application/json: + schema: + type: array + description: List of teams assigned to the organization role + items: + $ref: '#/components/schemas/team-role-assignment' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + description: Response if the organization or role does not exist. + '422': + description: Response if the organization roles feature is not enabled or validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/organization-roles/{role_id}/users: + get: + summary: List users that are assigned to an organization role + description: |- + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." + + To use this endpoint, you must be an administrator for the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-org-role-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/role-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response - List of assigned users + content: + application/json: + schema: + type: array + description: List of users assigned to the organization role + items: + $ref: '#/components/schemas/user-role-assignment' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + description: Response if the organization or role does not exist. + '422': + description: Response if the organization roles feature is not enabled or validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + x-stackQL-resource: organization_roles + /orgs/{org}/outside_collaborators: + get: + summary: List outside collaborators for an organization + description: List all users who are outside collaborators of an organization. + tags: + - orgs + operationId: orgs/list-outside-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - name: filter + description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 2fa_insecure + - all + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: outside-collaborators + x-stackQL-resource: outside_collaborators + /orgs/{org}/outside_collaborators/{username}: + put: + summary: Convert an organization member to outside collaborator + description: When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + tags: + - orgs + operationId: orgs/convert-member-to-outside-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + async: + type: boolean + description: When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. + default: false + examples: + '202': + summary: Status code 202, asynchronous request + value: + async: true + '204': + summary: Status code 204, synchronous request + value: null + responses: + '202': + description: User is getting converted asynchronously + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + '202': + value: null + '204': + description: User was converted + '403': + description: Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: outside-collaborators + x-stackQL-resource: outside_collaborators + delete: + summary: Remove outside collaborator from an organization + description: Removing a user from this list will remove them from all the organization's repositories. + tags: + - orgs + operationId: orgs/remove-outside-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '422': + description: Unprocessable Entity if user is a member of the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-user-is-a-member-of-the-organization: + value: + message: You cannot specify an organization member to remove as an outside collaborator. + documentation_url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: outside-collaborators + x-stackQL-resource: outside_collaborators + /orgs/{org}/personal-access-token-requests: + get: + summary: List requests to access organization resources with fine-grained personal access tokens + description: |- + Lists requests from organization members to access organization resources with a fine-grained personal access token. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grant-requests + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/personal-access-token-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/personal-access-token-owner' + - $ref: '#/components/parameters/personal-access-token-repository' + - $ref: '#/components/parameters/personal-access-token-permission' + - $ref: '#/components/parameters/personal-access-token-before' + - $ref: '#/components/parameters/personal-access-token-after' + - $ref: '#/components/parameters/personal-access-token-token-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-programmatic-access-grant-request' + examples: + default: + $ref: '#/components/examples/org-pat-grant-request-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + post: + summary: Review requests to access organization resources with fine-grained personal access tokens + description: |- + Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/review-pat-grant-requests-in-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pat_request_ids: + type: array + description: Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. + items: + type: integer + minItems: 1 + maxItems: 100 + action: + type: string + description: Action to apply to the requests. + enum: + - approve + - deny + reason: + type: string + description: Reason for approving or denying the requests. Max 1024 characters. + maxLength: 1024 + nullable: true + required: + - action + examples: + '204': + summary: Example of denying a request + value: + pat_request_ids: + - 42 + - 73 + action: deny + reason: Access is too broad. + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-token-requests/{pat_request_id}: + post: + summary: Review a request to access organization resources with a fine-grained personal access token + description: |- + Approves or denies a pending request to access organization resources via a fine-grained personal access token. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/review-pat-grant-request + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token + parameters: + - $ref: '#/components/parameters/org' + - name: pat_request_id + in: path + description: Unique identifier of the request for access via fine-grained personal access token. + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: Action to apply to the request. + enum: + - approve + - deny + reason: + type: string + description: Reason for approving or denying the request. Max 1024 characters. + maxLength: 1024 + nullable: true + required: + - action + examples: + '204': + summary: Example of denying a request + value: + action: deny + reason: This request is denied because the access is too broad. + responses: + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories: + get: + summary: List repositories requested to be accessed by a fine-grained personal access token + description: |- + Lists the repositories a fine-grained personal access token request is requesting access to. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grant-request-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token + parameters: + - $ref: '#/components/parameters/org' + - name: pat_request_id + in: path + description: Unique identifier of the request for access via fine-grained personal access token. + required: true + schema: + type: integer + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-tokens: + get: + summary: List fine-grained personal access tokens with access to organization resources + description: |- + Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/personal-access-token-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/personal-access-token-owner' + - $ref: '#/components/parameters/personal-access-token-repository' + - $ref: '#/components/parameters/personal-access-token-permission' + - $ref: '#/components/parameters/personal-access-token-before' + - $ref: '#/components/parameters/personal-access-token-after' + - $ref: '#/components/parameters/personal-access-token-token-id' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-programmatic-access-grant' + examples: + default: + $ref: '#/components/examples/org-pat-grant-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + post: + summary: Update the access to organization resources via fine-grained personal access tokens + description: |- + Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-accesses + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: Action to apply to the fine-grained personal access token. + enum: + - revoke + pat_ids: + description: The IDs of the fine-grained personal access tokens. + type: array + items: + type: integer + description: Unique identifier of the fine-grained personal access token. + minItems: 1 + maxItems: 100 + required: + - action + - pat_ids + examples: + '204': + summary: Example of revoking a fine-grained personal access token. + value: + action: revoke + pat_ids: + - 1296269 + - 1296280 + responses: + '202': + $ref: '#/components/responses/accepted' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-tokens/{pat_id}: + post: + summary: Update the access a fine-grained personal access token has to organization resources + description: |- + Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-access + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/fine-grained-personal-access-token-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: Action to apply to the fine-grained personal access token. + enum: + - revoke + required: + - action + examples: + '204': + summary: Example of revoking a fine-grained personal access token. + value: + action: revoke + responses: + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/personal-access-tokens/{pat_id}/repositories: + get: + summary: List repositories a fine-grained personal access token has access to + description: |- + Lists the repositories a fine-grained personal access token has access to. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grant-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to + parameters: + - $ref: '#/components/parameters/org' + - name: pat_id + in: path + description: Unique identifier of the fine-grained personal access token. + required: true + schema: + type: integer + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: personal-access-tokens + x-stackQL-resource: personal_access_tokens + /orgs/{org}/properties/schema: + get: + summary: Get all custom properties for an organization + description: |- + Gets all custom properties defined for an organization. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-get-organization-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-properties' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + patch: + summary: Create or update custom properties for an organization + description: |- + Creates new or updates existing custom properties defined for an organization in a batch. + + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of custom properties to create or update. + items: + $ref: '#/components/schemas/custom-property' + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + type: object + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-properties' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + /orgs/{org}/properties/schema/{custom_property_name}: + get: + summary: Get a custom property for an organization + description: |- + Gets a custom property that is defined for an organization. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-get-organization-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/custom-property-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-property' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + put: + summary: Create or update a custom property for an organization + description: |- + Creates a new or updates an existing custom property that is defined for an organization. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/custom-property-name' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/custom-property-set-payload' + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/custom-property' + examples: + default: + $ref: '#/components/examples/custom-property' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + delete: + summary: Remove a custom property for an organization + description: |- + Removes a custom property that is defined for an organization. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-delete-organization-definition + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/custom-property-name' + responses: + '204': + $ref: '#/components/responses/no_content' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + /orgs/{org}/properties/values: + get: + summary: List custom property values for organization repositories + description: |- + Lists organization repositories with all of their custom property values. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-get-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: repository_query + description: Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/org-repo-custom-property-values' + examples: + default: + $ref: '#/components/examples/org-repo-custom-property-values' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + patch: + summary: Create or update custom property values for organization repositories + description: |- + Create new or update existing custom property values for repositories in a batch that belong to an organization. + Each target repository will have its custom property values updated to match the values provided in the request. + + A maximum of 30 repositories can be updated in a single request. + + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + tags: + - orgs + operationId: orgs/custom-properties-for-repos-create-or-update-organization-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_names: + type: array + description: The names of repositories that the custom property values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values to apply to the repositories. + items: + $ref: '#/components/schemas/custom-property-value' + required: + - repository_names + - properties + examples: + default: + $ref: '#/components/examples/org-repo-update-custom-property-values' + responses: + '204': + description: No Content when custom property values are successfully created or updated + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + x-stackQL-resource: custom_properties + /orgs/{org}/public_members: + get: + summary: List public organization members + description: Members of an organization can choose to have their membership publicized or not. + tags: + - orgs + operationId: orgs/list-public-members + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-public-organization-members + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/public_members/{username}: + get: + summary: Check public organization membership for a user + description: Check if the provided user is a public member of the organization. + tags: + - orgs + operationId: orgs/check-public-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response if user is a public member + '404': + description: Not Found if user is not a public member + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + put: + summary: Set public organization membership for the authenticated user + description: |- + The user can publicize their own membership. (A user cannot publicize the membership for another user.) + + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - orgs + operationId: orgs/set-public-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: orgs + subcategory: members + x-stackQL-resource: members + delete: + summary: Remove public organization membership for the authenticated user + description: Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. + tags: + - orgs + operationId: orgs/remove-public-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: orgs + subcategory: members + x-stackQL-resource: members + /orgs/{org}/rulesets/{ruleset_id}/history: + get: + summary: Get organization ruleset history + description: Get the history of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ruleset-version' + examples: + default: + $ref: '#/components/examples/ruleset-history' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + x-stackQL-resource: rules + /orgs/{org}/rulesets/{ruleset_id}/history/{version_id}: + get: + summary: Get organization ruleset version + description: Get a version of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-version + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ruleset-version-with-state' + examples: + default: + $ref: '#/components/examples/org-ruleset-version-with-state' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + x-stackQL-resource: rules + /orgs/{org}/security-managers: + get: + summary: List security manager teams + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. + tags: + - orgs + operationId: orgs/list-security-manager-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team-simple' + examples: + default: + $ref: '#/components/examples/team-simple-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true + x-stackQL-resource: security_managers + /orgs/{org}/security-managers/teams/{team_slug}: + put: + summary: Add a security manager team + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. + tags: + - orgs + operationId: orgs/add-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true + x-stackQL-resource: security_managers + delete: + summary: Remove a security manager team + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. + tags: + - orgs + operationId: orgs/remove-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + deprecationDate: '2024-12-01' + removalDate: '2026-01-01' + deprecated: true + x-stackQL-resource: security_managers + /orgs/{org}/settings/immutable-releases: + get: + summary: Get immutable releases settings for an organization + description: |- + Gets the immutable releases policy for repositories in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/get-immutable-releases-settings + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Immutable releases settings response + content: + application/json: + schema: + $ref: '#/components/schemas/immutable-releases-organization-settings' + examples: + default: + value: + enforced_repositories: all + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + put: + summary: Set immutable releases settings for an organization + description: |- + Sets the immutable releases policy for repositories in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enforced_repositories: + type: string + description: The policy that controls how immutable releases are enforced in the organization. + enum: + - all + - none + - selected + example: all + selected_repository_ids: + type: array + description: An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. + items: + type: integer + required: + - enforced_repositories + examples: + default: + value: + enforced_repositories: all + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/settings/immutable-releases/repositories: + get: + summary: List selected repositories for immutable releases enforcement + description: |- + List all of the repositories that have been selected for immutable releases enforcement in an organization. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/get-immutable-releases-settings-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-paginated' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + put: + summary: Set selected repositories for immutable releases enforcement + description: |- + Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/settings/immutable-releases/repositories/{repository_id}: + put: + summary: Enable a selected repository for immutable releases in an organization + description: |- + Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: orgs/enable-selected-repository-immutable-releases-organization + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + delete: + summary: Disable a selected repository for immutable releases in an organization + description: |- + Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: orgs/disable-selected-repository-immutable-releases-organization + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/repository-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /orgs/{org}/{security_product}/{enablement}: + post: + summary: Enable or disable a security feature for an organization + description: |- + > [!WARNING] + > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + + Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. + tags: + - orgs + operationId: orgs/enable-or-disable-security-product-on-all-org-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/security-product' + - $ref: '#/components/parameters/org-security-product-enablement' + requestBody: + required: false + content: + application/json: + schema: + properties: + query_suite: + description: |- + CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. + If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + type: string + enum: + - default + - extended + type: object + examples: + default: + value: null + responses: + '204': + description: Action started + '422': + description: The action could not be taken due to an in progress enablement, or a policy is preventing enablement + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: orgs + deprecationDate: '2024-07-22' + removalDate: '2025-07-22' + deprecated: true + x-stackQL-resource: orgs + /user/memberships/orgs: + get: + summary: List organization memberships for the authenticated user + description: Lists all of the authenticated user's organization memberships. + tags: + - orgs + operationId: orgs/list-memberships-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user + parameters: + - name: state + description: Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. + in: query + required: false + schema: + type: string + enum: + - active + - pending + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/org-membership' + examples: + default: + $ref: '#/components/examples/org-membership-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /user/memberships/orgs/{org}: + get: + summary: Get an organization membership for the authenticated user + description: If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. + tags: + - orgs + operationId: orgs/get-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + default: + $ref: '#/components/examples/org-membership' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + patch: + summary: Update an organization membership for the authenticated user + description: Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. + tags: + - orgs + operationId: orgs/update-membership-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: The state that the membership should be in. Only `"active"` will be accepted. + enum: + - active + required: + - state + examples: + default: + value: + state: active + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/org-membership' + examples: + default: + $ref: '#/components/examples/org-membership-2' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: members + x-stackQL-resource: members + /user/orgs: + get: + summary: List organizations for the authenticated user + description: |- + List organizations for the authenticated user. + + For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + + > [!NOTE] + > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. + tags: + - orgs + operationId: orgs/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: orgs + subcategory: orgs + x-stackQL-resource: orgs + /users/{username}/orgs: + get: + summary: List organizations for a user + description: |- + List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. + + This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + tags: + - orgs + operationId: orgs/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-simple' + examples: + default: + $ref: '#/components/examples/organization-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + x-stackQL-resource: orgs +components: + schemas: + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + organization-full: + title: Organization Full + description: Organization Full + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + name: + type: string + example: github + company: + type: string + example: GitHub + blog: + type: string + format: uri + example: https://github.com/blog + location: + type: string + example: San Francisco + email: + type: string + format: email + example: octocat@github.com + twitter_username: + type: string + example: github + nullable: true + is_verified: + type: boolean + example: true + has_organization_projects: + type: boolean + example: true + has_repository_projects: + type: boolean + example: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + html_url: + type: string + format: uri + example: https://github.com/octocat + type: + type: string + example: Organization + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + private_gists: + type: integer + example: 81 + nullable: true + disk_usage: + type: integer + example: 10000 + nullable: true + collaborators: + type: integer + example: 8 + nullable: true + description: |- + The number of collaborators on private repositories. + + This field may be null if the number of private repositories is over 50,000. + billing_email: + type: string + format: email + example: org@example.com + nullable: true + plan: + type: object + properties: + name: + type: string + space: + type: integer + private_repos: + type: integer + filled_seats: + type: integer + seats: + type: integer + required: + - name + - space + - private_repos + default_repository_permission: + type: string + nullable: true + default_repository_branch: + type: string + example: main + nullable: true + description: The default branch for repositories created in this organization. + members_can_create_repositories: + type: boolean + example: true + nullable: true + two_factor_requirement_enabled: + type: boolean + example: true + nullable: true + members_allowed_repository_creation_type: + type: string + example: all + members_can_create_public_repositories: + type: boolean + example: true + members_can_create_private_repositories: + type: boolean + example: true + members_can_create_internal_repositories: + type: boolean + example: true + members_can_create_pages: + type: boolean + example: true + members_can_create_public_pages: + type: boolean + example: true + members_can_create_private_pages: + type: boolean + example: true + members_can_delete_repositories: + type: boolean + example: true + members_can_change_repo_visibility: + type: boolean + example: true + members_can_invite_outside_collaborators: + type: boolean + example: true + members_can_delete_issues: + type: boolean + example: true + display_commenter_full_name_setting_enabled: + type: boolean + example: true + readers_can_create_discussions: + type: boolean + example: true + members_can_create_teams: + type: boolean + example: true + members_can_view_dependency_insights: + type: boolean + example: true + members_can_fork_private_repositories: + type: boolean + example: false + nullable: true + web_commit_signoff_required: + type: boolean + example: false + advanced_security_enabled_for_new_repositories: + type: boolean + example: false + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + + This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true + dependabot_alerts_enabled_for_new_repositories: + type: boolean + example: false + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. + + This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true + dependabot_security_updates_enabled_for_new_repositories: + type: boolean + example: false + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. + + This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true + dependency_graph_enabled_for_new_repositories: + type: boolean + example: false + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. + + This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true + secret_scanning_enabled_for_new_repositories: + type: boolean + example: false + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. + + This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + example: false + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + + Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. + + This field is only visible to organization owners or members of a team with the security manager role. + deprecated: true + secret_scanning_push_protection_custom_link_enabled: + type: boolean + example: false + description: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. + secret_scanning_push_protection_custom_link: + type: string + example: https://github.com/test-org/test-repo/blob/main/README.md + nullable: true + description: An optional URL string to display to contributors who are blocked from pushing a secret. + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + archived_at: + type: string + format: date-time + nullable: true + deploy_keys_enabled_for_repositories: + type: boolean + example: false + description: Controls whether or not deploy keys may be added and used for repositories in the organization. + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + - html_url + - has_organization_projects + - has_repository_projects + - public_repos + - public_gists + - followers + - following + - type + - created_at + - updated_at + - archived_at + x-github-breaking-changes: + - changeset: remove_secret_scanning_custom_link_enablement_field + patch: + - op: remove + path: /properties/secret_scanning_push_protection_custom_link_enabled + version: '2026-03-10' + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + artifact-deployment-record: + title: Artifact Deployment Record + description: Artifact Metadata Deployment Record + type: object + properties: + id: + type: integer + digest: + type: string + logical_environment: + type: string + physical_environment: + type: string + cluster: + type: string + deployment_name: + type: string + tags: + type: object + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + created_at: + type: string + updated_at: + type: string + attestation_id: + type: integer + description: The ID of the provenance attestation associated with the deployment record. + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + organization-invitation: + title: Organization Invitation + description: Organization Invitation + type: object + properties: + id: + type: integer + format: int64 + login: + type: string + nullable: true + email: + type: string + nullable: true + role: + type: string + created_at: + type: string + failed_at: + type: string + nullable: true + failed_reason: + type: string + nullable: true + inviter: + $ref: '#/components/schemas/simple-user' + team_count: + type: integer + node_id: + type: string + example: '"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x"' + invitation_teams_url: + type: string + example: '"https://api.github.com/organizations/16/invitations/1/teams"' + invitation_source: + type: string + example: '"member"' + required: + - id + - login + - email + - role + - created_at + - inviter + - team_count + - invitation_teams_url + - node_id + org-hook: + title: Org Hook + description: Org Hook + type: object + properties: + id: + type: integer + example: 1 + url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/hooks/1 + ping_url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/hooks/1/deliveries + name: + type: string + example: web + events: + type: array + example: + - push + - pull_request + items: + type: string + active: + type: boolean + example: true + config: + type: object + properties: + url: + type: string + example: '"http://example.com/2"' + insecure_ssl: + type: string + example: '"0"' + content_type: + type: string + example: '"form"' + secret: + type: string + example: '"********"' + updated_at: + type: string + format: date-time + example: '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + example: '2011-09-06T17:26:27Z' + type: + type: string + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + webhook-config-url: + type: string + description: The URL to which the payloads will be delivered. + example: https://example.com/webhook + format: uri + webhook-config-content-type: + type: string + description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. + example: '"json"' + webhook-config-secret: + type: string + description: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + example: '"********"' + webhook-config-insecure-ssl: + type: string + description: Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** + example: '"0"' + webhook-config: + title: Webhook Configuration + description: Configuration object of the webhook + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + hook-delivery-item: + title: Simple webhook delivery + description: Delivery made by a webhook, without request and response information. + type: object + properties: + id: + description: Unique identifier of the webhook delivery. + type: integer + format: int64 + example: 42 + guid: + description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + hook-delivery: + title: Webhook delivery + description: Delivery made by a webhook. + type: object + properties: + id: + description: Unique identifier of the delivery. + type: integer + example: 42 + guid: + description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Description of the status of the attempted delivery + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + url: + description: The URL target of the delivery. + type: string + example: https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: object + nullable: true + additionalProperties: true + payload: + description: The webhook payload. + type: object + nullable: true + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: object + nullable: true + additionalProperties: true + payload: + description: The response payload received. + type: string + nullable: true + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + api-insights-route-stats: + title: Route Stats + description: API Insights usage route stats for an actor + type: array + items: + type: object + properties: + http_method: + description: The HTTP method + type: string + api_route: + description: The API path's route template + type: string + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: The total number of requests that were rate limited within the queried time period + type: integer + format: int64 + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + api-insights-subject-stats: + title: Subject Stats + description: API Insights usage subject stats for an organization + type: array + items: + type: object + properties: + subject_type: + type: string + subject_name: + type: string + subject_id: + type: integer + format: int64 + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + api-insights-summary-stats: + title: Summary Stats + description: API Insights usage summary stats for an organization + type: object + properties: + total_request_count: + description: The total number of requests within the queried time period + type: integer + format: int64 + rate_limited_request_count: + description: The total number of requests that were rate limited within the queried time period + type: integer + format: int64 + api-insights-time-stats: + title: Time Stats + description: API Insights usage time stats for an organization + type: array + items: + type: object + properties: + timestamp: + type: string + total_request_count: + type: integer + format: int64 + rate_limited_request_count: + type: integer + format: int64 + api-insights-user-stats: + title: User Stats + description: API Insights usage stats for a user + type: array + items: + type: object + properties: + actor_type: + type: string + actor_name: + type: string + actor_id: + type: integer + format: int64 + integration_id: + type: integer + format: int64 + nullable: true + oauth_application_id: + type: integer + format: int64 + nullable: true + total_request_count: + type: integer + rate_limited_request_count: + type: integer + last_rate_limited_timestamp: + type: string + nullable: true + last_request_timestamp: + type: string + installation: + title: Installation + description: Installation + type: object + properties: + id: + description: The ID of the installation. + type: integer + example: 1 + account: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + repository_selection: + description: Describe whether all repositories have been selected or there's a selection involved + type: string + enum: + - all + - selected + access_tokens_url: + type: string + format: uri + example: https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + example: https://api.github.com/installation/repositories + html_url: + type: string + format: uri + example: https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + example: 1 + client_id: + type: string + example: Iv1.ab1112223334445c + target_id: + description: The ID of the user or organization this token is being scoped to. + type: integer + target_type: + type: string + example: Organization + permissions: + $ref: '#/components/schemas/app-permissions' + events: + type: array + items: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + single_file_name: + type: string + example: config.yaml + nullable: true + has_multiple_single_files: + type: boolean + example: true + single_file_paths: + type: array + items: + type: string + example: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: + type: string + example: github-actions + suspended_by: + $ref: '#/components/schemas/nullable-simple-user' + suspended_at: + type: string + format: date-time + nullable: true + contact_email: + type: string + example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + nullable: true + required: + - id + - app_id + - app_slug + - target_id + - target_type + - single_file_name + - repository_selection + - access_tokens_url + - html_url + - repositories_url + - events + - account + - permissions + - created_at + - updated_at + - suspended_by + - suspended_at + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + issue-field: + title: Issue Field + description: A custom attribute defined at the organization level for attaching structured data to issues. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue field. + node_id: + type: string + description: The node identifier of the issue field. + name: + type: string + description: The name of the issue field. + description: + type: string + description: The description of the issue field. + nullable: true + data_type: + type: string + description: The data type of the issue field. + enum: + - text + - date + - single_select + - number + visibility: + type: string + description: The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). + enum: + - organization_members_only + - all + options: + description: Available options for single select fields. + type: array + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the option. + name: + type: string + description: The name of the option. + description: + type: string + description: The description of the option. + nullable: true + color: + type: string + description: The color of the option. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + priority: + type: integer + description: The priority of the option for ordering. + nullable: true + created_at: + type: string + description: The time the option was created. + format: date-time + updated_at: + type: string + description: The time the option was last updated. + format: date-time + required: + - id + - name + nullable: true + created_at: + type: string + description: The time the issue field was created. + format: date-time + updated_at: + type: string + description: The time the issue field was last updated. + format: date-time + required: + - id + - node_id + - name + - data_type + organization-create-issue-field: + type: object + properties: + name: + description: Name of the issue field. + type: string + description: + description: Description of the issue field. + type: string + nullable: true + data_type: + description: The data type of the issue field. + type: string + enum: + - text + - date + - single_select + - number + visibility: + description: The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to `organization_members_only`. + type: string + enum: + - organization_members_only + - all + options: + description: Options for single select fields. Required when data_type is 'single_select'. + type: array + items: + type: object + properties: + name: + description: Name of the option. + type: string + description: + description: Description of the option. + type: string + nullable: true + color: + description: Color for the option. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + priority: + description: Priority of the option for ordering. + type: integer + required: + - name + - color + - priority + nullable: true + required: + - name + - data_type + organization-update-issue-field: + type: object + properties: + name: + description: Name of the issue field. + type: string + description: + description: Description of the issue field. + type: string + nullable: true + visibility: + description: The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. + type: string + enum: + - organization_members_only + - all + options: + description: Options for single select fields. Only applicable when updating single_select fields. + type: array + items: + type: object + properties: + name: + description: Name of the option. + type: string + description: + description: Description of the option. + type: string + nullable: true + color: + description: Color for the option. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + priority: + description: Priority of the option for ordering. + type: integer + required: + - name + - color + - priority + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + organization-create-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization level. + type: boolean + description: + description: Description of the issue type. + type: string + nullable: true + color: + description: Color for the issue type. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + required: + - name + - is_enabled + organization-update-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization level. + type: boolean + description: + description: Description of the issue type. + type: string + nullable: true + color: + description: Color for the issue type. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + required: + - name + - is_enabled + org-membership: + title: Org Membership + description: Org Membership + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/orgs/octocat/memberships/defunkt + state: + type: string + description: The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. + example: active + enum: + - active + - pending + role: + type: string + description: The user's membership type in the organization. + example: admin + enum: + - admin + - member + - billing_manager + direct_membership: + type: boolean + description: Whether the user has direct membership in the organization. + example: true + enterprise_teams_providing_indirect_membership: + type: array + description: |- + The slugs of the enterprise teams providing the user with indirect membership in the organization. + A limit of 100 enterprise team slugs is returned. + maxItems: 100 + items: + type: string + example: + - ent:team-one + - ent:team-two + organization_url: + type: string + format: uri + example: https://api.github.com/orgs/octocat + organization: + $ref: '#/components/schemas/organization-simple' + user: + $ref: '#/components/schemas/nullable-simple-user' + permissions: + type: object + properties: + can_create_repository: + type: boolean + required: + - can_create_repository + required: + - state + - role + - organization_url + - url + - organization + - user + organization-role: + title: Organization Role + description: Organization roles + type: object + properties: + id: + description: The unique identifier of the role. + type: integer + format: int64 + name: + description: The name of the role. + type: string + description: + description: A short description about who this role is for or what permissions it grants. + type: string + nullable: true + base_role: + type: string + nullable: true + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + - admin + source: + type: string + nullable: true + description: Source answers the question, "where did this role come from?" + enum: + - Organization + - Enterprise + - Predefined + permissions: + description: A list of permissions included in this role. + type: array + items: + type: string + organization: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + description: The date and time the role was created. + type: string + format: date-time + updated_at: + description: The date and time the role was last updated. + type: string + format: date-time + required: + - id + - name + - permissions + - organization + - created_at + - updated_at + team-role-assignment: + title: A Role Assignment for a Team + description: The Relationship a Team has with a role. + type: object + properties: + assignment: + type: string + description: Determines if the team has a direct, indirect, or mixed relationship to a role + enum: + - direct + - indirect + - mixed + example: direct + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + $ref: '#/components/schemas/nullable-team-simple' + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + - parent + user-role-assignment: + title: A Role Assignment for a User + description: The Relationship a User has with a role. + type: object + properties: + assignment: + type: string + description: Determines if the user has a direct, indirect, or mixed relationship to a role + enum: + - direct + - indirect + - mixed + example: direct + inherited_from: + description: Team the user has gotten the role through + type: array + items: + $ref: '#/components/schemas/team-simple' + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + organization-programmatic-access-grant-request: + title: Simple Organization Programmatic Access Grant Request + description: Minimal representation of an organization programmatic access grant request for enumerations + type: object + properties: + id: + type: integer + description: Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. + reason: + type: string + nullable: true + description: Reason for requesting access. + owner: + $ref: '#/components/schemas/simple-user' + repository_selection: + type: string + enum: + - none + - all + - subset + description: Type of repository selection requested. + repositories_url: + type: string + description: URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. + permissions: + type: object + description: Permissions requested, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + created_at: + type: string + description: Date and time when the request for access was created. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. + token_expired: + type: boolean + description: Whether the associated fine-grained personal access token has expired. + token_expires_at: + type: string + nullable: true + description: Date and time when the associated fine-grained personal access token expires. + token_last_used_at: + type: string + nullable: true + description: Date and time when the associated fine-grained personal access token was last used for authentication. + required: + - id + - reason + - owner + - repository_selection + - repositories_url + - permissions + - created_at + - token_id + - token_name + - token_expired + - token_expires_at + - token_last_used_at + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + organization-programmatic-access-grant: + title: Organization Programmatic Access Grant + description: Minimal representation of an organization programmatic access grant for enumerations + type: object + properties: + id: + type: integer + description: Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. + owner: + $ref: '#/components/schemas/simple-user' + repository_selection: + type: string + enum: + - none + - all + - subset + description: Type of repository selection requested. + repositories_url: + type: string + description: URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. + permissions: + type: object + description: Permissions requested, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + access_granted_at: + type: string + description: Date and time when the fine-grained personal access token was approved to access the organization. + token_id: + type: integer + description: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + token_name: + type: string + description: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. + token_expired: + type: boolean + description: Whether the associated fine-grained personal access token has expired. + token_expires_at: + type: string + nullable: true + description: Date and time when the associated fine-grained personal access token expires. + token_last_used_at: + type: string + nullable: true + description: Date and time when the associated fine-grained personal access token was last used for authentication. + required: + - id + - owner + - repository_selection + - repositories_url + - permissions + - access_granted_at + - token_id + - token_name + - token_expired + - token_expires_at + - token_last_used_at + custom-property: + title: Organization Custom Property + description: Custom property defined on an organization + type: object + properties: + property_name: + type: string + description: The name of the property + url: + type: string + format: uri + description: The URL that can be used to fetch, update, or delete info about this property via the API. + source_type: + type: string + description: The source type of the property + enum: + - organization + - enterprise + example: organization + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + - url + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + nullable: true + description: Default value of the property + type: string + items: + type: string + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory + required: + - property_name + - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + - multi_select + - true_false + - url + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + nullable: true + description: Default value of the property + type: string + items: + type: string + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + nullable: true + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory + required: + - value_type + org-repo-custom-property-values: + title: Organization Repository Custom Property Values + description: List of custom property values for a repository + type: object + properties: + repository_id: + type: integer + example: 1296269 + repository_name: + type: string + example: Hello-World + repository_full_name: + type: string + example: octocat/Hello-World + properties: + type: array + items: + $ref: '#/components/schemas/custom-property-value' + description: List of custom property names and associated values + required: + - repository_id + - repository_name + - repository_full_name + - properties + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + description: The value assigned to the property + nullable: true + type: string + items: + type: string + required: + - property_name + - value + ruleset-version: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + ruleset-version-with-state: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + - state + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + state: + type: string + description: The state of the ruleset version (opaque JSON object) + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + immutable-releases-organization-settings: + title: Check immutable releases organization settings + description: Check immutable releases settings for an organization. + type: object + properties: + enforced_repositories: + type: string + description: The policy that controls how immutable releases are enforced in the organization. + enum: + - all + - none + - selected + example: all + selected_repositories_url: + type: string + description: The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. + required: + - enforced_repositories + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + app-permissions: + title: App Permissions + type: object + description: The permissions granted to the user access token. + properties: + actions: + type: string + description: The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. + enum: + - read + - write + administration: + type: string + description: The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. + enum: + - read + - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create and retrieve build artifact metadata records. + enum: + - read + - write + attestations: + type: string + description: The level of permission to create and retrieve the access token for repository attestations. + enum: + - read + - write + checks: + type: string + description: The level of permission to grant the access token for checks on code. + enum: + - read + - write + codespaces: + type: string + description: The level of permission to grant the access token to create, edit, delete, and list Codespaces. + enum: + - read + - write + contents: + type: string + description: The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. + enum: + - read + - write + dependabot_secrets: + type: string + description: The level of permission to grant the access token to manage Dependabot secrets. + enum: + - read + - write + deployments: + type: string + description: The level of permission to grant the access token for deployments and deployment statuses. + enum: + - read + - write + discussions: + type: string + description: The level of permission to grant the access token for discussions and related comments and labels. + enum: + - read + - write + environments: + type: string + description: The level of permission to grant the access token for managing repository environments. + enum: + - read + - write + issues: + type: string + description: The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. + enum: + - read + - write + merge_queues: + type: string + description: The level of permission to grant the access token to manage the merge queues for a repository. + enum: + - read + - write + metadata: + type: string + description: The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. + enum: + - read + - write + packages: + type: string + description: The level of permission to grant the access token for packages published to GitHub Packages. + enum: + - read + - write + pages: + type: string + description: The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. + enum: + - read + - write + pull_requests: + type: string + description: The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. + enum: + - read + - write + repository_custom_properties: + type: string + description: The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + enum: + - read + - write + repository_hooks: + type: string + description: The level of permission to grant the access token to manage the post-receive hooks for a repository. + enum: + - read + - write + repository_projects: + type: string + description: The level of permission to grant the access token to manage repository projects, columns, and cards. + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + description: The level of permission to grant the access token to view and manage secret scanning alerts. + enum: + - read + - write + secrets: + type: string + description: The level of permission to grant the access token to manage repository secrets. + enum: + - read + - write + security_events: + type: string + description: The level of permission to grant the access token to view and manage security events like code scanning alerts. + enum: + - read + - write + single_file: + type: string + description: The level of permission to grant the access token to manage just a single file. + enum: + - read + - write + statuses: + type: string + description: The level of permission to grant the access token for commit statuses. + enum: + - read + - write + vulnerability_alerts: + type: string + description: The level of permission to grant the access token to manage Dependabot alerts. + enum: + - read + - write + workflows: + type: string + description: The level of permission to grant the access token to update GitHub Actions workflow files. + enum: + - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + enum: + - read + - write + members: + type: string + description: The level of permission to grant the access token for organization teams and members. + enum: + - read + - write + organization_administration: + type: string + description: The level of permission to grant the access token to manage access to an organization. + enum: + - read + - write + organization_custom_roles: + type: string + description: The level of permission to grant the access token for custom repository roles management. + enum: + - read + - write + organization_custom_org_roles: + type: string + description: The level of permission to grant the access token for custom organization roles management. + enum: + - read + - write + organization_custom_properties: + type: string + description: The level of permission to grant the access token for repository custom properties management at the organization level. + enum: + - read + - write + - admin + organization_copilot_seat_management: + type: string + description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. + enum: + - write + organization_copilot_agent_settings: + type: string + description: The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization. + enum: + - read + - write + organization_announcement_banners: + type: string + description: The level of permission to grant the access token to view and manage announcement banners for an organization. + enum: + - read + - write + organization_events: + type: string + description: The level of permission to grant the access token to view events triggered by an activity in an organization. + enum: + - read + organization_hooks: + type: string + description: The level of permission to grant the access token to manage the post-receive hooks for an organization. + enum: + - read + - write + organization_personal_access_tokens: + type: string + description: The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. + enum: + - read + - write + organization_personal_access_token_requests: + type: string + description: The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. + enum: + - read + - write + organization_plan: + type: string + description: The level of permission to grant the access token for viewing an organization's plan. + enum: + - read + organization_projects: + type: string + description: The level of permission to grant the access token to manage organization projects and projects public preview (where available). + enum: + - read + - write + - admin + organization_packages: + type: string + description: The level of permission to grant the access token for organization packages published to GitHub Packages. + enum: + - read + - write + organization_secrets: + type: string + description: The level of permission to grant the access token to manage organization secrets. + enum: + - read + - write + organization_self_hosted_runners: + type: string + description: The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. + enum: + - read + - write + organization_user_blocking: + type: string + description: The level of permission to grant the access token to view and manage users blocked by the organization. + enum: + - read + - write + email_addresses: + type: string + description: The level of permission to grant the access token to manage the email addresses belonging to a user. + enum: + - read + - write + followers: + type: string + description: The level of permission to grant the access token to manage the followers belonging to a user. + enum: + - read + - write + git_ssh_keys: + type: string + description: The level of permission to grant the access token to manage git SSH keys. + enum: + - read + - write + gpg_keys: + type: string + description: The level of permission to grant the access token to view and manage GPG keys belonging to a user. + enum: + - read + - write + interaction_limits: + type: string + description: The level of permission to grant the access token to view and manage interaction limits on a repository. + enum: + - read + - write + profile: + type: string + description: The level of permission to grant the access token to manage the profile settings belonging to a user. + enum: + - write + starring: + type: string + description: The level of permission to grant the access token to list and manage repositories a user is starring. + enum: + - read + - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization custom properties management at the enterprise level. + enum: + - read + - write + - admin + example: + contents: read + issues: read + deployments: write + single_file: read + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + no_content: + description: A header with no content is returned. + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + since-org: + name: since + description: An organization ID. Only return organizations with an ID greater than this ID. + in: query + required: false + schema: + type: integer + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + subject-digest: + name: subject_digest + description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + minLength: 71 + maxLength: 71 + pattern: ^sha256:[a-f0-9]{64}$ + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + hook-id: + name: hook_id + description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. + in: path + required: true + schema: + type: integer + cursor: + name: cursor + description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.' + in: query + required: false + schema: + type: string + webhook-delivery-status: + name: status + description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive). + in: query + required: false + schema: + type: string + enum: + - success + - failure + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + api-insights-actor-type: + name: actor_type + in: path + description: The type of the actor + required: true + schema: + type: string + enum: + - installation + - classic_pat + - fine_grained_pat + - oauth_app + - github_app_user_to_server + api-insights-actor-id: + name: actor_id + in: path + description: The ID of the actor + required: true + schema: + type: integer + api-insights-min-timestamp: + name: min_timestamp + description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: true + schema: + type: string + api-insights-max-timestamp: + name: max_timestamp + description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + api-insights-route-stats-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - http_method + - api_route + - total_request_count + default: total_request_count + api-insights-api-route-substring: + name: api_route_substring + in: query + description: Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. + required: false + schema: + type: string + api-insights-sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: array + items: + type: string + enum: + - last_rate_limited_timestamp + - last_request_timestamp + - rate_limited_request_count + - subject_name + - total_request_count + default: total_request_count + api-insights-subject-name-substring: + name: subject_name_substring + in: query + description: Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. + required: false + schema: + type: string + api-insights-user-id: + name: user_id + in: path + description: The ID of the user to query for stats + required: true + schema: + type: string + api-insights-timestamp-increment: + name: timestamp_increment + description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) + in: query + required: true + schema: + type: string + api-insights-actor-name-substring: + name: actor_name_substring + in: query + description: Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. + required: false + schema: + type: string + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + in: path + required: true + schema: + type: integer + issue-field-id: + name: issue_field_id + description: The unique identifier of the issue field. + in: path + required: true + schema: + type: integer + issue-type-id: + name: issue_type_id + description: The unique identifier of the issue type. + in: path + required: true + schema: + type: integer + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + role-id: + name: role_id + description: The unique identifier of the role. + in: path + required: true + schema: + type: integer + personal-access-token-sort: + name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created_at + default: created_at + personal-access-token-owner: + name: owner + description: A list of owner usernames to use to filter the results. + in: query + required: false + schema: + type: array + maxItems: 10 + items: + type: string + example: owner[]=octocat1,owner[]=octocat2 + personal-access-token-repository: + name: repository + description: The name of the repository to use to filter the results. + in: query + required: false + schema: + type: string + example: Hello-World + personal-access-token-permission: + name: permission + description: The permission to use to filter the results. + in: query + required: false + schema: + type: string + example: issues_read + personal-access-token-before: + name: last_used_before + description: 'Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + personal-access-token-after: + name: last_used_after + description: 'Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + personal-access-token-token-id: + name: token_id + description: The ID of the token + in: query + required: false + schema: + type: array + maxItems: 50 + items: + type: string + example: token_id[]=1,token_id[]=2 + fine-grained-personal-access-token-id: + name: pat_id + description: The unique identifier of the fine-grained personal access token. + in: path + required: true + schema: + type: integer + custom-property-name: + name: custom_property_name + description: The custom property name + in: path + required: true + schema: + type: string + repository-id: + name: repository_id + description: The unique identifier of the repository. + in: path + required: true + schema: + type: integer + security-product: + name: security_product + in: path + description: The security feature to enable or disable. + required: true + schema: + type: string + enum: + - dependency_graph + - dependabot_alerts + - dependabot_security_updates + - advanced_security + - code_scanning_default_setup + - secret_scanning + - secret_scanning_push_protection + org-security-product-enablement: + name: enablement + in: path + description: |- + The action to take. + + `enable_all` means to enable the specified security feature for all repositories in the organization. + `disable_all` means to disable the specified security feature for all repositories in the organization. + required: true + schema: + type: string + enum: + - enable_all + - disable_all + examples: + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-full: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: github + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + twitter_username: github + is_verified: true + has_organization_projects: true + has_repository_projects: true + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + html_url: https://github.com/octocat + created_at: '2008-01-14T04:33:35Z' + type: Organization + total_private_repos: 100 + owned_private_repos: 100 + private_gists: 81 + disk_usage: 10000 + collaborators: 8 + billing_email: mona@github.com + plan: + name: Medium + space: 400 + private_repos: 20 + filled_seats: 4 + seats: 5 + default_repository_permission: read + default_repository_branch: main + members_can_create_repositories: true + two_factor_requirement_enabled: true + members_allowed_repository_creation_type: all + members_can_create_public_repositories: false + members_can_create_private_repositories: false + members_can_create_internal_repositories: false + members_can_create_pages: true + members_can_create_public_pages: true + members_can_create_private_pages: true + members_can_delete_repositories: true + members_can_change_repo_visibility: true + members_can_invite_outside_collaborators: true + members_can_delete_issues: false + display_commenter_full_name_setting_enabled: false + readers_can_create_discussions: true + members_can_create_teams: true + members_can_view_dependency_insights: true + members_can_fork_private_repositories: false + web_commit_signoff_required: false + updated_at: '2014-03-03T18:58:10Z' + deploy_keys_enabled_for_repositories: false + dependency_graph_enabled_for_new_repositories: false + dependabot_alerts_enabled_for_new_repositories: false + dependabot_security_updates_enabled_for_new_repositories: false + advanced_security_enabled_for_new_repositories: false + secret_scanning_enabled_for_new_repositories: false + secret_scanning_push_protection_enabled_for_new_repositories: false + secret_scanning_push_protection_custom_link: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md + secret_scanning_push_protection_custom_link_enabled: false + x-github-breaking-changes: + - changeset: remove_secret_scanning_custom_link_enablement_field + patch: + - op: remove + path: /value/secret_scanning_push_protection_custom_link_enabled + version: '2026-03-10' + artifact-deployment-record-list: + value: + total_count: 1 + deployment_records: + - id: 123 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: prod-deployment + tags: + data: sensitive + created: '2011-01-26T19:14:43Z' + updated_at: '2011-01-26T19:14:43Z' + attestation_id: 456 + bulk-subject-digest-body: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + bulk-subject-digest-body-with-predicate-type: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + predicateType: provenance + list-attestations-bulk: + value: + attestations_subject_digests: + - sha256:abc: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + organization-invitation-items: + value: + - id: 1 + login: monalisa + node_id: MDQ6VXNlcjE= + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + failed_at: '' + failed_reason: '' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams + invitation_source: member + org-hook-items: + value: + - id: 1 + url: https://api.github.com/orgs/octocat/hooks/1 + ping_url: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: https://api.github.com/orgs/octocat/hooks/1/deliveries + name: web + events: + - push + - pull_request + active: true + config: + url: http://example.com + content_type: json + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + type: Organization + org-hook: + value: + id: 1 + url: https://api.github.com/orgs/octocat/hooks/1 + ping_url: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: https://api.github.com/orgs/octocat/hooks/1/deliveries + name: web + events: + - push + - pull_request + active: true + config: + url: http://example.com + content_type: json + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + type: Organization + org-hook-2: + value: + id: 1 + url: https://api.github.com/orgs/octocat/hooks/1 + ping_url: https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries + name: web + events: + - pull_request + active: true + config: + url: http://example.com + content_type: json + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + type: Organization + webhook-config: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + hook-delivery-items: + value: + - id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: '2019-06-03T00:57:16Z' + - id: 123456789 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-04T00:57:16Z' + redelivery: true + duration: 0.28 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: null + hook-delivery: + value: + id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + url: https://www.example.com + throttled_at: '2019-06-03T00:57:16Z' + request: + headers: + X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + Accept: '*/*' + X-GitHub-Hook-ID: '42' + User-Agent: GitHub-Hookshot/b8c71d8 + X-GitHub-Event: issues + X-GitHub-Hook-Installation-Target-ID: '123' + X-GitHub-Hook-Installation-Target-Type: repository + content-type: application/json + X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + payload: + action: opened + issue: + body: foo + repository: + id: 123 + response: + headers: + Content-Type: text/html;charset=utf-8 + payload: ok + api-insights-route-stats: + value: + - http_method: GET + api_route: /repositories/:repository_id + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-subject-stats: + value: + - subject_type: installation + subject_id: 954453 + subject_name: GitHub Actions + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + api-insights-summary-stats: + value: + total_request_count: 34225 + rate_limited_request_count: 23 + api-insights-time-stats: + value: + - timestamp: '2024-09-11T15:00:00Z' + total_request_count: 34225 + rate_limited_request_count: 0 + - timestamp: '2024-09-11T15:05:00Z' + total_request_count: 10587 + rate_limited_request_count: 18 + - timestamp: '2024-09-11T15:10:00Z' + total_request_count: 43587 + rate_limited_request_count: 14 + - timestamp: '2024-09-11T15:15:00Z' + total_request_count: 19463 + rate_limited_request_count: 4 + - timestamp: '2024-09-11T15:20:00Z' + total_request_count: 60542 + rate_limited_request_count: 3 + - timestamp: '2024-09-11T15:25:00Z' + total_request_count: 55872 + rate_limited_request_count: 23 + api-insights-user-stats: + value: + - actor_type: oauth_app + actor_id: 954453 + actor_name: GitHub Actions + oauth_application_id: 1245 + total_request_count: 544665 + rate_limited_request_count: 13 + last_request_timestamp: '2024-09-18T15:43:03Z' + last_rate_limited_timestamp: '2024-09-18T06:30:09Z' + installation-paginated: + value: + total_count: 1 + installations: + - id: 25381 + account: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + repository_selection: selected + access_tokens_url: https://api.github.com/app/installations/25381/access_tokens + repositories_url: https://api.github.com/installation/repositories + html_url: https://github.com/organizations/octo-org/settings/installations/25381 + app_id: 2218 + target_id: 6811672 + target_type: Organization + permissions: + deployments: write + metadata: read + pull_requests: read + statuses: read + events: + - deployment + - deployment_status + created_at: '2017-05-16T08:47:09.000-07:00' + updated_at: '2017-06-06T11:23:23.000-07:00' + single_file_name: config.yml + has_multiple_single_files: true + single_file_paths: + - config.yml + - .github/issue_TEMPLATE.md + app_slug: github-actions + suspended_at: null + suspended_by: null + organization-invitation: + value: + id: 1 + login: monalisa + node_id: MDQ6VXNlcjE= + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams + invitation_source: member + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + issue-field-items: + value: + - id: 1 + node_id: IFT_kwDNAd3NAZo + name: Text field + description: DRI + data_type: text + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + - id: 2 + node_id: IFSS_kwDNAd3NAZs + name: Priority + description: Level of importance + data_type: single_select + options: + - id: 1 + name: High + color: red + - id: 2 + name: Medium + color: yellow + - id: 3 + name: Low + color: green + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + issue-field: + value: + id: 512 + node_id: IF_kwDNAd3NAZr + name: Priority + description: Level of importance for the issue + data_type: single_select + options: + - id: 1 + name: High + description: High priority + color: red + priority: 1 + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + - id: 2 + name: Medium + description: Medium priority + color: yellow + priority: 2 + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + - id: 3 + name: Low + description: Low priority + color: green + priority: 3 + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + created_at: '2025-01-15T10:30:15Z' + updated_at: '2025-01-15T10:30:15Z' + issue-type-items: + value: + - id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + - id: 411 + node_id: IT_kwDNAd3NAZs + name: Bug + description: An unexpected problem or behavior + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + issue-type: + value: + id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + org-membership-response-if-user-has-an-active-admin-membership-with-organization: + summary: Response if user has an active admin membership with organization + value: + url: https://api.github.com/orgs/octocat/memberships/defunkt + state: active + role: admin + organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + organization-role-list: + value: + total_count: 2 + roles: + - id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + - id: 8031 + name: Auditor + description: Permissions to read the organization audit log + permissions: + - read_audit_logs + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + organization-role: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + org-pat-grant-request-paginated: + value: + - id: 25381 + reason: I need to access the GitHub API + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository_selection: all + repositories_url: https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories + permissions: + organization: + members: read + repository: + metadata: read + created_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token + token_expired: false + token_expires_at: '2023-11-16T08:47:09.000-07:00' + token_last_used_at: null + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + org-pat-grant-paginated: + value: + - id: 25381 + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository_selection: all + repositories_url: https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories + permissions: + organization: + members: read + repository: + metadata: read + access_granted_at: '2023-05-16T08:47:09.000-07:00' + token_id: 98716 + token_name: Some Token + token_expired: false + token_expires_at: '2023-11-16T08:47:09.000-07:00' + token_last_used_at: null + custom-properties: + value: + - property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + values_editable_by: org_actors + require_explicit_values: true + - property_name: service + url: https://api.github.com/orgs/github/properties/schema/service + source_type: organization + value_type: string + - property_name: team + url: https://api.github.com/orgs/github/properties/schema/team + source_type: organization + value_type: string + description: Team owning the repository + custom-property: + value: + property_name: environment + url: https://api.github.com/orgs/github/properties/schema/environment + source_type: organization + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + org-repo-custom-property-values: + value: + - repository_id: 1296269 + repository_name: Hello-World + repository_full_name: octocat/Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + type: object + org-repo-update-custom-property-values: + value: + repository_names: + - Hello-World + - octo-repo + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + type: object + ruleset-history: + value: + - version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + - version_id: 2 + actor: + id: 2 + type: User + updated_at: '2024-09-23T16:29:47Z' + - version_id: 1 + actor: + id: 1 + type: User + updated_at: '2024-08-23T16:29:47Z' + org-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 21 + name: super cool ruleset + target: branch + source_type: Organization + source: my-org + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + team-simple-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/organizations/1/team/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: https://api.github.com/organizations/1/team/1/repos + type: organization + organization_id: 1 + public-repository-paginated: + value: + total_count: 1 + repositories: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + org-membership-items: + value: + - url: https://api.github.com/orgs/octocat/memberships/defunkt + state: active + role: admin + organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: [] + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - url: https://api.github.com/orgs/invitocat/memberships/defunkt + state: pending + role: admin + organization_url: https://api.github.com/orgs/invitocat + direct_membership: false + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + org-membership: + value: + url: https://api.github.com/orgs/invitocat/memberships/defunkt + state: pending + role: admin + organization_url: https://api.github.com/orgs/invitocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + org-membership-2: + value: + url: https://api.github.com/orgs/octocat/memberships/defunkt + state: active + role: admin + organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/packages.yaml b/provider-dev/source/packages.yaml new file mode 100644 index 0000000..1b467a4 --- /dev/null +++ b/provider-dev/source/packages.yaml @@ -0,0 +1,2410 @@ +openapi: 3.0.3 +info: + title: packages API + description: Manage packages for authenticated users and organizations. + version: 1.1.4 +paths: + /orgs/{org}/docker/conflicts: + get: + summary: Get list of conflicting packages during Docker migration for organization + description: |- + Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + tags: + - packages + operationId: packages/list-docker-migration-conflicting-packages-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-org' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages: + get: + summary: List packages for an organization + description: |- + Lists packages in an organization readable by the user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/list-packages-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#list-packages-for-an-organization + parameters: + - name: package_type + description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + in: query + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-visibility' + - name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + - name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-org' + '400': + $ref: '#/components/responses/package_es_list_error' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}: + get: + summary: Get a package for an organization + description: |- + Gets a specific package in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/package-org' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package for an organization + description: |- + Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. + + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/restore: + post: + summary: Restore a package for an organization + description: |- + Restores an entire package in an organization. + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - name: token + description: package token + schema: + type: string + required: false + in: query + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/versions: + get: + summary: List package versions for a package owned by an organization + description: |- + Lists package versions for a package owned by an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-all-package-versions-for-package-owned-by-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-versions-for-org' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}: + get: + summary: Get a package version for an organization + description: |- + Gets a specific package version in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-version-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-version-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-version-org' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete package version for an organization + description: |- + Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. + + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: + post: + summary: Restore package version for an organization + description: |- + Restores a specific package version in an organization. + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/docker/conflicts: + get: + summary: Get list of conflicting packages during Docker migration for authenticated-user + description: |- + Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + tags: + - packages + operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages: + get: + summary: List packages for the authenticated user's namespace + description: |- + Lists packages owned by the authenticated user within the user's namespace. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/list-packages-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace + parameters: + - name: package_type + description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + in: query + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + - $ref: '#/components/parameters/package-visibility' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + '400': + $ref: '#/components/responses/package_es_list_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}: + get: + summary: Get a package for the authenticated user + description: |- + Gets a specific package for a package owned by the authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/package-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package for the authenticated user + description: |- + Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/restore: + post: + summary: Restore a package for the authenticated user + description: |- + Restores a package owned by the authenticated user. + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - name: token + description: package token + schema: + type: string + required: false + in: query + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/versions: + get: + summary: List package versions for a package owned by the authenticated user + description: |- + Lists package versions for a package owned by the authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-versions-for-authenticated-user' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/versions/{package_version_id}: + get: + summary: Get a package version for the authenticated user + description: |- + Gets a specific package version for a package owned by the authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-version-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-version-authenticated-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package version for the authenticated user + description: |- + Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. + + The authenticated user must have admin permissions in the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-version-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: + post: + summary: Restore a package version for the authenticated user + description: |- + Restores a package version owned by the authenticated user. + + You can restore a deleted package version under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-version-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/docker/conflicts: + get: + summary: Get list of conflicting packages during Docker migration for user + description: |- + Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + tags: + - packages + operationId: packages/list-docker-migration-conflicting-packages-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages: + get: + summary: List packages for a user + description: |- + Lists all packages in a user's namespace for which the requesting user has access. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/list-packages-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#list-packages-for-a-user + parameters: + - name: package_type + description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + in: query + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + - $ref: '#/components/parameters/package-visibility' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/packages-for-user' + '400': + $ref: '#/components/responses/package_es_list_error' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}: + get: + summary: Get a package for a user + description: |- + Gets a specific package metadata for a public package owned by a user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package' + examples: + default: + $ref: '#/components/examples/package-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete a package for a user + description: |- + Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. + + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/restore: + post: + summary: Restore a package for a user + description: |- + Restores an entire package for a user. + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + - name: token + description: package token + schema: + type: string + required: false + in: query + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/versions: + get: + summary: List package versions for a package owned by a user + description: |- + Lists package versions for a public package owned by a specified user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-all-package-versions-for-package-owned-by-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-versions-for-user' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}: + get: + summary: Get a package version for a user + description: |- + Gets a specific package version for a public package owned by a specified user. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/get-package-version-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/package-version-id' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/package-version' + examples: + default: + $ref: '#/components/examples/package-version-user' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + delete: + summary: Delete package version for a user + description: |- + Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. + + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/delete-package-version-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages + /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: + post: + summary: Restore package version for a user + description: |- + Restores a specific package version for a user. + + You can restore a deleted package under the following conditions: + - The package was deleted within the last 30 days. + - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. + + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + tags: + - packages + operationId: packages/restore-package-version-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user + parameters: + - $ref: '#/components/parameters/package-type' + - $ref: '#/components/parameters/package-name' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/package-version-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: packages + subcategory: packages + x-stackQL-resource: packages +components: + schemas: + package: + title: Package + description: A software package + type: object + properties: + id: + description: Unique identifier of the package. + type: integer + example: 1 + name: + description: The name of the package. + type: string + example: super-linter + package_type: + type: string + example: docker + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + url: + type: string + example: https://api.github.com/orgs/github/packages/container/super-linter + html_url: + type: string + example: https://github.com/orgs/github/packages/container/package/super-linter + version_count: + description: The number of versions of the package. + type: integer + example: 1 + visibility: + type: string + example: private + enum: + - private + - public + owner: + $ref: '#/components/schemas/nullable-simple-user' + repository: + $ref: '#/components/schemas/nullable-minimal-repository' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - name + - package_type + - visibility + - url + - html_url + - version_count + - created_at + - updated_at + package-version: + title: Package Version + description: A version of a software package + type: object + properties: + id: + description: Unique identifier of the package version. + type: integer + example: 1 + name: + description: The name of the package version. + type: string + example: latest + url: + type: string + example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 + package_html_url: + type: string + example: https://github.com/orgs/github/packages/container/package/super-linter + html_url: + type: string + example: https://github.com/orgs/github/packages/container/super-linter/786068 + license: + type: string + example: MIT + description: + type: string + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + deleted_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + metadata: + type: object + title: Package Version Metadata + properties: + package_type: + type: string + example: docker + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + container: + type: object + title: Container Metadata + properties: + tags: + type: array + items: + type: string + required: + - tags + docker: + type: object + title: Docker Metadata + properties: + tag: + type: array + items: + type: string + required: + - tags + required: + - package_type + required: + - id + - name + - url + - package_html_url + - created_at + - updated_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + responses: + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + package_es_list_error: + description: The value of `per_page` multiplied by `page` cannot be greater than 10000. + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + package-visibility: + name: visibility + description: |- + The selected visibility of the packages. This parameter is optional and only filters an existing result set. + + The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + in: query + required: false + schema: + type: string + enum: + - public + - private + - internal + package-type: + name: package_type + description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. + in: path + required: true + schema: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + package-name: + name: package_name + description: The name of the package. + in: path + required: true + schema: + type: string + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + package-version-id: + name: package_version_id + description: Unique identifier of the package version. + in: path + required: true + schema: + type: integer + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + packages-for-org: + value: + - id: 197 + name: hello_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + version_count: 1 + visibility: private + url: https://api.github.com/orgs/github/packages/container/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/package/hello_docker + - id: 198 + name: goodbye_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + version_count: 2 + visibility: private + url: https://api.github.com/orgs/github/packages/container/goodbye_docker + created_at: '2020-05-20T22:19:11Z' + updated_at: '2020-05-20T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/package/goodbye_docker + package-org: + value: + id: 197 + name: hello_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + site_admin: false + version_count: 1 + visibility: private + url: https://api.github.com/orgs/github/packages/container/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/package/hello_docker + package-versions-for-org: + value: + - id: 245301 + name: 1.0.4 + url: https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/245301 + package_html_url: https://github.com/octo-org/hello-world-npm/packages/43752 + created_at: '2019-11-05T22:49:04Z' + updated_at: '2019-11-05T22:49:04Z' + html_url: https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.4 + metadata: + package_type: npm + - id: 209672 + name: 1.0.3 + url: https://api.github.com/orgs/octo-org/packages/npm/hello-world-npm/versions/209672 + package_html_url: https://github.com/octo-org/hello-world-npm/packages/43752 + created_at: '2019-10-29T15:42:11Z' + updated_at: '2019-10-29T15:42:12Z' + html_url: https://github.com/octo-org/hello-world-npm/packages/43752?version=1.0.3 + metadata: + package_type: npm + package-version-org: + value: + id: 836 + name: sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 + url: https://api.github.com/orgs/github/packages/container/hello_docker/versions/836 + package_html_url: https://github.com/orgs/github/packages/container/package/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/hello_docker/836 + metadata: + package_type: container + container: + tags: + - latest + packages-for-user: + value: + - id: 197 + name: hello_docker + package_type: container + owner: + login: octocat + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.octocatusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: User + site_admin: false + version_count: 1 + visibility: private + url: https://api.github.com/orgs/github/packages/container/hello_docker + created_at: '2020-05-19T22:19:11Z' + updated_at: '2020-05-19T22:19:11Z' + html_url: https://github.com/orgs/github/packages/container/package/hello_docker + - id: 198 + name: goodbye_docker + package_type: container + owner: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: User + site_admin: false + version_count: 2 + visibility: private + url: https://api.github.com/user/octocat/packages/container/goodbye_docker + created_at: '2020-05-20T22:19:11Z' + updated_at: '2020-05-20T22:19:11Z' + html_url: https://github.com/user/octocat/packages/container/package/goodbye_docker + package-user: + value: + id: 40201 + name: octo-name + package_type: rubygems + owner: + login: octocat + id: 209477 + node_id: MDQ6VXNlcjIwOTQ3Nw== + avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + version_count: 3 + visibility: public + url: https://api.github.com/users/octocat/packages/rubygems/octo-name + created_at: '2019-10-20T14:17:14Z' + updated_at: '2019-10-20T14:17:14Z' + repository: + id: 216219492 + node_id: MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI= + name: octo-name-repo + full_name: octocat/octo-name-repo + private: false + owner: + login: octocat + id: 209477 + node_id: MDQ6VXNlcjIwOTQ3Nw== + avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + html_url: https://github.com/octocat/octo-name-repo + description: Project for octocats + fork: false + url: https://api.github.com/repos/octocat/octo-name-repo + forks_url: https://api.github.com/repos/octocat/octo-name-repo/forks + keys_url: https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id} + collaborators_url: https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octocat/octo-name-repo/teams + hooks_url: https://api.github.com/repos/octocat/octo-name-repo/hooks + issue_events_url: https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number} + events_url: https://api.github.com/repos/octocat/octo-name-repo/events + assignees_url: https://api.github.com/repos/octocat/octo-name-repo/assignees{/user} + branches_url: https://api.github.com/repos/octocat/octo-name-repo/branches{/branch} + tags_url: https://api.github.com/repos/octocat/octo-name-repo/tags + blobs_url: https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha} + trees_url: https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha} + statuses_url: https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha} + languages_url: https://api.github.com/repos/octocat/octo-name-repo/languages + stargazers_url: https://api.github.com/repos/octocat/octo-name-repo/stargazers + contributors_url: https://api.github.com/repos/octocat/octo-name-repo/contributors + subscribers_url: https://api.github.com/repos/octocat/octo-name-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/octo-name-repo/subscription + commits_url: https://api.github.com/repos/octocat/octo-name-repo/commits{/sha} + git_commits_url: https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha} + comments_url: https://api.github.com/repos/octocat/octo-name-repo/comments{/number} + issue_comment_url: https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number} + contents_url: https://api.github.com/repos/octocat/octo-name-repo/contents/{+path} + compare_url: https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head} + merges_url: https://api.github.com/repos/octocat/octo-name-repo/merges + archive_url: https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octocat/octo-name-repo/downloads + issues_url: https://api.github.com/repos/octocat/octo-name-repo/issues{/number} + pulls_url: https://api.github.com/repos/octocat/octo-name-repo/pulls{/number} + milestones_url: https://api.github.com/repos/octocat/octo-name-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octocat/octo-name-repo/labels{/name} + releases_url: https://api.github.com/repos/octocat/octo-name-repo/releases{/id} + deployments_url: https://api.github.com/repos/octocat/octo-name-repo/deployments + html_url: https://github.com/octocat/octo-name-repo/packages/40201 + package-versions-for-authenticated-user: + value: + - id: 45763 + name: sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9 + url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763 + package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker + created_at: '2020-09-11T21:56:40Z' + updated_at: '2021-02-05T21:32:32Z' + html_url: https://github.com/users/octocat/packages/container/hello_docker/45763 + metadata: + package_type: container + container: + tags: + - latest + - id: 881 + name: sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 + url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/881 + package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker + created_at: '2020-05-21T22:22:20Z' + updated_at: '2021-02-05T21:32:32Z' + html_url: https://github.com/users/octocat/packages/container/hello_docker/881 + metadata: + package_type: container + container: + tags: [] + package-version-authenticated-user: + value: + id: 214 + name: sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a + url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/214 + package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker + created_at: '2020-05-15T03:46:45Z' + updated_at: '2020-05-15T03:46:45Z' + html_url: https://github.com/users/octocat/packages/container/hello_docker/214 + metadata: + package_type: container + container: + tags: + - 1.13.6 + package-versions-for-user: + value: + - id: 3497268 + name: 0.3.0 + url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/3497268 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2020-08-31T15:22:11Z' + updated_at: '2020-08-31T15:22:12Z' + description: Project for octocats + html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.3.0 + metadata: + package_type: rubygems + - id: 387039 + name: 0.2.0 + url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2019-12-01T20:49:29Z' + updated_at: '2019-12-01T20:49:30Z' + description: Project for octocats + html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 + metadata: + package_type: rubygems + - id: 169770 + name: 0.1.0 + url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/169770 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2019-10-20T14:17:14Z' + updated_at: '2019-10-20T14:17:15Z' + html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.1.0 + metadata: + package_type: rubygems + package-version-user: + value: + id: 387039 + name: 0.2.0 + url: https://api.github.com/users/octocat/packages/rubygems/octo-name/versions/387039 + package_html_url: https://github.com/octocat/octo-name-repo/packages/40201 + license: MIT + created_at: '2019-12-01T20:49:29Z' + updated_at: '2019-12-01T20:49:30Z' + description: Octo-name client for Ruby + html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 + metadata: + package_type: rubygems +servers: + - url: https://api.github.com diff --git a/provider-dev/source/private_registries.yaml b/provider-dev/source/private_registries.yaml new file mode 100644 index 0000000..eff1319 --- /dev/null +++ b/provider-dev/source/private_registries.yaml @@ -0,0 +1,853 @@ +openapi: 3.0.3 +info: + title: private_registries API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/private-registries: + get: + summary: List private registries for an organization + description: |- + + Lists all private registry configurations available at the organization-level without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/list-org-private-registries + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - configurations + properties: + total_count: + type: integer + configurations: + type: array + items: + $ref: '#/components/schemas/org-private-registry-configuration' + examples: + default: + $ref: '#/components/examples/org-private-registry-configurations-paginated' + headers: + Link: + $ref: '#/components/headers/link' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + post: + summary: Create a private registry for an organization + description: |- + + Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/create-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + type: string + nullable: true + replaces_base: + description: Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types. + type: string + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + description: The ID of the key you used to encrypt the secret. Required when `auth_type` is `token` or `username_password`. Should be omitted for OIDC auth types. + type: string + visibility: + description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. Defaults to `token` if not specified. Use `oidc_azure`, `oidc_aws`, or `oidc_jfrog` for OIDC authentication. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + tenant_id: + description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. + type: string + required: + - registry_type + - url + - visibility + examples: + org-private-registry-with-private-visibility: + summary: Example of a private registry configuration with private visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + replaces_base: true + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: private + org-private-registry-with-selected-visibility: + summary: Example of a private registry configuration with selected visibility + value: + registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + org-private-registry-with-oidc-azure: + summary: Example of an OIDC private registry configuration using Azure + value: + registry_type: docker_registry + url: https://myregistry.azurecr.io + auth_type: oidc_azure + visibility: all + tenant_id: 12345678-1234-1234-1234-123456789012 + client_id: abcdef01-2345-6789-abcd-ef0123456789 + responses: + '201': + description: The organization private registry configuration + content: + application/json: + schema: + $ref: '#/components/schemas/org-private-registry-configuration-with-selected-repositories' + examples: + org-private-registry-with-selected-visibility: + $ref: '#/components/examples/org-private-registry-configuration' + org-private-registry-with-private-visibility: + $ref: '#/components/examples/org-private-registry-configuration-with-selected-repositories' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + /orgs/{org}/private-registries/public-key: + get: + summary: Get private registries public key for an organization + description: |- + + Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - key_id + - key + properties: + key_id: + description: The identifier for the key. + example: '012345678912345678' + type: string + key: + description: The Base64 encoded public key. + example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + type: string + examples: + default: + $ref: '#/components/examples/private-registries-public-key' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + /orgs/{org}/private-registries/{secret_name}: + get: + summary: Get a private registry for an organization + description: |- + + Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/get-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '200': + description: The specified private registry configuration for the organization + content: + application/json: + schema: + $ref: '#/components/schemas/org-private-registry-configuration' + examples: + default: + $ref: '#/components/examples/org-private-registry-configuration' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + patch: + summary: Update a private registry for an organization + description: |- + + Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/update-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + registry_type: + description: The registry type. + type: string + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + type: string + nullable: true + replaces_base: + description: Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + type: boolean + default: false + encrypted_value: + description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. + type: string + pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$ + key_id: + description: The ID of the key you used to encrypt the secret. + type: string + visibility: + description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + type: string + enum: + - all + - private + - selected + selected_repository_ids: + description: An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. + type: array + items: + type: integer + auth_type: + description: The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration. + type: string + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + tenant_id: + description: The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. + type: string + client_id: + description: The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`. + type: string + aws_region: + description: The AWS region. Required when `auth_type` is `oidc_aws`. + type: string + account_id: + description: The AWS account ID. Required when `auth_type` is `oidc_aws`. + type: string + role_name: + description: The AWS IAM role name. Required when `auth_type` is `oidc_aws`. + type: string + domain: + description: The CodeArtifact domain. Required when `auth_type` is `oidc_aws`. + type: string + domain_owner: + description: The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`. + type: string + audience: + description: The OIDC audience. Optional for `oidc_aws` and `oidc_jfrog` auth types. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. Optional for `oidc_jfrog` auth type. + type: string + examples: + secret-based-update: + summary: Update a secret-based private registry + value: + username: monalisa + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + oidc-azure-update: + summary: Update an OIDC private registry (Azure) + value: + tenant_id: 12345678-1234-1234-1234-123456789012 + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations + delete: + summary: Delete a private registry for an organization + description: |- + + Delete a private registry configuration at the organization-level. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - private-registries + operationId: private-registries/delete-org-private-registry + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-name' + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: private-registries + subcategory: organization-configurations + x-stackQL-resource: organization_configurations +components: + schemas: + org-private-registry-configuration: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + example: MAVEN_REPOSITORY_SECRET + type: string + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private registry. + example: monalisa + type: string + nullable: true + replaces_base: + description: Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access to the private registry. + enum: + - all + - private + - selected + type: string + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + org-private-registry-configuration-with-selected-repositories: + title: Organization private registry + description: Private registry configuration for an organization + type: object + properties: + name: + description: The name of the private registry configuration. + example: MAVEN_REPOSITORY_SECRET + type: string + registry_type: + description: The registry type. + enum: + - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + auth_type: + description: The authentication type for the private registry. + enum: + - token + - username_password + - oidc_azure + - oidc_aws + - oidc_jfrog + type: string + url: + description: The URL of the private registry. + type: string + format: uri + username: + description: The username to use when authenticating with the private registry. + example: monalisa + type: string + replaces_base: + description: Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + type: boolean + default: false + visibility: + description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + enum: + - all + - private + - selected + type: string + selected_repository_ids: + type: array + description: An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. + items: + type: integer + tenant_id: + description: The tenant ID of the Azure AD application. + type: string + client_id: + description: The client ID of the Azure AD application. + type: string + aws_region: + description: The AWS region. + type: string + account_id: + description: The AWS account ID. + type: string + role_name: + description: The AWS IAM role name. + type: string + domain: + description: The CodeArtifact domain. + type: string + domain_owner: + description: The CodeArtifact domain owner. + type: string + jfrog_oidc_provider_name: + description: The JFrog OIDC provider name. + type: string + audience: + description: The OIDC audience. + type: string + identity_mapping_name: + description: The JFrog identity mapping name. + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - name + - registry_type + - visibility + - created_at + - updated_at + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + secret-name: + name: secret_name + description: The name of the secret. + in: path + required: true + schema: + type: string + examples: + org-private-registry-configurations-paginated: + value: + total_count: 1 + configurations: + - name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + visibility: selected + org-private-registry-configuration: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: private + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + org-private-registry-configuration-with-selected-repositories: + value: + name: MAVEN_REPOSITORY_SECRET + registry_type: maven_repository + username: monalisa + visibility: selected + selected_repository_ids: + - 1296269 + - 1296280 + created_at: '2019-08-10T14:59:22Z' + updated_at: '2020-01-10T14:59:22Z' + private-registries-public-key: + value: + key_id: '012345678912345678' + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/projects.yaml b/provider-dev/source/projects.yaml new file mode 100644 index 0000000..7337afa --- /dev/null +++ b/provider-dev/source/projects.yaml @@ -0,0 +1,6239 @@ +openapi: 3.0.3 +info: + title: projects API + description: Endpoints to manage Projects using the REST API. + version: 1.1.4 +paths: + /orgs/{org}/projectsV2: + get: + summary: List projects for organization + description: List all projects owned by a specific organization accessible by the authenticated user. + tags: + - projects + operationId: projects/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#list-projects-for-organization + parameters: + - $ref: '#/components/parameters/org' + - name: q + description: Limit results to projects of the specified type. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /orgs/{org}/projectsV2/{project_number}: + get: + summary: Get project for organization + description: Get a specific organization-owned project. + tags: + - projects + operationId: projects/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /orgs/{org}/projectsV2/{project_number}/drafts: + post: + summary: Create draft item for organization owned project + description: Create draft issue item for the specified organization owned project. + tags: + - projects + operationId: projects/create-draft-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: Details of the draft item to create in the project. + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the draft issue item to create in the project. + body: + type: string + description: The body content of the draft issue item to create in the project. + required: + - title + examples: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + draft_issue: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts + x-stackQL-resource: drafts + /orgs/{org}/projectsV2/{project_number}/fields: + get: + summary: List project fields for organization + description: List all fields for a specific organization-owned project. + tags: + - projects + operationId: projects/list-fields-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + single_select_options: + type: array + description: The options available for single select fields. At least one option must be provided when creating a single select field. + items: + $ref: '#/components/schemas/projects-v2-field-single-select-option' + iteration_configuration: + $ref: '#/components/schemas/projects-v2-field-iteration-configuration' + required: + - issue_field_id + - name + - data_type + - single_select_options + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select-request' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration-request' + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + text_field: + $ref: '#/components/examples/projects-v2-field-text' + number_field: + $ref: '#/components/examples/projects-v2-field-number' + date_field: + $ref: '#/components/examples/projects-v2-field-date' + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /orgs/{org}/projectsV2/{project_number}/fields/{field_id}: + get: + summary: Get project field for organization + description: Get a specific field for an organization-owned project. + tags: + - projects + operationId: projects/get-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/field-id' + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /orgs/{org}/projectsV2/{project_number}/items: + get: + summary: List items for an organization owned project + description: List all items for a specific organization-owned project accessible by the authenticated user. + tags: + - projects + operationId: projects/list-items-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - name: q + description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + in: query + required: false + schema: + type: string + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + post: + summary: Add item to organization owned project + description: Add an issue or pull request item to the specified organization owned project. + tags: + - projects + operationId: projects/add-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + - id + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, and issue number + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, name, and PR number + value: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /orgs/{org}/projectsV2/{project_number}/items/{item_id}: + get: + summary: Get an item for an organization owned project + description: Get a specific item from an organization-owned project. + tags: + - projects + operationId: projects/get-org-item + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/item-id' + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + patch: + summary: Update project item for organization + description: Update a specific item in an organization-owned project. + tags: + - projects + operationId: projects/update-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#update-project-item-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/item-id' + requestBody: + required: true + description: Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: |- + The new value for the field: + - For text, number, and date fields, provide the new value directly. + - For single select and iteration fields, provide the ID of the option or iteration. + - To clear the field, set this to null. + nullable: true + oneOf: + - type: string + - type: number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + text_field: + $ref: '#/components/examples/projects-v2-item-with-content' + number_field: + $ref: '#/components/examples/projects-v2-item-with-content' + date_field: + $ref: '#/components/examples/projects-v2-item-with-content' + single_select_field: + $ref: '#/components/examples/projects-v2-item-with-content' + iteration_field: + $ref: '#/components/examples/projects-v2-item-with-content' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + delete: + summary: Delete project item for organization + description: Delete a specific item from an organization-owned project. + tags: + - projects + operationId: projects/delete-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/item-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /orgs/{org}/projectsV2/{project_number}/views: + post: + summary: Create a view for an organization-owned project + description: Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + example: Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + example: board + filter: + type: string + description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + example: is:issue is:open + visible_fields: + type: array + description: |- + `visible_fields` is not applicable to `roadmap` layout views. + For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + items: + type: integer + example: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in an organization-owned project. + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-view' + examples: + table_view: + summary: Response for creating a table view + value: + $ref: '#/components/examples/projects-v2-view' + board_view: + summary: Response for creating a board view with filter + value: + $ref: '#/components/examples/projects-v2-view' + roadmap_view: + summary: Response for creating a roadmap view + value: + $ref: '#/components/examples/projects-v2-view' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + description: Service unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: views + x-stackQL-resource: views + /orgs/{org}/projectsV2/{project_number}/views/{view_number}/items: + get: + summary: List items for an organization project view + description: List items in an organization project with the saved view's filter applied. + tags: + - projects + operationId: projects/list-view-items-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/view-number' + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the + title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /user/{user_id}/projectsV2/{project_number}/drafts: + post: + summary: Create draft item for user owned project + description: Create draft issue item for the specified user owned project. + tags: + - projects + operationId: projects/create-draft-item-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project + parameters: + - $ref: '#/components/parameters/user-id' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: Details of the draft item to create in the project. + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the draft issue item to create in the project. + body: + type: string + description: The body content of the draft issue item to create in the project. + required: + - title + examples: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + draft_issue: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts + x-stackQL-resource: drafts + /users/{user_id}/projectsV2/{project_number}/views: + post: + summary: Create a view for a user-owned project + description: Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project + parameters: + - $ref: '#/components/parameters/user-id' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + example: Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + example: board + filter: + type: string + description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + example: is:issue is:open + visible_fields: + type: array + description: |- + `visible_fields` is not applicable to `roadmap` layout views. + For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + items: + type: integer + example: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in a user-owned project. + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-view' + examples: + table_view: + summary: Response for creating a table view + value: + $ref: '#/components/examples/projects-v2-view' + board_view: + summary: Response for creating a board view with filter + value: + $ref: '#/components/examples/projects-v2-view' + roadmap_view: + summary: Response for creating a roadmap view + value: + $ref: '#/components/examples/projects-v2-view' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '503': + description: Service unavailable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: views + x-stackQL-resource: views + /users/{username}/projectsV2: + get: + summary: List projects for user + description: List all projects owned by a specific user accessible by the authenticated user. + tags: + - projects + operationId: projects/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#list-projects-for-user + parameters: + - $ref: '#/components/parameters/username' + - name: q + description: Limit results to projects of the specified type. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /users/{username}/projectsV2/{project_number}: + get: + summary: Get project for user + description: Get a specific user-owned project. + tags: + - projects + operationId: projects/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2' + examples: + default: + $ref: '#/components/examples/projects-v2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + x-stackQL-resource: projects + /users/{username}/projectsV2/{project_number}/fields: + get: + summary: List project fields for user + description: List all fields for a specific user-owned project. + tags: + - projects + operationId: projects/list-fields-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + single_select_options: + type: array + description: The options available for single select fields. At least one option must be provided when creating a single select field. + items: + $ref: '#/components/schemas/projects-v2-field-single-select-option' + iteration_configuration: + $ref: '#/components/schemas/projects-v2-field-iteration-configuration' + required: + - name + - data_type + - single_select_options + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select-request' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration-request' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + text_field: + $ref: '#/components/examples/projects-v2-field-text' + number_field: + $ref: '#/components/examples/projects-v2-field-number' + date_field: + $ref: '#/components/examples/projects-v2-field-date' + single_select_field: + $ref: '#/components/examples/projects-v2-field-single-select' + iteration_field: + $ref: '#/components/examples/projects-v2-field-iteration' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /users/{username}/projectsV2/{project_number}/fields/{field_id}: + get: + summary: Get project field for user + description: Get a specific field for a user-owned project. + tags: + - projects + operationId: projects/get-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#get-project-field-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/field-id' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-field' + examples: + default: + $ref: '#/components/examples/projects-v2-field' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + x-stackQL-resource: fields + /users/{username}/projectsV2/{project_number}/items: + get: + summary: List items for a user owned project + description: List all items for a specific user-owned project accessible by the authenticated user. + tags: + - projects + operationId: projects/list-items-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + - name: q + description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + in: query + required: false + schema: + type: string + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + post: + summary: Add item to user owned project + description: Add an issue or pull request item to the specified user owned project. + tags: + - projects + operationId: projects/add-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/project-number' + requestBody: + required: true + description: Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + - id + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-simple' + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + $ref: '#/components/examples/projects-v2-item-simple' + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, and issue number + value: + $ref: '#/components/examples/projects-v2-item-simple' + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, name, and PR number + value: + $ref: '#/components/examples/projects-v2-item-simple' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /users/{username}/projectsV2/{project_number}/items/{item_id}: + get: + summary: Get an item for a user owned project + description: Get a specific item from a user-owned project. + tags: + - projects + operationId: projects/get-user-item + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/item-id' + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + patch: + summary: Update project item for user + description: Update a specific item in a user-owned project. + tags: + - projects + operationId: projects/update-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#update-project-item-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/item-id' + requestBody: + required: true + description: Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: |- + The new value for the field: + - For text, number, and date fields, provide the new value directly. + - For single select and iteration fields, provide the ID of the option or iteration. + - To clear the field, set this to null. + nullable: true + oneOf: + - type: string + - type: number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + text_field: + $ref: '#/components/examples/projects-v2-item-with-content' + number_field: + $ref: '#/components/examples/projects-v2-item-with-content' + date_field: + $ref: '#/components/examples/projects-v2-item-with-content' + single_select_field: + $ref: '#/components/examples/projects-v2-item-with-content' + iteration_field: + $ref: '#/components/examples/projects-v2-item-with-content' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + delete: + summary: Delete project item for user + description: Delete a specific item from a user-owned project. + tags: + - projects + operationId: projects/delete-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#delete-project-item-for-user + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/item-id' + responses: + '204': + description: Response + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + x-stackQL-resource: items + /users/{username}/projectsV2/{project_number}/views/{view_number}/items: + get: + summary: List items for a user project view + description: List items in a user project with the saved view's filter applied. + tags: + - projects + operationId: projects/list-view-items-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view + parameters: + - $ref: '#/components/parameters/project-number' + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/view-number' + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the + title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/projects-v2-item-with-content' + examples: + default: + $ref: '#/components/examples/projects-v2-item-with-content' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: items + x-stackQL-resource: items +components: + schemas: + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + description: The unique identifier of the project. + node_id: + type: string + description: The node ID of the project. + owner: + $ref: '#/components/schemas/simple-user' + creator: + $ref: '#/components/schemas/simple-user' + title: + type: string + description: The project title. + description: + type: string + nullable: true + description: A short description of the project. + public: + type: boolean + description: Whether the project is visible to anyone with access to the owner. + closed_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the project was closed. + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the project was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the project was last updated. + number: + type: integer + description: The project number. + short_description: + type: string + nullable: true + description: A concise summary of the project. + deleted_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the project was deleted. + deleted_by: + $ref: '#/components/schemas/nullable-simple-user' + state: + type: string + enum: + - open + - closed + description: The current state of the project. + latest_status_update: + $ref: '#/components/schemas/nullable-projects-v2-status-update' + is_template: + type: boolean + description: Whether this project is a template + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + projects-v2-item-simple: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + content: + description: The content represented by the item. + title: Issue + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + auto_merge: + $ref: '#/components/schemas/auto-merge' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + - _links + - base + - body + - commits_url + - diff_url + - head + - issue_url + - merge_commit_sha + - merged_at + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + content_type: + $ref: '#/components/schemas/projects-v2-item-content-type' + creator: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the item was archived. + project_url: + type: string + format: uri + description: The URL of the project this item belongs to. + item_url: + type: string + format: uri + description: The URL of the item in the project. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-field: + title: Projects v2 Field + description: A field inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the field. + issue_field_id: + type: integer + description: The ID of the issue field. + node_id: + type: string + description: The node ID of the field. + project_url: + type: string + description: The API URL of the project that contains the field. + example: https://api.github.com/projects/1 + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - assignees + - linked_pull_requests + - reviewers + - labels + - milestone + - repository + - title + - text + - single_select + - number + - date + - iteration + - issue_type + - parent_issue + - sub_issues_progress + options: + type: array + description: The options available for single select fields. + items: + $ref: '#/components/schemas/projects-v2-single-select-options' + configuration: + type: object + description: Configuration for iteration fields. + properties: + start_day: + type: integer + description: The day of the week when the iteration starts. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + items: + $ref: '#/components/schemas/projects-v2-iteration-settings' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the field was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the field was last updated. + required: + - id + - name + - data_type + - created_at + - updated_at + - project_url + projects-v2-field-single-select-option: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + additionalProperties: false + projects-v2-field-iteration-configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. Individual iterations can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + additionalProperties: false + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + projects-v2-item-with-content: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + project_url: + type: string + format: uri + example: https://api.github.com/users/monalisa/2/projectsV2/3 + description: The API URL of the project that contains this item. + content_type: + $ref: '#/components/schemas/projects-v2-item-content-type' + content: + type: object + additionalProperties: true + nullable: true + description: The content of the item, which varies by content type. + creator: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the item was archived. + item_url: + type: string + format: uri + example: https://api.github.com/users/monalisa/2/projectsV2/items/3 + nullable: true + description: The API URL of this item. + fields: + type: array + items: + type: object + additionalProperties: true + description: The fields and values associated with this item. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-view: + title: Projects v2 View + description: A view inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the view. + number: + type: integer + description: The number of the view within the project. + name: + type: string + description: The name of the view. + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + node_id: + type: string + description: The node ID of the view. + project_url: + type: string + description: The API URL of the project that contains the view. + example: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: + type: string + format: uri + description: The web URL of the view. + example: https://github.com/orgs/octocat/projects/1/views/1 + creator: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the view was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the view was last updated. + filter: + type: string + nullable: true + description: The filter query for the view. + example: is:issue is:open + visible_fields: + type: array + description: The list of field IDs that are visible in the view. + items: + type: integer + sort_by: + type: array + description: The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". + items: + type: array + minItems: 2 + maxItems: 2 + items: + oneOf: + - type: integer + - type: string + group_by: + type: array + description: The list of field IDs used for horizontal grouping. + items: + type: integer + vertical_group_by: + type: array + description: The list of field IDs used for vertical grouping (board layout). + items: + type: integer + required: + - id + - number + - name + - layout + - node_id + - project_url + - html_url + - creator + - created_at + - updated_at + - visible_fields + - sort_by + - group_by + - vertical_group_by + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the status update. + node_id: + type: string + description: The node ID of the status update. + project_node_id: + type: string + description: The node ID of the project that this status update belongs to. + creator: + $ref: '#/components/schemas/simple-user' + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the status update was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the status update was last updated. + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + description: The current status. + start_date: + type: string + format: date + example: '2022-04-28' + description: The start date of the period covered by the update. + target_date: + type: string + format: date + example: '2022-04-28' + description: The target date associated with the update. + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at + nullable: true + issue: + title: Issue + description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue + example: https://api.github.com/repositories/42/issues/1 + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + number: + description: Number uniquely identifying the issue within its repository + example: 42 + type: integer + state: + description: State of the issue; either 'open' or 'closed' + example: open + type: string + state_reason: + description: The reason for the current state + example: not_planned + type: string + nullable: true + enum: + - completed + - reopened + - not_planned + - duplicate + title: + description: Title of the issue + example: Widget creation fails in Safari on OS X 10.8 + type: string + body: + description: Contents of the issue + example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? + type: string + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository + example: + - bug + - registration + type: array + items: + oneOf: + - type: string + - type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + format: uri + name: + type: string + description: + type: string + nullable: true + color: + type: string + nullable: true + default: + type: boolean + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: string + format: date-time + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + $ref: '#/components/schemas/nullable-simple-user' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + repository: + $ref: '#/components/schemas/repository' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + x-github-breaking-changes: + - changeset: deprecate_beta_media_type + patch: + properties: + pull_request: + type: object + properties: + merged_at: + nullable: false + diff_url: + nullable: false + html_url: + nullable: false + patch_url: + nullable: false + url: + nullable: false + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - created_at + - updated_at + type: object + version: '2026-03-10' + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + example: 1347 + state: + type: string + example: open + locked: + type: boolean + example: true + title: + type: string + example: new-feature + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + projects-v2-draft-issue: + title: Draft Issue + description: A draft issue in a project + type: object + properties: + id: + type: number + description: The ID of the draft issue + node_id: + type: string + description: The node ID of the draft issue + title: + type: string + description: The title of the draft issue + body: + type: string + description: The body content of the draft issue + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + description: The time the draft issue was created + updated_at: + type: string + format: date-time + description: The time the draft issue was last updated + required: + - id + - node_id + - title + - user + - created_at + - updated_at + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-single-select-options: + title: Projects v2 Single Select Option + description: An option for a single select field + type: object + properties: + id: + type: string + description: The unique identifier of the option. + name: + type: object + description: The display name of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: + type: object + description: The description of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + color: + type: string + description: The color associated with the option. + required: + - id + - name + - description + - color + projects-v2-iteration-settings: + title: Projects v2 Iteration Setting + description: An iteration setting for an iteration field + type: object + properties: + id: + type: string + description: The unique identifier of the iteration setting. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + title: + type: object + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: The iteration title, in raw text and HTML formats. + completed: + type: boolean + description: Whether the iteration has been completed. + required: + - id + - start_date + - duration + - title + - completed + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: Details about the selected option (only present for single_select fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + $ref: '#/components/schemas/simple-user' + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + project-number: + name: project_number + description: The project's number. + in: path + required: true + schema: + type: integer + field-id: + name: field_id + description: The unique identifier of the field. + in: path + required: true + schema: + type: integer + item-id: + name: item_id + description: The unique identifier of the project item. + in: path + required: true + schema: + type: integer + view-number: + name: view_number + description: The number that identifies the project view. + in: path + required: true + schema: + type: integer + user-id: + name: user_id + description: The unique identifier of the user. + in: path + required: true + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + examples: + projects-v2: + value: + id: 2 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + title: My Projects + description: A board to manage my personal projects. + public: true + closed_at: null + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + number: 2 + short_description: null + deleted_at: null + deleted_by: null + state: open + latest_status_update: + id: 3 + node_id: PVTSU_lAECAQM + creator: + login: hubot + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: false + body: DONE + start_date: '2025-07-23' + target_date: '2025-07-26' + status: COMPLETE + created_at: '2025-07-11T16:19:28Z' + updated_at: '2025-07-11T16:19:28Z' + is_template: true + projects-v2-item-simple: + value: + id: 17 + node_id: PVTI_lADOANN5s84ACbL0zgBueEI + content: + id: 38 + node_id: I_kwDOANN5s85FtLts + title: Example Draft Issue + body: This is a draft issue in the project. + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content_type: DraftIssue + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + archived_at: null + project_url: https://api.github.com/users/octocat/projectsV2/1 + item_url: https://api.github.com/users/octocat/projectsV2/items/17 + projects-v2-field-items: + value: + - id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + - id: 67891 + node_id: PVTF_lADOABCD9876543210 + name: Status + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_4 + name: + html: Todo + raw: Todo + color: GRAY + description: + html: Items to be worked on + raw: Items to be worked on + - id: option_5 + name: + html: In Progress + raw: In Progress + color: BLUE + description: + html: Items currently being worked on + raw: Items currently being worked on + - id: option_6 + name: + html: Done + raw: Done + color: GREEN + description: + html: Completed items + raw: Completed items + created_at: '2022-04-29T10:30:00Z' + updated_at: '2022-04-29T10:30:00Z' + - id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + - id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + - id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + - id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-item-with-content: + value: + id: 13 + node_id: PVTI_lAAFAQ0 + project_url: https://api.github.com/orgs/github/projectsV2/1 + content: + url: https://api.github.com/repos/github/Hello-World/pulls/6 + id: 10 + node_id: PR_kwABCg + html_url: https://github.com/github/Hello-World/pull/6 + diff_url: https://github.com/github/Hello-World/pull/6.diff + patch_url: https://github.com/github/Hello-World/pull/6.patch + issue_url: https://api.github.com/repos/github/Hello-World/issues/6 + number: 6 + state: open + locked: false + title: Issue title + user: + login: monalisa + id: 161 + node_id: U_kgDMoQ + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + pinned_comment: null + body: Issue body + created_at: '2025-08-01T18:44:50Z' + updated_at: '2025-08-06T19:25:18Z' + closed_at: null + merged_at: null + merge_commit_sha: 98e25bad5878e54d22e5338cbc905dd2deedfa34 + assignee: + login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + assignees: + - login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + requested_reviewers: + - login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + requested_teams: [] + labels: + - id: 19 + node_id: LA_kwABEw + url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: fun size 🍫 + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: πŸš’ wontfix + color: 5891ce + default: false + description: This will not be worked on + milestone: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: null + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: null + closed_at: null + draft: false + commits_url: https://api.github.com/repos/github/Hello-World/pulls/6/commits + review_comments_url: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment_url: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/github/Hello-World/issues/6/comments + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + head: + label: github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f + ref: branch-2ee3da8fde8a1adfe6d0809a1a414e4f + sha: a3258d3434ecb2058b2784c8eb8610c2e9937a0d + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: null + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: null + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: null + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: null + archived: false + disabled: false + open_issues_count: 3 + license: null + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + base: + label: github:branch-0f4ceb14cbe39e4786ffbabb776da599 + ref: branch-0f4ceb14cbe39e4786ffbabb776da599 + sha: 9a9f5a8d77bdc2540412900d3c930fe36a82b5ed + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: null + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: null + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: null + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: null + archived: false + disabled: false + open_issues_count: 3 + license: null + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + _links: + self: + href: https://api.github.com/repos/github/Hello-World/pulls/6 + html: + href: https://github.com/github/Hello-World/pull/6 + issue: + href: https://api.github.com/repos/github/Hello-World/issues/6 + comments: + href: https://api.github.com/repos/github/Hello-World/issues/6/comments + review_comments: + href: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment: + href: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/github/Hello-World/pulls/6/commits + statuses: + href: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + author_association: MEMBER + auto_merge: null + active_lock_reason: null + content_type: PullRequest + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + created_at: '2025-08-01T18:44:51Z' + updated_at: '2025-08-06T19:25:18Z' + archived_at: null + item_url: https://api.github.com/orgs/github/projectsV2/1/items/13 + fields: + - id: 1 + name: Title + data_type: title + value: + raw: It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane. + html: It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane. + number: 6 + url: https://github.com/5/1/pull/6 + issue_id: 12 + state: open + state_reason: null + is_draft: false + - id: 2 + name: Assignees + data_type: assignees + value: + - login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + - id: 3 + name: Status + data_type: single_select + value: + id: '98236657' + name: + raw: Done + html: Done + color: PURPLE + description: + raw: This has been completed + html: This has been completed + - id: 4 + name: Labels + data_type: labels + value: + - id: 19 + node_id: LA_kwABEw + url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: fun size 🍫 + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: πŸš’ wontfix + color: 5891ce + default: false + description: This will not be worked on + - id: 5 + name: Linked pull requests + data_type: linked_pull_requests + value: [] + - id: 6 + name: Milestone + data_type: milestone + value: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: null + creator: + login: octocat + id: 175 + node_id: U_kgDMrw + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: null + closed_at: null + - id: 7 + name: Repository + data_type: repository + value: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: null + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + - id: 8 + name: Type + data_type: issue_type + value: null + - id: 9 + name: Reviewers + data_type: reviewers + value: + - type: ReviewRequest + status: pending + reviewer: + avatarUrl: https://github.com/images/error/octocat_happy.gif + id: 2 + login: monalisa + url: https://github.com/monalisa + name: monalisa + type: User + - id: 10 + name: Parent issue + data_type: parent_issue + value: null + - id: 11 + name: Sub-issues progress + data_type: sub_issues_progress + value: null + projects-v2-view: + value: + id: 1 + number: 1 + name: Sprint Board + layout: board + node_id: PVTV_lADOANN5s84ACbL0zgBueEI + project_url: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: https://github.com/orgs/octocat/projects/1/views/1 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + filter: is:issue is:open + visible_fields: + - 123 + - 456 + - 789 + sort_by: + - - 123 + - asc + - - 456 + - desc + group_by: + - 123 + vertical_group_by: + - 456 + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/pulls.yaml b/provider-dev/source/pulls.yaml new file mode 100644 index 0000000..b9948fc --- /dev/null +++ b/provider-dev/source/pulls.yaml @@ -0,0 +1,7167 @@ +openapi: 3.0.3 +info: + title: pulls API + description: Interact with GitHub Pull Requests. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/pulls: + get: + summary: List pull requests + description: |- + Lists pull requests in a specified repository. + + Draft pull requests are available in public repositories with GitHub + Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + plans, and in public and private repositories with GitHub Team and GitHub Enterprise + Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + in the GitHub Help documentation. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#list-pull-requests + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: state + description: Either `open`, `closed`, or `all` to filter by state. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - name: head + description: 'Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.' + in: query + required: false + schema: + type: string + - name: base + description: 'Filter pulls by base branch name. Example: `gh-pages`.' + in: query + required: false + schema: + type: string + - name: sort + description: What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - popularity + - long-running + default: created + - name: direction + description: 'The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.' + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + post: + summary: Create a pull request + description: |- + Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the new pull request. Required unless `issue` is specified. + head: + type: string + description: 'The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.' + head_repo: + type: string + description: The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. + format: repo.nwo + example: octo-org/octo-repo + base: + type: string + description: The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + body: + type: string + description: The contents of the pull request. + maintainer_can_modify: + type: boolean + description: Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + draft: + type: boolean + description: Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + issue: + type: integer + format: int64 + example: 1 + description: An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. + required: + - head + - base + examples: + default: + value: + title: Amazing new feature + body: Please pull these awesome changes in! + head: octocat:new-feature + base: master + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request' + examples: + default: + $ref: '#/components/examples/pull-request' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/comments: + get: + summary: List review comments in a repository + description: |- + Lists review comments for all pull requests in a repository. By default, + review comments are in ascending order by ID. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-review-comments-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at + - name: direction + description: The direction to sort results. Ignored without `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/comments/{comment_id}: + get: + summary: Get a review comment for a pull request + description: |- + Provides details for a specified review comment. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/get-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-2' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update a review comment for a pull request + description: |- + Edits the content of a specified review comment. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/update-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The text of the reply to the review comment. + required: + - body + examples: + default: + value: + body: I like this too! + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete a review comment for a pull request + description: Deletes a review comment. + tags: + - pulls + operationId: pulls/delete-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/{pull_number}: + get: + summary: Get a pull request + description: |- + Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Lists details of a pull request by providing its number. + + When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + + The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + + The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + + * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + + Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + tags: + - pulls + operationId: pulls/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + responses: + '200': + description: Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request' + examples: + default: + $ref: '#/components/examples/pull-request' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '406': + $ref: '#/components/responses/unacceptable' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + patch: + summary: Update a pull request + description: |- + Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the pull request. + body: + type: string + description: The contents of the pull request. + state: + type: string + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + base: + type: string + description: The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. + maintainer_can_modify: + type: boolean + description: Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + examples: + default: + value: + title: new title + body: updated body + state: open + base: master + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request' + examples: + default: + $ref: '#/components/examples/pull-request' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/comments: + get: + summary: List review comments on a pull request + description: |- + Lists all review comments for a specified pull request. By default, review comments + are in ascending order by ID. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-review-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/sort' + - name: direction + description: The direction to sort results. Ignored without `sort` parameter. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/since' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create a review comment for a pull request + description: |- + Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." + + If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + + The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The text of the review comment. + commit_id: + type: string + description: The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. + path: + type: string + description: The relative path to the file that necessitates a comment. + position: + type: integer + description: '**This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.' + deprecated: true + x-github: + deprecationDate: '2022-11-01' + side: + type: string + description: In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + enum: + - LEFT + - RIGHT + line: + type: integer + description: '**Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.' + start_line: + type: integer + description: '**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation.' + start_side: + type: string + description: '**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context.' + enum: + - LEFT + - RIGHT + - side + in_reply_to: + type: integer + example: 2 + description: The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. + subject_type: + type: string + description: The level at which the comment is targeted. + enum: + - line + - file + required: + - body + - commit_id + - path + examples: + example-for-a-multi-line-comment: + summary: Example for a multi-line comment + value: + body: Great stuff! + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + path: file1.txt + start_line: 1 + start_side: RIGHT + line: 2 + side: RIGHT + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + example-for-a-multi-line-comment: + $ref: '#/components/examples/pull-request-review-comment-example-for-a-multi-line-comment' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies: + post: + summary: Create a reply for a review comment + description: |- + Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create-reply-for-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The text of the review comment. + required: + - body + examples: + default: + value: + body: Great stuff! + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-comment' + examples: + default: + $ref: '#/components/examples/pull-request-review-comment' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + schema: + type: string + '404': + $ref: '#/components/responses/not_found' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: false + category: pulls + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/pulls/{pull_number}/commits: + get: + summary: List commits on a pull request + description: |- + Lists a maximum of 250 commits for a pull request. To receive a complete + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/files: + get: + summary: List pull requests files + description: |- + Lists the files in a specified pull request. + + > [!NOTE] + > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-files + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/diff-entry' + examples: + default: + $ref: '#/components/examples/diff-entry-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/merge: + get: + summary: Check if a pull request has been merged + description: Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. + tags: + - pulls + operationId: pulls/check-if-merged + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + responses: + '204': + description: Response if pull request has been merged + '404': + description: Not Found if pull request has not been merged + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + put: + summary: Merge a pull request + description: |- + Merges a pull request into the base branch. + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + commit_title: + type: string + description: Title for the automatic commit message. + commit_message: + type: string + description: Extra detail to append to automatic commit message. + sha: + type: string + description: SHA that pull request head must match to allow merge. + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + examples: + response-if-merge-was-successful: + value: + commit_title: Expand enum + commit_message: Add a new value to the merge_method enum + responses: + '200': + description: if merge was successful + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-merge-result' + examples: + response-if-merge-was-successful: + $ref: '#/components/examples/pull-request-merge-result-response-if-merge-was-successful' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '405': + description: Method Not Allowed if merge cannot be performed + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-merge-cannot-be-performed: + value: + message: Pull Request is not mergeable + '409': + description: Conflict if sha was provided and pull request head did not match + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-sha-was-provided-and-pull-request-head-did-not-match: + value: + message: Head branch was modified. Review and try the merge again. + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: pulls + x-stackQL-resource: pulls + /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers: + get: + summary: Get all requested reviewers for a pull request + description: Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + tags: + - pulls + operationId: pulls/list-requested-reviewers + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review-request' + examples: + default: + $ref: '#/components/examples/simple-pull-request-review-request' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: review-requests + x-stackQL-resource: review_requests + post: + summary: Request reviewers for a pull request + description: |- + Requests reviews for a pull request from a given set of users and/or teams. + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/request-reviewers + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + reviewers: + type: array + description: An array of user `login`s that will be requested. + items: + type: string + team_reviewers: + type: array + description: An array of team `slug`s that will be requested. + items: + type: string + required: + - reviewers + - team_reviewers + examples: + default: + value: + reviewers: + - octocat + - hubot + - other_user + team_reviewers: + - justice-league + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-review-request' + '403': + $ref: '#/components/responses/forbidden' + '422': + description: Unprocessable Entity if user is not a collaborator + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: review-requests + x-stackQL-resource: review_requests + delete: + summary: Remove requested reviewers from a pull request + description: Removes review requests from a pull request for a given set of users and/or teams. + tags: + - pulls + operationId: pulls/remove-requested-reviewers + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reviewers: + type: array + description: An array of user `login`s that will be removed. + items: + type: string + team_reviewers: + type: array + description: An array of team `slug`s that will be removed. + items: + type: string + required: + - reviewers + examples: + default: + value: + reviewers: + - octocat + - hubot + - other_user + team_reviewers: + - justice-league + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-simple' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: review-requests + x-stackQL-resource: review_requests + /repos/{owner}/{repo}/pulls/{pull_number}/reviews: + get: + summary: List reviews for a pull request + description: |- + Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-reviews + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: The list of reviews returns in chronological order. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + post: + summary: Create a review for a pull request + description: |- + Creates a review on a specified pull request. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + + > [!NOTE] + > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + + The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/create-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + commit_id: + type: string + description: The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. + body: + type: string + description: '**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.' + event: + type: string + description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.' + enum: + - APPROVE + - REQUEST_CHANGES + - COMMENT + comments: + type: array + description: Use the following table to specify the location, destination, and contents of the draft review comment. + items: + type: object + properties: + path: + type: string + description: The relative path to the file that necessitates a review comment. + position: + type: integer + description: The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + body: + type: string + description: Text of the review comment. + line: + type: integer + example: 28 + side: + type: string + example: RIGHT + start_line: + type: integer + example: 26 + start_side: + type: string + example: LEFT + required: + - path + - body + examples: + default: + value: + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + body: This is close to perfect! Please address the suggested inline change. + event: REQUEST_CHANGES + comments: + - path: file.md + position: 6 + body: Please add more information here, and fix this typo. + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}: + get: + summary: Get a review for a pull request + description: |- + Retrieves a pull request review by its ID. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/get-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-4' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + put: + summary: Update a review for a pull request + description: |- + Updates the contents of a specified review summary comment. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/update-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The body text of the pull request review. + required: + - body + examples: + default: + value: + body: This is close to perfect! Please address the suggested inline change. And add more about this. + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-5' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + delete: + summary: Delete a pending review for a pull request + description: |- + Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/delete-pending-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments: + get: + summary: List comments for a pull request review + description: |- + Lists comments for a specific pull request review. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/list-comments-for-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/review-comment' + examples: + default: + $ref: '#/components/examples/review-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals: + put: + summary: Dismiss a review for a pull request + description: |- + Dismisses a specified review on a pull request. + + > [!NOTE] + > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/dismiss-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The message for the pull request review dismissal + event: + type: string + example: '"DISMISS"' + enum: + - DISMISS + required: + - message + examples: + default: + value: + message: You are dismissed + event: DISMISS + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-3' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events: + post: + summary: Submit a review for a pull request + description: |- + Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - pulls + operationId: pulls/submit-review + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + - $ref: '#/components/parameters/review-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The body text of the pull request review + event: + type: string + description: 'The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.' + enum: + - APPROVE + - REQUEST_CHANGES + - COMMENT + required: + - event + examples: + default: + value: + body: Here is the body for the review. + event: REQUEST_CHANGES + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pull-request-review' + examples: + default: + $ref: '#/components/examples/pull-request-review-4' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pulls + subcategory: reviews + x-stackQL-resource: reviews + /repos/{owner}/{repo}/pulls/{pull_number}/update-branch: + put: + summary: Update a pull request branch + description: |- + Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. + Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. + tags: + - pulls + operationId: pulls/update-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pull-number' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + expected_head_sha: + type: string + description: 'The expected SHA of the pull request''s HEAD ref. This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.' + examples: + default: + value: + expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Updating pull request branch. + url: https://github.com/repos/octocat/Hello-World/pulls/53 + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: pulls + subcategory: pulls + x-stackQL-resource: pulls +components: + schemas: + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + example: 1347 + state: + type: string + example: open + locked: + type: boolean + example: true + title: + type: string + example: new-feature + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + pull-request: + type: object + title: Pull Request + description: Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + example: 42 + type: integer + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + example: open + type: string + locked: + type: boolean + example: true + title: + description: The title of the pull request. + example: Amazing new feature + type: string + user: + $ref: '#/components/schemas/simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + nullable: true + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team-simple' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + merged: + type: boolean + mergeable: + type: boolean + example: true + nullable: true + rebaseable: + type: boolean + example: true + nullable: true + mergeable_state: + type: string + example: clean + merged_by: + $ref: '#/components/schemas/nullable-simple-user' + comments: + type: integer + example: 10 + review_comments: + type: integer + example: 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + example: true + type: boolean + commits: + type: integer + example: 3 + additions: + type: integer + example: 100 + deletions: + type: integer + example: 3 + changed_files: + type: integer + example: 5 + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + - additions + - changed_files + - comments + - commits + - deletions + - mergeable + - mergeable_state + - merged + - maintainer_can_modify + - merged_by + - review_comments + type: object + version: '2026-03-10' + pull-request-review-comment: + title: Pull Request Review Comment + description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. + type: object + properties: + url: + description: URL for the pull request review comment + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + type: string + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: integer + format: int64 + example: 42 + nullable: true + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + example: 1 + node_id: + description: The node ID of the pull request review comment. + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: + description: The relative path of the file to which the comment applies. + example: config/database.yaml + type: string + position: + description: The line index in the diff to which the comment applies. This field is closing down; use `line` instead. + example: 1 + type: integer + original_position: + description: The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. + example: 4 + type: integer + commit_id: + description: The SHA of the commit to which the comment applies. + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + type: string + in_reply_to_id: + description: The comment ID to reply to. + example: 8 + type: integer + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + description: The text of the comment. + example: We should probably include a check for null values here. + type: string + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + description: URL for the pull request that the review comment belongs to. + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + $ref: '#/components/schemas/author-association' + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + original_start_line: + type: integer + description: The first line of the range for a multi-line comment. + example: 2 + nullable: true + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment + example: 2 + type: integer + original_line: + description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment + example: 2 + type: integer + side: + description: The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + subject_type: + description: The level at which the comment is targeted, can be a diff line or a file. + type: string + enum: + - line + - file + reactions: + $ref: '#/components/schemas/reaction-rollup' + body_html: + type: string + example: '"

comment body

"' + body_text: + type: string + example: '"comment body"' + required: + - url + - id + - node_id + - pull_request_review_id + - diff_hunk + - path + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + commit: + title: Commit + description: Commit + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + $ref: '#/components/schemas/nullable-git-user' + committer: + $ref: '#/components/schemas/nullable-git-user' + message: + type: string + example: Fix all the bugs + comment_count: + type: integer + example: 0 + tree: + type: object + properties: + sha: + type: string + example: 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + required: + - sha + - url + verification: + $ref: '#/components/schemas/verification' + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + committer: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + parents: + type: array + items: + type: object + properties: + sha: + type: string + example: 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + required: + - sha + - url + stats: + type: object + properties: + additions: + type: integer + deletions: + type: integer + total: + type: integer + files: + type: array + items: + $ref: '#/components/schemas/diff-entry' + required: + - url + - sha + - node_id + - html_url + - comments_url + - commit + - author + - committer + - parents + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + nullable: true + example: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + example: file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + example: added + additions: + type: integer + example: 103 + deletions: + type: integer + example: 21 + changes: + type: integer + example: 124 + blob_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + example: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + previous_filename: + type: string + example: file.txt + required: + - additions + - blob_url + - changes + - contents_url + - deletions + - filename + - raw_url + - sha + - status + pull-request-merge-result: + title: Pull Request Merge Result + description: Pull Request Merge Result + type: object + properties: + sha: + type: string + merged: + type: boolean + message: + type: string + required: + - merged + - message + - sha + pull-request-review-request: + title: Pull Request Review Request + description: Pull Request Review Request + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + type: array + items: + $ref: '#/components/schemas/team' + required: + - users + - teams + pull-request-review: + title: Pull Request Review + description: Pull Request Reviews are reviews on pull requests. + type: object + properties: + id: + description: Unique identifier of the review + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + description: The text of the review. + example: This looks great. + type: string + state: + type: string + example: CHANGES_REQUESTED + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + submitted_at: + type: string + format: date-time + commit_id: + description: A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. + example: 54bb654c9e6025347f57900a4a5c2313a96b8035 + type: string + nullable: true + body_html: + type: string + body_text: + type: string + author_association: + $ref: '#/components/schemas/author-association' + required: + - id + - node_id + - user + - body + - state + - commit_id + - html_url + - pull_request_url + - _links + - author_association + review-comment: + title: Legacy Review Comment + description: Legacy Review Comment + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: integer + format: int64 + example: 42 + nullable: true + id: + type: integer + format: int64 + example: 10 + node_id: + type: string + example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: + type: string + example: file1.txt + position: + type: integer + example: 1 + nullable: true + original_position: + type: integer + example: 4 + commit_id: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + example: 8 + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Great stuff + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: + $ref: '#/components/schemas/author-association' + _links: + type: object + properties: + self: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + pull_request: + $ref: '#/components/schemas/link' + required: + - self + - html + - pull_request + body_text: + type: string + body_html: + type: string + reactions: + $ref: '#/components/schemas/reaction-rollup' + side: + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + type: string + start_side: + type: string + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + default: RIGHT + nullable: true + line: + description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment + example: 2 + type: integer + original_line: + description: The original line of the blob to which the comment applies. The last line of the range for a multi-line comment + example: 2 + type: integer + start_line: + description: The first line of the range for a multi-line comment. + example: 2 + type: integer + nullable: true + original_start_line: + description: The original first line of the range for a multi-line comment. + example: 2 + type: integer + nullable: true + subject_type: + description: The level at which the comment is targeted, can be a diff line or a file. + type: string + enum: + - line + - file + required: + - id + - node_id + - url + - body + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - pull_request_review_id + - html_url + - pull_request_url + - _links + - author_association + - created_at + - updated_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + $ref: '#/components/schemas/simple-user' + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + nullable-git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' + nullable: true + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + responses: + not_modified: + description: Not modified + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + unacceptable: + description: Unacceptable + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + since: + name: since + description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + pull-number: + name: pull_number + description: The number that identifies the pull request. + in: path + required: true + schema: + type: integer + sort: + name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + review-id: + name: review_id + description: The unique identifier of the review. + in: path + required: true + schema: + type: integer + examples: + pull-request-simple-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + pull-request: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_merge_commit: true + allow_forking: true + forks: 123 + open_issues: 123 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + watchers: 123 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_merge_commit: true + forks: 123 + open_issues: 123 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + watchers: 123 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + merged: false + mergeable: true + rebaseable: true + mergeable_state: clean + merged_by: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + comments: 10 + review_comments: 0 + maintainer_can_modify: true + commits: 3 + additions: 100 + deletions: 3 + changed_files: 5 + pull-request-review-comment-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + pull-request-review-comment-2: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + pull-request-review-comment-example-for-a-multi-line-comment: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + pull-request-review-comment: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 426899381 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + start_line: 1 + original_start_line: 1 + start_side: RIGHT + line: 2 + original_line: 2 + side: RIGHT + commit-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + diff-entry-items: + value: + - sha: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: file1.txt + status: added + additions: 103 + deletions: 21 + changes: 124 + blob_url: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + pull-request-merge-result-response-if-merge-was-successful: + value: + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + merged: true + message: Pull Request successfully merged + simple-pull-request-review-request: + value: + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + pull-request-review-request: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + pull-request-simple: + value: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + pull-request-review-items: + value: + - id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Here is the body for the review. + state: APPROVED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + pull-request-review: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: This is close to perfect! Please address the suggested inline change. + state: CHANGES_REQUESTED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + pull-request-review-4: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Here is the body for the review. + state: APPROVED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + pull-request-review-5: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: This is close to perfect! Please address the suggested inline change. And add more about this. + state: CHANGES_REQUESTED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + review-comment-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: 42 + id: 10 + node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' + path: file1.txt + position: 1 + original_position: 4 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: 8 + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Great stuff! + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1 + author_association: NONE + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + html: + href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1 + pull-request-review-3: + value: + id: 80 + node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Here is the body for the review. + state: DISMISSED + html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12 + _links: + html: + href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request: + href: https://api.github.com/repos/octocat/Hello-World/pulls/12 + submitted_at: '2019-11-17T17:43:43Z' + commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 + author_association: COLLABORATOR + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/rate_limit.yaml b/provider-dev/source/rate_limit.yaml new file mode 100644 index 0000000..e2d81c6 --- /dev/null +++ b/provider-dev/source/rate_limit.yaml @@ -0,0 +1,231 @@ +openapi: 3.0.3 +info: + title: rate_limit API + description: github API + version: 1.1.4 +paths: + /rate_limit: + get: + summary: Get rate limit status for the authenticated user + description: |- + > [!NOTE] + > Accessing this endpoint does not count against your REST API rate limit. + + Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." + + > [!NOTE] + > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + tags: + - rate-limit + operationId: rate-limit/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rate-limit-overview' + examples: + default: + $ref: '#/components/examples/rate-limit-overview' + headers: + X-RateLimit-Limit: + $ref: '#/components/headers/x-rate-limit-limit' + X-RateLimit-Remaining: + $ref: '#/components/headers/x-rate-limit-remaining' + X-RateLimit-Reset: + $ref: '#/components/headers/x-rate-limit-reset' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: rate-limit + subcategory: rate-limit + x-stackQL-resource: rate_limit +components: + schemas: + rate-limit-overview: + title: Rate Limit Overview + description: Rate Limit Overview + type: object + properties: + resources: + type: object + properties: + core: + $ref: '#/components/schemas/rate-limit' + graphql: + $ref: '#/components/schemas/rate-limit' + search: + $ref: '#/components/schemas/rate-limit' + code_search: + $ref: '#/components/schemas/rate-limit' + source_import: + $ref: '#/components/schemas/rate-limit' + integration_manifest: + $ref: '#/components/schemas/rate-limit' + code_scanning_upload: + $ref: '#/components/schemas/rate-limit' + actions_runner_registration: + $ref: '#/components/schemas/rate-limit' + scim: + $ref: '#/components/schemas/rate-limit' + dependency_snapshots: + $ref: '#/components/schemas/rate-limit' + dependency_sbom: + $ref: '#/components/schemas/rate-limit' + code_scanning_autofix: + $ref: '#/components/schemas/rate-limit' + required: + - core + - search + rate: + $ref: '#/components/schemas/rate-limit' + required: + - rate + - resources + x-github-breaking-changes: + - changeset: remove_rate_limit_rate + patch: + properties: + rate: null + required: + - resources + type: object + version: '2026-03-10' + rate-limit: + title: Rate Limit + type: object + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + used: + type: integer + required: + - limit + - remaining + - reset + - used + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + responses: + not_modified: + description: Not modified + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + examples: + rate-limit-overview: + value: + resources: + core: + limit: 5000 + used: 1 + remaining: 4999 + reset: 1691591363 + search: + limit: 30 + used: 12 + remaining: 18 + reset: 1691591091 + graphql: + limit: 5000 + used: 7 + remaining: 4993 + reset: 1691593228 + integration_manifest: + limit: 5000 + used: 1 + remaining: 4999 + reset: 1691594631 + source_import: + limit: 100 + used: 1 + remaining: 99 + reset: 1691591091 + code_scanning_upload: + limit: 500 + used: 1 + remaining: 499 + reset: 1691594631 + actions_runner_registration: + limit: 10000 + used: 0 + remaining: 10000 + reset: 1691594631 + scim: + limit: 15000 + used: 0 + remaining: 15000 + reset: 1691594631 + dependency_snapshots: + limit: 100 + used: 0 + remaining: 100 + reset: 1691591091 + code_search: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 + rate: + limit: 5000 + used: 1 + remaining: 4999 + reset: 1372700873 + headers: + x-rate-limit-limit: + example: 5000 + schema: + type: integer + x-rate-limit-remaining: + example: 4999 + schema: + type: integer + x-rate-limit-reset: + example: 1590701888 + schema: + type: integer + format: timestamp +servers: + - url: https://api.github.com diff --git a/provider-dev/source/reactions.yaml b/provider-dev/source/reactions.yaml new file mode 100644 index 0000000..c3878ea --- /dev/null +++ b/provider-dev/source/reactions.yaml @@ -0,0 +1,1064 @@ +openapi: 3.0.3 +info: + title: reactions API + description: Interact with reactions to various GitHub entities. + version: 1.1.4 +paths: + /repos/{owner}/{repo}/comments/{comment_id}/reactions: + get: + summary: List reactions for a commit comment + description: List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + tags: + - reactions + operationId: reactions/list-for-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - name: content + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for a commit comment + description: Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + tags: + - reactions + operationId: reactions/create-for-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}: + delete: + summary: Delete a commit comment reaction + description: |- + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + + Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + tags: + - reactions + operationId: reactions/delete-for-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions: + get: + summary: List reactions for an issue comment + description: List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + tags: + - reactions + operationId: reactions/list-for-issue-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - name: content + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for an issue comment + description: Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + tags: + - reactions + operationId: reactions/create-for-issue-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}: + delete: + summary: Delete an issue comment reaction + description: |- + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + + Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + tags: + - reactions + operationId: reactions/delete-for-issue-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/{issue_number}/reactions: + get: + summary: List reactions for an issue + description: List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/list-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - name: content + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '410': + $ref: '#/components/responses/gone' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for an issue + description: Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + tags: + - reactions + operationId: reactions/create-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}: + delete: + summary: Delete an issue reaction + description: |- + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + + Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/delete-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/issue-number' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions: + get: + summary: List reactions for a pull request review comment + description: List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + tags: + - reactions + operationId: reactions/list-for-pull-request-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - name: content + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. + in: query + required: false + schema: + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for a pull request review comment + description: Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + tags: + - reactions + operationId: reactions/create-for-pull-request-review-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}: + delete: + summary: Delete a pull request comment reaction + description: |- + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + + Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + tags: + - reactions + operationId: reactions/delete-for-pull-request-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/releases/{release_id}/reactions: + get: + summary: List reactions for a release + description: List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/list-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - name: content + description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. + in: query + required: false + schema: + type: string + enum: + - '+1' + - laugh + - heart + - hooray + - rocket + - eyes + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + post: + summary: Create reaction for a release + description: 'Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.' + tags: + - reactions + operationId: reactions/create-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. + enum: + - '+1' + - laugh + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Reaction exists + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '201': + description: Reaction created + content: + application/json: + schema: + $ref: '#/components/schemas/reaction' + examples: + default: + $ref: '#/components/examples/reaction' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions + /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}: + delete: + summary: Delete a release reaction + description: |- + > [!NOTE] + > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + + Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/delete-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - $ref: '#/components/parameters/reaction-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + x-stackQL-resource: reactions +components: + schemas: + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + $ref: '#/components/schemas/nullable-simple-user' + content: + description: The reaction to use + example: heart + type: string + enum: + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + gone: + description: Gone + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer + issue-number: + name: issue_number + description: The number that identifies the issue. + in: path + required: true + schema: + type: integer + release-id: + name: release_id + description: The unique identifier of the release. + in: path + required: true + schema: + type: integer + examples: + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + content: heart + created_at: '2016-05-20T20:09:31Z' + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/repos.yaml b/provider-dev/source/repos.yaml new file mode 100644 index 0000000..e0fd7ca --- /dev/null +++ b/provider-dev/source/repos.yaml @@ -0,0 +1,25899 @@ +openapi: 3.0.3 +info: + title: repos API + description: Interact with GitHub Repos. + version: 1.1.4 +paths: + /orgs/{org}/repos: + get: + summary: List organization repositories + description: |- + Lists repositories for the specified organization. + + > [!NOTE] + > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + tags: + - repos + operationId: repos/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-organization-repositories + parameters: + - $ref: '#/components/parameters/org' + - name: type + description: Specifies the types of repositories you want returned. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + - forks + - sources + - member + default: all + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - pushed + - full_name + default: created + - name: direction + description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + post: + summary: Create an organization repository + description: |- + Creates a new repository in the specified organization. The authenticated user must be a member of the organization. + + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + tags: + - repos + operationId: repos/create-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#create-an-organization-repository + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the repository. + description: + type: string + description: A short description of the repository. + homepage: + type: string + description: A URL with more information about the repository. + private: + type: boolean + description: Whether the repository is private. + default: false + visibility: + type: string + description: The visibility of the repository. + enum: + - public + - private + has_issues: + type: boolean + description: Either `true` to enable issues for this repository or `false` to disable them. + default: true + has_projects: + type: boolean + description: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + default: true + has_wiki: + type: boolean + description: Either `true` to enable the wiki for this repository or `false` to disable it. + default: true + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + is_template: + type: boolean + description: Either `true` to make this repo available as a template repository or `false` to prevent it. + default: false + team_id: + type: integer + description: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + auto_init: + type: boolean + description: Pass `true` to create an initial commit with empty README. + default: false + gitignore_template: + type: string + description: Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + license_template: + type: string + description: Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". + allow_squash_merge: + type: boolean + description: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + default: true + allow_merge_commit: + type: boolean + description: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + default: true + allow_rebase_merge: + type: boolean + description: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + default: true + allow_auto_merge: + type: boolean + description: Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + default: false + delete_branch_on_merge: + type: boolean + description: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** + default: false + use_squash_pr_title_as_default: + type: boolean + description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + Required when using `squash_merge_commit_message`. + + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + Required when using `merge_commit_message`. + + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + custom_properties: + type: object + description: The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - name + examples: + default: + value: + name: Hello-World + description: This is your first repository + homepage: https://github.com + private: false + has_issues: true + has_projects: true + has_wiki: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-github-breaking-changes: + - changeset: change_create_repo_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: repos + /orgs/{org}/rulesets: + get: + summary: Get all organization repository rulesets + description: Get all the repository rulesets for an organization. + tags: + - repos + operationId: repos/get-org-rulesets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/ruleset-targets' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + post: + summary: Create an organization repository ruleset + description: Create a repository ruleset for an organization. + tags: + - repos + operationId: repos/create-org-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + default: branch + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/org-ruleset-conditions' + rules: + type: array + description: An array of rules within the ruleset. + items: + $ref: '#/components/schemas/org-rules' + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /orgs/{org}/rulesets/rule-suites: + get: + summary: List organization rule suites + description: |- + Lists suites of rule evaluations at the organization level. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-org-rule-suites + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/ref-in-query' + - $ref: '#/components/parameters/repository-name-in-query' + - $ref: '#/components/parameters/time-period' + - $ref: '#/components/parameters/actor-name-in-query' + - $ref: '#/components/parameters/rule-suite-result' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suites' + examples: + default: + $ref: '#/components/examples/rule-suite-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rule-suites + x-stackQL-resource: rule_suites + /orgs/{org}/rulesets/rule-suites/{rule_suite_id}: + get: + summary: Get an organization rule suite + description: |- + Gets information about a suite of rule evaluations from within an organization. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-org-rule-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/rule-suite-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suite' + examples: + default: + $ref: '#/components/examples/rule-suite' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rule-suites + x-stackQL-resource: rule_suites + /orgs/{org}/rulesets/{ruleset_id}: + get: + summary: Get an organization repository ruleset + description: |- + Get a repository ruleset for an organization. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-org-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + put: + summary: Update an organization repository ruleset + description: Update a ruleset for an organization. + tags: + - repos + operationId: repos/update-org-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/org-ruleset-conditions' + rules: + description: An array of rules within the ruleset. + type: array + items: + $ref: '#/components/schemas/org-rules' + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/org-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + delete: + summary: Delete an organization repository ruleset + description: Delete a ruleset for an organization. + tags: + - repos + operationId: repos/delete-org-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + parameters: + - $ref: '#/components/parameters/org' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /repos/{owner}/{repo}: + get: + summary: Get a repository + description: |- + The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. + + > [!NOTE] + > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. + tags: + - repos + operationId: repos/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#get-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default-response: + $ref: '#/components/examples/full-repository-default-response' + '301': + $ref: '#/components/responses/moved_permanently' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + patch: + summary: Update a repository + description: '**Note**: To edit a repository''s topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.' + tags: + - repos + operationId: repos/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#update-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the repository. + description: + type: string + description: A short description of the repository. + homepage: + type: string + description: A URL with more information about the repository. + private: + type: boolean + description: |- + Either `true` to make the repository private or `false` to make it public. Default: `false`. + **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + default: false + visibility: + type: string + description: The visibility of the repository. + enum: + - public + - private + security_and_analysis: + type: object + description: |- + Specify which security and analysis features to enable or disable for the repository. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + + You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. + nullable: true + properties: + advanced_security: + type: object + description: |- + Use the `status` property to enable or disable GitHub Advanced Security for this repository. + For more information, see "[About GitHub Advanced + Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + code_security: + type: object + description: Use the `status` property to enable or disable GitHub Code Security for this repository. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning: + type: object + description: Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_push_protection: + type: object + description: Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_ai_detection: + type: object + description: Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_non_provider_patterns: + type: object + description: Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_delegated_alert_dismissal: + type: object + description: Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_delegated_bypass: + type: object + description: Use the `status` property to enable or disable secret scanning delegated bypass for this repository. + properties: + status: + type: string + description: Can be `enabled` or `disabled`. + secret_scanning_delegated_bypass_options: + type: object + description: |- + Feature options for secret scanning delegated bypass. + This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + properties: + reviewers: + type: array + description: |- + The bypass reviewers for secret scanning delegated bypass. + If you omit this field, the existing set of reviewers is unchanged. + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + has_issues: + type: boolean + description: Either `true` to enable issues for this repository or `false` to disable them. + default: true + has_projects: + type: boolean + description: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + default: true + has_wiki: + type: boolean + description: Either `true` to enable the wiki for this repository or `false` to disable it. + default: true + is_template: + type: boolean + description: Either `true` to make this repo available as a template repository or `false` to prevent it. + default: false + default_branch: + type: string + description: Updates the default branch for this repository. + allow_squash_merge: + type: boolean + description: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + default: true + allow_merge_commit: + type: boolean + description: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + default: true + allow_rebase_merge: + type: boolean + description: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + default: true + allow_auto_merge: + type: boolean + description: Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + default: false + delete_branch_on_merge: + type: boolean + description: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. + default: false + allow_update_branch: + type: boolean + description: Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. + default: false + use_squash_pr_title_as_default: + type: boolean + description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + Required when using `squash_merge_commit_message`. + + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + Required when using `merge_commit_message`. + + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + archived: + type: boolean + description: Whether to archive this repository. `false` will unarchive a previously archived repository. + default: false + allow_forking: + type: boolean + description: Either `true` to allow private forks, or `false` to prevent private forks. + default: false + web_commit_signoff_required: + type: boolean + description: Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits. + default: false + examples: + default: + value: + name: Hello-World + description: This is your first repository + homepage: https://github.com + private: true + has_issues: true + has_projects: true + has_wiki: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + '307': + $ref: '#/components/responses/temporary_redirect' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Delete a repository + description: |- + Deleting a repository requires admin access. + + If an organization owner has configured the organization to prevent members from deleting organization-owned + repositories, you will get a `403 Forbidden` response. + + OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + tags: + - repos + operationId: repos/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#delete-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '307': + $ref: '#/components/responses/temporary_redirect' + '403': + description: 'If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:' + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + default: + value: + message: Organization members cannot delete repositories. + documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/activity: + get: + summary: List repository activities + description: |- + Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. + + For more information about viewing repository activity, + see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." + tags: + - repos + operationId: repos/list-activities + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-activities + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: ref + description: |- + The Git reference for the activities you want to list. + + The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. + in: query + required: false + schema: + type: string + - name: actor + description: The GitHub username to use to filter by the actor who performed the activity. + in: query + required: false + schema: + type: string + - name: time_period + description: |- + The time period to filter by. + + For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). + in: query + required: false + schema: + type: string + enum: + - day + - week + - month + - quarter + - year + - name: activity_type + description: |- + The activity type to filter by. + + For example, you can choose to filter by "force_push", to see all force pushes to the repository. + in: query + required: false + schema: + type: string + enum: + - push + - force_push + - branch_creation + - branch_deletion + - pr_merge + - merge_queue_merge + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/activity' + examples: + default: + $ref: '#/components/examples/activity-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/attestations: + post: + summary: Create an attestation + description: |- + Store an artifact attestation and associate it with a repository. + + The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + + Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/create-attestation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/attestations#create-an-attestation + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + required: + - bundle + examples: + default: + $ref: '#/components/examples/attestation' + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: + id: + type: integer + description: The ID of the attestation. + examples: + default: + value: + id: 2 + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: attestations + x-stackQL-resource: attestations + /repos/{owner}/{repo}/attestations/{subject_digest}: + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with a repository. + + The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - repos + operationId: repos/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/attestations#list-attestations + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + bundle_url: + type: string + initiator: + type: string + examples: + default: + $ref: '#/components/examples/list-attestations' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /repos/{owner}/{repo}/autolinks: + get: + summary: Get all autolinks of a repository + description: |- + Gets all autolinks that are configured for a repository. + + Information about autolinks are only available to repository administrators. + tags: + - repos + operationId: repos/list-autolinks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/autolink' + examples: + default: + $ref: '#/components/examples/autolink-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + post: + summary: Create an autolink reference for a repository + description: Users with admin access to the repository can create an autolink. + tags: + - repos + operationId: repos/create-autolink + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + key_prefix: + type: string + description: This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. + url_template: + type: string + description: The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. + is_alphanumeric: + type: boolean + default: true + description: Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters. + required: + - key_prefix + - url_template + examples: + default: + value: + key_prefix: TICKET- + url_template: https://example.com/TICKET?query= + is_alphanumeric: true + responses: + '201': + description: response + content: + application/json: + schema: + $ref: '#/components/schemas/autolink' + examples: + default: + $ref: '#/components/examples/autolink' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/autolinks/1 + schema: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + /repos/{owner}/{repo}/autolinks/{autolink_id}: + get: + summary: Get an autolink reference of a repository + description: |- + This returns a single autolink reference by ID that was configured for the given repository. + + Information about autolinks are only available to repository administrators. + tags: + - repos + operationId: repos/get-autolink + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/autolink-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/autolink' + examples: + default: + $ref: '#/components/examples/autolink' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + delete: + summary: Delete an autolink reference from a repository + description: |- + This deletes a single autolink reference by ID that was configured for the given repository. + + Information about autolinks are only available to repository administrators. + tags: + - repos + operationId: repos/delete-autolink + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/autolink-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: autolinks + x-stackQL-resource: autolinks + /repos/{owner}/{repo}/automated-security-fixes: + get: + summary: Check if Dependabot security updates are enabled for a repository + description: Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/check-automated-security-fixes + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response if Dependabot is enabled + content: + application/json: + schema: + $ref: '#/components/schemas/check-automated-security-fixes' + examples: + default: + value: + enabled: true + paused: false + '404': + description: Not Found if Dependabot is not enabled for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable Dependabot security updates + description: Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/enable-automated-security-fixes + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable Dependabot security updates + description: Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/disable-automated-security-fixes + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/branches: + get: + summary: List branches + description: '' + tags: + - repos + operationId: repos/list-branches + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#list-branches + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: protected + description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. + in: query + required: false + schema: + type: boolean + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/short-branch' + examples: + default: + $ref: '#/components/examples/short-branch-with-protection-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/branches/{branch}: + get: + summary: Get a branch + description: '' + tags: + - repos + operationId: repos/get-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#get-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-with-protection' + examples: + default: + $ref: '#/components/examples/branch-get' + '301': + $ref: '#/components/responses/moved_permanently' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/branches/{branch}/protection: + get: + summary: Get branch protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-branch-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-protection' + examples: + default: + $ref: '#/components/examples/branch-protection' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Update branch protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Protecting a branch requires admin or owner permissions to the repository. + + > [!NOTE] + > Passing new arrays of `users` and `teams` replaces their previous values. + + > [!NOTE] + > The list of users, apps, and teams in total is limited to 100 items. + tags: + - repos + operationId: repos/update-branch-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + required_status_checks: + type: object + description: Require status checks to pass before merging. Set to `null` to disable. + nullable: true + properties: + strict: + type: boolean + description: Require branches to be up to date before merging. + contexts: + type: array + deprecated: true + description: '**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.' + items: + type: string + checks: + type: array + description: The list of status checks to require in order to merge into this branch. + items: + type: object + required: + - context + properties: + context: + type: string + description: The name of the required check + app_id: + type: integer + description: The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. + required: + - strict + - contexts + enforce_admins: + type: boolean + description: Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. + nullable: true + required_pull_request_reviews: + type: object + description: Require at least one approving review on a pull request, before merging. Set to `null` to disable. + nullable: true + properties: + dismissal_restrictions: + type: object + description: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + properties: + users: + type: array + description: The list of user `login`s with dismissal access + items: + type: string + teams: + type: array + description: The list of team `slug`s with dismissal access + items: + type: string + apps: + type: array + description: The list of app `slug`s with dismissal access + items: + type: string + dismiss_stale_reviews: + type: boolean + description: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + require_code_owner_reviews: + type: boolean + description: Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. + required_approving_review_count: + type: integer + description: Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. + require_last_push_approval: + type: boolean + description: 'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.' + default: false + bypass_pull_request_allowances: + type: object + description: Allow specific users, teams, or apps to bypass pull request requirements. + properties: + users: + type: array + description: The list of user `login`s allowed to bypass pull request requirements. + items: + type: string + teams: + type: array + description: The list of team `slug`s allowed to bypass pull request requirements. + items: + type: string + apps: + type: array + description: The list of app `slug`s allowed to bypass pull request requirements. + items: + type: string + restrictions: + type: object + description: Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. + nullable: true + properties: + users: + type: array + description: The list of user `login`s with push access + items: + type: string + teams: + type: array + description: The list of team `slug`s with push access + items: + type: string + apps: + type: array + description: The list of app `slug`s with push access + items: + type: string + required: + - users + - teams + required_linear_history: + type: boolean + description: 'Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation.' + allow_force_pushes: + type: boolean + description: 'Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation."' + nullable: true + allow_deletions: + type: boolean + description: 'Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.' + block_creations: + type: boolean + description: 'If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.' + required_conversation_resolution: + type: boolean + description: 'Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.' + lock_branch: + type: boolean + description: 'Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.' + default: false + allow_fork_syncing: + type: boolean + description: 'Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.' + default: false + required: + - required_status_checks + - enforce_admins + - required_pull_request_reviews + - restrictions + examples: + default: + value: + required_status_checks: + strict: true + contexts: + - continuous-integration/travis-ci + enforce_admins: true + required_pull_request_reviews: + dismissal_restrictions: + users: + - octocat + teams: + - justice-league + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + bypass_pull_request_allowances: + users: + - octocat + teams: + - justice-league + restrictions: + users: + - octocat + teams: + - justice-league + apps: + - super-ci + required_linear_history: true + allow_force_pushes: true + allow_deletions: true + block_creations: true + required_conversation_resolution: true + lock_branch: true + allow_fork_syncing: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch' + examples: + default: + $ref: '#/components/examples/branch-protection-update' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete branch protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/delete-branch-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins: + get: + summary: Get admin branch protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-admin-branch-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Set admin branch protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + tags: + - repos + operationId: repos/set-admin-branch-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced-2' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete admin branch protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + tags: + - repos + operationId: repos/delete-admin-branch-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews: + get: + summary: Get pull request review protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-pull-request-review-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-pull-request-review' + examples: + default: + $ref: '#/components/examples/protected-branch-pull-request-review' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + patch: + summary: Update pull request review protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + + > [!NOTE] + > Passing new arrays of `users` and `teams` replaces their previous values. + tags: + - repos + operationId: repos/update-pull-request-review-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + dismissal_restrictions: + type: object + description: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. + properties: + users: + type: array + description: The list of user `login`s with dismissal access + items: + type: string + teams: + type: array + description: The list of team `slug`s with dismissal access + items: + type: string + apps: + type: array + description: The list of app `slug`s with dismissal access + items: + type: string + dismiss_stale_reviews: + type: boolean + description: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. + require_code_owner_reviews: + type: boolean + description: Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. + required_approving_review_count: + type: integer + description: Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. + require_last_push_approval: + type: boolean + description: 'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`' + default: false + bypass_pull_request_allowances: + type: object + description: Allow specific users, teams, or apps to bypass pull request requirements. + properties: + users: + type: array + description: The list of user `login`s allowed to bypass pull request requirements. + items: + type: string + teams: + type: array + description: The list of team `slug`s allowed to bypass pull request requirements. + items: + type: string + apps: + type: array + description: The list of app `slug`s allowed to bypass pull request requirements. + items: + type: string + examples: + default: + value: + dismissal_restrictions: + users: + - octocat + teams: + - justice-league + apps: + - octoapp + bypass_pull_request_allowances: + users: + - octocat + teams: + - justice-league + apps: + - octoapp + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-pull-request-review' + examples: + default: + $ref: '#/components/examples/protected-branch-pull-request-review' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete pull request review protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/delete-pull-request-review-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures: + get: + summary: Get commit signature protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. + + > [!NOTE] + > You must enable branch protection to require signed commits. + tags: + - repos + operationId: repos/get-commit-signature-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Create commit signature protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + tags: + - repos + operationId: repos/create-commit-signature-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/protected-branch-admin-enforced' + examples: + default: + $ref: '#/components/examples/protected-branch-admin-enforced' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete commit signature protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + tags: + - repos + operationId: repos/delete-commit-signature-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks: + get: + summary: Get status checks protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-status-checks-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/status-check-policy' + examples: + default: + $ref: '#/components/examples/status-check-policy' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + patch: + summary: Update status check protection + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + tags: + - repos + operationId: repos/update-status-check-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + strict: + type: boolean + description: Require branches to be up to date before merging. + contexts: + type: array + deprecated: true + description: '**Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.' + items: + type: string + checks: + type: array + description: The list of status checks to require in order to merge into this branch. + items: + type: object + required: + - context + properties: + context: + type: string + description: The name of the required check + app_id: + type: integer + description: The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. + examples: + default: + value: + strict: true + contexts: + - continuous-integration/travis-ci + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/status-check-policy' + examples: + default: + $ref: '#/components/examples/status-check-policy' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove status check protection + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/remove-status-check-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts: + get: + summary: Get all status check contexts + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/get-all-status-check-contexts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add status check contexts + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/add-status-check-contexts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + description: The name of the status checks + items: + type: string + required: + - contexts + example: + contexts: + - contexts + description: The name of the status checks + items: + type: string + examples: + default: + summary: Example adding status checks to a branch protection rule + value: + contexts: + - continuous-integration/travis-ci + - continuous-integration/jenkins + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + - continuous-integration/jenkins + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: contexts + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set status check contexts + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/set-status-check-contexts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + description: The name of the status checks + items: + type: string + required: + - contexts + example: + contexts: + - contexts + description: The name of the status checks + items: + type: string + examples: + default: + summary: Example updating status checks for a branch protection rule + value: + contexts: + - continuous-integration/travis-ci + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: contexts + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove status check contexts + description: Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - repos + operationId: repos/remove-status-check-contexts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + description: The name of the status checks + items: + type: string + required: + - contexts + example: + contexts: + - contexts + description: The name of the status checks + items: + type: string + examples: + default: + summary: Example removing status checks from a branch protection rule + value: + contexts: + - continuous-integration/jenkins + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: string + examples: + default: + value: + - continuous-integration/travis-ci + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: contexts + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions: + get: + summary: Get access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Lists who has access to this protected branch. + + > [!NOTE] + > Users, apps, and teams `restrictions` are only available for organization-owned repositories. + tags: + - repos + operationId: repos/get-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-restriction-policy' + examples: + default: + $ref: '#/components/examples/branch-restriction-policy' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Delete access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Disables the ability to restrict who can push to this branch. + tags: + - repos + operationId: repos/delete-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps: + get: + summary: Get apps with access to the protected branch + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + tags: + - repos + operationId: repos/get-apps-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add app access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + tags: + - repos + operationId: repos/add-app-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app + examples: + default: + value: + apps: + - octoapp + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: apps + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set app access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + tags: + - repos + operationId: repos/set-app-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app + examples: + default: + value: + apps: + - octoapp + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: apps + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove app access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + tags: + - repos + operationId: repos/remove-app-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + apps: + type: array + description: 'The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items.' + items: + type: string + required: + - apps + example: + apps: + - my-app + examples: + default: + value: + apps: + - my-app + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/integration' + examples: + default: + $ref: '#/components/examples/integration-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: apps + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams: + get: + summary: Get teams with access to the protected branch + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Lists the teams who have push access to this branch. The list includes child teams. + tags: + - repos + operationId: repos/get-teams-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add team access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Grants the specified teams push access for this branch. You can also give push access to child teams. + tags: + - repos + operationId: repos/add-team-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + teams: + type: array + description: The slug values for teams + items: + type: string + required: + - teams + example: + teams: + - my-team + description: The slug values for teams + items: + type: string + examples: + default: + summary: Example adding a team in a branch protection rule + value: + teams: + - justice-league + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: teams + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set team access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + tags: + - repos + operationId: repos/set-team-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + teams: + type: array + description: The slug values for teams + items: + type: string + required: + - teams + example: + teams: + - justice-league + description: The slug values for teams + items: + type: string + examples: + default: + summary: Example replacing a team in a branch protection rule + value: + teams: + - justice-league + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: teams + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove team access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Removes the ability of a team to push to this branch. You can also remove push access for child teams. + tags: + - repos + operationId: repos/remove-team-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + content: + application/json: + schema: + type: object + properties: + teams: + type: array + description: The slug values for teams + items: + type: string + required: + - teams + example: + teams: + - my-team + description: The slug values for teams + items: + type: string + examples: + default: + summary: Example removing a team in a branch protection rule + value: + teams: + - octocats + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: teams + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users: + get: + summary: Get users with access to the protected branch + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Lists the people who have push access to this branch. + tags: + - repos + operationId: repos/get-users-with-access-to-protected-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + post: + summary: Add user access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Grants the specified people push access for this branch. + + | Type | Description | + | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + tags: + - repos + operationId: repos/add-user-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona + examples: + default: + summary: Example adding a user in a branch protection rule + value: + users: + - octocat + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: users + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + put: + summary: Set user access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people. + + | Type | Description | + | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + tags: + - repos + operationId: repos/set-user-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona + examples: + default: + summary: Example replacing a user in a branch protection rule + value: + users: + - octocat + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: users + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + delete: + summary: Remove user access restrictions + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Removes the ability of a user to push to this branch. + + | Type | Description | + | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + tags: + - repos + operationId: repos/remove-user-access-restrictions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + users: + type: array + description: The username for users + items: + type: string + required: + - users + example: + users: + - mona + examples: + default: + summary: Example removing a user in a branch protection rule + value: + users: + - octocat + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + requestBodyParameterName: users + category: branches + subcategory: branch-protection + x-stackQL-resource: branch_protection + /repos/{owner}/{repo}/branches/{branch}/rename: + post: + summary: Rename a branch + description: |- + Renames a branch in a repository. + + > [!NOTE] + > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + + The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. + + In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + tags: + - repos + operationId: repos/rename-branch + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#rename-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_name: + type: string + description: The new name of the branch. + required: + - new_name + examples: + default: + value: + new_name: my_renamed_branch + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/branch-with-protection' + examples: + default: + $ref: '#/components/examples/branch-with-protection' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/codeowners/errors: + get: + summary: List CODEOWNERS errors + description: |- + List any syntax errors that are detected in the CODEOWNERS + file. + + For more information about the correct CODEOWNERS syntax, + see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + tags: + - repos + operationId: repos/codeowners-errors + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-codeowners-errors + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: 'A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository''s default branch (e.g. `main`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/codeowners-errors' + examples: + default: + $ref: '#/components/examples/codeowners-errors' + '404': + description: Resource not found + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/collaborators: + get: + summary: List repository collaborators + description: |- + For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. + + Team members will include the members of child teams. + + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. + OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + tags: + - repos + operationId: repos/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: affiliation + description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. + in: query + required: false + schema: + type: string + enum: + - outside + - direct + - all + default: all + - name: permission + description: Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. + in: query + required: false + schema: + type: string + enum: + - pull + - triage + - push + - maintain + - admin + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/collaborator' + examples: + default: + $ref: '#/components/examples/collaborator-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + /repos/{owner}/{repo}/collaborators/{username}: + get: + summary: Check if a user is a repository collaborator + description: |- + For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. + + Team members will include the members of child teams. + + The authenticated user must have push access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + tags: + - repos + operationId: repos/check-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response if user is a collaborator + '404': + description: Not Found if user is not a collaborator + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + put: + summary: Add a repository collaborator + description: |- + Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + + Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. + + For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + + ``` + Cannot assign {member} permission of {role name} + ``` + + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + + The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). + + For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + + **Updating an existing collaborator's permission level** + + The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. + + **Rate limits** + + You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + tags: + - repos + operationId: repos/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: 'The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.' + default: push + examples: + new-invitation-is-created: + summary: Add a collaborator with triage permissions + value: + permission: triage + responses: + '201': + description: Response when a new invitation is created + content: + application/json: + schema: + $ref: '#/components/schemas/repository-invitation' + examples: + new-invitation-is-created: + $ref: '#/components/examples/repository-invitation-response-when-a-new-invitation-is-created' + '204': + description: |- + Response when: + - an existing collaborator is added as a collaborator + - an organization member is added as an individual collaborator + - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator + '403': + $ref: '#/components/responses/forbidden' + '422': + description: |- + Response when: + - validation failed, or the endpoint has been spammed + - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + delete: + summary: Remove a repository collaborator + description: |- + Removes a collaborator from a repository. + + To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + + This endpoint also: + - Cancels any outstanding invitations sent by the collaborator + - Unassigns the user from any issues + - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + - Unstars the repository + - Updates access permissions to packages + + Removing a user as a collaborator has the following effects on forks: + - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + - If the user had their own fork of the repository, the fork will be deleted. + - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + + > [!NOTE] + > A user can still have access to the repository through organization permissions like base repository permissions. + + Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + + For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + tags: + - repos + operationId: repos/remove-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + responses: + '204': + description: No Content when collaborator was removed from the repository. + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + /repos/{owner}/{repo}/collaborators/{username}/permission: + get: + summary: Get repository permissions for a user + description: |- + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. + + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. + tags: + - repos + operationId: repos/get-collaborator-permission-level + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/username' + responses: + '200': + description: if user has admin permissions + content: + application/json: + schema: + $ref: '#/components/schemas/repository-collaborator-permission' + examples: + response-if-user-has-admin-permissions: + $ref: '#/components/examples/repository-collaborator-permission-response-if-user-has-admin-permissions' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: collaborators + x-stackQL-resource: collaborators + /repos/{owner}/{repo}/comments: + get: + summary: List commit comments for a repository + description: |- + Lists the commit comments for a specified repository. Comments are ordered by ascending ID. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - repos + operationId: repos/list-commit-comments-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/comments/{comment_id}: + get: + summary: Get a commit comment + description: |- + Gets a specified commit comment. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - repos + operationId: repos/get-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#get-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + patch: + summary: Update a commit comment + description: |- + Updates the contents of a specified commit comment. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - repos + operationId: repos/update-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#update-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment + required: + - body + examples: + default: + value: + body: Nice change + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment-2' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + delete: + summary: Delete a commit comment + description: '' + tags: + - repos + operationId: repos/delete-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/comment-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/commits: + get: + summary: List commits + description: |- + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - repos + operationId: repos/list-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#list-commits + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sha + description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' + in: query + required: false + schema: + type: string + - name: path + description: Only commits containing this file path will be returned. + in: query + required: false + schema: + type: string + - name: author + description: GitHub username or email address to use to filter by commit author. + in: query + required: false + schema: + type: string + - name: committer + description: GitHub username or email address to use to filter by commit committer. + in: query + required: false + schema: + type: string + - name: since + description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.' + in: query + required: false + schema: + type: string + format: date-time + - name: until + description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.' + in: query + required: false + schema: + type: string + format: date-time + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit-items' + headers: + Link: + $ref: '#/components/headers/link' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head: + get: + summary: List branches for HEAD commit + description: |- + Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + tags: + - repos + operationId: repos/list-branches-for-head-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/branch-short' + examples: + default: + $ref: '#/components/examples/branch-short-items' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{commit_sha}/comments: + get: + summary: List commit comments + description: |- + Lists the comments for a specified commit. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - repos + operationId: repos/list-comments-for-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#list-commit-comments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + post: + summary: Create a commit comment + description: |- + Create a comment for a commit using its `:commit_sha`. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - repos + operationId: repos/create-commit-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/comments#create-a-commit-comment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The contents of the comment. + path: + type: string + description: Relative path of the file to comment on. + position: + type: integer + description: Line index in the diff to comment on. + line: + type: integer + description: '**Closing down notice**. Use **position** parameter instead. Line number in the file to comment on.' + required: + - body + examples: + default: + value: + body: Great stuff + path: file1.txt + position: 4 + line: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comment' + examples: + default: + $ref: '#/components/examples/commit-comment' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/comments/1 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: comments + x-stackQL-resource: comments + /repos/{owner}/{repo}/commits/{commit_sha}/pulls: + get: + summary: List pull requests associated with a commit + description: |- + Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. + + To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + tags: + - repos + operationId: repos/list-pull-requests-associated-with-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-sha' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/pull-request-simple' + examples: + default: + $ref: '#/components/examples/pull-request-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{ref}: + get: + summary: Get a commit + description: |- + Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. + + > [!NOTE] + > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + + - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - repos + operationId: repos/get-commit + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#get-a-commit + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/commit-ref' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit' + application/vnd.github.diff: + schema: + type: string + examples: + default: + $ref: '#/components/examples/diff-media-type' + application/vnd.github.patch: + schema: + type: string + examples: + default: + $ref: '#/components/examples/patch-media-type' + application/vnd.github.sha: + schema: + type: string + examples: + default: + value: ac3282a2725be3b1d4979169a7a311c89066af1c + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/commits/{ref}/status: + get: + summary: Get the combined status for a specific reference + description: |- + Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. + + + Additionally, a combined `state` is returned. The `state` is one of: + + * **failure** if any of the contexts report as `error` or `failure` + * **pending** if there are no statuses or a context is `pending` + * **success** if the latest status for all contexts is `success` + tags: + - repos + operationId: repos/get-combined-status-for-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/combined-commit-status' + examples: + default: + $ref: '#/components/examples/combined-commit-status' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/commits/{ref}/statuses: + get: + summary: List commit statuses for a reference + description: |- + Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. + + This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + tags: + - repos + operationId: repos/list-commit-statuses-for-ref + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/commit-ref' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/status' + examples: + default: + $ref: '#/components/examples/status-items' + headers: + Link: + $ref: '#/components/headers/link' + '301': + $ref: '#/components/responses/moved_permanently' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/community/profile: + get: + summary: Get community profile metrics + description: |- + Returns all community profile metrics for a repository. The repository cannot be a fork. + + The returned metrics include an overall health score, the repository description, the presence of documentation, the + detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE, + README, and CONTRIBUTING files. + + The `health_percentage` score is defined as a percentage of how many of + the recommended community health files are present. For more information, see + "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + + `content_reports_enabled` is only returned for organization-owned repositories. + tags: + - repos + operationId: repos/get-community-profile-metrics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/community-profile' + examples: + default: + $ref: '#/components/examples/community-profile' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: community + x-stackQL-resource: community + /repos/{owner}/{repo}/compare/{basehead}: + get: + summary: Compare two commits + description: |- + Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + + This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.diff`**: Returns the diff of the commit. + - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + + The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. + + When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + + **Working with large comparisons** + + To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination: + + - The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison. + - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results. + + For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)." + + **Signature verification object** + + The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields: + + | Name | Type | Description | + | ---- | ---- | ----------- | + | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + | `signature` | `string` | The signature that was extracted from the commit. | + | `payload` | `string` | The value that was signed. | + | `verified_at` | `string` | The date the signature was verified by GitHub. | + + These are the possible values for `reason` in the `verification` object: + + | Value | Description | + | ----- | ----------- | + | `expired_key` | The key that made the signature is expired. | + | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + | `gpgverify_error` | There was an error communicating with the signature verification service. | + | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + | `unsigned` | The object does not include a signature. | + | `unknown_signature_type` | A non-PGP signature was found in the commit. | + | `no_user` | No user was associated with the `committer` email address in the commit. | + | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + | `unknown_key` | The key that made the signature has not been registered with any user's account. | + | `malformed_signature` | There was an error parsing the signature. | + | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + | `valid` | None of the above errors applied, so the signature is considered to be verified. | + tags: + - repos + operationId: repos/compare-commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/commits#compare-two-commits + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - name: basehead + description: The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. + in: path + required: true + x-multi-segment: true + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/commit-comparison' + examples: + default: + $ref: '#/components/examples/commit-comparison' + application/vnd.github.diff: + schema: + type: string + examples: + default: + $ref: '#/components/examples/diff-media-type' + application/vnd.github.patch: + schema: + type: string + examples: + default: + $ref: '#/components/examples/patch-media-type' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: commits + x-stackQL-resource: commits + /repos/{owner}/{repo}/contents/{path}: + get: + summary: Get repository content + description: |- + Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + + If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + + If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + + If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + + **Notes**: + + - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + - If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. + tags: + - repos + operationId: repos/get-content + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#get-repository-content + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: path + description: path parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' + in: query + required: false + schema: + type: string + requestBody: + required: false + content: + application/json: + examples: + response-if-content-is-a-file-github-object: + summary: Content is a file using the object media type + response-if-content-is-a-directory-github-object: + summary: Content is a directory using the object media type + response-if-content-is-a-file: + summary: Content is a file + response-if-content-is-a-directory: + summary: Content is a directory + response-if-content-is-a-symlink: + summary: Content is a symlink + response-if-content-is-a-submodule: + summary: Content is a submodule + responses: + '200': + description: Response + content: + application/vnd.github.object: + schema: + $ref: '#/components/schemas/content-tree' + examples: + response-if-content-is-a-file-github-object: + $ref: '#/components/examples/content-file-response-if-content-is-a-file' + response-if-content-is-a-directory-github-object: + $ref: '#/components/examples/content-file-response-if-content-is-a-directory-object' + application/json: + schema: + discriminator: + propertyName: type + mapping: + array: '#/components/schemas/content-directory' + file: '#/components/schemas/content-file' + symlink: '#/components/schemas/content-symlink' + submodule: '#/components/schemas/content-submodule' + title: Content Directory + description: A list of directory items + type: array + items: + type: object + properties: + type: + type: string + enum: + - dir + - file + - submodule + - symlink + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + properties: + type: + type: string + enum: + - file + encoding: + type: string + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + example: '"actual/actual.md"' + submodule_git_url: + type: string + example: '"git://example.com/defunkt/dotjs.git"' + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + - target + - submodule_git_url + examples: + response-if-content-is-a-file: + $ref: '#/components/examples/content-file-response-if-content-is-a-file' + response-if-content-is-a-directory: + $ref: '#/components/examples/content-file-response-if-content-is-a-directory' + response-if-content-is-a-symlink: + $ref: '#/components/examples/content-file-response-if-content-is-a-symlink' + response-if-content-is-a-submodule: + $ref: '#/components/examples/content-file-response-if-content-is-a-submodule' + '302': + $ref: '#/components/responses/found' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-github-breaking-changes: + - changeset: return_submodule_type_for_submodules_in_directory_lists + patch: + description: |- + Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + + If the content is a directory: The response will be an array of objects, one object for each item in the directory. + + If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + + If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + + **Notes**: + + - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + - If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. + version: '2026-03-10' + x-stackQL-resource: contents + put: + summary: Create or update file contents + description: |- + Creates a new file or replaces an existing file in a repository. + + > [!NOTE] + > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + tags: + - repos + operationId: repos/create-or-update-file-contents + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: path + description: path parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The commit message. + content: + type: string + description: The new file content, using Base64 encoding. + sha: + type: string + description: '**Required if you are updating a file**. The blob SHA of the file being replaced.' + branch: + type: string + description: 'The branch name. Default: the repository’s default branch.' + committer: + type: object + description: 'The person that committed the file. Default: the authenticated user.' + properties: + name: + type: string + description: The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. + email: + type: string + description: The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. + date: + type: string + example: '"2013-01-05T13:13:22+05:00"' + required: + - name + - email + author: + type: object + description: 'The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.' + properties: + name: + type: string + description: The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. + email: + type: string + description: The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. + date: + type: string + example: '"2013-01-15T17:13:22+05:00"' + required: + - name + - email + required: + - message + - content + examples: + example-for-creating-a-file: + summary: Example for creating a file + value: + message: my commit message + committer: + name: Monalisa Octocat + email: octocat@github.com + content: bXkgbmV3IGZpbGUgY29udGVudHM= + example-for-updating-a-file: + summary: Example for updating a file + value: + message: a new commit message + committer: + name: Monalisa Octocat + email: octocat@github.com + content: bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz + sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/file-commit' + examples: + example-for-updating-a-file: + $ref: '#/components/examples/file-commit-example-for-updating-a-file' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/file-commit' + examples: + example-for-creating-a-file: + $ref: '#/components/examples/file-commit-example-for-creating-a-file' + '404': + $ref: '#/components/responses/not_found' + '409': + description: Conflict + content: + application/json: + schema: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id' + token_type: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + delete: + summary: Delete a file + description: |- + Deletes a file in a repository. + + You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + + The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + + You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + + > [!NOTE] + > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + tags: + - repos + operationId: repos/delete-file + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#delete-a-file + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: path + description: path parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: The commit message. + sha: + type: string + description: The blob SHA of the file being deleted. + branch: + type: string + description: 'The branch name. Default: the repository’s default branch' + committer: + type: object + description: object containing information about the committer. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + author: + type: object + description: object containing information about the author. + properties: + name: + type: string + description: The name of the author (or committer) of the commit + email: + type: string + description: The email of the author (or committer) of the commit + required: + - message + - sha + examples: + default: + value: + message: my commit message + committer: + name: Monalisa Octocat + email: octocat@github.com + sha: 329688480d39049927147c162b9d2deaf885005f + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/file-commit' + examples: + default: + $ref: '#/components/examples/file-commit' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/contributors: + get: + summary: List repository contributors + description: |- + Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance. + + GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. + tags: + - repos + operationId: repos/list-contributors + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-contributors + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: anon + description: Set to `1` or `true` to include anonymous contributors in results. + in: query + required: false + schema: + type: string + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: If repository contains content + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/contributor' + examples: + response-if-repository-contains-content: + $ref: '#/components/examples/contributor-items-response-if-repository-contains-content' + headers: + Link: + $ref: '#/components/headers/link' + '204': + description: Response if repository is empty + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/deployments: + get: + summary: List deployments + description: 'Simple filtering of deployments is available via query parameters:' + tags: + - repos + operationId: repos/list-deployments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/deployments#list-deployments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sha + description: The SHA recorded at creation time. + in: query + required: false + schema: + type: string + default: none + - name: ref + description: The name of the ref. This can be a branch, tag, or SHA. + in: query + required: false + schema: + type: string + default: none + - name: task + description: The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). + in: query + required: false + schema: + type: string + default: none + - name: environment + description: The name of the environment that was deployed to (e.g., `staging` or `production`). + in: query + required: false + schema: + type: string + default: none + nullable: true + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deployment' + examples: + default: + $ref: '#/components/examples/deployment-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + post: + summary: Create a deployment + description: |- + Deployments offer a few configurable parameters with certain defaults. + + The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + before we merge a pull request. + + The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + makes it easier to track which environments have requested deployments. The default environment is `production`. + + The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + return a failure response. + + By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` + state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + not require any contexts or create any commit statuses, the deployment will always succeed. + + The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + field that will be passed on when a deployment event is dispatched. + + The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + application with debugging enabled. + + Merged branch response: + + You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + a deployment. This auto-merge happens when: + * Auto-merge option is enabled in the repository + * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * There are no merge conflicts + + If there are no new commits in the base branch, a new request to create a deployment should give a successful + response. + + Merge conflict response: + + This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + + Failed commit status checks: + + This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/deployments#create-a-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + ref: + type: string + description: The ref to deploy. This can be a branch, tag, or SHA. + task: + type: string + description: Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). + default: deploy + auto_merge: + type: boolean + description: Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + default: true + required_contexts: + type: array + description: The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + items: + type: string + payload: + type: object + additionalProperties: true + description: JSON payload with extra information about the deployment. + default: '' + environment: + type: string + description: Name for the target deployment environment (e.g., `production`, `staging`, `qa`). + default: production + description: + type: string + description: Short description of the deployment. + default: '' + nullable: true + transient_environment: + type: boolean + description: 'Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`' + default: false + production_environment: + type: boolean + description: 'Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.' + required: + - ref + examples: + simple-example: + summary: Simple example + value: + ref: topic-branch + payload: '{ "deploy": "migrate" }' + description: Deploy request from hubot + advanced-example: + summary: Advanced example + value: + ref: topic-branch + auto_merge: false + payload: '{ "deploy": "migrate" }' + description: Deploy request from hubot + required_contexts: + - ci/janky + - security/brakeman + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment' + examples: + simple-example: + $ref: '#/components/examples/deployment-simple-example' + '202': + description: Merged branch response + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + merged-branch-response: + value: + message: Auto-merged master into topic-branch on deployment. + '409': + description: Conflict when there is a merge conflict or the commit's status checks failed + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + /repos/{owner}/{repo}/deployments/{deployment_id}: + get: + summary: Get a deployment + description: '' + tags: + - repos + operationId: repos/get-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/deployments#get-a-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment' + examples: + default: + $ref: '#/components/examples/deployment' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + delete: + summary: Delete a deployment + description: |- + If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. + + To set a deployment as inactive, you must: + + * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. + * Mark the active deployment as inactive by adding any non-successful deployment status. + + For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + tags: + - repos + operationId: repos/delete-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: deployments + x-stackQL-resource: deployments + /repos/{owner}/{repo}/deployments/{deployment_id}/statuses: + get: + summary: List deployment statuses + description: 'Users with pull access can view deployment statuses for a deployment:' + tags: + - repos + operationId: repos/list-deployment-statuses + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deployment-status' + examples: + default: + $ref: '#/components/examples/deployment-status-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: statuses + x-stackQL-resource: statuses + post: + summary: Create a deployment status + description: |- + Users with `push` access can create deployment statuses for a given deployment. + + OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment-status + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. + enum: + - error + - failure + - inactive + - in_progress + - queued + - pending + - success + target_url: + type: string + description: |- + The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + + > [!NOTE] + > It's recommended to use the `log_url` parameter, which replaces `target_url`. + default: '' + log_url: + type: string + description: 'The full URL of the deployment''s output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`' + default: '' + description: + type: string + description: A short description of the status. The maximum description length is 140 characters. + default: '' + environment: + type: string + description: Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. + environment_url: + type: string + description: 'Sets the URL for accessing your environment. Default: `""`' + default: '' + auto_inactive: + type: boolean + description: 'Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status''s deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`' + required: + - state + examples: + default: + value: + environment: production + state: success + log_url: https://example.com/deployment/42/output + description: Deployment finished successfully. + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-status' + examples: + default: + $ref: '#/components/examples/deployment-status' + headers: + Location: + example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + schema: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}: + get: + summary: Get a deployment status + description: 'Users with pull access can view a deployment status for a deployment:' + tags: + - repos + operationId: repos/get-deployment-status + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/deployment-id' + - name: status_id + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-status' + examples: + default: + $ref: '#/components/examples/deployment-status' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/dispatches: + post: + summary: Create a repository dispatch event + description: |- + You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." + + The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + + This input example shows how you can use the `client_payload` as a test to debug your workflow. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/create-dispatch-event + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - event_type + properties: + event_type: + type: string + description: A custom webhook event name. Must be 100 characters or fewer. + minLength: 1 + maxLength: 100 + client_payload: + type: object + description: JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. + additionalProperties: true + maxProperties: 10 + examples: + default: + value: + event_type: on-demand-test + client_payload: + unit: false + integration: true + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/environments: + get: + summary: List environments + description: |- + Lists the environments for a repository. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-all-environments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/environments#list-environments + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of environments in this repository + example: 5 + type: integer + environments: + type: array + items: + $ref: '#/components/schemas/environment' + examples: + default: + $ref: '#/components/examples/environments' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + /repos/{owner}/{repo}/environments/{environment_name}: + get: + summary: Get an environment + description: |- + > [!NOTE] + > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-environment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/environments#get-an-environment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/environment' + examples: + default: + $ref: '#/components/examples/environment' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + put: + summary: Create or update an environment + description: |- + Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." + + > [!NOTE] + > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + + > [!NOTE] + > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-environment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + wait_timer: + $ref: '#/components/schemas/wait-timer' + prevent_self_review: + $ref: '#/components/schemas/prevent-self-review' + reviewers: + type: array + nullable: true + description: The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + items: + type: object + properties: + type: + $ref: '#/components/schemas/deployment-reviewer-type' + id: + type: integer + description: The id of the user or team who can review the deployment + example: 4532992 + deployment_branch_policy: + $ref: '#/components/schemas/deployment-branch-policy-settings' + additionalProperties: false + examples: + default: + value: + wait_timer: 30 + prevent_self_review: false + reviewers: + - type: User + id: 1 + - type: Team + id: 1 + deployment_branch_policy: + protected_branches: false + custom_branch_policies: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/environment' + examples: + default: + $ref: '#/components/examples/environment' + '422': + description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + delete: + summary: Delete an environment + description: OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/delete-an-environment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/environments#delete-an-environment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + responses: + '204': + description: Default response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: environments + x-stackQL-resource: environments + /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies: + get: + summary: List deployment branch policies + description: |- + Lists the deployment branch policies for an environment. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/list-deployment-branch-policies + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment branch policies for the environment. + type: integer + example: 2 + branch_policies: + type: array + items: + $ref: '#/components/schemas/deployment-branch-policy' + required: + - total_count + - branch_policies + examples: + default: + $ref: '#/components/examples/deployment-branch-policies-list' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + post: + summary: Create a deployment branch policy + description: |- + Creates a deployment branch or tag policy for an environment. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment-branch-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy-name-pattern-with-type' + examples: + example-wildcard: + summary: Example of a wildcard name pattern + value: + name: release/* + example-single-branch: + summary: Example of a single branch name pattern + value: + name: main + type: branch + example-single-tag: + summary: Example of a single tag name pattern + value: + name: v1 + type: tag + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy' + examples: + example-wildcard: + $ref: '#/components/examples/deployment-branch-policy-wildcard' + example-single-branch: + $ref: '#/components/examples/deployment-branch-policy-single-branch' + example-single-tag: + $ref: '#/components/examples/deployment-branch-policy-single-tag' + '303': + description: Response if the same branch name pattern already exists + '404': + description: Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}: + get: + summary: Get a deployment branch policy + description: |- + Gets a deployment branch or tag policy for an environment. + + Anyone with read access to the repository can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-deployment-branch-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/branch-policy-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy' + examples: + default: + $ref: '#/components/examples/deployment-branch-policy-wildcard' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + put: + summary: Update a deployment branch policy + description: |- + Updates a deployment branch or tag policy for an environment. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/update-deployment-branch-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/branch-policy-id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy-name-pattern' + examples: + default: + value: + name: release/* + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-branch-policy' + examples: + default: + $ref: '#/components/examples/deployment-branch-policy-wildcard' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + delete: + summary: Delete a deployment branch policy + description: |- + Deletes a deployment branch or tag policy for an environment. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/delete-deployment-branch-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/branch-policy-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: branch-policies + x-stackQL-resource: branch_policies + /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules: + get: + summary: Get all deployment protection rules for an environment + description: |- + Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-all-deployment-protection-rules + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + responses: + '200': + description: List of deployment protection rules + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of enabled custom deployment protection rules for this environment + type: integer + example: 10 + custom_deployment_protection_rules: + type: array + items: + $ref: '#/components/schemas/deployment-protection-rule' + example: + $ref: '#/components/examples/deployment-protection-rules' + examples: + default: + value: + total_count: 2 + custom_deployment_protection_rules: + - id: 3 + node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv + enabled: true + app: + id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + - id: 4 + node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 + enabled: true + app: + id: 1 + node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy + slug: another-custom-app + integration_url: https://api.github.com/apps/another-custom-app + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + post: + summary: Create a custom deployment protection rule on an environment + description: |- + Enable a custom deployment protection rule for an environment. + + The authenticated user must have admin or owner permissions to the repository to use this endpoint. + + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/create-deployment-protection-rule + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + requestBody: + content: + application/json: + schema: + type: object + properties: + integration_id: + type: integer + description: The ID of the custom app that will be enabled on the environment. + examples: + default: + value: + integration_id: 5 + required: true + responses: + '201': + description: The enabled custom deployment protection rule + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-protection-rule' + examples: + default: + $ref: '#/components/examples/deployment-protection-rule' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps: + get: + summary: List custom deployment rule integrations available for an environment + description: |- + Gets all custom deployment protection rule integrations that are available for an environment. + + The authenticated user must have admin or owner permissions to the repository to use this endpoint. + + For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/list-custom-deployment-rule-integrations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: A list of custom deployment rule integrations available for this environment. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The total number of custom deployment protection rule integrations available for this environment. + type: integer + example: 35 + available_custom_deployment_protection_rule_integrations: + type: array + items: + $ref: '#/components/schemas/custom-deployment-rule-app' + examples: + default: + $ref: '#/components/examples/custom-deployment-protection-rule-apps' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}: + get: + summary: Get a custom deployment protection rule + description: |- + Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + + For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/get-custom-deployment-protection-rule + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/protection-rule-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deployment-protection-rule' + examples: + default: + $ref: '#/components/examples/deployment-protection-rule' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + delete: + summary: Disable a custom protection rule for an environment + description: |- + Disables a custom deployment protection rule for an environment. + + The authenticated user must have admin or owner permissions to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/disable-deployment-protection-rule + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment + parameters: + - $ref: '#/components/parameters/environment-name' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/protection-rule-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deployments + subcategory: protection-rules + x-stackQL-resource: protection_rules + /repos/{owner}/{repo}/forks: + get: + summary: List forks + description: '' + tags: + - repos + operationId: repos/list-forks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/forks#list-forks + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sort + description: The sort order. `stargazers` will sort by star count. + in: query + required: false + schema: + type: string + enum: + - newest + - oldest + - stargazers + - watchers + default: newest + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items-2' + headers: + Link: + $ref: '#/components/headers/link' + '400': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: forks + x-stackQL-resource: forks + post: + summary: Create a fork + description: |- + Create a fork for the authenticated user. + + > [!NOTE] + > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + + > [!NOTE] + > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + tags: + - repos + operationId: repos/create-fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/forks#create-a-fork + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + organization: + type: string + description: Optional parameter to specify the organization name if forking into an organization. + name: + type: string + description: When forking from an existing repository, a new name for the fork. + default_branch_only: + type: boolean + description: When forking from an existing repository, fork with only the default branch. + examples: + default: + value: + organization: octocat + name: Hello-World + default_branch_only: true + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: forks + x-stackQL-resource: forks + /repos/{owner}/{repo}/hooks: + get: + summary: List repository webhooks + description: Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. + tags: + - repos + operationId: repos/list-webhooks + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + post: + summary: Create a repository webhook + description: |- + Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can + share the same `config` as long as those webhooks do not have any `events` that overlap. + tags: + - repos + operationId: repos/create-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + nullable: true + properties: + name: + type: string + description: 'Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.' + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + events: + type: array + description: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + default: + - push + items: + type: string + active: + type: boolean + description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + default: true + additionalProperties: false + examples: + default: + value: + name: web + active: true + events: + - push + - pull_request + config: + url: https://example.com/webhook + content_type: json + insecure_ssl: '0' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 + schema: + type: string + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}: + get: + summary: Get a repository webhook + description: Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." + tags: + - repos + operationId: repos/get-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a repository webhook + description: Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." + tags: + - repos + operationId: repos/update-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + config: + $ref: '#/components/schemas/webhook-config' + events: + type: array + description: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + default: + - push + items: + type: string + add_events: + type: array + description: Determines a list of events to be added to the list of events that the Hook triggers for. + items: + type: string + remove_events: + type: array + description: Determines a list of events to be removed from the list of events that the Hook triggers for. + items: + type: string + active: + type: boolean + description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + default: true + examples: + default: + value: + active: true + add_events: + - pull_request + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook' + examples: + default: + $ref: '#/components/examples/hook' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + delete: + summary: Delete a repository webhook + description: |- + Delete a webhook for an organization. + + The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + tags: + - repos + operationId: repos/delete-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/config: + get: + summary: Get a webhook configuration for a repository + description: |- + Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." + + OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/get-webhook-config-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + patch: + summary: Update a webhook configuration for a repository + description: |- + Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." + + OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/update-webhook-config-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + examples: + default: + summary: Example of updating content type and URL + value: + content_type: json + url: https://example.com/webhook + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/webhook-config' + examples: + default: + $ref: '#/components/examples/webhook-config' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/deliveries: + get: + summary: List deliveries for a repository webhook + description: Returns a list of webhook deliveries for a webhook configured in a repository. + tags: + - repos + operationId: repos/list-webhook-deliveries + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/cursor' + - $ref: '#/components/parameters/webhook-delivery-status' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/hook-delivery-item' + examples: + default: + $ref: '#/components/examples/hook-delivery-items' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}: + get: + summary: Get a delivery for a repository webhook + description: Returns a delivery for a webhook configured in a repository. + tags: + - repos + operationId: repos/get-webhook-delivery + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hook-delivery' + examples: + default: + $ref: '#/components/examples/hook-delivery' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts: + post: + summary: Redeliver a delivery for a repository webhook + description: Redeliver a webhook delivery for a webhook configured in a repository. + tags: + - repos + operationId: repos/redeliver-webhook-delivery + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + - $ref: '#/components/parameters/delivery-id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/pings: + post: + summary: Ping a repository webhook + description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + tags: + - repos + operationId: repos/ping-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/hooks/{hook_id}/tests: + post: + summary: Test the push repository webhook + description: |- + This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. + + > [!NOTE] + > Previously `/repos/:owner/:repo/hooks/:hook_id/test` + tags: + - repos + operationId: repos/test-push-webhook + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/hook-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: webhooks + x-stackQL-resource: webhooks + /repos/{owner}/{repo}/immutable-releases: + get: + summary: Check if immutable releases are enabled for a repository + description: |- + Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + enforced by the repository owner. The authenticated user must have admin read access to the repository. + tags: + - repos + operationId: repos/check-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response if immutable releases are enabled + content: + application/json: + schema: + $ref: '#/components/schemas/check-immutable-releases' + examples: + default: + value: + enabled: true + enforced_by_owner: false + '404': + description: Not Found if immutable releases are not enabled for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable immutable releases + description: Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + tags: + - repos + operationId: repos/enable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-immutable-releases + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable immutable releases + description: Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + tags: + - repos + operationId: repos/disable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-immutable-releases + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/invitations: + get: + summary: List repository invitations + description: When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + tags: + - repos + operationId: repos/list-invitations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-invitation' + examples: + default: + $ref: '#/components/examples/repository-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /repos/{owner}/{repo}/invitations/{invitation_id}: + patch: + summary: Update a repository invitation + description: '' + tags: + - repos + operationId: repos/update-invitation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/invitation-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permissions: + type: string + description: The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. + enum: + - read + - write + - maintain + - triage + - admin + examples: + default: + summary: Example request body + value: + permissions: write + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-invitation' + examples: + default: + $ref: '#/components/examples/repository-invitation' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + delete: + summary: Delete a repository invitation + description: '' + tags: + - repos + operationId: repos/delete-invitation + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /repos/{owner}/{repo}/keys: + get: + summary: List deploy keys + description: '' + tags: + - repos + operationId: repos/list-deploy-keys + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/deploy-key' + examples: + default: + $ref: '#/components/examples/deploy-key-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + post: + summary: Create a deploy key + description: You can create a read-only deploy key. + tags: + - repos + operationId: repos/create-deploy-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: A name for the key. + key: + type: string + description: The contents of the key. + read_only: + type: boolean + description: |- + If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + + Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." + required: + - key + examples: + default: + value: + title: octocat@octomac + key: ssh-rsa AAA... + read_only: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deploy-key' + examples: + default: + $ref: '#/components/examples/deploy-key' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/keys/1 + schema: + type: string + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + /repos/{owner}/{repo}/keys/{key_id}: + get: + summary: Get a deploy key + description: '' + tags: + - repos + operationId: repos/get-deploy-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/deploy-key' + examples: + default: + $ref: '#/components/examples/deploy-key' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + delete: + summary: Delete a deploy key + description: Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. + tags: + - repos + operationId: repos/delete-deploy-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/key-id' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: deploy-keys + subcategory: deploy-keys + x-stackQL-resource: deploy_keys + /repos/{owner}/{repo}/languages: + get: + summary: List repository languages + description: Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. + tags: + - repos + operationId: repos/list-languages + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-languages + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/language' + examples: + default: + $ref: '#/components/examples/language' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/merge-upstream: + post: + summary: Sync a fork branch with the upstream repository + description: Sync a branch of a forked repository to keep it up-to-date with the upstream repository. + tags: + - repos + operationId: repos/merge-upstream + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + branch: + type: string + description: The name of the branch which should be updated to match upstream. + required: + - branch + examples: + default: + value: + branch: main + responses: + '200': + description: The branch has been successfully synced with the upstream repository + content: + application/json: + schema: + $ref: '#/components/schemas/merged-upstream' + examples: + default: + $ref: '#/components/examples/merged-upstream' + '409': + description: The branch could not be synced because of a merge conflict + '422': + description: The branch could not be synced for some other reason + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/merges: + post: + summary: Merge a branch + description: '' + tags: + - repos + operationId: repos/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/branches/branches#merge-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + base: + type: string + description: The name of the base branch that the head will be merged into. + head: + type: string + description: The head to merge. This can be a branch name or a commit SHA1. + commit_message: + type: string + description: Commit message to use for the merge commit. If omitted, a default message will be used. + required: + - base + - head + examples: + default: + value: + base: master + head: cool_feature + commit_message: Shipped cool_feature! + responses: + '201': + description: Successful Response (The resulting merge commit) + content: + application/json: + schema: + $ref: '#/components/schemas/commit' + examples: + default: + $ref: '#/components/examples/commit' + '204': + description: Response when already merged + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found when the base or head does not exist + '409': + description: Conflict when there is a merge conflict + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: branches + subcategory: branches + x-stackQL-resource: branches + /repos/{owner}/{repo}/pages: + get: + summary: Get a GitHub Pages site + description: |- + Gets information about a GitHub Pages site. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/get-pages + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page' + examples: + default: + $ref: '#/components/examples/page' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + post: + summary: Create a GitHub Pages site + description: |- + Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." + + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/create-pages-site + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The source branch and directory used to publish your Pages site. + nullable: true + properties: + build_type: + type: string + description: The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + enum: + - legacy + - workflow + source: + type: object + description: The source branch and directory used to publish your Pages site. + properties: + branch: + type: string + description: The repository branch used to publish your site's source files. + path: + type: string + description: 'The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`' + enum: + - / + - /docs + default: / + required: + - branch + required: + - source + - build_type + examples: + default: + value: + source: + branch: main + path: /docs + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page' + examples: + default: + $ref: '#/components/examples/page' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + put: + summary: Update information about a GitHub Pages site + description: |- + Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). + + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/update-information-about-pages-site + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + cname: + type: string + description: Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." + nullable: true + https_enforced: + type: boolean + description: Specify whether HTTPS should be enforced for the repository. + build_type: + type: string + description: The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. + enum: + - legacy + - workflow + source: + type: string + description: Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`. + enum: + - gh-pages + - master + - master /docs + properties: + branch: + type: string + description: The repository branch used to publish your site's source files. + path: + type: string + description: The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + enum: + - / + - /docs + required: + - branch + - path + required: + - build_type + - source + - cname + - public + - https_enforced + examples: + default: + value: + cname: octocatblog.com + source: + branch: main + path: / + responses: + '204': + description: Response + '400': + $ref: '#/components/responses/bad_request' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + delete: + summary: Delete a GitHub Pages site + description: |- + Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). + + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/delete-pages-site + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/builds: + get: + summary: List GitHub Pages builds + description: |- + Lists builts of a GitHub Pages site. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/list-pages-builds + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/page-build' + examples: + default: + $ref: '#/components/examples/page-build-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + post: + summary: Request a GitHub Pages build + description: |- + You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. + + Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + tags: + - repos + operationId: repos/request-pages-build + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-build-status' + examples: + default: + $ref: '#/components/examples/page-build-status' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/builds/latest: + get: + summary: Get latest Pages build + description: |- + Gets information about the single most recent build of a GitHub Pages site. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/get-latest-pages-build + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-latest-pages-build + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-build' + examples: + default: + $ref: '#/components/examples/page-build' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/builds/{build_id}: + get: + summary: Get GitHub Pages build + description: |- + Gets information about a GitHub Pages build. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/get-pages-build + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: build_id + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-build' + examples: + default: + $ref: '#/components/examples/page-build' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/deployments: + post: + summary: Create a GitHub Pages deployment + description: |- + Create a GitHub Pages deployment for a repository. + + The authenticated user must have write permission to the repository. + tags: + - repos + operationId: repos/create-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The object used to create GitHub Pages deployment + properties: + artifact_id: + type: number + description: The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. + artifact_url: + type: string + description: The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. + environment: + type: string + description: The target environment for this GitHub Pages deployment. + default: github-pages + pages_build_version: + type: string + description: A unique string that represents the version of the build for this deployment. + default: GITHUB_SHA + oidc_token: + type: string + description: The OIDC token issued by GitHub Actions certifying the origin of the deployment. + required: + - pages_build_version + - oidc_token + examples: + default: + value: + artifact_url: https://downloadcontent/ + environment: github-pages + pages_build_version: 4fd754f7e594640989b406850d0bc8f06a121251 + oidc_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/page-deployment' + examples: + default: + $ref: '#/components/examples/page-deployment' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}: + get: + summary: Get the status of a GitHub Pages deployment + description: |- + Gets the current status of a GitHub Pages deployment. + + The authenticated user must have read permission for the GitHub Pages site. + tags: + - repos + operationId: repos/get-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pages-deployment-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pages-deployment-status' + examples: + default: + $ref: '#/components/examples/pages-deployment-status' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel: + post: + summary: Cancel a GitHub Pages deployment + description: |- + Cancels a GitHub Pages deployment. + + The authenticated user must have write permissions for the GitHub Pages site. + tags: + - repos + operationId: repos/cancel-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/pages-deployment-id' + responses: + '204': + $ref: '#/components/responses/no_content' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/pages/health: + get: + summary: Get a DNS health check for GitHub Pages + description: |- + Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. + + The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. + + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - repos + operationId: repos/get-pages-health-check + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/pages-health-check' + examples: + default: + $ref: '#/components/examples/pages-health-check' + '202': + description: Empty response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '400': + description: Custom domains are not available for GitHub Pages + '404': + $ref: '#/components/responses/not_found' + '422': + description: There isn't a CNAME for this page + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + x-stackQL-resource: pages + /repos/{owner}/{repo}/private-vulnerability-reporting: + get: + summary: Check if private vulnerability reporting is enabled for a repository + description: Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + tags: + - repos + operationId: repos/check-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Private vulnerability reporting status + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether or not private vulnerability reporting is enabled for the repository. + required: + - enabled + examples: + default: + value: + enabled: true + '422': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable private vulnerability reporting for a repository + description: Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + tags: + - repos + operationId: repos/enable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '422': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable private vulnerability reporting for a repository + description: Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + tags: + - repos + operationId: repos/disable-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + $ref: '#/components/responses/no_content' + '422': + $ref: '#/components/responses/bad_request' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/properties/values: + get: + summary: Get all custom property values for a repository + description: |- + Gets all custom property values that are set for a repository. + Users with read access to the repository can use this endpoint. + tags: + - repos + operationId: repos/custom-properties-for-repos-get-repository-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/custom-property-value' + examples: + default: + $ref: '#/components/examples/custom-property-values' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties + x-stackQL-resource: custom_properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + tags: + - repos + operationId: repos/custom-properties-for-repos-create-or-update-repository-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values to apply to the repositories. + items: + $ref: '#/components/schemas/custom-property-value' + required: + - properties + examples: + default: + $ref: '#/components/examples/create-or-update-custom-properties-values' + responses: + '204': + description: No Content when custom property values are successfully created or updated + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties + x-stackQL-resource: custom_properties + /repos/{owner}/{repo}/readme: + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + tags: + - repos + operationId: repos/get-readme + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#get-a-repository-readme + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/content-file' + examples: + default: + $ref: '#/components/examples/content-file' + '304': + $ref: '#/components/responses/not_modified' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/readme/{dir}: + get: + summary: Get a repository README for a directory + description: |- + Gets the README from a repository directory. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + tags: + - repos + operationId: repos/get-readme-in-directory + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/content-file' + examples: + default: + $ref: '#/components/examples/content-file' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/releases: + get: + summary: List releases + description: |- + This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags). + + Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + tags: + - repos + operationId: repos/list-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#list-releases + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + post: + summary: Create a release + description: |- + Users with push access to the repository can create a release. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - repos + operationId: repos/create-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#create-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tag_name: + type: string + description: The name of the tag. + target_commitish: + type: string + description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository''s default branch.' + name: + type: string + description: The name of the release. + body: + type: string + description: Text describing the contents of the tag. + draft: + type: boolean + description: '`true` to create a draft (unpublished) release, `false` to create a published one.' + default: false + prerelease: + type: boolean + description: '`true` to identify the release as a prerelease. `false` to identify the release as a full release.' + default: false + discussion_category_name: + type: string + description: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + generate_release_notes: + type: boolean + description: Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. + default: false + make_latest: + type: string + description: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. + enum: + - 'true' + - 'false' + - legacy + default: 'true' + required: + - tag_name + examples: + default: + value: + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + generate_release_notes: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/releases/1 + schema: + type: string + '404': + description: Not Found if the discussion category name is invalid + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/assets/{asset_id}: + get: + summary: Get a release asset + description: |- + To download the asset's binary content: + + - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + - Alternatively, set the `Accept` header of the request to + [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + The API will either redirect the client to the location, or stream it directly if possible. + API clients should handle both a `200` or `302` response. + tags: + - repos + operationId: repos/get-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#get-a-release-asset + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/asset-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release-asset' + examples: + default: + $ref: '#/components/examples/release-asset' + '302': + $ref: '#/components/responses/found' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + patch: + summary: Update a release asset + description: Users with push access to the repository can edit a release asset. + tags: + - repos + operationId: repos/update-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#update-a-release-asset + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/asset-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The file name of the asset. + label: + type: string + description: An alternate short description of the asset. Used in place of the filename. + state: + type: string + example: '"uploaded"' + examples: + default: + value: + name: foo-1.0.0-osx.zip + label: Mac binary + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release-asset' + examples: + default: + $ref: '#/components/examples/release-asset' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + delete: + summary: Delete a release asset + description: '' + tags: + - repos + operationId: repos/delete-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#delete-a-release-asset + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/asset-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + /repos/{owner}/{repo}/releases/generate-notes: + post: + summary: Generate release notes content for a release + description: Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + tags: + - repos + operationId: repos/generate-release-notes + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + tag_name: + type: string + description: The tag name for the release. This can be an existing tag or a new one. + target_commitish: + type: string + description: Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. + previous_tag_name: + type: string + description: The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. + configuration_file_path: + type: string + description: Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. + required: + - tag_name + examples: + default: + value: + tag_name: v1.0.0 + target_commitish: main + previous_tag_name: v0.9.2 + configuration_file_path: .github/custom_release_config.yml + responses: + '200': + description: Name and body of generated release notes + content: + application/json: + schema: + $ref: '#/components/schemas/release-notes-content' + examples: + default: + $ref: '#/components/examples/release-notes-content' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/latest: + get: + summary: Get the latest release + description: |- + View the latest published full release for the repository. + + The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + tags: + - repos + operationId: repos/get-latest-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#get-the-latest-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/tags/{tag}: + get: + summary: Get a release by tag name + description: Get a published release with the specified tag. + tags: + - repos + operationId: repos/get-release-by-tag + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: tag + description: tag parameter + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/{release_id}: + get: + summary: Get a release + description: |- + Gets a public release with the specified release ID. + + > [!NOTE] + > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + tags: + - repos + operationId: repos/get-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#get-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + responses: + '200': + description: '**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + patch: + summary: Update a release + description: Users with push access to the repository can edit a release. + tags: + - repos + operationId: repos/update-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#update-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + tag_name: + type: string + description: The name of the tag. + target_commitish: + type: string + description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository''s default branch.' + name: + type: string + description: The name of the release. + body: + type: string + description: Text describing the contents of the tag. + draft: + type: boolean + description: '`true` makes the release a draft, and `false` publishes the release.' + prerelease: + type: boolean + description: '`true` to identify the release as a prerelease, `false` to identify the release as a full release.' + make_latest: + type: string + description: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. + enum: + - 'true' + - 'false' + - legacy + default: 'true' + discussion_category_name: + type: string + description: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + examples: + default: + value: + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/release' + examples: + default: + $ref: '#/components/examples/release' + '404': + description: Not Found if the discussion category name is invalid + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + delete: + summary: Delete a release + description: Users with push access to the repository can delete a release. + tags: + - repos + operationId: repos/delete-release + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/releases#delete-a-release + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: releases + x-stackQL-resource: releases + /repos/{owner}/{repo}/releases/{release_id}/assets: + get: + summary: List release assets + description: '' + tags: + - repos + operationId: repos/list-release-assets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#list-release-assets + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/release-asset' + examples: + default: + $ref: '#/components/examples/release-asset-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + post: + summary: Upload a release asset + description: |- + This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. + + You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + + Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + + `application/zip` + + GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + you'll still need to pass your authentication to be able to upload an asset. + + When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + + **Notes:** + * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" + endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). + * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + tags: + - repos + operationId: repos/upload-release-asset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/releases/assets#upload-a-release-asset + servers: + - url: https://uploads.github.com + description: The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the "Create a release" endpoint + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/release-id' + - name: name + in: query + required: true + schema: + type: string + - name: label + in: query + schema: + type: string + requestBody: + required: false + content: + application/octet-stream: + schema: + type: string + format: binary + description: The raw file data + examples: + default: + value: '@example.zip' + responses: + '201': + description: Response for successful upload + content: + application/json: + schema: + $ref: '#/components/schemas/release-asset' + examples: + response-for-successful-upload: + $ref: '#/components/examples/release-asset-response-for-successful-upload' + '422': + description: Response if you upload an asset with the same filename as another uploaded asset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: releases + subcategory: assets + x-stackQL-resource: assets + /repos/{owner}/{repo}/rules/branches/{branch}: + get: + summary: Get rules for a branch + description: |- + Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply + to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + enforcement statuses are not returned. + tags: + - repos + operationId: repos/get-branch-rules + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/branch' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-rule-detailed' + examples: + default: + $ref: '#/components/examples/repository-rule-items' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets: + get: + summary: Get all repository rulesets + description: Get all the rulesets for a repository. + tags: + - repos + operationId: repos/get-repo-rulesets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-all-repository-rulesets + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: includes_parents + description: Include rulesets configured at higher levels that apply to this repository + in: query + required: false + schema: + type: boolean + default: true + - $ref: '#/components/parameters/ruleset-targets' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + post: + summary: Create a repository ruleset + description: Create a ruleset for a repository. + tags: + - repos + operationId: repos/create-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#create-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + default: branch + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/repository-ruleset-conditions' + rules: + type: array + description: An array of rules within the ruleset. + items: + $ref: '#/components/schemas/repository-rule' + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets/rule-suites: + get: + summary: List repository rule suites + description: |- + Lists suites of rule evaluations at the repository level. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-repo-rule-suites + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ref-in-query' + - $ref: '#/components/parameters/time-period' + - $ref: '#/components/parameters/actor-name-in-query' + - $ref: '#/components/parameters/rule-suite-result' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suites' + examples: + default: + $ref: '#/components/examples/rule-suite-items' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rule-suites + x-stackQL-resource: rule_suites + /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}: + get: + summary: Get a repository rule suite + description: |- + Gets information about a suite of rule evaluations from within a repository. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + tags: + - repos + operationId: repos/get-repo-rule-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/rule-suite-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/rule-suite' + examples: + default: + $ref: '#/components/examples/rule-suite' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rule-suites + x-stackQL-resource: rule_suites + /repos/{owner}/{repo}/rulesets/{ruleset_id}: + get: + summary: Get a repository ruleset + description: |- + Get a ruleset for a repository. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: includes_parents + description: Include rulesets configured at higher levels that apply to this repository + in: query + required: false + schema: + type: boolean + default: true + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + put: + summary: Update a repository ruleset + description: Update a ruleset for a repository. + tags: + - repos + operationId: repos/update-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#update-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + conditions: + $ref: '#/components/schemas/repository-ruleset-conditions' + rules: + description: An array of rules within the ruleset. + type: array + items: + $ref: '#/components/schemas/repository-rule' + examples: + default: + value: + name: super cool ruleset + target: branch + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-ruleset' + examples: + default: + $ref: '#/components/examples/repository-ruleset' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + delete: + summary: Delete a repository ruleset + description: Delete a ruleset for a repository. + tags: + - repos + operationId: repos/delete-repo-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets/{ruleset_id}/history: + get: + summary: Get repository ruleset history + description: Get the history of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ruleset-version' + examples: + default: + $ref: '#/components/examples/ruleset-history' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + x-stackQL-resource: rules + /repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}: + get: + summary: Get repository ruleset version + description: Get a version of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-version + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ruleset-version-with-state' + examples: + default: + $ref: '#/components/examples/repository-ruleset-version-with-state' + '404': + $ref: '#/components/responses/not_found' + '500': + $ref: '#/components/responses/internal_error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + x-stackQL-resource: rules + /repos/{owner}/{repo}/stats/code_frequency: + get: + summary: Get the weekly commit activity + description: |- + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + > [!NOTE] + > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. + tags: + - repos + operationId: repos/get-code-frequency-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-frequency-stat' + examples: + default: + $ref: '#/components/examples/code-frequency-stat-items' + '202': + $ref: '#/components/responses/accepted' + '204': + $ref: '#/components/responses/no_content' + '422': + description: Repository contains more than 10,000 commits + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/commit_activity: + get: + summary: Get the last year of commit activity + description: Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. + tags: + - repos + operationId: repos/get-commit-activity-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/commit-activity' + examples: + default: + $ref: '#/components/examples/commit-activity-items' + '202': + $ref: '#/components/responses/accepted' + '204': + $ref: '#/components/responses/no_content' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/contributors: + get: + summary: Get all contributor commit activity + description: |- + + Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + + * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * `a` - Number of additions + * `d` - Number of deletions + * `c` - Number of commits + + > [!NOTE] + > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + tags: + - repos + operationId: repos/get-contributors-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/contributor-activity' + examples: + default: + $ref: '#/components/examples/contributor-activity-items' + '202': + $ref: '#/components/responses/accepted' + '204': + $ref: '#/components/responses/no_content' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/participation: + get: + summary: Get the weekly commit count + description: |- + Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. + + The array order is oldest week (index 0) to most recent week. + + The most recent week is seven days ago at UTC midnight to today at UTC midnight. + tags: + - repos + operationId: repos/get-participation-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: The array order is oldest week (index 0) to most recent week. + content: + application/json: + schema: + $ref: '#/components/schemas/participation-stats' + examples: + default: + $ref: '#/components/examples/participation-stats' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/stats/punch_card: + get: + summary: Get the hourly commit count for each day + description: |- + Each array contains the day number, hour number, and number of commits: + + * `0-6`: Sunday - Saturday + * `0-23`: Hour of day + * Number of commits + + For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + tags: + - repos + operationId: repos/get-punch-card-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/code-frequency-stat' + examples: + default: + $ref: '#/components/examples/code-frequency-stat-items-2' + '204': + $ref: '#/components/responses/no_content' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: statistics + x-stackQL-resource: statistics + /repos/{owner}/{repo}/statuses/{sha}: + post: + summary: Create a commit status + description: |- + Users with push access in a repository can create commit statuses for a given SHA. + + Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + tags: + - repos + operationId: repos/create-commit-status + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/commits/statuses#create-a-commit-status + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: sha + in: path + required: true + schema: + type: string + x-multi-segment: true + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + type: string + description: The state of the status. + enum: + - error + - failure + - pending + - success + target_url: + type: string + nullable: true + description: |- + The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + `http://ci.example.com/user/repo/build/sha` + description: + type: string + nullable: true + description: A short description of the status. + context: + type: string + description: A string label to differentiate this status from the status of other systems. This field is case-insensitive. + default: default + required: + - state + examples: + default: + value: + state: success + target_url: https://example.com/build/status + description: The build succeeded! + context: continuous-integration/jenkins + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/status' + examples: + default: + $ref: '#/components/examples/status' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: commits + subcategory: statuses + x-stackQL-resource: statuses + /repos/{owner}/{repo}/tags: + get: + summary: List repository tags + description: '' + tags: + - repos + operationId: repos/list-tags + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-tags + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/tag' + examples: + default: + $ref: '#/components/examples/tag-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/tarball/{ref}: + get: + summary: Download a repository archive (tar) + description: |- + Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually + `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + the `Location` header to make a second `GET` request. + + > [!NOTE] + > For private repositories, these links are temporary and expire after five minutes. + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar + operationId: repos/download-tarball-archive + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + in: path + required: true + x-multi-segment: true + schema: + type: string + responses: + '302': + description: Response + headers: + Location: + example: https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{owner}/{repo}/teams: + get: + summary: List repository teams + description: |- + Lists the teams that have access to the specified repository and that are also visible to the authenticated user. + + For a public repository, a team is listed only if that team added the public repository explicitly. + + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + tags: + - repos + operationId: repos/list-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repository-teams + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/topics: + get: + summary: Get all repository topics + description: '' + tags: + - repos + operationId: repos/get-all-topics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#get-all-repository-topics + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/topic' + examples: + default: + $ref: '#/components/examples/topic' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Replace all repository topics + description: '' + tags: + - repos + operationId: repos/replace-all-topics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + names: + type: array + description: An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. + items: + type: string + required: + - names + examples: + default: + value: + names: + - octocat + - atom + - electron + - api + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/topic' + examples: + default: + $ref: '#/components/examples/topic' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed_simple' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/traffic/clones: + get: + summary: Get repository clones + description: Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + tags: + - repos + operationId: repos/get-clones + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-repository-clones + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/clone-traffic' + examples: + default: + $ref: '#/components/examples/clone-traffic' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/traffic/popular/paths: + get: + summary: Get top referral paths + description: Get the top 10 popular contents over the last 14 days. + tags: + - repos + operationId: repos/get-top-paths + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/content-traffic' + examples: + default: + $ref: '#/components/examples/content-traffic-items' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/traffic/popular/referrers: + get: + summary: Get top referral sources + description: Get the top 10 referrers over the last 14 days. + tags: + - repos + operationId: repos/get-top-referrers + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/referrer-traffic' + examples: + default: + $ref: '#/components/examples/referrer-traffic-items' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/traffic/views: + get: + summary: Get page views + description: Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + tags: + - repos + operationId: repos/get-views + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/metrics/traffic#get-page-views + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/per' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/view-traffic' + examples: + default: + $ref: '#/components/examples/view-traffic' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: metrics + subcategory: traffic + x-stackQL-resource: traffic + /repos/{owner}/{repo}/transfer: + post: + summary: Transfer a repository + description: A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). + tags: + - repos + operationId: repos/transfer + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#transfer-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + new_owner: + type: string + description: The username or organization name the repository will be transferred to. + new_name: + type: string + description: The new name to be given to the repository. + team_ids: + type: array + description: ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. + items: + type: integer + required: + - new_owner + examples: + default: + value: + new_owner: github + team_ids: + - 12 + - 345 + new_name: octorepo + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/vulnerability-alerts: + get: + summary: Check if vulnerability alerts are enabled for a repository + description: Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/check-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response if repository is enabled with vulnerability alerts + '404': + description: Not Found if repository is not enabled with vulnerability alerts + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + put: + summary: Enable vulnerability alerts + description: Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/enable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + delete: + summary: Disable vulnerability alerts + description: |- + Disables dependency alerts and the dependency graph for a repository. + The authenticated user must have admin access to the repository. For more information, + see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/disable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repos/{owner}/{repo}/zipball/{ref}: + get: + summary: Download a repository archive (zip) + description: |- + Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually + `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use + the `Location` header to make a second `GET` request. + + > [!NOTE] + > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip + operationId: repos/download-zipball-archive + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - name: ref + in: path + required: true + x-multi-segment: true + schema: + type: string + responses: + '302': + description: Response + headers: + Location: + example: https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: contents + x-stackQL-resource: contents + /repos/{template_owner}/{template_repo}/generate: + post: + summary: Create a repository using a template + description: |- + Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. + + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + tags: + - repos + operationId: repos/create-using-template + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template + parameters: + - name: template_owner + description: The account owner of the template repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + - name: template_repo + description: The name of the template repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + owner: + type: string + description: The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + name: + type: string + description: The name of the new repository. + description: + type: string + description: A short description of the new repository. + include_all_branches: + type: boolean + description: 'Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.' + default: false + private: + type: boolean + description: Either `true` to create a new private repository or `false` to create a new public one. + default: false + required: + - name + examples: + default: + value: + owner: octocat + name: Hello-World + description: This is your first repository + include_all_branches: false + private: false + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World + schema: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /repositories: + get: + summary: List public repositories + description: |- + Lists all public repositories in the order that they were created. + + Note: + - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + tags: + - repos + operationId: repos/list-public + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-public-repositories + parameters: + - $ref: '#/components/parameters/since-repo' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/public-repository-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos + /user/repos: + get: + summary: List repositories for the authenticated user + description: |- + Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. + + The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + tags: + - repos + operationId: repos/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user + parameters: + - name: visibility + description: Limit results to repositories with the specified visibility. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + default: all + - name: affiliation + description: |- + Comma-separated list of values. Can include: + * `owner`: Repositories that are owned by the authenticated user. + * `collaborator`: Repositories that the user has been added to as a collaborator. + * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. + in: query + required: false + schema: + type: string + default: owner,collaborator,organization_member + - name: type + description: Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. + in: query + required: false + schema: + type: string + enum: + - all + - owner + - public + - private + - member + default: all + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - pushed + - full_name + default: full_name + - name: direction + description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/since-repo-date' + - $ref: '#/components/parameters/before-repo-date' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository' + examples: + default: + $ref: '#/components/examples/repository-items-default-response' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: repos + subcategory: repos + x-stackQL-resource: repos + post: + summary: Create a repository for the authenticated user + description: |- + Creates a new repository for the authenticated user. + + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + tags: + - repos + operationId: repos/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: The name of the repository. + type: string + example: Team Environment + description: + description: A short description of the repository. + type: string + homepage: + description: A URL with more information about the repository. + type: string + private: + description: Whether the repository is private. + default: false + type: boolean + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + team_id: + description: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + type: integer + auto_init: + description: Whether the repository is initialized with a minimal README. + default: false + type: boolean + gitignore_template: + description: The desired language or platform to apply to the .gitignore. + example: Haskell + type: string + license_template: + description: The license keyword of the open source license for this repository. + example: mit + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + Required when using `squash_merge_commit_message`. + + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + Required when using `merge_commit_message`. + + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + required: + - name + type: object + examples: + default: + value: + name: Hello-World + description: This is your first repo! + homepage: https://github.com + private: false + is_template: true + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + '400': + $ref: '#/components/responses/bad_request' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: repos + subcategory: repos + x-github-breaking-changes: + - changeset: change_create_repo_trade_compliance_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: repos + /user/repository_invitations: + get: + summary: List repository invitations for the authenticated user + description: When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + tags: + - repos + operationId: repos/list-invitations-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-invitation' + examples: + default: + $ref: '#/components/examples/repository-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /user/repository_invitations/{invitation_id}: + patch: + summary: Accept a repository invitation + description: '' + tags: + - repos + operationId: repos/accept-invitation-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation + parameters: + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: collaborators + subcategory: invitations + x-github-breaking-changes: + - changeset: change_accept_repository_invitation_response_status + patch: + responses: + '451': + $ref: '#/components/responses/validation_failed' + version: '2026-03-10' + x-stackQL-resource: invitations + delete: + summary: Decline a repository invitation + description: '' + tags: + - repos + operationId: repos/decline-invitation-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation + parameters: + - $ref: '#/components/parameters/invitation-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: collaborators + subcategory: invitations + x-stackQL-resource: invitations + /users/{username}/repos: + get: + summary: List repositories for a user + description: Lists public repositories for the specified user. + tags: + - repos + operationId: repos/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - name: type + description: Limit results to repositories of the specified type. + in: query + required: false + schema: + type: string + enum: + - all + - owner + - member + default: owner + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - pushed + - full_name + default: full_name + - name: direction + description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' + in: query + required: false + schema: + type: string + enum: + - asc + - desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + x-stackQL-resource: repos +components: + schemas: + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + $ref: '#/components/schemas/nullable-repository' + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + $ref: '#/components/schemas/nullable-license-simple' + organization: + $ref: '#/components/schemas/nullable-simple-user' + parent: + $ref: '#/components/schemas/repository' + source: + $ref: '#/components/schemas/repository' + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct-simple' + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + repository-ruleset: + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: + type: string + description: The name of the ruleset + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + - Enterprise + source: + type: string + description: The name of the source + enforcement: + $ref: '#/components/schemas/repository-rule-enforcement' + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + $ref: '#/components/schemas/repository-ruleset-bypass-actor' + current_user_can_bypass: + type: string + description: |- + The bypass type of the user making the API request for this ruleset. This field is only returned when + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + - exempt + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: object + nullable: true + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + items: + type: string + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. + items: + type: integer + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of these properties must match for the condition to pass. + items: + $ref: '#/components/schemas/repository-ruleset-conditions-repository-property-spec' + exclude: + type: array + description: The repository properties and values to exclude. The condition will not pass if any of these properties match. + items: + $ref: '#/components/schemas/repository-ruleset-conditions-repository-property-spec' + required: + - repository_name + - repository_id + - repository_property + rules: + type: array + items: + $ref: '#/components/schemas/repository-rule' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + repository-rule-enforcement: + type: string + description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). + enum: + - disabled + - active + - evaluate + repository-ruleset-bypass-actor: + title: Repository Ruleset Bypass Actor + type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + properties: + actor_id: + type: integer + nullable: true + description: The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + description: The type of actor that can bypass a ruleset. + bypass_mode: + type: string + description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. + enum: + - always + - pull_request + - exempt + default: always + org-ruleset-conditions: + title: Organization ruleset conditions + type: object + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + items: + type: string + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. + items: + type: integer + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of these properties must match for the condition to pass. + items: + $ref: '#/components/schemas/repository-ruleset-conditions-repository-property-spec' + exclude: + type: array + description: The repository properties and values to exclude. The condition will not pass if any of these properties match. + items: + $ref: '#/components/schemas/repository-ruleset-conditions-repository-property-spec' + required: + - repository_name + - repository_id + - repository_property + org-rules: + title: Repository Rule + type: object + description: A repository rule. + required: + - type + properties: + type: + type: string + enum: + - creation + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + rule-suites: + title: Rule Suites + description: Response + type: array + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the rule insight. + actor_id: + type: integer + description: The number that identifies the user. + actor_name: + type: string + description: The handle for the GitHub user account. + before_sha: + type: string + description: The first commit sha before the push evaluation. + after_sha: + type: string + description: The last commit sha in the push evaluation. + ref: + type: string + description: The ref name that the evaluation ran on. + repository_id: + type: integer + description: The ID of the repository associated with the rule evaluation. + repository_name: + type: string + description: The name of the repository without the `.git` extension. + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + result: + type: string + enum: + - pass + - fail + - bypass + description: The result of the rule evaluations for rules with the `active` enforcement status. + evaluation_result: + type: string + enum: + - pass + - fail + - bypass + description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + rule-suite: + title: Rule Suite + description: Response + type: object + properties: + id: + type: integer + description: The unique identifier of the rule insight. + actor_id: + type: integer + description: The number that identifies the user. + nullable: true + actor_name: + type: string + description: The handle for the GitHub user account. + nullable: true + before_sha: + type: string + description: The previous commit SHA of the ref. + after_sha: + type: string + description: The new commit SHA of the ref. + ref: + type: string + description: The ref name that the evaluation ran on. + repository_id: + type: integer + description: The ID of the repository associated with the rule evaluation. + repository_name: + type: string + description: The name of the repository without the `.git` extension. + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + result: + type: string + enum: + - pass + - fail + - bypass + description: The result of the rule evaluations for rules with the `active` enforcement status. + evaluation_result: + type: string + nullable: true + enum: + - pass + - fail + - bypass + description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + rule_evaluations: + type: array + description: Details on the evaluated rules. + items: + type: object + properties: + rule_source: + type: object + properties: + type: + type: string + description: The type of rule source. + id: + type: integer + nullable: true + description: The ID of the rule source. + name: + type: string + nullable: true + description: The name of the rule source. + enforcement: + type: string + enum: + - active + - evaluate + - deleted ruleset + description: The enforcement level of this rule source. + result: + type: string + enum: + - pass + - fail + description: The result of the evaluation of the individual rule. + rule_type: + type: string + description: The type of rule. + details: + type: string + nullable: true + description: The detailed failure message for the rule. Null if the rule passed. + activity: + title: Activity + description: Activity + type: object + properties: + id: + type: integer + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + description: The SHA of the commit before the activity. + after: + type: string + example: 827efc6d56897b048c772eb4087f854f46256132 + description: The SHA of the commit after the activity. + ref: + type: string + example: refs/heads/main + description: The full Git reference, formatted as `refs/heads/`. + timestamp: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + description: The time when the activity occurred. + activity_type: + type: string + example: force_push + enum: + - push + - force_push + - branch_deletion + - branch_creation + - pr_merge + - merge_queue_merge + description: The type of the activity that was performed. + actor: + $ref: '#/components/schemas/nullable-simple-user' + required: + - id + - node_id + - before + - after + - ref + - timestamp + - activity_type + - actor + autolink: + title: Autolink reference + description: An autolink reference. + type: object + properties: + id: + type: integer + example: 3 + key_prefix: + description: The prefix of a key that is linkified. + example: TICKET- + type: string + url_template: + description: A template for the target URL that is generated if a key was found. + example: https://example.com/TICKET?query= + type: string + is_alphanumeric: + description: Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. + example: true + type: boolean + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - key_prefix + - url_template + - is_alphanumeric + check-automated-security-fixes: + title: Check Dependabot security updates + description: Check Dependabot security updates + type: object + properties: + enabled: + type: boolean + example: true + description: Whether Dependabot security updates are enabled for the repository. + paused: + type: boolean + example: false + description: Whether Dependabot security updates are paused for the repository. + required: + - enabled + - paused + short-branch: + title: Short Branch + description: Short Branch + type: object + properties: + name: + type: string + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + protected: + type: boolean + protection: + $ref: '#/components/schemas/branch-protection' + protection_url: + type: string + format: uri + required: + - name + - commit + - protected + branch-with-protection: + title: Branch With Protection + description: Branch With Protection + type: object + properties: + name: + type: string + commit: + $ref: '#/components/schemas/commit' + _links: + type: object + properties: + html: + type: string + self: + type: string + format: uri + required: + - html + - self + protected: + type: boolean + protection: + $ref: '#/components/schemas/branch-protection' + protection_url: + type: string + format: uri + pattern: + type: string + example: '"mas*"' + required_approving_review_count: + type: integer + example: 1 + required: + - name + - commit + - _links + - protection + - protected + - protection_url + branch-protection: + title: Branch Protection + description: Branch Protection + type: object + properties: + url: + type: string + enabled: + type: boolean + required_status_checks: + $ref: '#/components/schemas/protected-branch-required-status-check' + enforce_admins: + $ref: '#/components/schemas/protected-branch-admin-enforced' + required_pull_request_reviews: + $ref: '#/components/schemas/protected-branch-pull-request-review' + restrictions: + $ref: '#/components/schemas/branch-restriction-policy' + required_linear_history: + type: object + properties: + enabled: + type: boolean + allow_force_pushes: + type: object + properties: + enabled: + type: boolean + allow_deletions: + type: object + properties: + enabled: + type: boolean + block_creations: + type: object + properties: + enabled: + type: boolean + required_conversation_resolution: + type: object + properties: + enabled: + type: boolean + name: + type: string + example: '"branch/with/protection"' + protection_url: + type: string + example: '"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection"' + required_signatures: + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + example: true + required: + - url + - enabled + lock_branch: + type: object + description: Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. + properties: + enabled: + default: false + type: boolean + allow_fork_syncing: + type: object + description: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. + properties: + enabled: + default: false + type: boolean + protected-branch: + title: Protected Branch + description: Branch protections protect branches + type: object + properties: + url: + type: string + format: uri + required_status_checks: + $ref: '#/components/schemas/status-check-policy' + required_pull_request_reviews: + type: object + properties: + url: + type: string + format: uri + dismiss_stale_reviews: + type: boolean + require_code_owner_reviews: + type: boolean + required_approving_review_count: + type: integer + require_last_push_approval: + description: Whether the most recent push must be approved by someone other than the person who pushed it. + type: boolean + default: false + dismissal_restrictions: + type: object + properties: + url: + type: string + format: uri + users_url: + type: string + format: uri + teams_url: + type: string + format: uri + users: + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + type: array + items: + $ref: '#/components/schemas/team' + apps: + type: array + items: + $ref: '#/components/schemas/integration' + required: + - url + - users_url + - teams_url + - users + - teams + bypass_pull_request_allowances: + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + type: array + items: + $ref: '#/components/schemas/team' + apps: + type: array + items: + $ref: '#/components/schemas/integration' + required: + - users + - teams + required: + - url + required_signatures: + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + example: true + required: + - url + - enabled + enforce_admins: + type: object + properties: + url: + type: string + format: uri + enabled: + type: boolean + additionalProperties: false + required: + - url + - enabled + required_linear_history: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + allow_force_pushes: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + allow_deletions: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + restrictions: + $ref: '#/components/schemas/branch-restriction-policy' + required_conversation_resolution: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + block_creations: + type: object + properties: + enabled: + type: boolean + additionalProperties: false + required: + - enabled + lock_branch: + type: object + description: Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. + properties: + enabled: + default: false + type: boolean + additionalProperties: false + allow_fork_syncing: + type: object + description: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. + properties: + enabled: + default: false + type: boolean + additionalProperties: false + required: + - url + protected-branch-admin-enforced: + title: Protected Branch Admin Enforced + description: Protected Branch Admin Enforced + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: + type: boolean + example: true + required: + - url + - enabled + protected-branch-pull-request-review: + title: Protected Branch Pull Request Review + description: Protected Branch Pull Request Review + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + dismissal_restrictions: + type: object + properties: + users: + description: The list of users with review dismissal access. + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + description: The list of teams with review dismissal access. + type: array + items: + $ref: '#/components/schemas/team' + apps: + description: The list of apps with review dismissal access. + type: array + items: + $ref: '#/components/schemas/integration' + url: + type: string + example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"' + users_url: + type: string + example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"' + teams_url: + type: string + example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams"' + bypass_pull_request_allowances: + type: object + description: Allow specific users, teams, or apps to bypass pull request requirements. + properties: + users: + description: The list of users allowed to bypass pull request requirements. + type: array + items: + $ref: '#/components/schemas/simple-user' + teams: + description: The list of teams allowed to bypass pull request requirements. + type: array + items: + $ref: '#/components/schemas/team' + apps: + description: The list of apps allowed to bypass pull request requirements. + type: array + items: + $ref: '#/components/schemas/integration' + dismiss_stale_reviews: + type: boolean + example: true + require_code_owner_reviews: + type: boolean + example: true + required_approving_review_count: + type: integer + minimum: 0 + maximum: 6 + example: 2 + require_last_push_approval: + description: Whether the most recent push must be approved by someone other than the person who pushed it. + type: boolean + example: true + default: false + required: + - dismiss_stale_reviews + - require_code_owner_reviews + status-check-policy: + title: Status Check Policy + description: Status Check Policy + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: + type: boolean + example: true + contexts: + type: array + example: + - continuous-integration/travis-ci + items: + type: string + checks: + type: array + items: + type: object + properties: + context: + type: string + example: continuous-integration/travis-ci + app_id: + type: integer + nullable: true + required: + - context + - app_id + contexts_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + required: + - url + - contexts_url + - strict + - contexts + - checks + branch-restriction-policy: + title: Branch Restriction Policy + description: Branch Restriction Policy + type: object + properties: + url: + type: string + format: uri + users_url: + type: string + format: uri + teams_url: + type: string + format: uri + apps_url: + type: string + format: uri + users: + type: array + items: + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + user_view_type: + type: string + teams: + type: array + items: + $ref: '#/components/schemas/team' + apps: + type: array + items: + type: object + properties: + id: + type: integer + slug: + type: string + node_id: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + url: + type: string + repos_url: + type: string + events_url: + type: string + hooks_url: + type: string + issues_url: + type: string + members_url: + type: string + public_members_url: + type: string + avatar_url: + type: string + description: + type: string + gravatar_id: + type: string + example: '""' + html_url: + type: string + example: '"https://github.com/testorg-ea8ec76d71c3af4b"' + followers_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"' + following_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"' + gists_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"' + starred_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"' + subscriptions_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"' + organizations_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"' + received_events_url: + type: string + example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"' + type: + type: string + example: '"Organization"' + site_admin: + type: boolean + example: false + user_view_type: + type: string + example: public + name: + type: string + client_id: + type: string + description: + type: string + external_url: + type: string + html_url: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + metadata: + type: string + contents: + type: string + issues: + type: string + single_file: + type: string + events: + type: array + items: + type: string + required: + - url + - users_url + - teams_url + - apps_url + - users + - teams + - apps + integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + codeowners-errors: + title: CODEOWNERS errors + description: A list of errors found in a repo's CODEOWNERS file + type: object + properties: + errors: + type: array + items: + type: object + properties: + line: + description: The line number where this errors occurs. + type: integer + example: 7 + column: + description: The column number where this errors occurs. + type: integer + example: 3 + source: + description: The contents of the line where the error occurs. + type: string + example: '* user' + kind: + description: The type of error. + type: string + example: Invalid owner + suggestion: + description: Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. + type: string + nullable: true + example: The pattern `/` will never match anything, did you mean `*` instead? + message: + description: A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). + type: string + example: |- + Invalid owner on line 7: + + * user + ^ + path: + description: The path of the file where the error occured. + type: string + example: .github/CODEOWNERS + required: + - line + - column + - kind + - message + - path + required: + - errors + collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + email: + nullable: true + type: string + name: + nullable: true + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - push + - admin + role_name: + type: string + example: admin + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - role_name + repository-invitation: + title: Repository Invitation + description: Repository invitations let you manage who you collaborate with. + type: object + properties: + id: + description: Unique identifier of the repository invitation. + example: 42 + type: integer + format: int64 + repository: + $ref: '#/components/schemas/minimal-repository' + invitee: + $ref: '#/components/schemas/nullable-simple-user' + inviter: + $ref: '#/components/schemas/nullable-simple-user' + permissions: + description: The permission associated with the invitation. + example: read + type: string + enum: + - read + - write + - admin + - triage + - maintain + created_at: + type: string + format: date-time + example: '2016-06-13T14:52:50-05:00' + expired: + description: Whether or not the invitation has expired + type: boolean + url: + description: URL for the repository invitation + example: https://api.github.com/user/repository-invitations/1 + type: string + html_url: + type: string + example: https://github.com/octocat/Hello-World/invitations + node_id: + type: string + required: + - id + - node_id + - permissions + - inviter + - invitee + - repository + - url + - html_url + - created_at + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + repository-collaborator-permission: + title: Repository Collaborator Permission + description: Repository Collaborator Permission + type: object + properties: + permission: + type: string + role_name: + type: string + example: admin + user: + $ref: '#/components/schemas/nullable-collaborator' + required: + - permission + - role_name + - user + commit-comment: + title: Commit Comment + description: Commit Comment + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + author_association: + $ref: '#/components/schemas/author-association' + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - url + - html_url + - id + - node_id + - user + - position + - line + - path + - commit_id + - body + - author_association + - created_at + - updated_at + commit: + title: Commit + description: Commit + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + example: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + $ref: '#/components/schemas/nullable-git-user' + committer: + $ref: '#/components/schemas/nullable-git-user' + message: + type: string + example: Fix all the bugs + comment_count: + type: integer + example: 0 + tree: + type: object + properties: + sha: + type: string + example: 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 + required: + - sha + - url + verification: + $ref: '#/components/schemas/verification' + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + committer: + nullable: true + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + additionalProperties: false + parents: + type: array + items: + type: object + properties: + sha: + type: string + example: 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd + required: + - sha + - url + stats: + type: object + properties: + additions: + type: integer + deletions: + type: integer + total: + type: integer + files: + type: array + items: + $ref: '#/components/schemas/diff-entry' + required: + - url + - sha + - node_id + - html_url + - comments_url + - commit + - author + - committer + - parents + branch-short: + title: Branch Short + description: Branch Short + type: object + properties: + name: + type: string + commit: + type: object + properties: + sha: + type: string + url: + type: string + required: + - sha + - url + protected: + type: boolean + required: + - name + - commit + - protected + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + example: 1347 + state: + type: string + example: open + locked: + type: boolean + example: true + title: + type: string + example: new-feature + user: + $ref: '#/components/schemas/nullable-simple-user' + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + $ref: '#/components/schemas/nullable-milestone' + active_lock_reason: + type: string + example: too heated + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + closed_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_reviewers: + type: array + items: + $ref: '#/components/schemas/simple-user' + requested_teams: + type: array + items: + $ref: '#/components/schemas/team' + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + $ref: '#/components/schemas/repository' + sha: + type: string + user: + $ref: '#/components/schemas/nullable-simple-user' + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + $ref: '#/components/schemas/link' + commits: + $ref: '#/components/schemas/link' + statuses: + $ref: '#/components/schemas/link' + html: + $ref: '#/components/schemas/link' + issue: + $ref: '#/components/schemas/link' + review_comments: + $ref: '#/components/schemas/link' + review_comment: + $ref: '#/components/schemas/link' + self: + $ref: '#/components/schemas/link' + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + $ref: '#/components/schemas/author-association' + auto_merge: + $ref: '#/components/schemas/auto-merge' + draft: + description: Indicates whether or not the pull request is a draft. + example: false + type: boolean + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + x-github-breaking-changes: + - changeset: remove_pull_request_merge_commit_sha + patch: + properties: + merge_commit_sha: null + required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - _links + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url + - id + - node_id + - issue_url + - merged_at + - milestone + - number + - patch_url + - review_comment_url + - review_comments_url + - statuses_url + - state + - locked + - title + - updated_at + - url + - user + - author_association + - auto_merge + type: object + version: '2026-03-10' + combined-commit-status: + title: Combined Commit Status + description: Combined Commit Status + type: object + properties: + state: + type: string + statuses: + type: array + items: + $ref: '#/components/schemas/simple-commit-status' + sha: + type: string + total_count: + type: integer + repository: + $ref: '#/components/schemas/minimal-repository' + commit_url: + type: string + format: uri + url: + type: string + format: uri + required: + - state + - sha + - total_count + - statuses + - repository + - commit_url + - url + status: + title: Status + description: The status of a commit. + type: object + properties: + url: + type: string + avatar_url: + type: string + nullable: true + id: + type: integer + node_id: + type: string + state: + type: string + description: + type: string + nullable: true + target_url: + type: string + nullable: true + context: + type: string + created_at: + type: string + updated_at: + type: string + creator: + $ref: '#/components/schemas/nullable-simple-user' + required: + - url + - avatar_url + - id + - node_id + - state + - description + - target_url + - context + - created_at + - updated_at + - creator + community-profile: + title: Community Profile + description: Community Profile + type: object + properties: + health_percentage: + type: integer + example: 100 + description: + type: string + example: My first repository on GitHub! + nullable: true + documentation: + type: string + example: example.com + nullable: true + files: + type: object + properties: + code_of_conduct: + $ref: '#/components/schemas/nullable-code-of-conduct-simple' + code_of_conduct_file: + $ref: '#/components/schemas/nullable-community-health-file' + license: + $ref: '#/components/schemas/nullable-license-simple' + contributing: + $ref: '#/components/schemas/nullable-community-health-file' + readme: + $ref: '#/components/schemas/nullable-community-health-file' + issue_template: + $ref: '#/components/schemas/nullable-community-health-file' + pull_request_template: + $ref: '#/components/schemas/nullable-community-health-file' + required: + - code_of_conduct + - code_of_conduct_file + - license + - contributing + - readme + - issue_template + - pull_request_template + updated_at: + type: string + format: date-time + example: '2017-02-28T19:09:29Z' + nullable: true + content_reports_enabled: + type: boolean + example: true + required: + - health_percentage + - description + - documentation + - files + - updated_at + commit-comparison: + title: Commit Comparison + description: Commit Comparison + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/compare/master...topic.patch + base_commit: + $ref: '#/components/schemas/commit' + merge_base_commit: + $ref: '#/components/schemas/commit' + status: + type: string + enum: + - diverged + - ahead + - behind + - identical + example: ahead + ahead_by: + type: integer + example: 4 + behind_by: + type: integer + example: 5 + total_commits: + type: integer + example: 6 + commits: + type: array + items: + $ref: '#/components/schemas/commit' + files: + type: array + items: + $ref: '#/components/schemas/diff-entry' + required: + - url + - html_url + - permalink_url + - diff_url + - patch_url + - base_commit + - merge_base_commit + - status + - ahead_by + - behind_by + - total_commits + - commits + content-tree: + title: Content Tree + description: Content Tree + type: object + properties: + type: + type: string + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + content: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + entries: + type: array + items: + type: object + properties: + type: + type: string + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + encoding: + type: string + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + content-directory: + title: Content Directory + description: A list of directory items + type: array + items: + type: object + properties: + type: + type: string + enum: + - dir + - file + - submodule + - symlink + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + content-file: + title: Content File + description: Content File + type: object + properties: + type: + type: string + enum: + - file + encoding: + type: string + size: + type: integer + name: + type: string + path: + type: string + content: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + example: '"actual/actual.md"' + submodule_git_url: + type: string + example: '"git://example.com/defunkt/dotjs.git"' + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - content + - encoding + content-symlink: + title: Symlink Content + description: An object describing a symlink + type: object + properties: + type: + type: string + enum: + - symlink + target: + type: string + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - target + content-submodule: + title: Submodule Content + description: An object describing a submodule + type: object + properties: + type: + type: string + enum: + - submodule + submodule_git_url: + type: string + format: uri + size: + type: integer + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + download_url: + type: string + format: uri + nullable: true + _links: + type: object + properties: + git: + type: string + format: uri + nullable: true + html: + type: string + format: uri + nullable: true + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + - submodule_git_url + file-commit: + title: File Commit + description: File Commit + type: object + required: + - content + - commit + properties: + content: + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + size: + type: integer + url: + type: string + html_url: + type: string + git_url: + type: string + download_url: + type: string + type: + type: string + _links: + type: object + properties: + self: + type: string + git: + type: string + html: + type: string + nullable: true + commit: + type: object + properties: + sha: + type: string + node_id: + type: string + url: + type: string + html_url: + type: string + author: + type: object + properties: + date: + type: string + name: + type: string + email: + type: string + committer: + type: object + properties: + date: + type: string + name: + type: string + email: + type: string + message: + type: string + tree: + type: object + properties: + url: + type: string + sha: + type: string + parents: + type: array + items: + type: object + properties: + url: + type: string + html_url: + type: string + sha: + type: string + verification: + type: object + properties: + verified: + type: boolean + reason: + type: string + signature: + type: string + nullable: true + payload: + type: string + nullable: true + verified_at: + type: string + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + repository-rule-violation-error: + description: Repository rule violation was detected + type: object + properties: + message: + type: string + documentation_url: + type: string + status: + type: string + metadata: + type: object + properties: + secret_scanning: + type: object + properties: + bypass_placeholders: + type: array + items: + type: object + properties: + placeholder_id: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id' + token_type: + type: string + contributor: + title: Contributor + description: Contributor + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + events_url: + type: string + received_events_url: + type: string + format: uri + type: + type: string + site_admin: + type: boolean + contributions: + type: integer + email: + type: string + name: + type: string + user_view_type: + type: string + required: + - contributions + - type + deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + example: 42 + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + sha: + type: string + example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + example: topic-branch + type: string + task: + description: Parameter to specify a task to execute + example: deploy + type: string + payload: + type: object + additionalProperties: true + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.' + example: true + type: boolean + production_environment: + description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.' + example: true + type: boolean + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + deployment-status: + title: Deployment Status + description: The status of a deployment. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: + description: The state of the status. + enum: + - error + - failure + - inactive + - pending + - success + - queued + - in_progress + example: success + type: string + creator: + $ref: '#/components/schemas/nullable-simple-user' + description: + description: A short description of the status. + default: '' + type: string + maxLength: 140 + example: Deployment finished successfully. + environment: + description: The environment of the deployment that the status is for. + default: '' + type: string + example: production + target_url: + description: 'Closing down notice: the URL to associate with this status.' + default: '' + type: string + format: uri + example: https://example.com/deployment/42/output + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + deployment_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/42 + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + environment_url: + description: The URL for accessing your environment. + default: '' + type: string + format: uri + example: https://staging.example.com/ + log_url: + description: The URL to associate with this status. + default: '' + type: string + format: uri + example: https://example.com/deployment/42/output + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + required: + - id + - node_id + - state + - creator + - description + - deployment_url + - target_url + - repository_url + - url + - created_at + - updated_at + environment: + title: Environment + description: Details of a deployment environment + type: object + properties: + id: + description: The id of the environment. + example: 56780428 + type: integer + format: int64 + node_id: + type: string + example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + example: staging + type: string + url: + type: string + example: https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: + description: The time that the environment was created, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + updated_at: + description: The time that the environment was last updated, in ISO 8601 format. + example: '2020-11-23T22:00:40Z' + format: date-time + type: string + protection_rules: + type: array + description: Built-in deployment protection rules for the environment. + items: + anyOf: + - type: object + properties: + id: + type: integer + example: 3515 + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + type: + type: string + example: wait_timer + wait_timer: + $ref: '#/components/schemas/wait-timer' + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + example: 3755 + node_id: + type: string + example: MDQ6R2F0ZTM3NTU= + prevent_self_review: + type: boolean + example: false + description: Whether deployments to this environment can be approved by the user who created the deployment. + type: + type: string + example: required_reviewers + reviewers: + type: array + description: The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + items: + type: object + properties: + type: + $ref: '#/components/schemas/deployment-reviewer-type' + reviewer: + anyOf: + - $ref: '#/components/schemas/simple-user' + - $ref: '#/components/schemas/team' + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + example: 3515 + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + type: + type: string + example: branch_policy + required: + - id + - node_id + - type + deployment_branch_policy: + $ref: '#/components/schemas/deployment-branch-policy-settings' + required: + - id + - node_id + - name + - url + - html_url + - created_at + - updated_at + wait-timer: + type: integer + example: 30 + description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). + prevent-self-review: + type: boolean + example: false + description: Whether or not a user who created the job is prevented from approving their own job. + deployment-reviewer-type: + type: string + description: The type of reviewer. + enum: + - User + - Team + example: User + deployment-branch-policy-settings: + type: object + description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. + properties: + protected_branches: + type: boolean + description: Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. + custom_branch_policies: + type: boolean + description: Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. + nullable: true + required: + - protected_branches + - custom_branch_policies + deployment-branch-policy: + title: Deployment branch policy + description: Details of a deployment branch or tag policy. + type: object + properties: + id: + description: The unique identifier of the branch or tag policy. + type: integer + example: 361471 + node_id: + type: string + example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: + description: The name pattern that branches or tags must match in order to deploy to the environment. + type: string + example: release/* + type: + description: Whether this rule targets a branch or tag. + type: string + example: branch + enum: + - branch + - tag + deployment-branch-policy-name-pattern-with-type: + title: Deployment branch and tag policy name pattern + type: object + properties: + name: + description: |- + The name pattern that branches or tags must match in order to deploy to the environment. + + Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. + For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + type: string + example: release/* + type: + description: Whether this rule targets a branch or tag + type: string + example: branch + enum: + - branch + - tag + required: + - name + deployment-branch-policy-name-pattern: + title: Deployment branch policy name pattern + type: object + properties: + name: + description: |- + The name pattern that branches must match in order to deploy to the environment. + + Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. + For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + type: string + example: release/* + required: + - name + deployment-protection-rule: + title: Deployment protection rule + description: Deployment protection rule + type: object + properties: + id: + type: integer + example: 3515 + description: The unique identifier for the deployment protection rule. + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + description: The node ID for the deployment protection rule. + enabled: + type: boolean + example: true + description: Whether the deployment protection rule is enabled for the environment. + app: + $ref: '#/components/schemas/custom-deployment-rule-app' + required: + - id + - node_id + - enabled + - app + custom-deployment-rule-app: + title: Custom deployment protection rule app + description: A GitHub App that is providing a custom deployment protection rule. + type: object + properties: + id: + type: integer + example: 3515 + description: The unique identifier of the deployment protection rule integration. + slug: + type: string + example: my-custom-app + description: The slugified name of the deployment protection rule integration. + integration_url: + type: string + example: https://api.github.com/apps/custom-app-slug + description: The URL for the endpoint to get details about the app. + node_id: + type: string + example: MDQ6R2F0ZTM1MTU= + description: The node ID for the deployment protection rule integration. + required: + - id + - slug + - integration_url + - node_id + hook: + title: Webhook + description: Webhooks for repositories. + type: object + properties: + type: + type: string + id: + description: Unique identifier of the webhook. + example: 42 + type: integer + name: + description: The name of a valid service, use 'web' for a webhook. + example: web + type: string + active: + description: Determines whether the hook is actually triggered on pushes. + type: boolean + example: true + events: + description: 'Determines what events the hook is triggered for. Default: [''push''].' + type: array + items: + type: string + example: + - push + - pull_request + config: + $ref: '#/components/schemas/webhook-config' + updated_at: + type: string + format: date-time + example: '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + example: '2011-09-06T17:26:27Z' + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1 + test_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test + ping_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + deliveries_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries + last_response: + $ref: '#/components/schemas/hook-response' + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + - last_response + - test_url + webhook-config-url: + type: string + description: The URL to which the payloads will be delivered. + example: https://example.com/webhook + format: uri + webhook-config-content-type: + type: string + description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. + example: '"json"' + webhook-config-secret: + type: string + description: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). + example: '"********"' + webhook-config-insecure-ssl: + type: string + description: Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** + example: '"0"' + webhook-config: + title: Webhook Configuration + description: Configuration object of the webhook + type: object + properties: + url: + $ref: '#/components/schemas/webhook-config-url' + content_type: + $ref: '#/components/schemas/webhook-config-content-type' + secret: + $ref: '#/components/schemas/webhook-config-secret' + insecure_ssl: + $ref: '#/components/schemas/webhook-config-insecure-ssl' + hook-delivery-item: + title: Simple webhook delivery + description: Delivery made by a webhook, without request and response information. + type: object + properties: + id: + description: Unique identifier of the webhook delivery. + type: integer + format: int64 + example: 42 + guid: + description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + format: int64 + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + hook-delivery: + title: Webhook delivery + description: Delivery made by a webhook. + type: object + properties: + id: + description: Unique identifier of the delivery. + type: integer + example: 42 + guid: + description: Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). + type: string + example: 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + example: false + duration: + description: Time spent delivering. + type: number + example: 0.03 + status: + description: Description of the status of the attempted delivery + type: string + example: failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + example: 502 + event: + description: The event that triggered the delivery. + type: string + example: issues + action: + description: The type of activity for the event that triggered the delivery. + type: string + example: opened + nullable: true + installation_id: + description: The id of the GitHub App installation associated with this event. + type: integer + example: 123 + nullable: true + repository_id: + description: The id of the repository associated with this event. + type: integer + example: 123 + nullable: true + throttled_at: + description: Time when the webhook delivery was throttled. + type: string + format: date-time + example: '2021-05-12T20:33:44Z' + nullable: true + url: + description: The URL target of the delivery. + type: string + example: https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: object + nullable: true + additionalProperties: true + payload: + description: The webhook payload. + type: object + nullable: true + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: object + nullable: true + additionalProperties: true + payload: + description: The response payload received. + type: string + nullable: true + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + check-immutable-releases: + title: Check immutable releases + description: Check immutable releases + type: object + properties: + enabled: + type: boolean + example: true + description: Whether immutable releases are enabled for the repository. + enforced_by_owner: + type: boolean + example: false + description: Whether immutable releases are enforced by the repository owner. + required: + - enabled + - enforced_by_owner + deploy-key: + title: Deploy Key + description: An SSH key granting access to a single repository. + type: object + properties: + id: + type: integer + key: + type: string + url: + type: string + title: + type: string + verified: + type: boolean + created_at: + type: string + read_only: + type: boolean + added_by: + type: string + nullable: true + last_used: + nullable: true + type: string + format: date-time + enabled: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + language: + title: Language + description: Language + type: object + additionalProperties: + type: integer + merged-upstream: + title: Merged upstream + description: Results of a successful merge upstream request + type: object + properties: + message: + type: string + merge_type: + type: string + enum: + - merge + - fast-forward + - none + base_branch: + type: string + page: + title: GitHub Pages + description: The configuration for GitHub Pages for a repository. + type: object + properties: + url: + type: string + description: The API address for accessing this Page resource. + format: uri + example: https://api.github.com/repos/github/hello-world/pages + status: + type: string + description: The status of the most recent build of the Page. + example: built + enum: + - built + - building + - errored + nullable: true + cname: + description: The Pages site's custom domain + example: example.com + type: string + nullable: true + protected_domain_state: + type: string + description: The state if the domain is verified + example: pending + nullable: true + enum: + - pending + - verified + - unverified + pending_domain_unverified_at: + type: string + description: The timestamp when a pending domain becomes unverified. + nullable: true + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + example: false + default: false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + example: https://example.com + build_type: + type: string + description: The process in which the Page will be built. + example: legacy + nullable: true + enum: + - legacy + - workflow + source: + $ref: '#/components/schemas/pages-source-hash' + public: + type: boolean + description: Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. + example: true + https_certificate: + $ref: '#/components/schemas/pages-https-certificate' + https_enforced: + type: boolean + description: Whether https is enabled on the domain + example: true + required: + - url + - status + - cname + - custom_404 + - public + page-build: + title: Page Build + description: Page Build + type: object + properties: + url: + type: string + format: uri + status: + type: string + error: + type: object + properties: + message: + type: string + nullable: true + required: + - message + pusher: + $ref: '#/components/schemas/nullable-simple-user' + commit: + type: string + duration: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - url + - status + - error + - pusher + - commit + - duration + - created_at + - updated_at + page-build-status: + title: Page Build Status + description: Page Build Status + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + example: queued + required: + - url + - status + page-deployment: + title: GitHub Pages + description: The GitHub Pages deployment status. + type: object + properties: + id: + description: The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. + type: integer + status_url: + type: string + description: The URI to monitor GitHub Pages deployment status. + format: uri + example: https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 + page_url: + type: string + description: The URI to the deployed GitHub Pages. + format: uri + example: hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + example: monalisa-1231a2312sa32-23sda74.drafts.github.io + required: + - id + - status_url + - page_url + pages-deployment-status: + title: GitHub Pages deployment status + type: object + properties: + status: + type: string + description: The current status of the deployment. + enum: + - deployment_in_progress + - syncing_files + - finished_file_sync + - updating_pages + - purging_cdn + - deployment_cancelled + - deployment_failed + - deployment_content_failed + - deployment_attempt_error + - deployment_lost + - succeed + pages-health-check: + title: Pages Health Check Status + description: Pages Health Check Status + type: object + properties: + domain: + type: object + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: boolean + nullable: true + is_cloudflare_ip: + type: boolean + nullable: true + is_fastly_ip: + type: boolean + nullable: true + is_old_ip_address: + type: boolean + nullable: true + is_a_record: + type: boolean + nullable: true + has_cname_record: + type: boolean + nullable: true + has_mx_records_present: + type: boolean + nullable: true + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: boolean + nullable: true + is_cname_to_github_user_domain: + type: boolean + nullable: true + is_cname_to_pages_dot_github_dot_com: + type: boolean + nullable: true + is_cname_to_fastly: + type: boolean + nullable: true + is_pointed_to_github_pages_ip: + type: boolean + nullable: true + is_non_github_pages_ip_present: + type: boolean + nullable: true + is_pages_domain: + type: boolean + is_served_by_pages: + type: boolean + nullable: true + is_valid: + type: boolean + reason: + type: string + nullable: true + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: string + nullable: true + is_https_eligible: + type: boolean + nullable: true + caa_error: + type: string + nullable: true + alt_domain: + type: object + nullable: true + properties: + host: + type: string + uri: + type: string + nameservers: + type: string + dns_resolves: + type: boolean + is_proxied: + type: boolean + nullable: true + is_cloudflare_ip: + type: boolean + nullable: true + is_fastly_ip: + type: boolean + nullable: true + is_old_ip_address: + type: boolean + nullable: true + is_a_record: + type: boolean + nullable: true + has_cname_record: + type: boolean + nullable: true + has_mx_records_present: + type: boolean + nullable: true + is_valid_domain: + type: boolean + is_apex_domain: + type: boolean + should_be_a_record: + type: boolean + nullable: true + is_cname_to_github_user_domain: + type: boolean + nullable: true + is_cname_to_pages_dot_github_dot_com: + type: boolean + nullable: true + is_cname_to_fastly: + type: boolean + nullable: true + is_pointed_to_github_pages_ip: + type: boolean + nullable: true + is_non_github_pages_ip_present: + type: boolean + nullable: true + is_pages_domain: + type: boolean + is_served_by_pages: + type: boolean + nullable: true + is_valid: + type: boolean + reason: + type: string + nullable: true + responds_to_https: + type: boolean + enforces_https: + type: boolean + https_error: + type: string + nullable: true + is_https_eligible: + type: boolean + nullable: true + caa_error: + type: string + nullable: true + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + description: The value assigned to the property + nullable: true + type: string + items: + type: string + required: + - property_name + - value + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: Specifies the commitish value that determines where the Git tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: true to create a draft (unpublished) release, false to create a published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + $ref: '#/components/schemas/simple-user' + assets: + type: array + items: + $ref: '#/components/schemas/release-asset' + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + example: Team Environment + label: + type: string + nullable: true + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: string + nullable: true + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + $ref: '#/components/schemas/nullable-simple-user' + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release-notes-content: + title: Generated Release Notes Content + description: Generated name and body describing a release + type: object + properties: + name: + description: The generated name of the release + type: string + example: Release v1.0.0 is now available! + body: + description: The generated body describing the contents of the release supporting markdown formatting + type: string + required: + - name + - body + repository-rule-detailed: + title: Repository Rule + type: object + description: A repository rule with ruleset details. + required: + - type + properties: + type: + type: string + enum: + - creation + ruleset_source_type: + type: string + description: The type of source for the ruleset that includes this rule. + enum: + - Repository + - Organization + ruleset_source: + type: string + description: The name of the source of the ruleset that includes this rule. + ruleset_id: + type: integer + description: The ID of the ruleset that includes this rule. + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + repository-ruleset-conditions: + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. + items: + type: string + repository-rule: + title: Repository Rule + type: object + description: A repository rule. + required: + - type + properties: + type: + type: string + enum: + - creation + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + ruleset-version: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + ruleset-version-with-state: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + - state + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + state: + type: string + description: The state of the ruleset version (opaque JSON object) + code-frequency-stat: + title: Code Frequency Stat + description: Code Frequency Stat + type: array + items: + type: integer + commit-activity: + title: Commit Activity + description: Commit Activity + type: object + properties: + days: + type: array + example: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + items: + type: integer + total: + type: integer + example: 89 + week: + type: integer + example: 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + $ref: '#/components/schemas/nullable-simple-user' + total: + type: integer + example: 135 + weeks: + type: array + example: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + required: + - author + - total + - weeks + participation-stats: + title: Participation Stats + type: object + properties: + all: + type: array + items: + type: integer + owner: + type: array + items: + type: integer + required: + - all + - owner + tag: + title: Tag + description: Tag + type: object + properties: + name: + type: string + example: v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + topic: + title: Topic + description: A topic aggregates entities that are related to a subject. + type: object + properties: + names: + type: array + items: + type: string + required: + - names + clone-traffic: + title: Clone Traffic + description: Clone Traffic + type: object + properties: + count: + type: integer + example: 173 + uniques: + type: integer + example: 128 + clones: + type: array + items: + $ref: '#/components/schemas/traffic' + required: + - uniques + - count + - clones + content-traffic: + title: Content Traffic + description: Content Traffic + type: object + properties: + path: + type: string + example: /github/hubot + title: + type: string + example: 'github/hubot: A customizable life embetterment robot.' + count: + type: integer + example: 3542 + uniques: + type: integer + example: 2225 + required: + - path + - title + - uniques + - count + referrer-traffic: + title: Referrer Traffic + description: Referrer Traffic + type: object + properties: + referrer: + type: string + example: Google + count: + type: integer + example: 4 + uniques: + type: integer + example: 3 + required: + - referrer + - uniques + - count + view-traffic: + title: View Traffic + description: View Traffic + type: object + properties: + count: + type: integer + example: 14850 + uniques: + type: integer + example: 3782 + views: + type: array + items: + $ref: '#/components/schemas/traffic' + required: + - uniques + - count + - views + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + repository-ruleset-conditions-repository-name-target: + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + required: + - repository_name + repository-ruleset-conditions-repository-id-target: + title: Repository ruleset conditions for repository IDs + type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. + items: + type: integer + required: + - repository_id + repository-ruleset-conditions-repository-property-target: + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of these properties must match for the condition to pass. + items: + $ref: '#/components/schemas/repository-ruleset-conditions-repository-property-spec' + exclude: + type: array + description: The repository properties and values to exclude. The condition will not pass if any of these properties match. + items: + $ref: '#/components/schemas/repository-ruleset-conditions-repository-property-spec' + required: + - repository_property + repository-rule-creation: + title: creation + description: Only allow users with bypass permission to create matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + repository-rule-update: + title: update + description: Only allow users with bypass permission to update matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - update + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + repository-rule-deletion: + title: deletion + description: Only allow users with bypass permissions to delete matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + repository-rule-required-linear-history: + title: required_linear_history + description: Prevent merge commits from being pushed to matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_linear_history + repository-rule-required-deployments: + title: required_deployments + description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_deployments + parameters: + type: object + properties: + required_deployment_environments: + type: array + description: The environments that must be successfully deployed to before branches can be merged. + items: + type: string + required: + - required_deployment_environments + repository-rule-required-signatures: + title: required_signatures + description: Commits pushed to matching refs must have verified signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + repository-rule-pull-request: + title: pull_request + description: Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + allowed_merge_methods: + type: array + description: Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. + items: + type: string + enum: + - merge + - squash + - rebase + dismiss_stale_reviews_on_push: + type: boolean + description: New, reviewable commits pushed will dismiss previous pull request review approvals. + require_code_owner_review: + type: boolean + description: Require an approving review in pull requests that modify files that have a designated code owner. + require_last_push_approval: + type: boolean + description: Whether the most recent reviewable push must be approved by someone other than the person who pushed it. + required_approving_review_count: + type: integer + description: The number of approving reviews that are required before a pull request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: + type: boolean + description: All conversations on code must be resolved before a pull request can be merged. + required_reviewers: + type: array + description: |- + > [!NOTE] + > `required_reviewers` is in beta and subject to change. + + A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + items: + $ref: '#/components/schemas/repository-rule-params-required-reviewer-configuration' + required: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + repository-rule-required-status-checks: + title: required_status_checks + description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_status_checks + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check would otherwise prohibit it. + required_status_checks: + type: array + description: Status checks that are required. + items: + $ref: '#/components/schemas/repository-rule-params-status-check-configuration' + strict_required_status_checks_policy: + type: boolean + description: Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + repository-rule-non-fast-forward: + title: non_fast_forward + description: Prevent users with push access from force pushing to refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - non_fast_forward + repository-rule-commit-message-pattern: + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-commit-author-email-pattern: + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-committer-email-pattern: + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-branch-name-pattern: + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-tag-name-pattern: + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule appears when configuring it. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-file-path-restriction: + title: file_path_restriction + description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + repository-rule-workflows: + title: workflows + description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check would otherwise prohibit it. + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + $ref: '#/components/schemas/repository-rule-params-workflow-file-reference' + required: + - workflows + repository-rule-code-scanning: + title: code_scanning + description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. + type: object + required: + - type + properties: + type: + type: string + enum: + - code_scanning + parameters: + type: object + properties: + code_scanning_tools: + type: array + description: Tools that must provide code scanning results for this rule to pass. + items: + $ref: '#/components/schemas/repository-rule-params-code-scanning-tool' + required: + - code_scanning_tools + repository-rule-copilot-code-review: + title: copilot_code_review + description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. + type: object + required: + - type + properties: + type: + type: string + enum: + - copilot_code_review + parameters: + type: object + properties: + review_draft_pull_requests: + type: boolean + description: Copilot automatically reviews draft pull requests before they are marked as ready for review. + review_on_push: + type: boolean + description: Copilot automatically reviews each new push to the pull request. + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + protected-branch-required-status-check: + title: Protected Branch Required Status Check + description: Protected Branch Required Status Check + type: object + properties: + url: + type: string + enforcement_level: + type: string + contexts: + type: array + items: + type: string + checks: + type: array + items: + type: object + properties: + context: + type: string + app_id: + type: integer + nullable: true + required: + - context + - app_id + contexts_url: + type: string + strict: + type: boolean + required: + - contexts + - checks + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + nullable-collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + email: + nullable: true + type: string + name: + nullable: true + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - push + - admin + role_name: + type: string + example: admin + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - role_name + nullable: true + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + nullable-git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' + nullable: true + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + nullable: true + example: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + example: file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + example: added + additions: + type: integer + example: 103 + deletions: + type: integer + example: 21 + changes: + type: integer + example: 124 + blob_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + example: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + previous_filename: + type: string + example: file.txt + required: + - additions + - blob_url + - changes + - contents_url + - deletions + - filename + - raw_url + - sha + - status + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + $ref: '#/components/schemas/simple-user' + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + simple-commit-status: + title: Simple Commit Status + type: object + properties: + description: + type: string + nullable: true + id: + type: integer + node_id: + type: string + state: + type: string + context: + type: string + target_url: + type: string + format: uri + nullable: true + required: + type: boolean + nullable: true + avatar_url: + type: string + nullable: true + format: uri + url: + type: string + format: uri + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - description + - id + - node_id + - state + - context + - target_url + - avatar_url + - url + - created_at + - updated_at + nullable-code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + nullable: true + nullable-community-health-file: + title: Community Health File + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + required: + - url + - html_url + nullable: true + secret-scanning-push-protection-bypass-placeholder-id: + description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. + type: string + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + hook-response: + title: Hook Response + type: object + properties: + code: + type: integer + nullable: true + status: + type: string + nullable: true + message: + type: string + nullable: true + required: + - code + - status + - message + pages-source-hash: + title: Pages Source Hash + type: object + properties: + branch: + type: string + path: + type: string + required: + - branch + - path + pages-https-certificate: + title: Pages Https Certificate + type: object + properties: + state: + type: string + enum: + - new + - authorization_created + - authorization_pending + - authorized + - authorization_revoked + - issued + - uploaded + - approved + - errored + - bad_authz + - destroy_pending + - dns_changed + example: approved + description: + type: string + example: Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + example: + - example.com + - www.example.com + expires_at: + type: string + format: date + required: + - state + - description + - domains + repository-rule-ruleset-info: + title: repository ruleset data for rule + description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + properties: + ruleset_source_type: + type: string + description: The type of source for the ruleset that includes this rule. + enum: + - Repository + - Organization + ruleset_source: + type: string + description: The name of the source of the ruleset that includes this rule. + ruleset_id: + type: integer + description: The ID of the ruleset that includes this rule. + type: object + repository-rule-merge-queue: + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests requesting checks and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be merged together in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be merged together in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes + traffic: + title: Traffic + type: object + properties: + timestamp: + type: string + format: date-time + uniques: + type: integer + count: + type: integer + required: + - timestamp + - uniques + - count + repository-ruleset-conditions-repository-property-spec: + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository property + properties: + name: + type: string + description: The name of the repository property to target + property_values: + type: array + description: The values to match for the repository property + items: + type: string + source: + type: string + description: The source of the repository property. Defaults to 'custom' if not specified. + enum: + - custom + - system + required: + - name + - property_values + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. + reviewer: + $ref: '#/components/schemas/repository-rule-params-reviewer' + required: + - file_patterns + - minimum_approvals + - reviewer + repository-rule-params-status-check-configuration: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: + type: string + description: The status check context name that must be present on the commit. + integration_id: + type: integer + description: The optional integration ID that this status check must originate from. + required: + - context + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: + type: string + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-params-code-scanning-tool: + title: CodeScanningTool + description: A tool that must provide code scanning results for this rule to pass. + type: object + properties: + alerts_threshold: + type: string + description: The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + repository-rule-params-reviewer: + title: Reviewer + description: A required reviewing team + type: object + properties: + id: + type: integer + description: ID of the reviewer which must review changes to matching files. + type: + type: string + description: The type of the reviewer + enum: + - Team + required: + - id + - type + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + internal_error: + description: Internal Error + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + temporary_redirect: + description: Temporary Redirect + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + found: + description: Found + not_modified: + description: Not modified + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + no_content: + description: A header with no content is returned. + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + ruleset-targets: + name: targets + description: | + A comma-separated list of rule targets to filter by. + If provided, only rulesets that apply to the specified targets will be returned. + For example, `branch,tag,push`. + in: query + required: false + schema: + type: string + example: branch,tag,push + ref-in-query: + name: ref + description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + in: query + schema: + type: string + x-multi-segment: true + repository-name-in-query: + name: repository_name + description: The name of the repository to filter on. + in: query + schema: + type: string + time-period: + name: time_period + description: |- + The time period to filter by. + + For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). + in: query + required: false + schema: + type: string + enum: + - hour + - day + - week + - month + default: day + actor-name-in-query: + name: actor_name + description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. + in: query + schema: + type: string + rule-suite-result: + name: rule_suite_result + description: The rule suite results to filter on. When specified, only suites with this result will be returned. + in: query + schema: + type: string + enum: + - pass + - fail + - bypass + - all + default: all + rule-suite-id: + name: rule_suite_id + description: |- + The unique identifier of the rule suite result. + To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + for organizations. + in: path + required: true + schema: + type: integer + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + autolink-id: + name: autolink_id + description: The unique identifier of the autolink. + in: path + required: true + schema: + type: integer + branch: + name: branch + description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). + in: path + required: true + schema: + type: string + x-multi-segment: true + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + comment-id: + name: comment_id + description: The unique identifier of the comment. + in: path + required: true + schema: + type: integer + format: int64 + commit-sha: + name: commit_sha + description: The SHA of the commit. + in: path + required: true + schema: + type: string + x-multi-segment: true + commit-ref: + name: ref + description: The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + in: path + required: true + schema: + type: string + x-multi-segment: true + deployment-id: + name: deployment_id + description: deployment_id parameter + in: path + required: true + schema: + type: integer + environment-name: + name: environment_name + in: path + required: true + description: The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. + schema: + type: string + branch-policy-id: + name: branch_policy_id + in: path + required: true + description: The unique identifier of the branch policy. + schema: + type: integer + protection-rule-id: + name: protection_rule_id + description: The unique identifier of the protection rule. + in: path + required: true + schema: + type: integer + hook-id: + name: hook_id + description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. + in: path + required: true + schema: + type: integer + cursor: + name: cursor + description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.' + in: query + required: false + schema: + type: string + webhook-delivery-status: + name: status + description: Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive). + in: query + required: false + schema: + type: string + enum: + - success + - failure + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + in: path + required: true + schema: + type: integer + key-id: + name: key_id + description: The unique identifier of the key. + in: path + required: true + schema: + type: integer + pages-deployment-id: + name: pages_deployment_id + description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. + in: path + required: true + schema: + oneOf: + - type: integer + - type: string + asset-id: + name: asset_id + description: The unique identifier of the asset. + in: path + required: true + schema: + type: integer + release-id: + name: release_id + description: The unique identifier of the release. + in: path + required: true + schema: + type: integer + per: + name: per + description: The time frame to display results for. + in: query + required: false + schema: + type: string + enum: + - day + - week + default: day + since-repo: + name: since + description: A repository ID. Only return repositories with an ID greater than this ID. + in: query + required: false + schema: + type: integer + since-repo-date: + name: since + description: 'Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + before-repo-date: + name: before + description: 'Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' + in: query + required: false + schema: + type: string + format: date-time + examples: + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + full-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: null + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + org-ruleset-items: + value: + - id: 21 + name: super cool ruleset + source_type: Organization + source: my-org + enforcement: enabled + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/orgs/my-org/rulesets/21 + html: + href: https://github.com/organizations/my-org/settings/rules/21 + created_at: '2023-07-15T08:43:03Z' + updated_at: '2023-08-23T16:29:47Z' + - id: 432 + name: Another ruleset + source_type: Organization + source: my-org + enforcement: enabled + node_id: RRS_lACkVXNlcgQQ + _links: + self: + href: https://api.github.com/orgs/my-org/rulesets/432 + html: + href: https://github.com/organizations/my-org/settings/rules/432 + created_at: '2023-08-15T08:43:03Z' + updated_at: '2023-09-23T16:29:47Z' + org-ruleset: + value: + id: 21 + name: super cool ruleset + target: branch + source_type: Organization + source: my-org + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/orgs/my-org/rulesets/21 + html: + href: https://github.com/organizations/my-org/settings/rules/21 + created_at: '2023-08-15T08:43:03Z' + updated_at: '2023-09-23T16:29:47Z' + rule-suite-items: + value: + - id: 21 + actor_id: 12 + actor_name: octocat + before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d + after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 + ref: refs/heads/i-see-everything + repository_id: 404 + repository_name: octo-repo + pushed_at: '2023-07-06T08:43:03Z' + result: bypass + - id: 25 + actor_id: 11 + actor_name: not-octocat + before_sha: 48994e4e01ccc943624c6231f172702b82b233cc + after_sha: ecfd5a1025fa271a33ca5608d089476a2df3c9a1 + ref: refs/heads/i-am-everything + repository_id: 404 + repository_name: octo-repo + pushed_at: '2023-07-07T08:43:03Z' + result: pass + evaluation_result: fail + rule-suite: + value: + id: 21 + actor_id: 12 + actor_name: octocat + before_sha: 893f768e172fb1bc9c5d6f3dd48557e45f14e01d + after_sha: dedd88641a362b6b4ea872da4847d6131a164d01 + ref: refs/heads/i-see-everything + repository_id: 404 + repository_name: octo-repo + pushed_at: '2023-07-06T08:43:03Z' + result: bypass + evaluation_result: fail + rule_evaluations: + - rule_source: + type: ruleset + id: 2 + name: Author email must be a GitHub email address + enforcement: active + result: pass + rule_type: commit_author_email_pattern + - rule_source: + type: protected_branch + enforcement: active + result: fail + rule_type: pull_request + details: Changes must be made through a pull request. + - rule_source: + type: ruleset + id: 3 + name: Evaluate commit message pattern + enforcement: evaluate + result: fail + rule_type: commit_message_pattern + full-repository-default-response: + summary: Default response + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_bypass: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + activity-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: 6dcb09b5b57875f334f61aebed695e2e4193db5e + after: 827efc6d56897b048c772eb4087f854f46256132 + ref: refs/heads/main + pushed_at: '2011-01-26T19:06:43Z' + push_type: normal + pusher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + attestation: + value: + bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + autolink-items: + value: + - id: 1 + key_prefix: TICKET- + url_template: https://example.com/TICKET?query= + is_alphanumeric: true + autolink: + value: + id: 1 + key_prefix: TICKET- + url_template: https://example.com/TICKET?query= + is_alphanumeric: true + short-branch-with-protection-items: + value: + - name: master + commit: + sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + protected: true + protection: + required_status_checks: + enforcement_level: non_admins + contexts: + - ci-test + - linter + protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection + branch-get: + value: + name: main + commit: + sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + node_id: MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk + commit: + author: + name: The Octocat + email: octocat@nowhere.com + date: '2012-03-06T23:06:50Z' + committer: + name: The Octocat + email: octocat@nowhere.com + date: '2012-03-06T23:06:50Z' + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + tree: + sha: b4eecafa9be2f2006ce1b709d6857b07069b4608 + url: https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608 + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + comment_count: 77 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + html_url: https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments + author: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - sha: 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + url: https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + html_url: https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + - sha: 762941318ee16e59dabbacb1b4049eec22f0d303 + url: https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303 + html_url: https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303 + _links: + self: https://api.github.com/repos/octocat/Hello-World/branches/main + html: https://github.com/octocat/Hello-World/tree/main + protected: false + protection: + enabled: false + required_status_checks: + enforcement_level: 'off' + contexts: [] + checks: [] + protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection + branch-protection: + value: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection + required_status_checks: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + contexts: + - continuous-integration/travis-ci + contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + enforcement_level: non_admins + enforce_admins: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: true + required_pull_request_reviews: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews + dismissal_restrictions: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users + teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + restrictions: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions + users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users + teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams + apps_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + required_linear_history: + enabled: true + allow_force_pushes: + enabled: true + allow_deletions: + enabled: true + required_conversation_resolution: + enabled: true + lock_branch: + enabled: true + allow_fork_syncing: + enabled: true + branch-protection-update: + value: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection + required_status_checks: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks + strict: true + contexts: + - continuous-integration/travis-ci + contexts_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts + checks: + - context: continuous-integration/travis-ci + app_id: null + restrictions: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions + users_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users + teams_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams + apps_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps + users: [] + teams: [] + apps: [] + required_pull_request_reviews: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + dismissal_restrictions: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions + users_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users + teams_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams + users: [] + teams: [] + apps: [] + required_signatures: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures + enabled: false + enforce_admins: + url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins + enabled: true + required_linear_history: + enabled: true + allow_force_pushes: + enabled: true + allow_deletions: + enabled: true + block_creations: + enabled: true + required_conversation_resolution: + enabled: true + lock_branch: + enabled: true + allow_fork_syncing: + enabled: true + protected-branch-admin-enforced-2: + value: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: true + protected-branch-pull-request-review: + value: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews + dismissal_restrictions: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions + users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users + teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + dismiss_stale_reviews: true + require_code_owner_reviews: true + required_approving_review_count: 2 + require_last_push_approval: true + protected-branch-admin-enforced: + value: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: true + status-check-policy: + value: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: true + contexts: + - continuous-integration/travis-ci + contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts + branch-restriction-policy: + value: + url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions + users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users + teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams + apps_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps + users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + apps: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + integration-items: + value: + - id: 1 + slug: octoapp + node_id: MDExOkludGVncmF0aW9uMQ== + owner: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + name: Octocat App + description: '' + external_url: https://example.com + html_url: https://github.com/apps/octoapp + created_at: '2017-07-08T16:18:44-04:00' + updated_at: '2017-07-08T16:18:44-04:00' + permissions: + metadata: read + contents: read + issues: write + single_file: write + events: + - push + - pull_request + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + branch-with-protection: + value: + name: master + commit: + sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + node_id: MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA== + commit: + author: + name: The Octocat + date: '2012-03-06T15:06:50-08:00' + email: octocat@nowhere.com + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + message: |- + Merge pull request #6 from Spaceghost/patch-1 + + New line at end of file. + tree: + sha: b4eecafa9be2f2006ce1b709d6857b07069b4608 + url: https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608 + committer: + name: The Octocat + date: '2012-03-06T15:06:50-08:00' + email: octocat@nowhere.com + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + comment_count: 0 + author: + gravatar_id: '' + avatar_url: https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png + url: https://api.github.com/users/octocat + id: 583231 + login: octocat + node_id: MDQ6VXNlcjE= + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + parents: + - sha: 553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + url: https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e + - sha: 762941318ee16e59dabbacb1b4049eec22f0d303 + url: https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303 + url: https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + committer: + gravatar_id: '' + avatar_url: https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png + url: https://api.github.com/users/octocat + id: 583231 + login: octocat + node_id: MDQ6VXNlcjE= + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + _links: + html: https://github.com/octocat/Hello-World/tree/master + self: https://api.github.com/repos/octocat/Hello-World/branches/master + protected: true + protection: + required_status_checks: + enforcement_level: non_admins + contexts: + - ci-test + - linter + protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection + codeowners-errors: + value: + errors: + - line: 3 + column: 1 + kind: Invalid pattern + source: '***/*.rb @monalisa' + suggestion: Did you mean `**/*.rb`? + message: |- + Invalid pattern on line 3: Did you mean `**/*.rb`? + + ***/*.rb @monalisa + ^ + path: .github/CODEOWNERS + - line: 7 + column: 7 + kind: Invalid owner + source: '*.txt docs@' + suggestion: null + message: |- + Invalid owner on line 7: + + *.txt docs@ + ^ + path: .github/CODEOWNERS + collaborator-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: + pull: true + triage: true + push: true + maintain: false + admin: false + role_name: write + repository-invitation-response-when-a-new-invitation-is-created: + value: + id: 1 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + invitee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + inviter: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: write + created_at: '2016-06-13T14:52:50-05:00' + url: https://api.github.com/user/repository_invitations/1296269 + html_url: https://github.com/octocat/Hello-World/invitations + repository-collaborator-permission-response-if-user-has-admin-permissions: + value: + permission: admin + role_name: admin + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + commit-comment-items: + value: + - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 + url: https://api.github.com/repos/octocat/Hello-World/comments/1 + id: 1 + node_id: MDEzOkNvbW1pdENvbW1lbnQx + body: Great stuff + path: file1.txt + position: 4 + line: 14 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + author_association: COLLABORATOR + commit-comment: + value: + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 + url: https://api.github.com/repos/octocat/Hello-World/comments/1 + id: 1 + node_id: MDEzOkNvbW1pdENvbW1lbnQx + body: Great stuff + path: file1.txt + position: 4 + line: 14 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: COLLABORATOR + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + commit-comment-2: + value: + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 + url: https://api.github.com/repos/octocat/Hello-World/comments/1 + id: 1 + node_id: MDEzOkNvbW1pdENvbW1lbnQx + body: Nice change + path: file1.txt + position: 4 + line: 14 + commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: COLLABORATOR + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + commit-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: support@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + branch-short-items: + value: + - name: branch_5 + commit: + sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + protected: false + pull-request-simple-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: 1 + node_id: MDExOlB1bGxSZXF1ZXN0MQ== + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: 1347 + state: open + locked: true + title: Amazing new feature + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + body: Please pull these awesome changes in! + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + active_lock_reason: too heated + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:01:12Z' + closed_at: '2011-01-26T19:01:12Z' + merged_at: '2011-01-26T19:01:12Z' + merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assignees: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - login: hubot + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: true + requested_reviewers: + - login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + requested_teams: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + permission: admin + notification_setting: notifications_enabled + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + head: + label: octocat:new-topic + ref: new-topic + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + base: + label: octocat:master + ref: master + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repo: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + _links: + self: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html: + href: https://github.com/octocat/Hello-World/pull/1347 + issue: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347 + comments: + href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + review_comments: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment: + href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + statuses: + href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + author_association: OWNER + auto_merge: null + draft: false + commit: + value: + url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + stats: + additions: 104 + deletions: 4 + total: 108 + files: + - filename: file1.txt + additions: 10 + deletions: 2 + changes: 12 + status: modified + raw_url: https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt + blob_url: https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt + patch: |- + @@ -29,7 +29,7 @@ + ..... + diff-media-type: + value: | + diff --git a/testfile b/testfile + index 9bdeaeb..912c7ef 100644 + --- a/testfile + +++ b/testfile + @@ -1 +1 @@ + -test + +test change + patch-media-type: + value: | + From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001 + From: Mona Lisa <87831417+monalisa@users.noreply.github.com> + Date: Fri, 6 Mar 2026 11:18:45 +0000 + Subject: [PATCH] Change 'test' to 'test change' in testfile + + --- + testfile | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + + diff --git a/testfile b/testfile + index 9bdeaeb..912c7ef 100644 + --- a/testfile + +++ b/testfile + @@ -1 +1 @@ + -test + +test change + combined-commit-status: + value: + state: success + statuses: + - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/hubot_happy.gif + id: 1 + node_id: MDY6U3RhdHVzMQ== + state: success + description: Build has completed successfully + target_url: https://ci.example.com/1000/output + context: continuous-integration/jenkins + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/other_user_happy.gif + id: 2 + node_id: MDY6U3RhdHVzMg== + state: success + description: Testing has completed successfully + target_url: https://ci.example.com/2000/output + context: security/brakeman + created_at: '2012-08-20T01:19:13Z' + updated_at: '2012-08-20T01:19:13Z' + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + total_count: 2 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + commit_url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e + url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status + status-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/hubot_happy.gif + id: 1 + node_id: MDY6U3RhdHVzMQ== + state: success + description: Build has completed successfully + target_url: https://ci.example.com/1000/output + context: continuous-integration/jenkins + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + community-profile: + value: + health_percentage: 100 + description: My first repository on GitHub! + documentation: null + files: + code_of_conduct: + name: Contributor Covenant + key: contributor_covenant + url: https://api.github.com/codes_of_conduct/contributor_covenant + html_url: https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md + code_of_conduct_file: + url: https://api.github.com/repos/octocat/Hello-World/contents/CODE_OF_CONDUCT.md + html_url: https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md + contributing: + url: https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING + html_url: https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING + issue_template: + url: https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE + html_url: https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE + pull_request_template: + url: https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE + html_url: https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE + license: + name: MIT License + key: mit + spdx_id: MIT + url: https://api.github.com/licenses/mit + html_url: https://github.com/octocat/Hello-World/blob/master/LICENSE + node_id: MDc6TGljZW5zZW1pdA== + readme: + url: https://api.github.com/repos/octocat/Hello-World/contents/README.md + html_url: https://github.com/octocat/Hello-World/blob/master/README.md + updated_at: '2017-02-28T19:09:29Z' + content_reports_enabled: true + commit-comparison: + value: + url: https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: https://github.com/octocat/Hello-World/compare/master...topic.patch + base_commit: + url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + merge_base_commit: + url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + status: behind + ahead_by: 1 + behind_by: 2 + total_commits: 1 + commits: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + url: https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + committer: + name: Monalisa Octocat + email: mona@github.com + date: '2011-04-14T16:00:49Z' + message: Fix all the bugs + tree: + url: https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + comment_count: 0 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + parents: + - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e + files: + - sha: bbcd538c8e72b8c175046e27cc8f907076331401 + filename: file1.txt + status: added + additions: 103 + deletions: 21 + changes: 124 + blob_url: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: '@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test' + content-file-response-if-content-is-a-file: + summary: Response if content is a file + value: + type: file + encoding: base64 + size: 5362 + name: README.md + path: README.md + content: IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\nIHdvcmtmbG93Lgo=\n + sha: 3d21ec53a331a6f037a91c368710b99387d012c1 + url: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + html_url: https://github.com/octokit/octokit.rb/blob/master/README.md + download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md + _links: + git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + self: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + html: https://github.com/octokit/octokit.rb/blob/master/README.md + content-file-response-if-content-is-a-directory-object: + summary: Response if content is a directory and the application/vnd.github.v3.object media type is requested + value: + type: dir + size: 0 + name: src + path: src + sha: 2962be1c94eaae9794b3080790ec9d74b2fa8358 + url: https://api.github.com/repos/octocat/octorepo/contents/src?ref=main + git_url: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html_url: https://github.com/octocat/octorepo/blob/main/src + download_url: https://raw.githubusercontent.com/octocat/octorepo/main/src + _links: + self: https://api.github.com/repos/octocat/octorepo/contents/src + git: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html: https://github.com/octocat/octorepo/blob/main/src + entries: + - type: file + size: 625 + name: app.js + path: src/app.js + sha: fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + url: https://api.github.com/repos/octocat/octorepo/contents/src/app.js + git_url: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html_url: https://github.com/octocat/octorepo/blob/main/src/app.js + download_url: https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js + _links: + self: https://api.github.com/repos/octocat/octorepo/contents/src/app.js + git: https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html: https://github.com/octocat/octorepo/blob/main/src/app.js + - type: dir + size: 0 + name: images + path: src/images + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + url: https://api.github.com/repos/octocat/octorepo/contents/src/images + git_url: https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html_url: https://github.com/octocat/octorepo/tree/main/src/images + download_url: null + _links: + self: https://api.github.com/repos/octocat/octorepo/contents/src/images + git: https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html: https://github.com/octocat/octorepo/tree/main/src/images + content-file-response-if-content-is-a-directory: + summary: Response if content is a directory and the application/json media type is requested + value: + - type: file + size: 625 + name: octokit.rb + path: lib/octokit.rb + sha: fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + url: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb + git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html_url: https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb + download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb + _links: + self: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb + git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b + html: https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb + - type: dir + size: 0 + name: octokit + path: lib/octokit + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + url: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit + git_url: https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html_url: https://github.com/octokit/octokit.rb/tree/master/lib/octokit + download_url: null + _links: + self: https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit + git: https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + html: https://github.com/octokit/octokit.rb/tree/master/lib/octokit + content-file-response-if-content-is-a-symlink: + summary: Response if content is a symlink and the application/json media type is requested + value: + type: symlink + target: /path/to/symlink/target + size: 23 + name: some-symlink + path: bin/some-symlink + sha: 452a98979c88e093d682cab404a3ec82babebb48 + url: https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink + git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48 + html_url: https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink + download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink + _links: + git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48 + self: https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink + html: https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink + content-file-response-if-content-is-a-submodule: + summary: Response if content is a submodule and the application/json media type is requested + value: + type: submodule + submodule_git_url: git://github.com/jquery/qunit.git + size: 0 + name: qunit + path: test/qunit + sha: 6ca3721222109997540bd6d9ccd396902e0ad2f9 + url: https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master + git_url: https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9 + html_url: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 + download_url: null + _links: + git: https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9 + self: https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master + html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 + file-commit-example-for-updating-a-file: + value: + content: + name: hello.txt + path: notes/hello.txt + sha: a56507ed892d05a37c6d6128c260937ea4d287bd + size: 9 + url: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + git_url: https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd + download_url: https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt + type: file + _links: + self: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + git: https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd + html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + commit: + sha: 18a43cd8e1e3a79c786e3d808a73d23b6d212b16 + node_id: MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg== + url: https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16 + html_url: https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16 + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f + sha: 9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f + parents: + - url: https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6 + html_url: https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6 + sha: da5a433788da5c255edad7979b328b67d79f53f6 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + file-commit-example-for-creating-a-file: + value: + content: + name: hello.txt + path: notes/hello.txt + sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + size: 9 + url: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + git_url: https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + download_url: https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt + type: file + _links: + self: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt + git: https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3 + html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt + commit: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + html_url: https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + file-commit: + value: + content: null + commit: + sha: 7638417db6d59f3c431d3e1f261cc637155684cd + node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA== + url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd + author: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + committer: + date: '2014-11-07T22:01:45Z' + name: Monalisa Octocat + email: octocat@github.com + message: my commit message + tree: + url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb + sha: 691272480426f78a0138979dd3ce63b77f706feb + parents: + - url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5 + html_url: https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5 + sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5 + verification: + verified: false + reason: unsigned + signature: null + payload: null + verified_at: null + contributor-items-response-if-repository-contains-content: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + contributions: 32 + deployment-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + deployment-simple-example: + summary: Simple example + value: + url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + deployment: + value: + url: https://api.github.com/repos/octocat/example/deployments/1 + id: 1 + node_id: MDEwOkRlcGxveW1lbnQx + sha: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: topic-branch + task: deploy + payload: {} + original_environment: staging + environment: production + description: Deploy request from hubot + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + statuses_url: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: https://api.github.com/repos/octocat/example + transient_environment: false + production_environment: true + deployment-status-items: + value: + - url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: 1 + node_id: MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: success + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + description: Deployment finished successfully. + environment: production + target_url: https://example.com/deployment/42/output + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + deployment_url: https://api.github.com/repos/octocat/example/deployments/42 + repository_url: https://api.github.com/repos/octocat/example + environment_url: https://test-branch.lab.acme.com + log_url: https://example.com/deployment/42/output + deployment-status: + value: + url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: 1 + node_id: MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: success + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + description: Deployment finished successfully. + environment: production + target_url: https://example.com/deployment/42/output + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + deployment_url: https://api.github.com/repos/octocat/example/deployments/42 + repository_url: https://api.github.com/repos/octocat/example + environment_url: https://test-branch.lab.acme.com + log_url: https://example.com/deployment/42/output + environments: + value: + total_count: 1 + environments: + - id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + protection_rules: + - id: 3736 + node_id: MDQ6R2F0ZTM3MzY= + type: wait_timer + wait_timer: 30 + - id: 3755 + node_id: MDQ6R2F0ZTM3NTU= + prevent_self_review: false + type: required_reviewers + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + - id: 3756 + node_id: MDQ6R2F0ZTM3NTY= + type: branch_policy + deployment_branch_policy: + protected_branches: false + custom_branch_policies: true + environment: + value: + id: 161088068 + node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 + name: staging + url: https://api.github.com/repos/github/hello-world/environments/staging + html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + created_at: '2020-11-23T22:00:40Z' + updated_at: '2020-11-23T22:00:40Z' + protection_rules: + - id: 3736 + node_id: MDQ6R2F0ZTM3MzY= + type: wait_timer + wait_timer: 30 + - id: 3755 + node_id: MDQ6R2F0ZTM3NTU= + prevent_self_review: false + type: required_reviewers + reviewers: + - type: User + reviewer: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + - type: Team + reviewer: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + - id: 3756 + node_id: MDQ6R2F0ZTM3NTY= + type: branch_policy + deployment_branch_policy: + protected_branches: false + custom_branch_policies: true + deployment-branch-policies-list: + value: + total_count: 2 + branch_policies: + - id: 361471 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: release/* + - id: 361472 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI= + name: main + deployment-branch-policy-wildcard: + value: + id: 364662 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= + name: release/* + deployment-branch-policy-single-branch: + value: + id: 364663 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= + name: main + deployment-branch-policy-single-tag: + value: + id: 364663 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= + name: v1 + type: tag + deployment-protection-rules: + value: + - total_count: 2 + - custom_deployment_protection_rules: + - id: 3 + node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv + enabled: true + app: + id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + - id: 4 + node_id: MDE2OkRlcGxveW1lbnRTdHJ41128 + enabled: true + app: + id: 1 + node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy + slug: another-custom-app + integration_url: https://api.github.com/apps/another-custom-app + deployment-protection-rule: + value: + id: 3 + node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv + enabled: true + app: + id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + custom-deployment-protection-rule-apps: + value: + - total_count: 2 + - available_custom_deployment_protection_rule_integrations: + - id: 1 + node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy + slug: a-custom-app + integration_url: https://api.github.com/apps/a-custom-app + - id: 2 + node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy + slug: another-custom-app + integration_url: https://api.github.com/apps/another-custom-app + minimal-repository-items-2: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: true + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + delete_branch_on_merge: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + spdx_id: MIT + url: https://api.github.com/licenses/mit + node_id: MDc6TGljZW5zZW1pdA== + hook-items: + value: + - type: Repository + id: 12345678 + name: web + active: true + events: + - push + - pull_request + config: + content_type: json + insecure_ssl: '0' + url: https://example.com/webhook + updated_at: '2019-06-03T00:57:16Z' + created_at: '2019-06-03T00:57:16Z' + url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 + test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test + ping_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings + deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries + last_response: + code: null + status: unused + message: null + hook: + value: + type: Repository + id: 12345678 + name: web + active: true + events: + - push + - pull_request + config: + content_type: json + insecure_ssl: '0' + url: https://example.com/webhook + updated_at: '2019-06-03T00:57:16Z' + created_at: '2019-06-03T00:57:16Z' + url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678 + test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test + ping_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings + deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries + last_response: + code: null + status: unused + message: null + webhook-config: + value: + content_type: json + insecure_ssl: '0' + secret: '********' + url: https://example.com/webhook + hook-delivery-items: + value: + - id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: '2019-06-03T00:57:16Z' + - id: 123456789 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-04T00:57:16Z' + redelivery: true + duration: 0.28 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + throttled_at: null + hook-delivery: + value: + id: 12345678 + guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + delivered_at: '2019-06-03T00:57:16Z' + redelivery: false + duration: 0.27 + status: OK + status_code: 200 + event: issues + action: opened + installation_id: 123 + repository_id: 456 + url: https://www.example.com + throttled_at: '2019-06-03T00:57:16Z' + request: + headers: + X-GitHub-Delivery: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + X-Hub-Signature-256: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + Accept: '*/*' + X-GitHub-Hook-ID: '42' + User-Agent: GitHub-Hookshot/b8c71d8 + X-GitHub-Event: issues + X-GitHub-Hook-Installation-Target-ID: '123' + X-GitHub-Hook-Installation-Target-Type: repository + content-type: application/json + X-Hub-Signature: sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + payload: + action: opened + issue: + body: foo + repository: + id: 123 + response: + headers: + Content-Type: text/html;charset=utf-8 + payload: ok + repository-invitation-items: + value: + - id: 1 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + invitee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + inviter: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: write + created_at: '2016-06-13T14:52:50-05:00' + url: https://api.github.com/user/repository_invitations/1296269 + html_url: https://github.com/octocat/Hello-World/invitations + node_id: MDQ6VXNlcjE= + repository-invitation: + value: + id: 1 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + invitee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + inviter: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + permissions: write + created_at: '2016-06-13T14:52:50-05:00' + expired: false + url: https://api.github.com/user/repository_invitations/1296269 + html_url: https://github.com/octocat/Hello-World/invitations + deploy-key-items: + value: + - id: 1 + key: ssh-rsa AAA... + url: https://api.github.com/repos/octocat/Hello-World/keys/1 + title: octocat@octomac + verified: true + created_at: '2014-12-10T15:53:42Z' + read_only: true + added_by: octocat + last_used: '2022-01-10T15:53:42Z' + enabled: true + deploy-key: + value: + id: 1 + key: ssh-rsa AAA... + url: https://api.github.com/repos/octocat/Hello-World/keys/1 + title: octocat@octomac + verified: true + created_at: '2014-12-10T15:53:42Z' + read_only: true + added_by: octocat + last_used: '2022-01-10T15:53:42Z' + enabled: true + language: + value: + C: 78769 + Python: 7769 + merged-upstream: + value: + message: Successfully fetched and fast-forwarded from upstream defunkt:main + merge_type: fast-forward + base_branch: defunkt:main + page: + value: + url: https://api.github.com/repos/github/developer.github.com/pages + status: built + cname: developer.github.com + custom_404: false + html_url: https://developer.github.com + source: + branch: master + path: / + public: true + pending_domain_unverified_at: '2024-04-30T19:33:31Z' + protected_domain_state: verified + https_certificate: + state: approved + description: Certificate is approved + domains: + - developer.github.com + expires_at: '2021-05-22' + https_enforced: true + page-build-items: + value: + - url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 + status: built + error: + message: null + pusher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + commit: 351391cdcb88ffae71ec3028c91f375a8036a26b + duration: 2104 + created_at: '2014-02-10T19:00:49Z' + updated_at: '2014-02-10T19:00:51Z' + page-build-status: + value: + url: https://api.github.com/repos/github/developer.github.com/pages/builds/latest + status: queued + page-build: + value: + url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 + status: built + error: + message: null + pusher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + commit: 351391cdcb88ffae71ec3028c91f375a8036a26b + duration: 2104 + created_at: '2014-02-10T19:00:49Z' + updated_at: '2014-02-10T19:00:51Z' + page-deployment: + value: + id: 4fd754f7e594640989b406850d0bc8f06a121251 + status_url: https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + page_url: developer.github.com + pages-deployment-status: + value: + status: succeed + pages-health-check: + value: + domain: + host: example.com + uri: http://example.com/ + nameservers: default + dns_resolves: true + is_proxied: false + is_cloudflare_ip: false + is_fastly_ip: false + is_old_ip_address: false + is_a_record: true + has_cname_record: false + has_mx_records_present: false + is_valid_domain: true + is_apex_domain: true + should_be_a_record: true + is_cname_to_github_user_domain: false + is_cname_to_pages_dot_github_dot_com: false + is_cname_to_fastly: false + is_pointed_to_github_pages_ip: true + is_non_github_pages_ip_present: false + is_pages_domain: false + is_served_by_pages: true + is_valid: true + reason: null + responds_to_https: true + enforces_https: true + https_error: null + is_https_eligible: true + caa_error: null + alt_domain: + host: www.example.com + uri: http://www.example.com/ + nameservers: default + dns_resolves: true + is_proxied: false + is_cloudflare_ip: false + is_fastly_ip: false + is_old_ip_address: false + is_a_record: true + has_cname_record: false + has_mx_records_present: false + is_valid_domain: true + is_apex_domain: true + should_be_a_record: true + is_cname_to_github_user_domain: false + is_cname_to_pages_dot_github_dot_com: false + is_cname_to_fastly: false + is_pointed_to_github_pages_ip: true + is_non_github_pages_ip_present: false + is_pages_domain: false + is_served_by_pages: true + is_valid: true + reason: null + responds_to_https: true + enforces_https: true + https_error: null + is_https_eligible: true + caa_error: null + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + type: object + content-file: + value: + type: file + encoding: base64 + size: 5362 + name: README.md + path: README.md + content: encoded content ... + sha: 3d21ec53a331a6f037a91c368710b99387d012c1 + url: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + git_url: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + html_url: https://github.com/octokit/octokit.rb/blob/master/README.md + download_url: https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md + _links: + git: https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1 + self: https://api.github.com/repos/octokit/octokit.rb/contents/README.md + html: https://github.com/octokit/octokit.rb/blob/master/README.md + release-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/releases/1 + html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 + assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets + upload_url: https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label} + tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0 + zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0 + id: 1 + node_id: MDc6UmVsZWFzZTE= + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + immutable: false + created_at: '2013-02-27T19:35:32Z' + published_at: '2013-02-27T19:35:32Z' + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assets: + - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release: + value: + url: https://api.github.com/repos/octocat/Hello-World/releases/1 + html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 + assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets + upload_url: https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label} + tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0 + zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0 + discussion_url: https://github.com/octocat/Hello-World/discussions/90 + id: 1 + node_id: MDc6UmVsZWFzZTE= + tag_name: v1.0.0 + target_commitish: master + name: v1.0.0 + body: Description of the release + draft: false + prerelease: false + immutable: false + created_at: '2013-02-27T19:35:32Z' + published_at: '2013-02-27T19:35:32Z' + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assets: + - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release-asset: + value: + url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release-notes-content: + value: + name: Release v1.0.0 is now available! + body: '##Changes in Release v1.0.0 ... ##Contributors @monalisa' + release-asset-items: + value: + - url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + release-asset-response-for-successful-upload: + value: + url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 + browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip + id: 1 + node_id: MDEyOlJlbGVhc2VBc3NldDE= + name: example.zip + label: short description + state: uploaded + content_type: application/zip + size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 + download_count: 42 + created_at: '2013-02-27T19:35:32Z' + updated_at: '2013-02-27T19:35:32Z' + uploader: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + repository-rule-items: + value: + - type: commit_message_pattern + ruleset_source_type: Repository + ruleset_source: monalisa/my-repo + ruleset_id: 42 + parameters: + operator: starts_with + pattern: issue + - type: commit_author_email_pattern + ruleset_source_type: Organization + ruleset_source: my-org + ruleset_id: 73 + parameters: + operator: contains + pattern: github + repository-ruleset-items: + value: + - id: 42 + name: super cool ruleset + source_type: Repository + source: monalisa/my-repo + enforcement: enabled + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/repos/monalisa/my-repo/rulesets/42 + html: + href: https://github.com/monalisa/my-repo/rules/42 + created_at: '2023-07-15T08:43:03Z' + updated_at: '2023-08-23T16:29:47Z' + - id: 314 + name: Another ruleset + source_type: Repository + source: monalisa/my-repo + enforcement: enabled + node_id: RRS_lACkVXNlcgQQ + _links: + self: + href: https://api.github.com/repos/monalisa/my-repo/rulesets/314 + html: + href: https://github.com/monalisa/my-repo/rules/314 + created_at: '2023-08-15T08:43:03Z' + updated_at: '2023-09-23T16:29:47Z' + repository-ruleset: + value: + id: 42 + name: super cool ruleset + target: branch + source_type: Repository + source: monalisa/my-repo + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/repos/monalisa/my-repo/rulesets/42 + html: + href: https://github.com/monalisa/my-repo/rules/42 + created_at: '2023-07-15T08:43:03Z' + updated_at: '2023-08-23T16:29:47Z' + ruleset-history: + value: + - version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + - version_id: 2 + actor: + id: 2 + type: User + updated_at: '2024-09-23T16:29:47Z' + - version_id: 1 + actor: + id: 1 + type: User + updated_at: '2024-08-23T16:29:47Z' + repository-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 42 + name: super cool ruleset + target: branch + source_type: Repository + source: monalisa/my-repo + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + code-frequency-stat-items: + value: + - - 1302998400 + - 1124 + - -435 + commit-activity-items: + value: + - days: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + total: 89 + week: 1336280400 + contributor-activity-items: + value: + - author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + total: 135 + weeks: + - w: 1367712000 + a: 6898 + d: 77 + c: 10 + participation-stats: + value: + all: + - 11 + - 21 + - 15 + - 2 + - 8 + - 1 + - 8 + - 23 + - 17 + - 21 + - 11 + - 10 + - 33 + - 91 + - 38 + - 34 + - 22 + - 23 + - 32 + - 3 + - 43 + - 87 + - 71 + - 18 + - 13 + - 5 + - 13 + - 16 + - 66 + - 27 + - 12 + - 45 + - 110 + - 117 + - 13 + - 8 + - 18 + - 9 + - 19 + - 26 + - 39 + - 12 + - 20 + - 31 + - 46 + - 91 + - 45 + - 10 + - 24 + - 9 + - 29 + - 7 + owner: + - 3 + - 2 + - 3 + - 0 + - 2 + - 0 + - 5 + - 14 + - 7 + - 9 + - 1 + - 5 + - 0 + - 48 + - 19 + - 2 + - 0 + - 1 + - 10 + - 2 + - 23 + - 40 + - 35 + - 8 + - 8 + - 2 + - 10 + - 6 + - 30 + - 0 + - 2 + - 9 + - 53 + - 104 + - 3 + - 3 + - 10 + - 4 + - 7 + - 11 + - 21 + - 4 + - 4 + - 22 + - 26 + - 63 + - 11 + - 2 + - 14 + - 1 + - 10 + - 3 + code-frequency-stat-items-2: + value: + - - 0 + - 0 + - 5 + - - 0 + - 1 + - 43 + - - 0 + - 2 + - 21 + status: + value: + url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + avatar_url: https://github.com/images/error/hubot_happy.gif + id: 1 + node_id: MDY6U3RhdHVzMQ== + state: success + description: Build has completed successfully + target_url: https://ci.example.com/1000/output + context: continuous-integration/jenkins + created_at: '2012-07-20T01:19:13Z' + updated_at: '2012-07-20T01:19:13Z' + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + tag-items: + value: + - name: v0.1 + commit: + sha: c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc + zipball_url: https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: MDQ6VXNlcjE= + topic: + value: + names: + - octocat + - atom + - electron + - api + clone-traffic: + value: + count: 173 + uniques: 128 + clones: + - timestamp: '2016-10-10T00:00:00Z' + count: 2 + uniques: 1 + - timestamp: '2016-10-11T00:00:00Z' + count: 17 + uniques: 16 + - timestamp: '2016-10-12T00:00:00Z' + count: 21 + uniques: 15 + - timestamp: '2016-10-13T00:00:00Z' + count: 8 + uniques: 7 + - timestamp: '2016-10-14T00:00:00Z' + count: 5 + uniques: 5 + - timestamp: '2016-10-15T00:00:00Z' + count: 2 + uniques: 2 + - timestamp: '2016-10-16T00:00:00Z' + count: 8 + uniques: 7 + - timestamp: '2016-10-17T00:00:00Z' + count: 26 + uniques: 15 + - timestamp: '2016-10-18T00:00:00Z' + count: 19 + uniques: 17 + - timestamp: '2016-10-19T00:00:00Z' + count: 19 + uniques: 14 + - timestamp: '2016-10-20T00:00:00Z' + count: 19 + uniques: 15 + - timestamp: '2016-10-21T00:00:00Z' + count: 9 + uniques: 7 + - timestamp: '2016-10-22T00:00:00Z' + count: 5 + uniques: 5 + - timestamp: '2016-10-23T00:00:00Z' + count: 6 + uniques: 5 + - timestamp: '2016-10-24T00:00:00Z' + count: 7 + uniques: 5 + content-traffic-items: + value: + - path: /github/hubot + title: 'github/hubot: A customizable life embetterment robot.' + count: 3542 + uniques: 2225 + - path: /github/hubot/blob/master/docs/scripting.md + title: hubot/scripting.md at master Β· github/hubot Β· GitHub + count: 1707 + uniques: 804 + - path: /github/hubot/tree/master/docs + title: hubot/docs at master Β· github/hubot Β· GitHub + count: 685 + uniques: 435 + - path: /github/hubot/tree/master/src + title: hubot/src at master Β· github/hubot Β· GitHub + count: 577 + uniques: 347 + - path: /github/hubot/blob/master/docs/index.md + title: hubot/index.md at master Β· github/hubot Β· GitHub + count: 379 + uniques: 259 + - path: /github/hubot/blob/master/docs/adapters.md + title: hubot/adapters.md at master Β· github/hubot Β· GitHub + count: 354 + uniques: 201 + - path: /github/hubot/tree/master/examples + title: hubot/examples at master Β· github/hubot Β· GitHub + count: 340 + uniques: 260 + - path: /github/hubot/blob/master/docs/deploying/heroku.md + title: hubot/heroku.md at master Β· github/hubot Β· GitHub + count: 324 + uniques: 217 + - path: /github/hubot/blob/master/src/robot.coffee + title: hubot/robot.coffee at master Β· github/hubot Β· GitHub + count: 293 + uniques: 191 + - path: /github/hubot/blob/master/LICENSE.md + title: hubot/LICENSE.md at master Β· github/hubot Β· GitHub + count: 281 + uniques: 222 + referrer-traffic-items: + value: + - referrer: Google + count: 4 + uniques: 3 + - referrer: stackoverflow.com + count: 2 + uniques: 2 + - referrer: eggsonbread.com + count: 1 + uniques: 1 + - referrer: yandex.ru + count: 1 + uniques: 1 + view-traffic: + value: + count: 14850 + uniques: 3782 + views: + - timestamp: '2016-10-10T00:00:00Z' + count: 440 + uniques: 143 + - timestamp: '2016-10-11T00:00:00Z' + count: 1308 + uniques: 414 + - timestamp: '2016-10-12T00:00:00Z' + count: 1486 + uniques: 452 + - timestamp: '2016-10-13T00:00:00Z' + count: 1170 + uniques: 401 + - timestamp: '2016-10-14T00:00:00Z' + count: 868 + uniques: 266 + - timestamp: '2016-10-15T00:00:00Z' + count: 495 + uniques: 157 + - timestamp: '2016-10-16T00:00:00Z' + count: 524 + uniques: 175 + - timestamp: '2016-10-17T00:00:00Z' + count: 1263 + uniques: 412 + - timestamp: '2016-10-18T00:00:00Z' + count: 1402 + uniques: 417 + - timestamp: '2016-10-19T00:00:00Z' + count: 1394 + uniques: 424 + - timestamp: '2016-10-20T00:00:00Z' + count: 1492 + uniques: 448 + - timestamp: '2016-10-21T00:00:00Z' + count: 1153 + uniques: 332 + - timestamp: '2016-10-22T00:00:00Z' + count: 566 + uniques: 168 + - timestamp: '2016-10-23T00:00:00Z' + count: 675 + uniques: 184 + - timestamp: '2016-10-24T00:00:00Z' + count: 614 + uniques: 237 + minimal-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + subscribers_count: 42 + network_count: 0 + public-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + repository-items-default-response: + summary: Default response + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + template_repository: null + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/search.yaml b/provider-dev/source/search.yaml new file mode 100644 index 0000000..0d4c41d --- /dev/null +++ b/provider-dev/source/search.yaml @@ -0,0 +1,4160 @@ +openapi: 3.0.3 +info: + title: search API + description: Search for specific items on GitHub. + version: 1.1.4 +paths: + /search/code: + get: + summary: Search code + description: |- + Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + 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](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + + `q=addClass+in:file+language:js+repo:jquery/jquery` + + 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. + + Considerations for code search: + + Due to the complexity of searching code, there are a few restrictions on how searches are performed: + + * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * Only files smaller than 384 KB are searchable. + * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + + > [!NOTE] + > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. + + This endpoint requires you to authenticate and limits you to 10 requests per minute. + tags: + - search + operationId: search/code + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-code + parameters: + - name: q + description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + deprecated: true + description: '**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - indexed + - name: order + description: '**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ' + in: query + deprecated: true + required: false + schema: + type: string + enum: + - desc + - asc + default: desc + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/code-search-result-item' + examples: + default: + $ref: '#/components/examples/code-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/commits: + get: + summary: Search commits + description: |- + Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match + metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + + `q=repo:octocat/Spoon-Knife+css` + tags: + - search + operationId: search/commits + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-commits + parameters: + - name: q + description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - author-date + - committer-date + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/commit-search-result-item' + examples: + default: + $ref: '#/components/examples/commit-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/issues: + get: + summary: Search issues and pull requests + description: |- + Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + + `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + + This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + + > [!NOTE] + > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + tags: + - search + operationId: search/issues-and-pull-requests + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-issues-and-pull-requests + parameters: + - name: q + description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - comments + - reactions + - reactions-+1 + - reactions--1 + - reactions-smile + - reactions-thinking_face + - reactions-heart + - reactions-tada + - interactions + - created + - updated + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/issues-advanced-search' + - $ref: '#/components/parameters/search-type' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + - search_type + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/issue-search-result-item' + search_type: + type: string + description: The type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`. + enum: + - lexical + - semantic + - hybrid + lexical_fallback_reason: + type: array + description: When a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred. + items: + type: string + enum: + - no_text_terms + - quoted_text + - non_issue_target + - or_boolean_not_supported + - no_accessible_repos + - server_error + - only_non_semantic_fields_requested + examples: + default: + $ref: '#/components/examples/issue-search-result-item-paginated' + lexical-fallback: + $ref: '#/components/examples/issue-search-result-item-paginated-lexical-fallback' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/labels: + get: + summary: Search labels + description: |- + Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + + `q=bug+defect+enhancement&repository_id=64778136` + + The labels that best match the query appear first in the search results. + tags: + - search + operationId: search/labels + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-labels + parameters: + - name: repository_id + description: The id of the repository. + in: query + required: true + schema: + type: integer + - name: q + description: The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - created + - updated + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/label-search-result-item' + examples: + default: + $ref: '#/components/examples/label-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/repositories: + get: + summary: Search repositories + description: |- + Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + + `q=tetris+language:assembly&sort=stars&order=desc` + + This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + tags: + - search + operationId: search/repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-repositories + parameters: + - name: q + description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - stars + - forks + - help-wanted-issues + - updated + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/repo-search-result-item' + examples: + default: + $ref: '#/components/examples/repo-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/topics: + get: + summary: Search topics + description: |- + Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + + When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + + `q=ruby+is:featured` + + This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + tags: + - search + operationId: search/topics + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-topics + parameters: + - name: q + description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). + in: query + required: true + schema: + type: string + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/topic-search-result-item' + examples: + default: + $ref: '#/components/examples/topic-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search + /search/users: + get: + summary: Search users + description: |- + Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). + + When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + + For example, if you're looking for a list of popular users, you might try this query: + + `q=tom+repos:%3E42+followers:%3E1000` + + This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + + This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." + tags: + - search + operationId: search/users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/search/search#search-users + parameters: + - name: q + description: The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - followers + - repositories + - joined + - $ref: '#/components/parameters/order' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - incomplete_results + - items + properties: + total_count: + type: integer + incomplete_results: + type: boolean + items: + type: array + items: + $ref: '#/components/schemas/user-search-result-item' + examples: + default: + $ref: '#/components/examples/user-search-result-item-paginated' + '304': + $ref: '#/components/responses/not_modified' + '422': + $ref: '#/components/responses/validation_failed' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: search + subcategory: search + x-stackQL-resource: search +components: + schemas: + code-search-result-item: + title: Code Search Result Item + description: Code Search Result Item + type: object + properties: + name: + type: string + path: + type: string + sha: + type: string + url: + type: string + format: uri + git_url: + type: string + format: uri + html_url: + type: string + format: uri + repository: + $ref: '#/components/schemas/minimal-repository' + score: + type: number + file_size: + type: integer + language: + type: string + nullable: true + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + example: + - 73..77 + - 77..78 + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + required: + - score + - name + - path + - sha + - git_url + - html_url + - url + - repository + commit-search-result-item: + title: Commit Search Result Item + description: Commit Search Result Item + type: object + properties: + url: + type: string + format: uri + sha: + type: string + html_url: + type: string + format: uri + comments_url: + type: string + format: uri + commit: + type: object + properties: + author: + type: object + properties: + name: + type: string + email: + type: string + date: + type: string + format: date-time + required: + - name + - email + - date + committer: + $ref: '#/components/schemas/nullable-git-user' + comment_count: + type: integer + message: + type: string + tree: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + url: + type: string + format: uri + verification: + $ref: '#/components/schemas/verification' + required: + - author + - committer + - comment_count + - message + - tree + - url + author: + $ref: '#/components/schemas/nullable-simple-user' + committer: + $ref: '#/components/schemas/nullable-git-user' + parents: + type: array + items: + type: object + properties: + url: + type: string + html_url: + type: string + sha: + type: string + repository: + $ref: '#/components/schemas/minimal-repository' + score: + type: number + node_id: + type: string + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + required: + - sha + - node_id + - url + - html_url + - author + - committer + - parents + - comments_url + - commit + - repository + - score + issue-search-result-item: + title: Issue Search Result Item + description: Issue Search Result Item + type: object + properties: + url: + type: string + format: uri + repository_url: + type: string + format: uri + labels_url: + type: string + comments_url: + type: string + format: uri + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + node_id: + type: string + number: + type: integer + title: + type: string + locked: + type: boolean + active_lock_reason: + type: string + nullable: true + assignees: + type: array + items: + $ref: '#/components/schemas/simple-user' + nullable: true + user: + $ref: '#/components/schemas/nullable-simple-user' + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + color: + type: string + default: + type: boolean + description: + type: string + nullable: true + sub_issues_summary: + $ref: '#/components/schemas/sub-issues-summary' + issue_dependencies_summary: + $ref: '#/components/schemas/issue-dependencies-summary' + issue_field_values: + type: array + items: + $ref: '#/components/schemas/issue-field-value' + state: + type: string + state_reason: + type: string + nullable: true + assignee: + $ref: '#/components/schemas/nullable-simple-user' + milestone: + $ref: '#/components/schemas/nullable-milestone' + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: string + format: date-time + nullable: true + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + pull_request: + type: object + properties: + merged_at: + type: string + format: date-time + nullable: true + diff_url: + type: string + format: uri + nullable: true + html_url: + type: string + format: uri + nullable: true + patch_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + nullable: true + required: + - diff_url + - html_url + - patch_url + - url + body: + type: string + score: + type: number + author_association: + $ref: '#/components/schemas/author-association' + draft: + type: boolean + repository: + $ref: '#/components/schemas/repository' + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + type: + $ref: '#/components/schemas/issue-type' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + pinned_comment: + $ref: '#/components/schemas/nullable-issue-comment' + reactions: + $ref: '#/components/schemas/reaction-rollup' + required: + - assignee + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - author_association + - created_at + - updated_at + - score + x-github-breaking-changes: + - changeset: remove_singular_assignee_from_issues_and_pull_requests + patch: + properties: + assignee: null + required: + - closed_at + - comments + - comments_url + - events_url + - html_url + - id + - node_id + - labels + - labels_url + - milestone + - number + - repository_url + - state + - locked + - title + - url + - user + - author_association + - created_at + - updated_at + - score + type: object + version: '2026-03-10' + label-search-result-item: + title: Label Search Result Item + description: Label Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + name: + type: string + color: + type: string + default: + type: boolean + description: + type: string + nullable: true + score: + type: number + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + required: + - id + - node_id + - url + - name + - color + - default + - description + - score + repo-search-result-item: + title: Repo Search Result Item + description: Repo Search Result Item + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + $ref: '#/components/schemas/nullable-simple-user' + private: + type: boolean + html_url: + type: string + format: uri + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + format: uri + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + pushed_at: + type: string + format: date-time + homepage: + type: string + format: uri + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + forks_count: + type: integer + open_issues_count: + type: integer + master_branch: + type: string + default_branch: + type: string + score: + type: number + forks_url: + type: string + format: uri + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + format: uri + hooks_url: + type: string + format: uri + issue_events_url: + type: string + events_url: + type: string + format: uri + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + format: uri + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + format: uri + stargazers_url: + type: string + format: uri + contributors_url: + type: string + format: uri + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + format: uri + archive_url: + type: string + downloads_url: + type: string + format: uri + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + format: uri + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + format: uri + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + topics: + type: array + items: + type: string + mirror_url: + type: string + format: uri + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + license: + $ref: '#/components/schemas/nullable-license-simple' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + temp_clone_token: + type: string + allow_merge_commit: + type: boolean + allow_squash_merge: + type: boolean + allow_rebase_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - score + topic-search-result-item: + title: Topic Search Result Item + description: Topic Search Result Item + type: object + properties: + name: + type: string + display_name: + type: string + nullable: true + short_description: + type: string + nullable: true + description: + type: string + nullable: true + created_by: + type: string + nullable: true + released: + type: string + nullable: true + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + featured: + type: boolean + curated: + type: boolean + score: + type: number + repository_count: + type: integer + nullable: true + logo_url: + type: string + format: uri + nullable: true + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + related: + type: array + nullable: true + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + aliases: + type: array + nullable: true + items: + type: object + properties: + topic_relation: + type: object + properties: + id: + type: integer + name: + type: string + topic_id: + type: integer + relation_type: + type: string + required: + - name + - display_name + - short_description + - description + - created_by + - released + - created_at + - updated_at + - featured + - curated + - score + user-search-result-item: + title: User Search Result Item + description: User Search Result Item + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + received_events_url: + type: string + format: uri + type: + type: string + score: + type: number + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + events_url: + type: string + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + name: + type: string + nullable: true + bio: + type: string + nullable: true + email: + type: string + format: email + nullable: true + location: + type: string + nullable: true + site_admin: + type: boolean + hireable: + type: boolean + nullable: true + text_matches: + $ref: '#/components/schemas/search-result-text-matches' + blog: + type: string + nullable: true + company: + type: string + nullable: true + suspended_at: + type: string + format: date-time + nullable: true + user_view_type: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - score + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + nullable: true + type: string + property: + type: string + fragment: + type: string + matches: + type: array + items: + type: object + properties: + text: + type: string + indices: + type: array + items: + type: integer + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + nullable-git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + example: '"Chris Wanstrath"' + email: + type: string + example: '"chris@ozmm.org"' + date: + type: string + format: date-time + example: '"2007-10-29T02:42:39.000-07:00"' + nullable: true + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: string + nullable: true + signature: + type: string + nullable: true + verified_at: + type: string + nullable: true + required: + - verified + - reason + - payload + - signature + - verified_at + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + sub-issues-summary: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + nullable: true + type: string + example: Sample text + single_select_option: + description: Details about the selected option (only present for single_select fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value + nullable-milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + example: 1002604 + node_id: + type: string + example: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + example: 42 + state: + description: The state of the milestone. + example: open + type: string + enum: + - open + - closed + default: open + title: + description: The title of the milestone. + example: v1.0 + type: string + description: + type: string + example: Tracking milestone for version 1.0 + nullable: true + creator: + $ref: '#/components/schemas/nullable-simple-user' + open_issues: + type: integer + example: 4 + closed_issues: + type: integer + example: 8 + created_at: + type: string + format: date-time + example: '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + example: '2014-03-03T18:58:10Z' + closed_at: + type: string + format: date-time + example: '2013-02-12T13:22:01Z' + nullable: true + due_on: + type: string + format: date-time + example: '2012-10-09T23:39:01Z' + nullable: true + required: + - closed_issues + - creator + - description + - due_on + - closed_at + - id + - node_id + - labels_url + - html_url + - number + - open_issues + - state + - title + - url + - created_at + - updated_at + nullable: true + author-association: + title: author_association + type: string + example: OWNER + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description + nullable-integration: + title: GitHub app + description: GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + id: + description: Unique identifier of the GitHub app + example: 37 + type: integer + slug: + description: The slug name of the GitHub app + example: probot-owners + type: string + node_id: + type: string + example: MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + example: '"Iv1.25b5d1e65ffc4022"' + owner: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + description: + description: A short description of the enterprise. + type: string + nullable: true + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - name + - slug + - created_at + - updated_at + name: + description: The name of the GitHub app + example: Probot Owners + type: string + description: + type: string + example: The description of the app. + nullable: true + external_url: + type: string + format: uri + example: https://example.com + html_url: + type: string + format: uri + example: https://github.com/apps/super-ci + created_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + example: '2017-07-08T16:18:44-04:00' + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + issues: + type: string + checks: + type: string + metadata: + type: string + contents: + type: string + deployments: + type: string + additionalProperties: + type: string + example: + issues: read + deployments: write + events: + description: The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. + example: + - label + - deployment + type: array + items: + type: string + installations_count: + description: The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. + example: 5 + type: integer + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + - permissions + - events + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + $ref: '#/components/schemas/nullable-simple-user' + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + $ref: '#/components/schemas/author-association' + performed_via_github_app: + $ref: '#/components/schemas/nullable-integration' + reactions: + $ref: '#/components/schemas/reaction-rollup' + pin: + $ref: '#/components/schemas/nullable-pinned-issue-comment' + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + reaction-rollup: + title: Reaction Rollup + type: object + properties: + url: + type: string + format: uri + total_count: + type: integer + '+1': + type: integer + '-1': + type: integer + laugh: + type: integer + confused: + type: integer + heart: + type: integer + hooray: + type: integer + eyes: + type: integer + rocket: + type: integer + required: + - url + - total_count + - '+1' + - '-1' + - laugh + - confused + - heart + - hooray + - eyes + - rocket + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: string + nullable: true + html_url: + type: string + format: uri + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: string + nullable: true + format: uri + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + example: Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + example: octo-business + created_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: + type: string + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + $ref: '#/components/schemas/nullable-simple-user' + required: + - pinned_at + - pinned_by + nullable: true + responses: + not_modified: + description: Not modified + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + parameters: + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + order: + name: order + description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. + in: query + required: false + schema: + type: string + enum: + - desc + - asc + default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string + search-type: + name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` β€” performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` β€” combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid + examples: + code-search-result-item-paginated: + value: + total_count: 7 + incomplete_results: false + items: + - name: classes.js + path: src/attributes/classes.js + sha: d7212f9dee2dcc18f084d7df8f417b80846ded5a + url: https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4 + git_url: https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a + html_url: https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js + repository: + id: 167174 + node_id: MDEwOlJlcG9zaXRvcnkxNjcxNzQ= + name: jquery + full_name: jquery/jquery + owner: + login: jquery + id: 70142 + node_id: MDQ6VXNlcjcwMTQy + avatar_url: https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png + gravatar_id: '' + url: https://api.github.com/users/jquery + html_url: https://github.com/jquery + followers_url: https://api.github.com/users/jquery/followers + following_url: https://api.github.com/users/jquery/following{/other_user} + gists_url: https://api.github.com/users/jquery/gists{/gist_id} + starred_url: https://api.github.com/users/jquery/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/jquery/subscriptions + organizations_url: https://api.github.com/users/jquery/orgs + repos_url: https://api.github.com/users/jquery/repos + events_url: https://api.github.com/users/jquery/events{/privacy} + received_events_url: https://api.github.com/users/jquery/received_events + type: Organization + site_admin: false + private: false + html_url: https://github.com/jquery/jquery + description: jQuery JavaScript Library + fork: false + url: https://api.github.com/repos/jquery/jquery + forks_url: https://api.github.com/repos/jquery/jquery/forks + keys_url: https://api.github.com/repos/jquery/jquery/keys{/key_id} + collaborators_url: https://api.github.com/repos/jquery/jquery/collaborators{/collaborator} + teams_url: https://api.github.com/repos/jquery/jquery/teams + hooks_url: https://api.github.com/repos/jquery/jquery/hooks + issue_events_url: https://api.github.com/repos/jquery/jquery/issues/events{/number} + events_url: https://api.github.com/repos/jquery/jquery/events + assignees_url: https://api.github.com/repos/jquery/jquery/assignees{/user} + branches_url: https://api.github.com/repos/jquery/jquery/branches{/branch} + tags_url: https://api.github.com/repos/jquery/jquery/tags + blobs_url: https://api.github.com/repos/jquery/jquery/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/jquery/jquery/git/tags{/sha} + git_refs_url: https://api.github.com/repos/jquery/jquery/git/refs{/sha} + trees_url: https://api.github.com/repos/jquery/jquery/git/trees{/sha} + statuses_url: https://api.github.com/repos/jquery/jquery/statuses/{sha} + languages_url: https://api.github.com/repos/jquery/jquery/languages + stargazers_url: https://api.github.com/repos/jquery/jquery/stargazers + contributors_url: https://api.github.com/repos/jquery/jquery/contributors + subscribers_url: https://api.github.com/repos/jquery/jquery/subscribers + subscription_url: https://api.github.com/repos/jquery/jquery/subscription + commits_url: https://api.github.com/repos/jquery/jquery/commits{/sha} + git_commits_url: https://api.github.com/repos/jquery/jquery/git/commits{/sha} + comments_url: https://api.github.com/repos/jquery/jquery/comments{/number} + issue_comment_url: https://api.github.com/repos/jquery/jquery/issues/comments/{number} + contents_url: https://api.github.com/repos/jquery/jquery/contents/{+path} + compare_url: https://api.github.com/repos/jquery/jquery/compare/{base}...{head} + merges_url: https://api.github.com/repos/jquery/jquery/merges + archive_url: https://api.github.com/repos/jquery/jquery/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/jquery/jquery/downloads + issues_url: https://api.github.com/repos/jquery/jquery/issues{/number} + pulls_url: https://api.github.com/repos/jquery/jquery/pulls{/number} + milestones_url: https://api.github.com/repos/jquery/jquery/milestones{/number} + notifications_url: https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/jquery/jquery/labels{/name} + deployments_url: http://api.github.com/repos/octocat/Hello-World/deployments + releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} + score: 1 + commit-search-result-item-paginated: + value: + total_count: 1 + incomplete_results: false + items: + - url: https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + sha: bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + html_url: https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + comments_url: https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments + commit: + url: https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f + author: + date: '2014-02-04T14:38:36-08:00' + name: The Octocat + email: octocat@nowhere.com + committer: + date: '2014-02-12T15:18:55-08:00' + name: The Octocat + email: octocat@nowhere.com + message: Create styles.css and updated README + tree: + url: https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68 + sha: a639e96f9038797fba6e0469f94a4b0cc459fa68 + comment_count: 8 + author: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=3 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + committer: {} + parents: + - url: https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4 + html_url: https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4 + sha: a30c19e3f13765a3b48829788bc1cb8b4e95cee4 + repository: + id: 1300192 + node_id: MDEwOlJlcG9zaXRvcnkxMzAwMTky + name: Spoon-Knife + full_name: octocat/Spoon-Knife + owner: + login: octocat + id: 583231 + node_id: MDQ6VXNlcjU4MzIzMQ== + avatar_url: https://avatars.githubusercontent.com/u/583231?v=3 + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Spoon-Knife + description: This repo is for demonstration purposes only. + fork: false + url: https://api.github.com/repos/octocat/Spoon-Knife + forks_url: https://api.github.com/repos/octocat/Spoon-Knife/forks + keys_url: https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id} + collaborators_url: https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator} + teams_url: https://api.github.com/repos/octocat/Spoon-Knife/teams + hooks_url: https://api.github.com/repos/octocat/Spoon-Knife/hooks + issue_events_url: https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number} + events_url: https://api.github.com/repos/octocat/Spoon-Knife/events + assignees_url: https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user} + branches_url: https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch} + tags_url: https://api.github.com/repos/octocat/Spoon-Knife/tags + blobs_url: https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha} + git_refs_url: https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha} + trees_url: https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha} + statuses_url: https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha} + languages_url: https://api.github.com/repos/octocat/Spoon-Knife/languages + stargazers_url: https://api.github.com/repos/octocat/Spoon-Knife/stargazers + contributors_url: https://api.github.com/repos/octocat/Spoon-Knife/contributors + subscribers_url: https://api.github.com/repos/octocat/Spoon-Knife/subscribers + subscription_url: https://api.github.com/repos/octocat/Spoon-Knife/subscription + commits_url: https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha} + git_commits_url: https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha} + comments_url: https://api.github.com/repos/octocat/Spoon-Knife/comments{/number} + issue_comment_url: https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number} + contents_url: https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path} + compare_url: https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head} + merges_url: https://api.github.com/repos/octocat/Spoon-Knife/merges + archive_url: https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/octocat/Spoon-Knife/downloads + issues_url: https://api.github.com/repos/octocat/Spoon-Knife/issues{/number} + pulls_url: https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number} + milestones_url: https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/octocat/Spoon-Knife/labels{/name} + releases_url: https://api.github.com/repos/octocat/Spoon-Knife/releases{/id} + deployments_url: https://api.github.com/repos/octocat/Spoon-Knife/deployments + score: 1 + node_id: MDQ6VXNlcjU4MzIzMQ== + issue-search-result-item-paginated: + summary: Hybrid search response + value: + total_count: 280 + incomplete_results: false + search_type: hybrid + items: + - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 + repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit + labels_url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name} + comments_url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments + events_url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events + html_url: https://github.com/batterseapower/pinyin-toolkit/issues/132 + id: 35802 + node_id: MDU6SXNzdWUzNTgwMg== + number: 132 + title: Line Number Indexes Beyond 20 Not Displayed + user: + login: Nick3C + id: 90254 + node_id: MDQ6VXNlcjkwMjU0 + avatar_url: https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png + gravatar_id: '' + url: https://api.github.com/users/Nick3C + html_url: https://github.com/Nick3C + followers_url: https://api.github.com/users/Nick3C/followers + following_url: https://api.github.com/users/Nick3C/following{/other_user} + gists_url: https://api.github.com/users/Nick3C/gists{/gist_id} + starred_url: https://api.github.com/users/Nick3C/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/Nick3C/subscriptions + organizations_url: https://api.github.com/users/Nick3C/orgs + repos_url: https://api.github.com/users/Nick3C/repos + events_url: https://api.github.com/users/Nick3C/events{/privacy} + received_events_url: https://api.github.com/users/Nick3C/received_events + type: User + site_admin: true + labels: + - id: 4 + node_id: MDU6TGFiZWw0 + url: https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug + name: bug + color: ff0000 + state: open + assignee: null + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + comments: 15 + created_at: '2009-07-12T20:10:41Z' + updated_at: '2009-07-19T09:23:43Z' + closed_at: null + pull_request: + url: https://api/github.com/repos/octocat/Hello-World/pull/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + body: ... + score: 1 + locked: true + author_association: COLLABORATOR + state_reason: completed + issue-search-result-item-paginated-lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, the response includes search_type set to "lexical" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - ... + label-search-result-item-paginated: + value: + total_count: 2 + incomplete_results: false + items: + - id: 418327088 + node_id: MDU6TGFiZWw0MTgzMjcwODg= + url: https://api.github.com/repos/octocat/linguist/labels/enhancement + name: enhancement + color: 84b6eb + default: true + description: New feature or request. + score: 1 + - id: 418327086 + node_id: MDU6TGFiZWw0MTgzMjcwODY= + url: https://api.github.com/repos/octocat/linguist/labels/bug + name: bug + color: ee0701 + default: true + description: Something isn't working. + score: 1 + repo-search-result-item-paginated: + value: + total_count: 40 + incomplete_results: false + items: + - id: 3081286 + node_id: MDEwOlJlcG9zaXRvcnkzMDgxMjg2 + name: Tetris + full_name: dtrupenn/Tetris + owner: + login: dtrupenn + id: 872147 + node_id: MDQ6VXNlcjg3MjE0Nw== + avatar_url: https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png + gravatar_id: '' + url: https://api.github.com/users/dtrupenn + received_events_url: https://api.github.com/users/dtrupenn/received_events + type: User + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + site_admin: true + private: false + html_url: https://github.com/dtrupenn/Tetris + description: A C implementation of Tetris using Pennsim through LC4 + fork: false + url: https://api.github.com/repos/dtrupenn/Tetris + created_at: '2012-01-01T00:31:50Z' + updated_at: '2013-01-05T17:58:47Z' + pushed_at: '2012-01-01T00:37:02Z' + homepage: https://github.com + size: 524 + stargazers_count: 1 + watchers_count: 1 + language: Assembly + forks_count: 0 + open_issues_count: 0 + master_branch: master + default_branch: master + score: 1 + archive_url: https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/dtrupenn/Tetris/assignees{/user} + blobs_url: https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha} + branches_url: https://api.github.com/repos/dtrupenn/Tetris/branches{/branch} + collaborators_url: https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator} + comments_url: https://api.github.com/repos/dtrupenn/Tetris/comments{/number} + commits_url: https://api.github.com/repos/dtrupenn/Tetris/commits{/sha} + compare_url: https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head} + contents_url: https://api.github.com/repos/dtrupenn/Tetris/contents/{+path} + contributors_url: https://api.github.com/repos/dtrupenn/Tetris/contributors + deployments_url: https://api.github.com/repos/dtrupenn/Tetris/deployments + downloads_url: https://api.github.com/repos/dtrupenn/Tetris/downloads + events_url: https://api.github.com/repos/dtrupenn/Tetris/events + forks_url: https://api.github.com/repos/dtrupenn/Tetris/forks + git_commits_url: https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha} + git_refs_url: https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha} + git_tags_url: https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha} + git_url: git:github.com/dtrupenn/Tetris.git + issue_comment_url: https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number} + issue_events_url: https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number} + issues_url: https://api.github.com/repos/dtrupenn/Tetris/issues{/number} + keys_url: https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id} + labels_url: https://api.github.com/repos/dtrupenn/Tetris/labels{/name} + languages_url: https://api.github.com/repos/dtrupenn/Tetris/languages + merges_url: https://api.github.com/repos/dtrupenn/Tetris/merges + milestones_url: https://api.github.com/repos/dtrupenn/Tetris/milestones{/number} + notifications_url: https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/dtrupenn/Tetris/pulls{/number} + releases_url: https://api.github.com/repos/dtrupenn/Tetris/releases{/id} + ssh_url: git@github.com:dtrupenn/Tetris.git + stargazers_url: https://api.github.com/repos/dtrupenn/Tetris/stargazers + statuses_url: https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha} + subscribers_url: https://api.github.com/repos/dtrupenn/Tetris/subscribers + subscription_url: https://api.github.com/repos/dtrupenn/Tetris/subscription + tags_url: https://api.github.com/repos/dtrupenn/Tetris/tags + teams_url: https://api.github.com/repos/dtrupenn/Tetris/teams + trees_url: https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha} + clone_url: https://github.com/dtrupenn/Tetris.git + mirror_url: git:git.example.com/dtrupenn/Tetris + hooks_url: https://api.github.com/repos/dtrupenn/Tetris/hooks + svn_url: https://svn.github.com/dtrupenn/Tetris + forks: 1 + open_issues: 1 + watchers: 1 + has_issues: true + has_projects: true + has_pages: true + has_wiki: true + has_downloads: true + archived: true + disabled: true + visibility: private + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topic-search-result-item-paginated: + value: + total_count: 6 + incomplete_results: false + items: + - name: ruby + display_name: Ruby + short_description: Ruby is a scripting language designed for simplified object-oriented programming. + description: "Ruby was developed by\_Yukihiro \"Matz\" Matsumoto\_in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python." + created_by: Yukihiro Matsumoto + released: December 21, 1995 + created_at: '2016-11-28T22:03:59Z' + updated_at: '2017-10-30T18:16:32Z' + featured: true + curated: true + score: 1 + - name: rails + display_name: Rails + short_description: Ruby on Rails (Rails) is a web application framework written in Ruby. + description: Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites. + created_by: David Heinemeier Hansson + released: December 13 2005 + created_at: '2016-12-09T17:03:50Z' + updated_at: '2017-10-30T16:20:19Z' + featured: true + curated: true + score: 1 + - name: python + display_name: Python + short_description: Python is a dynamically typed programming language. + description: Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research. + created_by: Guido van Rossum + released: February 20, 1991 + created_at: '2016-12-07T00:07:02Z' + updated_at: '2017-10-27T22:45:43Z' + featured: true + curated: true + score: 1 + - name: jekyll + display_name: Jekyll + short_description: Jekyll is a simple, blog-aware static site generator. + description: Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website. + created_by: Tom Preston-Werner + released: '2008' + created_at: '2016-12-16T21:53:08Z' + updated_at: '2017-10-27T19:00:24Z' + featured: true + curated: true + score: 1 + - name: sass + display_name: Sass + short_description: Sass is a stable extension to classic CSS. + description: Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax. + created_by: Hampton Catlin, Natalie Weizenbaum, Chris Eppstein + released: November 28, 2006 + created_at: '2016-12-16T21:53:45Z' + updated_at: '2018-01-16T16:30:40Z' + featured: true + curated: true + score: 1 + - name: homebrew + display_name: Homebrew + short_description: Homebrew is a package manager for macOS. + description: Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community. + created_by: Max Howell + released: '2009' + created_at: '2016-12-17T20:30:44Z' + updated_at: '2018-02-06T16:14:56Z' + featured: true + curated: true + score: 1 + user-search-result-item-paginated: + value: + total_count: 12 + incomplete_results: false + items: + - login: mojombo + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png + gravatar_id: '' + url: https://api.github.com/users/mojombo + html_url: https://github.com/mojombo + followers_url: https://api.github.com/users/mojombo/followers + subscriptions_url: https://api.github.com/users/mojombo/subscriptions + organizations_url: https://api.github.com/users/mojombo/orgs + repos_url: https://api.github.com/users/mojombo/repos + received_events_url: https://api.github.com/users/mojombo/received_events + type: User + score: 1 + following_url: https://api.github.com/users/mojombo/following{/other_user} + gists_url: https://api.github.com/users/mojombo/gists{/gist_id} + starred_url: https://api.github.com/users/mojombo/starred{/owner}{/repo} + events_url: https://api.github.com/users/mojombo/events{/privacy} + site_admin: true +servers: + - url: https://api.github.com diff --git a/provider-dev/source/secret_scanning.yaml b/provider-dev/source/secret_scanning.yaml new file mode 100644 index 0000000..7b6fb35 --- /dev/null +++ b/provider-dev/source/secret_scanning.yaml @@ -0,0 +1,2734 @@ +openapi: 3.0.3 +info: + title: secret_scanning API + description: github API + version: 1.1.4 +paths: + /orgs/{org}/secret-scanning/alerts: + get: + summary: List secret scanning alerts for an organization + description: |- + Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/secret-scanning-alert-state' + - $ref: '#/components/parameters/secret-scanning-alert-secret-type' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-secret-types' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-providers' + - $ref: '#/components/parameters/secret-scanning-alert-providers' + - $ref: '#/components/parameters/secret-scanning-alert-resolution' + - $ref: '#/components/parameters/secret-scanning-alert-assignee' + - $ref: '#/components/parameters/secret-scanning-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/secret-scanning-pagination-before-org-repo' + - $ref: '#/components/parameters/secret-scanning-pagination-after-org-repo' + - $ref: '#/components/parameters/secret-scanning-alert-validity' + - $ref: '#/components/parameters/secret-scanning-alert-publicly-leaked' + - $ref: '#/components/parameters/secret-scanning-alert-multi-repo' + - $ref: '#/components/parameters/secret-scanning-alert-hide-secret' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/organization-secret-scanning-alert-list' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /orgs/{org}/secret-scanning/pattern-configurations: + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - $ref: '#/components/parameters/org' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-pattern-configuration' + examples: + default: + $ref: '#/components/examples/secret-scanning-pattern-configuration' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-stackQL-resource: push_protection + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + $ref: '#/components/schemas/secret-scanning-row-version' + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + $ref: '#/components/schemas/secret-scanning-row-version' + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '409': + $ref: '#/components/responses/conflict' + '422': + $ref: '#/components/responses/validation_failed' + x-stackQL-resource: push_protection + /repos/{owner}/{repo}/secret-scanning/alerts: + get: + summary: List secret scanning alerts for a repository + description: |- + Lists secret scanning alerts for an eligible repository, from newest to oldest. + + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/secret-scanning-alert-state' + - $ref: '#/components/parameters/secret-scanning-alert-secret-type' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-secret-types' + - $ref: '#/components/parameters/secret-scanning-alert-exclude-providers' + - $ref: '#/components/parameters/secret-scanning-alert-providers' + - $ref: '#/components/parameters/secret-scanning-alert-resolution' + - $ref: '#/components/parameters/secret-scanning-alert-assignee' + - $ref: '#/components/parameters/secret-scanning-alert-sort' + - $ref: '#/components/parameters/direction' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/secret-scanning-pagination-before-org-repo' + - $ref: '#/components/parameters/secret-scanning-pagination-after-org-repo' + - $ref: '#/components/parameters/secret-scanning-alert-validity' + - $ref: '#/components/parameters/secret-scanning-alert-publicly-leaked' + - $ref: '#/components/parameters/secret-scanning-alert-multi-repo' + - $ref: '#/components/parameters/secret-scanning-alert-hide-secret' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/secret-scanning-alert-list' + '404': + description: Repository is public or secret scanning is disabled for the repository + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}: + get: + summary: Get a secret scanning alert + description: |- + Gets a single secret scanning alert detected in an eligible repository. + + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/get-alert + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + - $ref: '#/components/parameters/secret-scanning-alert-hide-secret' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/secret-scanning-alert-open' + '304': + $ref: '#/components/responses/not_modified' + '404': + description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + patch: + summary: Update a secret scanning alert + description: |- + Updates the status of a secret scanning alert in an eligible repository. + + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + operationId: secret-scanning/update-alert + tags: + - secret-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + state: + $ref: '#/components/schemas/secret-scanning-alert-state' + resolution: + $ref: '#/components/schemas/secret-scanning-alert-resolution' + resolution_comment: + $ref: '#/components/schemas/secret-scanning-alert-resolution-comment' + assignee: + $ref: '#/components/schemas/secret-scanning-alert-assignee' + required: + - state + - assignee + - validity + examples: + default: + value: + state: resolved + resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: null + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-alert' + examples: + default: + $ref: '#/components/examples/secret-scanning-alert-resolved' + '400': + description: Bad request, resolution comment is invalid or the resolution was not changed. + '404': + description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found + '422': + description: State does not match the resolution or resolution comment, or assignee does not have write access to the repository + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations: + get: + summary: List locations for a secret scanning alert + description: |- + Lists all locations for a given secret scanning alert for an eligible repository. + + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/list-locations-for-alert + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/alert-number' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + description: List of locations where the secret was detected + items: + $ref: '#/components/schemas/secret-scanning-location' + examples: + default: + $ref: '#/components/examples/secret-scanning-location-list' + headers: + Link: + $ref: '#/components/headers/link' + '404': + description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/push-protection-bypasses: + post: + summary: Create a push protection bypass + description: |- + Creates a bypass for a previously push protected secret. + + The authenticated user must be the original author of the committed secret. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: secret-scanning/create-push-protection-bypass + tags: + - secret-scanning + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + reason: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-reason' + placeholder_id: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-placeholder-id' + required: + - reason + - placeholder_id + examples: + default: + value: + reason: will_fix_later + placeholder_id: 2k4dM4tseyC5lPIsjl5emX9sPNk + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass' + examples: + default: + $ref: '#/components/examples/secret-scanning-push-protection-bypass' + '403': + description: User does not have enough permissions to perform this action. + '404': + description: Placeholder ID not found, or push protection is disabled on this repository. + '422': + description: Bad request, input data missing or incorrect. + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning + /repos/{owner}/{repo}/secret-scanning/scan-history: + get: + summary: Get secret scanning scan history for a repository + description: |- + Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + tags: + - secret-scanning + operationId: secret-scanning/get-scan-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/secret-scanning-scan-history' + examples: + default: + $ref: '#/components/examples/secret-scanning-scan-history' + '404': + description: Repository does not have GitHub Advanced Security or secret scanning enabled + '503': + $ref: '#/components/responses/service_unavailable' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: secret-scanning + x-stackQL-resource: secret_scanning +components: + schemas: + organization-secret-scanning-alert: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/nullable-alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + $ref: '#/components/schemas/secret-scanning-alert-state' + resolution: + $ref: '#/components/schemas/secret-scanning-alert-resolution' + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + $ref: '#/components/schemas/nullable-simple-user' + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: string + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + description: The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters. + nullable: true + secret: + type: string + description: The secret that was detected. + repository: + $ref: '#/components/schemas/simple-repository' + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 encoded + nullable: true + first_location_detected: + $ref: '#/components/schemas/nullable-secret-scanning-first-detected-location' + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the alert was detected in more than one location. + assigned_to: + $ref: '#/components/schemas/nullable-simple-user' + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings related to push protection. + type: object + properties: + pattern_config_version: + $ref: '#/components/schemas/secret-scanning-row-version' + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + $ref: '#/components/schemas/secret-scanning-pattern-override' + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + $ref: '#/components/schemas/secret-scanning-pattern-override' + secret-scanning-row-version: + type: string + description: The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. + nullable: true + secret-scanning-alert: + type: object + properties: + number: + $ref: '#/components/schemas/alert-number' + created_at: + $ref: '#/components/schemas/alert-created-at' + updated_at: + $ref: '#/components/schemas/nullable-alert-updated-at' + url: + $ref: '#/components/schemas/alert-url' + html_url: + $ref: '#/components/schemas/alert-html-url' + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + $ref: '#/components/schemas/secret-scanning-alert-state' + resolution: + $ref: '#/components/schemas/secret-scanning-alert-resolution' + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + $ref: '#/components/schemas/nullable-simple-user' + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + provider: + type: string + description: The provider of the secret that was detected. + nullable: true + provider_slug: + type: string + description: The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters. + nullable: true + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + publicly_leaked: + type: boolean + description: Whether the detected secret was publicly leaked. + nullable: true + multi_repo: + type: boolean + description: Whether the detected secret was found in multiple repositories under the same organization or enterprise. + nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 encoded + nullable: true + first_location_detected: + $ref: '#/components/schemas/nullable-secret-scanning-first-detected-location' + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the alert was detected in more than one location. + assigned_to: + $ref: '#/components/schemas/nullable-simple-user' + closure_request_comment: + type: string + description: An optional comment from the closure request author. + nullable: true + closure_request_reviewer_comment: + type: string + description: An optional comment from the closure request reviewer. + nullable: true + closure_request_reviewer: + $ref: '#/components/schemas/nullable-simple-user' + secret-scanning-alert-state: + description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + type: string + enum: + - open + - resolved + secret-scanning-alert-resolution: + type: string + description: '**Required when the `state` is `resolved`.** The reason for resolving the alert.' + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + secret-scanning-alert-resolution-comment: + description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. + type: string + nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` to unassign the alert. + type: string + nullable: true + secret-scanning-location: + type: object + properties: + type: + type: string + enum: + - commit + - wiki_commit + - issue_title + - issue_body + - issue_comment + - discussion_title + - discussion_body + - discussion_comment + - pull_request_title + - pull_request_body + - pull_request_comment + - pull_request_review + - pull_request_review_comment + description: The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. + example: commit + details: + description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: /example/secrets.txt + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - page_url + - issue_title_url + - issue_body_url + - issue_comment_url + - discussion_title_url + - discussion_body_url + - discussion_comment_url + - pull_request_title_url + - pull_request_body_url + - pull_request_comment_url + - pull_request_review_url + - pull_request_review_comment_url + secret-scanning-push-protection-bypass-reason: + description: The reason for bypassing push protection. + type: string + enum: + - false_positive + - used_in_tests + - will_fix_later + secret-scanning-push-protection-bypass-placeholder-id: + description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. + type: string + secret-scanning-push-protection-bypass: + type: object + properties: + reason: + $ref: '#/components/schemas/secret-scanning-push-protection-bypass-reason' + expire_at: + type: string + format: date-time + description: 'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + token_type: + type: string + description: The token type this bypass is for. + secret-scanning-scan-history: + type: object + properties: + incremental_scans: + type: array + items: + $ref: '#/components/schemas/secret-scanning-scan' + pattern_update_scans: + type: array + items: + $ref: '#/components/schemas/secret-scanning-scan' + backfill_scans: + type: array + items: + $ref: '#/components/schemas/secret-scanning-scan' + custom_pattern_backfill_scans: + type: array + items: + description: Information on a single scan performed by secret scanning on the repository + type: object + properties: + type: + type: string + description: The type of scan + status: + type: string + description: The state of the scan. Either "completed", "running", or "pending" + completed_at: + type: string + format: date-time + description: The time that the scan was completed. Empty if the scan is running + nullable: true + started_at: + type: string + format: date-time + description: The time that the scan was started. Empty if the scan is pending + nullable: true + pattern_name: + type: string + description: Name of the custom pattern for custom pattern scans + pattern_scope: + type: string + description: Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" + alert-number: + type: integer + description: The security alert number. + readOnly: true + alert-created-at: + type: string + description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable-alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + alert-url: + type: string + description: The REST API URL of the alert resource. + format: uri + readOnly: true + alert-html-url: + type: string + description: The GitHub URL of the alert resource. + format: uri + readOnly: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + nullable-secret-scanning-first-detected-location: + description: | + Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. + nullable: true + type: object + properties: + path: + type: string + description: The file path in the repository + example: /example/secrets.txt + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + - page_url + - issue_title_url + - issue_body_url + - issue_comment_url + - discussion_title_url + - discussion_body_url + - discussion_comment_url + - pull_request_title_url + - pull_request_body_url + - pull_request_comment_url + - pull_request_review_url + - pull_request_review_comment_url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern represents, rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + enum: + - not-set + - disabled + - enabled + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: /example/secrets.txt + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + html_url: + type: string + format: uri + description: The GitHub URL to get the associated commit resource. + example: https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: /example/Home.md + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + example: https://github.com/octocat/Hello-World/issues/1 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + html_url: + type: string + format: uri + description: The GitHub URL for the issue where the secret was detected. + example: https://github.com/octocat/Hello-World/issues/1 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the issue comment where the secret was detected. + example: https://github.com/octocat/Hello-World/issues/1#issuecomment-1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request comment where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846#issuecomment-1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + html_url: + type: string + format: uri + description: The GitHub URL for the pull request review comment where the secret was detected. + example: https://github.com/octocat/Hello-World/pull/2846#discussion_r12 + required: + - pull_request_review_comment_url + secret-scanning-scan: + description: Information on a single scan performed by secret scanning on the repository + type: object + properties: + type: + type: string + description: The type of scan + status: + type: string + description: The state of the scan. Either "completed", "running", or "pending" + completed_at: + type: string + format: date-time + description: The time that the scan was completed. Empty if the scan is running + nullable: true + started_at: + type: string + format: date-time + description: The time that the scan was started. Empty if the scan is pending + nullable: true + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + responses: + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + service_unavailable: + description: Service unavailable + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_modified: + description: Not modified + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + secret-scanning-alert-state: + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + secret-scanning-alert-secret-type: + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-exclude-secret-types: + name: exclude_secret_types + in: query + description: A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-exclude-providers: + name: exclude_providers + in: query + description: |- + A comma-separated list of provider slugs to exclude from the results. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-providers: + name: providers + in: query + description: |- + A comma-separated list of provider slugs to filter by. + Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). + You can find the provider slug in the `provider_slug` field of each alert. + Cannot be combined with the `exclude_providers` parameter. + required: false + schema: + type: string + secret-scanning-alert-resolution: + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: '*' + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + secret-scanning-alert-sort: + name: sort + description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + secret-scanning-pagination-before-org-repo: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. + in: query + required: false + schema: + type: string + secret-scanning-pagination-after-org-repo: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. + in: query + required: false + schema: + type: string + secret-scanning-alert-validity: + name: validity + in: query + description: A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. + required: false + schema: + type: string + secret-scanning-alert-publicly-leaked: + name: is_publicly_leaked + in: query + description: A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-multi-repo: + name: is_multi_repo + in: query + description: A boolean value representing whether or not to filter alerts by the multi-repo tag being present. + required: false + schema: + type: boolean + default: false + secret-scanning-alert-hide-secret: + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets in the results. + required: false + schema: + type: boolean + default: false + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + alert-number: + name: alert_number + in: path + description: The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. + required: true + schema: + $ref: '#/components/schemas/alert-number' + examples: + organization-secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: /example/secrets.txt + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled + secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: inactive + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: /example/secrets.txt + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + secret-scanning-alert-open: + value: + number: 42 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 + html_url: https://github.com/owner/private-repo/security/secret-scanning/42 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations + state: open + resolution: null + resolved_at: null + resolved_by: null + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed_by: null + push_protection_bypassed: false + push_protection_bypassed_at: null + push_protection_bypass_request_reviewer: null + push_protection_bypass_request_reviewer_comment: null + push_protection_bypass_request_comment: null + push_protection_bypass_request_html_url: null + resolution_comment: null + validity: unknown + publicly_leaked: false + multi_repo: false + secret-scanning-alert-resolved: + value: + number: 42 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42 + html_url: https://github.com/owner/private-repo/security/secret-scanning/42 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations + state: resolved + resolution: used_in_tests + resolved_at: '2020-11-16T22:42:07Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed: false + push_protection_bypassed_by: null + push_protection_bypassed_at: null + push_protection_bypass_request_reviewer: null + push_protection_bypass_request_reviewer_comment: null + push_protection_bypass_request_comment: null + push_protection_bypass_request_html_url: null + resolution_comment: Example comment + validity: unknown + publicly_leaked: false + multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + secret-scanning-location-list: + value: + - type: commit + details: + path: /example/secrets.txt + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + - type: wiki_commit + details: + path: /example/Home.md + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + - type: issue_title + details: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + - type: issue_body + details: + issue_body_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + - type: issue_comment + details: + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + - type: discussion_title + details: + discussion_title_url: https://github.com/community/community/discussions/39082 + - type: discussion_body + details: + discussion_body_url: https://github.com/community/community/discussions/39082#discussion-4566270 + - type: discussion_comment + details: + discussion_comment_url: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + - type: pull_request_title + details: + pull_request_title_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + - type: pull_request_body + details: + pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + - type: pull_request_comment + details: + pull_request_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898 + - type: pull_request_review + details: + pull_request_review_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + - type: pull_request_review_comment + details: + pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + secret-scanning-push-protection-bypass: + value: + reason: will_fix_later + expire_at: '2020-11-06T18:18:30Z' + token_type: mailchimp_api_key + secret-scanning-scan-history: + value: + incremental_scans: + - type: git + status: completed + completed_at: '2024-10-07T02:47:00Z' + backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:50:00Z' + - type: issue + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:49:00Z' + - type: discussion + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:48:00Z' + pattern_update_scans: + - type: discussion + status: in_progress + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:51:00Z' + custom_pattern_backfill_scans: + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: enterprise + - type: git + status: completed + started_at: '2024-10-07T02:47:00Z' + completed_at: '2024-10-07T02:55:00Z' + pattern_slug: my-custom-pattern + pattern_scope: organization + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/security_advisories.yaml b/provider-dev/source/security_advisories.yaml new file mode 100644 index 0000000..cff617e --- /dev/null +++ b/provider-dev/source/security_advisories.yaml @@ -0,0 +1,6030 @@ +openapi: 3.0.3 +info: + title: security_advisories API + description: github API + version: 1.1.4 +paths: + /advisories: + get: + summary: List global security advisories + description: |- + Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + + By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + tags: + - security-advisories + operationId: security-advisories/list-global-advisories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories + parameters: + - name: ghsa_id + in: query + description: If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. + schema: + type: string + - name: type + in: query + description: If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. + schema: + type: string + enum: + - reviewed + - malware + - unreviewed + default: reviewed + - name: cve_id + description: If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. + in: query + schema: + type: string + - name: ecosystem + in: query + description: If specified, only advisories for these ecosystems will be returned. + schema: + $ref: '#/components/schemas/security-advisory-ecosystems' + - name: severity + in: query + description: If specified, only advisories with these severities will be returned. + schema: + type: string + enum: + - unknown + - low + - medium + - high + - critical + - name: cwes + in: query + description: |- + If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + + Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + schema: + oneOf: + - type: string + - type: array + items: + type: string + - name: is_withdrawn + in: query + description: Whether to only return advisories that have been withdrawn. + schema: + type: boolean + - name: affects + in: query + description: |- + If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + + Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + schema: + oneOf: + - type: string + - type: array + maxItems: 1000 + items: + type: string + - name: published + in: query + description: |- + If specified, only return advisories that were published on a date or date range. + + For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + schema: + type: string + - name: updated + in: query + description: |- + If specified, only return advisories that were updated on a date or date range. + + For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + schema: + type: string + - name: modified + description: |- + If specified, only show advisories that were updated or published on a date or date range. + + For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + in: query + schema: + type: string + - name: epss_percentage + in: query + description: |- + If specified, only return advisories that have an EPSS percentage score that matches the provided value. + The EPSS percentage represents the likelihood of a CVE being exploited. + schema: + type: string + - name: epss_percentile + in: query + description: |- + If specified, only return advisories that have an EPSS percentile score that matches the provided value. + The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + schema: + type: string + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/direction' + - name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - updated + - published + - epss_percentage + - epss_percentile + default: published + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/global-advisory' + examples: + default: + $ref: '#/components/examples/global-advisory-items' + '422': + $ref: '#/components/responses/validation_failed_simple' + '429': + description: Too many requests + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: global-advisories + x-stackQL-resource: global_advisories + /advisories/{ghsa_id}: + get: + summary: Get a global security advisory + description: Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + tags: + - security-advisories + operationId: security-advisories/get-global-advisory + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory + parameters: + - $ref: '#/components/parameters/ghsa_id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/global-advisory' + examples: + default: + $ref: '#/components/examples/global-advisory' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: global-advisories + x-stackQL-resource: global_advisories + /orgs/{org}/security-advisories: + get: + summary: List repository security advisories for an organization + description: |- + Lists repository security advisories for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/list-org-repository-advisories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/direction' + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - published + default: created + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: per_page + description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: state + description: Filter by the state of the repository advisories. Only advisories of this state will be returned. + in: query + required: false + schema: + type: string + enum: + - triage + - draft + - published + - closed + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/list-repository-advisories' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories: + get: + summary: List repository security advisories + description: |- + Lists security advisories in a repository. + + The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + tags: + - security-advisories + operationId: security-advisories/list-repository-advisories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/direction' + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - published + default: created + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - name: per_page + description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: state + description: Filter by state of the repository advisories. Only advisories of this state will be returned. + in: query + required: false + schema: + type: string + enum: + - triage + - draft + - published + - closed + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/list-repository-advisories' + '400': + $ref: '#/components/responses/bad_request' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + post: + summary: Create a repository security advisory + description: |- + Creates a new repository security advisory. + + In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/create-repository-advisory + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory-create' + examples: + default: + value: + summary: A new important advisory + description: A more in-depth description of what the problem is. + severity: high + cve_id: null + vulnerabilities: + - package: + name: a-package + ecosystem: npm + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cwe_ids: + - CWE-1101 + - CWE-20 + credits: + - login: monalisa + type: reporter + - login: octocat + type: analyst + withVectorString: + value: + summary: A new important advisory + description: A more in-depth description of what the problem is. + cvss_vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:L + cve_id: null + vulnerabilities: + - package: + name: a-package + ecosystem: npm + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cwe_ids: + - CWE-1101 + - CWE-20 + credits: + - login: monalisa + type: reporter + - login: octocat + type: analyst + minimal: + value: + summary: A new important advisory + description: A more in-depth description of what the problem is. + vulnerabilities: + - package: + ecosystem: npm + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/reports: + post: + summary: Privately report a security vulnerability + description: |- + Report a security vulnerability to the maintainers of the repository. + See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. + tags: + - security-advisories + operationId: security-advisories/create-private-vulnerability-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/private-vulnerability-report-create' + examples: + default: + value: + summary: A newly discovered vulnerability + description: A more in-depth description of what the problem is. + severity: high + vulnerabilities: + - package: + name: a-package + ecosystem: npm + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cwe_ids: + - CWE-123 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory-pvr' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/{ghsa_id}: + get: + summary: Get a repository security advisory + description: |- + Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. + + Anyone can access any published security advisory on a public repository. + + The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a + collaborator on the security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + tags: + - security-advisories + operationId: security-advisories/get-repository-advisory + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + patch: + summary: Update a repository security advisory + description: |- + Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. + + In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, + or a collaborator on the repository security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/update-repository-advisory + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory-update' + examples: + default: + summary: Updating the severity and state. + value: + severity: critical + state: published + add_credit: + summary: To add a credit to an advisory, send the whole array of values. + value: + credits: + - login: monauser + type: remediation_developer + update_vvrs: + summary: To add vulnerable versions, include existing versions in the array. + value: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + invalid_state_transition: + summary: Example of an invalid state transition, from `published` to `draft`. + value: + state: draft + update_severity_with_cvss_set: + summary: Severity cannot be updated when the CVSS is already set. + value: + severity: low + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/repository-advisory' + examples: + default: + $ref: '#/components/examples/repository-advisory' + add_credit: + $ref: '#/components/examples/repository-advisory' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + examples: + invalid_state_transition: + value: + message: Invalid state transition from `published` to `draft`. + update_severity_with_cvss_set: + value: + message: Cannot update severity value when CVSS is set. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve: + post: + summary: Request a CVE for a repository security advisory + description: |- + If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + + You may request a CVE for public repositories, but cannot do so for private repositories. + + In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + tags: + - security-advisories + operationId: security-advisories/create-repository-advisory-cve-request + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + responses: + '202': + $ref: '#/components/responses/accepted' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories + /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks: + post: + summary: Create a temporary private fork + description: |- + Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + + > [!NOTE] + > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + tags: + - security-advisories + operationId: security-advisories/create-fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork + parameters: + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + - $ref: '#/components/parameters/ghsa_id' + responses: + '202': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/full-repository' + examples: + default: + $ref: '#/components/examples/full-repository' + '400': + $ref: '#/components/responses/bad_request' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories + x-stackQL-resource: repository_advisories +components: + schemas: + security-advisory-ecosystems: + type: string + description: The package's language or package management ecosystem. + enum: + - rubygems + - npm + - pip + - maven + - nuget + - composer + - go + - rust + - erlang + - actions + - pub + - other + - swift + global-advisory: + description: A GitHub Security Advisory. + type: object + properties: + ghsa_id: + type: string + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + readOnly: true + url: + type: string + description: The API URL for the advisory. + readOnly: true + html_url: + type: string + format: uri + description: The URL for the advisory. + readOnly: true + repository_advisory_url: + type: string + format: uri + description: The API URL for the repository advisory. + readOnly: true + nullable: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory entails. + maxLength: 65535 + nullable: true + type: + type: string + description: The type of advisory. + readOnly: true + enum: + - reviewed + - unreviewed + - malware + severity: + type: string + description: The severity of the advisory. + enum: + - critical + - high + - medium + - low + - unknown + source_code_location: + type: string + format: uri + description: The URL of the advisory's source code. + nullable: true + identifiers: + type: array + nullable: true + readOnly: true + items: + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + references: + type: array + nullable: true + items: + type: string + description: URLs with more information regarding the advisory. + published_at: + type: string + format: date-time + description: The date and time of when the advisory was published, in ISO 8601 format. + readOnly: true + updated_at: + type: string + format: date-time + description: The date and time of when the advisory was last updated, in ISO 8601 format. + readOnly: true + github_reviewed_at: + type: string + format: date-time + description: The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + readOnly: true + nullable: true + nvd_published_at: + type: string + format: date-time + description: |- + The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + This field is only populated when the advisory is imported from the National Vulnerability Database. + readOnly: true + nullable: true + withdrawn_at: + type: string + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO 8601 format. + readOnly: true + nullable: true + vulnerabilities: + type: array + description: The products and respective version ranges affected by the advisory. + nullable: true + items: + $ref: '#/components/schemas/vulnerability' + cvss: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS vector. + nullable: true + score: + type: number + description: The CVSS score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_severities: + $ref: '#/components/schemas/cvss-severities' + epss: + $ref: '#/components/schemas/security-advisory-epss' + cwes: + type: array + nullable: true + items: + type: object + properties: + cwe_id: + type: string + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + credits: + type: array + description: The users who contributed to the advisory. + nullable: true + readOnly: true + items: + type: object + properties: + user: + $ref: '#/components/schemas/simple-user' + type: + $ref: '#/components/schemas/security-advisory-credit-types' + required: + - user + - type + required: + - ghsa_id + - cve_id + - url + - html_url + - repository_advisory_url + - summary + - description + - type + - severity + - source_code_location + - identifiers + - references + - published_at + - updated_at + - github_reviewed_at + - nvd_published_at + - withdrawn_at + - vulnerabilities + - cvss + - cwes + - credits + additionalProperties: false + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + properties: + cvss: null + required: + - ghsa_id + - cve_id + - url + - html_url + - repository_advisory_url + - summary + - description + - type + - severity + - source_code_location + - identifiers + - references + - published_at + - updated_at + - github_reviewed_at + - nvd_published_at + - withdrawn_at + - vulnerabilities + - cwes + - credits + type: object + version: '2026-03-10' + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + repository-advisory: + description: A repository security advisory. + type: object + properties: + ghsa_id: + type: string + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + url: + type: string + format: uri + description: The API URL for the advisory. + readOnly: true + html_url: + type: string + format: uri + description: The URL for the advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory entails. + maxLength: 65535 + nullable: true + severity: + type: string + description: The severity of the advisory. + nullable: true + enum: + - critical + - high + - medium + - low + author: + readOnly: true + nullable: true + description: The author of the advisory. + title: Simple User + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + publisher: + readOnly: true + nullable: true + description: The publisher of the advisory. + title: Simple User + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + identifiers: + type: array + items: + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + readOnly: true + state: + type: string + description: The state of the advisory. + enum: + - published + - closed + - withdrawn + - draft + - triage + created_at: + type: string + format: date-time + description: The date and time of when the advisory was created, in ISO 8601 format. + readOnly: true + nullable: true + updated_at: + type: string + format: date-time + description: The date and time of when the advisory was last updated, in ISO 8601 format. + readOnly: true + nullable: true + published_at: + type: string + format: date-time + description: The date and time of when the advisory was published, in ISO 8601 format. + readOnly: true + nullable: true + closed_at: + type: string + format: date-time + description: The date and time of when the advisory was closed, in ISO 8601 format. + readOnly: true + nullable: true + withdrawn_at: + type: string + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO 8601 format. + readOnly: true + nullable: true + submission: + type: object + nullable: true + readOnly: true + properties: + accepted: + type: boolean + description: Whether a private vulnerability report was accepted by the repository's administrators. + readOnly: true + required: + - accepted + vulnerabilities: + type: array + nullable: true + items: + $ref: '#/components/schemas/repository-advisory-vulnerability' + cvss: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS vector. + nullable: true + score: + type: number + description: The CVSS score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_severities: + $ref: '#/components/schemas/cvss-severities' + cwes: + type: array + nullable: true + items: + type: object + properties: + cwe_id: + type: string + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + readOnly: true + cwe_ids: + type: array + description: A list of only the CWE IDs. + nullable: true + items: + type: string + credits: + type: array + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + $ref: '#/components/schemas/security-advisory-credit-types' + credits_detailed: + type: array + nullable: true + items: + $ref: '#/components/schemas/repository-advisory-credit' + readOnly: true + collaborating_users: + type: array + description: A list of users that collaborate on the advisory. + nullable: true + items: + $ref: '#/components/schemas/simple-user' + collaborating_teams: + type: array + description: A list of teams that collaborate on the advisory. + nullable: true + items: + $ref: '#/components/schemas/team' + private_fork: + readOnly: true + nullable: true + description: A temporary private fork of the advisory's repository for collaborating on a fix. + title: Simple Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + required: + - ghsa_id + - cve_id + - url + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state + - created_at + - updated_at + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cvss + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + additionalProperties: false + x-github-breaking-changes: + - changeset: deprecate_cvss + patch: + properties: + cvss: null + required: + - ghsa_id + - cve_id + - url + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state + - created_at + - updated_at + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + type: object + version: '2026-03-10' + repository-advisory-create: + type: object + properties: + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory impacts. + maxLength: 65535 + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + vulnerabilities: + type: array + description: A product affected by the vulnerability detailed in a repository security advisory. + items: + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + additionalProperties: false + cwe_ids: + type: array + description: A list of Common Weakness Enumeration (CWE) IDs. + nullable: true + items: + type: string + credits: + type: array + description: A list of users receiving credit for their participation in the security advisory. + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + $ref: '#/components/schemas/security-advisory-credit-types' + required: + - login + - type + additionalProperties: false + severity: + type: string + description: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. + nullable: true + enum: + - critical + - high + - medium + - low + cvss_vector_string: + type: string + description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + nullable: true + start_private_fork: + type: boolean + description: Whether to create a temporary private fork of the repository to collaborate on a fix. + default: false + required: + - summary + - description + - vulnerabilities + additionalProperties: false + private-vulnerability-report-create: + type: object + properties: + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory impacts. + maxLength: 65535 + vulnerabilities: + type: array + description: An array of products affected by the vulnerability detailed in a repository security advisory. + nullable: true + items: + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + additionalProperties: false + cwe_ids: + type: array + description: A list of Common Weakness Enumeration (CWE) IDs. + nullable: true + items: + type: string + severity: + type: string + description: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. + nullable: true + enum: + - critical + - high + - medium + - low + cvss_vector_string: + type: string + description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + nullable: true + start_private_fork: + type: boolean + description: Whether to create a temporary private fork of the repository to collaborate on a fix. + default: false + required: + - summary + - description + additionalProperties: false + repository-advisory-update: + type: object + properties: + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: string + description: A detailed description of what the advisory impacts. + maxLength: 65535 + cve_id: + type: string + description: The Common Vulnerabilities and Exposures (CVE) ID. + nullable: true + vulnerabilities: + type: array + description: A product affected by the vulnerability detailed in a repository security advisory. + items: + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + additionalProperties: false + cwe_ids: + type: array + description: A list of Common Weakness Enumeration (CWE) IDs. + nullable: true + items: + type: string + credits: + type: array + description: A list of users receiving credit for their participation in the security advisory. + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + $ref: '#/components/schemas/security-advisory-credit-types' + required: + - login + - type + additionalProperties: false + severity: + type: string + description: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. + nullable: true + enum: + - critical + - high + - medium + - low + cvss_vector_string: + type: string + description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + nullable: true + state: + type: string + description: The state of the advisory. + enum: + - published + - closed + - draft + collaborating_users: + type: array + description: A list of usernames who have been granted write access to the advisory. + nullable: true + items: + type: string + collaborating_teams: + type: array + description: A list of team slugs which have been granted write access to the advisory. + nullable: true + items: + type: string + additionalProperties: false + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + type: boolean + example: true + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + example: true + has_projects: + type: boolean + example: true + has_wiki: + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + type: boolean + example: true + has_discussions: + type: boolean + example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + example: public + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + $ref: '#/components/schemas/nullable-repository' + temp_clone_token: + type: string + nullable: true + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + example: PR_TITLE + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + example: PR_BODY + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_forking: + type: boolean + example: true + web_commit_signoff_required: + type: boolean + example: false + subscribers_count: + type: integer + example: 42 + network_count: + type: integer + example: 0 + license: + $ref: '#/components/schemas/nullable-license-simple' + organization: + $ref: '#/components/schemas/nullable-simple-user' + parent: + $ref: '#/components/schemas/repository' + source: + $ref: '#/components/schemas/repository' + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct-simple' + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + vulnerability: + description: A vulnerability describing the product and its affected versions within a GitHub Security Advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + first_patched_version: + type: string + description: The package version that resolves the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected by the vulnerability. + nullable: true + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions + cvss-severities: + type: object + nullable: true + properties: + cvss_v3: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 3 vector string. + nullable: true + score: + type: number + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: object + nullable: true + properties: + vector_string: + type: string + description: The CVSS 4 vector string. + nullable: true + score: + type: number + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + security-advisory-epss: + type: object + nullable: true + readOnly: true + description: The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). + properties: + percentage: + type: number + minimum: 0 + maximum: 100 + percentile: + type: number + minimum: 0 + maximum: 100 + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + security-advisory-credit-types: + type: string + description: The type of credit the user is receiving. + enum: + - analyst + - finder + - reporter + - coordinator + - remediation_developer + - remediation_reviewer + - remediation_verifier + - tool + - sponsor + - other + validation-error-simple: + title: Validation Error Simple + description: Validation Error Simple + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + repository-advisory-vulnerability: + description: A product affected by the vulnerability detailed in a repository security advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + $ref: '#/components/schemas/security-advisory-ecosystems' + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: + type: string + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + - vulnerable_version_range + - patched_versions + - vulnerable_functions + additionalProperties: false + repository-advisory-credit: + description: A credit given to a user for a repository security advisory. + type: object + properties: + user: + $ref: '#/components/schemas/simple-user' + type: + $ref: '#/components/schemas/security-advisory-credit-types' + state: + type: string + description: The state of the user's acceptance of the credit. + enum: + - accepted + - declined + - pending + required: + - user + - type + - state + additionalProperties: false + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + simple-repository: + title: Simple Repository + description: A GitHub repository. + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + description: A unique identifier of the repository. + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. + events_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events on the repository. + issues_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues on the repository. + keys_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy keys on the repository. + labels_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels of the repository. + languages_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + scim-error: + title: Scim Error + description: Scim Error + type: object + properties: + message: + type: string + nullable: true + documentation_url: + type: string + nullable: true + detail: + type: string + nullable: true + status: + type: integer + scimType: + type: string + nullable: true + schemas: + type: array + items: + type: string + nullable-repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable: true + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + format: int64 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + $ref: '#/components/schemas/simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_use_squash_pr_title_as_default + patch: + properties: + use_squash_pr_title_as_default: null + type: object + version: '2026-03-10' + - changeset: deprecate_beta_media_type + patch: + properties: + master_branch: null + type: object + version: '2026-03-10' + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + example: citizen_code_of_conduct + name: + type: string + example: Citizen Code of Conduct + html_url: + type: string + nullable: true + format: uri + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + responses: + validation_failed_simple: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error-simple' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + bad_request: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + application/scim+json: + schema: + $ref: '#/components/schemas/scim-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + accepted: + description: Accepted + content: + application/json: + schema: + type: string + description: (opaque JSON object) + examples: + default: + value: null + parameters: + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + ghsa_id: + name: ghsa_id + description: The GHSA (GitHub Security Advisory) identifier of the advisory. + in: path + required: true + schema: + type: string + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + examples: + global-advisory-items: + value: + - id: 1 + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/advisories/GHSA-abcd-1234-efgh + repository_advisory_url: https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh + summary: Heartbleed security advisory + description: This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information. + type: reviewed + severity: high + source_code_location: https://github.com/project/a-package + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + references: + - https://nvd.nist.gov/vuln/detail/CVE-2050-00000 + published_at: '2023-03-23T02:30:56Z' + updated_at: '2023-03-24T02:30:56Z' + github_reviewed_at: '2023-03-23T02:30:56Z' + nvd_published_at: '2023-03-25T02:30:56Z' + withdrawn_at: null + vulnerabilities: + - package: + ecosystem: npm + name: a-package + first_patched_version: 1.0.3 + vulnerable_version_range: <=1.0.2 + vulnerable_functions: + - a_function + cvss: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-400 + name: Uncontrolled Resource Consumption + epss: + percentage: 0.00045 + percentile: '0.16001e0' + credits: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + global-advisory: + value: + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/advisories/GHSA-abcd-1234-efgh + repository_advisory_url: https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + type: reviewed + severity: high + source_code_location: https://github.com/project/a-package + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + references: + - https://nvd.nist.gov/vuln/detail/CVE-2050-00000 + published_at: '2023-03-23T02:30:56Z' + updated_at: '2023-03-24T02:30:56Z' + github_reviewed_at: '2023-03-23T02:30:56Z' + nvd_published_at: '2023-03-25T02:30:56Z' + withdrawn_at: null + vulnerabilities: + - package: + ecosystem: npm + name: a-package + first_patched_version: 1.0.3 + vulnerable_version_range: <=1.0.2 + vulnerable_functions: + - a_function + cvss: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H + score: 7.6 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-400 + name: Uncontrolled Resource Consumption + credits: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + list-repository-advisories: + value: + - ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: critical + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + state: published + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: '2020-01-03T00:00:00Z' + closed_at: null + withdrawn_at: null + submission: null + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: analyst + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: null + - ghsa_id: GHSA-1234-5678-9012 + cve_id: CVE-2051-0000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 + html_url: https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012 + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: low + author: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + publisher: + login: monalisa + id: 3 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-1234-5678-9012 + - type: CVE + value: CVE-2051-00000 + state: published + created_at: '2020-01-03T00:00:00Z' + updated_at: '2020-01-04T00:00:00Z' + published_at: '2020-01-04T00:00:00Z' + closed_at: null + withdrawn_at: null + submission: + accepted: true + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N + score: 1.6 + cvss_v4: + vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 7.1 + cwes: + - cwe_id: CWE-456 + name: A CWE 2.0 + cwe_ids: + - CWE-456 + credits: + - login: monauser + type: reporter + credits_detailed: + - user: + login: monauser + id: 2 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monauser + html_url: https://github.com/monauser + followers_url: https://api.github.com/users/monauser/followers + following_url: https://api.github.com/users/monauser/following{/other_user} + gists_url: https://api.github.com/users/monauser/gists{/gist_id} + starred_url: https://api.github.com/users/monauser/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monauser/subscriptions + organizations_url: https://api.github.com/users/monauser/orgs + repos_url: https://api.github.com/users/monauser/repos + events_url: https://api.github.com/users/monauser/events{/privacy} + received_events_url: https://api.github.com/users/monauser/received_events + type: User + site_admin: false + type: reporter + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-1234-5678-9012 + full_name: octo-org/octo-repo-ghsa-1234-5678-9012 + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012 + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012 + archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events + forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription + tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags + teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams + trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha} + repository-advisory: + value: + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A short summary of the advisory. + description: A detailed description of what the advisory entails. + severity: critical + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: CVE-2050-00000 + state: published + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: '2020-01-03T00:00:00Z' + closed_at: null + withdrawn_at: null + submission: null + vulnerabilities: + - package: + ecosystem: pip + name: a-package + vulnerable_version_range: '>= 1.0.0, < 1.0.1' + patched_versions: 1.0.1 + vulnerable_functions: + - function1 + - package: + ecosystem: pip + name: another-package + vulnerable_version_range: '>= 1.0.0, < 1.0.2' + patched_versions: 1.0.2 + vulnerable_functions: + - function2 + cvss: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_severities: + cvss_v3: + vector_string: CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H + score: 9.8 + cvss_v4: + vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N + score: 9.3 + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: analyst + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: analyst + state: accepted + collaborating_users: + - login: octokitten + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-abcd-1234-efgh + full_name: octo-org/octo-repo-ghsa-abcd-1234-efgh + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh + description: null + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh + archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events + forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription + tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags + teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams + trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} + repository-advisory-pvr: + value: + ghsa_id: GHSA-abcd-1234-efgh + cve_id: CVE-2050-00000 + url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh + html_url: https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh + summary: A newly discovered vulnerability + description: A more in-depth description of what the problem is. + severity: high + author: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + publisher: null + identifiers: + - type: GHSA + value: GHSA-abcd-1234-efgh + - type: CVE + value: null + state: triage + created_at: '2020-01-01T00:00:00Z' + updated_at: '2020-01-02T00:00:00Z' + published_at: null + closed_at: null + withdrawn_at: null + submission: + accepted: false + vulnerabilities: + - package: + ecosystem: npm + name: a-package + vulnerable_version_range: < 1.0.0 + patched_versions: 1.0.0 + vulnerable_functions: + - important_function + cvss: null + cvss_severities: + cvss_v3: null + cvss_v4: null + cwes: + - cwe_id: CWE-123 + name: A CWE + cwe_ids: + - CWE-123 + credits: + - login: octocat + type: finder + credits_detailed: + - user: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + type: finder + state: accepted + collaborating_users: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + collaborating_teams: + - name: Justice League + id: 1 + node_id: MDQ6VGVhbTE= + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + permission: admin + parent: null + private_fork: null + full-repository: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit + language: null + forks_count: 9 + forks: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues_count: 0 + open_issues: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + pull: true + push: false + admin: false + allow_rebase_merge: true + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: null + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false + subscribers_count: 42 + network_count: 0 + organization: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: Organization + site_admin: false + parent: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 +servers: + - url: https://api.github.com diff --git a/provider-dev/source/teams.yaml b/provider-dev/source/teams.yaml new file mode 100644 index 0000000..3e031af --- /dev/null +++ b/provider-dev/source/teams.yaml @@ -0,0 +1,4060 @@ +openapi: 3.0.3 +info: + title: teams API + description: Interact with GitHub Teams. + version: 1.1.4 +paths: + /orgs/{org}/teams: + get: + summary: List teams + description: Lists all teams in an organization that are visible to the authenticated user. + tags: + - teams + operationId: teams/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-teams + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/team-type' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + default: + $ref: '#/components/examples/team-items' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + post: + summary: Create a team + description: |- + To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)." + + When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". + tags: + - teams + operationId: teams/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#create-a-team + parameters: + - $ref: '#/components/parameters/org' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: string + description: The description of the team. + maintainers: + type: array + description: List GitHub usernames for organization members who will become team maintainers. + items: + type: string + repo_names: + type: array + description: The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + items: + type: string + privacy: + type: string + description: |- + The level of privacy this team should have. The options are: + **For a non-nested team:** + * `secret` - only visible to organization owners and members of this team. + * `closed` - visible to all members of this organization. + Default: `secret` + **For a parent or child team:** + * `closed` - visible to all members of this organization. + Default for child team: `closed` + enum: + - secret + - closed + notification_setting: + type: string + description: |- + The notification setting the team has chosen. The options are: + * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * `notifications_disabled` - no one receives notifications. + Default: `notifications_enabled` + enum: + - notifications_enabled + - notifications_disabled + permission: + type: string + description: '**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.' + enum: + - pull + - push + default: pull + parent_team_id: + type: integer + description: The ID of a team to set as the parent team. + required: + - name + examples: + default: + value: + name: Justice League + description: A great team + permission: push + notification_setting: notifications_enabled + privacy: closed + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-github-breaking-changes: + - changeset: remove_team_permission + patch: + requestBody: + required: true + content: + application/json: + schema: + properties: + permission: null + type: object + version: '2026-03-10' + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}: + get: + summary: Get a team by name + description: |- + Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam NΓ€me"` would become `my-team-name`. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + tags: + - teams + operationId: teams/get-by-name + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#get-a-team-by-name + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + patch: + summary: Update a team + description: |- + To edit a team, the authenticated user must either be an organization owner or a team maintainer. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + tags: + - teams + operationId: teams/update-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#update-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: string + description: The description of the team. + privacy: + type: string + description: |- + The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + **For a non-nested team:** + * `secret` - only visible to organization owners and members of this team. + * `closed` - visible to all members of this organization. + **For a parent or child team:** + * `closed` - visible to all members of this organization. + enum: + - secret + - closed + notification_setting: + type: string + description: |- + The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * `notifications_disabled` - no one receives notifications. + enum: + - notifications_enabled + - notifications_disabled + permission: + type: string + description: '**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.' + enum: + - pull + - push + - admin + default: pull + parent_team_id: + type: integer + description: The ID of a team to set as the parent team. + nullable: true + examples: + default: + value: + name: new team name + description: new team description + privacy: closed + notification_setting: notifications_enabled + responses: + '200': + description: Response when the updated information already exists + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + delete: + summary: Delete a team + description: |- + To delete a team, the authenticated user must be an organization owner or team maintainer. + + If you are an organization owner, deleting a parent team will delete all of its child teams as well. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + tags: + - teams + operationId: teams/delete-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#delete-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + responses: + '204': + description: Response + '422': + $ref: '#/components/responses/enterprise_team_unsupported' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}/invitations: + get: + summary: List pending team invitations + description: |- + The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + tags: + - teams + operationId: teams/list-pending-invitations-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#list-pending-team-invitations + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + '422': + $ref: '#/components/responses/enterprise_team_unsupported' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + /orgs/{org}/teams/{team_slug}/members: + get: + summary: List team members + description: |- + Team members will include the members of child teams. + + To list members in a team, the team must be visible to the authenticated user. + tags: + - teams + operationId: teams/list-members-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#list-team-members + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - name: role + description: Filters members returned by their role in the team. + in: query + required: false + schema: + type: string + enum: + - member + - maintainer + - all + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + /orgs/{org}/teams/{team_slug}/memberships/{username}: + get: + summary: Get team membership for a user + description: |- + Team members will include the members of child teams. + + To get a user's membership with a team, the team must be visible to the authenticated user. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + + > [!NOTE] + > The response contains the `state` of the membership and the member's `role`. + + The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + tags: + - teams + operationId: teams/get-membership-for-user-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-user-is-a-team-maintainer: + $ref: '#/components/examples/team-membership-response-if-user-is-a-team-maintainer' + '404': + description: if user has no team membership + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + put: + summary: Add or update team membership for a user + description: |- + Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. + + If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + tags: + - teams + operationId: teams/add-or-update-membership-for-user-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: The role that this user should have in the team. + enum: + - member + - maintainer + default: member + examples: + default: + summary: Add or update team membership for an organization member + value: + role: maintainer + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-users-membership-with-team-is-now-pending: + $ref: '#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending' + '403': + description: Forbidden if team synchronization is set up + '422': + description: Unprocessable Entity if you attempt to add an organization to a team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + delete: + summary: Remove team membership for a user + description: |- + To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + tags: + - teams + operationId: teams/remove-membership-for-user-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + description: Forbidden if team synchronization is set up + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: members + x-stackQL-resource: members + /orgs/{org}/teams/{team_slug}/repos: + get: + summary: List team repositories + description: |- + Lists a team's repositories visible to the authenticated user. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + tags: + - teams + operationId: teams/list-repos-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-team-repositories + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}: + get: + summary: Check team permissions for a repository + description: |- + Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. + + You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header. + + If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + + If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + tags: + - teams + operationId: teams/check-permissions-for-repo-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Alternative response with repository permissions + content: + application/json: + schema: + $ref: '#/components/schemas/team-repository' + examples: + alternative-response-with-repository-permissions: + $ref: '#/components/examples/team-repository-alternative-response-with-repository-permissions' + '204': + description: Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. + '404': + description: Not Found if team does not have permission for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + put: + summary: Add or update team repository permissions + description: |- + To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + + For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + tags: + - teams + operationId: teams/add-or-update-repo-permissions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: 'The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team''s `permission` attribute will be used to determine what permission to grant the team on this repository.' + examples: + default: + summary: Adding a team to an organization repository with the write role + value: + permission: push + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + delete: + summary: Remove a repository from a team + description: |- + If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + tags: + - teams + operationId: teams/remove-repo-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /orgs/{org}/teams/{team_slug}/teams: + get: + summary: List child teams + description: |- + Lists the child teams of the team specified by `{team_slug}`. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + tags: + - teams + operationId: teams/list-child-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-child-teams + parameters: + - $ref: '#/components/parameters/org' + - $ref: '#/components/parameters/team-slug' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: if child teams exist + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + response-if-child-teams-exist: + $ref: '#/components/examples/team-items-response-if-child-teams-exist' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + x-stackQL-resource: teams + /teams/{team_id}: + get: + summary: Get a team (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + tags: + - teams + operationId: teams/get-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#get-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + patch: + summary: Update a team (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + + To edit a team, the authenticated user must either be an organization owner or a team maintainer. + + > [!NOTE] + > With nested teams, the `privacy` for parent teams cannot be `secret`. + tags: + - teams + operationId: teams/update-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#update-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: string + description: The description of the team. + privacy: + type: string + description: |- + The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + **For a non-nested team:** + * `secret` - only visible to organization owners and members of this team. + * `closed` - visible to all members of this organization. + **For a parent or child team:** + * `closed` - visible to all members of this organization. + enum: + - secret + - closed + notification_setting: + type: string + description: |- + The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * `notifications_disabled` - no one receives notifications. + enum: + - notifications_enabled + - notifications_disabled + permission: + type: string + description: '**Closing down notice**. The permission that new repositories will be added to the team with when none is specified.' + enum: + - pull + - push + - admin + default: pull + parent_team_id: + type: integer + description: The ID of a team to set as the parent team. + nullable: true + required: + - name + examples: + default: + value: + name: new team name + description: new team description + privacy: closed + notification_setting: notifications_enabled + responses: + '200': + description: Response when the updated information already exists + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + delete: + summary: Delete a team (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + + To delete a team, the authenticated user must be an organization owner or team maintainer. + + If you are an organization owner, deleting a parent team will delete all of its child teams as well. + tags: + - teams + operationId: teams/delete-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + responses: + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /teams/{team_id}/invitations: + get: + summary: List pending team invitations (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + + The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + tags: + - teams + operationId: teams/list-pending-invitations-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/organization-invitation' + examples: + default: + $ref: '#/components/examples/organization-invitation-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/members: + get: + summary: List team members (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + + Team members will include the members of child teams. + tags: + - teams + operationId: teams/list-members-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#list-team-members-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - name: role + description: Filters members returned by their role in the team. + in: query + required: false + schema: + type: string + enum: + - member + - maintainer + - all + default: all + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/members/{username}: + get: + summary: Get team member (Legacy) + description: |- + The "Get team member" endpoint (described below) is closing down. + + We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + + To list members in a team, the team must be visible to the authenticated user. + tags: + - teams + operationId: teams/get-member-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#get-team-member-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: if user is a member + '404': + description: if user is not a member + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + put: + summary: Add team member (Legacy) + description: |- + The "Add team member" endpoint (described below) is closing down. + + We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - teams + operationId: teams/add-member-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#add-team-member-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + description: Not Found if team synchronization is set up + '422': + description: Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + delete: + summary: Remove team member (Legacy) + description: |- + The "Remove team member" endpoint (described below) is closing down. + + We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + tags: + - teams + operationId: teams/remove-member-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#remove-team-member-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '404': + description: Not Found if team synchronization is setup + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/memberships/{username}: + get: + summary: Get team membership for a user (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + + Team members will include the members of child teams. + + To get a user's membership with a team, the team must be visible to the authenticated user. + + **Note:** + The response contains the `state` of the membership and the member's `role`. + + The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + tags: + - teams + operationId: teams/get-membership-for-user-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-user-is-a-team-maintainer: + $ref: '#/components/examples/team-membership-response-if-user-is-a-team-maintainer' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + put: + summary: Add or update team membership for a user (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + + If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + + If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + tags: + - teams + operationId: teams/add-or-update-membership-for-user-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + role: + type: string + description: The role that this user should have in the team. + enum: + - member + - maintainer + default: member + examples: + default: + summary: Assign the member role for a user in a team + value: + role: member + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/team-membership' + examples: + response-if-users-membership-with-team-is-now-pending: + $ref: '#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending' + '403': + description: Forbidden if team synchronization is set up + '404': + $ref: '#/components/responses/not_found' + '422': + description: Unprocessable Entity if you attempt to add an organization to a team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + delete: + summary: Remove team membership for a user (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. + + > [!NOTE] + > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + tags: + - teams + operationId: teams/remove-membership-for-user-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '403': + description: if team synchronization is set up + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: members + deprecated: true + x-stackQL-resource: members + /teams/{team_id}/repos: + get: + summary: List team repositories (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + tags: + - teams + operationId: teams/list-repos-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/minimal-repository' + examples: + default: + $ref: '#/components/examples/minimal-repository-items' + headers: + Link: + $ref: '#/components/headers/link' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /teams/{team_id}/repos/{owner}/{repo}: + get: + summary: Check team permissions for a repository (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + + > [!NOTE] + > Repositories inherited through a parent team will also be checked. + + You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: + tags: + - teams + operationId: teams/check-permissions-for-repo-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '200': + description: Alternative response with extra repository information + content: + application/json: + schema: + $ref: '#/components/schemas/team-repository' + examples: + alternative-response-with-extra-repository-information: + $ref: '#/components/examples/team-repository-alternative-response-with-extra-repository-information' + '204': + description: Response if repository is managed by this team + '404': + description: Not Found if repository is not managed by this team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + put: + summary: Add or update team repository permissions (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + + To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. + + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + tags: + - teams + operationId: teams/add-or-update-repo-permissions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. + enum: + - pull + - push + - admin + examples: + default: + summary: Example of setting permission to pull + value: + permission: push + responses: + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + delete: + summary: Remove a repository from a team (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + + If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + tags: + - teams + operationId: teams/remove-repo-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/owner' + - $ref: '#/components/parameters/repo' + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /teams/{team_id}/teams: + get: + summary: List child teams (Legacy) + description: |- + > [!WARNING] + > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + tags: + - teams + operationId: teams/list-child-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy + parameters: + - $ref: '#/components/parameters/team-id' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: if child teams exist + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team' + examples: + response-if-child-teams-exist: + $ref: '#/components/examples/team-items-response-if-child-teams-exist' + headers: + Link: + $ref: '#/components/headers/link' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: teams + deprecated: true + x-stackQL-resource: teams + /user/teams: + get: + summary: List teams for the authenticated user + description: |- + List all of the teams across all of the organizations to which the authenticated + user belongs. + + OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + + When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + tags: + - teams + operationId: teams/list-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/team-full' + examples: + default: + $ref: '#/components/examples/team-full-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: teams + subcategory: teams + x-stackQL-resource: teams +components: + schemas: + team: + title: Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + $ref: '#/components/schemas/nullable-team-simple' + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + team-full: + title: Full Team + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + example: 42 + type: integer + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + example: https://api.github.com/organizations/1/team/1 + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + name: + description: Name of the team + example: Developers + type: string + slug: + type: string + example: justice-league + description: + type: string + example: A great team. + nullable: true + privacy: + description: The level of privacy this team should have + type: string + enum: + - closed + - secret + example: closed + notification_setting: + description: The notification setting the team has set + type: string + enum: + - notifications_enabled + - notifications_disabled + example: notifications_enabled + permission: + description: Permission that the team will have for its repositories + example: push + type: string + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + parent: + $ref: '#/components/schemas/nullable-team-simple' + members_count: + type: integer + example: 3 + repos_count: + type: integer + example: 10 + created_at: + type: string + format: date-time + example: '2017-07-14T16:53:42Z' + updated_at: + type: string + format: date-time + example: '2017-08-17T12:37:15Z' + organization: + $ref: '#/components/schemas/team-organization' + ldap_dn: + $ref: '#/components/schemas/ldap-dn' + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + - created_at + - updated_at + - members_count + - repos_count + - organization + organization-invitation: + title: Organization Invitation + description: Organization Invitation + type: object + properties: + id: + type: integer + format: int64 + login: + type: string + nullable: true + email: + type: string + nullable: true + role: + type: string + created_at: + type: string + failed_at: + type: string + nullable: true + failed_reason: + type: string + nullable: true + inviter: + $ref: '#/components/schemas/simple-user' + team_count: + type: integer + node_id: + type: string + example: '"MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x"' + invitation_teams_url: + type: string + example: '"https://api.github.com/organizations/16/invitations/1/teams"' + invitation_source: + type: string + example: '"member"' + required: + - id + - login + - email + - role + - created_at + - inviter + - team_count + - invitation_teams_url + - node_id + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + team-membership: + title: Team Membership + description: Team Membership + type: object + properties: + url: + type: string + format: uri + role: + description: The role of the user in the team. + enum: + - member + - maintainer + default: member + example: member + type: string + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + example: 1296269 + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + $ref: '#/components/schemas/simple-user' + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: string + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: string + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or collaborators_only.' + type: string + enum: + - all + - collaborators_only + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + example: admin + temp_clone_token: + type: string + delete_branch_on_merge: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + code_of_conduct: + $ref: '#/components/schemas/code-of-conduct' + license: + type: object + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + node_id: + type: string + nullable: true + forks: + type: integer + example: 0 + open_issues: + type: integer + example: 0 + watchers: + type: integer + example: 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + example: false + security_and_analysis: + $ref: '#/components/schemas/security-and-analysis' + custom_properties: + type: object + description: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + additionalProperties: true + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + type: object + version: '2026-03-10' + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + $ref: '#/components/schemas/nullable-license-simple' + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + role_name: + type: string + example: admin + owner: + $ref: '#/components/schemas/nullable-simple-user' + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + example: false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + example: false + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + x-github-breaking-changes: + - changeset: remove_has_downloads + patch: + properties: + has_downloads: null + required: + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url + - description + - downloads_url + - events_url + - fork + - forks_url + - full_name + - git_commits_url + - git_refs_url + - git_tags_url + - hooks_url + - html_url + - id + - node_id + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + type: object + version: '2026-03-10' + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + team-organization: + title: Team Organization + description: Team Organization + type: object + properties: + login: + type: string + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + example: https://api.github.com/orgs/github + repos_url: + type: string + format: uri + example: https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + example: https://api.github.com/orgs/github/events + hooks_url: + type: string + example: https://api.github.com/orgs/github/hooks + issues_url: + type: string + example: https://api.github.com/orgs/github/issues + members_url: + type: string + example: https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + example: https://github.com/images/error/octocat_happy.gif + description: + type: string + example: A great organization + nullable: true + name: + type: string + example: github + company: + type: string + example: GitHub + blog: + type: string + format: uri + example: https://github.com/blog + location: + type: string + example: San Francisco + email: + type: string + format: email + example: octocat@github.com + twitter_username: + type: string + example: github + nullable: true + is_verified: + type: boolean + example: true + has_organization_projects: + type: boolean + example: true + has_repository_projects: + type: boolean + example: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + html_url: + type: string + format: uri + example: https://github.com/octocat + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + type: + type: string + example: Organization + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + private_gists: + type: integer + example: 81 + nullable: true + disk_usage: + type: integer + example: 10000 + nullable: true + collaborators: + type: integer + example: 8 + nullable: true + billing_email: + type: string + format: email + example: org@example.com + nullable: true + plan: + type: object + properties: + name: + type: string + space: + type: integer + private_repos: + type: integer + filled_seats: + type: integer + seats: + type: integer + required: + - name + - space + - private_repos + default_repository_permission: + type: string + nullable: true + members_can_create_repositories: + type: boolean + example: true + nullable: true + two_factor_requirement_enabled: + type: boolean + example: true + nullable: true + members_allowed_repository_creation_type: + type: string + example: all + members_can_create_public_repositories: + type: boolean + example: true + members_can_create_private_repositories: + type: boolean + example: true + members_can_create_internal_repositories: + type: boolean + example: true + members_can_create_pages: + type: boolean + example: true + members_can_create_public_pages: + type: boolean + example: true + members_can_create_private_pages: + type: boolean + example: true + members_can_fork_private_repositories: + type: boolean + example: false + nullable: true + web_commit_signoff_required: + type: boolean + example: false + updated_at: + type: string + format: date-time + archived_at: + type: string + format: date-time + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + - html_url + - has_organization_projects + - has_repository_projects + - public_repos + - public_gists + - followers + - following + - type + - created_at + - updated_at + - archived_at + ldap-dn: + type: string + description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + example: cn=Enterprise Ops,ou=teams,dc=github,dc=com + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + example: contributor_covenant + name: + type: string + example: Contributor Covenant + url: + type: string + format: uri + example: https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + example: | + # Contributor Covenant Code of Conduct + + ## Our Pledge + + In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + + ## Our Standards + + Examples of behavior that contributes to creating a positive environment include: + + * Using welcoming and inclusive language + * Being respectful of differing viewpoints and experiences + * Gracefully accepting constructive criticism + * Focusing on what is best for the community + * Showing empathy towards other community members + + Examples of unacceptable behavior by participants include: + + * The use of sexualized language or imagery and unwelcome sexual attention or advances + * Trolling, insulting/derogatory comments, and personal or political attacks + * Public or private harassment + * Publishing others' private information, such as a physical or electronic address, without explicit permission + * Other conduct which could reasonably be considered inappropriate in a professional setting + + ## Our Responsibilities + + Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + to any instances of unacceptable behavior. + + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + + ## Scope + + This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + + ## Enforcement + + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + + Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + + ## Attribution + + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + html_url: + type: string + format: uri + nullable: true + required: + - url + - html_url + - key + - name + security-and-analysis: + nullable: true + type: object + properties: + advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + dependabot_security_updates: + description: Enable or disable Dependabot security updates for the repository. + type: object + properties: + status: + description: The enablement status of Dependabot security updates for the repository. + type: string + enum: + - enabled + - disabled + secret_scanning: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_push_protection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_non_provider_patterns: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_ai_detection: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + properties: + reviewers: + type: array + description: The bypass reviewers for secret scanning delegated bypass + items: + type: object + required: + - reviewer_id + - reviewer_type + properties: + reviewer_id: + type: integer + description: The ID of the team or role selected as a bypass reviewer + reviewer_type: + type: string + description: The type of the bypass reviewer + enum: + - TEAM + - ROLE + mode: + type: string + description: The bypass mode for the reviewer + enum: + - ALWAYS + - EXEMPT + default: ALWAYS + nullable-license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + example: mit + name: + type: string + example: MIT License + url: + type: string + nullable: true + format: uri + example: https://api.github.com/licenses/mit + spdx_id: + type: string + nullable: true + example: MIT + node_id: + type: string + example: MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + nullable: true + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true + responses: + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + enterprise_team_unsupported: + description: Unprocessable entity if you attempt to modify an enterprise team at the organization level. + not_modified: + description: Not modified + parameters: + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true + schema: + type: string + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + team-type: + name: team_type + description: Filter team results by their type. For more information, see "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)" + in: query + required: false + schema: + type: string + enum: + - all + - enterprise + - organization + default: all + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + owner: + name: owner + description: The account owner of the repository. The name is not case sensitive. + in: path + required: true + schema: + type: string + repo: + name: repo + description: The name of the repository without the `.git` extension. The name is not case sensitive. + in: path + required: true + schema: + type: string + team-id: + name: team_id + description: The unique identifier of the team. + in: path + required: true + schema: + type: integer + examples: + team-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + team-full: + value: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + members_count: 3 + repos_count: 10 + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: github + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + is_verified: true + has_organization_projects: true + has_repository_projects: true + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + html_url: https://github.com/octocat + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + organization-invitation-items: + value: + - id: 1 + login: monalisa + node_id: MDQ6VXNlcjE= + email: octocat@github.com + role: direct_member + created_at: '2016-11-30T06:46:10-08:00' + failed_at: '' + failed_reason: '' + inviter: + login: other_user + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/other_user_happy.gif + gravatar_id: '' + url: https://api.github.com/users/other_user + html_url: https://github.com/other_user + followers_url: https://api.github.com/users/other_user/followers + following_url: https://api.github.com/users/other_user/following{/other_user} + gists_url: https://api.github.com/users/other_user/gists{/gist_id} + starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/other_user/subscriptions + organizations_url: https://api.github.com/users/other_user/orgs + repos_url: https://api.github.com/users/other_user/repos + events_url: https://api.github.com/users/other_user/events{/privacy} + received_events_url: https://api.github.com/users/other_user/received_events + type: User + site_admin: false + team_count: 2 + invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams + invitation_source: member + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + team-membership-response-if-user-is-a-team-maintainer: + summary: Response if user is a team maintainer + value: + url: https://api.github.com/teams/1/memberships/octocat + role: maintainer + state: active + team-membership-response-if-users-membership-with-team-is-now-pending: + summary: Response if user's membership with team is now pending + value: + url: https://api.github.com/teams/1/memberships/octocat + role: member + state: pending + minimal-repository-items: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + has_discussions: false + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled + secret_scanning_non_provider_patterns: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled + team-repository-alternative-response-with-repository-permissions: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + maintain: false + push: false + triage: false + pull: true + role_name: read + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + team-items-response-if-child-teams-exist: + value: + - id: 2 + node_id: MDQ6VGVhbTI= + url: https://api.github.com/teams/2 + name: Original Roster + slug: original-roster + description: Started it all. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/2/members{/member} + repositories_url: https://api.github.com/teams/2/repos + parent: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + html_url: https://github.com/orgs/rails/teams/core + team-repository-alternative-response-with-extra-repository-information: + value: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + private: false + html_url: https://github.com/octocat/Hello-World + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World + archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads + events_url: https://api.github.com/repos/octocat/Hello-World/events + forks_url: https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World/languages + merges_url: https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: git@github.com:octocat/Hello-World.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World/tags + teams_url: https://api.github.com/repos/octocat/Hello-World/teams + trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: null + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: false + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + maintain: false + push: false + triage: false + pull: true + role_name: read + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + team-full-items: + value: + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: null + members_count: 3 + repos_count: 10 + created_at: '2017-07-14T16:53:42Z' + updated_at: '2017-08-17T12:37:15Z' + organization: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + name: github + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + is_verified: true + has_organization_projects: true + has_repository_projects: true + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + html_url: https://github.com/octocat + created_at: '2008-01-14T04:33:35Z' + updated_at: '2017-08-17T12:37:15Z' + type: Organization + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/provider-dev/source/users.yaml b/provider-dev/source/users.yaml new file mode 100644 index 0000000..f37622c --- /dev/null +++ b/provider-dev/source/users.yaml @@ -0,0 +1,4241 @@ +openapi: 3.0.3 +info: + title: users API + description: Interact with and view information about users and also current user. + version: 1.1.4 +paths: + /user: + get: + summary: Get the authenticated user + description: OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. + tags: + - users + operationId: users/get-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-the-authenticated-user + parameters: [] + responses: + '200': + description: Response + content: + application/json: + schema: + discriminator: + propertyName: user_view_type + mapping: + public: '#/components/schemas/public-user' + private: '#/components/schemas/private-user' + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + additionalProperties: false + examples: + response-with-public-and-private-profile-information: + $ref: '#/components/examples/private-user-response-with-public-and-private-profile-information' + response-with-public-profile-information: + $ref: '#/components/examples/private-user-response-with-public-profile-information' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: users + x-stackQL-resource: users + patch: + summary: Update the authenticated user + description: '**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.' + tags: + - users + operationId: users/update-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#update-the-authenticated-user + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + description: The new name of the user. + type: string + example: Omar Jahandar + email: + description: The publicly visible email address of the user. + type: string + example: omar@example.com + blog: + description: The new blog URL of the user. + type: string + example: blog.example.com + twitter_username: + description: The new Twitter username of the user. + type: string + example: therealomarj + nullable: true + company: + description: The new company of the user. + type: string + example: Acme corporation + location: + description: The new location of the user. + type: string + example: Berlin, Germany + hireable: + description: The new hiring availability of the user. + type: boolean + bio: + description: The new short biography of the user. + type: string + examples: + default: + summary: Example of updating blog and name + value: + blog: https://github.com/blog + name: monalisa octocat + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/private-user' + examples: + default: + $ref: '#/components/examples/private-user' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: users + x-stackQL-resource: users + /user/blocks: + get: + summary: List users blocked by the authenticated user + description: List the users you've blocked on your personal account. + tags: + - users + operationId: users/list-blocked-by-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + /user/blocks/{username}: + get: + summary: Check if a user is blocked by the authenticated user + description: Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. + tags: + - users + operationId: users/check-blocked + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: If the user is blocked + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: If the user is not blocked + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + put: + summary: Block a user + description: Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. + tags: + - users + operationId: users/block + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/blocking#block-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + delete: + summary: Unblock a user + description: Unblocks the given user and returns a 204. + tags: + - users + operationId: users/unblock + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/blocking#unblock-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: blocking + x-stackQL-resource: blocking + /user/email/visibility: + patch: + summary: Set primary email visibility for the authenticated user + description: Sets the visibility for your primary email addresses. + tags: + - users + operationId: users/set-primary-email-visibility-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + visibility: + description: Denotes whether an email is publicly visible. + type: string + enum: + - public + - private + required: + - visibility + type: object + examples: + default: + summary: Example setting the primary email address to private + value: + visibility: private + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items-3' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + /user/emails: + get: + summary: List email addresses for the authenticated user + description: |- + Lists all of your email addresses, and specifies which one is visible + to the public. + + OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + tags: + - users + operationId: users/list-emails-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items-2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + post: + summary: Add an email address for the authenticated user + description: OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - users + operationId: users/add-email-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + emails: + description: Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + type: array + items: + type: string + example: username@example.com + minItems: 1 + example: [] + required: + - emails + example: + emails: + - octocat@github.com + - mona@github.com + items: + type: string + example: username@example.com + minItems: 1 + examples: + default: + summary: Example adding multiple email addresses + value: + emails: + - octocat@github.com + - mona@github.com + - octocat@octocat.org + responses: + '201': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + delete: + summary: Delete an email address for the authenticated user + description: OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - users + operationId: users/delete-email-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user + parameters: [] + requestBody: + content: + application/json: + schema: + type: object + description: Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. + properties: + emails: + description: Email addresses associated with the GitHub user account. + type: array + items: + type: string + example: username@example.com + minItems: 1 + example: + emails: + - octocat@github.com + - mona@github.com + required: + - emails + items: + type: string + example: username@example.com + minItems: 1 + examples: + default: + summary: Example deleting multiple email accounts + value: + emails: + - octocat@github.com + - mona@github.com + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + /user/followers: + get: + summary: List followers of the authenticated user + description: Lists the people following the authenticated user. + tags: + - users + operationId: users/list-followers-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + /user/following: + get: + summary: List the people the authenticated user follows + description: Lists the people who the authenticated user follows. + tags: + - users + operationId: users/list-followed-by-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + /user/following/{username}: + get: + summary: Check if a person is followed by the authenticated user + description: '' + tags: + - users + operationId: users/check-person-is-followed-by-authenticated + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: if the person is followed by the authenticated user + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + description: if the person is not followed by the authenticated user + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + put: + summary: Follow a user + description: |- + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + + OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + tags: + - users + operationId: users/follow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#follow-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + delete: + summary: Unfollow a user + description: OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + tags: + - users + operationId: users/unfollow + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#unfollow-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: followers + x-stackQL-resource: followers + /user/gpg_keys: + get: + summary: List GPG keys for the authenticated user + description: |- + Lists the current user's GPG keys. + + OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + tags: + - users + operationId: users/list-gpg-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + post: + summary: Create a GPG key for the authenticated user + description: |- + Adds a GPG key to the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + operationId: users/create-gpg-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: A descriptive name for the new key. + type: string + armored_public_key: + description: A GPG key in ASCII-armored format. + type: string + type: object + required: + - armored_public_key + examples: + default: + value: + name: Octocat's GPG Key + armored_public_key: |- + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1 + + mQINBFnZ2ZIBEADQ2Z7Z7 + -----END PGP PUBLIC KEY BLOCK----- + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + /user/gpg_keys/{gpg_key_id}: + get: + summary: Get a GPG key for the authenticated user + description: |- + View extended details for a single GPG key. + + OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + tags: + - users + operationId: users/get-gpg-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/gpg-key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + delete: + summary: Delete a GPG key for the authenticated user + description: |- + Removes a GPG key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + tags: + - users + operationId: users/delete-gpg-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/gpg-key-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + /user/keys: + get: + summary: List public SSH keys for the authenticated user + description: |- + Lists the public SSH keys for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + tags: + - users + operationId: users/list-public-ssh-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/key' + examples: + default: + $ref: '#/components/examples/key-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + post: + summary: Create a public SSH key for the authenticated user + description: |- + Adds a public SSH key to the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. + operationId: users/create-public-ssh-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + title: + description: A descriptive name for the new key. + type: string + example: Personal MacBook Air + key: + description: The public SSH key to add to your GitHub account. + type: string + pattern: '^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ' + required: + - key + type: object + examples: + default: + value: + title: ssh-rsa AAAAB3NzaC1yc2EAAA + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/key' + examples: + default: + $ref: '#/components/examples/key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + /user/keys/{key_id}: + get: + summary: Get a public SSH key for the authenticated user + description: |- + View extended details for a single public SSH key. + + OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + tags: + - users + operationId: users/get-public-ssh-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/key' + examples: + default: + $ref: '#/components/examples/key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + delete: + summary: Delete a public SSH key for the authenticated user + description: |- + Removes a public SSH key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + tags: + - users + operationId: users/delete-public-ssh-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/key-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: keys + x-stackQL-resource: keys + /user/public_emails: + get: + summary: List public email addresses for the authenticated user + description: |- + Lists your publicly visible email address, which you can set with the + [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + endpoint. + + OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + tags: + - users + operationId: users/list-public-emails-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/email' + examples: + default: + $ref: '#/components/examples/email-items-2' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: emails + x-stackQL-resource: emails + /user/social_accounts: + get: + summary: List social accounts for the authenticated user + description: Lists all of your social accounts. + tags: + - users + operationId: users/list-social-accounts-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/social-account' + examples: + default: + $ref: '#/components/examples/social-account-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + post: + summary: Add social accounts for the authenticated user + description: |- + Add one or more social accounts to the authenticated user's profile. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - users + operationId: users/add-social-account-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + account_urls: + description: Full URLs for the social media profiles to add. + type: array + items: + type: string + example: https://twitter.com/github + example: [] + required: + - account_urls + example: + account_urls: + - https://www.linkedin.com/company/github/ + - https://twitter.com/github + examples: + default: + summary: Adding multiple social accounts + value: + account_urls: + - https://facebook.com/GitHub + - https://www.youtube.com/@GitHub + responses: + '201': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/social-account' + examples: + default: + $ref: '#/components/examples/social-account-items' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + delete: + summary: Delete social accounts for the authenticated user + description: |- + Deletes one or more social accounts from the authenticated user's profile. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + tags: + - users + operationId: users/delete-social-account-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + account_urls: + description: Full URLs for the social media profiles to delete. + type: array + items: + type: string + example: https://twitter.com/github + example: [] + required: + - account_urls + example: + account_urls: + - https://www.linkedin.com/company/github/ + - https://twitter.com/github + examples: + default: + summary: Deleting multiple social accounts + value: + account_urls: + - https://facebook.com/GitHub + - https://www.youtube.com/@GitHub + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + /user/ssh_signing_keys: + get: + summary: List SSH signing keys for the authenticated user + description: |- + Lists the SSH signing keys for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + tags: + - users + operationId: users/list-ssh-signing-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key-items' + headers: + Link: + $ref: '#/components/headers/link' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + post: + summary: Create a SSH signing key for the authenticated user + description: |- + Creates an SSH signing key for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + operationId: users/create-ssh-signing-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + title: + description: A descriptive name for the new key. + type: string + example: Personal MacBook Air + key: + description: The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + type: string + pattern: '^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com ' + required: + - key + type: object + examples: + default: + value: + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + responses: + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + /user/ssh_signing_keys/{ssh_signing_key_id}: + get: + summary: Get an SSH signing key for the authenticated user + description: |- + Gets extended details for an SSH signing key. + + OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + tags: + - users + operationId: users/get-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/ssh-signing-key-id' + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key' + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + delete: + summary: Delete an SSH signing key for the authenticated user + description: |- + Deletes an SSH signing key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + tags: + - users + operationId: users/delete-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user + parameters: + - $ref: '#/components/parameters/ssh-signing-key-id' + responses: + '204': + description: Response + '304': + $ref: '#/components/responses/not_modified' + '401': + $ref: '#/components/responses/requires_authentication' + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys + /user/{account_id}: + get: + summary: Get a user using their ID + description: |- + Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-a-user-using-their-id + parameters: + - $ref: '#/components/parameters/account-id' + responses: + '200': + description: Response + content: + application/json: + schema: + discriminator: + propertyName: user_view_type + mapping: + public: '#/components/schemas/public-user' + private: '#/components/schemas/private-user' + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + additionalProperties: false + examples: + default-response: + $ref: '#/components/examples/public-user-default-response' + response-with-git-hub-plan-information: + $ref: '#/components/examples/public-user-response-with-git-hub-plan-information' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users + x-stackQL-resource: users + /users: + get: + summary: List users + description: |- + Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. + + Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + tags: + - users + operationId: users/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#list-users + parameters: + - $ref: '#/components/parameters/since-user' + - $ref: '#/components/parameters/per-page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + example: ; rel="next" + schema: + type: string + '304': + $ref: '#/components/responses/not_modified' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users + x-stackQL-resource: users + /users/{username}: + get: + summary: Get a user + description: |- + Provides publicly available information about someone with a GitHub account. + + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). + tags: + - users + operationId: users/get-by-username + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-a-user + parameters: + - $ref: '#/components/parameters/username' + responses: + '200': + description: Response + content: + application/json: + schema: + discriminator: + propertyName: user_view_type + mapping: + public: '#/components/schemas/public-user' + private: '#/components/schemas/private-user' + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + additionalProperties: false + examples: + default-response: + $ref: '#/components/examples/public-user-default-response' + response-with-git-hub-plan-information: + $ref: '#/components/examples/public-user-response-with-git-hub-plan-information' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: users + x-stackQL-resource: users + /users/{username}/attestations/bulk-list: + post: + summary: List attestations by bulk subject digests + description: |- + List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/username' + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + required: + - subject_digests + examples: + default: + $ref: '#/components/examples/bulk-subject-digest-body' + withPredicateType: + $ref: '#/components/examples/bulk-subject-digest-body-with-predicate-type' + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + nullable: true + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + $ref: '#/components/examples/list-attestations-bulk' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations_subject_digests: + additionalProperties: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /users/{username}/attestations/delete-request: + post: + summary: Delete attestations in bulk + description: Delete artifact attestations in bulk by either subject digests or unique ID. + tags: + - users + operationId: users/delete-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk + parameters: + - $ref: '#/components/parameters/username' + requestBody: + required: true + content: + application/json: + schema: + type: object + description: The request body must include either `subject_digests` or `attestation_ids`, but not both. + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests associated with the artifact attestations to delete. + minItems: 1 + maxItems: 1024 + attestation_ids: + type: array + items: + type: integer + description: List of unique IDs associated with the artifact attestations to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - attestation_ids + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-stackQL-resource: attestations + /users/{username}/attestations/digest/{subject_digest}: + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - users + operationId: users/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest + parameters: + - $ref: '#/components/parameters/username' + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-stackQL-resource: attestations + /users/{username}/attestations/{attestation_id}: + delete: + summary: Delete attestations by ID + description: Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + tags: + - users + operationId: users/delete-attestations-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id + parameters: + - $ref: '#/components/parameters/username' + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + $ref: '#/components/responses/forbidden' + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-stackQL-resource: attestations + /users/{username}/attestations/{subject_digest}: + get: + summary: List attestations + description: |- + List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations + parameters: + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/pagination-before' + - $ref: '#/components/parameters/pagination-after' + - $ref: '#/components/parameters/username' + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations: + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + repository_id: + type: integer + bundle_url: + type: string + initiator: + type: string + examples: + default: + $ref: '#/components/examples/list-attestations' + '201': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/empty-object' + examples: + default: + value: null + '204': + description: Response + '404': + $ref: '#/components/responses/not_found' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + x-github-breaking-changes: + - changeset: remove_bundle + patch: + responses: + '200': + content: + application/json: + schema: + properties: + attestations: + items: + properties: + bundle: null + type: object + type: object + version: '2026-03-10' + x-stackQL-resource: attestations + /users/{username}/followers: + get: + summary: List followers of a user + description: Lists the people following the specified user. + tags: + - users + operationId: users/list-followers-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#list-followers-of-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: followers + x-stackQL-resource: followers + /users/{username}/following: + get: + summary: List the people a user follows + description: Lists the people who the specified user follows. + tags: + - users + operationId: users/list-following-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/simple-user' + examples: + default: + $ref: '#/components/examples/simple-user-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: followers + x-stackQL-resource: followers + /users/{username}/following/{target_user}: + get: + summary: Check if a user follows another user + description: '' + tags: + - users + operationId: users/check-following-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user + parameters: + - $ref: '#/components/parameters/username' + - name: target_user + in: path + required: true + schema: + type: string + responses: + '204': + description: if the user follows the target user + '404': + description: if the user does not follow the target user + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: followers + x-stackQL-resource: followers + /users/{username}/gpg_keys: + get: + summary: List GPG keys for a user + description: Lists the GPG keys for a user. This information is accessible by anyone. + tags: + - users + operationId: users/list-gpg-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/gpg-key' + examples: + default: + $ref: '#/components/examples/gpg-key-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: gpg-keys + x-stackQL-resource: gpg_keys + /users/{username}/hovercard: + get: + summary: Get contextual information for a user + description: |- + Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + + The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - users + operationId: users/get-context-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - name: subject_type + description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. + in: query + required: false + schema: + type: string + enum: + - organization + - repository + - issue + - pull_request + - name: subject_id + description: Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + $ref: '#/components/schemas/hovercard' + examples: + default: + $ref: '#/components/examples/hovercard' + '404': + $ref: '#/components/responses/not_found' + '422': + $ref: '#/components/responses/validation_failed' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: users + x-stackQL-resource: users + /users/{username}/keys: + get: + summary: List public keys for a user + description: Lists the _verified_ public SSH keys for a user. This is accessible by anyone. + tags: + - users + operationId: users/list-public-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/key-simple' + examples: + default: + $ref: '#/components/examples/key-simple-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: keys + x-stackQL-resource: keys + /users/{username}/social_accounts: + get: + summary: List social accounts for a user + description: Lists social media accounts for a user. This endpoint is accessible by anyone. + tags: + - users + operationId: users/list-social-accounts-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/social-account' + examples: + default: + $ref: '#/components/examples/social-account-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: social-accounts + x-stackQL-resource: social_accounts + /users/{username}/ssh_signing_keys: + get: + summary: List SSH signing keys for a user + description: Lists the SSH signing keys for a user. This operation is accessible by anyone. + tags: + - users + operationId: users/list-ssh-signing-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user + parameters: + - $ref: '#/components/parameters/username' + - $ref: '#/components/parameters/per-page' + - $ref: '#/components/parameters/page' + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ssh-signing-key' + examples: + default: + $ref: '#/components/examples/ssh-signing-key-items' + headers: + Link: + $ref: '#/components/headers/link' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: ssh-signing-keys + x-stackQL-resource: ssh_signing_keys +components: + schemas: + private-user: + title: Private User + description: Private User + type: object + properties: + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + user_view_type: + type: string + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + name: + type: string + example: monalisa octocat + nullable: true + company: + type: string + example: GitHub + nullable: true + blog: + type: string + example: https://github.com/blog + nullable: true + location: + type: string + example: San Francisco + nullable: true + email: + type: string + format: email + example: octocat@github.com + nullable: true + notification_email: + type: string + format: email + example: octocat@github.com + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + example: There once was... + nullable: true + twitter_username: + type: string + example: monalisa + nullable: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + created_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + example: '2008-01-14T04:33:35Z' + private_gists: + type: integer + example: 81 + total_private_repos: + type: integer + example: 100 + owned_private_repos: + type: integer + example: 100 + disk_usage: + type: integer + example: 10000 + collaborators: + type: integer + example: 8 + two_factor_authentication: + type: boolean + example: true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + business_plus: + type: boolean + ldap_dn: + type: string + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + - collaborators + - disk_usage + - owned_private_repos + - private_gists + - total_private_repos + - two_factor_authentication + public-user: + title: Public User + description: Public User + type: object + properties: + login: + type: string + id: + type: integer + format: int64 + user_view_type: + type: string + node_id: + type: string + avatar_url: + type: string + format: uri + gravatar_id: + type: string + nullable: true + url: + type: string + format: uri + html_url: + type: string + format: uri + followers_url: + type: string + format: uri + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + format: uri + organizations_url: + type: string + format: uri + repos_url: + type: string + format: uri + events_url: + type: string + received_events_url: + type: string + format: uri + type: + type: string + site_admin: + type: boolean + name: + type: string + nullable: true + company: + type: string + nullable: true + blog: + type: string + nullable: true + location: + type: string + nullable: true + email: + type: string + format: email + nullable: true + notification_email: + type: string + format: email + nullable: true + hireable: + type: boolean + nullable: true + bio: + type: string + nullable: true + twitter_username: + type: string + nullable: true + public_repos: + type: integer + public_gists: + type: integer + followers: + type: integer + following: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + private_gists: + type: integer + example: 1 + total_private_repos: + type: integer + example: 2 + owned_private_repos: + type: integer + example: 2 + disk_usage: + type: integer + example: 1 + collaborators: + type: integer + example: 3 + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + - bio + - blog + - company + - email + - followers + - following + - hireable + - location + - name + - public_gists + - public_repos + - created_at + - updated_at + additionalProperties: false + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + basic-error: + title: Basic Error + description: Basic Error + type: object + properties: + message: + type: string + documentation_url: + type: string + url: + type: string + status: + type: string + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + example: octocat@github.com + primary: + type: boolean + example: true + verified: + type: boolean + example: true + visibility: + type: string + example: public + nullable: true + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + format: int64 + example: 3 + name: + type: string + example: Octocat's GPG Key + nullable: true + primary_key_id: + type: integer + nullable: true + key_id: + type: string + example: 3262EFF25BA0D270 + public_key: + type: string + example: xsBNBFayYZ... + emails: + type: array + example: + - email: octocat@users.noreply.github.com + verified: true + items: + type: object + properties: + email: + type: string + verified: + type: boolean + subkeys: + type: array + example: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: null + revoked: false + items: + type: object + properties: + id: + type: integer + format: int64 + primary_key_id: + type: integer + key_id: + type: string + public_key: + type: string + emails: + type: array + items: + type: object + properties: + email: + type: string + verified: + type: boolean + subkeys: + type: array + items: {} + can_sign: + type: boolean + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + created_at: + type: string + expires_at: + type: string + nullable: true + raw_key: + type: string + nullable: true + revoked: + type: boolean + can_sign: + type: boolean + example: true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + example: true + created_at: + type: string + format: date-time + example: '2016-03-24T11:31:04-06:00' + expires_at: + type: string + format: date-time + nullable: true + revoked: + type: boolean + example: true + raw_key: + type: string + nullable: true + required: + - id + - primary_key_id + - key_id + - raw_key + - public_key + - created_at + - expires_at + - can_sign + - can_encrypt_comms + - can_encrypt_storage + - can_certify + - emails + - subkeys + - revoked + key: + title: Key + description: Key + type: object + properties: + key: + type: string + id: + type: integer + format: int64 + url: + type: string + title: + type: string + created_at: + type: string + format: date-time + verified: + type: boolean + read_only: + type: boolean + last_used: + nullable: true + type: string + format: date-time + required: + - key + - id + - url + - title + - created_at + - verified + - read_only + social-account: + title: Social account + description: Social media account + type: object + properties: + provider: + type: string + example: linkedin + url: + type: string + example: https://www.linkedin.com/company/github/ + required: + - provider + - url + ssh-signing-key: + title: SSH Signing Key + description: A public SSH key used to sign Git commits + type: object + properties: + key: + type: string + id: + type: integer + title: + type: string + created_at: + type: string + format: date-time + required: + - key + - id + - title + - created_at + empty-object: + title: Empty Object + description: An object without any properties. + type: object + properties: {} + additionalProperties: false + hovercard: + title: Hovercard + description: Hovercard + type: object + properties: + contexts: + type: array + items: + type: object + properties: + message: + type: string + octicon: + type: string + required: + - message + - octicon + required: + - contexts + key-simple: + title: Key Simple + description: Key Simple + type: object + properties: + id: + type: integer + key: + type: string + created_at: + type: string + format: date-time + last_used: + nullable: true + type: string + format: date-time + required: + - key + - id + validation-error: + title: Validation Error + description: Validation Error + type: object + required: + - message + - documentation_url + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + required: + - code + properties: + resource: + type: string + field: + type: string + message: + type: string + code: + type: string + index: + type: integer + value: + oneOf: + - type: string + nullable: true + - type: integer + nullable: true + - type: array + nullable: true + items: + type: string + responses: + not_modified: + description: Not modified + requires_authentication: + description: Requires authentication + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + not_found: + description: Resource not found + content: + application/json: + schema: + $ref: '#/components/schemas/basic-error' + validation_failed: + description: Validation failed, or the endpoint has been spammed. + content: + application/json: + schema: + $ref: '#/components/schemas/validation-error' + parameters: + per-page: + name: per_page + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + page: + name: page + description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true + schema: + type: string + gpg-key-id: + name: gpg_key_id + description: The unique identifier of the GPG key. + in: path + required: true + schema: + type: integer + key-id: + name: key_id + description: The unique identifier of the key. + in: path + required: true + schema: + type: integer + ssh-signing-key-id: + name: ssh_signing_key_id + description: The unique identifier of the SSH signing key. + in: path + required: true + schema: + type: integer + account-id: + name: account_id + description: account_id parameter + in: path + required: true + schema: + type: integer + since-user: + name: since + description: A user ID. Only return users with an ID greater than this ID. + in: query + required: false + schema: + type: integer + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + pagination-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + examples: + private-user-response-with-public-and-private-profile-information: + summary: Response with public and private profile information + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + private_gists: 81 + total_private_repos: 100 + owned_private_repos: 100 + disk_usage: 10000 + collaborators: 8 + two_factor_authentication: true + plan: + name: Medium + space: 400 + private_repos: 20 + collaborators: 0 + private-user-response-with-public-profile-information: + summary: Response with public profile information + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + private-user: + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + private_gists: 81 + total_private_repos: 100 + owned_private_repos: 100 + disk_usage: 10000 + collaborators: 8 + two_factor_authentication: true + plan: + name: Medium + space: 400 + private_repos: 20 + collaborators: 0 + simple-user-items: + value: + - login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + email-items-3: + value: + - email: octocat@github.com + primary: true + verified: true + visibility: private + email-items-2: + value: + - email: octocat@github.com + verified: true + primary: true + visibility: public + email-items: + value: + - email: octocat@octocat.org + primary: false + verified: false + visibility: public + - email: octocat@github.com + primary: false + verified: false + visibility: null + - email: mona@github.com + primary: false + verified: false + visibility: null + gpg-key-items: + value: + - id: 3 + name: Octocat's GPG Key + primary_key_id: 2 + key_id: 3262EFF25BA0D270 + public_key: xsBNBFayYZ... + emails: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + can_sign: true + can_encrypt_comms: false + can_encrypt_storage: false + can_certify: true + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + raw_key: string + gpg-key: + value: + id: 3 + name: Octocat's GPG Key + primary_key_id: 2 + key_id: 3262EFF25BA0D270 + public_key: xsBNBFayYZ... + emails: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + - id: 4 + primary_key_id: 3 + key_id: 4A595D4C72EE49C7 + public_key: zsBNBFayYZ... + emails: [] + can_sign: false + can_encrypt_comms: true + can_encrypt_storage: true + can_certify: false + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + can_sign: true + can_encrypt_comms: false + can_encrypt_storage: false + can_certify: true + created_at: '2016-03-24T11:31:04-06:00' + expires_at: '2016-03-24T11:31:04-07:00' + revoked: false + raw_key: '"-----BEGIN PGP PUBLIC KEY BLOCK-----\nVersion: GnuPG v2\n\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\nIts/HFYRLiFgDLmTlxo=\n=+OzK\n-----END PGP PUBLIC KEY BLOCK-----"' + key-items: + value: + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + verified: false + read_only: false + key: + value: + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + social-account-items: + value: + - provider: twitter + url: https://twitter.com/github + ssh-signing-key-items: + value: + - id: 2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + - id: 3 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + ssh-signing-key: + value: + id: 2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + public-user-default-response: + summary: Default response + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + public-user-response-with-git-hub-plan-information: + summary: Response with GitHub plan information + value: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + name: monalisa octocat + company: GitHub + blog: https://github.com/blog + location: San Francisco + email: octocat@github.com + hireable: false + bio: There once was... + twitter_username: monatheoctocat + public_repos: 2 + public_gists: 1 + followers: 20 + following: 0 + created_at: '2008-01-14T04:33:35Z' + updated_at: '2008-01-14T04:33:35Z' + plan: + name: pro + space: 976562499 + collaborators: 0 + private_repos: 9999 + bulk-subject-digest-body: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + bulk-subject-digest-body-with-predicate-type: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + predicateType: provenance + list-attestations-bulk: + value: + attestations_subject_digests: + - sha256:abc: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + list-attestations: + value: + attestations: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\nβ€” rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + hovercard: + value: + contexts: + - message: Owns this repository + octicon: repo + key-simple-items: + value: + - id: 1 + key: ssh-rsa AAA... + headers: + link: + example: ; rel="next", ; rel="last" + schema: + type: string +servers: + - url: https://api.github.com diff --git a/website/docs/index.md b/website/docs/index.md index a52d387..5aaa1d8 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -1,80 +1,72 @@ ---- -title: github -hide_title: false -hide_table_of_contents: false -keywords: - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png -id: 'provider-intro' ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - +--- +title: github +hide_title: false +hide_table_of_contents: false +keywords: + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage GitHub resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +id: 'provider-intro' +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; + Web-based version-control and collaboration. - -:::info Provider Summary (v24.04.00227) - -
-
-total services: 31
-total methods: 885
-
-
-total resources: 281
-total selectable resources: 276
-
-
- -::: - -See also: -[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) -* * * - -## Installation - -To pull the latest version of the `github` provider, run the following command: -```bash -REGISTRY PULL github; -``` -> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). +:::info[Provider Summary] -## Authentication +total services: __44__ +total resources: __430__ -The following system environment variables are used for authentication by default: - -- - GitHub username (login) -- - GitHub Personal Access Token (see Creating a personal access token) - -These variables are sourced at runtime (from the local machine or as CI variables/secrets). - -
- -Using different environment variables - -To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: - -```bash - -AUTH='{ "github": { "type": "basic", "username_var": "YOUR_GITHUB_USERNAME_VAR", "password_var": "YOUR_GITHUB_PASSWORD_VAR" }}' -stackql shell --auth="${AUTH}" - -``` -or using PowerShell: - -```powershell - -$Auth = "{ 'github': { 'type': 'basic', 'username_var': 'YOUR_GITHUB_USERNAME_VAR', 'password_var': 'YOUR_GITHUB_PASSWORD_VAR' }}" -stackql.exe shell --auth=$Auth +::: -``` +See also: +[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe) [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry) +* * * + +## Installation + +To pull the latest version of the `github` provider, run the following command: + +```bash +REGISTRY PULL github; +``` +> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry). + +## Authentication + +The following system environment variables are used for authentication by default: + +- - GitHub username (login) +- - GitHub Personal Access Token (see Creating a personal access token) + +These variables are sourced at runtime (from the local machine or as CI variables/secrets). + +
+ +Using different environment variables + +To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program. For example: + +```bash + +AUTH='{ "github": { "type": "basic", "username_var": "YOUR_GITHUB_USERNAME_VAR", "password_var": "YOUR_GITHUB_PASSWORD_VAR" }}' +stackql shell --auth="${AUTH}" + +``` +or using PowerShell: + +```powershell + +$Auth = "{ 'github': { 'type': 'basic', 'username_var': 'YOUR_GITHUB_USERNAME_VAR', 'password_var': 'YOUR_GITHUB_PASSWORD_VAR' }}" +stackql.exe shell --auth=$Auth + +```
## Services @@ -82,27 +74,40 @@ stackql.exe shell --auth=$Auth
actions
activity
+agent_tasks
apps
billing
+campaigns
checks
+classroom
code_scanning
+code_security
codes_of_conduct
codespaces
copilot
+credentials
dependabot
dependency_graph
+emojis
+enterprise_team_memberships
+enterprise_team_organizations
+enterprise_teams
gists
git
+
+
gitignore
+hosted_compute
interactions
issues
-
-
licenses
+markdown
+meta
migrations
oidc
orgs
packages
+private_registries
projects
pulls
rate_limit
diff --git a/website/docs/services/actions/allowed_actions/index.md b/website/docs/services/actions/allowed_actions/index.md index d4b6c36..f01ac75 100644 --- a/website/docs/services/actions/allowed_actions/index.md +++ b/website/docs/services/actions/allowed_actions/index.md @@ -1,42 +1,262 @@ ---- +--- title: allowed_actions hide_title: false hide_table_of_contents: false keywords: - allowed_actions - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an allowed_actions resource. ## Overview - +
Nameallowed_actions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `boolean` | Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. | -| | `array` | Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.

**Note**: The `patterns_allowed` setting only applies to public repositories. | -| | `boolean` | Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.
arraySpecifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. > [!NOTE] > The `patterns_allowed` setting only applies to public repositories.
booleanWhether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.
arraySpecifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. > [!NOTE] > The `patterns_allowed` setting only applies to public repositories.
booleanWhether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `SELECT` | | Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. | -| | `EXEC` | | Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `EXEC` | | Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repoSets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgSets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +github_owned_allowed, +patterns_allowed, +verified_allowed +FROM github.actions.allowed_actions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +github_owned_allowed, +patterns_allowed, +verified_allowed +FROM github.actions.allowed_actions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.allowed_actions +SET +github_owned_allowed = {{ github_owned_allowed }}, +verified_allowed = {{ verified_allowed }}, +patterns_allowed = '{{ patterns_allowed }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + + +Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.allowed_actions +SET +github_owned_allowed = {{ github_owned_allowed }}, +verified_allowed = {{ verified_allowed }}, +patterns_allowed = '{{ patterns_allowed }}' +WHERE +org = '{{ org }}' --required; +``` + + diff --git a/website/docs/services/actions/artifact_log_retention/index.md b/website/docs/services/actions/artifact_log_retention/index.md new file mode 100644 index 0000000..7cf6af2 --- /dev/null +++ b/website/docs/services/actions/artifact_log_retention/index.md @@ -0,0 +1,248 @@ +--- +title: artifact_log_retention +hide_title: false +hide_table_of_contents: false +keywords: + - artifact_log_retention + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an artifact_log_retention resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number of days artifacts and logs are retained
integerThe maximum number of days that can be configured
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number of days artifacts and logs are retained
integerThe maximum number of days that can be configured
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets artifact and log retention settings for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets artifact and log retention settings for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
owner, repo, daysSets artifact and log retention settings for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, daysSets artifact and log retention settings for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets artifact and log retention settings for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +days, +maximum_allowed_days +FROM github.actions.artifact_log_retention +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets artifact and log retention settings for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +SELECT +days, +maximum_allowed_days +FROM github.actions.artifact_log_retention +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets artifact and log retention settings for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.artifact_log_retention +SET +days = {{ days }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND days = '{{ days }}' --required; +``` + + + +Sets artifact and log retention settings for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +REPLACE github.actions.artifact_log_retention +SET +days = {{ days }} +WHERE +org = '{{ org }}' --required +AND days = '{{ days }}' --required; +``` + + diff --git a/website/docs/services/actions/artifacts/index.md b/website/docs/services/actions/artifacts/index.md index cf9bb73..540450b 100644 --- a/website/docs/services/actions/artifacts/index.md +++ b/website/docs/services/actions/artifacts/index.md @@ -1,51 +1,369 @@ ---- +--- title: artifacts hide_title: false hide_table_of_contents: false keywords: - artifacts - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an artifacts resource. ## Overview - +
Nameartifacts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The name of the artifact. | -| | `string` | | -| | `string` | | -| | `boolean` | Whether or not the artifact has expired. | -| | `string` | | -| | `string` | | -| | `integer` | The size in bytes of the artifact. | -| | `string` | | -| | `string` | | -| | `object` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe name of the artifact. (example: AdventureWorks.Framework)
string (example: MDEwOkNoZWNrU3VpdGU1)
string (example: https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip)
string (date-time)
stringThe SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. (example: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c)
booleanWhether or not the artifact has expired.
string (date-time)
integerThe size in bytes of the artifact.
string (date-time)
string (example: https://api.github.com/repos/github/hello-world/actions/artifacts/5)
object
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `DELETE` | | Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in
the response header to find the URL for the download. The `:archive_format` must be `zip`.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:read` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, artifact_idGets a specific artifact for a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_idper_page, page, name, directionLists artifacts for a workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repoper_page, page, nameLists all artifacts for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, artifact_idDeletes an artifact for a workflow run.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the artifact.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
stringThe direction to sort the results by.
stringThe name field of an artifact. When specified, only artifacts with this name will be returned.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a specific artifact for a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +name, +node_id, +archive_download_url, +created_at, +digest, +expired, +expires_at, +size_in_bytes, +updated_at, +url, +workflow_run +FROM github.actions.artifacts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND artifact_id = '{{ artifact_id }}' -- required +; +``` + + + +Lists artifacts for a workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +artifacts, +total_count +FROM github.actions.artifacts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND name = '{{ name }}' +AND direction = '{{ direction }}' +; +``` + + + +Lists all artifacts for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +artifacts, +total_count +FROM github.actions.artifacts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND name = '{{ name }}' +; +``` + + + + +## `DELETE` examples + + + + +Deletes an artifact for a workflow run.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.artifacts +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND artifact_id = '{{ artifact_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/cache/index.md b/website/docs/services/actions/cache/index.md index e43ae9e..53b9f7e 100644 --- a/website/docs/services/actions/cache/index.md +++ b/website/docs/services/actions/cache/index.md @@ -1,40 +1,239 @@ ---- +--- title: cache hide_title: false hide_table_of_contents: false keywords: - cache - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a cache resource. ## Overview - +
Namecache
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | Array of caches | -| | `integer` | Total number of caches | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayArray of caches
integerTotal number of caches
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the GitHub Actions caches for a repository.
You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `DELETE` | | Deletes a GitHub Actions cache for a repository, using a cache ID.

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

GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `DELETE` | | Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

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

GitHub Apps must have the `actions:write` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, page, ref, key, sort, directionLists the GitHub Actions caches for a repository.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, cache_idDeletes a GitHub Actions cache for a repository, using a cache ID.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, keyrefDeletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the GitHub Actions cache.
stringA key for identifying the cache.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe direction to sort the results by.
stringAn explicit key or prefix for identifying the cache
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`.
stringThe property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes.
+ +## `SELECT` examples + + + + +Lists the GitHub Actions caches for a repository.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +actions_caches, +total_count +FROM github.actions.cache +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND ref = '{{ ref }}' +AND key = '{{ key }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +; +``` + + + + +## `DELETE` examples + + + + +Deletes a GitHub Actions cache for a repository, using a cache ID.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.cache +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND cache_id = '{{ cache_id }}' --required +; +``` + + + +Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.cache +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND key = '{{ key }}' --required +AND ref = '{{ ref }}' +; +``` + + diff --git a/website/docs/services/actions/cache_retention_limit/index.md b/website/docs/services/actions/cache_retention_limit/index.md new file mode 100644 index 0000000..270b662 --- /dev/null +++ b/website/docs/services/actions/cache_retention_limit/index.md @@ -0,0 +1,301 @@ +--- +title: cache_retention_limit +hide_title: false +hide_table_of_contents: false +keywords: + - cache_retention_limit + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a cache_retention_limit resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe maximum number of days to keep caches in this repository.
+ + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerFor repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.
+ + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerFor repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if
not manually removed or evicted due to size constraints.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.
enterpriseGets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
orgGets GitHub Actions cache retention limit for an organization. All repositories under this
organization may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
owner, repoSets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if
not manually removed or evicted due to size constraints.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.
enterpriseSets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
orgSets GitHub Actions cache retention limit for an organization. All repositories under this
organization may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if
not manually removed or evicted due to size constraints.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + +```sql +SELECT +max_cache_retention_days +FROM github.actions.cache_retention_limit +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +SELECT +max_cache_retention_days +FROM github.actions.cache_retention_limit +WHERE enterprise = '{{ enterprise }}' -- required +; +``` + + + +Gets GitHub Actions cache retention limit for an organization. All repositories under this
organization may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + +```sql +SELECT +max_cache_retention_days +FROM github.actions.cache_retention_limit +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if
not manually removed or evicted due to size constraints.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + +```sql +REPLACE github.actions.cache_retention_limit +SET +max_cache_retention_days = {{ max_cache_retention_days }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + + +Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +REPLACE github.actions.cache_retention_limit +SET +max_cache_retention_days = {{ max_cache_retention_days }} +WHERE +enterprise = '{{ enterprise }}' --required; +``` + + + +Sets GitHub Actions cache retention limit for an organization. All repositories under this
organization may not set a higher cache retention limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + +```sql +REPLACE github.actions.cache_retention_limit +SET +max_cache_retention_days = {{ max_cache_retention_days }} +WHERE +org = '{{ org }}' --required; +``` + + diff --git a/website/docs/services/actions/cache_storage_limit/index.md b/website/docs/services/actions/cache_storage_limit/index.md new file mode 100644 index 0000000..b8cf252 --- /dev/null +++ b/website/docs/services/actions/cache_storage_limit/index.md @@ -0,0 +1,301 @@ +--- +title: cache_storage_limit +hide_title: false +hide_table_of_contents: false +keywords: + - cache_storage_limit + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a cache_storage_limit resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe maximum total cache size for this repository, in gigabytes.
+ + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerFor repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.
+ + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerFor repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be
stored before eviction occurs.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.
enterpriseGets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
orgGets GitHub Actions cache storage limit for an organization. All repositories under this
organization may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
owner, repoSets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be
stored before eviction occurs.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.
enterpriseSets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
orgSets GitHub Actions cache storage limit for an organization. All organizations and repositories under this
organization may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be
stored before eviction occurs.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + +```sql +SELECT +max_cache_size_gb +FROM github.actions.cache_storage_limit +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +SELECT +max_cache_size_gb +FROM github.actions.cache_storage_limit +WHERE enterprise = '{{ enterprise }}' -- required +; +``` + + + +Gets GitHub Actions cache storage limit for an organization. All repositories under this
organization may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + +```sql +SELECT +max_cache_size_gb +FROM github.actions.cache_storage_limit +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be
stored before eviction occurs.

OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + +```sql +REPLACE github.actions.cache_storage_limit +SET +max_cache_size_gb = {{ max_cache_size_gb }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + + +Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this
enterprise may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +REPLACE github.actions.cache_storage_limit +SET +max_cache_size_gb = {{ max_cache_size_gb }} +WHERE +enterprise = '{{ enterprise }}' --required; +``` + + + +Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this
organization may not set a higher cache storage limit.

OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + +```sql +REPLACE github.actions.cache_storage_limit +SET +max_cache_size_gb = {{ max_cache_size_gb }} +WHERE +org = '{{ org }}' --required; +``` + + diff --git a/website/docs/services/actions/cache_usage/index.md b/website/docs/services/actions/cache_usage/index.md index 293ad9a..fa96d31 100644 --- a/website/docs/services/actions/cache_usage/index.md +++ b/website/docs/services/actions/cache_usage/index.md @@ -1,40 +1,201 @@ ---- +--- title: cache_usage hide_title: false hide_table_of_contents: false keywords: - cache_usage - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a cache_usage resource. ## Overview - +
Namecache_usage
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The number of active caches in the repository. | -| | `integer` | The sum of the size in bytes of all the active cache items in the repository. | -| | `string` | The repository owner and name for the cache usage being shown. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe repository owner and name for the cache usage being shown. (example: octo-org/Hello-World)
integerThe number of active caches in the repository.
integerThe sum of the size in bytes of all the active cache items in the repository.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe count of active caches across all repositories of an enterprise or an organization.
integerThe total size in bytes of all active cache items across all repositories of an enterprise or an organization.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Gets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets GitHub Actions cache usage for a repository.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +full_name, +active_caches_count, +active_caches_size_in_bytes +FROM github.actions.cache_usage +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets the total GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +total_active_caches_count, +total_active_caches_size_in_bytes +FROM github.actions.cache_usage +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/default_workflow_permissions/index.md b/website/docs/services/actions/default_workflow_permissions/index.md index a9fef2b..762136f 100644 --- a/website/docs/services/actions/default_workflow_permissions/index.md +++ b/website/docs/services/actions/default_workflow_permissions/index.md @@ -1,41 +1,248 @@ ---- +--- title: default_workflow_permissions hide_title: false hide_table_of_contents: false keywords: - default_workflow_permissions - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a default_workflow_permissions resource. ## Overview - +
Namedefault_workflow_permissions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `boolean` | Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. | -| | `string` | The default workflow permissions granted to the GITHUB_TOKEN when running workflows. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether GitHub Actions can approve pull requests. Enabling this can be a security risk.
stringThe default workflow permissions granted to the GITHUB_TOKEN when running workflows. (read, write)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether GitHub Actions can approve pull requests. Enabling this can be a security risk.
stringThe default workflow permissions granted to the GITHUB_TOKEN when running workflows. (read, write)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `SELECT` | | Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. | -| | `EXEC` | | Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `EXEC` | | Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repoSets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgSets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,
as well as if GitHub Actions can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +can_approve_pull_request_reviews, +default_workflow_permissions +FROM github.actions.default_workflow_permissions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,
as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +can_approve_pull_request_reviews, +default_workflow_permissions +FROM github.actions.default_workflow_permissions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions
can submit approving pull request reviews.
For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.default_workflow_permissions +SET +default_workflow_permissions = '{{ default_workflow_permissions }}', +can_approve_pull_request_reviews = {{ can_approve_pull_request_reviews }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + + +Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
can submit approving pull request reviews. For more information, see
"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.default_workflow_permissions +SET +default_workflow_permissions = '{{ default_workflow_permissions }}', +can_approve_pull_request_reviews = {{ can_approve_pull_request_reviews }} +WHERE +org = '{{ org }}' --required; +``` + + diff --git a/website/docs/services/actions/enabled_repos/index.md b/website/docs/services/actions/enabled_repos/index.md index 693f910..5110857 100644 --- a/website/docs/services/actions/enabled_repos/index.md +++ b/website/docs/services/actions/enabled_repos/index.md @@ -1,41 +1,234 @@ ---- +--- title: enabled_repos hide_title: false hide_table_of_contents: false keywords: - enabled_repos - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an enabled_repos resource. ## Overview - +
Nameenabled_repos
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `number` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
number
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `EXEC` | | Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `EXEC` | | Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `EXEC` | | Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageLists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, repository_idAdds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, selected_repository_idsReplaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."


OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, repository_idRemoves a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the repository.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.actions.enabled_repos +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.enabled_repos +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required; +``` + + + +Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."


OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.enabled_repos +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.actions.enabled_repos +WHERE org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/environment_secrets/index.md b/website/docs/services/actions/environment_secrets/index.md deleted file mode 100644 index b6f902b..0000000 --- a/website/docs/services/actions/environment_secrets/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: environment_secrets -hide_title: false -hide_table_of_contents: false -keywords: - - environment_secrets - - actions - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameenvironment_secrets
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret. | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single environment secret without revealing its encrypted value.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `SELECT` | | Lists all secrets available in an environment without revealing their
encrypted values.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `INSERT` | | Creates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `DELETE` | | Deletes a secret in an environment using the secret name.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | diff --git a/website/docs/services/actions/fork_pr_contributor_approval_permissions/index.md b/website/docs/services/actions/fork_pr_contributor_approval_permissions/index.md new file mode 100644 index 0000000..734ce0d --- /dev/null +++ b/website/docs/services/actions/fork_pr_contributor_approval_permissions/index.md @@ -0,0 +1,168 @@ +--- +title: fork_pr_contributor_approval_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - fork_pr_contributor_approval_permissions + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a fork_pr_contributor_approval_permissions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe policy that controls when fork PR workflows require approval from a maintainer. (first_time_contributors_new_to_github, first_time_contributors, all_external_contributors)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the fork PR contributor approval policy for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, approval_policySets the fork PR contributor approval policy for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the fork PR contributor approval policy for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +approval_policy +FROM github.actions.fork_pr_contributor_approval_permissions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the fork PR contributor approval policy for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.fork_pr_contributor_approval_permissions +SET +approval_policy = '{{ approval_policy }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND approval_policy = '{{ approval_policy }}' --required; +``` + + diff --git a/website/docs/services/actions/fork_pr_workflows_private_repos_settings/index.md b/website/docs/services/actions/fork_pr_workflows_private_repos_settings/index.md new file mode 100644 index 0000000..4f733dd --- /dev/null +++ b/website/docs/services/actions/fork_pr_workflows_private_repos_settings/index.md @@ -0,0 +1,189 @@ +--- +title: fork_pr_workflows_private_repos_settings +hide_title: false +hide_table_of_contents: false +keywords: + - fork_pr_workflows_private_repos_settings + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a fork_pr_workflows_private_repos_settings resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether workflows triggered by pull requests from forks require approval from a repository administrator to run.
booleanWhether workflows triggered by pull requests from forks are allowed to run on private repositories.
booleanWhether to make secrets and variables available to workflows triggered by pull requests from forks.
booleanWhether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the settings for whether workflows from fork pull requests can run on a private repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_workflows_from_fork_pull_requestsSets the settings for whether workflows from fork pull requests can run on a private repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the settings for whether workflows from fork pull requests can run on a private repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +require_approval_for_fork_pr_workflows, +run_workflows_from_fork_pull_requests, +send_secrets_and_variables, +send_write_tokens_to_workflows +FROM github.actions.fork_pr_workflows_private_repos_settings +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the settings for whether workflows from fork pull requests can run on a private repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.fork_pr_workflows_private_repos_settings +SET +run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }}, +send_write_tokens_to_workflows = {{ send_write_tokens_to_workflows }}, +send_secrets_and_variables = {{ send_secrets_and_variables }}, +require_approval_for_fork_pr_workflows = {{ require_approval_for_fork_pr_workflows }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }} --required; +``` + + diff --git a/website/docs/services/actions/index.md b/website/docs/services/actions/index.md index 4947e18..64a8eeb 100644 --- a/website/docs/services/actions/index.md +++ b/website/docs/services/actions/index.md @@ -9,60 +9,65 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Endpoints To Manage GitHub Actions Using The REST API. - -:::info Service Summary +actions service documentation. -
-
-total resources: 32
-total selectable resources: 31
-total methods: 123
-
-
+:::info[Service Summary] -::: +total resources: __52__ -## Overview - - - - - - -
Namegithub.actions
TypeService
TitleGitHub V3 REST API - Actions
DescriptionEndpoints To Manage GitHub Actions Using The REST API.
Idactions:v24.04.00227
+::: ## Resources
allowed_actions
+artifact_log_retention
artifacts
cache
+cache_retention_limit
+cache_storage_limit
cache_usage
default_workflow_permissions
enabled_repos
-environment_secrets
+fork_pr_contributor_approval_permissions
+fork_pr_workflows_private_repos_settings
oidc
org_cache_usage
-org_permissions
-org_secrets
-org_variables
+org_fork_pr_contributor_approval_permissions
+org_fork_pr_workflows_private_repos_settings
+org_hosted_runner_custom_image_versions
+org_hosted_runner_custom_images
+org_hosted_runner_github_images
+org_hosted_runner_limits
+org_hosted_runner_machine_specs
+org_hosted_runner_partner_images
+org_hosted_runner_platforms
+org_hosted_runners
+org_runner_group_hosted_runners
+org_runner_group_repos
+org_runner_group_runners +
+
+org_runner_groups
+org_self_hosted_runner_repo_access
+org_self_hosted_runners_permissions
pending_deployments_for_run
permissions
public_keys
repo_org_secrets
-
-
repo_org_variables
repos_for_org_variable
repos_for_secret
runner_applications
+runner_jit_configs
runner_labels
+runner_registration_tokens
+runner_remove_tokens
secrets
self_hosted_runners
variables
@@ -73,6 +78,6 @@ Endpoints To Manage GitHub Actions Using The REST API. workflow_run_usage
workflow_runs
workflow_usage
-workflows
-
+workflows
+
\ No newline at end of file diff --git a/website/docs/services/actions/oidc/index.md b/website/docs/services/actions/oidc/index.md index 24c5c7e..8fbe855 100644 --- a/website/docs/services/actions/oidc/index.md +++ b/website/docs/services/actions/oidc/index.md @@ -1,39 +1,175 @@ ---- +--- title: oidc hide_title: false hide_table_of_contents: false keywords: - oidc - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an oidc resource. ## Overview - +
Nameoidc
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. | -| | `boolean` | Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. | + +The following fields are returned by `SELECT` queries: + + + + +Status response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayArray of unique strings. Each claim key can only contain alphanumeric characters and underscores.
booleanWhether to use the default template or not. If `true`, the `include_claim_keys` field is ignored.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `repo` scope to use this
endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. | -| | `EXEC` | | Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.
You must authenticate using an access token with the `repo` scope to use this
endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, use_defaultSets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +include_claim_keys, +use_default +FROM github.actions.oidc +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.oidc +SET +use_default = {{ use_default }}, +include_claim_keys = '{{ include_claim_keys }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND use_default = {{ use_default }} --required; +``` + + diff --git a/website/docs/services/actions/org_cache_usage/index.md b/website/docs/services/actions/org_cache_usage/index.md index fd5d6da..2803dab 100644 --- a/website/docs/services/actions/org_cache_usage/index.md +++ b/website/docs/services/actions/org_cache_usage/index.md @@ -1,38 +1,148 @@ ---- +--- title: org_cache_usage hide_title: false hide_table_of_contents: false keywords: - org_cache_usage - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an org_cache_usage resource. ## Overview - +
Nameorg_cache_usage
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageLists repositories and their GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists repositories and their GitHub Actions cache usage for an organization.
The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +repository_cache_usages, +total_count +FROM github.actions.org_cache_usage +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/actions/org_fork_pr_contributor_approval_permissions/index.md b/website/docs/services/actions/org_fork_pr_contributor_approval_permissions/index.md new file mode 100644 index 0000000..68404fd --- /dev/null +++ b/website/docs/services/actions/org_fork_pr_contributor_approval_permissions/index.md @@ -0,0 +1,161 @@ +--- +title: org_fork_pr_contributor_approval_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - org_fork_pr_contributor_approval_permissions + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_fork_pr_contributor_approval_permissions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe policy that controls when fork PR workflows require approval from a maintainer. (first_time_contributors_new_to_github, first_time_contributors, all_external_contributors)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGets the fork PR contributor approval policy for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
org, approval_policySets the fork PR contributor approval policy for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the fork PR contributor approval policy for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +SELECT +approval_policy +FROM github.actions.org_fork_pr_contributor_approval_permissions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the fork PR contributor approval policy for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.org_fork_pr_contributor_approval_permissions +SET +approval_policy = '{{ approval_policy }}' +WHERE +org = '{{ org }}' --required +AND approval_policy = '{{ approval_policy }}' --required; +``` + + diff --git a/website/docs/services/actions/org_fork_pr_workflows_private_repos_settings/index.md b/website/docs/services/actions/org_fork_pr_workflows_private_repos_settings/index.md new file mode 100644 index 0000000..cb016ea --- /dev/null +++ b/website/docs/services/actions/org_fork_pr_workflows_private_repos_settings/index.md @@ -0,0 +1,182 @@ +--- +title: org_fork_pr_workflows_private_repos_settings +hide_title: false +hide_table_of_contents: false +keywords: + - org_fork_pr_workflows_private_repos_settings + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_fork_pr_workflows_private_repos_settings resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether workflows triggered by pull requests from forks require approval from a repository administrator to run.
booleanWhether workflows triggered by pull requests from forks are allowed to run on private repositories.
booleanWhether to make secrets and variables available to workflows triggered by pull requests from forks.
booleanWhether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGets the settings for whether workflows from fork pull requests can run on private repositories in an organization.
org, run_workflows_from_fork_pull_requestsSets the settings for whether workflows from fork pull requests can run on private repositories in an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + +```sql +SELECT +require_approval_for_fork_pr_workflows, +run_workflows_from_fork_pull_requests, +send_secrets_and_variables, +send_write_tokens_to_workflows +FROM github.actions.org_fork_pr_workflows_private_repos_settings +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + +```sql +REPLACE github.actions.org_fork_pr_workflows_private_repos_settings +SET +run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }}, +send_write_tokens_to_workflows = {{ send_write_tokens_to_workflows }}, +send_secrets_and_variables = {{ send_secrets_and_variables }}, +require_approval_for_fork_pr_workflows = {{ require_approval_for_fork_pr_workflows }} +WHERE +org = '{{ org }}' --required +AND run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }} --required; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_custom_image_versions/index.md b/website/docs/services/actions/org_hosted_runner_custom_image_versions/index.md new file mode 100644 index 0000000..d63f260 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_custom_image_versions/index.md @@ -0,0 +1,245 @@ +--- +title: org_hosted_runner_custom_image_versions +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_custom_image_versions + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_custom_image_versions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe creation date time of the image version. (example: 2024-11-09T23:39:01Z)
integerImage version size in GB.
stringThe state of image version. (example: Ready)
stringThe image version status details. (example: None)
stringThe version of image. (example: 1.0.0)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, image_definition_id, versionGet an image version of a custom image for GitHub Actions Hosted Runners.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
image_definition_id, orgList image versions of a custom image for an organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
org, image_definition_id, versionDelete an image version of custom image from the organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerImage definition ID of custom image
stringThe organization name. The name is not case sensitive.
stringVersion of a custom image
+ +## `SELECT` examples + + + + +Get an image version of a custom image for GitHub Actions Hosted Runners.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +SELECT +created_on, +size_gb, +state, +state_details, +version +FROM github.actions.org_hosted_runner_custom_image_versions +WHERE org = '{{ org }}' -- required +AND image_definition_id = '{{ image_definition_id }}' -- required +AND version = '{{ version }}' -- required +; +``` + + + +List image versions of a custom image for an organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +SELECT +image_versions, +total_count +FROM github.actions.org_hosted_runner_custom_image_versions +WHERE image_definition_id = '{{ image_definition_id }}' -- required +AND org = '{{ org }}' -- required +; +``` + + + + +## `DELETE` examples + + + + +Delete an image version of custom image from the organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +DELETE FROM github.actions.org_hosted_runner_custom_image_versions +WHERE org = '{{ org }}' --required +AND image_definition_id = '{{ image_definition_id }}' --required +AND version = '{{ version }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_custom_images/index.md b/website/docs/services/actions/org_hosted_runner_custom_images/index.md new file mode 100644 index 0000000..1da7d2e --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_custom_images/index.md @@ -0,0 +1,255 @@ +--- +title: org_hosted_runner_custom_images +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_custom_images + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_custom_images resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the image. Use this ID for the `image` parameter when creating a new larger runner.
stringDisplay name for this image. (example: CustomImage)
stringThe latest image version associated with the image. (example: 1.3.0)
stringThe operating system of the image. (example: linux-x64)
stringThe image provider. (example: custom)
stringThe number of image versions associated with the image. (example: Ready)
integerTotal size of all the image versions in GB.
integerThe number of image versions associated with the image.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, image_definition_idGet a custom image definition for GitHub Actions Hosted Runners.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
orgList custom images for an organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
org, image_definition_idDelete a custom image from the organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerImage definition ID of custom image
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get a custom image definition for GitHub Actions Hosted Runners.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +latest_version, +platform, +source, +state, +total_versions_size, +versions_count +FROM github.actions.org_hosted_runner_custom_images +WHERE org = '{{ org }}' -- required +AND image_definition_id = '{{ image_definition_id }}' -- required +; +``` + + + +List custom images for an organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +SELECT +images, +total_count +FROM github.actions.org_hosted_runner_custom_images +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `DELETE` examples + + + + +Delete a custom image from the organization.

OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +DELETE FROM github.actions.org_hosted_runner_custom_images +WHERE org = '{{ org }}' --required +AND image_definition_id = '{{ image_definition_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_github_images/index.md b/website/docs/services/actions/org_hosted_runner_github_images/index.md new file mode 100644 index 0000000..36f9446 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_github_images/index.md @@ -0,0 +1,136 @@ +--- +title: org_hosted_runner_github_images +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_github_images + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_github_images resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGet the list of GitHub-owned images available for GitHub-hosted runners for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + +```sql +SELECT +images, +total_count +FROM github.actions.org_hosted_runner_github_images +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_limits/index.md b/website/docs/services/actions/org_hosted_runner_limits/index.md new file mode 100644 index 0000000..bdf3ff4 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_limits/index.md @@ -0,0 +1,136 @@ +--- +title: org_hosted_runner_limits +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_limits + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_limits resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe current number of static public IP addresses in use by Hosted Runners.
integerThe maximum number of static public IP addresses that can be used for Hosted Runners.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGet the GitHub-hosted runners limits for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the GitHub-hosted runners limits for an organization. + +```sql +SELECT +current_usage, +maximum +FROM github.actions.org_hosted_runner_limits +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_machine_specs/index.md b/website/docs/services/actions/org_hosted_runner_machine_specs/index.md new file mode 100644 index 0000000..cefda53 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_machine_specs/index.md @@ -0,0 +1,136 @@ +--- +title: org_hosted_runner_machine_specs +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_machine_specs + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_machine_specs resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGet the list of machine specs available for GitHub-hosted runners for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the list of machine specs available for GitHub-hosted runners for an organization. + +```sql +SELECT +machine_specs, +total_count +FROM github.actions.org_hosted_runner_machine_specs +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_partner_images/index.md b/website/docs/services/actions/org_hosted_runner_partner_images/index.md new file mode 100644 index 0000000..65d0c84 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_partner_images/index.md @@ -0,0 +1,136 @@ +--- +title: org_hosted_runner_partner_images +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_partner_images + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_partner_images resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGet the list of partner images available for GitHub-hosted runners for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the list of partner images available for GitHub-hosted runners for an organization. + +```sql +SELECT +images, +total_count +FROM github.actions.org_hosted_runner_partner_images +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runner_platforms/index.md b/website/docs/services/actions/org_hosted_runner_platforms/index.md new file mode 100644 index 0000000..86b10b1 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runner_platforms/index.md @@ -0,0 +1,136 @@ +--- +title: org_hosted_runner_platforms +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runner_platforms + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runner_platforms resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGet the list of platforms available for GitHub-hosted runners for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the list of platforms available for GitHub-hosted runners for an organization. + +```sql +SELECT +platforms, +total_count +FROM github.actions.org_hosted_runner_platforms +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/org_hosted_runners/index.md b/website/docs/services/actions/org_hosted_runners/index.md new file mode 100644 index 0000000..dbbe081 --- /dev/null +++ b/website/docs/services/actions/org_hosted_runners/index.md @@ -0,0 +1,443 @@ +--- +title: org_hosted_runners +hide_title: false +hide_table_of_contents: false +keywords: + - org_hosted_runners + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_hosted_runners resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hosted runner.
stringThe name of the hosted runner. (example: my-github-hosted-runner)
integerThe unique identifier of the group that the hosted runner belongs to.
objectProvides details of a hosted runner image (title: GitHub-hosted runner image details.)
booleanWhether custom image generation is enabled for the hosted runners.
string (date-time)The time at which the runner was last used, in ISO 8601 format. (example: 2022-10-09T23:39:01Z)
objectProvides details of a particular machine spec. (title: Github-owned VM details.)
integerThe maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost.
stringThe operating system of the image. (example: linux-x64)
booleanWhether public IP is enabled for the hosted runners.
arrayThe public IP ranges when public IP is enabled for the hosted runners.
stringThe status of the runner. (Ready, Provisioning, Shutdown, Deleting, Stuck) (example: Ready)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, hosted_runner_idGets a GitHub-hosted runner configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
orgper_page, pageLists all GitHub-hosted runners configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint.
org, name, image, size, runner_group_idCreates a GitHub-hosted runner for an organization.
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
org, hosted_runner_idUpdates a GitHub-hosted runner for an organization.
OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint.
org, hosted_runner_idDeletes a GitHub-hosted runner for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the GitHub-hosted runner.
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a GitHub-hosted runner configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +runner_group_id, +image_details, +image_gen, +last_active_on, +machine_size_details, +maximum_runners, +platform, +public_ip_enabled, +public_ips, +status +FROM github.actions.org_hosted_runners +WHERE org = '{{ org }}' -- required +AND hosted_runner_id = '{{ hosted_runner_id }}' -- required +; +``` + + + +Lists all GitHub-hosted runners configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + +```sql +SELECT +runners, +total_count +FROM github.actions.org_hosted_runners +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a GitHub-hosted runner for an organization.
OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +INSERT INTO github.actions.org_hosted_runners ( +name, +image, +size, +runner_group_id, +maximum_runners, +enable_static_ip, +image_gen, +org +) +SELECT +'{{ name }}' /* required */, +'{{ image }}' /* required */, +'{{ size }}' /* required */, +{{ runner_group_id }} /* required */, +{{ maximum_runners }}, +{{ enable_static_ip }}, +{{ image_gen }}, +'{{ org }}' +RETURNING +id, +name, +runner_group_id, +image_details, +image_gen, +last_active_on, +machine_size_details, +maximum_runners, +platform, +public_ip_enabled, +public_ips, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_hosted_runners + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_hosted_runners resource. + - name: name + value: "{{ name }}" + description: | + Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + - name: image + description: | + The image of runner. To list all available images, use \`GET /actions/hosted-runners/images/github-owned\` or \`GET /actions/hosted-runners/images/partner\`. + value: + id: "{{ id }}" + source: "{{ source }}" + version: "{{ version }}" + - name: size + value: "{{ size }}" + description: | + The machine size of the runner. To list available sizes, use \`GET actions/hosted-runners/machine-sizes\` + - name: runner_group_id + value: {{ runner_group_id }} + description: | + The existing runner group to add this runner to. + - name: maximum_runners + value: {{ maximum_runners }} + description: | + The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. + - name: enable_static_ip + value: {{ enable_static_ip }} + description: | + Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use \`GET actions/hosted-runners/limits\` + - name: image_gen + value: {{ image_gen }} + description: | + Whether this runner should be used to generate custom images. + default: false +`} + + + + + +## `UPDATE` examples + + + + +Updates a GitHub-hosted runner for an organization.
OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + +```sql +UPDATE github.actions.org_hosted_runners +SET +name = '{{ name }}', +runner_group_id = {{ runner_group_id }}, +maximum_runners = {{ maximum_runners }}, +enable_static_ip = {{ enable_static_ip }}, +size = '{{ size }}', +image_id = '{{ image_id }}', +image_version = '{{ image_version }}' +WHERE +org = '{{ org }}' --required +AND hosted_runner_id = '{{ hosted_runner_id }}' --required +RETURNING +id, +name, +runner_group_id, +image_details, +image_gen, +last_active_on, +machine_size_details, +maximum_runners, +platform, +public_ip_enabled, +public_ips, +status; +``` + + + + +## `DELETE` examples + + + + +Deletes a GitHub-hosted runner for an organization. + +```sql +DELETE FROM github.actions.org_hosted_runners +WHERE org = '{{ org }}' --required +AND hosted_runner_id = '{{ hosted_runner_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_permissions/index.md b/website/docs/services/actions/org_permissions/index.md deleted file mode 100644 index 03f1b4b..0000000 --- a/website/docs/services/actions/org_permissions/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: org_permissions -hide_title: false -hide_table_of_contents: false -keywords: - - org_permissions - - actions - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_permissions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The permissions policy that controls the actions and reusable workflows that are allowed to run. | -| | `string` | The policy that controls the repositories in the organization that are allowed to run GitHub Actions. | -| | `string` | The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. | -| | `string` | The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | -| | `EXEC` | | Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. | diff --git a/website/docs/services/actions/org_runner_group_hosted_runners/index.md b/website/docs/services/actions/org_runner_group_hosted_runners/index.md new file mode 100644 index 0000000..6358917 --- /dev/null +++ b/website/docs/services/actions/org_runner_group_hosted_runners/index.md @@ -0,0 +1,154 @@ +--- +title: org_runner_group_hosted_runners +hide_title: false +hide_table_of_contents: false +keywords: + - org_runner_group_hosted_runners + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_runner_group_hosted_runners resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
number
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, runner_group_idper_page, pageLists the GitHub-hosted runners in an organization group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerUnique identifier of the self-hosted runner group.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the GitHub-hosted runners in an organization group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +runners, +total_count +FROM github.actions.org_runner_group_hosted_runners +WHERE org = '{{ org }}' -- required +AND runner_group_id = '{{ runner_group_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/actions/org_runner_group_repos/index.md b/website/docs/services/actions/org_runner_group_repos/index.md new file mode 100644 index 0000000..90c4fda --- /dev/null +++ b/website/docs/services/actions/org_runner_group_repos/index.md @@ -0,0 +1,243 @@ +--- +title: org_runner_group_repos +hide_title: false +hide_table_of_contents: false +keywords: + - org_runner_group_repos + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_runner_group_repos resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
number
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, runner_group_idpage, per_pageLists the repositories with access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, repository_idAdds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/manage-access)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, selected_repository_idsReplaces the list of repositories that have access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, repository_idRemoves a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/manage-access)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the repository.
integerUnique identifier of the self-hosted runner group.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the repositories with access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.actions.org_runner_group_repos +WHERE org = '{{ org }}' -- required +AND runner_group_id = '{{ runner_group_id }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/manage-access)."

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.org_runner_group_repos +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND repository_id = '{{ repository_id }}' --required; +``` + + + +Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.org_runner_group_repos +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/manage-access)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.actions.org_runner_group_repos +WHERE org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_runner_group_runners/index.md b/website/docs/services/actions/org_runner_group_runners/index.md new file mode 100644 index 0000000..4a969db --- /dev/null +++ b/website/docs/services/actions/org_runner_group_runners/index.md @@ -0,0 +1,243 @@ +--- +title: org_runner_group_runners +hide_title: false +hide_table_of_contents: false +keywords: + - org_runner_group_runners + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_runner_group_runners resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
number
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, runner_group_idper_page, pageLists self-hosted runners that are in a specific organization group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, runner_idAdds a self-hosted runner to a runner group configured in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, runnersReplaces the list of self-hosted runners that are part of an organization runner group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, runner_idRemoves a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerUnique identifier of the self-hosted runner group.
integerUnique identifier of the self-hosted runner.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists self-hosted runners that are in a specific organization group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +runners, +total_count +FROM github.actions.org_runner_group_runners +WHERE org = '{{ org }}' -- required +AND runner_group_id = '{{ runner_group_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Adds a self-hosted runner to a runner group configured in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.org_runner_group_runners +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND runner_id = '{{ runner_id }}' --required; +``` + + + +Replaces the list of self-hosted runners that are part of an organization runner group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.org_runner_group_runners +SET +runners = '{{ runners }}' +WHERE +org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND runners = '{{ runners }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.actions.org_runner_group_runners +WHERE org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND runner_id = '{{ runner_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_runner_groups/index.md b/website/docs/services/actions/org_runner_groups/index.md new file mode 100644 index 0000000..1e068b6 --- /dev/null +++ b/website/docs/services/actions/org_runner_groups/index.md @@ -0,0 +1,474 @@ +--- +title: org_runner_groups +hide_title: false +hide_table_of_contents: false +keywords: + - org_runner_groups + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_runner_groups resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
number
string
stringThe identifier of a hosted compute network configuration.
boolean
boolean
string
boolean
boolean
booleanIf `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
string
stringLink to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`
arrayList of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
string
booleanIf `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
number
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, runner_group_idGets a specific self-hosted runner group for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
orgper_page, page, visible_to_repositoryLists all self-hosted runner groups configured in an organization and inherited from an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, nameCreates a new self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_id, nameUpdates the `name` and `visibility` of a self-hosted runner group in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, runner_group_idDeletes a self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerUnique identifier of the self-hosted runner group.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringOnly return runner groups that are allowed to be used by this repository.
+ +## `SELECT` examples + + + + +Gets a specific self-hosted runner group for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +network_configuration_id, +allows_public_repositories, +default, +hosted_runners_url, +inherited, +inherited_allows_public_repositories, +restricted_to_workflows, +runners_url, +selected_repositories_url, +selected_workflows, +visibility, +workflow_restrictions_read_only +FROM github.actions.org_runner_groups +WHERE org = '{{ org }}' -- required +AND runner_group_id = '{{ runner_group_id }}' -- required +; +``` + + + +Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +runner_groups, +total_count +FROM github.actions.org_runner_groups +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND visible_to_repository = '{{ visible_to_repository }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a new self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.actions.org_runner_groups ( +name, +visibility, +selected_repository_ids, +runners, +allows_public_repositories, +restricted_to_workflows, +selected_workflows, +network_configuration_id, +org +) +SELECT +'{{ name }}' /* required */, +'{{ visibility }}', +'{{ selected_repository_ids }}', +'{{ runners }}', +{{ allows_public_repositories }}, +{{ restricted_to_workflows }}, +'{{ selected_workflows }}', +'{{ network_configuration_id }}', +'{{ org }}' +RETURNING +id, +name, +network_configuration_id, +allows_public_repositories, +default, +hosted_runners_url, +inherited, +inherited_allows_public_repositories, +restricted_to_workflows, +runners_url, +selected_repositories_url, +selected_workflows, +visibility, +workflow_restrictions_read_only +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_runner_groups + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_runner_groups resource. + - name: name + value: "{{ name }}" + description: | + Name of the runner group. + - name: visibility + value: "{{ visibility }}" + description: | + Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + valid_values: ['selected', 'all', 'private'] + default: all + - name: selected_repository_ids + value: + - {{ selected_repository_ids }} + description: | + List of repository IDs that can access the runner group. + - name: runners + value: + - {{ runners }} + description: | + List of runner IDs to add to the runner group. + - name: allows_public_repositories + value: {{ allows_public_repositories }} + description: | + Whether the runner group can be used by \`public\` repositories. + default: false + - name: restricted_to_workflows + value: {{ restricted_to_workflows }} + description: | + If \`true\`, the runner group will be restricted to running only the workflows specified in the \`selected_workflows\` array. + default: false + - name: selected_workflows + value: + - "{{ selected_workflows }}" + description: | + List of workflows the runner group should be allowed to run. This setting will be ignored unless \`restricted_to_workflows\` is set to \`true\`. + - name: network_configuration_id + value: "{{ network_configuration_id }}" + description: | + The identifier of a hosted compute network configuration. +`} + + + + + +## `UPDATE` examples + + + + +Updates the `name` and `visibility` of a self-hosted runner group in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +UPDATE github.actions.org_runner_groups +SET +name = '{{ name }}', +visibility = '{{ visibility }}', +allows_public_repositories = {{ allows_public_repositories }}, +restricted_to_workflows = {{ restricted_to_workflows }}, +selected_workflows = '{{ selected_workflows }}', +network_configuration_id = '{{ network_configuration_id }}' +WHERE +org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +AND name = '{{ name }}' --required +RETURNING +id, +name, +network_configuration_id, +allows_public_repositories, +default, +hosted_runners_url, +inherited, +inherited_allows_public_repositories, +restricted_to_workflows, +runners_url, +selected_repositories_url, +selected_workflows, +visibility, +workflow_restrictions_read_only; +``` + + + + +## `DELETE` examples + + + + +Deletes a self-hosted runner group for an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.actions.org_runner_groups +WHERE org = '{{ org }}' --required +AND runner_group_id = '{{ runner_group_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_secrets/index.md b/website/docs/services/actions/org_secrets/index.md deleted file mode 100644 index d99f802..0000000 --- a/website/docs/services/actions/org_secrets/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: org_secrets -hide_title: false -hide_table_of_contents: false -keywords: - - org_secrets - - actions - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_secrets
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | Visibility of a secret | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single organization secret without revealing its encrypted value.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `SELECT` | | Lists all secrets available in an organization without revealing their
encrypted values.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `INSERT` | | Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `DELETE` | | Deletes a secret in an organization using the secret name.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | diff --git a/website/docs/services/actions/org_self_hosted_runner_repo_access/index.md b/website/docs/services/actions/org_self_hosted_runner_repo_access/index.md new file mode 100644 index 0000000..2c88d94 --- /dev/null +++ b/website/docs/services/actions/org_self_hosted_runner_repo_access/index.md @@ -0,0 +1,234 @@ +--- +title: org_self_hosted_runner_repo_access +hide_title: false +hide_table_of_contents: false +keywords: + - org_self_hosted_runner_repo_access + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_self_hosted_runner_repo_access resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageLists repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
org, repository_idAdds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
org, selected_repository_idsSets repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
org, repository_idRemoves a repository from the list of repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the repository.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.actions.org_self_hosted_runner_repo_access +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +REPLACE github.actions.org_self_hosted_runner_repo_access +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required; +``` + + + +Sets repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +REPLACE github.actions.org_self_hosted_runner_repo_access +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +DELETE FROM github.actions.org_self_hosted_runner_repo_access +WHERE org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/org_self_hosted_runners_permissions/index.md b/website/docs/services/actions/org_self_hosted_runners_permissions/index.md new file mode 100644 index 0000000..7bed269 --- /dev/null +++ b/website/docs/services/actions/org_self_hosted_runners_permissions/index.md @@ -0,0 +1,167 @@ +--- +title: org_self_hosted_runners_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - org_self_hosted_runners_permissions + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_self_hosted_runners_permissions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe policy that controls whether self-hosted runners can be used by repositories in the organization (all, selected, none)
stringThe URL to the endpoint for managing selected repositories for self-hosted runners in the organization
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
org, enabled_repositoriesSets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +SELECT +enabled_repositories, +selected_repositories_url +FROM github.actions.org_self_hosted_runners_permissions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the settings for self-hosted runners for an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + +```sql +REPLACE github.actions.org_self_hosted_runners_permissions +SET +enabled_repositories = '{{ enabled_repositories }}' +WHERE +org = '{{ org }}' --required +AND enabled_repositories = '{{ enabled_repositories }}' --required; +``` + + diff --git a/website/docs/services/actions/org_variables/index.md b/website/docs/services/actions/org_variables/index.md deleted file mode 100644 index cb5c94b..0000000 --- a/website/docs/services/actions/org_variables/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: org_variables -hide_title: false -hide_table_of_contents: false -keywords: - - org_variables - - actions - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_variables
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the variable. | -| | `string` | The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | | -| | `string` | The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The value of the variable. | -| | `string` | Visibility of a variable | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific variable in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `SELECT` | | Lists all organization variables.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `INSERT` | | Creates an organization variable that you can reference in a GitHub Actions workflow.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `DELETE` | | Deletes an organization variable using the variable name.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `EXEC` | | Updates an organization variable that you can reference in a GitHub Actions workflow.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | diff --git a/website/docs/services/actions/pending_deployments_for_run/index.md b/website/docs/services/actions/pending_deployments_for_run/index.md index c9e291f..91b20c4 100644 --- a/website/docs/services/actions/pending_deployments_for_run/index.md +++ b/website/docs/services/actions/pending_deployments_for_run/index.md @@ -1,42 +1,202 @@ ---- +--- title: pending_deployments_for_run hide_title: false hide_table_of_contents: false keywords: - pending_deployments_for_run - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pending_deployments_for_run resource. ## Overview - +
Namepending_deployments_for_run
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `boolean` | Whether the currently authenticated user can approve the deployment | -| | `object` | | -| | `array` | The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. | -| | `integer` | The set duration of the wait timer | -| | `string` | The time that the wait timer began. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether the currently authenticated user can approve the deployment
object
arrayThe people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
integerThe set duration of the wait timer
string (date-time)The time that the wait timer began. (example: 2020-11-23T22:00:40Z)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `EXEC` | | Approve or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, run_idGet all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_id, environment_ids, state, commentApprove or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
+ +## `SELECT` examples + + + + +Get all deployment environments for a workflow run that are waiting for protection rules to pass.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +current_user_can_approve, +environment, +reviewers, +wait_timer, +wait_timer_started_at +FROM github.actions.pending_deployments_for_run +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Approve or reject pending deployments that are waiting on approval by a required reviewer.

Required reviewers with read access to the repository contents and deployments can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.pending_deployments_for_run.review_pending_deployments_for_run +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@run_id='{{ run_id }}' --required +@@json= +'{ +"environment_ids": "{{ environment_ids }}", +"state": "{{ state }}", +"comment": "{{ comment }}" +}' +; +``` + + diff --git a/website/docs/services/actions/permissions/index.md b/website/docs/services/actions/permissions/index.md index edab1ea..0b0f0f9 100644 --- a/website/docs/services/actions/permissions/index.md +++ b/website/docs/services/actions/permissions/index.md @@ -1,40 +1,282 @@ ---- +--- title: permissions hide_title: false hide_table_of_contents: false keywords: - permissions - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a permissions resource. ## Overview - +
Namepermissions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The permissions policy that controls the actions and reusable workflows that are allowed to run. | -| | `boolean` | Whether GitHub Actions is enabled on the repository. | -| | `string` | The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe permissions policy that controls the actions and reusable workflows that are allowed to run. (all, local_only, selected)
booleanWhether GitHub Actions is enabled on the repository.
stringThe API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`.
booleanWhether actions must be pinned to a full-length commit SHA.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe permissions policy that controls the actions and reusable workflows that are allowed to run. (all, local_only, selected)
stringThe policy that controls the repositories in the organization that are allowed to run GitHub Actions. (all, none, selected)
stringThe API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`.
stringThe API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`.
booleanWhether actions must be pinned to a full-length commit SHA.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. | -| | `EXEC` | | Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repo, enabledSets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, enabled_repositoriesSets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +allowed_actions, +enabled, +selected_actions_url, +sha_pinning_required +FROM github.actions.permissions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +allowed_actions, +enabled_repositories, +selected_actions_url, +selected_repositories_url, +sha_pinning_required +FROM github.actions.permissions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.permissions +SET +enabled = {{ enabled }}, +allowed_actions = '{{ allowed_actions }}', +sha_pinning_required = {{ sha_pinning_required }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND enabled = {{ enabled }} --required; +``` + + + +Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.actions.permissions +SET +enabled_repositories = '{{ enabled_repositories }}', +allowed_actions = '{{ allowed_actions }}', +sha_pinning_required = {{ sha_pinning_required }} +WHERE +org = '{{ org }}' --required +AND enabled_repositories = '{{ enabled_repositories }}' --required; +``` + + diff --git a/website/docs/services/actions/public_keys/index.md b/website/docs/services/actions/public_keys/index.md index f23bd58..70c592b 100644 --- a/website/docs/services/actions/public_keys/index.md +++ b/website/docs/services/actions/public_keys/index.md @@ -1,44 +1,322 @@ ---- +--- title: public_keys hide_title: false hide_table_of_contents: false keywords: - public_keys - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_keys resource. ## Overview - +
Namepublic_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | The Base64 encoded public key. | -| | `string` | The identifier for the key. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe identifier for the key. (example: 1234567)
string (example: 2011-01-26T19:01:12Z)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
string (example: ssh-rsa AAAAB3NzaC1yc2EAAA)
string (example: https://api.github.com/user/keys/2)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe identifier for the key. (example: 1234567)
string (example: 2011-01-26T19:01:12Z)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
string (example: ssh-rsa AAAAB3NzaC1yc2EAAA)
string (example: https://api.github.com/user/keys/2)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe identifier for the key. (example: 1234567)
string (example: 2011-01-26T19:01:12Z)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
string (example: ssh-rsa AAAAB3NzaC1yc2EAAA)
string (example: https://api.github.com/user/keys/2)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.
If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `SELECT` | | Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `SELECT` | | Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.
If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, environment_nameGet the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repoGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the public key for an environment, which you need to encrypt environment
secrets. You need to encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +key_id, +created_at, +key, +title, +url +FROM github.actions.public_keys +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +; +``` + + + +Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +key_id, +created_at, +key, +title, +url +FROM github.actions.public_keys +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +key_id, +created_at, +key, +title, +url +FROM github.actions.public_keys +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/repo_org_secrets/index.md b/website/docs/services/actions/repo_org_secrets/index.md index 33595da..d15c632 100644 --- a/website/docs/services/actions/repo_org_secrets/index.md +++ b/website/docs/services/actions/repo_org_secrets/index.md @@ -1,38 +1,154 @@ ---- +--- title: repo_org_secrets hide_title: false hide_table_of_contents: false keywords: - repo_org_secrets - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repo_org_secrets resource. ## Overview - +
Namerepo_org_secrets
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists all organization secrets shared with a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all organization secrets shared with a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.actions.repo_org_secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/actions/repo_org_variables/index.md b/website/docs/services/actions/repo_org_variables/index.md index 62c6172..ab570e4 100644 --- a/website/docs/services/actions/repo_org_variables/index.md +++ b/website/docs/services/actions/repo_org_variables/index.md @@ -1,38 +1,154 @@ ---- +--- title: repo_org_variables hide_title: false hide_table_of_contents: false keywords: - repo_org_variables - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repo_org_variables resource. ## Overview - +
Namerepo_org_variables
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `array` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
array
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists all organization variables shared with a repository.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all organization variables shared with a repository.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +total_count, +variables +FROM github.actions.repo_org_variables +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/actions/repos_for_org_variable/index.md b/website/docs/services/actions/repos_for_org_variable/index.md index edb8a33..65f0e43 100644 --- a/website/docs/services/actions/repos_for_org_variable/index.md +++ b/website/docs/services/actions/repos_for_org_variable/index.md @@ -1,41 +1,274 @@ ---- +--- title: repos_for_org_variable hide_title: false hide_table_of_contents: false keywords: - repos_for_org_variable - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos_for_org_variable resource. ## Overview - +
Namerepos_for_org_variable
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all repositories that can access an organization variable
that is available to selected repositories.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `DELETE` | | Removes a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their `visibility` field set to `selected`.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `EXEC` | | Adds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their `visibility` field set to `selected`.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `EXEC` | | Replaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their `visibility` field set to `selected`.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this
endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, namepage, per_pageLists all repositories that can access an organization variable
that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
org, name, repository_idAdds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, name, selected_repository_idsReplaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
org, name, repository_idRemoves a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable.
stringThe organization name. The name is not case sensitive.
integer
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all repositories that can access an organization variable
that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +repositories, +total_count +FROM github.actions.repos_for_org_variable +WHERE org = '{{ org }}' -- required +AND name = '{{ name }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository to an organization variable that is available to selected repositories.
Organization variables that are available to selected repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.repos_for_org_variable ( +org, +name, +repository_id +) +SELECT +'{{ org }}', +'{{ name }}', +'{{ repository_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: repos_for_org_variable + props: + - name: org + value: "{{ org }}" + description: Required parameter for the repos_for_org_variable resource. + - name: name + value: "{{ name }}" + description: Required parameter for the repos_for_org_variable resource. + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the repos_for_org_variable resource. +`} + + + + + +## `REPLACE` examples + + + + +Replaces all repositories for an organization variable that is available
to selected repositories. Organization variables that are available to selected
repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +REPLACE github.actions.repos_for_org_variable +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND name = '{{ name }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from an organization variable that is
available to selected repositories. Organization variables that are available to
selected repositories have their `visibility` field set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +DELETE FROM github.actions.repos_for_org_variable +WHERE org = '{{ org }}' --required +AND name = '{{ name }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/repos_for_secret/index.md b/website/docs/services/actions/repos_for_secret/index.md index 68f0ac3..52a832f 100644 --- a/website/docs/services/actions/repos_for_secret/index.md +++ b/website/docs/services/actions/repos_for_secret/index.md @@ -1,41 +1,274 @@ ---- +--- title: repos_for_secret hide_title: false hide_table_of_contents: false keywords: - repos_for_secret - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos_for_secret resource. ## Overview - +
Namerepos_for_secret
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `DELETE` | | Removes a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `EXEC` | | Adds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. The visibility is set when you [Create or
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `EXEC` | | Replaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `secrets` organization permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, secret_namepage, per_pageLists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
org, secret_name, repository_idAdds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. For more information about setting the visibility, see [Create or
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_name, selected_repository_idsReplaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
org, secret_name, repository_idRemoves a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integer
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +repositories, +total_count +FROM github.actions.repos_for_secret +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. For more information about setting the visibility, see [Create or
update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.repos_for_secret ( +org, +secret_name, +repository_id +) +SELECT +'{{ org }}', +'{{ secret_name }}', +'{{ repository_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: repos_for_secret + props: + - name: org + value: "{{ org }}" + description: Required parameter for the repos_for_secret resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the repos_for_secret resource. + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the repos_for_secret resource. +`} + + + + + +## `REPLACE` examples + + + + +Replaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +REPLACE github.actions.repos_for_secret +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +DELETE FROM github.actions.repos_for_secret +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/runner_applications/index.md b/website/docs/services/actions/runner_applications/index.md index 8ac35dd..ad973e3 100644 --- a/website/docs/services/actions/runner_applications/index.md +++ b/website/docs/services/actions/runner_applications/index.md @@ -1,43 +1,243 @@ ---- +--- title: runner_applications hide_title: false hide_table_of_contents: false keywords: - runner_applications - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a runner_applications resource. ## Overview - +
Namerunner_applications
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | A short lived bearer token used to download the runner, if needed. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringA short lived bearer token used to download the runner, if needed.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
stringA short lived bearer token used to download the runner, if needed.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `SELECT` | | Lists binaries for the runner application that you can download and run.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoLists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgLists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +architecture, +download_url, +filename, +os, +sha256_checksum, +temp_download_token +FROM github.actions.runner_applications +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Lists binaries for the runner application that you can download and run.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +architecture, +download_url, +filename, +os, +sha256_checksum, +temp_download_token +FROM github.actions.runner_applications +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/actions/runner_jit_configs/index.md b/website/docs/services/actions/runner_jit_configs/index.md new file mode 100644 index 0000000..a68a1c9 --- /dev/null +++ b/website/docs/services/actions/runner_jit_configs/index.md @@ -0,0 +1,196 @@ +--- +title: runner_jit_configs +hide_title: false +hide_table_of_contents: false +keywords: + - runner_jit_configs + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a runner_jit_configs resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, name, runner_group_id, labelsGenerates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the repository.

OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint.
org, name, runner_group_id, labelsGenerates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the organization.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the repository.

OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_jit_configs ( +name, +runner_group_id, +labels, +work_folder, +owner, +repo +) +SELECT +'{{ name }}' /* required */, +{{ runner_group_id }} /* required */, +'{{ labels }}' /* required */, +'{{ work_folder }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +encoded_jit_config, +runner +; +``` + + + +Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the organization.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_jit_configs ( +name, +runner_group_id, +labels, +work_folder, +org +) +SELECT +'{{ name }}' /* required */, +{{ runner_group_id }} /* required */, +'{{ labels }}' /* required */, +'{{ work_folder }}', +'{{ org }}' +RETURNING +encoded_jit_config, +runner +; +``` + + + +{`# Description fields are for documentation purposes +- name: runner_jit_configs + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the runner_jit_configs resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the runner_jit_configs resource. + - name: org + value: "{{ org }}" + description: Required parameter for the runner_jit_configs resource. + - name: name + value: "{{ name }}" + description: | + The name of the new runner. + - name: runner_group_id + value: {{ runner_group_id }} + description: | + The ID of the runner group to register the runner to. + - name: labels + value: + - "{{ labels }}" + description: | + The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. + - name: work_folder + value: "{{ work_folder }}" + description: | + The working directory to be used for job execution, relative to the runner install directory. + default: _work +`} + + + diff --git a/website/docs/services/actions/runner_labels/index.md b/website/docs/services/actions/runner_labels/index.md index 4fa69e2..027aa8e 100644 --- a/website/docs/services/actions/runner_labels/index.md +++ b/website/docs/services/actions/runner_labels/index.md @@ -1,47 +1,452 @@ ---- +--- title: runner_labels hide_title: false hide_table_of_contents: false keywords: - runner_labels - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a runner_labels resource. ## Overview - +
Namerunner_labels
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all labels for a self-hosted runner configured in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `SELECT` | | Lists all labels for a self-hosted runner configured in a repository.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `INSERT` | | Add custom labels to a self-hosted runner configured in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `INSERT` | | Add custom labels to a self-hosted runner configured in a repository.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `DELETE` | | Remove all custom labels from a self-hosted runner configured in an
organization. Returns the remaining read-only labels from the runner.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `DELETE` | | Remove all custom labels from a self-hosted runner configured in a
repository. Returns the remaining read-only labels from the runner.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `DELETE` | | Remove a custom label from a self-hosted runner configured
in an organization. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `DELETE` | | Remove a custom label from a self-hosted runner configured
in a repository. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `EXEC` | | Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `EXEC` | | Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in a repository.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, runner_idLists all labels for a self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_idLists all labels for a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, runner_id, labelsAdds custom labels to a self-hosted runner configured in a repository.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_id, labelsAdds custom labels to a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repo, runner_id, labelsRemove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_id, labelsRemove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, runner_id, nameRemove a custom label from a self-hosted runner configured
in a repository. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_id, nameRemove a custom label from a self-hosted runner configured
in an organization. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, runner_idRemove all custom labels from a self-hosted runner configured in a
repository. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_idRemove all custom labels from a self-hosted runner configured in an
organization. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of a self-hosted runner's custom label.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerUnique identifier of the self-hosted runner.
+ +## `SELECT` examples + + + + +Lists all labels for a self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +labels, +total_count +FROM github.actions.runner_labels +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND runner_id = '{{ runner_id }}' -- required +; +``` + + + +Lists all labels for a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +labels, +total_count +FROM github.actions.runner_labels +WHERE org = '{{ org }}' -- required +AND runner_id = '{{ runner_id }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Adds custom labels to a self-hosted runner configured in a repository.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_labels ( +labels, +owner, +repo, +runner_id +) +SELECT +'{{ labels }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ runner_id }}' +RETURNING +labels, +total_count +; +``` + + + +Adds custom labels to a self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_labels ( +labels, +org, +runner_id +) +SELECT +'{{ labels }}' /* required */, +'{{ org }}', +'{{ runner_id }}' +RETURNING +labels, +total_count +; +``` + + + +{`# Description fields are for documentation purposes +- name: runner_labels + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the runner_labels resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the runner_labels resource. + - name: runner_id + value: {{ runner_id }} + description: Required parameter for the runner_labels resource. + - name: org + value: "{{ org }}" + description: Required parameter for the runner_labels resource. + - name: labels + value: + - "{{ labels }}" + description: | + The names of the custom labels to add to the runner. +`} + + + + + +## `REPLACE` examples + + + + +Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.runner_labels +SET +labels = '{{ labels }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND runner_id = '{{ runner_id }}' --required +AND labels = '{{ labels }}' --required +RETURNING +labels, +total_count; +``` + + + +Remove all previous custom labels and set the new custom labels for a specific
self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +REPLACE github.actions.runner_labels +SET +labels = '{{ labels }}' +WHERE +org = '{{ org }}' --required +AND runner_id = '{{ runner_id }}' --required +AND labels = '{{ labels }}' --required +RETURNING +labels, +total_count; +``` + + + + +## `DELETE` examples + + + + +Remove a custom label from a self-hosted runner configured
in a repository. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.runner_labels +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND runner_id = '{{ runner_id }}' --required +AND name = '{{ name }}' --required +; +``` + + + +Remove a custom label from a self-hosted runner configured
in an organization. Returns the remaining labels from the runner.

This endpoint returns a `404 Not Found` status if the custom label is not
present on the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +DELETE FROM github.actions.runner_labels +WHERE org = '{{ org }}' --required +AND runner_id = '{{ runner_id }}' --required +AND name = '{{ name }}' --required +; +``` + + + +Remove all custom labels from a self-hosted runner configured in a
repository. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.runner_labels +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND runner_id = '{{ runner_id }}' --required +; +``` + + + +Remove all custom labels from a self-hosted runner configured in an
organization. Returns the remaining read-only labels from the runner.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +DELETE FROM github.actions.runner_labels +WHERE org = '{{ org }}' --required +AND runner_id = '{{ runner_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/runner_registration_tokens/index.md b/website/docs/services/actions/runner_registration_tokens/index.md new file mode 100644 index 0000000..b870b96 --- /dev/null +++ b/website/docs/services/actions/runner_registration_tokens/index.md @@ -0,0 +1,170 @@ +--- +title: runner_registration_tokens +hide_title: false +hide_table_of_contents: false +keywords: + - runner_registration_tokens + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a runner_registration_tokens resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns a token that you can pass to the `config` script. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

```
./config.sh --url https://github.com/octo-org --token TOKEN
```

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgReturns a token that you can pass to the `config` script. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

```
./config.sh --url https://github.com/octo-org --token TOKEN
```

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Returns a token that you can pass to the `config` script. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

```
./config.sh --url https://github.com/octo-org --token TOKEN
```

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_registration_tokens ( +owner, +repo +) +SELECT +'{{ owner }}', +'{{ repo }}' +RETURNING +expires_at, +permissions, +repositories, +repository_selection, +single_file, +token +; +``` + + + +Returns a token that you can pass to the `config` script. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

```
./config.sh --url https://github.com/octo-org --token TOKEN
```

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_registration_tokens ( +org +) +SELECT +'{{ org }}' +RETURNING +expires_at, +permissions, +repositories, +repository_selection, +single_file, +token +; +``` + + + +{`# Description fields are for documentation purposes +- name: runner_registration_tokens + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the runner_registration_tokens resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the runner_registration_tokens resource. + - name: org + value: "{{ org }}" + description: Required parameter for the runner_registration_tokens resource. +`} + + + diff --git a/website/docs/services/actions/runner_remove_tokens/index.md b/website/docs/services/actions/runner_remove_tokens/index.md new file mode 100644 index 0000000..911fb87 --- /dev/null +++ b/website/docs/services/actions/runner_remove_tokens/index.md @@ -0,0 +1,170 @@ +--- +title: runner_remove_tokens +hide_title: false +hide_table_of_contents: false +keywords: + - runner_remove_tokens + - actions + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a runner_remove_tokens resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

```
./config.sh remove --token TOKEN
```

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgReturns 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.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

```
./config.sh remove --token TOKEN
```

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

```
./config.sh remove --token TOKEN
```

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_remove_tokens ( +owner, +repo +) +SELECT +'{{ owner }}', +'{{ repo }}' +RETURNING +expires_at, +permissions, +repositories, +repository_selection, +single_file, +token +; +``` + + + +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.

For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:

```
./config.sh remove --token TOKEN
```

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.runner_remove_tokens ( +org +) +SELECT +'{{ org }}' +RETURNING +expires_at, +permissions, +repositories, +repository_selection, +single_file, +token +; +``` + + + +{`# Description fields are for documentation purposes +- name: runner_remove_tokens + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the runner_remove_tokens resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the runner_remove_tokens resource. + - name: org + value: "{{ org }}" + description: Required parameter for the runner_remove_tokens resource. +`} + + + diff --git a/website/docs/services/actions/secrets/index.md b/website/docs/services/actions/secrets/index.md index 4f06364..13ba55d 100644 --- a/website/docs/services/actions/secrets/index.md +++ b/website/docs/services/actions/secrets/index.md @@ -1,42 +1,664 @@ ---- +--- title: secrets hide_title: false hide_table_of_contents: false keywords: - secrets - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a secrets resource. ## Overview - +
Namesecrets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret. (example: SECRET_TOKEN)
string (date-time)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret. (example: SECRET_TOKEN)
string (date-time)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret. (example: SECRET_TOKEN)
string (date-time)
string (uri) (example: https://api.github.com/organizations/org/secrets/my_secret/repositories)
string (date-time)
stringVisibility of a secret (all, private, selected)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single repository secret without revealing its encrypted value.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `SELECT` | | Lists all secrets available in a repository without revealing their encrypted
values.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `INSERT` | | Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | -| | `DELETE` | | Deletes a secret in a repository using the secret name.

You must authenticate using an access token with the `repo` scope to use this endpoint.
GitHub Apps must have the `secrets` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read secrets. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, environment_name, secret_nameGets a single environment secret without revealing its encrypted value.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, secret_nameGets a single repository secret without revealing its encrypted value.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, environment_nameper_page, pageLists all secrets available in an environment without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_nameGets a single organization secret without revealing its encrypted value.

The authenticated user must have collaborator access to a repository to create, update, or read secrets

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repoper_page, pageLists all secrets available in a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgper_page, pageLists all secrets available in an organization without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, environment_name, secret_name, encrypted_value, key_idCreates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, secret_name, encrypted_value, key_idCreates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_name, encrypted_value, key_id, visibilityCreates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, environment_name, secret_nameDeletes a secret in an environment using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, secret_nameDeletes a secret in a repository using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_nameDeletes a secret in an organization using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a single environment secret without revealing its encrypted value.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +updated_at +FROM github.actions.secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Gets a single repository secret without revealing its encrypted value.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +updated_at +FROM github.actions.secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Lists all secrets available in an environment without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.actions.secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Gets a single organization secret without revealing its encrypted value.

The authenticated user must have collaborator access to a repository to create, update, or read secrets

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +selected_repositories_url, +updated_at, +visibility +FROM github.actions.secrets +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Lists all secrets available in a repository without revealing their encrypted
values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.actions.secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all secrets available in an organization without revealing their
encrypted values.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +secrets, +total_count +FROM github.actions.secrets +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.secrets ( +encrypted_value, +key_id, +owner, +repo, +environment_name, +secret_name +) +SELECT +'{{ encrypted_value }}' /* required */, +'{{ key_id }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ environment_name }}', +'{{ secret_name }}' +; +``` + + + +Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.secrets ( +encrypted_value, +key_id, +owner, +repo, +secret_name +) +SELECT +'{{ encrypted_value }}' /* required */, +'{{ key_id }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ secret_name }}' +; +``` + + + +Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.secrets ( +encrypted_value, +key_id, +visibility, +selected_repository_ids, +org, +secret_name +) +SELECT +'{{ encrypted_value }}' /* required */, +'{{ key_id }}' /* required */, +'{{ visibility }}' /* required */, +'{{ selected_repository_ids }}', +'{{ org }}', +'{{ secret_name }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: secrets + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the secrets resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the secrets resource. + - name: environment_name + value: "{{ environment_name }}" + description: Required parameter for the secrets resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the secrets resource. + - name: org + value: "{{ org }}" + description: Required parameter for the secrets resource. + - name: encrypted_value + value: "{{ encrypted_value }}" + description: | + Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. + - name: key_id + value: "{{ key_id }}" + description: | + ID of the key you used to encrypt the secret. + - name: visibility + value: "{{ visibility }}" + description: | + Which type of organization repositories have access to the organization secret. \`selected\` means only the repositories specified by \`selected_repository_ids\` can access the secret. + valid_values: ['all', 'private', 'selected'] + - name: selected_repository_ids + value: + - {{ selected_repository_ids }} + description: | + An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the \`visibility\` is set to \`selected\`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. +`} + + + + + +## `DELETE` examples + + + + +Deletes a secret in an environment using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.secrets +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND environment_name = '{{ environment_name }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + + +Deletes a secret in a repository using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.secrets +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + + +Deletes a secret in an organization using the secret name.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.secrets +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + diff --git a/website/docs/services/actions/self_hosted_runners/index.md b/website/docs/services/actions/self_hosted_runners/index.md index 0d46802..07d9b19 100644 --- a/website/docs/services/actions/self_hosted_runners/index.md +++ b/website/docs/services/actions/self_hosted_runners/index.md @@ -1,54 +1,441 @@ ---- +--- title: self_hosted_runners hide_title: false hide_table_of_contents: false keywords: - self_hosted_runners - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a self_hosted_runners resource. ## Overview - +
Nameself_hosted_runners
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The id of the runner. | -| | `string` | The name of the runner. | -| | `boolean` | | -| | `array` | | -| | `string` | The Operating System of the runner. | -| | `integer` | The id of the runner group. | -| | `string` | The status of the runner. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the runner.
stringThe name of the runner. (example: iMac)
integerThe ID of the runner group.
boolean
boolean
array
stringThe Operating System of the runner. (example: macos)
stringThe status of the runner. (example: online)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the runner.
stringThe name of the runner. (example: iMac)
integerThe ID of the runner group.
boolean
boolean
array
stringThe Operating System of the runner. (example: macos)
stringThe status of the runner. (example: online)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific self-hosted runner configured in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `SELECT` | | Gets a specific self-hosted runner configured in a repository.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `SELECT` | | Lists all self-hosted runners configured in an organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `SELECT` | | Lists all self-hosted runners configured in a repository.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `DELETE` | | Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `DELETE` | | Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `EXEC` | | Returns a token that you can pass to the `config` script. The token expires after one hour.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.

Example using registration token:

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

```
./config.sh --url https://github.com/octo-org --token TOKEN
``` | -| | `EXEC` | | Returns a token that you can pass to the `config` script. The token
expires after one hour.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.

Example using registration token:

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

```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` | -| | `EXEC` | | 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.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.

Example using remove token:

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

```
./config.sh remove --token TOKEN
``` | -| | `EXEC` | | Returns a token that you can pass to remove a self-hosted runner from
a repository. The token expires after one hour.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.

Example using remove token:

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

```config.sh remove --token TOKEN``` | -| | `EXEC` | | Generates a configuration that can be passed to the runner application at startup.

You must authenticate using an access token with the `admin:org` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | -| | `EXEC` | | Generates a configuration that can be passed to the runner application at startup.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.
Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, runner_idGets a specific self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_idGets a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, reponame, per_page, pageLists all self-hosted runners configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgname, per_page, pageLists all self-hosted runners configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, runner_idForces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, runner_idForces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerUnique identifier of the self-hosted runner.
stringThe name of a self-hosted runner.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a specific self-hosted runner configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +name, +runner_group_id, +busy, +ephemeral, +labels, +os, +status +FROM github.actions.self_hosted_runners +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND runner_id = '{{ runner_id }}' -- required +; +``` + + + +Gets a specific self-hosted runner configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +id, +name, +runner_group_id, +busy, +ephemeral, +labels, +os, +status +FROM github.actions.self_hosted_runners +WHERE org = '{{ org }}' -- required +AND runner_id = '{{ runner_id }}' -- required +; +``` + + + +Lists all self-hosted runners configured in a repository.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +runners, +total_count +FROM github.actions.self_hosted_runners +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND name = '{{ name }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all self-hosted runners configured in an organization.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +runners, +total_count +FROM github.actions.self_hosted_runners +WHERE org = '{{ org }}' -- required +AND name = '{{ name }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `DELETE` examples + + + + +Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the repository to use this endpoint.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.self_hosted_runners +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND runner_id = '{{ runner_id }}' --required +; +``` + + + +Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.self_hosted_runners +WHERE org = '{{ org }}' --required +AND runner_id = '{{ runner_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/variables/index.md b/website/docs/services/actions/variables/index.md index 3bdb50f..c30bc2d 100644 --- a/website/docs/services/actions/variables/index.md +++ b/website/docs/services/actions/variables/index.md @@ -1,49 +1,754 @@ ---- +--- title: variables hide_title: false hide_table_of_contents: false keywords: - variables - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a variables resource. ## Overview - +
Namevariables
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the variable. | -| | `string` | The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The value of the variable. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable. (example: USERNAME)
string (date-time)The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. (example: 2019-01-24T22:45:36.000Z)
string (date-time)The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. (example: 2019-01-24T22:45:36.000Z)
stringThe value of the variable. (example: octocat)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable. (example: USERNAME)
string (date-time)The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. (example: 2019-01-24T22:45:36.000Z)
string (date-time)The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. (example: 2019-01-24T22:45:36.000Z)
stringThe value of the variable. (example: octocat)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
array
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the variable. (example: USERNAME)
string (date-time)The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. (example: 2019-01-24T22:45:36.000Z)
string (uri) (example: https://api.github.com/organizations/org/variables/USERNAME/repositories)
string (date-time)The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. (example: 2019-01-24T22:45:36.000Z)
stringThe value of the variable. (example: octocat)
stringVisibility of a variable (all, private, selected)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
array
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
array
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific variable in an environment.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `SELECT` | | Gets a specific variable in a repository.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `SELECT` | | Lists all environment variables.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environments:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `SELECT` | | Lists all repository variables.
You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `INSERT` | | Create an environment variable that you can reference in a GitHub Actions workflow.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `INSERT` | | Creates a repository variable that you can reference in a GitHub Actions workflow.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `DELETE` | | Deletes an environment variable using the variable name.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `DELETE` | | Deletes a repository variable using the variable name.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `EXEC` | | Updates an environment variable that you can reference in a GitHub Actions workflow.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | -| | `EXEC` | | Updates a repository variable that you can reference in a GitHub Actions workflow.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
Authenticated users must have collaborator access to a repository to create, update, or read variables. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, environment_name, nameGets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, nameGets a specific variable in a repository.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, environment_nameper_page, pageLists all environment variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, nameGets a specific variable in an organization.

The authenticated user must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repoper_page, pageLists all repository variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgper_page, pageLists all organization variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, environment_name, name, valueCreate an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, name, valueCreates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, name, value, visibilityCreates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, name, environment_nameUpdates an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, nameUpdates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, nameUpdates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.
owner, repo, name, environment_nameDeletes an environment variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, nameDeletes a repository variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, nameDeletes an organization variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe name of the variable.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +updated_at, +value +FROM github.actions.variables +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND name = '{{ name }}' -- required +; +``` + + + +Gets a specific variable in a repository.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +updated_at, +value +FROM github.actions.variables +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND name = '{{ name }}' -- required +; +``` + + + +Lists all environment variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +total_count, +variables +FROM github.actions.variables +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Gets a specific variable in an organization.

The authenticated user must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +selected_repositories_url, +updated_at, +value, +visibility +FROM github.actions.variables +WHERE org = '{{ org }}' -- required +AND name = '{{ name }}' -- required +; +``` + + + +Lists all repository variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +total_count, +variables +FROM github.actions.variables +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all organization variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +SELECT +total_count, +variables +FROM github.actions.variables +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.variables ( +name, +value, +owner, +repo, +environment_name +) +SELECT +'{{ name }}' /* required */, +'{{ value }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ environment_name }}' +; +``` + + + +Creates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.variables ( +name, +value, +owner, +repo +) +SELECT +'{{ name }}' /* required */, +'{{ value }}' /* required */, +'{{ owner }}', +'{{ repo }}' +; +``` + + + +Creates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.variables ( +name, +value, +visibility, +selected_repository_ids, +org +) +SELECT +'{{ name }}' /* required */, +'{{ value }}' /* required */, +'{{ visibility }}' /* required */, +'{{ selected_repository_ids }}', +'{{ org }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: variables + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the variables resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the variables resource. + - name: environment_name + value: "{{ environment_name }}" + description: Required parameter for the variables resource. + - name: org + value: "{{ org }}" + description: Required parameter for the variables resource. + - name: name + value: "{{ name }}" + description: | + The name of the variable. + - name: value + value: "{{ value }}" + description: | + The value of the variable. + - name: visibility + value: "{{ visibility }}" + description: | + The type of repositories in the organization that can access the variable. \`selected\` means only the repositories specified by \`selected_repository_ids\` can access the variable. + valid_values: ['all', 'private', 'selected'] + - name: selected_repository_ids + value: + - {{ selected_repository_ids }} + description: | + An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the \`visibility\` is set to \`selected\`. +`} + + + + + +## `UPDATE` examples + + + + +Updates an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +UPDATE github.actions.variables +SET +name = '{{ name }}', +value = '{{ value }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND name = '{{ name }}' --required +AND environment_name = '{{ environment_name }}' --required; +``` + + + +Updates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +UPDATE github.actions.variables +SET +name = '{{ name }}', +value = '{{ value }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND name = '{{ name }}' --required; +``` + + + +Updates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + +```sql +UPDATE github.actions.variables +SET +name = '{{ name }}', +value = '{{ value }}', +visibility = '{{ visibility }}', +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND name = '{{ name }}' --required; +``` + + + + +## `DELETE` examples + + + + +Deletes an environment variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.variables +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND name = '{{ name }}' --required +AND environment_name = '{{ environment_name }}' --required +; +``` + + + +Deletes a repository variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.variables +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND name = '{{ name }}' --required +; +``` + + + +Deletes an organization variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.variables +WHERE org = '{{ org }}' --required +AND name = '{{ name }}' --required +; +``` + + diff --git a/website/docs/services/actions/workflow_access/index.md b/website/docs/services/actions/workflow_access/index.md index f383e89..4837bdd 100644 --- a/website/docs/services/actions/workflow_access/index.md +++ b/website/docs/services/actions/workflow_access/index.md @@ -1,35 +1,168 @@ ---- +--- title: workflow_access hide_title: false hide_table_of_contents: false keywords: - workflow_access - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_access resource. ## Overview - +
Nameworkflow_access
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDefines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. (none, user, organization)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
repository `administration` permission to use this endpoint. | -| | `EXEC` | | Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the
repository `administration` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, access_levelSets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +access_level +FROM github.actions.workflow_access +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
This endpoint only applies to private repositories.
For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.actions.workflow_access +SET +access_level = '{{ access_level }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND access_level = '{{ access_level }}' --required; +``` + + diff --git a/website/docs/services/actions/workflow_jobs/index.md b/website/docs/services/actions/workflow_jobs/index.md index 3ce58f8..5c97463 100644 --- a/website/docs/services/actions/workflow_jobs/index.md +++ b/website/docs/services/actions/workflow_jobs/index.md @@ -1,41 +1,405 @@ ---- +--- title: workflow_jobs hide_title: false hide_table_of_contents: false keywords: - workflow_jobs - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_jobs resource. ## Overview - +
Nameworkflow_jobs
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe id of the job.
stringThe name of the job. (example: test-coverage)
string (example: MDg6Q2hlY2tSdW40)
integerThe id of the associated workflow run.
integerThe ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
integerThe ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
stringThe name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) (example: my runner group)
stringThe name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) (example: my runner)
stringThe name of the workflow. (example: Build)
string (example: https://api.github.com/repos/github/hello-world/check-runs/4)
string (date-time)The time that the job finished, in ISO 8601 format. (example: 2019-08-08T08:00:00-07:00)
stringThe outcome of the job. (success, failure, neutral, cancelled, skipped, timed_out, action_required) (example: success)
string (date-time)The time that the job created, in ISO 8601 format. (example: 2019-08-08T08:00:00-07:00)
stringThe name of the current branch. (example: main)
stringThe SHA of the commit that is being run. (example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d)
string (example: https://github.com/github/hello-world/runs/4)
arrayLabels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
integerAttempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
string (example: https://api.github.com/repos/github/hello-world/actions/runs/5)
string (date-time)The time that the job started, in ISO 8601 format. (example: 2019-08-08T08:00:00-07:00)
stringThe phase of the lifecycle that the job is currently in. (queued, in_progress, completed, waiting, requested, pending) (example: queued)
arraySteps in this job.
string (example: https://api.github.com/repos/github/hello-world/actions/jobs/21)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). | -| | `SELECT` | | Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). | -| | `EXEC` | | Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look
for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can
use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must
have the `actions:read` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, run_id, attempt_numberper_page, pageLists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, job_idGets a specific job in a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_idfilter, per_page, pageLists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe attempt number of the workflow run.
integerThe unique identifier of the job.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
stringFilters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +jobs, +total_count +FROM github.actions.workflow_jobs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +AND attempt_number = '{{ attempt_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Gets a specific job in a workflow run.

Anyone with read access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +name, +node_id, +run_id, +runner_group_id, +runner_id, +runner_group_name, +runner_name, +workflow_name, +check_run_url, +completed_at, +conclusion, +created_at, +head_branch, +head_sha, +html_url, +labels, +run_attempt, +run_url, +started_at, +status, +steps, +url +FROM github.actions.workflow_jobs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND job_id = '{{ job_id }}' -- required +; +``` + + + +Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information
about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +jobs, +total_count +FROM github.actions.workflow_jobs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +AND filter = '{{ filter }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/actions/workflow_run_logs/index.md b/website/docs/services/actions/workflow_run_logs/index.md index d9efe2c..820f3ec 100644 --- a/website/docs/services/actions/workflow_run_logs/index.md +++ b/website/docs/services/actions/workflow_run_logs/index.md @@ -1,37 +1,114 @@ ---- +--- title: workflow_run_logs hide_title: false hide_table_of_contents: false keywords: - workflow_run_logs - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_run_logs resource. ## Overview - +
Nameworkflow_run_logs
Name
TypeResource
Id
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `DELETE` | | Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after
1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to
the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `EXEC` | | Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for
`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use
this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have
the `actions:read` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, run_idDeletes all logs for a workflow run.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
+ +## `DELETE` examples + + + + +Deletes all logs for a workflow run.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.workflow_run_logs +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND run_id = '{{ run_id }}' --required +; +``` + + diff --git a/website/docs/services/actions/workflow_run_reviews/index.md b/website/docs/services/actions/workflow_run_reviews/index.md index b9624cc..9568fd0 100644 --- a/website/docs/services/actions/workflow_run_reviews/index.md +++ b/website/docs/services/actions/workflow_run_reviews/index.md @@ -1,40 +1,160 @@ ---- +--- title: workflow_run_reviews hide_title: false hide_table_of_contents: false keywords: - workflow_run_reviews - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_run_reviews resource. ## Overview - +
Nameworkflow_run_reviews
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The comment submitted with the deployment review | -| | `array` | The list of environments that were approved or rejected | -| | `string` | Whether deployment to the environment(s) was approved or rejected or pending (with comments) | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe comment submitted with the deployment review (example: Ship it!)
arrayThe list of environments that were approved or rejected
stringWhether deployment to the environment(s) was approved or rejected or pending (with comments) (approved, rejected, pending) (example: approved)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, run_idAnyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
+ +## `SELECT` examples + + + + +Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +comment, +environments, +state, +user +FROM github.actions.workflow_run_reviews +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +; +``` + + diff --git a/website/docs/services/actions/workflow_run_usage/index.md b/website/docs/services/actions/workflow_run_usage/index.md index 3f3d39d..d8b7721 100644 --- a/website/docs/services/actions/workflow_run_usage/index.md +++ b/website/docs/services/actions/workflow_run_usage/index.md @@ -1,38 +1,148 @@ ---- +--- title: workflow_run_usage hide_title: false hide_table_of_contents: false keywords: - workflow_run_usage - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_run_usage resource. ## Overview - +
Nameworkflow_run_usage
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `object` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, run_id> [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
+ +## `SELECT` examples + + + + +> [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +billable, +run_duration_ms +FROM github.actions.workflow_run_usage +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +; +``` + + diff --git a/website/docs/services/actions/workflow_runs/index.md b/website/docs/services/actions/workflow_runs/index.md index 1df8502..930b6ed 100644 --- a/website/docs/services/actions/workflow_runs/index.md +++ b/website/docs/services/actions/workflow_runs/index.md @@ -1,82 +1,1228 @@ ---- +--- title: workflow_runs hide_title: false hide_table_of_contents: false keywords: - workflow_runs - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_runs resource. ## Overview - +
Nameworkflow_runs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The ID of the workflow run. | -| | `string` | The name of the workflow run. | -| | `object` | A GitHub user. | -| | `string` | The URL to the artifacts for the workflow run. | -| | `string` | The URL to cancel the workflow run. | -| | `integer` | The ID of the associated check suite. | -| | `string` | The node ID of the associated check suite. | -| | `string` | The URL to the associated check suite. | -| | `string` | | -| | `string` | | -| | `string` | The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. | -| | `string` | | -| | `string` | | -| | `object` | A commit. | -| | `object` | Minimal Repository | -| | `integer` | | -| | `string` | The SHA of the head commit that points to the version of the workflow being run. | -| | `string` | | -| | `string` | The URL to the jobs for the workflow run. | -| | `string` | The URL to download the logs for the workflow run. | -| | `string` | | -| | `string` | The full path of the workflow | -| | `string` | The URL to the previous attempted run of this workflow, if one exists. | -| | `array` | Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. | -| | `array` | | -| | `object` | Minimal Repository | -| | `string` | The URL to rerun the workflow run. | -| | `integer` | Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. | -| | `integer` | The auto incrementing run number for the workflow run. | -| | `string` | The start time of the latest run. Resets on re-run. | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | The URL to the workflow run. | -| | `integer` | The ID of the parent workflow. | -| | `string` | The URL to the workflow. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the workflow run.
stringThe name of the workflow run. (example: Build)
integerThe ID of the associated check suite.
stringThe node ID of the associated check suite. (example: MDEwOkNoZWNrU3VpdGU0Mg==)
integer
string (example: MDEwOkNoZWNrU3VpdGU1)
integerThe ID of the parent workflow.
objectA GitHub user. (title: Simple User)
stringThe URL to the artifacts for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts)
stringThe URL to cancel the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel)
stringThe URL to the associated check suite. (example: https://api.github.com/repos/github/hello-world/check-suites/12)
string (example: neutral)
string (date-time)
stringThe event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. (example: Simple Workflow)
string (example: push)
string (example: master)
objectA commit. (title: Simple Commit)
objectMinimal Repository (title: Minimal Repository)
stringThe SHA of the head commit that points to the version of the workflow being run. (example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d)
string (example: https://github.com/github/hello-world/suites/4)
stringThe URL to the jobs for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs)
stringThe URL to download the logs for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs)
stringThe full path of the workflow (example: octocat/octo-repo/.github/workflows/ci.yml@main)
stringThe URL to the previous attempted run of this workflow, if one exists. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3)
arrayPull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.
array
objectMinimal Repository (title: Minimal Repository)
stringThe URL to rerun the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun)
integerAttempt number of the run, 1 for first attempt and higher if the workflow was re-run.
integerThe auto incrementing run number for the workflow run.
string (date-time)The start time of the latest run. Resets on re-run.
string (example: completed)
objectA GitHub user. (title: Simple User)
string (date-time)
stringThe URL to the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5)
stringThe URL to the workflow. (example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the workflow run.
stringThe name of the workflow run. (example: Build)
integerThe ID of the associated check suite.
stringThe node ID of the associated check suite. (example: MDEwOkNoZWNrU3VpdGU0Mg==)
integer
string (example: MDEwOkNoZWNrU3VpdGU1)
integerThe ID of the parent workflow.
objectA GitHub user. (title: Simple User)
stringThe URL to the artifacts for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts)
stringThe URL to cancel the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel)
stringThe URL to the associated check suite. (example: https://api.github.com/repos/github/hello-world/check-suites/12)
string (example: neutral)
string (date-time)
stringThe event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. (example: Simple Workflow)
string (example: push)
string (example: master)
objectA commit. (title: Simple Commit)
objectMinimal Repository (title: Minimal Repository)
stringThe SHA of the head commit that points to the version of the workflow being run. (example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d)
string (example: https://github.com/github/hello-world/suites/4)
stringThe URL to the jobs for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs)
stringThe URL to download the logs for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs)
stringThe full path of the workflow (example: octocat/octo-repo/.github/workflows/ci.yml@main)
stringThe URL to the previous attempted run of this workflow, if one exists. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3)
arrayPull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.
array
objectMinimal Repository (title: Minimal Repository)
stringThe URL to rerun the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun)
integerAttempt number of the run, 1 for first attempt and higher if the workflow was re-run.
integerThe auto incrementing run number for the workflow run.
string (date-time)The start time of the latest run. Resets on re-run.
string (example: completed)
objectA GitHub user. (title: Simple User)
string (date-time)
stringThe URL to the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5)
stringThe URL to the workflow. (example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
array
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the workflow run.
stringThe name of the workflow run. (example: Build)
integerThe ID of the associated check suite.
stringThe node ID of the associated check suite. (example: MDEwOkNoZWNrU3VpdGU0Mg==)
integer
string (example: MDEwOkNoZWNrU3VpdGU1)
integerThe ID of the parent workflow.
objectA GitHub user. (title: Simple User)
stringThe URL to the artifacts for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts)
stringThe URL to cancel the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/cancel)
stringThe URL to the associated check suite. (example: https://api.github.com/repos/github/hello-world/check-suites/12)
string (example: neutral)
string (date-time)
stringThe event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. (example: Simple Workflow)
string (example: push)
string (example: master)
objectA commit. (title: Simple Commit)
objectMinimal Repository (title: Minimal Repository)
stringThe SHA of the head commit that points to the version of the workflow being run. (example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d)
string (example: https://github.com/github/hello-world/suites/4)
stringThe URL to the jobs for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/jobs)
stringThe URL to download the logs for the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/logs)
stringThe full path of the workflow (example: octocat/octo-repo/.github/workflows/ci.yml@main)
stringThe URL to the previous attempted run of this workflow, if one exists. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3)
arrayPull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run.
array
objectMinimal Repository (title: Minimal Repository)
stringThe URL to rerun the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun)
integerAttempt number of the run, 1 for first attempt and higher if the workflow was re-run.
integerThe auto incrementing run number for the workflow run.
string (date-time)The start time of the latest run. Resets on re-run.
string (example: completed)
objectA GitHub user. (title: Simple User)
string (date-time)
stringThe URL to the workflow run. (example: https://api.github.com/repos/github/hello-world/actions/runs/5)
stringThe URL to the workflow. (example: https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Gets a specific workflow run attempt. Anyone with read access to the repository
can use this endpoint. If the repository is private you must use an access token
with the `repo` scope. GitHub Apps must have the `actions:read` permission to
use this endpoint. | -| | `SELECT` | | List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. | -| | `SELECT` | | Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `DELETE` | | Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is
private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use
this endpoint. | -| | `EXEC` | | Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Cancels a workflow run using its `id`.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Re-run a job and its dependent jobs in a workflow run.

You must authenticate using an access token with the `repo` scope to use this endpoint.
If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. | -| | `EXEC` | | Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

**Note:** GitHub Apps can only review their own custom deployment protection rules.
To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).

If the repository is private, you must use an access token with the `repo` scope.
GitHub Apps must have read and write permission for **Deployments** to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, run_id, attempt_numberexclude_pull_requestsGets a specific workflow run attempt.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, run_idexclude_pull_requestsGets a specific workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, workflow_idactor, branch, event, status, per_page, page, created, exclude_pull_requests, check_suite_id, head_shaList all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
owner, repoactor, branch, event, status, per_page, page, created, exclude_pull_requests, check_suite_id, head_shaLists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
owner, repo, run_idCancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run).

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_idDeletes a specific workflow run.

Anyone with write access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, job_idRe-run a job and its dependent jobs in a workflow run.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_idApproves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_idCancels a workflow run using its `id`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_id, environment_name, comment, stateApprove or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

> [!NOTE]
> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, run_idRe-runs your workflow run using its `id`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, run_idRe-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe attempt number of the workflow run.
integerThe unique identifier of the job.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the workflow run.
The ID of the workflow. You can also pass the workflow file name as a string.
stringReturns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.
stringReturns workflow runs associated with a branch. Use the name of the branch of the `push`.
integerReturns workflow runs with the `check_suite_id` that you specify.
string (date-time)Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
stringReturns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)."
booleanIf `true` pull requests are omitted from the response (empty array).
stringOnly returns workflow runs that are associated with the specified `head_sha`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringReturns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
+ +## `SELECT` examples + + + + +Gets a specific workflow run attempt.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +name, +check_suite_id, +check_suite_node_id, +head_repository_id, +node_id, +workflow_id, +actor, +artifacts_url, +cancel_url, +check_suite_url, +conclusion, +created_at, +display_title, +event, +head_branch, +head_commit, +head_repository, +head_sha, +html_url, +jobs_url, +logs_url, +path, +previous_attempt_url, +pull_requests, +referenced_workflows, +repository, +rerun_url, +run_attempt, +run_number, +run_started_at, +status, +triggering_actor, +updated_at, +url, +workflow_url +FROM github.actions.workflow_runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +AND attempt_number = '{{ attempt_number }}' -- required +AND exclude_pull_requests = '{{ exclude_pull_requests }}' +; +``` + + + +Gets a specific workflow run.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +name, +check_suite_id, +check_suite_node_id, +head_repository_id, +node_id, +workflow_id, +actor, +artifacts_url, +cancel_url, +check_suite_url, +conclusion, +created_at, +display_title, +event, +head_branch, +head_commit, +head_repository, +head_sha, +html_url, +jobs_url, +logs_url, +path, +previous_attempt_url, +pull_requests, +referenced_workflows, +repository, +rerun_url, +run_attempt, +run_number, +run_started_at, +status, +triggering_actor, +updated_at, +url, +workflow_url +FROM github.actions.workflow_runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND run_id = '{{ run_id }}' -- required +AND exclude_pull_requests = '{{ exclude_pull_requests }}' +; +``` + + + +List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + +```sql +SELECT +total_count, +workflow_runs +FROM github.actions.workflow_runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND workflow_id = '{{ workflow_id }}' -- required +AND actor = '{{ actor }}' +AND branch = '{{ branch }}' +AND event = '{{ event }}' +AND status = '{{ status }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND created = '{{ created }}' +AND exclude_pull_requests = '{{ exclude_pull_requests }}' +AND check_suite_id = '{{ check_suite_id }}' +AND head_sha = '{{ head_sha }}' +; +``` + + + +Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + +```sql +SELECT +id, +name, +check_suite_id, +check_suite_node_id, +head_repository_id, +node_id, +workflow_id, +actor, +artifacts_url, +cancel_url, +check_suite_url, +conclusion, +created_at, +display_title, +event, +head_branch, +head_commit, +head_repository, +head_sha, +html_url, +jobs_url, +logs_url, +path, +previous_attempt_url, +pull_requests, +referenced_workflows, +repository, +rerun_url, +run_attempt, +run_number, +run_started_at, +status, +triggering_actor, +updated_at, +url, +workflow_url +FROM github.actions.workflow_runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND actor = '{{ actor }}' +AND branch = '{{ branch }}' +AND event = '{{ event }}' +AND status = '{{ status }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND created = '{{ created }}' +AND exclude_pull_requests = '{{ exclude_pull_requests }}' +AND check_suite_id = '{{ check_suite_id }}' +AND head_sha = '{{ head_sha }}' +; +``` + + + + +## `INSERT` examples + + + + +Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.
You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run).

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.workflow_runs ( +owner, +repo, +run_id +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ run_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: workflow_runs + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the workflow_runs resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the workflow_runs resource. + - name: run_id + value: {{ run_id }} + description: Required parameter for the workflow_runs resource. +`} + + + + + +## `DELETE` examples + + + + +Deletes a specific workflow run.

Anyone with write access to the repository can use this endpoint.

If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.actions.workflow_runs +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND run_id = '{{ run_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Re-run a job and its dependent jobs in a workflow run.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflow_runs.re_run_job_for_workflow_run +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@job_id='{{ job_id }}' --required +@@json= +'{ +"enable_debug_logging": {{ enable_debug_logging }} +}' +; +``` + + + +Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflow_runs.approve_workflow_run +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@run_id='{{ run_id }}' --required +; +``` + + + +Cancels a workflow run using its `id`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflow_runs.cancel_workflow_run +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@run_id='{{ run_id }}' --required +; +``` + + + +Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

> [!NOTE]
> GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +EXEC github.actions.workflow_runs.review_custom_gates_for_run +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@run_id='{{ run_id }}' --required +@@json= +'{ +"environment_name": "{{ environment_name }}", +"comment": "{{ comment }}", +"state": "{{ state }}" +}' +; +``` + + + +Re-runs your workflow run using its `id`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflow_runs.re_run_workflow +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@run_id='{{ run_id }}' --required +@@json= +'{ +"enable_debug_logging": {{ enable_debug_logging }} +}' +; +``` + + + +Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflow_runs.re_run_workflow_failed_jobs +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@run_id='{{ run_id }}' --required +@@json= +'{ +"enable_debug_logging": {{ enable_debug_logging }} +}' +; +``` + + diff --git a/website/docs/services/actions/workflow_usage/index.md b/website/docs/services/actions/workflow_usage/index.md index 319bb14..278a35e 100644 --- a/website/docs/services/actions/workflow_usage/index.md +++ b/website/docs/services/actions/workflow_usage/index.md @@ -1,34 +1,154 @@ ---- +--- title: workflow_usage hide_title: false hide_table_of_contents: false keywords: - workflow_usage - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflow_usage resource. ## Overview - +
Nameworkflow_usage
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
object
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, workflow_id> [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
The ID of the workflow. You can also pass the workflow file name as a string.
+ +## `SELECT` examples + + + + +> [!WARNING]
> This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information.

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +MACOS, +UBUNTU, +WINDOWS +FROM github.actions.workflow_usage +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND workflow_id = '{{ workflow_id }}' -- required +; +``` + + diff --git a/website/docs/services/actions/workflows/index.md b/website/docs/services/actions/workflows/index.md index 50dfdf3..7bb56bb 100644 --- a/website/docs/services/actions/workflows/index.md +++ b/website/docs/services/actions/workflows/index.md @@ -1,51 +1,388 @@ ---- +--- title: workflows hide_title: false hide_table_of_contents: false keywords: - workflows - actions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a workflows resource. ## Overview - +
Nameworkflows
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: CI)
string (example: MDg6V29ya2Zsb3cxMg==)
string (example: https://github.com/actions/setup-ruby/workflows/CI/badge.svg)
string (date-time) (example: 2019-12-06T14:20:20.000Z)
string (date-time) (example: 2019-12-06T14:20:20.000Z)
string (example: https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml)
string (example: ruby.yaml)
string (active, deleted, disabled_fork, disabled_inactivity, disabled_manually) (example: active)
string (date-time) (example: 2019-12-06T14:20:20.000Z)
string (example: https://api.github.com/repos/actions/setup-ruby/workflows/5)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
array
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `INSERT` | | You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." | -| | `EXEC` | | Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | -| | `EXEC` | | Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, workflow_idGets a specific workflow. You can replace `workflow_id` with the workflow
file name. For example, you could use `main.yaml`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repoper_page, pageLists the workflows in a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, workflow_id, refYou can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](https://docs.github.com/actions/reference/events-that-trigger-workflows#workflow_dispatch)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, workflow_idDisables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, workflow_idEnables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
The ID of the workflow. You can also pass the workflow file name as a string.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a specific workflow. You can replace `workflow_id` with the workflow
file name. For example, you could use `main.yaml`.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +name, +node_id, +badge_url, +created_at, +deleted_at, +html_url, +path, +state, +updated_at, +url +FROM github.actions.workflows +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND workflow_id = '{{ workflow_id }}' -- required +; +``` + + + +Lists the workflows in a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +total_count, +workflows +FROM github.actions.workflows +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](https://docs.github.com/actions/reference/events-that-trigger-workflows#workflow_dispatch)."

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.actions.workflows ( +ref, +inputs, +return_run_details, +owner, +repo, +workflow_id +) +SELECT +'{{ ref }}' /* required */, +'{{ inputs }}', +{{ return_run_details }}, +'{{ owner }}', +'{{ repo }}', +'{{ workflow_id }}' +RETURNING +workflow_run_id, +html_url, +run_url +; +``` + + + +{`# Description fields are for documentation purposes +- name: workflows + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the workflows resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the workflows resource. + - name: workflow_id + value: "{{ workflow_id }}" + description: Required parameter for the workflows resource. + - name: ref + value: "{{ ref }}" + description: | + The git reference for the workflow. The reference can be a branch or tag name. + - name: inputs + value: "{{ inputs }}" + description: | + Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when \`inputs\` are omitted. + - name: return_run_details + value: {{ return_run_details }} + description: | + Whether the response should include the workflow run ID and URLs. +`} + + + + + +## Lifecycle Methods + + + + +Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflows.disable_workflow +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@workflow_id='{{ workflow_id }}' --required +; +``` + + + +Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.

OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +EXEC github.actions.workflows.enable_workflow +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@workflow_id='{{ workflow_id }}' --required +; +``` + + diff --git a/website/docs/services/activity/events/index.md b/website/docs/services/activity/events/index.md index 00d903c..4bed50f 100644 --- a/website/docs/services/activity/events/index.md +++ b/website/docs/services/activity/events/index.md @@ -1,46 +1,373 @@ ---- +--- title: events hide_title: false hide_table_of_contents: false keywords: - events - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an events resource. ## Overview - +
Nameevents
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | Actor | -| | `string` | | -| | `object` | Actor | -| | `object` | | -| | `boolean` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. | -| | `SELECT` | | This is the user's organization dashboard. You must be authenticated as the user to view this. | -| | `SELECT` | | **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
| + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, page> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
username, orgper_page, pageThis is the user's organization dashboard. You must be authenticated as the user to view this.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
usernameper_page, pageIf you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.events +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +This is the user's organization dashboard. You must be authenticated as the user to view this.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.events +WHERE username = '{{ username }}' -- required +AND org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read).

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.events +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/activity/feeds/index.md b/website/docs/services/activity/feeds/index.md index aca31ae..4859d89 100644 --- a/website/docs/services/activity/feeds/index.md +++ b/website/docs/services/activity/feeds/index.md @@ -1,47 +1,184 @@ ---- +--- title: feeds hide_title: false hide_table_of_contents: false keywords: - feeds - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a feeds resource. ## Overview - +
Namefeeds
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | A feed of discussions for a given repository and category. | -| | `string` | A feed of discussions for a given repository. | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string (example: https://github.com/octocat.private.actor?token=abc123)
string (example: https://github.com/octocat-org)
array
string (example: https://github.com/octocat)
string (example: https://github.com/octocat.private?token=abc123)
stringA feed of discussions for a given repository and category. (example: https://github.com/{user}/{repo}/discussions/categories/{category})
stringA feed of discussions for a given repository. (example: https://github.com/{user}/{repo}/discussions)
string (example: https://github.com/security-advisories)
string (example: https://github.com/timeline)
string (example: https://github.com/{user})
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

* **Timeline**: The GitHub global public timeline
* **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
* **Current user public**: The public timeline for the authenticated user
* **Current user**: The private timeline for the authenticated user
* **Current user actor**: The private timeline for activity created by the authenticated user
* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

> [!NOTE]
> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

* **Timeline**: The GitHub global public timeline
* **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
* **Current user public**: The public timeline for the authenticated user
* **Current user**: The private timeline for the authenticated user
* **Current user actor**: The private timeline for activity created by the authenticated user
* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.
* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.

By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

> [!NOTE]
> Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + +```sql +SELECT +_links, +current_user_actor_url, +current_user_organization_url, +current_user_organization_urls, +current_user_public_url, +current_user_url, +repository_discussions_category_url, +repository_discussions_url, +security_advisories_url, +timeline_url, +user_url +FROM github.activity.feeds +; +``` + + diff --git a/website/docs/services/activity/index.md b/website/docs/services/activity/index.md index d50031c..3acb31a 100644 --- a/website/docs/services/activity/index.md +++ b/website/docs/services/activity/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Activity APIs Provide Access To Notifications, Subscriptions, And Timelines. - -:::info Service Summary +activity service documentation. -
-
-total resources: 14
-total selectable resources: 14
-total methods: 33
-
-
+:::info[Service Summary] -::: +total resources: __12__ -## Overview - - - - - - -
Namegithub.activity
TypeService
TitleGitHub V3 REST API - Activity
DescriptionActivity APIs Provide Access To Notifications, Subscriptions, And Timelines.
Idactivity:v24.04.00227
+::: ## Resources
@@ -45,16 +30,14 @@ Activity APIs Provide Access To Notifications, Subscriptions, And Timelines. notifications
notifications_thread_subscriptions
public_events
-received_events
-received_public_events
+received_events
+received_public_events
repo_stargazers
-repo_stargazers_extended
-repo_stargazers_with_timestamps
repo_subscriptions
repo_watchers
starring
-watching
-
+watching + \ No newline at end of file diff --git a/website/docs/services/activity/notifications/index.md b/website/docs/services/activity/notifications/index.md index 4b28e77..37c54d3 100644 --- a/website/docs/services/activity/notifications/index.md +++ b/website/docs/services/activity/notifications/index.md @@ -1,50 +1,523 @@ ---- +--- title: notifications hide_title: false hide_table_of_contents: false keywords: - notifications - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a notifications resource. ## Overview - +
Namenotifications
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Minimal Repository | -| | `object` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
objectMinimal Repository (title: Minimal Repository)
object
string (example: https://api.github.com/notifications/threads/2/subscription)
boolean
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
objectMinimal Repository (title: Minimal Repository)
object
string (example: https://api.github.com/notifications/threads/2/subscription)
boolean
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
objectMinimal Repository (title: Minimal Repository)
object
string (example: https://api.github.com/notifications/threads/2/subscription)
boolean
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a notification thread. | -| | `SELECT` | | List all notifications for the current user, sorted by most recently updated. | -| | `SELECT` | | Lists all notifications for the current user in the specified repository. | -| | `EXEC` | | Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. | -| | `EXEC` | | Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. | -| | `EXEC` | | Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoall, participating, since, before, per_page, pageLists all notifications for the current user in the specified repository.
thread_idGets information about a notification thread.
all, participating, since, before, page, per_pageList all notifications for the current user, sorted by most recently updated.
thread_idMarks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.
thread_idMarks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.
Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
owner, repoMarks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).
booleanIf `true`, show notifications marked as read.
string (date-time)Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
booleanIf `true`, only shows notifications in which the user is directly participating or mentioned.
integerThe number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +Lists all notifications for the current user in the specified repository. + +```sql +SELECT +id, +last_read_at, +reason, +repository, +subject, +subscription_url, +unread, +updated_at, +url +FROM github.activity.notifications +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND all = '{{ all }}' +AND participating = '{{ participating }}' +AND since = '{{ since }}' +AND before = '{{ before }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Gets information about a notification thread. + +```sql +SELECT +id, +last_read_at, +reason, +repository, +subject, +subscription_url, +unread, +updated_at, +url +FROM github.activity.notifications +WHERE thread_id = '{{ thread_id }}' -- required +; +``` + + + +List all notifications for the current user, sorted by most recently updated. + +```sql +SELECT +id, +last_read_at, +reason, +repository, +subject, +subscription_url, +unread, +updated_at, +url +FROM github.activity.notifications +WHERE all = '{{ all }}' +AND participating = '{{ participating }}' +AND since = '{{ since }}' +AND before = '{{ before }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `UPDATE` examples + + + + +Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications. + +```sql +UPDATE github.activity.notifications +SET +-- No updatable properties +WHERE +thread_id = '{{ thread_id }}' --required; +``` + + + + +## `DELETE` examples + + + + +Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + +```sql +DELETE FROM github.activity.notifications +WHERE thread_id = '{{ thread_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + +```sql +EXEC github.activity.notifications.mark_notifications_as_read +@@json= +'{ +"last_read_at": "{{ last_read_at }}", +"read": {{ read }} +}' +; +``` + + + +Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. + +```sql +EXEC github.activity.notifications.mark_repo_notifications_as_read +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +@@json= +'{ +"last_read_at": "{{ last_read_at }}" +}' +; +``` + + diff --git a/website/docs/services/activity/notifications_thread_subscriptions/index.md b/website/docs/services/activity/notifications_thread_subscriptions/index.md index b1ba5c1..87d9d01 100644 --- a/website/docs/services/activity/notifications_thread_subscriptions/index.md +++ b/website/docs/services/activity/notifications_thread_subscriptions/index.md @@ -1,45 +1,232 @@ ---- +--- title: notifications_thread_subscriptions hide_title: false hide_table_of_contents: false keywords: - notifications_thread_subscriptions - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a notifications_thread_subscriptions resource. ## Overview - +
Namenotifications_thread_subscriptions
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time) (example: 2012-10-06T21:34:12Z)
boolean
string
string (uri) (example: https://api.github.com/repos/1)
boolean
string (uri) (example: https://api.github.com/notifications/threads/1)
string (uri) (example: https://api.github.com/notifications/threads/1/subscription)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. | -| | `DELETE` | | Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. | -| | `EXEC` | | If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
thread_idThis checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.
thread_idIf you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint.
thread_idMutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).
+ +## `SELECT` examples + + + + +This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription).

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + +```sql +SELECT +created_at, +ignored, +reason, +repository_url, +subscribed, +thread_url, +url +FROM github.activity.notifications_thread_subscriptions +WHERE thread_id = '{{ thread_id }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. + +```sql +REPLACE github.activity.notifications_thread_subscriptions +SET +ignored = {{ ignored }} +WHERE +thread_id = '{{ thread_id }}' --required +RETURNING +created_at, +ignored, +reason, +repository_url, +subscribed, +thread_url, +url; +``` + + + + +## `DELETE` examples + + + + +Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. + +```sql +DELETE FROM github.activity.notifications_thread_subscriptions +WHERE thread_id = '{{ thread_id }}' --required +; +``` + + diff --git a/website/docs/services/activity/public_events/index.md b/website/docs/services/activity/public_events/index.md index 42a0972..02d4087 100644 --- a/website/docs/services/activity/public_events/index.md +++ b/website/docs/services/activity/public_events/index.md @@ -1,47 +1,457 @@ ---- +--- title: public_events hide_title: false hide_table_of_contents: false keywords: - public_events - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_events resource. ## Overview - +
Namepublic_events
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | Actor | -| | `string` | | -| | `object` | Actor | -| | `object` | | -| | `boolean` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. | -| | `SELECT` | | | -| | `SELECT` | | | -| | `SELECT` | | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, page> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
orgper_page, page> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
usernameper_page, page> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
per_page, page> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.public_events +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.public_events +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.public_events +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.public_events +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/activity/received_events/index.md b/website/docs/services/activity/received_events/index.md index 47509dd..13a29ed 100644 --- a/website/docs/services/activity/received_events/index.md +++ b/website/docs/services/activity/received_events/index.md @@ -1,44 +1,184 @@ ---- +--- title: received_events hide_title: false hide_table_of_contents: false keywords: - received_events - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a received_events resource. ## Overview - +
Namereceived_events
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | Actor | -| | `string` | | -| | `object` | Actor | -| | `object` | | -| | `boolean` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameper_page, pageThese are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +These are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.received_events +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/activity/received_public_events/index.md b/website/docs/services/activity/received_public_events/index.md index 5c8b73b..8ba3869 100644 --- a/website/docs/services/activity/received_public_events/index.md +++ b/website/docs/services/activity/received_public_events/index.md @@ -1,44 +1,184 @@ ---- +--- title: received_public_events hide_title: false hide_table_of_contents: false keywords: - received_public_events - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a received_public_events resource. ## Overview - +
Namereceived_public_events
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | Actor | -| | `string` | | -| | `object` | Actor | -| | `object` | | -| | `boolean` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectActor (title: Actor)
string (date-time)
objectActor (title: Actor)
object(opaque JSON object) (title: CreateEvent)
boolean
object
string
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameper_page, page> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + +```sql +SELECT +id, +actor, +created_at, +org, +payload, +public, +repo, +type +FROM github.activity.received_public_events +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/activity/repo_stargazers/index.md b/website/docs/services/activity/repo_stargazers/index.md index 01eceb9..969ca24 100644 --- a/website/docs/services/activity/repo_stargazers/index.md +++ b/website/docs/services/activity/repo_stargazers/index.md @@ -1,57 +1,274 @@ ---- +--- title: repo_stargazers hide_title: false hide_table_of_contents: false keywords: - repo_stargazers - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repo_stargazers resource. ## Overview - +
Namerepo_stargazers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists the people that have starred the repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the people that have starred the repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.activity.repo_stargazers +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/activity/repo_stargazers_extended/index.md b/website/docs/services/activity/repo_stargazers_extended/index.md deleted file mode 100644 index 9e75476..0000000 --- a/website/docs/services/activity/repo_stargazers_extended/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: repo_stargazers_extended -hide_title: false -hide_table_of_contents: false -keywords: - - repo_stargazers_extended - - activity - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namerepo_stargazers_extended
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | A GitHub user. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/activity/repo_stargazers_with_timestamps/index.md b/website/docs/services/activity/repo_stargazers_with_timestamps/index.md deleted file mode 100644 index 88d9dfe..0000000 --- a/website/docs/services/activity/repo_stargazers_with_timestamps/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: repo_stargazers_with_timestamps -hide_title: false -hide_table_of_contents: false -keywords: - - repo_stargazers_with_timestamps - - activity - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namerepo_stargazers_with_timestamps
TypeResource
Id
- -## Fields -> This resource is a view. For the view definition, please refer to the provider spec in the [stackql-provider-registry](https://github.com/stackql/stackql-provider-registry/blob/dev/providers/src/github/v00.00.00000/services/activity.yaml), located under `components -> x-stackQL-resources -> repo_stargazers_with_timestamps`. - -| Name | Datatype | -|:-----|:---------| -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| || -| | `text` | -| || -| || -| || -| || -## Methods -No additional methods available for this resource diff --git a/website/docs/services/activity/repo_subscriptions/index.md b/website/docs/services/activity/repo_subscriptions/index.md index a3e27cb..5537fe9 100644 --- a/website/docs/services/activity/repo_subscriptions/index.md +++ b/website/docs/services/activity/repo_subscriptions/index.md @@ -1,44 +1,234 @@ ---- +--- title: repo_subscriptions hide_title: false hide_table_of_contents: false keywords: - repo_subscriptions - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repo_subscriptions resource. ## Overview - +
Namerepo_subscriptions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `boolean` | Determines if all notifications should be blocked from this repository. | -| | `string` | | -| | `string` | | -| | `boolean` | Determines if notifications should be received from this repository. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +if you subscribe to the repository + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time) (example: 2012-10-06T21:34:12Z)
booleanDetermines if all notifications should be blocked from this repository.
string
string (uri) (example: https://api.github.com/repos/octocat/example)
booleanDetermines if notifications should be received from this repository.
string (uri) (example: https://api.github.com/repos/octocat/example/subscription)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about whether the authenticated user is subscribed to the repository. | -| | `DELETE` | | This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). | -| | `EXEC` | | If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets information about whether the authenticated user is subscribed to the repository.
owner, repoIf you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely.
owner, repoThis endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets information about whether the authenticated user is subscribed to the repository. + +```sql +SELECT +created_at, +ignored, +reason, +repository_url, +subscribed, +url +FROM github.activity.repo_subscriptions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. + +```sql +REPLACE github.activity.repo_subscriptions +SET +subscribed = {{ subscribed }}, +ignored = {{ ignored }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +RETURNING +created_at, +ignored, +reason, +repository_url, +subscribed, +url; +``` + + + + +## `DELETE` examples + + + + +This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). + +```sql +DELETE FROM github.activity.repo_subscriptions +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/activity/repo_watchers/index.md b/website/docs/services/activity/repo_watchers/index.md index a6caa77..29f6999 100644 --- a/website/docs/services/activity/repo_watchers/index.md +++ b/website/docs/services/activity/repo_watchers/index.md @@ -1,57 +1,274 @@ ---- +--- title: repo_watchers hide_title: false hide_table_of_contents: false keywords: - repo_watchers - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repo_watchers resource. ## Overview - +
Namerepo_watchers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists the people watching the specified repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the people watching the specified repository. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.activity.repo_watchers +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/activity/starring/index.md b/website/docs/services/activity/starring/index.md index c9e761b..3cb5d35 100644 --- a/website/docs/services/activity/starring/index.md +++ b/website/docs/services/activity/starring/index.md @@ -1,42 +1,864 @@ ---- +--- title: starring hide_title: false hide_table_of_contents: false keywords: - starring - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a starring resource. ## Overview - +
Namestarring
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A repository on GitHub. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA repository on GitHub. (title: Repository)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the repository
stringThe name of the repository. (example: Team Environment)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
booleanWhether to allow Auto-merge to be used on pull requests.
booleanWhether to allow forking this repo
booleanWhether to allow merge commits for pull requests.
booleanWhether to allow rebase merges for pull requests.
booleanWhether to allow squash merges for pull requests.
booleanWhether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
booleanWhether anonymous git access is enabled for this repository
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
booleanWhether the repository is archived.
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string (example: https://github.com/octocat/Hello-World.git)
objectThe status of the code search index for this repository
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
stringThe default branch of the repository. (example: master)
booleanWhether to delete head branches when pull requests are merged
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
booleanReturns whether or not this repository disabled.
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string (example: git:github.com/octocat/Hello-World.git)
booleanWhether discussions are enabled.
booleanWhether downloads are enabled.
booleanWhether issues are enabled.
boolean
booleanWhether projects are enabled.
booleanWhether pull requests are enabled.
booleanWhether the wiki is enabled.
string (uri) (example: https://github.com)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
booleanWhether this repository acts as a template that can be used to generate new repositories.
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
objectLicense Simple (title: License Simple)
string
stringThe default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. (PR_BODY, PR_TITLE, BLANK)
stringThe default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). (PR_TITLE, MERGE_MESSAGE)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string (uri) (example: git:git.example.com/octocat/Hello-World)
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
booleanWhether the repository is private or public.
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only) (example: all)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
stringThe default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. (PR_BODY, COMMIT_MESSAGES, BLANK)
stringThe default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). (PR_TITLE, COMMIT_OR_PR_TITLE)
string (example: git@github.com:octocat/Hello-World.git)
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: "2020-07-09T00:17:42Z")
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string (uri) (example: https://svn.github.com/octocat/Hello-World)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
booleanWhether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
stringThe repository visibility: public, private, or internal. (default: public)
integer
integer
booleanWhether to require contributors to sign off on web-based commits
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists repositories the authenticated user has starred.

You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. | -| | `SELECT` | | Lists repositories a user has starred.

You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. | -| | `EXEC` | | Whether the authenticated user has starred the repository. | -| | `EXEC` | | Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." | -| | `EXEC` | | Unstar a repository that the authenticated user has previously starred. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernamesort, direction, per_page, pageLists repositories a user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
sort, direction, per_page, pageLists repositories the authenticated user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
owner, repoWhether the authenticated user has starred the repository.
owner, repoNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
owner, repoUnstar a repository that the authenticated user has previously starred.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
stringThe direction to sort the results by.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.
+ +## `SELECT` examples + + + + +Lists repositories a user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + +```sql +SELECT +repo, +starred_at +FROM github.activity.starring +WHERE username = '{{ username }}' -- required +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists repositories the authenticated user has starred.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + +```sql +SELECT +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_search_index_status, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +size, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +starred_at, +statuses_url, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.activity.starring +WHERE sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## Lifecycle Methods + + + + +Whether the authenticated user has starred the repository. + +```sql +EXEC github.activity.starring.check_repo_is_starred_by_authenticated_user +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + +```sql +EXEC github.activity.starring.star_repo_for_authenticated_user +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +Unstar a repository that the authenticated user has previously starred. + +```sql +EXEC github.activity.starring.unstar_repo_for_authenticated_user +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/activity/watching/index.md b/website/docs/services/activity/watching/index.md index 1f733c3..79a9a51 100644 --- a/website/docs/services/activity/watching/index.md +++ b/website/docs/services/activity/watching/index.md @@ -1,124 +1,1253 @@ ---- +--- title: watching hide_title: false hide_table_of_contents: false keywords: - watching - activity - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a watching resource. ## Overview - +
Namewatching
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists repositories a user is watching. | -| | `SELECT` | | Lists repositories the authenticated user is watching. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameper_page, pageLists repositories a user is watching.
per_page, pageLists repositories the authenticated user is watching.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists repositories a user is watching. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.activity.watching +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists repositories the authenticated user is watching. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.activity.watching +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/agent_tasks/index.md b/website/docs/services/agent_tasks/index.md new file mode 100644 index 0000000..db8186a --- /dev/null +++ b/website/docs/services/agent_tasks/index.md @@ -0,0 +1,33 @@ +--- +title: agent_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - agent_tasks + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +agent_tasks service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+repo_tasks +
+
+tasks +
+
\ No newline at end of file diff --git a/website/docs/services/agent_tasks/repo_tasks/index.md b/website/docs/services/agent_tasks/repo_tasks/index.md new file mode 100644 index 0000000..15d0fcf --- /dev/null +++ b/website/docs/services/agent_tasks/repo_tasks/index.md @@ -0,0 +1,418 @@ +--- +title: repo_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - repo_tasks + - agent_tasks + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repo_tasks resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Task retrieved successfully + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSession ID
stringSession name
stringTask ID this session belongs to
stringBase branch name
string (date-time)Completion timestamp
string (date-time)Creation timestamp
objectError details for a failed session
stringHead branch name
stringModel used for this session
objectThe owner of the repository
stringContent of the triggering event
objectThe repository this session belongs to
stringCurrent state of a session (queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled)
string (date-time)Last update timestamp
objectThe user who created this session
+ + + +Tasks retrieved successfully + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of tasks
integer (int32)Total count of active (non-archived) tasks
integer (int32)Total count of archived tasks
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, task_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a task by ID scoped to an owner/repo path
owner, repoper_page, page, sort, direction, state, is_archived, since, creator_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a list of tasks for a specific repository
owner, repo, prompt> [!NOTE]
> This endpoint is in public preview and is subject to change.

Creates a new task for a repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository. The name is not case sensitive.
stringThe unique identifier of the task.
integerFilter tasks by creator user ID
stringThe direction to sort results. Can be `asc` or `desc`.
booleanFilter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`.
integerThe page number of the results to fetch.
integerThe number of results per page (max 100).
string (date-time)Only show tasks updated at or after this time (ISO 8601 timestamp)
stringThe field to sort results by. Can be `updated_at` or `created_at`.
stringComma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a task by ID scoped to an owner/repo path
+ +```sql +SELECT +id, +name, +task_id, +base_ref, +completed_at, +created_at, +error, +head_ref, +model, +owner, +prompt, +repository, +state, +updated_at, +user +FROM github.agent_tasks.repo_tasks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND task_id = '{{ task_id }}' -- required +; +``` + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a list of tasks for a specific repository
+ +```sql +SELECT +tasks, +total_active_count, +total_archived_count +FROM github.agent_tasks.repo_tasks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND state = '{{ state }}' +AND is_archived = '{{ is_archived }}' +AND since = '{{ since }}' +AND creator_id = '{{ creator_id }}' +; +``` + + + + +## `INSERT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Creates a new task for a repository.
+ +```sql +INSERT INTO github.agent_tasks.repo_tasks ( +prompt, +model, +create_pull_request, +base_ref, +owner, +repo +) +SELECT +'{{ prompt }}' /* required */, +'{{ model }}', +{{ create_pull_request }}, +'{{ base_ref }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +archived_at, +artifacts, +created_at, +creator, +creator_type, +html_url, +owner, +repository, +session_count, +state, +updated_at, +url, +user_collaborators +; +``` + + + +{`# Description fields are for documentation purposes +- name: repo_tasks + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the repo_tasks resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the repo_tasks resource. + - name: prompt + value: "{{ prompt }}" + description: | + The user's prompt for the agent + - name: model + value: "{{ model }}" + description: | + The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: \`claude-sonnet-4.6\`, \`claude-opus-4.6\`, \`gpt-5.2-codex\`, \`gpt-5.3-codex\`, \`gpt-5.4\`, \`claude-sonnet-4.5\`, \`claude-opus-4.5\` + - name: create_pull_request + value: {{ create_pull_request }} + description: | + Whether to create a PR. + default: false + - name: base_ref + value: "{{ base_ref }}" + description: | + Base ref for new branch/PR +`} + + + diff --git a/website/docs/services/agent_tasks/tasks/index.md b/website/docs/services/agent_tasks/tasks/index.md new file mode 100644 index 0000000..4744427 --- /dev/null +++ b/website/docs/services/agent_tasks/tasks/index.md @@ -0,0 +1,309 @@ +--- +title: tasks +hide_title: false +hide_table_of_contents: false +keywords: + - tasks + - agent_tasks + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a tasks resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Task retrieved successfully + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringSession ID
stringSession name
stringTask ID this session belongs to
stringBase branch name
string (date-time)Completion timestamp
string (date-time)Creation timestamp
objectError details for a failed session
stringHead branch name
stringModel used for this session
objectThe owner of the repository
stringContent of the triggering event
objectThe repository this session belongs to
stringCurrent state of a session (queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled)
string (date-time)Last update timestamp
objectThe user who created this session
+ + + +Tasks retrieved successfully + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayList of tasks
integer (int32)Total count of active (non-archived) tasks
integer (int32)Total count of archived tasks
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
task_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a task by ID with its associated sessions
per_page, page, sort, direction, state, is_archived, since> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a list of tasks for the authenticated user
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the task.
stringThe direction to sort results. Can be `asc` or `desc`.
booleanFilter by archived status. When `true`, returns only archived tasks. When `false` or omitted, returns only non-archived tasks. Defaults to `false`.
integerThe page number of the results to fetch.
integerThe number of results per page (max 100).
string (date-time)Only show tasks updated at or after this time (ISO 8601 timestamp)
stringThe field to sort results by. Can be `updated_at` or `created_at`.
stringComma-separated list of task states to filter by. Can be any combination of: `queued`, `in_progress`, `completed`, `failed`, `idle`, `waiting_for_user`, `timed_out`, `cancelled`.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a task by ID with its associated sessions
+ +```sql +SELECT +id, +name, +task_id, +base_ref, +completed_at, +created_at, +error, +head_ref, +model, +owner, +prompt, +repository, +state, +updated_at, +user +FROM github.agent_tasks.tasks +WHERE task_id = '{{ task_id }}' -- required +; +``` + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Returns a list of tasks for the authenticated user
+ +```sql +SELECT +tasks, +total_active_count, +total_archived_count +FROM github.agent_tasks.tasks +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND state = '{{ state }}' +AND is_archived = '{{ is_archived }}' +AND since = '{{ since }}' +; +``` + + diff --git a/website/docs/services/apps/apps/index.md b/website/docs/services/apps/apps/index.md index 3999ece..330d7e1 100644 --- a/website/docs/services/apps/apps/index.md +++ b/website/docs/services/apps/apps/index.md @@ -1,66 +1,1221 @@ ---- +--- title: apps hide_title: false hide_table_of_contents: false keywords: - apps - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an apps resource. ## Overview - +
Nameapps
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The ID of the installation. | -| | `string` | | -| | `object` | A GitHub user. | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `boolean` | | -| | `string` | | -| | `object` | The permissions granted to the user access token. | -| | `string` | | -| | `string` | Describe whether all repositories have been selected or there's a selection involved | -| | `string` | | -| | `array` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `integer` | The ID of the user or organization this token is being scoped to. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the installation.
integer
string (example: Iv1.ab1112223334445c)
integerThe ID of the user or organization this token is being scoped to.
string (example: config.yaml)
string (uri) (example: https://api.github.com/app/installations/1/access_tokens)
objectA GitHub user. (title: Simple User)
string (example: github-actions)
string (example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
string (date-time)
array
boolean
string (uri) (example: https://github.com/organizations/github/settings/installations/1)
objectThe permissions granted to the user access token. (title: App Permissions)
string (uri) (example: https://api.github.com/installation/repositories)
stringDescribe whether all repositories have been selected or there's a selection involved (all, selected)
array
string (date-time)
objectA GitHub user. (title: Simple User)
string (example: Organization)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the installation.
integer
string (example: Iv1.ab1112223334445c)
integerThe ID of the user or organization this token is being scoped to.
string (example: config.yaml)
string (uri) (example: https://api.github.com/app/installations/1/access_tokens)
objectA GitHub user. (title: Simple User)
string (example: github-actions)
string (example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
string (date-time)
array
boolean
string (uri) (example: https://github.com/organizations/github/settings/installations/1)
objectThe permissions granted to the user access token. (title: App Permissions)
string (uri) (example: https://api.github.com/installation/repositories)
stringDescribe whether all repositories have been selected or there's a selection involved (all, selected)
array
string (date-time)
objectA GitHub user. (title: Simple User)
string (example: Organization)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the installation.
integer
string (example: Iv1.ab1112223334445c)
integerThe ID of the user or organization this token is being scoped to.
string (example: config.yaml)
string (uri) (example: https://api.github.com/app/installations/1/access_tokens)
objectA GitHub user. (title: Simple User)
string (example: github-actions)
string (example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
string (date-time)
array
boolean
string (uri) (example: https://github.com/organizations/github/settings/installations/1)
objectThe permissions granted to the user access token. (title: App Permissions)
string (uri) (example: https://api.github.com/installation/repositories)
stringDescribe whether all repositories have been selected or there's a selection involved (all, selected)
array
string (date-time)
objectA GitHub user. (title: Simple User)
string (example: Organization)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the installation.
integer
string (example: Iv1.ab1112223334445c)
integerThe ID of the user or organization this token is being scoped to.
string (example: config.yaml)
string (uri) (example: https://api.github.com/app/installations/1/access_tokens)
objectA GitHub user. (title: Simple User)
string (example: github-actions)
string (example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
string (date-time)
array
boolean
string (uri) (example: https://github.com/organizations/github/settings/installations/1)
objectThe permissions granted to the user access token. (title: App Permissions)
string (uri) (example: https://api.github.com/installation/repositories)
stringDescribe whether all repositories have been selected or there's a selection involved (all, selected)
array
string (date-time)
objectA GitHub user. (title: Simple User)
string (example: Organization)
string (date-time)
+ + + +The permissions the installation has are included under the `permissions` key. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the installation.
integer
string (example: Iv1.ab1112223334445c)
integerThe ID of the user or organization this token is being scoped to.
string (example: config.yaml)
string (uri) (example: https://api.github.com/app/installations/1/access_tokens)
objectA GitHub user. (title: Simple User)
string (example: github-actions)
string (example: "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com")
string (date-time)
array
boolean
string (uri) (example: https://github.com/organizations/github/settings/installations/1)
objectThe permissions granted to the user access token. (title: App Permissions)
string (uri) (example: https://api.github.com/installation/repositories)
stringDescribe whether all repositories have been selected or there's a selection involved (all, selected)
array
string (date-time)
objectA GitHub user. (title: Simple User)
string (example: Organization)
string (date-time)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Enables an authenticated GitHub App to find an installation's information using the installation id.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `SELECT` | | Enables an authenticated GitHub App to find the organization's installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `SELECT` | | Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `SELECT` | | Enables an authenticated GitHub App to find the user’s installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `SELECT` | | You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

The permissions the installation has are included under the `permissions` key. | -| | `INSERT` | | Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. | -| | `INSERT` | | Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `DELETE` | | Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `EXEC` | | Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. | -| | `EXEC` | | Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `EXEC` | | Removes a GitHub App installation suspension.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoEnables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
installation_idEnables an authenticated GitHub App to find an installation's information using the installation id.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
orgEnables an authenticated GitHub App to find the organization's installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
usernameEnables an authenticated GitHub App to find the user’s installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
per_page, page, since, outdatedThe permissions the installation has are included under the `permissions` key.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
codeUse this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.
installation_idCreates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
installation_idUninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
installation_idSuspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
installation_idRemoves a GitHub App installation suspension.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
client_id, access_tokenUse a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
which repositories the token can access and which permissions are granted to the
token.

Invalid tokens will return `404 NOT FOUND`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe client ID of the GitHub app.
string
integerThe unique identifier of the installation.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
string
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +app_id, +client_id, +target_id, +single_file_name, +access_tokens_url, +account, +app_slug, +contact_email, +created_at, +events, +has_multiple_single_files, +html_url, +permissions, +repositories_url, +repository_selection, +single_file_paths, +suspended_at, +suspended_by, +target_type, +updated_at +FROM github.apps.apps +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Enables an authenticated GitHub App to find an installation's information using the installation id.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +app_id, +client_id, +target_id, +single_file_name, +access_tokens_url, +account, +app_slug, +contact_email, +created_at, +events, +has_multiple_single_files, +html_url, +permissions, +repositories_url, +repository_selection, +single_file_paths, +suspended_at, +suspended_by, +target_type, +updated_at +FROM github.apps.apps +WHERE installation_id = '{{ installation_id }}' -- required +; +``` + + + +Enables an authenticated GitHub App to find the organization's installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +app_id, +client_id, +target_id, +single_file_name, +access_tokens_url, +account, +app_slug, +contact_email, +created_at, +events, +has_multiple_single_files, +html_url, +permissions, +repositories_url, +repository_selection, +single_file_paths, +suspended_at, +suspended_by, +target_type, +updated_at +FROM github.apps.apps +WHERE org = '{{ org }}' -- required +; +``` + + + +Enables an authenticated GitHub App to find the user’s installation information.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +app_id, +client_id, +target_id, +single_file_name, +access_tokens_url, +account, +app_slug, +contact_email, +created_at, +events, +has_multiple_single_files, +html_url, +permissions, +repositories_url, +repository_selection, +single_file_paths, +suspended_at, +suspended_by, +target_type, +updated_at +FROM github.apps.apps +WHERE username = '{{ username }}' -- required +; +``` + + + +The permissions the installation has are included under the `permissions` key.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +app_id, +client_id, +target_id, +single_file_name, +access_tokens_url, +account, +app_slug, +contact_email, +created_at, +events, +has_multiple_single_files, +html_url, +permissions, +repositories_url, +repository_selection, +single_file_paths, +suspended_at, +suspended_by, +target_type, +updated_at +FROM github.apps.apps +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND since = '{{ since }}' +AND outdated = '{{ outdated }}' +; +``` + + + + +## `INSERT` examples + + + + +Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. + +```sql +INSERT INTO github.apps.apps ( +code +) +SELECT +'{{ code }}' +RETURNING +id, +name, +client_id, +node_id, +client_secret, +created_at, +description, +events, +external_url, +html_url, +installations_count, +owner, +pem, +permissions, +slug, +updated_at, +webhook_secret +; +``` + + + +Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +INSERT INTO github.apps.apps ( +repositories, +repository_ids, +permissions, +installation_id +) +SELECT +'{{ repositories }}', +'{{ repository_ids }}', +'{{ permissions }}', +'{{ installation_id }}' +RETURNING +expires_at, +has_multiple_single_files, +permissions, +repositories, +repository_selection, +single_file, +single_file_paths, +token +; +``` + + + +{`# Description fields are for documentation purposes +- name: apps + props: + - name: code + value: "{{ code }}" + description: Required parameter for the apps resource. + - name: installation_id + value: {{ installation_id }} + description: Required parameter for the apps resource. + - name: repositories + value: + - "{{ repositories }}" + description: | + List of repository names that the token should have access to + - name: repository_ids + value: + - {{ repository_ids }} + description: | + List of repository IDs that the token should have access to + - name: permissions + description: | + The permissions granted to the user access token. + value: + actions: "{{ actions }}" + administration: "{{ administration }}" + artifact_metadata: "{{ artifact_metadata }}" + attestations: "{{ attestations }}" + checks: "{{ checks }}" + codespaces: "{{ codespaces }}" + contents: "{{ contents }}" + dependabot_secrets: "{{ dependabot_secrets }}" + deployments: "{{ deployments }}" + discussions: "{{ discussions }}" + environments: "{{ environments }}" + issues: "{{ issues }}" + merge_queues: "{{ merge_queues }}" + metadata: "{{ metadata }}" + packages: "{{ packages }}" + pages: "{{ pages }}" + pull_requests: "{{ pull_requests }}" + repository_custom_properties: "{{ repository_custom_properties }}" + repository_hooks: "{{ repository_hooks }}" + repository_projects: "{{ repository_projects }}" + secret_scanning_alerts: "{{ secret_scanning_alerts }}" + secrets: "{{ secrets }}" + security_events: "{{ security_events }}" + single_file: "{{ single_file }}" + statuses: "{{ statuses }}" + vulnerability_alerts: "{{ vulnerability_alerts }}" + workflows: "{{ workflows }}" + custom_properties_for_organizations: "{{ custom_properties_for_organizations }}" + members: "{{ members }}" + organization_administration: "{{ organization_administration }}" + organization_custom_roles: "{{ organization_custom_roles }}" + organization_custom_org_roles: "{{ organization_custom_org_roles }}" + organization_custom_properties: "{{ organization_custom_properties }}" + organization_copilot_seat_management: "{{ organization_copilot_seat_management }}" + organization_copilot_agent_settings: "{{ organization_copilot_agent_settings }}" + organization_announcement_banners: "{{ organization_announcement_banners }}" + organization_events: "{{ organization_events }}" + organization_hooks: "{{ organization_hooks }}" + organization_personal_access_tokens: "{{ organization_personal_access_tokens }}" + organization_personal_access_token_requests: "{{ organization_personal_access_token_requests }}" + organization_plan: "{{ organization_plan }}" + organization_projects: "{{ organization_projects }}" + organization_packages: "{{ organization_packages }}" + organization_secrets: "{{ organization_secrets }}" + organization_self_hosted_runners: "{{ organization_self_hosted_runners }}" + organization_user_blocking: "{{ organization_user_blocking }}" + email_addresses: "{{ email_addresses }}" + followers: "{{ followers }}" + git_ssh_keys: "{{ git_ssh_keys }}" + gpg_keys: "{{ gpg_keys }}" + interaction_limits: "{{ interaction_limits }}" + profile: "{{ profile }}" + starring: "{{ starring }}" + enterprise_custom_properties_for_organizations: "{{ enterprise_custom_properties_for_organizations }}" +`} + + + + + +## `DELETE` examples + + + + +Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +DELETE FROM github.apps.apps +WHERE installation_id = '{{ installation_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +EXEC github.apps.apps.suspend_installation +@installation_id='{{ installation_id }}' --required +; +``` + + + +Removes a GitHub App installation suspension.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +EXEC github.apps.apps.unsuspend_installation +@installation_id='{{ installation_id }}' --required +; +``` + + + +Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
which repositories the token can access and which permissions are granted to the
token.

Invalid tokens will return `404 NOT FOUND`. + +```sql +EXEC github.apps.apps.scope_token +@client_id='{{ client_id }}' --required +@@json= +'{ +"access_token": "{{ access_token }}", +"target": "{{ target }}", +"target_id": {{ target_id }}, +"repositories": "{{ repositories }}", +"repository_ids": "{{ repository_ids }}", +"permissions": "{{ permissions }}" +}' +; +``` + + diff --git a/website/docs/services/apps/index.md b/website/docs/services/apps/index.md index d7e4a5c..65ddd06 100644 --- a/website/docs/services/apps/index.md +++ b/website/docs/services/apps/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Information For Integrations And Installations. - -:::info Service Summary +apps service documentation. -
-
-total resources: 15
-total selectable resources: 14
-total methods: 37
-
-
+:::info[Service Summary] -::: +total resources: __16__ -## Overview - - - - - - -
Namegithub.apps
TypeService
TitleGitHub V3 REST API - Apps
DescriptionInformation For Integrations And Installations.
Idapps:v24.04.00227
+::: ## Resources
@@ -47,15 +32,16 @@ Information For Integrations And Installations. integrations
marketplace_listings
marketplace_listings_stubbed
-marketplace_subs
+marketplace_subs
marketplace_subs_stubbed
marketplace_users_subs
marketplace_users_subs_stubbed
oauth_applications
+oauth_grants
webhook_config
webhook_deliveries
-webhook_delivery
-
+webhook_delivery + \ No newline at end of file diff --git a/website/docs/services/apps/installation_repos/index.md b/website/docs/services/apps/installation_repos/index.md index 3c8fe3b..d6eb7fd 100644 --- a/website/docs/services/apps/installation_repos/index.md +++ b/website/docs/services/apps/installation_repos/index.md @@ -1,42 +1,291 @@ ---- +--- title: installation_repos hide_title: false hide_table_of_contents: false keywords: - installation_repos - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an installation_repos resource. ## Overview - +
Nameinstallation_repos
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `string` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +The access the user has to each repository is included in the hash under the `permissions` key. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string (example: selected)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.

The access the user has to each repository is included in the hash under the `permissions` key. | -| | `SELECT` | | List repositories that an app installation can access.

You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. | -| | `DELETE` | | Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.

You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. | -| | `EXEC` | | Add a single repository to an installation. The authenticated user must have admin access to the repository.

You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
installation_idper_page, pageList repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

The access the user has to each repository is included in the hash under the `permissions` key.
per_page, pageList repositories that an app installation can access.
installation_id, repository_idAdd a single repository to an installation. The authenticated user must have admin access to the repository.

This endpoint only works for PATs (classic) with the `repo` scope.
installation_id, repository_idRemove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.

This endpoint only works for PATs (classic) with the `repo` scope.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the installation.
integerThe unique identifier of the repository.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

The access the user has to each repository is included in the hash under the `permissions` key. + +```sql +SELECT +repositories, +repository_selection, +total_count +FROM github.apps.installation_repos +WHERE installation_id = '{{ installation_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +List repositories that an app installation can access. + +```sql +SELECT +repositories, +repository_selection, +total_count +FROM github.apps.installation_repos +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Add a single repository to an installation. The authenticated user must have admin access to the repository.

This endpoint only works for PATs (classic) with the `repo` scope. + +```sql +INSERT INTO github.apps.installation_repos ( +installation_id, +repository_id +) +SELECT +'{{ installation_id }}', +'{{ repository_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: installation_repos + props: + - name: installation_id + value: {{ installation_id }} + description: Required parameter for the installation_repos resource. + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the installation_repos resource. +`} + + + + + +## `DELETE` examples + + + + +Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.

This endpoint only works for PATs (classic) with the `repo` scope. + +```sql +DELETE FROM github.apps.installation_repos +WHERE installation_id = '{{ installation_id }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/apps/installations/index.md b/website/docs/services/apps/installations/index.md index b760b69..875918d 100644 --- a/website/docs/services/apps/installations/index.md +++ b/website/docs/services/apps/installations/index.md @@ -1,39 +1,169 @@ ---- +--- title: installations hide_title: false hide_table_of_contents: false keywords: - installations - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an installations resource. ## Overview - +
Nameinstallations
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +You can find the permissions for the installation under the `permissions` key. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the `permissions` key. | -| | `EXEC` | | Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint.

You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the `permissions` key.
Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.

You can find the permissions for the installation under the `permissions` key. + +```sql +SELECT +installations, +total_count +FROM github.apps.installations +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `DELETE` examples + + + + +Revokes the installation token you're using to authenticate as an installation and access this endpoint.

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + +```sql +DELETE FROM github.apps.installations +; +``` + + diff --git a/website/docs/services/apps/integration_installation_requests/index.md b/website/docs/services/apps/integration_installation_requests/index.md index 500220d..18c47ee 100644 --- a/website/docs/services/apps/integration_installation_requests/index.md +++ b/website/docs/services/apps/integration_installation_requests/index.md @@ -1,41 +1,160 @@ ---- +--- title: integration_installation_requests hide_title: false hide_table_of_contents: false keywords: - integration_installation_requests - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an integration_installation_requests resource. ## Overview - +
Nameintegration_installation_requests
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the request installation. | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +List of integration installation requests + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the request installation.
string (example: MDExOkludGVncmF0aW9uMQ==)
objectA GitHub user. (title: Simple User)
string (date-time) (example: 2022-07-08T16:18:44-04:00)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists all the pending installation requests for the authenticated GitHub App.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all the pending installation requests for the authenticated GitHub App. + +```sql +SELECT +id, +node_id, +account, +created_at, +requester +FROM github.apps.integration_installation_requests +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/integrations/index.md b/website/docs/services/apps/integrations/index.md index 690fd42..bd11019 100644 --- a/website/docs/services/apps/integrations/index.md +++ b/website/docs/services/apps/integrations/index.md @@ -1,54 +1,327 @@ ---- +--- title: integrations hide_title: false hide_table_of_contents: false keywords: - integrations - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an integrations resource. ## Overview - +
Nameintegrations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the GitHub app | -| | `string` | The name of the GitHub app | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | The list of events for the GitHub app | -| | `string` | | -| | `string` | | -| | `integer` | The number of installations associated with the GitHub app | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | The set of permissions for the GitHub app | -| | `string` | The slug name of the GitHub app | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the GitHub app
stringThe name of the GitHub app (example: Probot Owners)
string (example: "Iv1.25b5d1e65ffc4022")
string (example: MDExOkludGVncmF0aW9uMQ==)
string (date-time) (example: 2017-07-08T16:18:44-04:00)
string (example: The description of the app.)
arrayThe list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
string (uri) (example: https://example.com)
string (uri) (example: https://github.com/apps/super-ci)
integerThe number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
objectA GitHub user. (title: Simple User)
objectThe set of permissions for the GitHub app
stringThe slug name of the GitHub app (example: probot-owners)
string (date-time) (example: 2017-07-08T16:18:44-04:00)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the GitHub app
stringThe name of the GitHub app (example: Probot Owners)
string (example: "Iv1.25b5d1e65ffc4022")
string (example: MDExOkludGVncmF0aW9uMQ==)
string (date-time) (example: 2017-07-08T16:18:44-04:00)
string (example: The description of the app.)
arrayThe list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
string (uri) (example: https://example.com)
string (uri) (example: https://github.com/apps/super-ci)
integerThe number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
objectA GitHub user. (title: Simple User)
objectThe set of permissions for the GitHub app
stringThe slug name of the GitHub app (example: probot-owners)
string (date-time) (example: 2017-07-08T16:18:44-04:00)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `SELECT` | | **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
app_slug> [!NOTE]
> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).
Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
+ +## `SELECT` examples + + + + +> [!NOTE]
> The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + +```sql +SELECT +id, +name, +client_id, +node_id, +created_at, +description, +events, +external_url, +html_url, +installations_count, +owner, +permissions, +slug, +updated_at +FROM github.apps.integrations +WHERE app_slug = '{{ app_slug }}' -- required +; +``` + + + +Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +name, +client_id, +node_id, +created_at, +description, +events, +external_url, +html_url, +installations_count, +owner, +permissions, +slug, +updated_at +FROM github.apps.integrations +; +``` + + diff --git a/website/docs/services/apps/marketplace_listings/index.md b/website/docs/services/apps/marketplace_listings/index.md index 09a7d56..7f8c72a 100644 --- a/website/docs/services/apps/marketplace_listings/index.md +++ b/website/docs/services/apps/marketplace_listings/index.md @@ -1,49 +1,208 @@ ---- +--- title: marketplace_listings hide_title: false hide_table_of_contents: false keywords: - marketplace_listings - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a marketplace_listings resource. ## Overview - +
Namemarketplace_listings
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `array` | -| | `boolean` | -| | `integer` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: Pro)
string
string (uri) (example: https://api.github.com/marketplace_listing/plans/1313/accounts)
array
string (example: A professional-grade CI solution)
boolean
integer
integer
string (FREE, FLAT_RATE, PER_UNIT) (example: FLAT_RATE)
string (example: published)
string (uri) (example: https://api.github.com/marketplace_listing/plans/1313)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + +```sql +SELECT +id, +name, +unit_name, +accounts_url, +bullets, +description, +has_free_trial, +monthly_price_in_cents, +number, +price_model, +state, +url, +yearly_price_in_cents +FROM github.apps.marketplace_listings +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/marketplace_listings_stubbed/index.md b/website/docs/services/apps/marketplace_listings_stubbed/index.md index 8498cf3..bdd34c8 100644 --- a/website/docs/services/apps/marketplace_listings_stubbed/index.md +++ b/website/docs/services/apps/marketplace_listings_stubbed/index.md @@ -1,49 +1,208 @@ ---- +--- title: marketplace_listings_stubbed hide_title: false hide_table_of_contents: false keywords: - marketplace_listings_stubbed - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a marketplace_listings_stubbed resource. ## Overview - +
Namemarketplace_listings_stubbed
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `array` | -| | `boolean` | -| | `integer` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: Pro)
string
string (uri) (example: https://api.github.com/marketplace_listing/plans/1313/accounts)
array
string (example: A professional-grade CI solution)
boolean
integer
integer
string (FREE, FLAT_RATE, PER_UNIT) (example: FLAT_RATE)
string (example: published)
string (uri) (example: https://api.github.com/marketplace_listing/plans/1313)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all plans that are part of your GitHub Marketplace listing.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + +```sql +SELECT +id, +name, +unit_name, +accounts_url, +bullets, +description, +has_free_trial, +monthly_price_in_cents, +number, +price_model, +state, +url, +yearly_price_in_cents +FROM github.apps.marketplace_listings_stubbed +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/marketplace_subs/index.md b/website/docs/services/apps/marketplace_subs/index.md index 86a25a4..60d0859 100644 --- a/website/docs/services/apps/marketplace_subs/index.md +++ b/website/docs/services/apps/marketplace_subs/index.md @@ -1,45 +1,285 @@ ---- +--- title: marketplace_subs hide_title: false hide_table_of_contents: false keywords: - marketplace_subs - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a marketplace_subs resource. ## Overview - +
Namemarketplace_subs
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `object` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
object
object
string
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
object
object
string
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. | -| | `SELECT` | | Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_idShows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
plan_idsort, direction, per_page, pageReturns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integeraccount_id parameter
integerThe unique identifier of the plan.
stringTo return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe property to sort the results by.
+ +## `SELECT` examples + + + + +Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + +```sql +SELECT +id, +email, +login, +marketplace_pending_change, +marketplace_purchase, +organization_billing_email, +type, +url +FROM github.apps.marketplace_subs +WHERE account_id = '{{ account_id }}' -- required +; +``` + + + +Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + +```sql +SELECT +id, +email, +login, +marketplace_pending_change, +marketplace_purchase, +organization_billing_email, +type, +url +FROM github.apps.marketplace_subs +WHERE plan_id = '{{ plan_id }}' -- required +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/marketplace_subs_stubbed/index.md b/website/docs/services/apps/marketplace_subs_stubbed/index.md index 2ee669d..862a137 100644 --- a/website/docs/services/apps/marketplace_subs_stubbed/index.md +++ b/website/docs/services/apps/marketplace_subs_stubbed/index.md @@ -1,45 +1,285 @@ ---- +--- title: marketplace_subs_stubbed hide_title: false hide_table_of_contents: false keywords: - marketplace_subs_stubbed - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a marketplace_subs_stubbed resource. ## Overview - +
Namemarketplace_subs_stubbed
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `object` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
object
object
string
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
object
object
string
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. | -| | `SELECT` | | Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_idShows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
plan_idsort, direction, per_page, pageReturns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integeraccount_id parameter
integerThe unique identifier of the plan.
stringTo return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe property to sort the results by.
+ +## `SELECT` examples + + + + +Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + +```sql +SELECT +id, +email, +login, +marketplace_pending_change, +marketplace_purchase, +organization_billing_email, +type, +url +FROM github.apps.marketplace_subs_stubbed +WHERE account_id = '{{ account_id }}' -- required +; +``` + + + +Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. + +```sql +SELECT +id, +email, +login, +marketplace_pending_change, +marketplace_purchase, +organization_billing_email, +type, +url +FROM github.apps.marketplace_subs_stubbed +WHERE plan_id = '{{ plan_id }}' -- required +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/marketplace_users_subs/index.md b/website/docs/services/apps/marketplace_users_subs/index.md index 3095ea3..c3178a3 100644 --- a/website/docs/services/apps/marketplace_users_subs/index.md +++ b/website/docs/services/apps/marketplace_users_subs/index.md @@ -1,44 +1,178 @@ ---- +--- title: marketplace_users_subs hide_title: false hide_table_of_contents: false keywords: - marketplace_users_subs - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a marketplace_users_subs resource. ## Overview - +
Namemarketplace_users_subs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `object` | Marketplace Listing Plan | -| | `integer` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object (title: Marketplace Account)
string (example: monthly)
string (date-time) (example: 2017-11-11T00:00:00Z)
string (date-time) (example: 2017-11-11T00:00:00Z)
boolean
objectMarketplace Listing Plan (title: Marketplace Listing Plan)
integer
string (date-time) (example: 2017-11-02T01:12:12Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists the active subscriptions for the authenticated user.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the active subscriptions for the authenticated user. + +```sql +SELECT +account, +billing_cycle, +free_trial_ends_on, +next_billing_date, +on_free_trial, +plan, +unit_count, +updated_at +FROM github.apps.marketplace_users_subs +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/marketplace_users_subs_stubbed/index.md b/website/docs/services/apps/marketplace_users_subs_stubbed/index.md index e825b7a..ecdc915 100644 --- a/website/docs/services/apps/marketplace_users_subs_stubbed/index.md +++ b/website/docs/services/apps/marketplace_users_subs_stubbed/index.md @@ -1,44 +1,178 @@ ---- +--- title: marketplace_users_subs_stubbed hide_title: false hide_table_of_contents: false keywords: - marketplace_users_subs_stubbed - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a marketplace_users_subs_stubbed resource. ## Overview - +
Namemarketplace_users_subs_stubbed
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `object` | Marketplace Listing Plan | -| | `integer` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object (title: Marketplace Account)
string (example: monthly)
string (date-time) (example: 2017-11-11T00:00:00Z)
string (date-time) (example: 2017-11-11T00:00:00Z)
boolean
objectMarketplace Listing Plan (title: Marketplace Listing Plan)
integer
string (date-time) (example: 2017-11-02T01:12:12Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists the active subscriptions for the authenticated user.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the active subscriptions for the authenticated user. + +```sql +SELECT +account, +billing_cycle, +free_trial_ends_on, +next_billing_date, +on_free_trial, +plan, +unit_count, +updated_at +FROM github.apps.marketplace_users_subs_stubbed +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/apps/oauth_applications/index.md b/website/docs/services/apps/oauth_applications/index.md index eecdcc3..abac393 100644 --- a/website/docs/services/apps/oauth_applications/index.md +++ b/website/docs/services/apps/oauth_applications/index.md @@ -1,38 +1,156 @@ ---- +--- title: oauth_applications hide_title: false hide_table_of_contents: false keywords: - oauth_applications - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an oauth_applications resource. ## Overview - +
Nameoauth_applications
Name
TypeResource
Id
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `DELETE` | | OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). | -| | `EXEC` | | OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. | -| | `EXEC` | | OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. | -| | `EXEC` | | OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
client_idOAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization.
client_id, access_tokenOAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`.
client_id, access_tokenOAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe client ID of the GitHub app.
+ +## `DELETE` examples + + + + +OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. + +```sql +DELETE FROM github.apps.oauth_applications +WHERE client_id = '{{ client_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. + +```sql +EXEC github.apps.oauth_applications.check_token +@client_id='{{ client_id }}' --required +@@json= +'{ +"access_token": "{{ access_token }}" +}' +; +``` + + + +OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. + +```sql +EXEC github.apps.oauth_applications.reset_token +@client_id='{{ client_id }}' --required +@@json= +'{ +"access_token": "{{ access_token }}" +}' +; +``` + + diff --git a/website/docs/services/apps/oauth_grants/index.md b/website/docs/services/apps/oauth_grants/index.md new file mode 100644 index 0000000..e958eab --- /dev/null +++ b/website/docs/services/apps/oauth_grants/index.md @@ -0,0 +1,102 @@ +--- +title: oauth_grants +hide_title: false +hide_table_of_contents: false +keywords: + - oauth_grants + - apps + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an oauth_grants resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
client_idOAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe client ID of the GitHub app.
+ +## `DELETE` examples + + + + +OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + +```sql +DELETE FROM github.apps.oauth_grants +WHERE client_id = '{{ client_id }}' --required +; +``` + + diff --git a/website/docs/services/apps/webhook_config/index.md b/website/docs/services/apps/webhook_config/index.md index 16cb9f6..6b4c82c 100644 --- a/website/docs/services/apps/webhook_config/index.md +++ b/website/docs/services/apps/webhook_config/index.md @@ -1,41 +1,178 @@ ---- +--- title: webhook_config hide_title: false hide_table_of_contents: false keywords: - webhook_config - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_config resource. ## Overview - +
Namewebhook_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. | -| | `` | | -| | `string` | If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). | -| | `string` | The URL to which the payloads will be delivered. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. (example: "json")
stringDetermines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** (example: "0")
stringIf provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). (example: "********")
string (uri)The URL to which the payloads will be delivered. (example: https://example.com/webhook)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `EXEC` | | Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](https://docs.github.com/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](https://docs.github.com/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](https://docs.github.com/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +content_type, +insecure_ssl, +secret, +url +FROM github.apps.webhook_config +; +``` + + + + +## `UPDATE` examples + + + + +Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](https://docs.github.com/developers/apps/creating-a-github-app)."

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +UPDATE github.apps.webhook_config +SET +url = '{{ url }}', +content_type = '{{ content_type }}', +secret = '{{ secret }}', +insecure_ssl = '{{ insecure_ssl }}' +RETURNING +content_type, +insecure_ssl, +secret, +url; +``` + + diff --git a/website/docs/services/apps/webhook_deliveries/index.md b/website/docs/services/apps/webhook_deliveries/index.md index c29703f..ba61150 100644 --- a/website/docs/services/apps/webhook_deliveries/index.md +++ b/website/docs/services/apps/webhook_deliveries/index.md @@ -1,47 +1,208 @@ ---- +--- title: webhook_deliveries hide_title: false hide_table_of_contents: false keywords: - webhook_deliveries - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_deliveries resource. ## Overview - +
Namewebhook_deliveries
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the webhook delivery. | -| | `string` | The type of activity for the event that triggered the delivery. | -| | `string` | Time when the webhook delivery occurred. | -| | `number` | Time spent delivering. | -| | `string` | The event that triggered the delivery. | -| | `string` | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). | -| | `integer` | The id of the GitHub App installation associated with this event. | -| | `boolean` | Whether the webhook delivery is a redelivery. | -| | `integer` | The id of the repository associated with this event. | -| | `string` | Describes the response returned after attempting the delivery. | -| | `integer` | Status code received when delivery was made. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the webhook delivery.
integer (int64)The id of the GitHub App installation associated with this event.
integer (int64)The id of the repository associated with this event.
stringThe type of activity for the event that triggered the delivery. (example: opened)
string (date-time)Time when the webhook delivery occurred. (example: 2021-05-12T20:33:44Z)
numberTime spent delivering.
stringThe event that triggered the delivery. (example: issues)
stringUnique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). (example: 58474f00-b361-11eb-836d-0e4f3503ccbe)
booleanWhether the webhook delivery is a redelivery.
stringDescribes the response returned after attempting the delivery. (example: failed to connect)
integerStatus code received when delivery was made.
string (date-time)Time when the webhook delivery was throttled. (example: 2021-05-12T20:33:44Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, cursor, statusReturns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUsed for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringReturns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).
+ +## `SELECT` examples + + + + +Returns a list of webhook deliveries for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +installation_id, +repository_id, +action, +delivered_at, +duration, +event, +guid, +redelivery, +status, +status_code, +throttled_at +FROM github.apps.webhook_deliveries +WHERE per_page = '{{ per_page }}' +AND cursor = '{{ cursor }}' +AND status = '{{ status }}' +; +``` + + diff --git a/website/docs/services/apps/webhook_delivery/index.md b/website/docs/services/apps/webhook_delivery/index.md index 09d9d1d..0318b6e 100644 --- a/website/docs/services/apps/webhook_delivery/index.md +++ b/website/docs/services/apps/webhook_delivery/index.md @@ -1,51 +1,242 @@ ---- +--- title: webhook_delivery hide_title: false hide_table_of_contents: false keywords: - webhook_delivery - apps - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_delivery resource. ## Overview - +
Namewebhook_delivery
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the delivery. | -| | `string` | The type of activity for the event that triggered the delivery. | -| | `string` | Time when the delivery was delivered. | -| | `number` | Time spent delivering. | -| | `string` | The event that triggered the delivery. | -| | `string` | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). | -| | `integer` | The id of the GitHub App installation associated with this event. | -| | `boolean` | Whether the delivery is a redelivery. | -| | `integer` | The id of the repository associated with this event. | -| | `object` | | -| | `object` | | -| | `string` | Description of the status of the attempted delivery | -| | `integer` | Status code received when delivery was made. | -| | `string` | The URL target of the delivery. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the delivery.
integerThe id of the GitHub App installation associated with this event.
integerThe id of the repository associated with this event.
stringThe type of activity for the event that triggered the delivery. (example: opened)
string (date-time)Time when the delivery was delivered. (example: 2021-05-12T20:33:44Z)
numberTime spent delivering.
stringThe event that triggered the delivery. (example: issues)
stringUnique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). (example: 58474f00-b361-11eb-836d-0e4f3503ccbe)
booleanWhether the delivery is a redelivery.
object
object
stringDescription of the status of the attempted delivery (example: failed to connect)
integerStatus code received when delivery was made.
string (date-time)Time when the webhook delivery was throttled. (example: 2021-05-12T20:33:44Z)
stringThe URL target of the delivery. (example: https://www.example.com)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | -| | `EXEC` | | Redeliver a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
delivery_idReturns a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
delivery_idRedeliver a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
+ +## `SELECT` examples + + + + +Returns a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +SELECT +id, +installation_id, +repository_id, +action, +delivered_at, +duration, +event, +guid, +redelivery, +request, +response, +status, +status_code, +throttled_at, +url +FROM github.apps.webhook_delivery +WHERE delivery_id = '{{ delivery_id }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Redeliver a delivery for the webhook configured for a GitHub App.

You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + +```sql +EXEC github.apps.webhook_delivery.redeliver_webhook_delivery +@delivery_id='{{ delivery_id }}' --required +; +``` + + diff --git a/website/docs/services/billing/actions_billing_usage/index.md b/website/docs/services/billing/actions_billing_usage/index.md deleted file mode 100644 index 8dc4e50..0000000 --- a/website/docs/services/billing/actions_billing_usage/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: actions_billing_usage -hide_title: false -hide_table_of_contents: false -keywords: - - actions_billing_usage - - billing - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameactions_billing_usage
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The amount of free GitHub Actions minutes available. | -| | `object` | | -| | `integer` | The sum of the free and paid GitHub Actions minutes used. | -| | `integer` | The total paid GitHub Actions minutes used. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

Access tokens must have the `repo` or `admin:org` scope. | -| | `SELECT` | | Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)".

Access tokens must have the `user` scope. | diff --git a/website/docs/services/billing/combined_billing_usage/index.md b/website/docs/services/billing/combined_billing_usage/index.md deleted file mode 100644 index 0e917ca..0000000 --- a/website/docs/services/billing/combined_billing_usage/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: combined_billing_usage -hide_title: false -hide_table_of_contents: false -keywords: - - combined_billing_usage - - billing - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecombined_billing_usage
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Numbers of days left in billing cycle. | -| | `integer` | Estimated storage space (GB) used in billing cycle. | -| | `integer` | Estimated sum of free and paid storage space (GB) used in billing cycle. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

Access tokens must have the `repo` or `admin:org` scope. | -| | `SELECT` | | Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

Access tokens must have the `user` scope. | diff --git a/website/docs/services/billing/index.md b/website/docs/services/billing/index.md index 2120fc2..a3927ca 100644 --- a/website/docs/services/billing/index.md +++ b/website/docs/services/billing/index.md @@ -9,41 +9,30 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Monitor Charges And Usage From Actions And Packages. - -:::info Service Summary +billing service documentation. -
-
-total resources: 3
-total selectable resources: 3
-total methods: 6
-
-
+:::info[Service Summary] -::: +total resources: __7__ -## Overview - - - - - - -
Namegithub.billing
TypeService
TitleGitHub V3 REST API - Billing
DescriptionMonitor Charges And Usage From Actions And Packages.
Idbilling:v24.04.00227
+::: ## Resources
-actions_billing_usage
-combined_billing_usage
+org_budgets
+org_premium_request_usage
+org_usage
+org_usage_summary
-packages_billing_usage
-
+premium_request_usage
+usage
+usage_summary
+ \ No newline at end of file diff --git a/website/docs/services/billing/org_budgets/index.md b/website/docs/services/billing/org_budgets/index.md new file mode 100644 index 0000000..14d633c --- /dev/null +++ b/website/docs/services/billing/org_budgets/index.md @@ -0,0 +1,319 @@ +--- +title: org_budgets +hide_title: false +hide_table_of_contents: false +keywords: + - org_budgets + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_budgets resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when updating a budget + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringID of the budget.
stringThe name of the entity to apply the budget to (example: octocat/hello-world)
object
integerThe budget amount in whole dollars. For license-based products, this represents the number of licenses.
stringA single product or sku to apply the budget to. (example: actions_linux)
stringThe type of scope for the budget (enterprise, organization, repository, cost_center) (example: enterprise)
stringThe type of pricing for the budget (ProductPricing) (example: ProductPricing)
booleanWhether to prevent additional spending once the budget is exceeded
+ + + +Response when getting all budgets + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayArray of budget objects for the enterprise
booleanIndicates if there are more pages of results available (maps to hasNextPage from billing platform)
integerTotal number of budgets matching the query
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, budget_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets a budget by ID. The authenticated user must be an organization admin or billing manager.
orgpage, per_page, scope> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.
Each page returns up to 10 budgets.
org, budget_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.
org, budget_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe ID corresponding to the budget.
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch.
integerThe number of results per page (max 10).
stringFilter budgets by scope type.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + +```sql +SELECT +id, +budget_entity_name, +budget_alerting, +budget_amount, +budget_product_sku, +budget_scope, +budget_type, +prevent_further_usage +FROM github.billing.org_budgets +WHERE org = '{{ org }}' -- required +AND budget_id = '{{ budget_id }}' -- required +; +``` + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.
Each page returns up to 10 budgets. + +```sql +SELECT +budgets, +has_next_page, +total_count +FROM github.billing.org_budgets +WHERE org = '{{ org }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND scope = '{{ scope }}' +; +``` + + + + +## `UPDATE` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + +```sql +UPDATE github.billing.org_budgets +SET +budget_amount = {{ budget_amount }}, +prevent_further_usage = {{ prevent_further_usage }}, +budget_alerting = '{{ budget_alerting }}', +budget_scope = '{{ budget_scope }}', +budget_entity_name = '{{ budget_entity_name }}', +budget_type = '{{ budget_type }}', +budget_product_sku = '{{ budget_product_sku }}' +WHERE +org = '{{ org }}' --required +AND budget_id = '{{ budget_id }}' --required +RETURNING +budget, +message; +``` + + + + +## `DELETE` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + +```sql +DELETE FROM github.billing.org_budgets +WHERE org = '{{ org }}' --required +AND budget_id = '{{ budget_id }}' --required +; +``` + + diff --git a/website/docs/services/billing/org_premium_request_usage/index.md b/website/docs/services/billing/org_premium_request_usage/index.md new file mode 100644 index 0000000..4657723 --- /dev/null +++ b/website/docs/services/billing/org_premium_request_usage/index.md @@ -0,0 +1,196 @@ +--- +title: org_premium_request_usage +hide_title: false +hide_table_of_contents: false +keywords: + - org_premium_request_usage + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_premium_request_usage resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when getting a billing premium request usage report + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe model for the usage report.
stringThe unique identifier of the organization.
stringThe product for the usage report.
object
array
stringThe name of the user for the usage report.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgyear, month, day, user, model, productGets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** Only data from the past 24 months is accessible via this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerIf specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
stringThe model name to query usage for. The name is not case sensitive.
integerIf specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
stringThe product name to query usage for. The name is not case sensitive.
stringThe user name to query usage for. The name is not case sensitive.
integerIf specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
+ +## `SELECT` examples + + + + +Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** Only data from the past 24 months is accessible via this endpoint. + +```sql +SELECT +model, +organization, +product, +timePeriod, +usageItems, +user +FROM github.billing.org_premium_request_usage +WHERE org = '{{ org }}' -- required +AND year = '{{ year }}' +AND month = '{{ month }}' +AND day = '{{ day }}' +AND user = '{{ user }}' +AND model = '{{ model }}' +AND product = '{{ product }}' +; +``` + + diff --git a/website/docs/services/billing/org_usage/index.md b/website/docs/services/billing/org_usage/index.md new file mode 100644 index 0000000..41f735c --- /dev/null +++ b/website/docs/services/billing/org_usage/index.md @@ -0,0 +1,208 @@ +--- +title: org_usage +hide_title: false +hide_table_of_contents: false +keywords: + - org_usage + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_usage resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Billing usage report response for an organization + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDate of the usage line item.
numberDiscount amount of the usage line item.
numberGross amount of the usage line item.
numberNet amount of the usage line item.
stringName of the organization.
numberPrice per unit of the usage line item.
stringProduct name.
integerQuantity of the usage line item.
stringName of the repository.
stringSKU name.
stringUnit type of the usage line item.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgyear, month, dayGets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerIf specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
integerIf specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.
integerIf specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
+ +## `SELECT` examples + + + + +Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + +```sql +SELECT +date, +discountAmount, +grossAmount, +netAmount, +organizationName, +pricePerUnit, +product, +quantity, +repositoryName, +sku, +unitType +FROM github.billing.org_usage +WHERE org = '{{ org }}' -- required +AND year = '{{ year }}' +AND month = '{{ month }}' +AND day = '{{ day }}' +; +``` + + diff --git a/website/docs/services/billing/org_usage_summary/index.md b/website/docs/services/billing/org_usage_summary/index.md new file mode 100644 index 0000000..6afedb8 --- /dev/null +++ b/website/docs/services/billing/org_usage_summary/index.md @@ -0,0 +1,196 @@ +--- +title: org_usage_summary +hide_title: false +hide_table_of_contents: false +keywords: + - org_usage_summary + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_usage_summary resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when getting a billing usage summary + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the organization.
stringThe product for the usage report.
stringThe name of the repository for the usage report.
stringThe SKU for the usage report.
object
array
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgyear, month, day, repository, product, sku> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** Only data from the past 24 months is accessible via this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerIf specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
integerIf specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
stringThe product name to query usage for. The name is not case sensitive.
stringThe repository name to query for usage in the format owner/repository.
stringThe SKU to query for usage.
integerIf specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

**Note:** Only data from the past 24 months is accessible via this endpoint. + +```sql +SELECT +organization, +product, +repository, +sku, +timePeriod, +usageItems +FROM github.billing.org_usage_summary +WHERE org = '{{ org }}' -- required +AND year = '{{ year }}' +AND month = '{{ month }}' +AND day = '{{ day }}' +AND repository = '{{ repository }}' +AND product = '{{ product }}' +AND sku = '{{ sku }}' +; +``` + + diff --git a/website/docs/services/billing/packages_billing_usage/index.md b/website/docs/services/billing/packages_billing_usage/index.md deleted file mode 100644 index 2bd1d74..0000000 --- a/website/docs/services/billing/packages_billing_usage/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: packages_billing_usage -hide_title: false -hide_table_of_contents: false -keywords: - - packages_billing_usage - - billing - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namepackages_billing_usage
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Free storage space (GB) for GitHub Packages. | -| | `integer` | Sum of the free and paid storage space (GB) for GitHuub Packages. | -| | `integer` | Total paid storage space (GB) for GitHuub Packages. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

Access tokens must have the `repo` or `admin:org` scope. | -| | `SELECT` | | Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)."

Access tokens must have the `user` scope. | diff --git a/website/docs/services/billing/premium_request_usage/index.md b/website/docs/services/billing/premium_request_usage/index.md new file mode 100644 index 0000000..85a4380 --- /dev/null +++ b/website/docs/services/billing/premium_request_usage/index.md @@ -0,0 +1,184 @@ +--- +title: premium_request_usage +hide_title: false +hide_table_of_contents: false +keywords: + - premium_request_usage + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a premium_request_usage resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when getting a billing premium request usage report + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe model for the usage report.
stringThe product for the usage report.
object
array
stringThe unique identifier of the user.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameyear, month, day, model, productGets a report of premium request usage for a user.

**Note:** Only data from the past 24 months is accessible via this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerIf specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
stringThe model name to query usage for. The name is not case sensitive.
integerIf specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
stringThe product name to query usage for. The name is not case sensitive.
integerIf specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
+ +## `SELECT` examples + + + + +Gets a report of premium request usage for a user.

**Note:** Only data from the past 24 months is accessible via this endpoint. + +```sql +SELECT +model, +product, +timePeriod, +usageItems, +user +FROM github.billing.premium_request_usage +WHERE username = '{{ username }}' -- required +AND year = '{{ year }}' +AND month = '{{ month }}' +AND day = '{{ day }}' +AND model = '{{ model }}' +AND product = '{{ product }}' +; +``` + + diff --git a/website/docs/services/billing/usage/index.md b/website/docs/services/billing/usage/index.md new file mode 100644 index 0000000..1d23b94 --- /dev/null +++ b/website/docs/services/billing/usage/index.md @@ -0,0 +1,202 @@ +--- +title: usage +hide_title: false +hide_table_of_contents: false +keywords: + - usage + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a usage resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when getting a billing usage report + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringDate of the usage line item.
numberDiscount amount of the usage line item.
numberGross amount of the usage line item.
numberNet amount of the usage line item.
numberPrice per unit of the usage line item.
stringProduct name.
integerQuantity of the usage line item.
stringName of the repository.
stringSKU name.
stringUnit type of the usage line item.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameyear, month, dayGets a report of the total usage for a user.

**Note:** This endpoint is only available to users with access to the enhanced billing platform.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerIf specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
integerIf specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.
integerIf specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
+ +## `SELECT` examples + + + + +Gets a report of the total usage for a user.

**Note:** This endpoint is only available to users with access to the enhanced billing platform. + +```sql +SELECT +date, +discountAmount, +grossAmount, +netAmount, +pricePerUnit, +product, +quantity, +repositoryName, +sku, +unitType +FROM github.billing.usage +WHERE username = '{{ username }}' -- required +AND year = '{{ year }}' +AND month = '{{ month }}' +AND day = '{{ day }}' +; +``` + + diff --git a/website/docs/services/billing/usage_summary/index.md b/website/docs/services/billing/usage_summary/index.md new file mode 100644 index 0000000..3c52f77 --- /dev/null +++ b/website/docs/services/billing/usage_summary/index.md @@ -0,0 +1,196 @@ +--- +title: usage_summary +hide_title: false +hide_table_of_contents: false +keywords: + - usage_summary + - billing + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a usage_summary resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when getting a billing usage summary + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe product for the usage report.
stringThe name of the repository for the usage report.
stringThe SKU for the usage report.
object
array
stringThe unique identifier of the user.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameyear, month, day, repository, product, sku> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets a summary report of usage for a user.

**Note:** Only data from the past 24 months is accessible via this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerIf specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
integerIf specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
stringThe product name to query usage for. The name is not case sensitive.
stringThe repository name to query for usage in the format owner/repository.
stringThe SKU to query for usage.
integerIf specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets a summary report of usage for a user.

**Note:** Only data from the past 24 months is accessible via this endpoint. + +```sql +SELECT +product, +repository, +sku, +timePeriod, +usageItems, +user +FROM github.billing.usage_summary +WHERE username = '{{ username }}' -- required +AND year = '{{ year }}' +AND month = '{{ month }}' +AND day = '{{ day }}' +AND repository = '{{ repository }}' +AND product = '{{ product }}' +AND sku = '{{ sku }}' +; +``` + + diff --git a/website/docs/services/campaigns/index.md b/website/docs/services/campaigns/index.md new file mode 100644 index 0000000..c7bc61b --- /dev/null +++ b/website/docs/services/campaigns/index.md @@ -0,0 +1,33 @@ +--- +title: campaigns +hide_title: false +hide_table_of_contents: false +keywords: + - campaigns + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +campaigns service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+org_campaigns +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/campaigns/org_campaigns/index.md b/website/docs/services/campaigns/org_campaigns/index.md new file mode 100644 index 0000000..3022666 --- /dev/null +++ b/website/docs/services/campaigns/org_campaigns/index.md @@ -0,0 +1,542 @@ +--- +title: org_campaigns +hide_title: false +hide_table_of_contents: false +keywords: + - org_campaigns + - campaigns + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_campaigns resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe campaign name
object
string (date-time)The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.
string (uri)The contact link of the campaign.
string (date-time)The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe campaign description
string (date-time)The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
arrayThe campaign managers
integerThe number of the newly created campaign
string (date-time)The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringIndicates whether a campaign is open or closed (open, closed) (title: Campaign state)
arrayThe campaign team managers
string (date-time)The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe campaign name
object
string (date-time)The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open.
string (uri)The contact link of the campaign.
string (date-time)The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe campaign description
string (date-time)The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
arrayThe campaign managers
integerThe number of the newly created campaign
string (date-time)The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringIndicates whether a campaign is open or closed (open, closed) (title: Campaign state)
arrayThe campaign team managers
string (date-time)The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, campaign_numberGets a campaign for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
orgpage, per_page, direction, state, sortLists campaigns in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
org, name, description, ends_at, code_scanning_alerts, secret_scanning_alertsCreate a campaign for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.

Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
in the campaign.
org, campaign_numberUpdates a campaign in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
org, campaign_numberDeletes a campaign in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe campaign number.
stringThe organization name. The name is not case sensitive.
stringThe direction to sort the results by.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe property by which to sort the results.
stringIf specified, only campaigns with this state will be returned.
+ +## `SELECT` examples + + + + +Gets a campaign for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```sql +SELECT +name, +alert_stats, +closed_at, +contact_link, +created_at, +description, +ends_at, +managers, +number, +published_at, +state, +team_managers, +updated_at +FROM github.campaigns.org_campaigns +WHERE org = '{{ org }}' -- required +AND campaign_number = '{{ campaign_number }}' -- required +; +``` + + + +Lists campaigns in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```sql +SELECT +name, +alert_stats, +closed_at, +contact_link, +created_at, +description, +ends_at, +managers, +number, +published_at, +state, +team_managers, +updated_at +FROM github.campaigns.org_campaigns +WHERE org = '{{ org }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND direction = '{{ direction }}' +AND state = '{{ state }}' +AND sort = '{{ sort }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a campaign for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.

Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
in the campaign. + +```sql +INSERT INTO github.campaigns.org_campaigns ( +name, +description, +managers, +team_managers, +ends_at, +contact_link, +code_scanning_alerts, +generate_issues, +org +) +SELECT +'{{ name }}' /* required */, +'{{ description }}' /* required */, +'{{ managers }}', +'{{ team_managers }}', +'{{ ends_at }}' /* required */, +'{{ contact_link }}', +'{{ code_scanning_alerts }}' /* required */, +{{ generate_issues }}, +'{{ org }}' +RETURNING +name, +alert_stats, +closed_at, +contact_link, +created_at, +description, +ends_at, +managers, +number, +published_at, +state, +team_managers, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_campaigns + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_campaigns resource. + - name: name + value: "{{ name }}" + description: | + The name of the campaign + - name: description + value: "{{ description }}" + description: | + A description for the campaign + - name: managers + value: + - "{{ managers }}" + description: | + The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. + - name: team_managers + value: + - "{{ team_managers }}" + description: | + The slugs of the teams to set as the campaign managers. + - name: ends_at + value: "{{ ends_at }}" + description: | + The end date and time of the campaign. The date must be in the future. + - name: contact_link + value: "{{ contact_link }}" + description: | + The contact link of the campaign. Must be a URI. + - name: code_scanning_alerts + description: | + The code scanning alerts to include in this campaign + value: + - repository_id: {{ repository_id }} + alert_numbers: "{{ alert_numbers }}" + - name: generate_issues + value: {{ generate_issues }} + description: | + If true, will automatically generate issues for the campaign. The default is false. + default: false +`} + + + + + +## `UPDATE` examples + + + + +Updates a campaign in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```sql +UPDATE github.campaigns.org_campaigns +SET +name = '{{ name }}', +description = '{{ description }}', +managers = '{{ managers }}', +team_managers = '{{ team_managers }}', +ends_at = '{{ ends_at }}', +contact_link = '{{ contact_link }}', +state = '{{ state }}' +WHERE +org = '{{ org }}' --required +AND campaign_number = '{{ campaign_number }}' --required +RETURNING +name, +alert_stats, +closed_at, +contact_link, +created_at, +description, +ends_at, +managers, +number, +published_at, +state, +team_managers, +updated_at; +``` + + + + +## `DELETE` examples + + + + +Deletes a campaign in an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + +```sql +DELETE FROM github.campaigns.org_campaigns +WHERE org = '{{ org }}' --required +AND campaign_number = '{{ campaign_number }}' --required +; +``` + + diff --git a/website/docs/services/checks/annotations/index.md b/website/docs/services/checks/annotations/index.md index 8b89613..e499aab 100644 --- a/website/docs/services/checks/annotations/index.md +++ b/website/docs/services/checks/annotations/index.md @@ -1,46 +1,208 @@ ---- +--- title: annotations hide_title: false hide_table_of_contents: false keywords: - annotations - checks - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an annotations resource. ## Overview - +
Nameannotations
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `integer` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `integer` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: warning)
string
integer
integer
string (example: Check your spelling for 'banaas'.)
string (example: README.md)
string (example: Do you mean 'bananas' or 'banana'?)
integer
integer
string (example: Spell Checker)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, check_run_idper_page, pageLists annotations for a check run using the annotation `id`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the check run.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists annotations for a check run using the annotation `id`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + +```sql +SELECT +annotation_level, +blob_href, +end_column, +end_line, +message, +path, +raw_details, +start_column, +start_line, +title +FROM github.checks.annotations +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND check_run_id = '{{ check_run_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/checks/index.md b/website/docs/services/checks/index.md index b4302b2..dcd5346 100644 --- a/website/docs/services/checks/index.md +++ b/website/docs/services/checks/index.md @@ -9,41 +9,26 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Rich Interactions With Checks Run By Your Integrations. - -:::info Service Summary +checks service documentation. -
-
-total resources: 3
-total selectable resources: 3
-total methods: 12
-
-
+:::info[Service Summary] -::: +total resources: __3__ -## Overview - - - - - - -
Namegithub.checks
TypeService
TitleGitHub V3 REST API - Checks
DescriptionRich Interactions With Checks Run By Your Integrations.
Idchecks:v24.04.00227
+::: ## Resources
annotations
-runs
+runs
-suites
-
+suites
+ \ No newline at end of file diff --git a/website/docs/services/checks/runs/index.md b/website/docs/services/checks/runs/index.md index d722f0d..8b8478b 100644 --- a/website/docs/services/checks/runs/index.md +++ b/website/docs/services/checks/runs/index.md @@ -1,58 +1,628 @@ ---- +--- title: runs hide_title: false hide_table_of_contents: false keywords: - runs - checks - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a runs resource. ## Overview - +
Nameruns
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The id of the check. | -| | `string` | The name of the check. | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `object` | A deployment created as the result of an Actions check run from a workflow that references an environment | -| | `string` | | -| | `string` | | -| | `string` | The SHA of the commit that is being checked. | -| | `string` | | -| | `string` | | -| | `object` | | -| | `array` | Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. | -| | `string` | | -| | `string` | The phase of the lifecycle that the check is currently in. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The id of the check.
stringThe name of the check. (example: test-coverage)
string (example: 42)
string (example: MDg6Q2hlY2tSdW40)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
object
string (date-time) (example: 2018-05-04T01:14:52Z)
string (success, failure, neutral, cancelled, skipped, timed_out, action_required) (example: neutral)
objectA deployment created as the result of an Actions check run from a workflow that references an environment (title: Deployment)
string (example: https://example.com)
stringThe SHA of the commit that is being checked. (example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d)
string (example: https://github.com/github/hello-world/runs/4)
object
arrayPull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
string (date-time) (example: 2018-05-04T01:14:52Z)
stringThe phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. (queued, in_progress, completed, waiting, requested, pending) (example: queued)
string (example: https://api.github.com/repos/github/hello-world/check-runs/4)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. | -| | `SELECT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. | -| | `SELECT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. | -| | `INSERT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. | -| | `EXEC` | | Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.

To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.

For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". | -| | `EXEC` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, check_run_idGets a single check run using its `id`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
owner, repo, check_suite_idcheck_name, status, filter, per_page, pageLists check runs for a check suite using its `id`.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
owner, repo, refcheck_name, status, filter, per_page, page, app_idLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
owner, repo, name, head_sha, status, conclusionCreates a new check run for a specific commit in a repository.

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
owner, repo, check_run_id, conclusionUpdates a check run for a specific commit in a repository.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth apps and personal access tokens (classic) cannot use this endpoint.
owner, repo, check_run_idTriggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.

For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the check run.
integerThe unique identifier of the check suite.
stringThe account owner of the repository. The name is not case sensitive.
stringThe commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integer
stringReturns check runs with the specified `name`.
stringFilters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringReturns check runs with the specified `status`.
+ +## `SELECT` examples + + + + +Gets a single check run using its `id`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + +```sql +SELECT +id, +name, +external_id, +node_id, +app, +check_suite, +completed_at, +conclusion, +deployment, +details_url, +head_sha, +html_url, +output, +pull_requests, +started_at, +status, +url +FROM github.checks.runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND check_run_id = '{{ check_run_id }}' -- required +; +``` + + + +Lists check runs for a check suite using its `id`.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + +```sql +SELECT +check_runs, +total_count +FROM github.checks.runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND check_suite_id = '{{ check_suite_id }}' -- required +AND check_name = '{{ check_name }}' +AND status = '{{ status }}' +AND filter = '{{ filter }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + +```sql +SELECT +check_runs, +total_count +FROM github.checks.runs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +AND check_name = '{{ check_name }}' +AND status = '{{ status }}' +AND filter = '{{ filter }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND app_id = '{{ app_id }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a new check run for a specific commit in a repository.

To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + +```sql +INSERT INTO github.checks.runs ( +name, +head_sha, +details_url, +external_id, +status, +started_at, +conclusion, +completed_at, +output, +actions, +owner, +repo +) +SELECT +'{{ name }}' /* required */, +'{{ head_sha }}' /* required */, +'{{ details_url }}', +'{{ external_id }}', +'{{ status }}' /* required */, +'{{ started_at }}', +'{{ conclusion }}' /* required */, +'{{ completed_at }}', +'{{ output }}', +'{{ actions }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +external_id, +node_id, +app, +check_suite, +completed_at, +conclusion, +deployment, +details_url, +head_sha, +html_url, +output, +pull_requests, +started_at, +status, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: runs + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the runs resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the runs resource. + - name: name + value: "{{ name }}" + description: | + The name of the check. For example, "code-coverage". + - name: head_sha + value: "{{ head_sha }}" + description: | + The SHA of the commit. + - name: details_url + value: "{{ details_url }}" + description: | + The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. + - name: external_id + value: "{{ external_id }}" + description: | + A reference for the run on the integrator's system. + - name: status + value: "{{ status }}" + description: | + The current status of the check run. Only GitHub Actions can set a status of \`waiting\`, \`pending\`, or \`requested\`. + valid_values: ['queued', 'in_progress', 'completed', 'waiting', 'requested', 'pending'] + default: queued + - name: started_at + value: "{{ started_at }}" + description: | + The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: \`YYYY-MM-DDTHH:MM:SSZ\`. + - name: conclusion + value: "{{ conclusion }}" + description: | + **Required if you provide \`completed_at\` or a \`status\` of \`completed\`**. The final conclusion of the check. + **Note:** Providing \`conclusion\` will automatically set the \`status\` parameter to \`completed\`. You cannot change a check run conclusion to \`stale\`, only GitHub can set this. + valid_values: ['action_required', 'cancelled', 'failure', 'neutral', 'success', 'skipped', 'stale', 'timed_out'] + - name: completed_at + value: "{{ completed_at }}" + description: | + The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: \`YYYY-MM-DDTHH:MM:SSZ\`. + - name: output + description: | + Check runs can accept a variety of data in the \`output\` object, including a \`title\` and \`summary\` and can optionally provide descriptive details about the run. + value: + title: "{{ title }}" + summary: "{{ summary }}" + text: "{{ text }}" + annotations: + - path: "{{ path }}" + start_line: {{ start_line }} + end_line: {{ end_line }} + start_column: {{ start_column }} + end_column: {{ end_column }} + annotation_level: "{{ annotation_level }}" + message: "{{ message }}" + title: "{{ title }}" + raw_details: "{{ raw_details }}" + images: + - alt: "{{ alt }}" + image_url: "{{ image_url }}" + caption: "{{ caption }}" + - name: actions + description: | + Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [\`check_run.requested_action\` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a \`label\`, \`identifier\` and \`description\`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." + value: + - label: "{{ label }}" + description: "{{ description }}" + identifier: "{{ identifier }}" +`} + + + + + +## `UPDATE` examples + + + + +Updates a check run for a specific commit in a repository.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

OAuth apps and personal access tokens (classic) cannot use this endpoint. + +```sql +UPDATE github.checks.runs +SET +name = '{{ name }}', +details_url = '{{ details_url }}', +external_id = '{{ external_id }}', +started_at = '{{ started_at }}', +status = '{{ status }}', +conclusion = '{{ conclusion }}', +completed_at = '{{ completed_at }}', +output = '{{ output }}', +actions = '{{ actions }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND check_run_id = '{{ check_run_id }}' --required +AND conclusion = '{{ conclusion }}' --required +RETURNING +id, +name, +external_id, +node_id, +app, +check_suite, +completed_at, +conclusion, +deployment, +details_url, +head_sha, +html_url, +output, +pull_requests, +started_at, +status, +url; +``` + + + + +## Lifecycle Methods + + + + +Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired.

For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + +```sql +EXEC github.checks.runs.rerequest_run +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@check_run_id='{{ check_run_id }}' --required +; +``` + + diff --git a/website/docs/services/checks/suites/index.md b/website/docs/services/checks/suites/index.md index 330c6ff..1fc7ff5 100644 --- a/website/docs/services/checks/suites/index.md +++ b/website/docs/services/checks/suites/index.md @@ -1,59 +1,467 @@ ---- +--- title: suites hide_title: false hide_table_of_contents: false keywords: - suites - checks - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a suites resource. ## Overview - +
Namesuites
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A commit. | -| | `string` | The SHA of the head commit that is being checked. | -| | `integer` | | -| | `string` | | -| | `array` | | -| | `object` | Minimal Repository | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: MDEwOkNoZWNrU3VpdGU1)
string (example: d6fde92930d4715a2b49857d24b940956b26d2d3)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
string (example: 146e867f55c26428e5f9fade55a9bbf5e95a7912)
string
string (success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, stale, ) (example: neutral)
string (date-time)
string (example: master)
objectA commit. (title: Simple Commit)
stringThe SHA of the head commit that is being checked. (example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d)
integer
array
objectMinimal Repository (title: Minimal Repository)
boolean
boolean
stringThe phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. (queued, in_progress, completed, waiting, requested, pending) (example: completed)
string (date-time)
string (example: https://api.github.com/repos/github/hello-world/check-suites/5)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. | -| | `SELECT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. | -| | `INSERT` | | **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. | -| | `EXEC` | | Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.

To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. | -| | `EXEC` | | Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, check_suite_idGets a single check suite using its `id`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
owner, repo, refapp_id, check_name, per_page, pageLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
owner, repo, head_shaCreates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth apps and personal access tokens (classic) cannot use this endpoint.
owner, repoChanges the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
You must have admin permissions in the repository to set preferences for check suites.
owner, repo, check_suite_idTriggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the check suite.
stringThe account owner of the repository. The name is not case sensitive.
stringThe commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerFilters check suites by GitHub App `id`. (example: 1)
stringReturns check runs with the specified `name`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a single check suite using its `id`.

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + +```sql +SELECT +id, +node_id, +after, +app, +before, +check_runs_url, +conclusion, +created_at, +head_branch, +head_commit, +head_sha, +latest_check_runs_count, +pull_requests, +repository, +rerequestable, +runs_rerequestable, +status, +updated_at, +url +FROM github.checks.suites +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND check_suite_id = '{{ check_suite_id }}' -- required +; +``` + + + +Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.

> [!NOTE]
> The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + +```sql +SELECT +check_suites, +total_count +FROM github.checks.suites +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +AND app_id = '{{ app_id }}' +AND check_name = '{{ check_name }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".

> [!NOTE]
> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.

OAuth apps and personal access tokens (classic) cannot use this endpoint. + +```sql +INSERT INTO github.checks.suites ( +head_sha, +owner, +repo +) +SELECT +'{{ head_sha }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +node_id, +after, +app, +before, +check_runs_url, +conclusion, +created_at, +head_branch, +head_commit, +head_sha, +latest_check_runs_count, +pull_requests, +repository, +rerequestable, +runs_rerequestable, +status, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: suites + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the suites resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the suites resource. + - name: head_sha + value: "{{ head_sha }}" + description: | + The sha of the head commit. +`} + + + + + +## `UPDATE` examples + + + + +Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite).
You must have admin permissions in the repository to set preferences for check suites. + +```sql +UPDATE github.checks.suites +SET +auto_trigger_checks = '{{ auto_trigger_checks }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +RETURNING +preferences, +repository; +``` + + + + +## Lifecycle Methods + + + + +Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + +```sql +EXEC github.checks.suites.rerequest_suite +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@check_suite_id='{{ check_suite_id }}' --required +; +``` + + diff --git a/website/docs/services/classroom/assignment_accepted_assignments/index.md b/website/docs/services/classroom/assignment_accepted_assignments/index.md new file mode 100644 index 0000000..7632923 --- /dev/null +++ b/website/docs/services/classroom/assignment_accepted_assignments/index.md @@ -0,0 +1,184 @@ +--- +title: assignment_accepted_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - assignment_accepted_assignments + - classroom + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an assignment_accepted_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the repository.
objectA GitHub Classroom assignment (title: Simple Classroom Assignment)
integerCount of student commits.
stringMost recent grade. (example: 10/10)
booleanWhether a submission passed.
objectA GitHub repository view for Classroom (title: Simple Classroom Repository)
array
booleanWhether an accepted assignment has been submitted.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
assignment_idpage, per_pageLists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the classroom assignment.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + +```sql +SELECT +id, +assignment, +commit_count, +grade, +passing, +repository, +students, +submitted +FROM github.classroom.assignment_accepted_assignments +WHERE assignment_id = '{{ assignment_id }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/classroom/assignment_grades/index.md b/website/docs/services/classroom/assignment_grades/index.md new file mode 100644 index 0000000..e3d8e17 --- /dev/null +++ b/website/docs/services/classroom/assignment_grades/index.md @@ -0,0 +1,190 @@ +--- +title: assignment_grades +hide_title: false +hide_table_of_contents: false +keywords: + - assignment_grades + - classroom + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an assignment_grades resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringName of the assignment
stringIf a group assignment, name of the group the student is in
stringName of the student's assignment repository
stringURL of the assignment
stringGitHub username of the student
integerNumber of points available for the assignment
integerNumber of points awarded to the student
stringRoster identifier of the student
stringURL of the starter code for the assignment
stringURL of the student's assignment repository
stringTimestamp of the student's assignment submission
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
assignment_idGets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the classroom assignment.
+ +## `SELECT` examples + + + + +Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + +```sql +SELECT +assignment_name, +group_name, +student_repository_name, +assignment_url, +github_username, +points_available, +points_awarded, +roster_identifier, +starter_code_url, +student_repository_url, +submission_timestamp +FROM github.classroom.assignment_grades +WHERE assignment_id = '{{ assignment_id }}' -- required +; +``` + + diff --git a/website/docs/services/classroom/assignments/index.md b/website/docs/services/classroom/assignments/index.md new file mode 100644 index 0000000..a77d779 --- /dev/null +++ b/website/docs/services/classroom/assignments/index.md @@ -0,0 +1,238 @@ +--- +title: assignments +hide_title: false +hide_table_of_contents: false +keywords: + - assignments + - classroom + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the repository.
integerThe number of students that have accepted the assignment.
objectA GitHub Classroom classroom (title: Classroom)
string (date-time)The time at which the assignment is due. (example: 2011-01-26T19:06:43Z)
stringThe selected editor for the assignment. (example: codespaces)
booleanWhether feedback pull request will be created when a student accepts the assignment.
booleanWhether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
stringThe link that a student can use to accept the assignment. (example: https://classroom.github.com/a/Lx7jiUgx)
stringThe programming language used in the assignment. (example: elixir)
integerThe maximum allowable members per team.
integerThe maximum allowable teams for the assignment.
integerThe number of students that have passed the assignment.
booleanWhether an accepted assignment creates a public repository.
stringSluggified name of the assignment. (example: intro-to-binaries)
objectA GitHub repository view for Classroom (title: Simple Classroom Repository)
booleanWhether students are admins on created repository when a student accepts the assignment.
integerThe number of students that have submitted the assignment.
stringAssignment title. (example: Intro to Binaries)
stringWhether it's a group assignment or individual assignment. (individual, group) (example: individual)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
assignment_idGets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the classroom assignment.
+ +## `SELECT` examples + + + + +Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. + +```sql +SELECT +id, +accepted, +classroom, +deadline, +editor, +feedback_pull_requests_enabled, +invitations_enabled, +invite_link, +language, +max_members, +max_teams, +passing, +public_repo, +slug, +starter_code_repository, +students_are_repo_admins, +submitted, +title, +type +FROM github.classroom.assignments +WHERE assignment_id = '{{ assignment_id }}' -- required +; +``` + + diff --git a/website/docs/services/classroom/classroom_assignments/index.md b/website/docs/services/classroom/classroom_assignments/index.md new file mode 100644 index 0000000..3b7af02 --- /dev/null +++ b/website/docs/services/classroom/classroom_assignments/index.md @@ -0,0 +1,244 @@ +--- +title: classroom_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - classroom_assignments + - classroom + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a classroom_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the repository.
integerThe number of students that have accepted the assignment.
objectA GitHub Classroom classroom (title: Simple Classroom)
string (date-time)The time at which the assignment is due. (example: 2011-01-26T19:06:43Z)
stringThe selected editor for the assignment. (example: codespaces)
booleanWhether feedback pull request will be created on assignment acceptance.
booleanWhether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
stringThe link that a student can use to accept the assignment. (example: https://classroom.github.com/a/Lx7jiUgx)
stringThe programming language used in the assignment. (example: elixir)
integerThe maximum allowable members per team.
integerThe maximum allowable teams for the assignment.
integerThe number of students that have passed the assignment.
booleanWhether an accepted assignment creates a public repository.
stringSluggified name of the assignment. (example: intro-to-binaries)
booleanWhether students are admins on created repository on accepted assignment.
integerThe number of students that have submitted the assignment.
stringAssignment title. (example: Intro to Binaries)
stringWhether it's a Group Assignment or Individual Assignment. (individual, group) (example: individual)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
classroom_idpage, per_pageLists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the classroom.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. + +```sql +SELECT +id, +accepted, +classroom, +deadline, +editor, +feedback_pull_requests_enabled, +invitations_enabled, +invite_link, +language, +max_members, +max_teams, +passing, +public_repo, +slug, +students_are_repo_admins, +submitted, +title, +type +FROM github.classroom.classroom_assignments +WHERE classroom_id = '{{ classroom_id }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/classroom/classrooms/index.md b/website/docs/services/classroom/classrooms/index.md new file mode 100644 index 0000000..3033463 --- /dev/null +++ b/website/docs/services/classroom/classrooms/index.md @@ -0,0 +1,225 @@ +--- +title: classrooms +hide_title: false +hide_table_of_contents: false +keywords: + - classrooms + - classroom + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a classrooms resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the classroom.
stringThe name of the classroom. (example: Programming Elixir)
booleanWhether classroom is archived.
objectA GitHub organization. (title: Organization Simple for Classroom)
stringThe URL of the classroom on GitHub Classroom. (example: https://classroom.github.com/classrooms/1-programming-elixir)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the classroom.
stringThe name of the classroom. (example: Programming Elixir)
booleanReturns whether classroom is archived or not.
stringThe url of the classroom on GitHub Classroom. (example: https://classroom.github.com/classrooms/1-programming-elixir)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
classroom_idGets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
page, per_pageLists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the classroom.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. + +```sql +SELECT +id, +name, +archived, +organization, +url +FROM github.classroom.classrooms +WHERE classroom_id = '{{ classroom_id }}' -- required +; +``` + + + +Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. + +```sql +SELECT +id, +name, +archived, +url +FROM github.classroom.classrooms +WHERE page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/classroom/index.md b/website/docs/services/classroom/index.md new file mode 100644 index 0000000..1599b33 --- /dev/null +++ b/website/docs/services/classroom/index.md @@ -0,0 +1,36 @@ +--- +title: classroom +hide_title: false +hide_table_of_contents: false +keywords: + - classroom + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +classroom service documentation. + +:::info[Service Summary] + +total resources: __5__ + +::: + +## Resources +
+
+assignment_accepted_assignments
+assignment_grades
+assignments +
+
+classroom_assignments
+classrooms +
+
\ No newline at end of file diff --git a/website/docs/services/code_scanning/alert_autofixes/index.md b/website/docs/services/code_scanning/alert_autofixes/index.md new file mode 100644 index 0000000..b2cc127 --- /dev/null +++ b/website/docs/services/code_scanning/alert_autofixes/index.md @@ -0,0 +1,246 @@ +--- +title: alert_autofixes +hide_title: false +hide_table_of_contents: false +keywords: + - alert_autofixes + - code_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an alert_autofixes resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe description of an autofix.
string (date-time)The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe status of an autofix. (pending, error, success, outdated)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, alert_numberGets the status and description of an autofix for a code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, alert_numberCreates an autofix for a code scanning alert.

If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.

If an autofix already exists for a given alert, then this endpoint will return a 200 OK response.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, alert_numberCommits an autofix for a code scanning alert.

If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the status and description of an autofix for a code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +description, +started_at, +status +FROM github.code_scanning.alert_autofixes +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND alert_number = '{{ alert_number }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Creates an autofix for a code scanning alert.

If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.

If an autofix already exists for a given alert, then this endpoint will return a 200 OK response.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +INSERT INTO github.code_scanning.alert_autofixes ( +owner, +repo, +alert_number +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ alert_number }}' +RETURNING +description, +started_at, +status +; +``` + + + +{`# Description fields are for documentation purposes +- name: alert_autofixes + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the alert_autofixes resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the alert_autofixes resource. + - name: alert_number + value: {{ alert_number }} + description: Required parameter for the alert_autofixes resource. +`} + + + + + +## Lifecycle Methods + + + + +Commits an autofix for a code scanning alert.

If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +EXEC github.code_scanning.alert_autofixes.commit_autofix +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@alert_number='{{ alert_number }}' --required +@@json= +'{ +"target_ref": "{{ target_ref }}", +"message": "{{ message }}" +}' +; +``` + + diff --git a/website/docs/services/code_scanning/alert_instances/index.md b/website/docs/services/code_scanning/alert_instances/index.md index 8d686df..742fa65 100644 --- a/website/docs/services/code_scanning/alert_instances/index.md +++ b/website/docs/services/code_scanning/alert_instances/index.md @@ -1,46 +1,220 @@ ---- +--- title: alert_instances hide_title: false hide_table_of_contents: false keywords: - alert_instances - code_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an alert_instances resource. ## Overview - +
Namealert_instances
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. | -| | `string` | Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. | -| | `array` | Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file. | -| | `string` | | -| | `string` | Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. | -| | `string` | | -| | `object` | Describe a region within a file for the alert. | -| | `object` | | -| | `string` | The full Git reference, formatted as `refs/heads/<branch name>`,
`refs/pull/<number>/merge`, or `refs/pull/<number>/head`. | -| | `string` | State of a code scanning alert. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringIdentifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
stringIdentifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
arrayClassifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.
string
stringIdentifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
string
objectDescribe a region within a file for the alert.
object
stringThe Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``.
stringState of a code scanning alert instance. (open, fixed)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, alert_numberpage, per_page, ref, prLists all instances of the specified code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of the pull request for the results you want to list.
stringThe Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.
+ +## `SELECT` examples + + + + +Lists all instances of the specified code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +analysis_key, +category, +classifications, +commit_sha, +environment, +html_url, +location, +message, +ref, +state +FROM github.code_scanning.alert_instances +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND alert_number = '{{ alert_number }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND ref = '{{ ref }}' +AND pr = '{{ pr }}' +; +``` + + diff --git a/website/docs/services/code_scanning/alert_items/index.md b/website/docs/services/code_scanning/alert_items/index.md new file mode 100644 index 0000000..3529ddf --- /dev/null +++ b/website/docs/services/code_scanning/alert_items/index.md @@ -0,0 +1,470 @@ +--- +title: alert_items +hide_title: false +hide_table_of_contents: false +keywords: + - alert_items + - code_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an alert_items resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringThe dismissal comment associated with the dismissal of the alert.
string**Required when the state is dismissed.** The reason for dismissing or closing the alert. (false positive, won't fix, used in tests)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
string (uri)The REST API URL for fetching the list of instances for an alert.
object
integerThe security alert number.
object
stringState of a code scanning alert. (open, dismissed, fixed)
object
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringThe dismissal comment associated with the dismissal of the alert.
string**Required when the state is dismissed.** The reason for dismissing or closing the alert. (false positive, won't fix, used in tests)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
string (uri)The REST API URL for fetching the list of instances for an alert.
object
integerThe security alert number.
objectA GitHub repository. (title: Simple Repository)
object
stringState of a code scanning alert. (open, dismissed, fixed)
object
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repotool_name, tool_guid, page, per_page, ref, pr, direction, before, after, sort, state, severity, assigneesLists code scanning alerts.

The response includes a `most_recent_instance` object.
This provides details of the most recent instance of this alert
for the default branch (or for the specified Git reference if you used `ref` in the request).

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
orgtool_name, tool_guid, before, after, page, per_page, direction, state, sort, severity, assigneesLists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFilter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe direction to sort the results by.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of the pull request for the results you want to list.
stringThe Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.
stringIf specified, only code scanning alerts with this severity will be returned.
stringThe property by which to sort the results.
stringIf specified, only code scanning alerts with this state will be returned.
stringThe GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.
stringThe name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.
+ +## `SELECT` examples + + + + +Lists code scanning alerts.

The response includes a `most_recent_instance` object.
This provides details of the most recent instance of this alert
for the default branch (or for the specified Git reference if you used `ref` in the request).

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +assignees, +created_at, +dismissal_approved_by, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +instances_url, +most_recent_instance, +number, +rule, +state, +tool, +updated_at, +url +FROM github.code_scanning.alert_items +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND tool_name = '{{ tool_name }}' +AND tool_guid = '{{ tool_guid }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND ref = '{{ ref }}' +AND pr = '{{ pr }}' +AND direction = '{{ direction }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND sort = '{{ sort }}' +AND state = '{{ state }}' +AND severity = '{{ severity }}' +AND assignees = '{{ assignees }}' +; +``` + + + +Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +assignees, +created_at, +dismissal_approved_by, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +instances_url, +most_recent_instance, +number, +repository, +rule, +state, +tool, +updated_at, +url +FROM github.code_scanning.alert_items +WHERE org = '{{ org }}' -- required +AND tool_name = '{{ tool_name }}' +AND tool_guid = '{{ tool_guid }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND direction = '{{ direction }}' +AND state = '{{ state }}' +AND sort = '{{ sort }}' +AND severity = '{{ severity }}' +AND assignees = '{{ assignees }}' +; +``` + + diff --git a/website/docs/services/code_scanning/alerts/index.md b/website/docs/services/code_scanning/alerts/index.md index 05510b3..f1c4cb6 100644 --- a/website/docs/services/code_scanning/alerts/index.md +++ b/website/docs/services/code_scanning/alerts/index.md @@ -1,52 +1,294 @@ ---- +--- title: alerts hide_title: false hide_table_of_contents: false keywords: - alerts - code_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an alerts resource. ## Overview - +
Namealerts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | The dismissal comment associated with the dismissal of the alert. | -| | `string` | **Required when the state is dismissed.** The reason for dismissing or closing the alert. | -| | `string` | The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `string` | The REST API URL for fetching the list of instances for an alert. | -| | `object` | | -| | `integer` | The security alert number. | -| | `object` | | -| | `string` | State of a code scanning alert. | -| | `object` | | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringThe dismissal comment associated with the dismissal of the alert.
string**Required when the state is dismissed.** The reason for dismissing or closing the alert. (false positive, won't fix, used in tests)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
string (uri)The REST API URL for fetching the list of instances for an alert.
object
integerThe security alert number.
object
stringState of a code scanning alert. (open, dismissed, fixed)
object
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. | -| | `EXEC` | | Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, alert_numberGets a single code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, alert_number, state, assigneesUpdates the status of a single code scanning alert.
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a single code scanning alert.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +assignees, +created_at, +dismissal_approved_by, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +instances_url, +most_recent_instance, +number, +rule, +state, +tool, +updated_at, +url +FROM github.code_scanning.alerts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND alert_number = '{{ alert_number }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Updates the status of a single code scanning alert.
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +UPDATE github.code_scanning.alerts +SET +state = '{{ state }}', +dismissed_reason = '{{ dismissed_reason }}', +dismissed_comment = '{{ dismissed_comment }}', +create_request = {{ create_request }}, +assignees = '{{ assignees }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND alert_number = '{{ alert_number }}' --required +AND state = '{{ state }}' --required +AND assignees = '{{ assignees }}' --required +RETURNING +assignees, +created_at, +dismissal_approved_by, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +instances_url, +most_recent_instance, +number, +rule, +state, +tool, +updated_at, +url; +``` + + diff --git a/website/docs/services/code_scanning/analysis/index.md b/website/docs/services/code_scanning/analysis/index.md index 85c891d..a840d32 100644 --- a/website/docs/services/code_scanning/analysis/index.md +++ b/website/docs/services/code_scanning/analysis/index.md @@ -1,53 +1,443 @@ ---- +--- title: analysis hide_title: false hide_table_of_contents: false keywords: - analysis - code_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an analysis resource. ## Overview - +
Nameanalysis
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier for this analysis. | -| | `string` | Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. | -| | `string` | Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. | -| | `string` | The SHA of the commit to which the analysis you are uploading relates. | -| | `string` | The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `boolean` | | -| | `string` | Identifies the variable values associated with the environment in which this analysis was performed. | -| | `string` | | -| | `string` | The full Git reference, formatted as `refs/heads/<branch name>`,
`refs/pull/<number>/merge`, or `refs/pull/<number>/head`. | -| | `integer` | The total number of results in the analysis. | -| | `integer` | The total number of rules used in the analysis. | -| | `string` | An identifier for the upload. | -| | `object` | | -| | `string` | The REST API URL of the analysis resource. | -| | `string` | Warning generated when processing the analysis | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier for this analysis.
stringAn identifier for the upload. (example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53)
stringIdentifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
stringIdentifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
stringThe SHA of the commit to which the analysis you are uploading relates. (pattern: ^[0-9a-fA-F]+$)
string (date-time)The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
boolean
stringIdentifies the variable values associated with the environment in which this analysis was performed.
string (example: error reading field xyz)
stringThe Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``.
integerThe total number of results in the analysis.
integerThe total number of rules used in the analysis.
object
string (uri)The REST API URL of the analysis resource.
stringWarning generated when processing the analysis (example: 123 results were ignored)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier for this analysis.
stringAn identifier for the upload. (example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53)
stringIdentifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
stringIdentifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
stringThe SHA of the commit to which the analysis you are uploading relates. (pattern: ^[0-9a-fA-F]+$)
string (date-time)The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
boolean
stringIdentifies the variable values associated with the environment in which this analysis was performed.
string (example: error reading field xyz)
stringThe Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``.
integerThe total number of results in the analysis.
integerThe total number of rules used in the analysis.
object
string (uri)The REST API URL of the analysis resource.
stringWarning generated when processing the analysis (example: 123 results were ignored)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specified code scanning analysis for a repository.
You must use an access token with the `security_events` scope to use this endpoint with private repos,
the `public_repo` scope also grants permission to read security events on public repos only.
GitHub Apps must have the `security_events` read permission to use this endpoint.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The `rules_count` field in the default response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

If you use the Accept header `application/sarif+json`,
the response contains the analysis data that was uploaded.
This is formatted as
[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). | -| | `SELECT` | | Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the `page` and `per_page` parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The `rules_count` field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

You must use an access token with the `security_events` scope to use this endpoint with private repos,
the `public_repo` scope also grants permission to read security events on public repos only.
GitHub Apps must have the `security_events` read permission to use this endpoint.

**Deprecation notice**:
The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. | -| | `DELETE` | | Deletes a specified code scanning analysis from a repository. For
private repositories, you must use an access token with the `repo` scope. For public repositories,
you must use an access token with `public_repo` scope.
GitHub Apps must have the `security_events` write permission to use this endpoint.

You can delete one analysis at a time.
To delete a series of analyses, start with the most recent analysis and work backwards.
Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository,
one or more will be identified as deletable in the response:

```
"deletable": true
```

An analysis is deletable when it's the most recent in a set of analyses.
Typically, a repository will have multiple sets of analyses
for each enabled code scanning tool,
where a set is determined by a unique combination of analysis values:

* `ref`
* `tool`
* `category`

If you attempt to delete an analysis that is not the most recent in a set,
you'll get a 400 response with the message:

```
Analysis specified is not deletable.
```

The response from a successful `DELETE` operation provides you with
two alternative URLs for deleting the next analysis in the set:
`next_analysis_url` and `confirm_delete_url`.
Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
in a set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
in the 200 response is `null`.

As an example of the deletion process,
let's imagine that you added a workflow that configured a particular code scanning tool
to analyze the code in a repository. This tool has added 15 analyses:
10 on the default branch, and another 5 on a topic branch.
You therefore have two separate sets of analyses for this tool.
You've now decided that you want to remove all of the analyses for the tool.
To do this you must make 15 separate deletion requests.
To start, you must find an analysis that's identified as deletable.
Each set of analyses always has one that's identified as deletable.
Having found the deletable analysis for one of the two sets,
delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
Then repeat the process for the second set.
The procedure therefore consists of a nested loop:

**Outer loop**:
* List the analyses for the repository, filtered by tool.
* Parse this list to find a deletable analysis. If found:

**Inner loop**:
* Delete the identified analysis.
* Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, analysis_idGets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The `rules_count` field in the default response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repotool_name, tool_guid, page, per_page, pr, ref, sarif_id, direction, sortLists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the `page` and `per_page` parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The `rules_count` field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

> [!WARNING]
> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, analysis_idconfirm_deleteDeletes a specified code scanning analysis from a repository.

You can delete one analysis at a time.
To delete a series of analyses, start with the most recent analysis and work backwards.
Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository,
one or more will be identified as deletable in the response:

```
"deletable": true
```

An analysis is deletable when it's the most recent in a set of analyses.
Typically, a repository will have multiple sets of analyses
for each enabled code scanning tool,
where a set is determined by a unique combination of analysis values:

* `ref`
* `tool`
* `category`

If you attempt to delete an analysis that is not the most recent in a set,
you'll get a 400 response with the message:

```
Analysis specified is not deletable.
```

The response from a successful `DELETE` operation provides you with
two alternative URLs for deleting the next analysis in the set:
`next_analysis_url` and `confirm_delete_url`.
Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
in a set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
in the 200 response is `null`.

As an example of the deletion process,
let's imagine that you added a workflow that configured a particular code scanning tool
to analyze the code in a repository. This tool has added 15 analyses:
10 on the default branch, and another 5 on a topic branch.
You therefore have two separate sets of analyses for this tool.
You've now decided that you want to remove all of the analyses for the tool.
To do this you must make 15 separate deletion requests.
To start, you must find an analysis that's identified as deletable.
Each set of analyses always has one that's identified as deletable.
Having found the deletable analysis for one of the two sets,
delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
Then repeat the process for the second set.
The procedure therefore consists of a nested loop:

**Outer loop**:
* List the analyses for the repository, filtered by tool.
* Parse this list to find a deletable analysis. If found:

**Inner loop**:
* Delete the identified analysis.
* Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringAllow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`
stringThe direction to sort the results by.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of the pull request for the results you want to list.
stringThe Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.
stringFilter analyses belonging to the same SARIF upload.
stringThe property by which to sort the results.
stringThe GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.
stringThe name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.
+ +## `SELECT` examples + + + + +Gets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis.
This includes the Git reference and commit SHA to which the analysis relates,
the datetime of the analysis, the name of the code scanning tool,
and the number of alerts.

The `rules_count` field in the default response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +id, +sarif_id, +analysis_key, +category, +commit_sha, +created_at, +deletable, +environment, +error, +ref, +results_count, +rules_count, +tool, +url, +warning +FROM github.code_scanning.analysis +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND analysis_id = '{{ analysis_id }}' -- required +; +``` + + + +Lists the details of all code scanning analyses for a repository,
starting with the most recent.
The response is paginated and you can use the `page` and `per_page` parameters
to list the analyses you're interested in.
By default 30 analyses are listed per page.

The `rules_count` field in the response give the number of rules
that were run in the analysis.
For very old analyses this data is not available,
and `0` is returned in this field.

> [!WARNING]
> **Closing down notice:** The `tool_name` field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +id, +sarif_id, +analysis_key, +category, +commit_sha, +created_at, +deletable, +environment, +error, +ref, +results_count, +rules_count, +tool, +url, +warning +FROM github.code_scanning.analysis +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND tool_name = '{{ tool_name }}' +AND tool_guid = '{{ tool_guid }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND pr = '{{ pr }}' +AND ref = '{{ ref }}' +AND sarif_id = '{{ sarif_id }}' +AND direction = '{{ direction }}' +AND sort = '{{ sort }}' +; +``` + + + + +## `DELETE` examples + + + + +Deletes a specified code scanning analysis from a repository.

You can delete one analysis at a time.
To delete a series of analyses, start with the most recent analysis and work backwards.
Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository,
one or more will be identified as deletable in the response:

```
"deletable": true
```

An analysis is deletable when it's the most recent in a set of analyses.
Typically, a repository will have multiple sets of analyses
for each enabled code scanning tool,
where a set is determined by a unique combination of analysis values:

* `ref`
* `tool`
* `category`

If you attempt to delete an analysis that is not the most recent in a set,
you'll get a 400 response with the message:

```
Analysis specified is not deletable.
```

The response from a successful `DELETE` operation provides you with
two alternative URLs for deleting the next analysis in the set:
`next_analysis_url` and `confirm_delete_url`.
Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis
in a set. This is a useful option if you want to preserve at least one analysis
for the specified tool in your repository.
Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool.
When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url`
in the 200 response is `null`.

As an example of the deletion process,
let's imagine that you added a workflow that configured a particular code scanning tool
to analyze the code in a repository. This tool has added 15 analyses:
10 on the default branch, and another 5 on a topic branch.
You therefore have two separate sets of analyses for this tool.
You've now decided that you want to remove all of the analyses for the tool.
To do this you must make 15 separate deletion requests.
To start, you must find an analysis that's identified as deletable.
Each set of analyses always has one that's identified as deletable.
Having found the deletable analysis for one of the two sets,
delete this analysis and then continue deleting the next analysis in the set until they're all deleted.
Then repeat the process for the second set.
The procedure therefore consists of a nested loop:

**Outer loop**:
* List the analyses for the repository, filtered by tool.
* Parse this list to find a deletable analysis. If found:

**Inner loop**:
* Delete the identified analysis.
* Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +DELETE FROM github.code_scanning.analysis +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND analysis_id = '{{ analysis_id }}' --required +AND confirm_delete = '{{ confirm_delete }}' +; +``` + + diff --git a/website/docs/services/code_scanning/codeql_databases/index.md b/website/docs/services/code_scanning/codeql_databases/index.md index b6b2955..77f4f00 100644 --- a/website/docs/services/code_scanning/codeql_databases/index.md +++ b/website/docs/services/code_scanning/codeql_databases/index.md @@ -1,46 +1,323 @@ ---- +--- title: codeql_databases hide_title: false hide_table_of_contents: false keywords: - codeql_databases - code_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a codeql_databases resource. ## Overview - +
Namecodeql_databases
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The ID of the CodeQL database. | -| | `string` | The name of the CodeQL database. | -| | `string` | The MIME type of the CodeQL database file. | -| | `string` | The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The language of the CodeQL database. | -| | `integer` | The size of the CodeQL database file in bytes. | -| | `string` | The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `object` | A GitHub user. | -| | `string` | The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the CodeQL database.
stringThe name of the CodeQL database.
stringThe commit SHA of the repository at the time the CodeQL database was created.
stringThe MIME type of the CodeQL database file.
string (date-time)The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe language of the CodeQL database.
integerThe size of the CodeQL database file in bytes.
string (date-time)The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
objectA GitHub user. (title: Simple User)
string (uri)The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the CodeQL database.
stringThe name of the CodeQL database.
stringThe commit SHA of the repository at the time the CodeQL database was created.
stringThe MIME type of the CodeQL database file.
string (date-time)The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe language of the CodeQL database.
integerThe size of the CodeQL database file in bytes.
string (date-time)The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
objectA GitHub user. (title: Simple User)
string (uri)The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To
download the CodeQL database binary content, set the `Accept` header of the request
to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure
your HTTP client is configured to follow redirects or use the `Location` header
to make a second request to get the redirect URL.

For private repositories, you must use an access token with the `security_events` scope.
For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
GitHub Apps must have the `contents` read permission to use this endpoint. | -| | `SELECT` | | Lists the CodeQL databases that are available in a repository.

For private repositories, you must use an access token with the `security_events` scope.
For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
GitHub Apps must have the `contents` read permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, languageGets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To
download the CodeQL database binary content, set the `Accept` header of the request
to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure
your HTTP client is configured to follow redirects or use the `Location` header
to make a second request to get the redirect URL.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repoLists the CodeQL databases that are available in a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, languageDeletes a CodeQL database for a language in a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe language of the CodeQL database.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To
download the CodeQL database binary content, set the `Accept` header of the request
to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types), and make sure
your HTTP client is configured to follow redirects or use the `Location` header
to make a second request to get the redirect URL.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +id, +name, +commit_oid, +content_type, +created_at, +language, +size, +updated_at, +uploader, +url +FROM github.code_scanning.codeql_databases +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND language = '{{ language }}' -- required +; +``` + + + +Lists the CodeQL databases that are available in a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +id, +name, +commit_oid, +content_type, +created_at, +language, +size, +updated_at, +uploader, +url +FROM github.code_scanning.codeql_databases +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `DELETE` examples + + + + +Deletes a CodeQL database for a language in a repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +DELETE FROM github.code_scanning.codeql_databases +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND language = '{{ language }}' --required +; +``` + + diff --git a/website/docs/services/code_scanning/codeql_variant_analyses/index.md b/website/docs/services/code_scanning/codeql_variant_analyses/index.md new file mode 100644 index 0000000..97c1d07 --- /dev/null +++ b/website/docs/services/code_scanning/codeql_variant_analyses/index.md @@ -0,0 +1,310 @@ +--- +title: codeql_variant_analyses +hide_title: false +hide_table_of_contents: false +keywords: + - codeql_variant_analyses + - code_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a codeql_variant_analyses resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the variant analysis.
integerThe GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started.
objectA GitHub user. (title: Simple User)
string (date-time)The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available.
objectA GitHub repository. (title: Simple Repository)
string (date-time)The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe reason for a failure of the variant analysis. This is only available if the variant analysis has failed. (no_repos_queried, actions_workflow_run_failed, internal_error)
stringThe language targeted by the CodeQL query (actions, cpp, csharp, go, java, javascript, python, ruby, rust, swift)
stringThe download url for the query pack.
array
objectInformation about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis.
string (in_progress, succeeded, failed, cancelled)
string (date-time)The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, codeql_variant_analysis_idGets the summary of a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, language, query_pack, repositories, repository_lists, repository_ownersCreates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).

Use the `owner` and `repo` parameters in the URL to specify the controller repository that
will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the variant analysis.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the summary of a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +id, +actions_workflow_run_id, +actor, +completed_at, +controller_repo, +created_at, +failure_reason, +query_language, +query_pack_url, +scanned_repositories, +skipped_repositories, +status, +updated_at +FROM github.code_scanning.codeql_variant_analyses +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND codeql_variant_analysis_id = '{{ codeql_variant_analysis_id }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis).

Use the `owner` and `repo` parameters in the URL to specify the controller repository that
will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.code_scanning.codeql_variant_analyses ( +language, +query_pack, +repositories, +repository_lists, +repository_owners, +owner, +repo +) +SELECT +'{{ language }}' /* required */, +'{{ query_pack }}' /* required */, +'{{ repositories }}' /* required */, +'{{ repository_lists }}' /* required */, +'{{ repository_owners }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +actions_workflow_run_id, +actor, +completed_at, +controller_repo, +created_at, +failure_reason, +query_language, +query_pack_url, +scanned_repositories, +skipped_repositories, +status, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: codeql_variant_analyses + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the codeql_variant_analyses resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the codeql_variant_analyses resource. + - name: language + value: "{{ language }}" + description: | + The language targeted by the CodeQL query + valid_values: ['actions', 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'rust', 'swift'] + - name: query_pack + value: "{{ query_pack }}" + description: | + A Base64-encoded tarball containing a CodeQL query and all its dependencies + - name: repositories + value: + - "{{ repositories }}" + description: | + List of repository names (in the form \`owner/repo-name\`) to run the query against. Precisely one property from \`repositories\`, \`repository_lists\` and \`repository_owners\` is required. + - name: repository_lists + value: + - "{{ repository_lists }}" + description: | + List of repository lists to run the query against. Precisely one property from \`repositories\`, \`repository_lists\` and \`repository_owners\` is required. + - name: repository_owners + value: + - "{{ repository_owners }}" + description: | + List of organization or user names whose repositories the query should be run against. Precisely one property from \`repositories\`, \`repository_lists\` and \`repository_owners\` is required. +`} + + + diff --git a/website/docs/services/code_scanning/codeql_variant_analysis_repo_tasks/index.md b/website/docs/services/code_scanning/codeql_variant_analysis_repo_tasks/index.md new file mode 100644 index 0000000..4c2ae50 --- /dev/null +++ b/website/docs/services/code_scanning/codeql_variant_analysis_repo_tasks/index.md @@ -0,0 +1,196 @@ +--- +title: codeql_variant_analysis_repo_tasks +hide_title: false +hide_table_of_contents: false +keywords: + - codeql_variant_analysis_repo_tasks + - code_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a codeql_variant_analysis_repo_tasks resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe new status of the CodeQL variant analysis repository task. (pending, in_progress, succeeded, failed, canceled, timed_out)
integerThe size of the artifact. This is only available for successful analyses.
stringThe URL of the artifact. This is only available for successful analyses.
stringThe SHA of the commit the CodeQL database was built against. This is only available for successful analyses.
stringThe reason of the failure of this repo task. This is only available if the repository task has failed.
objectA GitHub repository. (title: Simple Repository)
integerThe number of results in the case of a successful analysis. This is only available for successful analyses.
stringThe source location prefix to use. This is only available for successful analyses.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, codeql_variant_analysis_id, repo_owner, repo_nameGets the analysis status of a repository in a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the variant analysis.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the controller repository.
stringThe name of the variant analysis repository.
stringThe account owner of the variant analysis repository. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the analysis status of a repository in a CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +analysis_status, +artifact_size_in_bytes, +artifact_url, +database_commit_sha, +failure_message, +repository, +result_count, +source_location_prefix +FROM github.code_scanning.codeql_variant_analysis_repo_tasks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND codeql_variant_analysis_id = '{{ codeql_variant_analysis_id }}' -- required +AND repo_owner = '{{ repo_owner }}' -- required +AND repo_name = '{{ repo_name }}' -- required +; +``` + + diff --git a/website/docs/services/code_scanning/default_setup/index.md b/website/docs/services/code_scanning/default_setup/index.md index 38f884f..61be631 100644 --- a/website/docs/services/code_scanning/default_setup/index.md +++ b/website/docs/services/code_scanning/default_setup/index.md @@ -1,42 +1,214 @@ ---- +--- title: default_setup hide_title: false hide_table_of_contents: false keywords: - default_setup - code_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a default_setup resource. ## Overview - +
Namedefault_setup
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | Languages to be analysed. | -| | `string` | CodeQL query suite to be used. | -| | `string` | The frequency of the periodic analysis. | -| | `string` | Code scanning default setup has been configured or not. | -| | `string` | Timestamp of latest configuration update. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayLanguages to be analyzed.
stringCodeQL query suite to be used. (default, extended)
stringRunner label to be used if the runner type is labeled. (example: code-scanning)
stringRunner type to be used. (standard, labeled)
stringThe frequency of the periodic analysis. (weekly)
stringCode scanning default setup has been configured or not. (configured, not-configured)
stringThreat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. (remote, remote_and_local)
string (date-time)Timestamp of latest configuration update. (example: 2023-12-06T14:20:20.000Z)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a code scanning default setup configuration.
You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. | -| | `EXEC` | | Updates a code scanning default setup configuration.
You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`
scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repoUpdates a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +languages, +query_suite, +runner_label, +runner_type, +schedule, +state, +threat_model, +updated_at +FROM github.code_scanning.default_setup +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Updates a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +UPDATE github.code_scanning.default_setup +SET +state = '{{ state }}', +runner_type = '{{ runner_type }}', +runner_label = '{{ runner_label }}', +query_suite = '{{ query_suite }}', +threat_model = '{{ threat_model }}', +languages = '{{ languages }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + diff --git a/website/docs/services/code_scanning/index.md b/website/docs/services/code_scanning/index.md index 453f8bf..0de34d9 100644 --- a/website/docs/services/code_scanning/index.md +++ b/website/docs/services/code_scanning/index.md @@ -9,46 +9,33 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Code Scanning - -:::info Service Summary +code_scanning service documentation. -
-
-total resources: 8
-total selectable resources: 8
-total methods: 14
-
-
+:::info[Service Summary] -::: +total resources: __10__ -## Overview - - - - - - -
Namegithub.code_scanning
TypeService
TitleGitHub V3 REST API - Code Scanning
DescriptionCode Scanning
Idcode_scanning:v24.04.00227
+::: ## Resources
+alert_autofixes
alert_instances
+alert_items
alerts
-analysis
-codeql_databases
+analysis
+codeql_databases
+codeql_variant_analyses
+codeql_variant_analysis_repo_tasks
default_setup
-org_alert_items
-repo_alert_items
-sarifs
-
+sarifs
+ \ No newline at end of file diff --git a/website/docs/services/code_scanning/org_alert_items/index.md b/website/docs/services/code_scanning/org_alert_items/index.md deleted file mode 100644 index 7eca274..0000000 --- a/website/docs/services/code_scanning/org_alert_items/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: org_alert_items -hide_title: false -hide_table_of_contents: false -keywords: - - org_alert_items - - code_scanning - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_alert_items
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | The dismissal comment associated with the dismissal of the alert. | -| | `string` | **Required when the state is dismissed.** The reason for dismissing or closing the alert. | -| | `string` | The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `string` | The REST API URL for fetching the list of instances for an alert. | -| | `object` | | -| | `integer` | The security alert number. | -| | `object` | A GitHub repository. | -| | `object` | | -| | `string` | State of a code scanning alert. | -| | `object` | | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/code_scanning/repo_alert_items/index.md b/website/docs/services/code_scanning/repo_alert_items/index.md deleted file mode 100644 index fc180b5..0000000 --- a/website/docs/services/code_scanning/repo_alert_items/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: repo_alert_items -hide_title: false -hide_table_of_contents: false -keywords: - - repo_alert_items - - code_scanning - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namerepo_alert_items
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | The dismissal comment associated with the dismissal of the alert. | -| | `string` | **Required when the state is dismissed.** The reason for dismissing or closing the alert. | -| | `string` | The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `string` | The REST API URL for fetching the list of instances for an alert. | -| | `object` | | -| | `integer` | The security alert number. | -| | `object` | | -| | `string` | State of a code scanning alert. | -| | `object` | | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/code_scanning/sarifs/index.md b/website/docs/services/code_scanning/sarifs/index.md index c50f1ef..b362e1c 100644 --- a/website/docs/services/code_scanning/sarifs/index.md +++ b/website/docs/services/code_scanning/sarifs/index.md @@ -1,40 +1,197 @@ ---- +--- title: sarifs hide_title: false hide_table_of_contents: false keywords: - sarifs - code_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a sarifs resource. ## Overview - +
Namesarifs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The REST API URL for getting the analyses associated with the upload. | -| | `array` | Any errors that ocurred during processing of the delivery. | -| | `string` | `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (uri)The REST API URL for getting the analyses associated with the upload.
arrayAny errors that ocurred during processing of the delivery.
string`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. (pending, complete, failed)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. | -| | `EXEC` | | Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."

There are two places where you can upload code scanning results.
- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."

You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:

```
gzip -c analysis-data.sarif \| base64 -w0
```
<br>
SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."


\| **SARIF data** \| **Maximum values** \| **Additional limits** \|
\|----------------------------------\|:------------------:\|----------------------------------------------------------------------------------\|
\| Runs per file \| 20 \| \|
\| Results per run \| 25,000 \| Only the top 5,000 results will be included, prioritized by severity. \|
\| Rules per run \| 25,000 \| \|
\| Tool extensions per run \| 100 \| \|
\| Thread Flow Locations per result \| 10,000 \| Only the top 1,000 Thread Flow Locations will be included, using prioritization. \|
\| Location per result \| 1,000 \| Only 100 locations will be included. \|
\| Tags per rule \| 20 \| Only 10 tags will be included. \|


The `202 Accepted` response includes an `id` value.
You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, sarif_idGets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
owner, repo, commit_sha, ref, sarifUploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."

There are two places where you can upload code scanning results.
- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](https://docs.github.com/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](https://docs.github.com/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."

You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:

```
gzip -c analysis-data.sarif | base64 -w0
```

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."


| **SARIF data** | **Maximum values** | **Additional limits** |
|----------------------------------|:------------------:|----------------------------------------------------------------------------------|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |


The `202 Accepted` response includes an `id` value.
You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
For more information, see "[Get information about a SARIF upload](https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe SARIF ID obtained after uploading.
+ +## `SELECT` examples + + + + +Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + +```sql +SELECT +analyses_url, +errors, +processing_status +FROM github.code_scanning.sarifs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND sarif_id = '{{ sarif_id }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."

There are two places where you can upload code scanning results.
- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](https://docs.github.com/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](https://docs.github.com/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."

You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:

```
gzip -c analysis-data.sarif | base64 -w0
```

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)."


| **SARIF data** | **Maximum values** | **Additional limits** |
|----------------------------------|:------------------:|----------------------------------------------------------------------------------|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |


The `202 Accepted` response includes an `id` value.
You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
For more information, see "[Get information about a SARIF upload](https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. + +```sql +UPDATE github.code_scanning.sarifs +SET +commit_sha = '{{ commit_sha }}', +ref = '{{ ref }}', +sarif = '{{ sarif }}', +checkout_uri = '{{ checkout_uri }}', +started_at = '{{ started_at }}', +tool_name = '{{ tool_name }}', +validate = {{ validate }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND commit_sha = '{{ commit_sha }}' --required +AND ref = '{{ ref }}' --required +AND sarif = '{{ sarif }}' --required +RETURNING +id, +url; +``` + + diff --git a/website/docs/services/code_security/code_security_configuration_repos/index.md b/website/docs/services/code_security/code_security_configuration_repos/index.md new file mode 100644 index 0000000..9b9a386 --- /dev/null +++ b/website/docs/services/code_security/code_security_configuration_repos/index.md @@ -0,0 +1,224 @@ +--- +title: code_security_configuration_repos +hide_title: false +hide_table_of_contents: false +keywords: + - code_security_configuration_repos + - code_security + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a code_security_configuration_repos resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA GitHub repository. (title: Simple Repository)
stringThe attachment status of the code security configuration on the repository. (attached, attaching, detached, removed, enforced, failed, updating, removed_by_enterprise)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA GitHub repository. (title: Simple Repository)
stringThe attachment status of the code security configuration on the repository. (attached, attaching, detached, removed, enforced, failed, updating, removed_by_enterprise)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, configuration_idper_page, before, after, statusLists the repositories associated with an enterprise code security configuration in an organization.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
org, configuration_idper_page, before, after, statusLists the repositories associated with a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the code security configuration.
stringThe slug version of the enterprise name.
stringThe organization name. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`
+ +## `SELECT` examples + + + + +Lists the repositories associated with an enterprise code security configuration in an organization.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + +```sql +SELECT +repository, +status +FROM github.code_security.code_security_configuration_repos +WHERE enterprise = '{{ enterprise }}' -- required +AND configuration_id = '{{ configuration_id }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND status = '{{ status }}' +; +``` + + + +Lists the repositories associated with a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +repository, +status +FROM github.code_security.code_security_configuration_repos +WHERE org = '{{ org }}' -- required +AND configuration_id = '{{ configuration_id }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND status = '{{ status }}' +; +``` + + diff --git a/website/docs/services/code_security/code_security_configurations/index.md b/website/docs/services/code_security/code_security_configurations/index.md new file mode 100644 index 0000000..4eb4d49 --- /dev/null +++ b/website/docs/services/code_security/code_security_configurations/index.md @@ -0,0 +1,1718 @@ +--- +title: code_security_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - code_security_configurations + - code_security + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a code_security_configurations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the code security configuration
stringThe name of the code security configuration. Must be unique within the organization.
stringThe enablement status of GitHub Advanced Security (enabled, disabled, code_security, secret_protection)
stringThe enablement status of code scanning default setup (enabled, disabled, not_set)
objectFeature options for code scanning default setup
stringThe enablement status of code scanning delegated alert dismissal (enabled, disabled, not_set)
objectFeature options for code scanning
string (date-time)
stringThe enablement status of Dependabot alerts (enabled, disabled, not_set)
stringThe enablement status of Dependabot delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of Dependabot security updates (enabled, disabled, not_set)
stringThe enablement status of Dependency Graph (enabled, disabled, not_set)
stringThe enablement status of Automatic dependency submission (enabled, disabled, not_set)
objectFeature options for Automatic dependency submission
stringA description of the code security configuration
stringThe enforcement status for a security configuration (enforced, unenforced)
string (uri)The URL of the configuration
stringThe enablement status of private vulnerability reporting (enabled, disabled, not_set)
stringThe enablement status of secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated bypass (enabled, disabled, not_set)
objectFeature options for secret scanning delegated bypass
stringThe enablement status of secret scanning extended metadata (enabled, disabled, not_set)
stringThe enablement status of Copilot secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning non-provider patterns (enabled, disabled, not_set)
stringThe enablement status of secret scanning push protection (enabled, disabled, not_set)
stringThe enablement status of secret scanning validity checks (enabled, disabled, not_set)
stringThe type of the code security configuration. (global, organization, enterprise)
string (date-time)
string (uri)The URL of the configuration
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the code security configuration
stringThe name of the code security configuration. Must be unique within the organization.
stringThe enablement status of GitHub Advanced Security (enabled, disabled, code_security, secret_protection)
stringThe enablement status of code scanning default setup (enabled, disabled, not_set)
objectFeature options for code scanning default setup
stringThe enablement status of code scanning delegated alert dismissal (enabled, disabled, not_set)
objectFeature options for code scanning
string (date-time)
stringThe enablement status of Dependabot alerts (enabled, disabled, not_set)
stringThe enablement status of Dependabot delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of Dependabot security updates (enabled, disabled, not_set)
stringThe enablement status of Dependency Graph (enabled, disabled, not_set)
stringThe enablement status of Automatic dependency submission (enabled, disabled, not_set)
objectFeature options for Automatic dependency submission
stringA description of the code security configuration
stringThe enforcement status for a security configuration (enforced, unenforced)
string (uri)The URL of the configuration
stringThe enablement status of private vulnerability reporting (enabled, disabled, not_set)
stringThe enablement status of secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated bypass (enabled, disabled, not_set)
objectFeature options for secret scanning delegated bypass
stringThe enablement status of secret scanning extended metadata (enabled, disabled, not_set)
stringThe enablement status of Copilot secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning non-provider patterns (enabled, disabled, not_set)
stringThe enablement status of secret scanning push protection (enabled, disabled, not_set)
stringThe enablement status of secret scanning validity checks (enabled, disabled, not_set)
stringThe type of the code security configuration. (global, organization, enterprise)
string (date-time)
string (uri)The URL of the configuration
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the code security configuration
stringThe name of the code security configuration. Must be unique within the organization.
stringThe enablement status of GitHub Advanced Security (enabled, disabled, code_security, secret_protection)
stringThe enablement status of code scanning default setup (enabled, disabled, not_set)
objectFeature options for code scanning default setup
stringThe enablement status of code scanning delegated alert dismissal (enabled, disabled, not_set)
objectFeature options for code scanning
string (date-time)
stringThe enablement status of Dependabot alerts (enabled, disabled, not_set)
stringThe enablement status of Dependabot delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of Dependabot security updates (enabled, disabled, not_set)
stringThe enablement status of Dependency Graph (enabled, disabled, not_set)
stringThe enablement status of Automatic dependency submission (enabled, disabled, not_set)
objectFeature options for Automatic dependency submission
stringA description of the code security configuration
stringThe enforcement status for a security configuration (enforced, unenforced)
string (uri)The URL of the configuration
stringThe enablement status of private vulnerability reporting (enabled, disabled, not_set)
stringThe enablement status of secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated bypass (enabled, disabled, not_set)
objectFeature options for secret scanning delegated bypass
stringThe enablement status of secret scanning extended metadata (enabled, disabled, not_set)
stringThe enablement status of Copilot secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning non-provider patterns (enabled, disabled, not_set)
stringThe enablement status of secret scanning push protection (enabled, disabled, not_set)
stringThe enablement status of secret scanning validity checks (enabled, disabled, not_set)
stringThe type of the code security configuration. (global, organization, enterprise)
string (date-time)
string (uri)The URL of the configuration
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the code security configuration
stringThe name of the code security configuration. Must be unique within the organization.
stringThe enablement status of GitHub Advanced Security (enabled, disabled, code_security, secret_protection)
stringThe enablement status of code scanning default setup (enabled, disabled, not_set)
objectFeature options for code scanning default setup
stringThe enablement status of code scanning delegated alert dismissal (enabled, disabled, not_set)
objectFeature options for code scanning
string (date-time)
stringThe enablement status of Dependabot alerts (enabled, disabled, not_set)
stringThe enablement status of Dependabot delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of Dependabot security updates (enabled, disabled, not_set)
stringThe enablement status of Dependency Graph (enabled, disabled, not_set)
stringThe enablement status of Automatic dependency submission (enabled, disabled, not_set)
objectFeature options for Automatic dependency submission
stringA description of the code security configuration
stringThe enforcement status for a security configuration (enforced, unenforced)
string (uri)The URL of the configuration
stringThe enablement status of private vulnerability reporting (enabled, disabled, not_set)
stringThe enablement status of secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated alert dismissal (enabled, disabled, not_set)
stringThe enablement status of secret scanning delegated bypass (enabled, disabled, not_set)
objectFeature options for secret scanning delegated bypass
stringThe enablement status of secret scanning extended metadata (enabled, disabled, not_set)
stringThe enablement status of Copilot secret scanning (enabled, disabled, not_set)
stringThe enablement status of secret scanning non-provider patterns (enabled, disabled, not_set)
stringThe enablement status of secret scanning push protection (enabled, disabled, not_set)
stringThe enablement status of secret scanning validity checks (enabled, disabled, not_set)
stringThe type of the code security configuration. (global, organization, enterprise)
string (date-time)
string (uri)The URL of the configuration
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, configuration_idGets a code security configuration available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
org, configuration_idGets a code security configuration available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
enterpriseper_page, before, afterLists all code security configurations available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
orgtarget_type, per_page, before, afterLists all code security configurations available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
enterprise, configuration_id, scopeAttaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
org, configuration_id, scopeAttach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
enterprise, name, descriptionCreates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
org, name, descriptionCreates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
enterprise, configuration_idUpdates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
org, configuration_idUpdates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
enterprise, configuration_idSets a code security configuration as a default to be applied to new repositories in your enterprise.

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
org, configuration_idSets a code security configuration as a default to be applied to new repositories in your organization.

This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
enterprise, configuration_idDeletes a code security configuration from an enterprise.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
org, configuration_idDeletes the desired code security configuration from an organization.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
orgDetach code security configuration(s) from a set of repositories.
Repositories will retain their settings but will no longer be associated with the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the code security configuration.
stringThe slug version of the enterprise name.
stringThe organization name. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe target type of the code security configuration
+ +## `SELECT` examples + + + + +Gets a code security configuration available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + +```sql +SELECT +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url +FROM github.code_security.code_security_configurations +WHERE enterprise = '{{ enterprise }}' -- required +AND configuration_id = '{{ configuration_id }}' -- required +; +``` + + + +Gets a code security configuration available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url +FROM github.code_security.code_security_configurations +WHERE org = '{{ org }}' -- required +AND configuration_id = '{{ configuration_id }}' -- required +; +``` + + + +Lists all code security configurations available in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + +```sql +SELECT +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url +FROM github.code_security.code_security_configurations +WHERE enterprise = '{{ enterprise }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +; +``` + + + +Lists all code security configurations available in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url +FROM github.code_security.code_security_configurations +WHERE org = '{{ org }}' -- required +AND target_type = '{{ target_type }}' +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +; +``` + + + + +## `INSERT` examples + + + + +Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +INSERT INTO github.code_security.code_security_configurations ( +scope, +enterprise, +configuration_id +) +SELECT +'{{ scope }}' /* required */, +'{{ enterprise }}', +'{{ configuration_id }}' +; +``` + + + +Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +INSERT INTO github.code_security.code_security_configurations ( +scope, +selected_repository_ids, +org, +configuration_id +) +SELECT +'{{ scope }}' /* required */, +'{{ selected_repository_ids }}', +'{{ org }}', +'{{ configuration_id }}' +; +``` + + + +Creates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +INSERT INTO github.code_security.code_security_configurations ( +name, +description, +advanced_security, +code_security, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +dependabot_alerts, +dependabot_security_updates, +code_scanning_options, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +secret_protection, +secret_scanning, +secret_scanning_push_protection, +secret_scanning_validity_checks, +secret_scanning_non_provider_patterns, +secret_scanning_generic_secrets, +secret_scanning_delegated_alert_dismissal, +secret_scanning_extended_metadata, +private_vulnerability_reporting, +enforcement, +enterprise +) +SELECT +'{{ name }}' /* required */, +'{{ description }}' /* required */, +'{{ advanced_security }}', +'{{ code_security }}', +'{{ dependency_graph }}', +'{{ dependency_graph_autosubmit_action }}', +'{{ dependency_graph_autosubmit_action_options }}', +'{{ dependabot_alerts }}', +'{{ dependabot_security_updates }}', +'{{ code_scanning_options }}', +'{{ code_scanning_default_setup }}', +'{{ code_scanning_default_setup_options }}', +'{{ code_scanning_delegated_alert_dismissal }}', +'{{ secret_protection }}', +'{{ secret_scanning }}', +'{{ secret_scanning_push_protection }}', +'{{ secret_scanning_validity_checks }}', +'{{ secret_scanning_non_provider_patterns }}', +'{{ secret_scanning_generic_secrets }}', +'{{ secret_scanning_delegated_alert_dismissal }}', +'{{ secret_scanning_extended_metadata }}', +'{{ private_vulnerability_reporting }}', +'{{ enforcement }}', +'{{ enterprise }}' +RETURNING +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url +; +``` + + + +Creates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +INSERT INTO github.code_security.code_security_configurations ( +name, +description, +advanced_security, +code_security, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +dependabot_alerts, +dependabot_security_updates, +dependabot_delegated_alert_dismissal, +code_scanning_options, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +secret_protection, +secret_scanning, +secret_scanning_push_protection, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_validity_checks, +secret_scanning_non_provider_patterns, +secret_scanning_generic_secrets, +secret_scanning_delegated_alert_dismissal, +secret_scanning_extended_metadata, +private_vulnerability_reporting, +enforcement, +org +) +SELECT +'{{ name }}' /* required */, +'{{ description }}' /* required */, +'{{ advanced_security }}', +'{{ code_security }}', +'{{ dependency_graph }}', +'{{ dependency_graph_autosubmit_action }}', +'{{ dependency_graph_autosubmit_action_options }}', +'{{ dependabot_alerts }}', +'{{ dependabot_security_updates }}', +'{{ dependabot_delegated_alert_dismissal }}', +'{{ code_scanning_options }}', +'{{ code_scanning_default_setup }}', +'{{ code_scanning_default_setup_options }}', +'{{ code_scanning_delegated_alert_dismissal }}', +'{{ secret_protection }}', +'{{ secret_scanning }}', +'{{ secret_scanning_push_protection }}', +'{{ secret_scanning_delegated_bypass }}', +'{{ secret_scanning_delegated_bypass_options }}', +'{{ secret_scanning_validity_checks }}', +'{{ secret_scanning_non_provider_patterns }}', +'{{ secret_scanning_generic_secrets }}', +'{{ secret_scanning_delegated_alert_dismissal }}', +'{{ secret_scanning_extended_metadata }}', +'{{ private_vulnerability_reporting }}', +'{{ enforcement }}', +'{{ org }}' +RETURNING +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: code_security_configurations + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the code_security_configurations resource. + - name: configuration_id + value: {{ configuration_id }} + description: Required parameter for the code_security_configurations resource. + - name: org + value: "{{ org }}" + description: Required parameter for the code_security_configurations resource. + - name: scope + value: "{{ scope }}" + description: | + The type of repositories to attach the configuration to. \`selected\` means the configuration will be attached to only the repositories specified by \`selected_repository_ids\` + valid_values: ['all', 'all_without_configurations', 'public', 'private_or_internal', 'selected'] + - name: selected_repository_ids + value: + - {{ selected_repository_ids }} + description: | + An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the \`scope\` is set to \`selected\`. + - name: name + value: "{{ name }}" + description: | + The name of the code security configuration. Must be unique within the organization. + - name: description + value: "{{ description }}" + description: | + A description of the code security configuration + - name: advanced_security + value: "{{ advanced_security }}" + description: | + The enablement status of GitHub Advanced Security features. \`enabled\` will enable both Code Security and Secret Protection features. + > [!WARNING] + > \`code_security\` and \`secret_protection\` are deprecated values for this field. Prefer the individual \`code_security\` and \`secret_protection\` fields to set the status of these features. + valid_values: ['enabled', 'disabled', 'code_security', 'secret_protection'] + default: disabled + - name: code_security + value: "{{ code_security }}" + description: | + The enablement status of GitHub Code Security features. + valid_values: ['enabled', 'disabled', 'not_set'] + - name: dependency_graph + value: "{{ dependency_graph }}" + description: | + The enablement status of Dependency Graph + valid_values: ['enabled', 'disabled', 'not_set'] + default: enabled + - name: dependency_graph_autosubmit_action + value: "{{ dependency_graph_autosubmit_action }}" + description: | + The enablement status of Automatic dependency submission + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: dependency_graph_autosubmit_action_options + description: | + Feature options for Automatic dependency submission + value: + labeled_runners: {{ labeled_runners }} + - name: dependabot_alerts + value: "{{ dependabot_alerts }}" + description: | + The enablement status of Dependabot alerts + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: dependabot_security_updates + value: "{{ dependabot_security_updates }}" + description: | + The enablement status of Dependabot security updates + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: code_scanning_options + description: | + Security Configuration feature options for code scanning + value: + allow_advanced: {{ allow_advanced }} + - name: code_scanning_default_setup + value: "{{ code_scanning_default_setup }}" + description: | + The enablement status of code scanning default setup + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: code_scanning_default_setup_options + description: | + Feature options for code scanning default setup + value: + runner_type: "{{ runner_type }}" + runner_label: "{{ runner_label }}" + - name: code_scanning_delegated_alert_dismissal + value: "{{ code_scanning_delegated_alert_dismissal }}" + description: | + The enablement status of code scanning delegated alert dismissal + valid_values: ['enabled', 'disabled', 'not_set'] + default: not_set + - name: secret_protection + value: "{{ secret_protection }}" + description: | + The enablement status of GitHub Secret Protection features. + valid_values: ['enabled', 'disabled', 'not_set'] + - name: secret_scanning + value: "{{ secret_scanning }}" + description: | + The enablement status of secret scanning + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_push_protection + value: "{{ secret_scanning_push_protection }}" + description: | + The enablement status of secret scanning push protection + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_validity_checks + value: "{{ secret_scanning_validity_checks }}" + description: | + The enablement status of secret scanning validity checks + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_non_provider_patterns + value: "{{ secret_scanning_non_provider_patterns }}" + description: | + The enablement status of secret scanning non provider patterns + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_generic_secrets + value: "{{ secret_scanning_generic_secrets }}" + description: | + The enablement status of Copilot secret scanning + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_delegated_alert_dismissal + value: "{{ secret_scanning_delegated_alert_dismissal }}" + description: | + The enablement status of secret scanning delegated alert dismissal + valid_values: ['enabled', 'disabled', 'not_set'] + - name: secret_scanning_extended_metadata + value: "{{ secret_scanning_extended_metadata }}" + description: | + The enablement status of secret scanning extended metadata + valid_values: ['enabled', 'disabled', 'not_set'] + - name: private_vulnerability_reporting + value: "{{ private_vulnerability_reporting }}" + description: | + The enablement status of private vulnerability reporting + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: enforcement + value: "{{ enforcement }}" + description: | + The enforcement status for a security configuration + valid_values: ['enforced', 'unenforced'] + default: enforced + - name: dependabot_delegated_alert_dismissal + value: "{{ dependabot_delegated_alert_dismissal }}" + description: | + The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_delegated_bypass + value: "{{ secret_scanning_delegated_bypass }}" + description: | + The enablement status of secret scanning delegated bypass + valid_values: ['enabled', 'disabled', 'not_set'] + default: disabled + - name: secret_scanning_delegated_bypass_options + description: | + Feature options for secret scanning delegated bypass + value: + reviewers: + - reviewer_id: {{ reviewer_id }} + reviewer_type: "{{ reviewer_type }}" + mode: "{{ mode }}" +`} + + + + + +## `UPDATE` examples + + + + +Updates a code security configuration in an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +UPDATE github.code_security.code_security_configurations +SET +name = '{{ name }}', +description = '{{ description }}', +advanced_security = '{{ advanced_security }}', +code_security = '{{ code_security }}', +dependency_graph = '{{ dependency_graph }}', +dependency_graph_autosubmit_action = '{{ dependency_graph_autosubmit_action }}', +dependency_graph_autosubmit_action_options = '{{ dependency_graph_autosubmit_action_options }}', +dependabot_alerts = '{{ dependabot_alerts }}', +dependabot_security_updates = '{{ dependabot_security_updates }}', +code_scanning_default_setup = '{{ code_scanning_default_setup }}', +code_scanning_default_setup_options = '{{ code_scanning_default_setup_options }}', +code_scanning_options = '{{ code_scanning_options }}', +code_scanning_delegated_alert_dismissal = '{{ code_scanning_delegated_alert_dismissal }}', +secret_protection = '{{ secret_protection }}', +secret_scanning = '{{ secret_scanning }}', +secret_scanning_push_protection = '{{ secret_scanning_push_protection }}', +secret_scanning_validity_checks = '{{ secret_scanning_validity_checks }}', +secret_scanning_non_provider_patterns = '{{ secret_scanning_non_provider_patterns }}', +secret_scanning_generic_secrets = '{{ secret_scanning_generic_secrets }}', +secret_scanning_delegated_alert_dismissal = '{{ secret_scanning_delegated_alert_dismissal }}', +secret_scanning_extended_metadata = '{{ secret_scanning_extended_metadata }}', +private_vulnerability_reporting = '{{ private_vulnerability_reporting }}', +enforcement = '{{ enforcement }}' +WHERE +enterprise = '{{ enterprise }}' --required +AND configuration_id = '{{ configuration_id }}' --required +RETURNING +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url; +``` + + + +Updates a code security configuration in an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +UPDATE github.code_security.code_security_configurations +SET +name = '{{ name }}', +description = '{{ description }}', +advanced_security = '{{ advanced_security }}', +code_security = '{{ code_security }}', +dependency_graph = '{{ dependency_graph }}', +dependency_graph_autosubmit_action = '{{ dependency_graph_autosubmit_action }}', +dependency_graph_autosubmit_action_options = '{{ dependency_graph_autosubmit_action_options }}', +dependabot_alerts = '{{ dependabot_alerts }}', +dependabot_security_updates = '{{ dependabot_security_updates }}', +dependabot_delegated_alert_dismissal = '{{ dependabot_delegated_alert_dismissal }}', +code_scanning_default_setup = '{{ code_scanning_default_setup }}', +code_scanning_default_setup_options = '{{ code_scanning_default_setup_options }}', +code_scanning_options = '{{ code_scanning_options }}', +code_scanning_delegated_alert_dismissal = '{{ code_scanning_delegated_alert_dismissal }}', +secret_protection = '{{ secret_protection }}', +secret_scanning = '{{ secret_scanning }}', +secret_scanning_push_protection = '{{ secret_scanning_push_protection }}', +secret_scanning_delegated_bypass = '{{ secret_scanning_delegated_bypass }}', +secret_scanning_delegated_bypass_options = '{{ secret_scanning_delegated_bypass_options }}', +secret_scanning_validity_checks = '{{ secret_scanning_validity_checks }}', +secret_scanning_non_provider_patterns = '{{ secret_scanning_non_provider_patterns }}', +secret_scanning_generic_secrets = '{{ secret_scanning_generic_secrets }}', +secret_scanning_delegated_alert_dismissal = '{{ secret_scanning_delegated_alert_dismissal }}', +secret_scanning_extended_metadata = '{{ secret_scanning_extended_metadata }}', +private_vulnerability_reporting = '{{ private_vulnerability_reporting }}', +enforcement = '{{ enforcement }}' +WHERE +org = '{{ org }}' --required +AND configuration_id = '{{ configuration_id }}' --required +RETURNING +id, +name, +advanced_security, +code_scanning_default_setup, +code_scanning_default_setup_options, +code_scanning_delegated_alert_dismissal, +code_scanning_options, +created_at, +dependabot_alerts, +dependabot_delegated_alert_dismissal, +dependabot_security_updates, +dependency_graph, +dependency_graph_autosubmit_action, +dependency_graph_autosubmit_action_options, +description, +enforcement, +html_url, +private_vulnerability_reporting, +secret_scanning, +secret_scanning_delegated_alert_dismissal, +secret_scanning_delegated_bypass, +secret_scanning_delegated_bypass_options, +secret_scanning_extended_metadata, +secret_scanning_generic_secrets, +secret_scanning_non_provider_patterns, +secret_scanning_push_protection, +secret_scanning_validity_checks, +target_type, +updated_at, +url; +``` + + + + +## `REPLACE` examples + + + + +Sets a code security configuration as a default to be applied to new repositories in your enterprise.

This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +REPLACE github.code_security.code_security_configurations +SET +default_for_new_repos = '{{ default_for_new_repos }}' +WHERE +enterprise = '{{ enterprise }}' --required +AND configuration_id = '{{ configuration_id }}' --required +RETURNING +configuration, +default_for_new_repos; +``` + + + +Sets a code security configuration as a default to be applied to new repositories in your organization.

This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +REPLACE github.code_security.code_security_configurations +SET +default_for_new_repos = '{{ default_for_new_repos }}' +WHERE +org = '{{ org }}' --required +AND configuration_id = '{{ configuration_id }}' --required +RETURNING +configuration, +default_for_new_repos; +``` + + + + +## `DELETE` examples + + + + +Deletes a code security configuration from an enterprise.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator for the enterprise to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +DELETE FROM github.code_security.code_security_configurations +WHERE enterprise = '{{ enterprise }}' --required +AND configuration_id = '{{ configuration_id }}' --required +; +``` + + + +Deletes the desired code security configuration from an organization.
Repositories attached to the configuration will retain their settings but will no longer be associated with
the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +DELETE FROM github.code_security.code_security_configurations +WHERE org = '{{ org }}' --required +AND configuration_id = '{{ configuration_id }}' --required +; +``` + + + +Detach code security configuration(s) from a set of repositories.
Repositories will retain their settings but will no longer be associated with the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +DELETE FROM github.code_security.code_security_configurations +WHERE org = '{{ org }}' --required +; +``` + + diff --git a/website/docs/services/code_security/code_security_default_configurations/index.md b/website/docs/services/code_security/code_security_default_configurations/index.md new file mode 100644 index 0000000..c20776c --- /dev/null +++ b/website/docs/services/code_security/code_security_default_configurations/index.md @@ -0,0 +1,189 @@ +--- +title: code_security_default_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - code_security_default_configurations + - code_security + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a code_security_default_configurations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA code security configuration
The visibility of newly created repositories for which the code security configuration will be applied to by default (public, private_and_internal, all)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA code security configuration
The visibility of newly created repositories for which the code security configuration will be applied to by default (public, private_and_internal, all)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterpriseLists the default code security configurations for an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.
orgLists the default code security configurations for an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists the default code security configurations for an enterprise.

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + +```sql +SELECT +configuration, +default_for_new_repos +FROM github.code_security.code_security_default_configurations +WHERE enterprise = '{{ enterprise }}' -- required +; +``` + + + +Lists the default code security configurations for an organization.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +configuration, +default_for_new_repos +FROM github.code_security.code_security_default_configurations +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/code_security/index.md b/website/docs/services/code_security/index.md new file mode 100644 index 0000000..8be0b96 --- /dev/null +++ b/website/docs/services/code_security/index.md @@ -0,0 +1,35 @@ +--- +title: code_security +hide_title: false +hide_table_of_contents: false +keywords: + - code_security + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +code_security service documentation. + +:::info[Service Summary] + +total resources: __4__ + +::: + +## Resources +
+
+code_security_configuration_repos
+code_security_configurations +
+
+code_security_default_configurations
+repo_code_security_configuration +
+
\ No newline at end of file diff --git a/website/docs/services/code_security/repo_code_security_configuration/index.md b/website/docs/services/code_security/repo_code_security_configuration/index.md new file mode 100644 index 0000000..b15b25e --- /dev/null +++ b/website/docs/services/code_security/repo_code_security_configuration/index.md @@ -0,0 +1,142 @@ +--- +title: repo_code_security_configuration +hide_title: false +hide_table_of_contents: false +keywords: + - repo_code_security_configuration + - code_security + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repo_code_security_configuration resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA code security configuration
stringThe attachment status of the code security configuration on the repository. (attached, attaching, detached, removed, enforced, failed, updating, removed_by_enterprise)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGet the code security configuration that manages a repository's code security settings.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the code security configuration that manages a repository's code security settings.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +configuration, +status +FROM github.code_security.repo_code_security_configuration +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/codes_of_conduct/codes_of_conduct/index.md b/website/docs/services/codes_of_conduct/codes_of_conduct/index.md index 65b3357..eadbd6b 100644 --- a/website/docs/services/codes_of_conduct/codes_of_conduct/index.md +++ b/website/docs/services/codes_of_conduct/codes_of_conduct/index.md @@ -1,42 +1,219 @@ ---- +--- title: codes_of_conduct hide_title: false hide_table_of_contents: false keywords: - codes_of_conduct - codes_of_conduct - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a codes_of_conduct resource. ## Overview - +
Namecodes_of_conduct
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: Contributor Covenant)
string (example: # Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response
to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,
posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).
)
string (uri)
string (example: contributor_covenant)
string (uri) (example: https://api.github.com/codes_of_conduct/contributor_covenant)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: Contributor Covenant)
string (example: # Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response
to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,
posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).
)
string (uri)
string (example: contributor_covenant)
string (uri) (example: https://api.github.com/codes_of_conduct/contributor_covenant)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns array of all GitHub's codes of conduct. | -| | `SELECT` | | Returns information about the specified GitHub code of conduct. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
keyReturns information about the specified GitHub code of conduct.
Returns array of all GitHub's codes of conduct.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
+ +## `SELECT` examples + + + + +Returns information about the specified GitHub code of conduct. + +```sql +SELECT +name, +body, +html_url, +key, +url +FROM github.codes_of_conduct.codes_of_conduct +WHERE key = '{{ key }}' -- required +; +``` + + + +Returns array of all GitHub's codes of conduct. + +```sql +SELECT +name, +body, +html_url, +key, +url +FROM github.codes_of_conduct.codes_of_conduct +; +``` + + diff --git a/website/docs/services/codes_of_conduct/index.md b/website/docs/services/codes_of_conduct/index.md index 93ecfa6..e1dc90c 100644 --- a/website/docs/services/codes_of_conduct/index.md +++ b/website/docs/services/codes_of_conduct/index.md @@ -9,39 +9,25 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Codes Of Conduct - -:::info Service Summary +codes_of_conduct service documentation. -
-
-total resources: 1
-total selectable resources: 1
-total methods: 2
-
-
+:::info[Service Summary] -::: +total resources: __1__ -## Overview - - - - - - -
Namegithub.codes_of_conduct
TypeService
TitleGitHub V3 REST API - Codes Of Conduct
DescriptionCodes Of Conduct
Idcodes_of_conduct:v24.04.00227
+::: ## Resources
-codes_of_conduct
+codes_of_conduct
+
-
+ \ No newline at end of file diff --git a/website/docs/services/codespaces/codespace_export_details/index.md b/website/docs/services/codespaces/codespace_export_details/index.md index a519ac5..d84cc40 100644 --- a/website/docs/services/codespaces/codespace_export_details/index.md +++ b/website/docs/services/codespaces/codespace_export_details/index.md @@ -1,43 +1,172 @@ ---- +--- title: codespace_export_details hide_title: false hide_table_of_contents: false keywords: - codespace_export_details - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a codespace_export_details resource. ## Overview - +
Namecodespace_export_details
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Id for the export details | -| | `string` | Name of the exported branch | -| | `string` | Completion time of the last export operation | -| | `string` | Url for fetching export details | -| | `string` | Web url for the exported branch | -| | `string` | Git commit SHA of the exported branch | -| | `string` | State of the latest export | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringId for the export details (example: latest)
stringName of the exported branch (example: codespace-monalisa-octocat-hello-world-g4wpq6h95q)
string (date-time)Completion time of the last export operation (example: 2021-01-01T19:01:12Z)
stringUrl for fetching export details (example: https://api.github.com/user/codespaces/:name/exports/latest)
stringWeb url for the exported branch (example: https://github.com/octocat/hello-world/tree/:branch)
stringGit commit SHA of the exported branch (example: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2)
stringState of the latest export (example: succeeded | failed | in_progress)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
codespace_name, export_idGets information about an export of a codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the codespace.
stringThe ID of the export operation, or `latest`. Currently only `latest` is currently supported.
+ +## `SELECT` examples + + + + +Gets information about an export of a codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +id, +branch, +completed_at, +export_url, +html_url, +sha, +state +FROM github.codespaces.codespace_export_details +WHERE codespace_name = '{{ codespace_name }}' -- required +AND export_id = '{{ export_id }}' -- required +; +``` + + diff --git a/website/docs/services/codespaces/codespaces/index.md b/website/docs/services/codespaces/codespaces/index.md index 16b5ee2..b835eff 100644 --- a/website/docs/services/codespaces/codespaces/index.md +++ b/website/docs/services/codespaces/codespaces/index.md @@ -1,51 +1,975 @@ ---- +--- title: codespaces hide_title: false hide_table_of_contents: false keywords: - codespaces - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a codespaces resource. ## Overview - +
Namecodespaces
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
stringAutomatically generated name of this codespace. (example: monalisa-octocat-hello-world-g4wpq6h95q)
stringUUID identifying this codespace's environment. (example: 26a7c758-7299-4a73-b978-5a92a7ae98a0)
stringDisplay name for this codespace. (example: bookish space pancake)
objectA GitHub user. (title: Simple User)
string (date-time) (example: 2011-01-26T19:01:12Z)
stringPath to devcontainer.json from repo root used to create Codespace. (example: .devcontainer/example/devcontainer.json)
objectDetails about the codespace's git repository.
integerThe number of minutes of inactivity after which this codespace will be automatically stopped.
stringText to show user when codespace idle timeout minutes has been overriden by an organization policy
stringThe text to display to a user when a codespace has been stopped for a potentially actionable reason. (example: you've used 100% of your spending limit for Codespaces)
string (date-time)Last known time this codespace was started. (example: 2011-01-26T19:01:12Z)
stringThe initally assigned location of a new codespace. (EastUs, SouthEastAsia, WestEurope, WestUs2) (example: WestUs2)
objectA description of the machine powering a codespace. (title: Codespace machine)
string (uri)API URL to access available alternate machine types for this codespace.
objectA GitHub user. (title: Simple User)
booleanWhether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.
stringText to show user when codespace is disabled by a pending operation
booleanWhether the codespace was created from a prebuild.
string (uri)API URL to publish this codespace to a new repository.
string (uri)API URL for the Pull Request associated with this codespace, if any.
array
objectMinimal Repository (title: Minimal Repository)
string (date-time)When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" (example: 2011-01-26T20:01:12Z)
integerDuration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
object
string (uri)API URL to start this codespace.
stringState of this codespace. (Unknown, Created, Queued, Provisioning, Available, Awaiting, Unavailable, Deleted, Moved, Shutdown, Archived, Starting, ShuttingDown, Failed, Exporting, Updating, Rebuilding) (example: Available)
string (uri)API URL to stop this codespace.
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri)API URL for this codespace.
string (uri)URL to access this codespace on the web.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a user's codespace.

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

GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. | -| | `SELECT` | | Lists the authenticated user's codespaces.

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

GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. | -| | `SELECT` | | Lists the codespaces associated to a specified repository and the authenticated user.

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

GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. | -| | `INSERT` | | Creates a new codespace, owned by the authenticated user.

This endpoint requires either a `repository_id` OR a `pull_request` but not both.

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

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | -| | `DELETE` | | Deletes a user's codespace.

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

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | -| | `EXEC` | | Creates a codespace owned by the authenticated user for the specified pull request.

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

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | -| | `EXEC` | | Creates a codespace owned by the authenticated user in the specified repository.

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

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | -| | `EXEC` | | Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.

You must authenticate using a personal access token with the `codespace` scope to use this endpoint.

GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. | -| | `EXEC` | | Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
specify launchpoint configurations for codespaces created within the repository.

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

GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. | -| | `EXEC` | | Gets the default attributes for codespaces created by the user with the repository.

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

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | -| | `EXEC` | | Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.

The codespace's token is granted write permissions to the repository, allowing the user to push their changes.

This will fail for a codespace that is already published, meaning it has an associated repository.

You must authenticate using a personal access token with the `codespace` scope to use this endpoint.

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | -| | `EXEC` | | Starts a user's codespace.

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

GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. | -| | `EXEC` | | Stops a user's codespace.

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

GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. | -| | `EXEC` | | Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.

If you specify a new machine type it will be applied the next time your codespace is started.

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

GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists the codespaces associated to a specified repository and the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameGets information about a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
per_page, page, repository_idLists the authenticated user's codespaces.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
owner, repo, pull_numberCreates a codespace owned by the authenticated user for the specified pull request.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
owner, repoCreates a codespace owned by the authenticated user in the specified repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
repository_id, pull_requestCreates a new codespace, owned by the authenticated user.

This endpoint requires either a `repository_id` OR a `pull_request` but not both.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameUpdates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.

If you specify a new machine type it will be applied the next time your codespace is started.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameDeletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
owner, reporef, client_ipGets the default attributes for codespaces created by the user with the repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameTriggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_namePublishes an unpublished codespace, creating a new repository and assigning it to the codespace.

The codespace's token is granted write permissions to the repository, allowing the user to push their changes.

This will fail for a codespace that is already published, meaning it has an associated repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameStarts a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameStops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the codespace.
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringAn alternative IP for default location auto-detection, such as when proxying a request.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked.
integerID of the Repository to filter on
+ +## `SELECT` examples + + + + +Lists the codespaces associated to a specified repository and the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +codespaces, +total_count +FROM github.codespaces.codespaces +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Gets information about a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +id, +name, +environment_id, +display_name, +billable_owner, +created_at, +devcontainer_path, +git_status, +idle_timeout_minutes, +idle_timeout_notice, +last_known_stop_notice, +last_used_at, +location, +machine, +machines_url, +owner, +pending_operation, +pending_operation_disabled_reason, +prebuild, +publish_url, +pulls_url, +recent_folders, +repository, +retention_expires_at, +retention_period_minutes, +runtime_constraints, +start_url, +state, +stop_url, +updated_at, +url, +web_url +FROM github.codespaces.codespaces +WHERE codespace_name = '{{ codespace_name }}' -- required +; +``` + + + +Lists the authenticated user's codespaces.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +codespaces, +total_count +FROM github.codespaces.codespaces +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND repository_id = '{{ repository_id }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a codespace owned by the authenticated user for the specified pull request.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.codespaces ( +location, +geo, +client_ip, +machine, +devcontainer_path, +multi_repo_permissions_opt_out, +working_directory, +idle_timeout_minutes, +display_name, +retention_period_minutes, +owner, +repo, +pull_number +) +SELECT +'{{ location }}', +'{{ geo }}', +'{{ client_ip }}', +'{{ machine }}', +'{{ devcontainer_path }}', +{{ multi_repo_permissions_opt_out }}, +'{{ working_directory }}', +{{ idle_timeout_minutes }}, +'{{ display_name }}', +{{ retention_period_minutes }}, +'{{ owner }}', +'{{ repo }}', +'{{ pull_number }}' +RETURNING +id, +name, +environment_id, +display_name, +billable_owner, +created_at, +devcontainer_path, +git_status, +idle_timeout_minutes, +idle_timeout_notice, +last_known_stop_notice, +last_used_at, +location, +machine, +machines_url, +owner, +pending_operation, +pending_operation_disabled_reason, +prebuild, +publish_url, +pulls_url, +recent_folders, +repository, +retention_expires_at, +retention_period_minutes, +runtime_constraints, +start_url, +state, +stop_url, +updated_at, +url, +web_url +; +``` + + + +Creates a codespace owned by the authenticated user in the specified repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.codespaces ( +ref, +location, +geo, +client_ip, +machine, +devcontainer_path, +multi_repo_permissions_opt_out, +working_directory, +idle_timeout_minutes, +display_name, +retention_period_minutes, +owner, +repo +) +SELECT +'{{ ref }}', +'{{ location }}', +'{{ geo }}', +'{{ client_ip }}', +'{{ machine }}', +'{{ devcontainer_path }}', +{{ multi_repo_permissions_opt_out }}, +'{{ working_directory }}', +{{ idle_timeout_minutes }}, +'{{ display_name }}', +{{ retention_period_minutes }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +environment_id, +display_name, +billable_owner, +created_at, +devcontainer_path, +git_status, +idle_timeout_minutes, +idle_timeout_notice, +last_known_stop_notice, +last_used_at, +location, +machine, +machines_url, +owner, +pending_operation, +pending_operation_disabled_reason, +prebuild, +publish_url, +pulls_url, +recent_folders, +repository, +retention_expires_at, +retention_period_minutes, +runtime_constraints, +start_url, +state, +stop_url, +updated_at, +url, +web_url +; +``` + + + +Creates a new codespace, owned by the authenticated user.

This endpoint requires either a `repository_id` OR a `pull_request` but not both.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.codespaces ( +repository_id, +ref, +location, +geo, +client_ip, +machine, +devcontainer_path, +multi_repo_permissions_opt_out, +working_directory, +idle_timeout_minutes, +display_name, +retention_period_minutes, +pull_request +) +SELECT +{{ repository_id }} /* required */, +'{{ ref }}', +'{{ location }}', +'{{ geo }}', +'{{ client_ip }}', +'{{ machine }}', +'{{ devcontainer_path }}', +{{ multi_repo_permissions_opt_out }}, +'{{ working_directory }}', +{{ idle_timeout_minutes }}, +'{{ display_name }}', +{{ retention_period_minutes }}, +'{{ pull_request }}' /* required */ +RETURNING +id, +name, +environment_id, +display_name, +billable_owner, +created_at, +devcontainer_path, +git_status, +idle_timeout_minutes, +idle_timeout_notice, +last_known_stop_notice, +last_used_at, +location, +machine, +machines_url, +owner, +pending_operation, +pending_operation_disabled_reason, +prebuild, +publish_url, +pulls_url, +recent_folders, +repository, +retention_expires_at, +retention_period_minutes, +runtime_constraints, +start_url, +state, +stop_url, +updated_at, +url, +web_url +; +``` + + + +{`# Description fields are for documentation purposes +- name: codespaces + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the codespaces resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the codespaces resource. + - name: pull_number + value: {{ pull_number }} + description: Required parameter for the codespaces resource. + - name: location + value: "{{ location }}" + description: | + The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. + - name: geo + value: "{{ geo }}" + description: | + The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces \`location\`, which is closing down. + valid_values: ['EuropeWest', 'SoutheastAsia', 'UsEast', 'UsWest'] + - name: client_ip + value: "{{ client_ip }}" + description: | + IP for location auto-detection when proxying a request + - name: machine + value: "{{ machine }}" + description: | + Machine type to use for this codespace + - name: devcontainer_path + value: "{{ devcontainer_path }}" + description: | + Path to devcontainer.json config to use for this codespace + - name: multi_repo_permissions_opt_out + value: {{ multi_repo_permissions_opt_out }} + description: | + Whether to authorize requested permissions from devcontainer.json + - name: working_directory + value: "{{ working_directory }}" + description: | + Working directory for this codespace + - name: idle_timeout_minutes + value: {{ idle_timeout_minutes }} + description: | + Time in minutes before codespace stops from inactivity + - name: display_name + value: "{{ display_name }}" + description: | + Display name for this codespace + - name: retention_period_minutes + value: {{ retention_period_minutes }} + description: | + Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). + - name: ref + value: "{{ ref }}" + description: | + Git ref (typically a branch name) for this codespace + - name: repository_id + value: {{ repository_id }} + description: | + Repository id for this codespace + - name: pull_request + description: | + Pull request number for this codespace + value: + pull_request_number: {{ pull_request_number }} + repository_id: {{ repository_id }} +`} + + + + + +## `UPDATE` examples + + + + +Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.

If you specify a new machine type it will be applied the next time your codespace is started.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +UPDATE github.codespaces.codespaces +SET +machine = '{{ machine }}', +display_name = '{{ display_name }}', +recent_folders = '{{ recent_folders }}' +WHERE +codespace_name = '{{ codespace_name }}' --required +RETURNING +id, +name, +environment_id, +display_name, +billable_owner, +created_at, +devcontainer_path, +git_status, +idle_timeout_minutes, +idle_timeout_notice, +last_known_stop_notice, +last_used_at, +location, +machine, +machines_url, +owner, +pending_operation, +pending_operation_disabled_reason, +prebuild, +publish_url, +pulls_url, +recent_folders, +repository, +retention_expires_at, +retention_period_minutes, +runtime_constraints, +start_url, +state, +stop_url, +updated_at, +url, +web_url; +``` + + + + +## `DELETE` examples + + + + +Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.codespaces +WHERE codespace_name = '{{ codespace_name }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Gets the default attributes for codespaces created by the user with the repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +EXEC github.codespaces.codespaces.pre_flight_with_repo_for_authenticated_user +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@ref='{{ ref }}', +@client_ip='{{ client_ip }}' +; +``` + + + +Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.

If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +EXEC github.codespaces.codespaces.export_for_authenticated_user +@codespace_name='{{ codespace_name }}' --required +; +``` + + + +Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.

The codespace's token is granted write permissions to the repository, allowing the user to push their changes.

This will fail for a codespace that is already published, meaning it has an associated repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +EXEC github.codespaces.codespaces.publish_for_authenticated_user +@codespace_name='{{ codespace_name }}' --required +@@json= +'{ +"name": "{{ name }}", +"private": {{ private }} +}' +; +``` + + + +Starts a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +EXEC github.codespaces.codespaces.start_for_authenticated_user +@codespace_name='{{ codespace_name }}' --required +; +``` + + + +Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +EXEC github.codespaces.codespaces.stop_for_authenticated_user +@codespace_name='{{ codespace_name }}' --required +; +``` + + diff --git a/website/docs/services/codespaces/devcontainer_permissions/index.md b/website/docs/services/codespaces/devcontainer_permissions/index.md new file mode 100644 index 0000000..ac0a683 --- /dev/null +++ b/website/docs/services/codespaces/devcontainer_permissions/index.md @@ -0,0 +1,148 @@ +--- +title: devcontainer_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - devcontainer_permissions + - codespaces + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a devcontainer_permissions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response when the permission check is successful + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether the user has accepted the permissions defined by the devcontainer config
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, ref, devcontainer_pathChecks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringPath to the devcontainer.json configuration to use for the permission check.
stringThe account owner of the repository. The name is not case sensitive.
stringThe git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +accepted +FROM github.codespaces.devcontainer_permissions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +AND devcontainer_path = '{{ devcontainer_path }}' -- required +; +``` + + diff --git a/website/docs/services/codespaces/devcontainers/index.md b/website/docs/services/codespaces/devcontainers/index.md new file mode 100644 index 0000000..c5f5297 --- /dev/null +++ b/website/docs/services/codespaces/devcontainers/index.md @@ -0,0 +1,154 @@ +--- +title: devcontainers +hide_title: false +hide_table_of_contents: false +keywords: + - devcontainers + - codespaces + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a devcontainers resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists the devcontainer.json files associated with a specified repository and the authenticated user. These files
specify launchpoint configurations for codespaces created within the repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files
specify launchpoint configurations for codespaces created within the repository.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +devcontainers, +total_count +FROM github.codespaces.devcontainers +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/codespaces/index.md b/website/docs/services/codespaces/index.md index 74803ee..fd570dd 100644 --- a/website/docs/services/codespaces/index.md +++ b/website/docs/services/codespaces/index.md @@ -9,49 +9,36 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Endpoints To Manage Codespaces Using The REST API. - -:::info Service Summary +codespaces service documentation. -
-
-total resources: 11
-total selectable resources: 11
-total methods: 47
-
-
+:::info[Service Summary] -::: +total resources: __13__ -## Overview - - - - - - -
Namegithub.codespaces
TypeService
TitleGitHub V3 REST API - Codespaces
DescriptionEndpoints To Manage Codespaces Using The REST API.
Idcodespaces:v24.04.00227
+::: ## Resources
codespace_export_details
codespaces
+devcontainer_permissions
+devcontainers
machines
org_secrets_repos
-organization_secrets
-organizations
+organization_secrets
+organizations
public_keys
repository_secrets
secrets
user_public_keys
-user_secrets
-
+user_secrets
+ \ No newline at end of file diff --git a/website/docs/services/codespaces/machines/index.md b/website/docs/services/codespaces/machines/index.md index e9859b4..a870b30 100644 --- a/website/docs/services/codespaces/machines/index.md +++ b/website/docs/services/codespaces/machines/index.md @@ -1,39 +1,213 @@ ---- +--- title: machines hide_title: false hide_table_of_contents: false keywords: - machines - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a machines resource. ## Overview - +
Namemachines
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the machine types a codespace can transition to use.

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

GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. | -| | `SELECT` | | List the machine types available for a given repository based on its configuration.

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

GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repolocation, client_ip, refList the machine types available for a given repository based on its configuration.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
codespace_nameList the machine types a codespace can transition to use.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the codespace.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringIP for location auto-detection when proxying a request
stringThe location to check for available machines. Assigned by IP if not provided.
stringThe branch or commit to check for prebuild availability and devcontainer restrictions.
+ +## `SELECT` examples + + + + +List the machine types available for a given repository based on its configuration.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +machines, +total_count +FROM github.codespaces.machines +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND location = '{{ location }}' +AND client_ip = '{{ client_ip }}' +AND ref = '{{ ref }}' +; +``` + + + +List the machine types a codespace can transition to use.

OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + +```sql +SELECT +machines, +total_count +FROM github.codespaces.machines +WHERE codespace_name = '{{ codespace_name }}' -- required +; +``` + + diff --git a/website/docs/services/codespaces/org_secrets_repos/index.md b/website/docs/services/codespaces/org_secrets_repos/index.md index 61d35c7..94c6b85 100644 --- a/website/docs/services/codespaces/org_secrets_repos/index.md +++ b/website/docs/services/codespaces/org_secrets_repos/index.md @@ -1,41 +1,274 @@ ---- +--- title: org_secrets_repos hide_title: false hide_table_of_contents: false keywords: - org_secrets_repos - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an org_secrets_repos resource. ## Overview - +
Nameorg_secrets_repos
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `DELETE` | | Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `EXEC` | | Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `EXEC` | | Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, secret_namepage, per_pageLists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, repository_idAdds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, selected_repository_idsReplaces all repositories for an organization development environment secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, repository_idRemoves a repository from an organization development environment secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integer
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.codespaces.org_secrets_repos +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.org_secrets_repos ( +org, +secret_name, +repository_id +) +SELECT +'{{ org }}', +'{{ secret_name }}', +'{{ repository_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_secrets_repos + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_secrets_repos resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the org_secrets_repos resource. + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the org_secrets_repos resource. +`} + + + + + +## `REPLACE` examples + + + + +Replaces all repositories for an organization development environment secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.codespaces.org_secrets_repos +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from an organization development environment secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.org_secrets_repos +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/codespaces/organization_secrets/index.md b/website/docs/services/codespaces/organization_secrets/index.md index b73a4e8..58a8b2d 100644 --- a/website/docs/services/codespaces/organization_secrets/index.md +++ b/website/docs/services/codespaces/organization_secrets/index.md @@ -1,44 +1,323 @@ ---- +--- title: organization_secrets hide_title: false hide_table_of_contents: false keywords: - organization_secrets - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an organization_secrets resource. ## Overview - +
Nameorganization_secrets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret | -| | `string` | The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The API URL at which the list of repositories this secret is visible to can be retrieved | -| | `string` | The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The type of repositories in the organization that the secret is visible to | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret (example: SECRET_NAME)
string (date-time)The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
string (uri)The API URL at which the list of repositories this secret is visible to can be retrieved (example: https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories)
string (date-time)The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe type of repositories in the organization that the secret is visible to (all, private, selected)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets an organization secret without revealing its encrypted value.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `SELECT` | | Lists all Codespaces secrets available at the organization-level without revealing their encrypted values.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `INSERT` | | Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access
token with the `admin:org` scope to use this endpoint. | -| | `DELETE` | | Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, secret_nameGets an organization development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
orgper_page, pageLists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, visibilityCreates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_nameDeletes an organization development environment secret using the secret name.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets an organization development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +selected_repositories_url, +updated_at, +visibility +FROM github.codespaces.organization_secrets +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.codespaces.organization_secrets +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.organization_secrets ( +encrypted_value, +key_id, +visibility, +selected_repository_ids, +org, +secret_name +) +SELECT +'{{ encrypted_value }}', +'{{ key_id }}', +'{{ visibility }}' /* required */, +'{{ selected_repository_ids }}', +'{{ org }}', +'{{ secret_name }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: organization_secrets + props: + - name: org + value: "{{ org }}" + description: Required parameter for the organization_secrets resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the organization_secrets resource. + - name: encrypted_value + value: "{{ encrypted_value }}" + description: | + The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. + - name: key_id + value: "{{ key_id }}" + description: | + The ID of the key you used to encrypt the secret. + - name: visibility + value: "{{ visibility }}" + description: | + Which type of organization repositories have access to the organization secret. \`selected\` means only the repositories specified by \`selected_repository_ids\` can access the secret. + valid_values: ['all', 'private', 'selected'] + - name: selected_repository_ids + value: + - {{ selected_repository_ids }} + description: | + An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the \`visibility\` is set to \`selected\`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. +`} + + + + + +## `DELETE` examples + + + + +Deletes an organization development environment secret using the secret name.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.organization_secrets +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + diff --git a/website/docs/services/codespaces/organizations/index.md b/website/docs/services/codespaces/organizations/index.md index 0ccde9c..3a0f79e 100644 --- a/website/docs/services/codespaces/organizations/index.md +++ b/website/docs/services/codespaces/organizations/index.md @@ -1,44 +1,341 @@ ---- +--- title: organizations hide_title: false hide_table_of_contents: false keywords: - organizations - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an organizations resource. ## Overview - +
Nameorganizations
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the codespaces that a member of an organization has for repositories in that organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `SELECT` | | Lists the codespaces associated to a specified organization.

You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `DELETE` | | Codespaces for the specified users will no longer be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `DELETE` | | Deletes a user's codespace.

You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `EXEC` | | Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `EXEC` | | Codespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `EXEC` | | Stops a user's codespace.

You must authenticate using an access token with the `admin:org` scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, usernameper_page, pageLists the codespaces that a member of an organization has for repositories in that organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
orgper_page, pageLists the codespaces associated to a specified organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, visibilitySets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, username, codespace_nameDeletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
orgCodespaces for the specified users will no longer be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, selected_usernamesCodespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, username, codespace_nameStops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the codespace.
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the codespaces that a member of an organization has for repositories in that organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +codespaces, +total_count +FROM github.codespaces.organizations +WHERE org = '{{ org }}' -- required +AND username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the codespaces associated to a specified organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +codespaces, +total_count +FROM github.codespaces.organizations +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.codespaces.organizations +SET +visibility = '{{ visibility }}', +selected_usernames = '{{ selected_usernames }}' +WHERE +org = '{{ org }}' --required +AND visibility = '{{ visibility }}' --required; +``` + + + + +## `DELETE` examples + + + + +Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.organizations +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +AND codespace_name = '{{ codespace_name }}' --required +; +``` + + + +Codespaces for the specified users will no longer be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.organizations +WHERE org = '{{ org }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Codespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to `selected_members`.
For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +EXEC github.codespaces.organizations.set_codespaces_access_users +@org='{{ org }}' --required +@@json= +'{ +"selected_usernames": "{{ selected_usernames }}" +}' +; +``` + + + +Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +EXEC github.codespaces.organizations.stop_in_organization +@org='{{ org }}' --required, +@username='{{ username }}' --required, +@codespace_name='{{ codespace_name }}' --required +; +``` + + diff --git a/website/docs/services/codespaces/public_keys/index.md b/website/docs/services/codespaces/public_keys/index.md index e21bd80..e707d72 100644 --- a/website/docs/services/codespaces/public_keys/index.md +++ b/website/docs/services/codespaces/public_keys/index.md @@ -1,43 +1,243 @@ ---- +--- title: public_keys hide_title: false hide_table_of_contents: false keywords: - public_keys - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_keys resource. ## Overview - +
Namepublic_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | The Base64 encoded public key. | -| | `string` | The identifier for the key. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe identifier for the key. (example: 1234567)
string (example: 2011-01-26T19:01:12Z)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
string (example: ssh-rsa AAAAB3NzaC1yc2EAAA)
string (example: https://api.github.com/user/keys/2)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe identifier for the key. (example: 1234567)
string (example: 2011-01-26T19:01:12Z)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
string (example: ssh-rsa AAAAB3NzaC1yc2EAAA)
string (example: https://api.github.com/user/keys/2)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. | -| | `SELECT` | | Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgGets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +id, +key_id, +created_at, +key, +title, +url +FROM github.codespaces.public_keys +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +id, +key_id, +created_at, +key, +title, +url +FROM github.codespaces.public_keys +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/codespaces/repository_secrets/index.md b/website/docs/services/codespaces/repository_secrets/index.md index 26d0a5d..ca6dcb6 100644 --- a/website/docs/services/codespaces/repository_secrets/index.md +++ b/website/docs/services/codespaces/repository_secrets/index.md @@ -1,42 +1,310 @@ ---- +--- title: repository_secrets hide_title: false hide_table_of_contents: false keywords: - repository_secrets - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repository_secrets resource. ## Overview - +
Namerepository_secrets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret. (example: SECRET_TOKEN)
string (date-time)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. | -| | `SELECT` | | Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. | -| | `INSERT` | | Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access
token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`
repository permission to use this endpoint. | -| | `DELETE` | | Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, secret_nameGets a single repository development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repoper_page, pageLists all development environment secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, secret_nameCreates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.
owner, repo, secret_nameDeletes a development environment secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a single repository development environment secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +updated_at +FROM github.codespaces.repository_secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Lists all development environment secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.codespaces.repository_secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. + +```sql +INSERT INTO github.codespaces.repository_secrets ( +encrypted_value, +key_id, +owner, +repo, +secret_name +) +SELECT +'{{ encrypted_value }}', +'{{ key_id }}', +'{{ owner }}', +'{{ repo }}', +'{{ secret_name }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: repository_secrets + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the repository_secrets resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the repository_secrets resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the repository_secrets resource. + - name: encrypted_value + value: "{{ encrypted_value }}" + description: | + Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. + - name: key_id + value: "{{ key_id }}" + description: | + ID of the key you used to encrypt the secret. +`} + + + + + +## `DELETE` examples + + + + +Deletes a development environment secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. + +```sql +DELETE FROM github.codespaces.repository_secrets +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + diff --git a/website/docs/services/codespaces/secrets/index.md b/website/docs/services/codespaces/secrets/index.md index f3a3957..474e41d 100644 --- a/website/docs/services/codespaces/secrets/index.md +++ b/website/docs/services/codespaces/secrets/index.md @@ -1,44 +1,302 @@ ---- +--- title: secrets hide_title: false hide_table_of_contents: false keywords: - secrets - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a secrets resource. ## Overview - +
Namesecrets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret | -| | `string` | The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The API URL at which the list of repositories this secret is visible to can be retrieved | -| | `string` | The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. | -| | `string` | The type of repositories in the organization that the secret is visible to | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret (example: SECRET_NAME)
string (date-time)The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
string (uri)The API URL at which the list of repositories this secret is visible to can be retrieved (example: https://api.github.com/user/secrets/SECRET_NAME/repositories)
string (date-time)The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
stringThe type of repositories in the organization that the secret is visible to (all, private, selected)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a secret available to a user's codespaces without revealing its encrypted value.

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

GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. | -| | `SELECT` | | Lists all secrets available for a user's Codespaces without revealing their
encrypted values.

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

GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. | -| | `INSERT` | | Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

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.

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. | -| | `DELETE` | | Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.

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

GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
secret_nameGets a development environment secret available to a user's codespaces without revealing its encrypted value.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
per_page, pageLists all development environment secrets available for a user's codespaces without revealing their
encrypted values.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
secret_name, key_idCreates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
secret_nameDeletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a development environment secret available to a user's codespaces without revealing its encrypted value.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +selected_repositories_url, +updated_at, +visibility +FROM github.codespaces.secrets +WHERE secret_name = '{{ secret_name }}' -- required +; +``` + + + +Lists all development environment secrets available for a user's codespaces without revealing their
encrypted values.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.codespaces.secrets +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.secrets ( +encrypted_value, +key_id, +selected_repository_ids, +secret_name +) +SELECT +'{{ encrypted_value }}', +'{{ key_id }}' /* required */, +'{{ selected_repository_ids }}', +'{{ secret_name }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: secrets + props: + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the secrets resource. + - name: encrypted_value + value: "{{ encrypted_value }}" + description: | + Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. + - name: key_id + value: "{{ key_id }}" + description: | + ID of the key you used to encrypt the secret. + - name: selected_repository_ids + value: "{{ selected_repository_ids }}" + description: | + An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. +`} + + + + + +## `DELETE` examples + + + + +Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.secrets +WHERE secret_name = '{{ secret_name }}' --required +; +``` + + diff --git a/website/docs/services/codespaces/user_public_keys/index.md b/website/docs/services/codespaces/user_public_keys/index.md index e884057..32af088 100644 --- a/website/docs/services/codespaces/user_public_keys/index.md +++ b/website/docs/services/codespaces/user_public_keys/index.md @@ -1,38 +1,130 @@ ---- +--- title: user_public_keys hide_title: false hide_table_of_contents: false keywords: - user_public_keys - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a user_public_keys resource. ## Overview - +
Nameuser_public_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The Base64 encoded public key. | -| | `string` | The identifier for the key. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the key. (example: 1234567)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +SELECT +key_id, +key +FROM github.codespaces.user_public_keys +; +``` + + diff --git a/website/docs/services/codespaces/user_secrets/index.md b/website/docs/services/codespaces/user_secrets/index.md index 7a095d9..0c1973c 100644 --- a/website/docs/services/codespaces/user_secrets/index.md +++ b/website/docs/services/codespaces/user_secrets/index.md @@ -1,41 +1,249 @@ ---- +--- title: user_secrets hide_title: false hide_table_of_contents: false keywords: - user_secrets - codespaces - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a user_secrets resource. ## Overview - +
Nameuser_secrets
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the repositories that have been granted the ability to use a user's codespace secret.

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

GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. | -| | `DELETE` | | Removes a repository from the selected repositories for a user's codespace secret.
You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. | -| | `EXEC` | | Adds a repository to the selected repositories for a user's codespace secret.
You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. | -| | `EXEC` | | Select the repositories that will use a user's codespace secret.

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

GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
secret_nameList the repositories that have been granted the ability to use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
secret_name, repository_idAdds a repository to the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
secret_name, selected_repository_idsSelect the repositories that will use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
secret_name, repository_idRemoves a repository from the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe name of the secret.
+ +## `SELECT` examples + + + + +List the repositories that have been granted the ability to use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.codespaces.user_secrets +WHERE secret_name = '{{ secret_name }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository to the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +INSERT INTO github.codespaces.user_secrets ( +secret_name, +repository_id +) +SELECT +'{{ secret_name }}', +'{{ repository_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: user_secrets + props: + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the user_secrets resource. + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the user_secrets resource. +`} + + + + + +## `REPLACE` examples + + + + +Select the repositories that will use a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +REPLACE github.codespaces.user_secrets +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +secret_name = '{{ secret_name }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from the selected repositories for a user's development environment secret.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + +```sql +DELETE FROM github.codespaces.user_secrets +WHERE secret_name = '{{ secret_name }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/copilot/copilot_metrics/index.md b/website/docs/services/copilot/copilot_metrics/index.md new file mode 100644 index 0000000..6c35850 --- /dev/null +++ b/website/docs/services/copilot/copilot_metrics/index.md @@ -0,0 +1,196 @@ +--- +title: copilot_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - copilot_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a copilot_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectUsage metrics for Copilot Chat in GitHub.com
objectUsage metrics for Copilot for pull requests.
objectUsage metrics for Copilot Chat in the IDE.
objectUsage metrics for Copilot editor code completions in the IDE.
string (date)The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format.
integerThe total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint.
integerThe total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slugsince, until, page, per_pageUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.
Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringShow usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.
stringShow usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.
+ +## `SELECT` examples + + + + +Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.
Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + +```sql +SELECT +copilot_dotcom_chat, +copilot_dotcom_pull_requests, +copilot_ide_chat, +copilot_ide_code_completions, +date, +total_active_users, +total_engaged_users +FROM github.copilot.copilot_metrics +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND since = '{{ since }}' +AND until = '{{ until }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/copilot/copilot_one_day_usage_metrics/index.md b/website/docs/services/copilot/copilot_one_day_usage_metrics/index.md new file mode 100644 index 0000000..1a5b7c6 --- /dev/null +++ b/website/docs/services/copilot/copilot_one_day_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: copilot_one_day_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - copilot_one_day_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a copilot_one_day_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.
string (date)The day of the report in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, dayUse this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date)The day to request data for, in `YYYY-MM-DD` format.
stringThe slug version of the enterprise name.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the Copilot enterprise usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the enterprise.

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + +```sql +SELECT +download_links, +report_day +FROM github.copilot.copilot_one_day_usage_metrics +WHERE enterprise = '{{ enterprise }}' -- required +AND day = '{{ day }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/copilot_usage_metrics/index.md b/website/docs/services/copilot/copilot_usage_metrics/index.md new file mode 100644 index 0000000..efc7a42 --- /dev/null +++ b/website/docs/services/copilot/copilot_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: copilot_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - copilot_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a copilot_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the latest Copilot usage metrics report for the enterprise/organization.
string (date)The end date of the report period in `YYYY-MM-DD` format.
string (date)The start date of the report period in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterpriseUse this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the latest 28-day enterprise Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the enterprise.

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + +```sql +SELECT +download_links, +report_end_day, +report_start_day +FROM github.copilot.copilot_usage_metrics +WHERE enterprise = '{{ enterprise }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/copilot_user_one_day_usage_metrics/index.md b/website/docs/services/copilot/copilot_user_one_day_usage_metrics/index.md new file mode 100644 index 0000000..7a3e440 --- /dev/null +++ b/website/docs/services/copilot/copilot_user_one_day_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: copilot_user_one_day_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - copilot_user_one_day_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a copilot_user_one_day_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.
string (date)The day of the report in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, dayUse this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date)The day to request data for, in `YYYY-MM-DD` format.
stringThe slug version of the enterprise name.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + +```sql +SELECT +download_links, +report_day +FROM github.copilot.copilot_user_one_day_usage_metrics +WHERE enterprise = '{{ enterprise }}' -- required +AND day = '{{ day }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/copilot_user_usage_metrics/index.md b/website/docs/services/copilot/copilot_user_usage_metrics/index.md new file mode 100644 index 0000000..cd239ad --- /dev/null +++ b/website/docs/services/copilot/copilot_user_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: copilot_user_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - copilot_user_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a copilot_user_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the latest Copilot usage metrics report for the enterprise/organization.
string (date)The end date of the report period in `YYYY-MM-DD` format.
string (date)The start date of the report period in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterpriseUse this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + +```sql +SELECT +download_links, +report_end_day, +report_start_day +FROM github.copilot.copilot_user_usage_metrics +WHERE enterprise = '{{ enterprise }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/index.md b/website/docs/services/copilot/index.md index b049990..bd62b35 100644 --- a/website/docs/services/copilot/index.md +++ b/website/docs/services/copilot/index.md @@ -9,41 +9,39 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Endpoints To Manage Copilot Using The REST API. - -:::info Service Summary +copilot service documentation. -
-
-total resources: 3
-total selectable resources: 3
-total methods: 7
-
-
+:::info[Service Summary] -::: +total resources: __16__ -## Overview - - - - - - -
Namegithub.copilot
TypeService
TitleGitHub V3 REST API - Copilot
DescriptionEndpoints To Manage Copilot Using The REST API.
Idcopilot:v24.04.00227
+::: ## Resources
-org_details
-org_seats
+copilot_metrics
+copilot_one_day_usage_metrics
+copilot_usage_metrics
+copilot_user_one_day_usage_metrics
+copilot_user_usage_metrics
+org_coding_agent_permissions
+org_coding_agent_repos
+org_content_exclusion
-user_seats
-
+org_copilot_metrics
+org_copilot_one_day_usage_metrics
+org_copilot_usage_metrics
+org_copilot_user_one_day_usage_metrics
+org_copilot_user_usage_metrics
+org_details
+org_seats
+user_seats
+ \ No newline at end of file diff --git a/website/docs/services/copilot/org_coding_agent_permissions/index.md b/website/docs/services/copilot/org_coding_agent_permissions/index.md new file mode 100644 index 0000000..86339ad --- /dev/null +++ b/website/docs/services/copilot/org_coding_agent_permissions/index.md @@ -0,0 +1,167 @@ +--- +title: org_coding_agent_permissions +hide_title: false +hide_table_of_contents: false +keywords: + - org_coding_agent_permissions + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_coding_agent_permissions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe policy for which repositories can use Copilot coding agent. Can be one of `all`, `selected`, or `none`. (all, selected, none)
stringThe URL for the selected repositories endpoint. Only present when `enabled_repositories` is `selected`.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about which repositories in an organization have been enabled
or disabled for the Copilot coding agent.

Organization owners can configure whether Copilot coding agent is enabled for
all repositories, selected repositories, or no repositories owned by organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, enabled_repositories> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets the policy for which repositories in an organization can use Copilot coding agent.

Organization owners can configure whether Copilot coding agent is enabled for
all repositories, selected repositories, or no repositories owned by the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about which repositories in an organization have been enabled
or disabled for the Copilot coding agent.

Organization owners can configure whether Copilot coding agent is enabled for
all repositories, selected repositories, or no repositories owned by organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +enabled_repositories, +selected_repositories_url +FROM github.copilot.org_coding_agent_permissions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets the policy for which repositories in an organization can use Copilot coding agent.

Organization owners can configure whether Copilot coding agent is enabled for
all repositories, selected repositories, or no repositories owned by the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.copilot.org_coding_agent_permissions +SET +enabled_repositories = '{{ enabled_repositories }}' +WHERE +org = '{{ org }}' --required +AND enabled_repositories = '{{ enabled_repositories }}' --required; +``` + + diff --git a/website/docs/services/copilot/org_coding_agent_repos/index.md b/website/docs/services/copilot/org_coding_agent_repos/index.md new file mode 100644 index 0000000..b61c14e --- /dev/null +++ b/website/docs/services/copilot/org_coding_agent_repos/index.md @@ -0,0 +1,234 @@ +--- +title: org_coding_agent_repos +hide_title: false +hide_table_of_contents: false +keywords: + - org_coding_agent_repos + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_coding_agent_repos resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, page> [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists the selected repositories that are enabled for Copilot coding agent in an organization.

Organization owners can use this endpoint when the coding agent repository policy
is set to `selected` to see which repositories have been enabled.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, repository_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Adds a repository to the list of selected repositories enabled for Copilot
coding agent in an organization. This method can only be called when the
coding agent repository policy is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, selected_repository_ids> [!NOTE]
> This endpoint is in public preview and is subject to change.

Replaces the list of selected repositories that are enabled for Copilot coding
agent in an organization. This method can only be called when the coding agent
repository policy is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, repository_id> [!NOTE]
> This endpoint is in public preview and is subject to change.

Removes a repository from the list of selected repositories enabled for Copilot
coding agent in an organization. This method can only be called when the
coding agent repository policy is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the repository.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists the selected repositories that are enabled for Copilot coding agent in an organization.

Organization owners can use this endpoint when the coding agent repository policy
is set to `selected` to see which repositories have been enabled.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.copilot.org_coding_agent_repos +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Adds a repository to the list of selected repositories enabled for Copilot
coding agent in an organization. This method can only be called when the
coding agent repository policy is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.copilot.org_coding_agent_repos +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required; +``` + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Replaces the list of selected repositories that are enabled for Copilot coding
agent in an organization. This method can only be called when the coding agent
repository policy is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.copilot.org_coding_agent_repos +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Removes a repository from the list of selected repositories enabled for Copilot
coding agent in an organization. This method can only be called when the
coding agent repository policy is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scopes to use this endpoint. + +```sql +DELETE FROM github.copilot.org_coding_agent_repos +WHERE org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/copilot/org_content_exclusion/index.md b/website/docs/services/copilot/org_content_exclusion/index.md new file mode 100644 index 0000000..bb534fb --- /dev/null +++ b/website/docs/services/copilot/org_content_exclusion/index.md @@ -0,0 +1,134 @@ +--- +title: org_content_exclusion +hide_title: false +hide_table_of_contents: false +keywords: + - org_content_exclusion + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_content_exclusion resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets Copilot content exclusion path rules for an organization.
To configure these settings, go to the organization's settings on GitHub.
For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)."

Organization owners can set Copilot content exclusion rules for the organization.

OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.

> [!CAUTION]
> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
org> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot content exclusion path rules.
To configure these settings, go to the organization's settings on GitHub.
For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)."

Organization owners can view details about Copilot content exclusion rules for the organization.

OAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.

> [!CAUTION]
> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `REPLACE` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets Copilot content exclusion path rules for an organization.
To configure these settings, go to the organization's settings on GitHub.
For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)."

Organization owners can set Copilot content exclusion rules for the organization.

OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint.

> [!CAUTION]
> * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
> * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + +```sql +REPLACE github.copilot.org_content_exclusion +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +RETURNING +message; +``` + + + + +## Lifecycle Methods + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot content exclusion path rules.
To configure these settings, go to the organization's settings on GitHub.
For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)."

Organization owners can view details about Copilot content exclusion rules for the organization.

OAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint.

> [!CAUTION]
> * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
> * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. + +```sql +EXEC github.copilot.org_content_exclusion.copilot_content_exclusion_for_organization +@org='{{ org }}' --required +; +``` + + diff --git a/website/docs/services/copilot/org_copilot_metrics/index.md b/website/docs/services/copilot/org_copilot_metrics/index.md new file mode 100644 index 0000000..e7e6675 --- /dev/null +++ b/website/docs/services/copilot/org_copilot_metrics/index.md @@ -0,0 +1,190 @@ +--- +title: org_copilot_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - org_copilot_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_copilot_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectUsage metrics for Copilot Chat in GitHub.com
objectUsage metrics for Copilot for pull requests.
objectUsage metrics for Copilot Chat in the IDE.
objectUsage metrics for Copilot editor code completions in the IDE.
string (date)The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format.
integerThe total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint.
integerThe total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgsince, until, page, per_pageUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.
Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringShow usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago.
stringShow usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.
+ +## `SELECT` examples + + + + +Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

> [!NOTE]
> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,
and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
they must have telemetry enabled in their IDE.

To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.
Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + +```sql +SELECT +copilot_dotcom_chat, +copilot_dotcom_pull_requests, +copilot_ide_chat, +copilot_ide_code_completions, +date, +total_active_users, +total_engaged_users +FROM github.copilot.org_copilot_metrics +WHERE org = '{{ org }}' -- required +AND since = '{{ since }}' +AND until = '{{ until }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/copilot/org_copilot_one_day_usage_metrics/index.md b/website/docs/services/copilot/org_copilot_one_day_usage_metrics/index.md new file mode 100644 index 0000000..58e10d8 --- /dev/null +++ b/website/docs/services/copilot/org_copilot_one_day_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: org_copilot_one_day_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - org_copilot_one_day_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_copilot_one_day_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.
string (date)The day of the report in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, dayUse this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date)The day to request data for, in `YYYY-MM-DD` format.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + +```sql +SELECT +download_links, +report_day +FROM github.copilot.org_copilot_one_day_usage_metrics +WHERE org = '{{ org }}' -- required +AND day = '{{ day }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/org_copilot_usage_metrics/index.md b/website/docs/services/copilot/org_copilot_usage_metrics/index.md new file mode 100644 index 0000000..f15d2af --- /dev/null +++ b/website/docs/services/copilot/org_copilot_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: org_copilot_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - org_copilot_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_copilot_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the latest Copilot usage metrics report for the enterprise/organization.
string (date)The end date of the report period in `YYYY-MM-DD` format.
string (date)The start date of the report period in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgUse this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + +```sql +SELECT +download_links, +report_end_day, +report_start_day +FROM github.copilot.org_copilot_usage_metrics +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/org_copilot_user_one_day_usage_metrics/index.md b/website/docs/services/copilot/org_copilot_user_one_day_usage_metrics/index.md new file mode 100644 index 0000000..a26f547 --- /dev/null +++ b/website/docs/services/copilot/org_copilot_user_one_day_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: org_copilot_user_one_day_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - org_copilot_user_one_day_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_copilot_user_one_day_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day.
string (date)The day of the report in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, dayUse this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date)The day to request data for, in `YYYY-MM-DD` format.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + +```sql +SELECT +download_links, +report_day +FROM github.copilot.org_copilot_user_one_day_usage_metrics +WHERE org = '{{ org }}' -- required +AND day = '{{ day }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/org_copilot_user_usage_metrics/index.md b/website/docs/services/copilot/org_copilot_user_usage_metrics/index.md new file mode 100644 index 0000000..2f86317 --- /dev/null +++ b/website/docs/services/copilot/org_copilot_user_usage_metrics/index.md @@ -0,0 +1,142 @@ +--- +title: org_copilot_user_usage_metrics +hide_title: false +hide_table_of_contents: false +keywords: + - org_copilot_user_usage_metrics + - copilot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_copilot_user_usage_metrics resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe URLs to download the latest Copilot usage metrics report for the enterprise/organization.
string (date)The end date of the report period in `YYYY-MM-DD` format.
string (date)The start date of the report period in `YYYY-MM-DD` format.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgUse this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.

For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + +```sql +SELECT +download_links, +report_end_day, +report_start_day +FROM github.copilot.org_copilot_user_usage_metrics +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/org_details/index.md b/website/docs/services/copilot/org_details/index.md index df4f170..42cd442 100644 --- a/website/docs/services/copilot/org_details/index.md +++ b/website/docs/services/copilot/org_details/index.md @@ -1,39 +1,164 @@ ---- +--- title: org_details hide_title: false hide_table_of_contents: false keywords: - org_details - copilot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an org_details resource. ## Overview - +
Nameorg_details
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The organization policy for allowing or disallowing Copilot to make suggestions that match public code. | -| | `object` | The breakdown of Copilot for Business seats for the organization. | -| | `string` | The mode of assigning new seats. | + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization policy for allowing or disallowing Copilot CLI. (enabled, disabled, unconfigured)
stringThe organization policy for allowing or disallowing Copilot Chat in the IDE. (enabled, disabled, unconfigured)
stringThe Copilot plan of the organization, or the parent enterprise, when applicable. (business, enterprise)
stringThe organization policy for allowing or disallowing Copilot features on GitHub.com. (enabled, disabled, unconfigured)
stringThe organization policy for allowing or blocking suggestions matching public code (duplication detection filter). (allow, block, unconfigured)
objectThe breakdown of Copilot Business seats for the organization. (title: Copilot Seat Breakdown)
stringThe mode of assigning new seats. (assign_all, assign_selected, disabled, unconfigured)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot subscription, including seat breakdown
and feature policies. To configure these settings, go to your organization's settings on GitHub.com.
For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)."

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets information about an organization's Copilot subscription, including seat breakdown
and feature policies. To configure these settings, go to your organization's settings on GitHub.com.
For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)."

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. + +```sql +SELECT +cli, +ide_chat, +plan_type, +platform_chat, +public_code_suggestions, +seat_breakdown, +seat_management_setting +FROM github.copilot.org_details +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/copilot/org_seats/index.md b/website/docs/services/copilot/org_seats/index.md index 1ec200a..feb5935 100644 --- a/website/docs/services/copilot/org_seats/index.md +++ b/website/docs/services/copilot/org_seats/index.md @@ -1,40 +1,232 @@ ---- +--- title: org_seats hide_title: false hide_table_of_contents: false keywords: - org_seats - copilot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an org_seats resource. ## Overview - +
Nameorg_seats
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | | -| | `integer` | Total number of Copilot For Business seats for the organization currently being billed. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerTotal number of Copilot seats for the organization currently being billed.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | **Note**: This endpoint is in beta and is subject to change.

Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).

Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must
authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. | -| | `INSERT` | | **Note**: This endpoint is in beta and is subject to change.

Purchases a GitHub Copilot for Business seat for all users within each specified team.
The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.

In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.
For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)".
For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". | -| | `EXEC` | | **Note**: This endpoint is in beta and is subject to change.

Cancels the Copilot for Business seat assignment for all members of each team specified.
This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.

For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)".

For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgpage, per_page> [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.
Only organization owners can view assigned seats.

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
org, selected_teams> [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for all users within each specified team.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
org, selected_teams> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all members of each team specified to "pending cancellation".
This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.
Only organization owners can view assigned seats.

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. + +```sql +SELECT +seats, +total_seats +FROM github.copilot.org_seats +WHERE org = '{{ org }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `INSERT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for all users within each specified team.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + +```sql +INSERT INTO github.copilot.org_seats ( +selected_teams, +org +) +SELECT +'{{ selected_teams }}' /* required */, +'{{ org }}' +RETURNING +seats_created +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_seats + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_seats resource. + - name: selected_teams + value: + - "{{ selected_teams }}" + description: | + List of team names within the organization to which to grant access to GitHub Copilot. +`} + + + + + +## Lifecycle Methods + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all members of each team specified to "pending cancellation".
This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + +```sql +EXEC github.copilot.org_seats.cancel_copilot_seat_assignment_for_teams +@org='{{ org }}' --required +@@json= +'{ +"selected_teams": "{{ selected_teams }}" +}' +; +``` + + diff --git a/website/docs/services/copilot/user_seats/index.md b/website/docs/services/copilot/user_seats/index.md index e3dcadf..5867edb 100644 --- a/website/docs/services/copilot/user_seats/index.md +++ b/website/docs/services/copilot/user_seats/index.md @@ -1,45 +1,274 @@ ---- +--- title: user_seats hide_title: false hide_table_of_contents: false keywords: - user_seats - copilot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a user_seats resource. ## Overview - +
Nameuser_seats
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | The assignee that has been granted access to GitHub Copilot. | -| | `object` | The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. | -| | `string` | Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. | -| | `string` | Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. | -| | `string` | Last editor that was used by the user for a GitHub Copilot completion. | -| | `string` | The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. | -| | `string` | Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. | + +The following fields are returned by `SELECT` queries: + + + + +The user's GitHub Copilot seat details, including usage. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA GitHub user. (title: Simple User)
objectThe team through which the assignee is granted access to GitHub Copilot, if applicable. (title: Team)
string (date-time)Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format.
string (date-time)Timestamp of user's last GitHub Copilot activity, in ISO 8601 format.
stringLast editor that was used by the user for a GitHub Copilot completion.
string (date-time)Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format.
objectA GitHub organization. (title: Organization Simple)
string (date)The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle.
stringThe Copilot plan of the organization, or the parent enterprise, when applicable. (business, enterprise, unknown)
string (date-time)**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | **Note**: This endpoint is in beta and is subject to change.

Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.

Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. | -| | `INSERT` | | **Note**: This endpoint is in beta and is subject to change.

Purchases a GitHub Copilot for Business seat for each user specified.
The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.

In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.
For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)".
For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". | -| | `EXEC` | | **Note**: This endpoint is in beta and is subject to change.

Cancels the Copilot for Business seat assignment for each user specified.
This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.

For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)"

For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, username> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).

Only organization owners can view Copilot seat assignment details for members of their organization.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
org, selected_usernames> [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for each user specified.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
org, selected_usernames> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all users specified to "pending cancellation".
This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
+ +## `SELECT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data).

Only organization owners can view Copilot seat assignment details for members of their organization.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. + +```sql +SELECT +assignee, +assigning_team, +created_at, +last_activity_at, +last_activity_editor, +last_authenticated_at, +organization, +pending_cancellation_date, +plan_type, +updated_at +FROM github.copilot.user_seats +WHERE org = '{{ org }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Purchases a GitHub Copilot seat for each user specified.
The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."

The response contains the total number of new seats that were created and existing seats that were refreshed.

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + +```sql +INSERT INTO github.copilot.user_seats ( +selected_usernames, +org +) +SELECT +'{{ selected_usernames }}' /* required */, +'{{ org }}' +RETURNING +seats_created +; +``` + + + +{`# Description fields are for documentation purposes +- name: user_seats + props: + - name: org + value: "{{ org }}" + description: Required parameter for the user_seats resource. + - name: selected_usernames + value: + - "{{ selected_usernames }}" + description: | + The usernames of the organization members to be granted access to GitHub Copilot. +`} + + + + + +## Lifecycle Methods + + + + +> [!NOTE]
> This endpoint is in public preview and is subject to change.

Sets seats for all users specified to "pending cancellation".
This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.
For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."

Only organization owners can cancel Copilot seats for their organization members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. + +```sql +EXEC github.copilot.user_seats.cancel_copilot_seat_assignment_for_users +@org='{{ org }}' --required +@@json= +'{ +"selected_usernames": "{{ selected_usernames }}" +}' +; +``` + + diff --git a/website/docs/services/credentials/credentials/index.md b/website/docs/services/credentials/credentials/index.md new file mode 100644 index 0000000..22fe85d --- /dev/null +++ b/website/docs/services/credentials/credentials/index.md @@ -0,0 +1,100 @@ +--- +title: credentials +hide_title: false +hide_table_of_contents: false +keywords: + - credentials + - credentials + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a credentials resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
credentialsSubmit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.

This endpoint currently accepts the following credential types:
- Personal access tokens (classic) (`ghp_`)
- Fine-grained personal access tokens (`github_pat_`)
- OAuth app access tokens (`gho_`)
- User-to-server tokens from GitHub Apps (`ghu_`)
- Refresh tokens from GitHub Apps (`ghr_`)


Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.
GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.

To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.

> [!NOTE]
> Any authenticated requests will return a 403.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation.

This endpoint currently accepts the following credential types:
- Personal access tokens (classic) (`ghp_`)
- Fine-grained personal access tokens (`github_pat_`)
- OAuth app access tokens (`gho_`)
- User-to-server tokens from GitHub Apps (`ghu_`)
- Refresh tokens from GitHub Apps (`ghr_`)


Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users.
GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated.

To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request.

> [!NOTE]
> Any authenticated requests will return a 403. + +```sql +EXEC github.credentials.credentials.revoke +@@json= +'{ +"credentials": "{{ credentials }}" +}' +; +``` + + diff --git a/website/docs/services/credentials/index.md b/website/docs/services/credentials/index.md new file mode 100644 index 0000000..dcfa7a8 --- /dev/null +++ b/website/docs/services/credentials/index.md @@ -0,0 +1,33 @@ +--- +title: credentials +hide_title: false +hide_table_of_contents: false +keywords: + - credentials + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +credentials service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+credentials +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/dependabot/alerts/index.md b/website/docs/services/dependabot/alerts/index.md index 5b969ed..73407e9 100644 --- a/website/docs/services/dependabot/alerts/index.md +++ b/website/docs/services/dependabot/alerts/index.md @@ -1,53 +1,866 @@ ---- +--- title: alerts hide_title: false hide_table_of_contents: false keywords: - alerts - dependabot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an alerts resource. ## Overview - +
Namealerts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | Details for the vulnerable dependency. | -| | `string` | The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | An optional comment associated with the alert's dismissal. | -| | `string` | The reason that the alert was dismissed. | -| | `string` | The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `integer` | The security alert number. | -| | `object` | Details for the GitHub Security Advisory. | -| | `object` | Details pertaining to one vulnerable version range for the advisory. | -| | `string` | The state of the Dependabot alert. | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe users assigned to this alert.
string (date-time)The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails for the vulnerable dependency.
objectInformation about an active dismissal request for this Dependabot alert. (title: Dependabot alert dismissal request)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringAn optional comment associated with the alert's dismissal.
stringThe reason that the alert was dismissed. (fix_started, inaccurate, no_bandwidth, not_used, tolerable_risk)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
integerThe security alert number.
objectDetails for the GitHub Security Advisory.
objectDetails pertaining to one vulnerable version range for the advisory.
stringThe state of the Dependabot alert. (auto_dismissed, dismissed, fixed, open)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe users assigned to this alert.
string (date-time)The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails for the vulnerable dependency.
objectInformation about an active dismissal request for this Dependabot alert. (title: Dependabot alert dismissal request)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringAn optional comment associated with the alert's dismissal.
stringThe reason that the alert was dismissed. (fix_started, inaccurate, no_bandwidth, not_used, tolerable_risk)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
integerThe security alert number.
objectDetails for the GitHub Security Advisory.
objectDetails pertaining to one vulnerable version range for the advisory.
stringThe state of the Dependabot alert. (auto_dismissed, dismissed, fixed, open)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe users assigned to this alert.
string (date-time)The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails for the vulnerable dependency.
objectInformation about an active dismissal request for this Dependabot alert. (title: Dependabot alert dismissal request)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringAn optional comment associated with the alert's dismissal.
stringThe reason that the alert was dismissed. (fix_started, inaccurate, no_bandwidth, not_used, tolerable_risk)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
integerThe security alert number.
objectA GitHub repository. (title: Simple Repository)
objectDetails for the GitHub Security Advisory.
objectDetails pertaining to one vulnerable version range for the advisory.
stringThe state of the Dependabot alert. (auto_dismissed, dismissed, fixed, open)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe users assigned to this alert.
string (date-time)The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails for the vulnerable dependency.
objectInformation about an active dismissal request for this Dependabot alert. (title: Dependabot alert dismissal request)
string (date-time)The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringAn optional comment associated with the alert's dismissal.
stringThe reason that the alert was dismissed. (fix_started, inaccurate, no_bandwidth, not_used, tolerable_risk)
string (date-time)The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The GitHub URL of the alert resource.
integerThe security alert number.
objectA GitHub repository. (title: Simple Repository)
objectDetails for the GitHub Security Advisory.
objectDetails pertaining to one vulnerable version range for the advisory.
stringThe state of the Dependabot alert. (auto_dismissed, dismissed, fixed, open)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | You must use an access token with the `security_events` scope to use this endpoint with private repositories.
You can also use tokens with the `public_repo` scope for public repositories only.
GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. | -| | `SELECT` | | You must use an access token with the `security_events` scope to use this endpoint with private repositories.
You can also use tokens with the `public_repo` scope for public repositories only.
GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. | -| | `EXEC` | | You must use an access token with the `security_events` scope to use this endpoint with private repositories.
You can also use tokens with the `public_repo` scope for public repositories only.
GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.

To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, alert_numberOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
owner, repoclassification, state, severity, ecosystem, package, manifest, epss_percentage, has, assignee, scope, sort, direction, before, after, per_pageOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
enterpriseclassification, state, severity, ecosystem, package, epss_percentage, has, assignee, scope, sort, direction, before, after, per_pageLists Dependabot alerts for repositories that are owned by the specified enterprise.

The authenticated user must be a member of the enterprise to use this endpoint.

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
orgclassification, state, severity, ecosystem, package, epss_percentage, artifact_registry_url, artifact_registry, has, assignee, runtime_risk, scope, sort, direction, before, after, per_pageLists Dependabot alerts for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
owner, repo, alert_number, state, assigneesThe authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation.
stringThe slug version of the enterprise name.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. Can be: `jfrog-artifactory`
stringA comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned.
stringFilter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA comma-separated list of vulnerability classifications. If specified, only alerts for vulnerabilities with these classifications will be returned. Can be: `malware`, `general`
stringThe direction to sort the results by.
stringA comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
stringCVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - An exact number (`n`) - Comparators such as `>n`, `=n`, `<=n` - A range like `n..n`, where `n` is a number from 0.0 to 1.0 Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. Multiple `has` filters can be passed to filter for alerts that have all of the values.
stringA comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned.
stringA comma-separated list of package names. If specified, only alerts for these packages will be returned.
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`
stringThe scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.
stringA comma-separated list of severities. If specified, only alerts with these severities will be returned. Can be: `low`, `medium`, `high`, `critical`
stringThe property by which to sort the results. `created` means when the alert was created. `updated` means when the alert's state last changed. `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.
stringA comma-separated list of states. If specified, only alerts with these states will be returned. Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
+ +## `SELECT` examples + + + + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +assignees, +auto_dismissed_at, +created_at, +dependency, +dismissal_request, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +number, +security_advisory, +security_vulnerability, +state, +updated_at, +url +FROM github.dependabot.alerts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND alert_number = '{{ alert_number }}' -- required +; +``` + + + +OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +assignees, +auto_dismissed_at, +created_at, +dependency, +dismissal_request, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +number, +security_advisory, +security_vulnerability, +state, +updated_at, +url +FROM github.dependabot.alerts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND classification = '{{ classification }}' +AND state = '{{ state }}' +AND severity = '{{ severity }}' +AND ecosystem = '{{ ecosystem }}' +AND package = '{{ package }}' +AND manifest = '{{ manifest }}' +AND epss_percentage = '{{ epss_percentage }}' +AND has = '{{ has }}' +AND assignee = '{{ assignee }}' +AND scope = '{{ scope }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + + +Lists Dependabot alerts for repositories that are owned by the specified enterprise.

The authenticated user must be a member of the enterprise to use this endpoint.

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + +```sql +SELECT +assignees, +auto_dismissed_at, +created_at, +dependency, +dismissal_request, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +number, +repository, +security_advisory, +security_vulnerability, +state, +updated_at, +url +FROM github.dependabot.alerts +WHERE enterprise = '{{ enterprise }}' -- required +AND classification = '{{ classification }}' +AND state = '{{ state }}' +AND severity = '{{ severity }}' +AND ecosystem = '{{ ecosystem }}' +AND package = '{{ package }}' +AND epss_percentage = '{{ epss_percentage }}' +AND has = '{{ has }}' +AND assignee = '{{ assignee }}' +AND scope = '{{ scope }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + + +Lists Dependabot alerts for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +assignees, +auto_dismissed_at, +created_at, +dependency, +dismissal_request, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +number, +repository, +security_advisory, +security_vulnerability, +state, +updated_at, +url +FROM github.dependabot.alerts +WHERE org = '{{ org }}' -- required +AND classification = '{{ classification }}' +AND state = '{{ state }}' +AND severity = '{{ severity }}' +AND ecosystem = '{{ ecosystem }}' +AND package = '{{ package }}' +AND epss_percentage = '{{ epss_percentage }}' +AND artifact_registry_url = '{{ artifact_registry_url }}' +AND artifact_registry = '{{ artifact_registry }}' +AND has = '{{ has }}' +AND assignee = '{{ assignee }}' +AND runtime_risk = '{{ runtime_risk }}' +AND scope = '{{ scope }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `UPDATE` examples + + + + +The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."

OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +UPDATE github.dependabot.alerts +SET +state = '{{ state }}', +dismissed_reason = '{{ dismissed_reason }}', +dismissed_comment = '{{ dismissed_comment }}', +assignees = '{{ assignees }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND alert_number = '{{ alert_number }}' --required +AND state = '{{ state }}' --required +AND assignees = '{{ assignees }}' --required +RETURNING +assignees, +auto_dismissed_at, +created_at, +dependency, +dismissal_request, +dismissed_at, +dismissed_by, +dismissed_comment, +dismissed_reason, +fixed_at, +html_url, +number, +security_advisory, +security_vulnerability, +state, +updated_at, +url; +``` + + diff --git a/website/docs/services/dependabot/enterprise_alerts/index.md b/website/docs/services/dependabot/enterprise_alerts/index.md deleted file mode 100644 index 4b9e9da..0000000 --- a/website/docs/services/dependabot/enterprise_alerts/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: enterprise_alerts -hide_title: false -hide_table_of_contents: false -keywords: - - enterprise_alerts - - dependabot - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameenterprise_alerts
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | Details for the vulnerable dependency. | -| | `string` | The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | An optional comment associated with the alert's dismissal. | -| | `string` | The reason that the alert was dismissed. | -| | `string` | The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `integer` | The security alert number. | -| | `object` | A GitHub repository. | -| | `object` | Details for the GitHub Security Advisory. | -| | `object` | Details pertaining to one vulnerable version range for the advisory. | -| | `string` | The state of the Dependabot alert. | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/dependabot/index.md b/website/docs/services/dependabot/index.md index f56ccef..541b26e 100644 --- a/website/docs/services/dependabot/index.md +++ b/website/docs/services/dependabot/index.md @@ -9,45 +9,28 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Endpoints To Manage Dependabot. - -:::info Service Summary +dependabot service documentation. -
-
-total resources: 7
-total selectable resources: 7
-total methods: 19
-
-
+:::info[Service Summary] -::: +total resources: __5__ -## Overview - - - - - - -
Namegithub.dependabot
TypeService
TitleGitHub V3 REST API - Dependabot
DescriptionEndpoints To Manage Dependabot.
Iddependabot:v24.04.00227
+::: ## Resources
alerts
-enterprise_alerts
-org_alerts
-org_secrets
+org_dependabot_repository_access
+public_keys
-public_keys
repos_for_secret
-secrets
-
+secrets
+ \ No newline at end of file diff --git a/website/docs/services/dependabot/org_alerts/index.md b/website/docs/services/dependabot/org_alerts/index.md deleted file mode 100644 index 6267dbd..0000000 --- a/website/docs/services/dependabot/org_alerts/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: org_alerts -hide_title: false -hide_table_of_contents: false -keywords: - - org_alerts - - dependabot - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_alerts
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | Details for the vulnerable dependency. | -| | `string` | The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | An optional comment associated with the alert's dismissal. | -| | `string` | The reason that the alert was dismissed. | -| | `string` | The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `integer` | The security alert number. | -| | `object` | A GitHub repository. | -| | `object` | Details for the GitHub Security Advisory. | -| | `object` | Details pertaining to one vulnerable version range for the advisory. | -| | `string` | The state of the Dependabot alert. | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/dependabot/org_dependabot_repository_access/index.md b/website/docs/services/dependabot/org_dependabot_repository_access/index.md new file mode 100644 index 0000000..5d31e9a --- /dev/null +++ b/website/docs/services/dependabot/org_dependabot_repository_access/index.md @@ -0,0 +1,210 @@ +--- +title: org_dependabot_repository_access +hide_title: false +hide_table_of_contents: false +keywords: + - org_dependabot_repository_access + - dependabot + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_dependabot_repository_access resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
stringThe default repository access level for Dependabot updates. (public, internal) (example: internal)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgpage, per_pageLists repositories that organization admins have allowed Dependabot to access when updating dependencies.
> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Unauthorized users will not see the existence of this endpoint.
orgUpdates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.

> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Unauthorized users will not see the existence of this endpoint.

**Example request body:**
```json
{
"repository_ids_to_add": [123, 456],
"repository_ids_to_remove": [789]
}
```
org, default_levelSets the default level of repository access Dependabot will have while performing an update. Available values are:
- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.
- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.

Unauthorized users will not see the existence of this endpoint.

This operation supports both server-to-server and user-to-server access.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of results to fetch.
integerNumber of results per page.
+ +## `SELECT` examples + + + + +Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.
> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Unauthorized users will not see the existence of this endpoint. + +```sql +SELECT +accessible_repositories, +default_level +FROM github.dependabot.org_dependabot_repository_access +WHERE org = '{{ org }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `UPDATE` examples + + + + +Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.

> [!NOTE]
> This operation supports both server-to-server and user-to-server access.
Unauthorized users will not see the existence of this endpoint.

**Example request body:**
```json
{
"repository_ids_to_add": [123, 456],
"repository_ids_to_remove": [789]
}
``` + +```sql +UPDATE github.dependabot.org_dependabot_repository_access +SET +repository_ids_to_add = '{{ repository_ids_to_add }}', +repository_ids_to_remove = '{{ repository_ids_to_remove }}' +WHERE +org = '{{ org }}' --required; +``` + + + + +## `REPLACE` examples + + + + +Sets the default level of repository access Dependabot will have while performing an update. Available values are:
- 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.
- 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.

Unauthorized users will not see the existence of this endpoint.

This operation supports both server-to-server and user-to-server access. + +```sql +REPLACE github.dependabot.org_dependabot_repository_access +SET +default_level = '{{ default_level }}' +WHERE +org = '{{ org }}' --required +AND default_level = '{{ default_level }}' --required; +``` + + diff --git a/website/docs/services/dependabot/org_secrets/index.md b/website/docs/services/dependabot/org_secrets/index.md deleted file mode 100644 index 12bfdb7..0000000 --- a/website/docs/services/dependabot/org_secrets/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: org_secrets -hide_title: false -hide_table_of_contents: false -keywords: - - org_secrets - - dependabot - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_secrets
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | Visibility of a secret | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | -| | `SELECT` | | Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | -| | `INSERT` | | Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access
token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
permission to use this endpoint. | -| | `DELETE` | | Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | diff --git a/website/docs/services/dependabot/public_keys/index.md b/website/docs/services/dependabot/public_keys/index.md index 05dc686..17a3f3f 100644 --- a/website/docs/services/dependabot/public_keys/index.md +++ b/website/docs/services/dependabot/public_keys/index.md @@ -1,39 +1,195 @@ ---- +--- title: public_keys hide_title: false hide_table_of_contents: false keywords: - public_keys - dependabot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_keys resource. ## Overview - +
Namepublic_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The Base64 encoded public key. | -| | `string` | The identifier for the key. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the key. (example: 1234567)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the key. (example: 1234567)
stringThe Base64 encoded public key. (example: hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | -| | `SELECT` | | Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets. Anyone with read access
to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
orgGets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets. Anyone with read access
to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + +```sql +SELECT +key_id, +key +FROM github.dependabot.public_keys +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +Gets your public key, which you need to encrypt secrets. You need to
encrypt a secret before you can create or update secrets.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +key_id, +key +FROM github.dependabot.public_keys +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/dependabot/repos_for_secret/index.md b/website/docs/services/dependabot/repos_for_secret/index.md index ca15609..ea076be 100644 --- a/website/docs/services/dependabot/repos_for_secret/index.md +++ b/website/docs/services/dependabot/repos_for_secret/index.md @@ -1,41 +1,274 @@ ---- +--- title: repos_for_secret hide_title: false hide_table_of_contents: false keywords: - repos_for_secret - dependabot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos_for_secret resource. ## Overview - +
Namerepos_for_secret
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | -| | `DELETE` | | Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | -| | `EXEC` | | Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | -| | `EXEC` | | Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, secret_namepage, per_pageLists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, repository_idAdds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. The visibility is set when you [Create or
update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, selected_repository_idsReplaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name, repository_idRemoves a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integer
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all repositories that have been selected when the `visibility`
for repository access to a secret is set to `selected`.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.dependabot.repos_for_secret +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository to an organization secret when the `visibility` for
repository access is set to `selected`. The visibility is set when you [Create or
update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.dependabot.repos_for_secret ( +org, +secret_name, +repository_id +) +SELECT +'{{ org }}', +'{{ secret_name }}', +'{{ repository_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: repos_for_secret + props: + - name: org + value: "{{ org }}" + description: Required parameter for the repos_for_secret resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the repos_for_secret resource. + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the repos_for_secret resource. +`} + + + + + +## `REPLACE` examples + + + + +Replaces all repositories for an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.dependabot.repos_for_secret +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from an organization secret when the `visibility`
for repository access is set to `selected`. The visibility is set when you [Create
or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.dependabot.repos_for_secret +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/dependabot/secrets/index.md b/website/docs/services/dependabot/secrets/index.md index 015f84b..d3bb11d 100644 --- a/website/docs/services/dependabot/secrets/index.md +++ b/website/docs/services/dependabot/secrets/index.md @@ -1,42 +1,494 @@ ---- +--- title: secrets hide_title: false hide_table_of_contents: false keywords: - secrets - dependabot - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a secrets resource. ## Overview - +
Namesecrets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The name of the secret. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret. (example: MY_ARTIFACTORY_PASSWORD)
string (date-time)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the secret. (example: SECRET_TOKEN)
string (date-time)
string (uri) (example: https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories)
string (date-time)
stringVisibility of a secret (all, private, selected)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. | -| | `SELECT` | | Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. | -| | `INSERT` | | Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

You must authenticate using an access
token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository
permission to use this endpoint. | -| | `DELETE` | | Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, secret_nameGets a single repository secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_nameGets a single organization secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repoper_page, pageLists all secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
orgper_page, pageLists all secrets available in an organization without revealing their
encrypted values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repo, secret_nameCreates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_name, visibilityCreates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
owner, repo, secret_nameDeletes a secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
org, secret_nameDeletes a secret in an organization using the secret name.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a single repository secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +updated_at +FROM github.dependabot.secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Gets a single organization secret without revealing its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +name, +created_at, +selected_repositories_url, +updated_at, +visibility +FROM github.dependabot.secrets +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +Lists all secrets available in a repository without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.dependabot.secrets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all secrets available in an organization without revealing their
encrypted values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +secrets, +total_count +FROM github.dependabot.secrets +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.dependabot.secrets ( +encrypted_value, +key_id, +owner, +repo, +secret_name +) +SELECT +'{{ encrypted_value }}', +'{{ key_id }}', +'{{ owner }}', +'{{ repo }}', +'{{ secret_name }}' +; +``` + + + +Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.dependabot.secrets ( +encrypted_value, +key_id, +visibility, +selected_repository_ids, +org, +secret_name +) +SELECT +'{{ encrypted_value }}', +'{{ key_id }}', +'{{ visibility }}' /* required */, +'{{ selected_repository_ids }}', +'{{ org }}', +'{{ secret_name }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: secrets + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the secrets resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the secrets resource. + - name: secret_name + value: "{{ secret_name }}" + description: Required parameter for the secrets resource. + - name: org + value: "{{ org }}" + description: Required parameter for the secrets resource. + - name: encrypted_value + value: "{{ encrypted_value }}" + description: | + Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. + - name: key_id + value: "{{ key_id }}" + description: | + ID of the key you used to encrypt the secret. + - name: visibility + value: "{{ visibility }}" + description: | + Which type of organization repositories have access to the organization secret. \`selected\` means only the repositories specified by \`selected_repository_ids\` can access the secret. + valid_values: ['all', 'private', 'selected'] + - name: selected_repository_ids + value: "{{ selected_repository_ids }}" + description: | + An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the \`visibility\` is set to \`selected\`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. +`} + + + + + +## `DELETE` examples + + + + +Deletes a secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.dependabot.secrets +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + + +Deletes a secret in an organization using the secret name.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.dependabot.secrets +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + diff --git a/website/docs/services/dependency_graph/dependency_review/index.md b/website/docs/services/dependency_graph/dependency_review/index.md index e3b5b42..ccbef5c 100644 --- a/website/docs/services/dependency_graph/dependency_review/index.md +++ b/website/docs/services/dependency_graph/dependency_review/index.md @@ -1,46 +1,202 @@ ---- +--- title: dependency_review hide_title: false hide_table_of_contents: false keywords: - dependency_review - dependency_graph - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a dependency_review resource. ## Overview - +
Namedependency_review
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment. | -| | `string` | | -| | `string` | | -| | `array` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: @actions/core)
string (added, removed)
string (example: npm)
string (example: MIT)
string (example: path/to/package-lock.json)
string (example: pkg:/npm/%40actions/core@1.1.0)
stringWhere the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment. (unknown, runtime, development)
string (example: https://github.com/github/actions)
string (example: 1.0.0)
array
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, baseheadnameGets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe full path, relative to the repository root, of the dependency manifest file.
+ +## `SELECT` examples + + + + +Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. + +```sql +SELECT +name, +change_type, +ecosystem, +license, +manifest, +package_url, +scope, +source_repository_url, +version, +vulnerabilities +FROM github.dependency_graph.dependency_review +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND basehead = '{{ basehead }}' -- required +AND name = '{{ name }}' +; +``` + + diff --git a/website/docs/services/dependency_graph/dependency_submission/index.md b/website/docs/services/dependency_graph/dependency_submission/index.md index 7316d2e..e300166 100644 --- a/website/docs/services/dependency_graph/dependency_submission/index.md +++ b/website/docs/services/dependency_graph/dependency_submission/index.md @@ -1,35 +1,184 @@ ---- +--- title: dependency_submission hide_title: false hide_table_of_contents: false keywords: - dependency_submission - dependency_graph - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a dependency_submission resource. ## Overview - +
Namedependency_submission
Name
TypeResource
Id
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `INSERT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, detector, version, ref, sha, job, scannedCreate a new snapshot of a repository's dependencies.

The authenticated user must have access to the repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Create a new snapshot of a repository's dependencies.

The authenticated user must have access to the repository.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.dependency_graph.dependency_submission ( +version, +job, +sha, +ref, +detector, +metadata, +manifests, +scanned, +owner, +repo +) +SELECT +{{ version }} /* required */, +'{{ job }}' /* required */, +'{{ sha }}' /* required */, +'{{ ref }}' /* required */, +'{{ detector }}' /* required */, +'{{ metadata }}', +'{{ manifests }}', +'{{ scanned }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +created_at, +message, +result +; +``` + + + +{`# Description fields are for documentation purposes +- name: dependency_submission + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the dependency_submission resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the dependency_submission resource. + - name: version + value: {{ version }} + description: | + The version of the repository snapshot submission. + - name: job + value: + id: "{{ id }}" + correlator: "{{ correlator }}" + html_url: "{{ html_url }}" + - name: sha + value: "{{ sha }}" + description: | + The commit SHA associated with this dependency snapshot. Maximum length: 40 characters. + - name: ref + value: "{{ ref }}" + description: | + The repository branch that triggered this snapshot. + - name: detector + description: | + A description of the detector used. + value: + name: "{{ name }}" + version: "{{ version }}" + url: "{{ url }}" + - name: metadata + value: "{{ metadata }}" + description: | + User-defined metadata to store domain-specific information limited to 8 keys with scalar values. + - name: manifests + value: "{{ manifests }}" + description: | + A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. + - name: scanned + value: "{{ scanned }}" + description: | + The time at which the snapshot was scanned. +`} + + + diff --git a/website/docs/services/dependency_graph/index.md b/website/docs/services/dependency_graph/index.md index e0b1b66..f2bd420 100644 --- a/website/docs/services/dependency_graph/index.md +++ b/website/docs/services/dependency_graph/index.md @@ -9,41 +9,26 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Dependency Graph - -:::info Service Summary +dependency_graph service documentation. -
-
-total resources: 3
-total selectable resources: 2
-total methods: 3
-
-
+:::info[Service Summary] -::: +total resources: __3__ -## Overview - - - - - - -
Namegithub.dependency_graph
TypeService
TitleGitHub V3 REST API - Dependency Graph
DescriptionDependency Graph
Iddependency_graph:v24.04.00227
+::: ## Resources
dependency_review
-dependency_submission
+dependency_submission
-sboms
-
+sboms
+ \ No newline at end of file diff --git a/website/docs/services/dependency_graph/sboms/index.md b/website/docs/services/dependency_graph/sboms/index.md index 44af3dc..b562310 100644 --- a/website/docs/services/dependency_graph/sboms/index.md +++ b/website/docs/services/dependency_graph/sboms/index.md @@ -1,34 +1,184 @@ ---- +--- title: sboms hide_title: false hide_table_of_contents: false keywords: - sboms - dependency_graph - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a sboms resource. ## Overview - +
Namesboms
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the SPDX document. (example: github/github)
stringThe SPDX identifier for the SPDX document. (example: SPDXRef-DOCUMENT)
stringAn optional comment about the SPDX document. (example: Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/)
object
stringThe license under which the SPDX document is licensed. (example: CC0-1.0)
stringThe namespace for the SPDX document. (example: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57)
array
array
stringThe version of the SPDX specification that this document conforms to. (example: SPDX-2.3)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoExports the software bill of materials (SBOM) for a repository in SPDX JSON format.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. + +```sql +SELECT +name, +SPDXID, +comment, +creationInfo, +dataLicense, +documentNamespace, +packages, +relationships, +spdxVersion +FROM github.dependency_graph.sboms +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/emojis/emojis/index.md b/website/docs/services/emojis/emojis/index.md new file mode 100644 index 0000000..21dbf44 --- /dev/null +++ b/website/docs/services/emojis/emojis/index.md @@ -0,0 +1,97 @@ +--- +title: emojis +hide_title: false +hide_table_of_contents: false +keywords: + - emojis + - emojis + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an emojis resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Lists all the emojis available to use on GitHub.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Lists all the emojis available to use on GitHub. + +```sql +EXEC github.emojis.emojis.get_emojis + +; +``` + + diff --git a/website/docs/services/emojis/index.md b/website/docs/services/emojis/index.md new file mode 100644 index 0000000..58434c5 --- /dev/null +++ b/website/docs/services/emojis/index.md @@ -0,0 +1,33 @@ +--- +title: emojis +hide_title: false +hide_table_of_contents: false +keywords: + - emojis + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +emojis service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+emojis +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/enterprise_team_memberships/enterprise_team_membership_bulk_additions/index.md b/website/docs/services/enterprise_team_memberships/enterprise_team_membership_bulk_additions/index.md new file mode 100644 index 0000000..6a7a133 --- /dev/null +++ b/website/docs/services/enterprise_team_memberships/enterprise_team_membership_bulk_additions/index.md @@ -0,0 +1,157 @@ +--- +title: enterprise_team_membership_bulk_additions +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_membership_bulk_additions + - enterprise_team_memberships + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_team_membership_bulk_additions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, enterprise-team, usernamesAdd multiple team members to an enterprise team.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
+ +## `INSERT` examples + + + + +Add multiple team members to an enterprise team. + +```sql +INSERT INTO github.enterprise_team_memberships.enterprise_team_membership_bulk_additions ( +usernames, +enterprise, +enterprise-team +) +SELECT +'{{ usernames }}' /* required */, +'{{ enterprise }}', +'{{ enterprise-team }}' +RETURNING +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +; +``` + + + +{`# Description fields are for documentation purposes +- name: enterprise_team_membership_bulk_additions + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the enterprise_team_membership_bulk_additions resource. + - name: enterprise-team + value: "{{ enterprise-team }}" + description: Required parameter for the enterprise_team_membership_bulk_additions resource. + - name: usernames + value: + - "{{ usernames }}" + description: | + The GitHub user handles to add to the team. +`} + + + diff --git a/website/docs/services/enterprise_team_memberships/enterprise_team_membership_bulk_removals/index.md b/website/docs/services/enterprise_team_memberships/enterprise_team_membership_bulk_removals/index.md new file mode 100644 index 0000000..13a82e9 --- /dev/null +++ b/website/docs/services/enterprise_team_memberships/enterprise_team_membership_bulk_removals/index.md @@ -0,0 +1,157 @@ +--- +title: enterprise_team_membership_bulk_removals +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_membership_bulk_removals + - enterprise_team_memberships + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_team_membership_bulk_removals resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, enterprise-team, usernamesRemove multiple team members from an enterprise team.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
+ +## `INSERT` examples + + + + +Remove multiple team members from an enterprise team. + +```sql +INSERT INTO github.enterprise_team_memberships.enterprise_team_membership_bulk_removals ( +usernames, +enterprise, +enterprise-team +) +SELECT +'{{ usernames }}' /* required */, +'{{ enterprise }}', +'{{ enterprise-team }}' +RETURNING +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +; +``` + + + +{`# Description fields are for documentation purposes +- name: enterprise_team_membership_bulk_removals + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the enterprise_team_membership_bulk_removals resource. + - name: enterprise-team + value: "{{ enterprise-team }}" + description: Required parameter for the enterprise_team_membership_bulk_removals resource. + - name: usernames + value: + - "{{ usernames }}" + description: | + The GitHub user handles to be removed from the team. +`} + + + diff --git a/website/docs/services/enterprise_team_memberships/enterprise_team_memberships/index.md b/website/docs/services/enterprise_team_memberships/enterprise_team_memberships/index.md new file mode 100644 index 0000000..7c022af --- /dev/null +++ b/website/docs/services/enterprise_team_memberships/enterprise_team_memberships/index.md @@ -0,0 +1,534 @@ +--- +title: enterprise_team_memberships +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_memberships + - enterprise_team_memberships + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_team_memberships resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +User is a member of the enterprise team. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, enterprise-team, usernameReturns whether the user is a member of the enterprise team.
enterprise, enterprise-teamper_page, pageLists all team members in an enterprise team.
enterprise, enterprise-team, usernameAdd a team member to an enterprise team.
enterprise, enterprise-team, usernameRemove membership of a specific user from a particular team in an enterprise.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Returns whether the user is a member of the enterprise team. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.enterprise_team_memberships.enterprise_team_memberships +WHERE enterprise = '{{ enterprise }}' -- required +AND enterprise-team = '{{ enterprise-team }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +Lists all team members in an enterprise team. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.enterprise_team_memberships.enterprise_team_memberships +WHERE enterprise = '{{ enterprise }}' -- required +AND enterprise-team = '{{ enterprise-team }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Add a team member to an enterprise team. + +```sql +REPLACE github.enterprise_team_memberships.enterprise_team_memberships +SET +-- No updatable properties +WHERE +enterprise = '{{ enterprise }}' --required +AND enterprise-team = '{{ enterprise-team }}' --required +AND username = '{{ username }}' --required +RETURNING +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type; +``` + + + + +## `DELETE` examples + + + + +Remove membership of a specific user from a particular team in an enterprise. + +```sql +DELETE FROM github.enterprise_team_memberships.enterprise_team_memberships +WHERE enterprise = '{{ enterprise }}' --required +AND enterprise-team = '{{ enterprise-team }}' --required +AND username = '{{ username }}' --required +; +``` + + diff --git a/website/docs/services/enterprise_team_memberships/index.md b/website/docs/services/enterprise_team_memberships/index.md new file mode 100644 index 0000000..09016ae --- /dev/null +++ b/website/docs/services/enterprise_team_memberships/index.md @@ -0,0 +1,34 @@ +--- +title: enterprise_team_memberships +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_memberships + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +enterprise_team_memberships service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+enterprise_team_membership_bulk_additions
+enterprise_team_membership_bulk_removals +
+
+enterprise_team_memberships +
+
\ No newline at end of file diff --git a/website/docs/services/enterprise_team_organizations/enterprise_team_organization_bulk_additions/index.md b/website/docs/services/enterprise_team_organizations/enterprise_team_organization_bulk_additions/index.md new file mode 100644 index 0000000..54581bd --- /dev/null +++ b/website/docs/services/enterprise_team_organizations/enterprise_team_organization_bulk_additions/index.md @@ -0,0 +1,147 @@ +--- +title: enterprise_team_organization_bulk_additions +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_organization_bulk_additions + - enterprise_team_organizations + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_team_organization_bulk_additions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, enterprise-team, organization_slugsAssign an enterprise team to multiple organizations.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
+ +## `INSERT` examples + + + + +Assign an enterprise team to multiple organizations. + +```sql +INSERT INTO github.enterprise_team_organizations.enterprise_team_organization_bulk_additions ( +organization_slugs, +enterprise, +enterprise-team +) +SELECT +'{{ organization_slugs }}' /* required */, +'{{ enterprise }}', +'{{ enterprise-team }}' +RETURNING +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: enterprise_team_organization_bulk_additions + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the enterprise_team_organization_bulk_additions resource. + - name: enterprise-team + value: "{{ enterprise-team }}" + description: Required parameter for the enterprise_team_organization_bulk_additions resource. + - name: organization_slugs + value: + - "{{ organization_slugs }}" + description: | + Organization slug to assign the team to. +`} + + + diff --git a/website/docs/services/enterprise_team_organizations/enterprise_team_organization_bulk_removals/index.md b/website/docs/services/enterprise_team_organizations/enterprise_team_organization_bulk_removals/index.md new file mode 100644 index 0000000..fa1970e --- /dev/null +++ b/website/docs/services/enterprise_team_organizations/enterprise_team_organization_bulk_removals/index.md @@ -0,0 +1,134 @@ +--- +title: enterprise_team_organization_bulk_removals +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_organization_bulk_removals + - enterprise_team_organizations + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_team_organization_bulk_removals resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, enterprise-team, organization_slugsUnassign an enterprise team from multiple organizations.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
+ +## `INSERT` examples + + + + +Unassign an enterprise team from multiple organizations. + +```sql +INSERT INTO github.enterprise_team_organizations.enterprise_team_organization_bulk_removals ( +organization_slugs, +enterprise, +enterprise-team +) +SELECT +'{{ organization_slugs }}' /* required */, +'{{ enterprise }}', +'{{ enterprise-team }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: enterprise_team_organization_bulk_removals + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the enterprise_team_organization_bulk_removals resource. + - name: enterprise-team + value: "{{ enterprise-team }}" + description: Required parameter for the enterprise_team_organization_bulk_removals resource. + - name: organization_slugs + value: + - "{{ organization_slugs }}" + description: | + Organization slug to unassign the team from. +`} + + + diff --git a/website/docs/services/enterprise_team_organizations/enterprise_team_organizations/index.md b/website/docs/services/enterprise_team_organizations/enterprise_team_organizations/index.md new file mode 100644 index 0000000..bc1e953 --- /dev/null +++ b/website/docs/services/enterprise_team_organizations/enterprise_team_organizations/index.md @@ -0,0 +1,404 @@ +--- +title: enterprise_team_organizations +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_organizations + - enterprise_team_organizations + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_team_organizations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The team is assigned to the organization + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDEyOk9yZ2FuaXphdGlvbjE=)
string (example: https://github.com/images/error/octocat_happy.gif)
string (example: A great organization)
string (uri) (example: https://api.github.com/orgs/github/events)
string (example: https://api.github.com/orgs/github/hooks)
string (example: https://api.github.com/orgs/github/issues)
string (example: github)
string (example: https://api.github.com/orgs/github/members{/member})
string (example: https://api.github.com/orgs/github/public_members{/member})
string (uri) (example: https://api.github.com/orgs/github/repos)
string (uri) (example: https://api.github.com/orgs/github)
+ + + +An array of organizations the team is assigned to + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDEyOk9yZ2FuaXphdGlvbjE=)
string (example: https://github.com/images/error/octocat_happy.gif)
string (example: A great organization)
string (uri) (example: https://api.github.com/orgs/github/events)
string (example: https://api.github.com/orgs/github/hooks)
string (example: https://api.github.com/orgs/github/issues)
string (example: github)
string (example: https://api.github.com/orgs/github/members{/member})
string (example: https://api.github.com/orgs/github/public_members{/member})
string (uri) (example: https://api.github.com/orgs/github/repos)
string (uri) (example: https://api.github.com/orgs/github)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, enterprise-team, orgCheck if an enterprise team is assigned to an organization
enterprise, enterprise-teamper_page, pageGet all organizations assigned to an enterprise team
enterprise, enterprise-team, orgAssign an enterprise team to an organization.
enterprise, enterprise-team, orgUnassign an enterprise team from an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug version of the enterprise team name. You can also substitute this value with the enterprise team id.
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Check if an enterprise team is assigned to an organization + +```sql +SELECT +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url +FROM github.enterprise_team_organizations.enterprise_team_organizations +WHERE enterprise = '{{ enterprise }}' -- required +AND enterprise-team = '{{ enterprise-team }}' -- required +AND org = '{{ org }}' -- required +; +``` + + + +Get all organizations assigned to an enterprise team + +```sql +SELECT +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url +FROM github.enterprise_team_organizations.enterprise_team_organizations +WHERE enterprise = '{{ enterprise }}' -- required +AND enterprise-team = '{{ enterprise-team }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Assign an enterprise team to an organization. + +```sql +REPLACE github.enterprise_team_organizations.enterprise_team_organizations +SET +-- No updatable properties +WHERE +enterprise = '{{ enterprise }}' --required +AND enterprise-team = '{{ enterprise-team }}' --required +AND org = '{{ org }}' --required +RETURNING +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url; +``` + + + + +## `DELETE` examples + + + + +Unassign an enterprise team from an organization. + +```sql +DELETE FROM github.enterprise_team_organizations.enterprise_team_organizations +WHERE enterprise = '{{ enterprise }}' --required +AND enterprise-team = '{{ enterprise-team }}' --required +AND org = '{{ org }}' --required +; +``` + + diff --git a/website/docs/services/enterprise_team_organizations/index.md b/website/docs/services/enterprise_team_organizations/index.md new file mode 100644 index 0000000..e6857ba --- /dev/null +++ b/website/docs/services/enterprise_team_organizations/index.md @@ -0,0 +1,34 @@ +--- +title: enterprise_team_organizations +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_team_organizations + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +enterprise_team_organizations service documentation. + +:::info[Service Summary] + +total resources: __3__ + +::: + +## Resources +
+
+enterprise_team_organization_bulk_additions
+enterprise_team_organization_bulk_removals +
+
+enterprise_team_organizations +
+
\ No newline at end of file diff --git a/website/docs/services/enterprise_teams/enterprise_teams/index.md b/website/docs/services/enterprise_teams/enterprise_teams/index.md new file mode 100644 index 0000000..1aaf35c --- /dev/null +++ b/website/docs/services/enterprise_teams/enterprise_teams/index.md @@ -0,0 +1,508 @@ +--- +title: enterprise_teams +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_teams + - enterprise_teams + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an enterprise_teams resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 62ab9291-fae2-468e-974b-7e45096d5021)
stringRetired: this field will not be returned with GHEC enterprise teams. (example: Justice League)
string (date-time)
string
string (uri) (example: https://github.com/enterprises/dc/teams/justice-league)
string
string (example: disabled | selected | all)
string
stringRetired: this field will not be returned with GHEC enterprise teams. (example: disabled | all)
string (date-time)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 62ab9291-fae2-468e-974b-7e45096d5021)
stringRetired: this field will not be returned with GHEC enterprise teams. (example: Justice League)
string (date-time)
string
string (uri) (example: https://github.com/enterprises/dc/teams/justice-league)
string
string (example: disabled | selected | all)
string
stringRetired: this field will not be returned with GHEC enterprise teams. (example: disabled | all)
string (date-time)
string (uri)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterprise, team_slugGets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam NΓ€me" would become `ent:my-team-name`.
enterpriseper_page, pageList all teams in the enterprise for the authenticated user
enterprise, nameTo create an enterprise team, the authenticated user must be an owner of the enterprise.
enterprise, team_slugTo edit a team, the authenticated user must be an enterprise owner.
enterprise, team_slugTo delete an enterprise team, the authenticated user must be an enterprise owner.

If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe slug version of the enterprise name.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam NΓ€me" would become `ent:my-team-name`. + +```sql +SELECT +id, +name, +group_id, +group_name, +created_at, +description, +html_url, +members_url, +organization_selection_type, +slug, +sync_to_organizations, +updated_at, +url +FROM github.enterprise_teams.enterprise_teams +WHERE enterprise = '{{ enterprise }}' -- required +AND team_slug = '{{ team_slug }}' -- required +; +``` + + + +List all teams in the enterprise for the authenticated user + +```sql +SELECT +id, +name, +group_id, +group_name, +created_at, +description, +html_url, +members_url, +organization_selection_type, +slug, +sync_to_organizations, +updated_at, +url +FROM github.enterprise_teams.enterprise_teams +WHERE enterprise = '{{ enterprise }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +To create an enterprise team, the authenticated user must be an owner of the enterprise. + +```sql +INSERT INTO github.enterprise_teams.enterprise_teams ( +name, +description, +sync_to_organizations, +organization_selection_type, +group_id, +enterprise +) +SELECT +'{{ name }}' /* required */, +'{{ description }}', +'{{ sync_to_organizations }}', +'{{ organization_selection_type }}', +'{{ group_id }}', +'{{ enterprise }}' +RETURNING +id, +name, +group_id, +group_name, +created_at, +description, +html_url, +members_url, +organization_selection_type, +slug, +sync_to_organizations, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: enterprise_teams + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the enterprise_teams resource. + - name: name + value: "{{ name }}" + description: | + The name of the team. + - name: description + value: "{{ description }}" + description: | + A description of the team. + - name: sync_to_organizations + value: "{{ sync_to_organizations }}" + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be set. + valid_values: ['all', 'disabled'] + default: disabled + - name: organization_selection_type + value: "{{ organization_selection_type }}" + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of \`disabled\`, \`selected\`, or \`all\`. + \`disabled\`: The team is not assigned to any organizations. This is the default when you create a new team. + \`selected\`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + \`all\`: The team is assigned to all current and future organizations in the enterprise. + valid_values: ['disabled', 'selected', 'all'] + default: disabled + - name: group_id + value: "{{ group_id }}" + description: | + The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). +`} + + + + + +## `UPDATE` examples + + + + +To edit a team, the authenticated user must be an enterprise owner. + +```sql +UPDATE github.enterprise_teams.enterprise_teams +SET +name = '{{ name }}', +description = '{{ description }}', +sync_to_organizations = '{{ sync_to_organizations }}', +organization_selection_type = '{{ organization_selection_type }}', +group_id = '{{ group_id }}' +WHERE +enterprise = '{{ enterprise }}' --required +AND team_slug = '{{ team_slug }}' --required +RETURNING +id, +name, +group_id, +group_name, +created_at, +description, +html_url, +members_url, +organization_selection_type, +slug, +sync_to_organizations, +updated_at, +url; +``` + + + + +## `DELETE` examples + + + + +To delete an enterprise team, the authenticated user must be an enterprise owner.

If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + +```sql +DELETE FROM github.enterprise_teams.enterprise_teams +WHERE enterprise = '{{ enterprise }}' --required +AND team_slug = '{{ team_slug }}' --required +; +``` + + diff --git a/website/docs/services/enterprise_teams/index.md b/website/docs/services/enterprise_teams/index.md new file mode 100644 index 0000000..60fca8d --- /dev/null +++ b/website/docs/services/enterprise_teams/index.md @@ -0,0 +1,33 @@ +--- +title: enterprise_teams +hide_title: false +hide_table_of_contents: false +keywords: + - enterprise_teams + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +enterprise_teams service documentation. + +:::info[Service Summary] + +total resources: __1__ + +::: + +## Resources +
+
+enterprise_teams +
+
+ +
+
\ No newline at end of file diff --git a/website/docs/services/gists/comments/index.md b/website/docs/services/gists/comments/index.md index 5633ba5..01eabe1 100644 --- a/website/docs/services/gists/comments/index.md +++ b/website/docs/services/gists/comments/index.md @@ -1,48 +1,402 @@ ---- +--- title: comments hide_title: false hide_table_of_contents: false keywords: - comments - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a comments resource. ## Overview - +
Namecomments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | How the author is associated with the repository. | -| | `string` | The comment text. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDExOkdpc3RDb21tZW50MQ==)
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe comment text. (example: Body of the attachment)
string (date-time) (example: 2011-04-18T23:23:56Z)
string (date-time) (example: 2011-04-18T23:23:56Z)
string (uri) (example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDExOkdpc3RDb21tZW50MQ==)
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe comment text. (example: Body of the attachment)
string (date-time) (example: 2011-04-18T23:23:56Z)
string (date-time) (example: 2011-04-18T23:23:56Z)
string (uri) (example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `SELECT` | | -| | `INSERT` | | -| | `DELETE` | | -| | `EXEC` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
gist_id, comment_idGets a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
gist_idper_page, pageLists the comments on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
gist_id, bodyCreates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
gist_id, comment_id, bodyUpdates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
gist_id, comment_id
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
stringThe unique identifier of the gist.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +SELECT +id, +node_id, +author_association, +body, +created_at, +updated_at, +url, +user +FROM github.gists.comments +WHERE gist_id = '{{ gist_id }}' -- required +AND comment_id = '{{ comment_id }}' -- required +; +``` + + + +Lists the comments on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +SELECT +id, +node_id, +author_association, +body, +created_at, +updated_at, +url, +user +FROM github.gists.comments +WHERE gist_id = '{{ gist_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +INSERT INTO github.gists.comments ( +body, +gist_id +) +SELECT +'{{ body }}' /* required */, +'{{ gist_id }}' +RETURNING +id, +node_id, +author_association, +body, +created_at, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: comments + props: + - name: gist_id + value: "{{ gist_id }}" + description: Required parameter for the comments resource. + - name: body + value: "{{ body }}" + description: | + The comment text. +`} + + + + + +## `UPDATE` examples + + + + +Updates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +UPDATE github.gists.comments +SET +body = '{{ body }}' +WHERE +gist_id = '{{ gist_id }}' --required +AND comment_id = '{{ comment_id }}' --required +AND body = '{{ body }}' --required +RETURNING +id, +node_id, +author_association, +body, +created_at, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +No description available. + +```sql +DELETE FROM github.gists.comments +WHERE gist_id = '{{ gist_id }}' --required +AND comment_id = '{{ comment_id }}' --required +; +``` + + diff --git a/website/docs/services/gists/commits/index.md b/website/docs/services/gists/commits/index.md index 188a6d3..3fb5736 100644 --- a/website/docs/services/gists/commits/index.md +++ b/website/docs/services/gists/commits/index.md @@ -1,41 +1,166 @@ ---- +--- title: commits hide_title: false hide_table_of_contents: false keywords: - commits - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commits resource. ## Overview - +
Namecommits
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
string (date-time) (example: 2010-04-14T02:15:15Z)
string (uri) (example: https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f)
objectA GitHub user. (title: Simple User)
string (example: 57a7f021a713b1c5a6a199b54cc514735d2d462f)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
gist_idper_page, page
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the gist.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +change_status, +committed_at, +url, +user, +version +FROM github.gists.commits +WHERE gist_id = '{{ gist_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/gists/forks/index.md b/website/docs/services/gists/forks/index.md index 58732a2..fe408dd 100644 --- a/website/docs/services/gists/forks/index.md +++ b/website/docs/services/gists/forks/index.md @@ -1,57 +1,268 @@ ---- +--- title: forks hide_title: false hide_table_of_contents: false keywords: - forks - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a forks resource. ## Overview - +
Nameforks
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `object` | Gist | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string
string
string
string
object
objectGist (title: Gist)
array
string
string
string
array
string
objectA GitHub user. (title: Simple User)
boolean
boolean
string
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
gist_idper_page, page
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the gist.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +fork_of, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.forks +WHERE gist_id = '{{ gist_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/gists/gist/index.md b/website/docs/services/gists/gist/index.md deleted file mode 100644 index 7aad5a0..0000000 --- a/website/docs/services/gists/gist/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: gist -hide_title: false -hide_table_of_contents: false -keywords: - - gist - - gists - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namegist
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `object` | Gist | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/gists/gists/index.md b/website/docs/services/gists/gists/index.md index 450c652..494e871 100644 --- a/website/docs/services/gists/gists/index.md +++ b/website/docs/services/gists/gists/index.md @@ -1,64 +1,878 @@ ---- +--- title: gists hide_title: false hide_table_of_contents: false keywords: - gists - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a gists resource. ## Overview - +
Namegists
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string
string
string
string
object
objectGist (title: Gist)
array
string
string
string
array
string
objectA GitHub user. (title: Simple User)
boolean
boolean
string
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string (uri)
string (uri)
string (date-time)
string
object
array
string (uri)
string (uri)
string (uri)
array
string (uri)
objectA GitHub user. (title: Simple User)
boolean
boolean
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string (uri)
string (uri)
string (date-time)
string
object
array
string (uri)
string (uri)
string (uri)
array
string (uri)
objectA GitHub user. (title: Simple User)
boolean
boolean
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: | -| | `SELECT` | | Lists public gists for the specified user: | -| | `INSERT` | | Allows you to add a new gist with one or more files.

**Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. | -| | `DELETE` | | | -| | `EXEC` | | | -| | `EXEC` | | | -| | `EXEC` | | Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." | -| | `EXEC` | | | -| | `EXEC` | | Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
At least one of `description` or `files` is required. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
gist_idGets a specified gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
usernamesince, per_page, pageLists public gists for the specified user:
since, per_page, pageLists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:
gist_id
filesAllows you to add a new gist with one or more files.

> [!NOTE]
> Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.
gist_idAllows you to update a gist's description and to update, delete, or rename gist files. Files
from the previous version of the gist that aren't explicitly changed during an edit
are unchanged.

At least one of `description` or `files` is required.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
gist_id
gist_id
gist_idNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
gist_id
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the gist.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +Gets a specified gist.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +fork_of, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.gists +WHERE gist_id = '{{ gist_id }}' -- required +; +``` + + + +Lists public gists for the specified user: + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.gists +WHERE username = '{{ username }}' -- required +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.gists +WHERE since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +No description available. + +```sql +INSERT INTO github.gists.gists ( +gist_id +) +SELECT +'{{ gist_id }}' +RETURNING +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +; +``` + + + +Allows you to add a new gist with one or more files.

> [!NOTE]
> Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + +```sql +INSERT INTO github.gists.gists ( +description, +files, +public +) +SELECT +'{{ description }}', +'{{ files }}' /* required */, +{{ public }} +RETURNING +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +fork_of, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: gists + props: + - name: gist_id + value: "{{ gist_id }}" + description: Required parameter for the gists resource. + - name: description + value: "{{ description }}" + description: | + Description of the gist + - name: files + value: "{{ files }}" + description: | + Names and content for the files that make up the gist + - name: public + value: {{ public }} + description: | + Flag indicating whether the gist is public + valid_values: ['true', 'false'] + default: false +`} + + + + + +## `UPDATE` examples + + + + +Allows you to update a gist's description and to update, delete, or rename gist files. Files
from the previous version of the gist that aren't explicitly changed during an edit
are unchanged.

At least one of `description` or `files` is required.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +UPDATE github.gists.gists +SET +description = '{{ description }}', +files = '{{ files }}' +WHERE +gist_id = '{{ gist_id }}' --required +RETURNING +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +fork_of, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +No description available. + +```sql +DELETE FROM github.gists.gists +WHERE gist_id = '{{ gist_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Response if gist is starred + +```sql +EXEC github.gists.gists.check_is_starred +@gist_id='{{ gist_id }}' --required +; +``` + + + +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + +```sql +EXEC github.gists.gists.star +@gist_id='{{ gist_id }}' --required +; +``` + + + +Response + +```sql +EXEC github.gists.gists.unstar +@gist_id='{{ gist_id }}' --required +; +``` + + diff --git a/website/docs/services/gists/index.md b/website/docs/services/gists/index.md index e1eddb6..f67be7e 100644 --- a/website/docs/services/gists/index.md +++ b/website/docs/services/gists/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -View, Modify Your Gists. - -:::info Service Summary +gists service documentation. -
-
-total resources: 8
-total selectable resources: 8
-total methods: 20
-
-
+:::info[Service Summary] -::: +total resources: __7__ -## Overview - - - - - - -
Namegithub.gists
TypeService
TitleGitHub V3 REST API - Gists
DescriptionView, Modify Your Gists.
Idgists:v24.04.00227
+::: ## Resources
@@ -43,12 +28,11 @@ View, Modify Your Gists. comments
commits
forks
-gist
+gists
-gists
public_gists
revisions
-starred_gists
-
+starred_gists + \ No newline at end of file diff --git a/website/docs/services/gists/public_gists/index.md b/website/docs/services/gists/public_gists/index.md index 942ad14..f3a6b2d 100644 --- a/website/docs/services/gists/public_gists/index.md +++ b/website/docs/services/gists/public_gists/index.md @@ -1,56 +1,262 @@ ---- +--- title: public_gists hide_title: false hide_table_of_contents: false keywords: - public_gists - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_gists resource. ## Overview - +
Namepublic_gists
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string (uri)
string (uri)
string (date-time)
string
object
array
string (uri)
string (uri)
string (uri)
array
string (uri)
objectA GitHub user. (title: Simple User)
boolean
boolean
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
since, per_page, pageList public gists sorted by most recently updated to least recently updated.

Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +List public gists sorted by most recently updated to least recently updated.

Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.public_gists +WHERE since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/gists/revisions/index.md b/website/docs/services/gists/revisions/index.md index 87ce59a..b3daaa3 100644 --- a/website/docs/services/gists/revisions/index.md +++ b/website/docs/services/gists/revisions/index.md @@ -1,57 +1,262 @@ ---- +--- title: revisions hide_title: false hide_table_of_contents: false keywords: - revisions - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a revisions resource. ## Overview - +
Namerevisions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `object` | Gist | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string
string
string
string
object
objectGist (title: Gist)
array
string
string
string
array
string
objectA GitHub user. (title: Simple User)
boolean
boolean
string
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
gist_id, shaGets a specified gist revision.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the gist.
string
+ +## `SELECT` examples + + + + +Gets a specified gist revision.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +fork_of, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.revisions +WHERE gist_id = '{{ gist_id }}' -- required +AND sha = '{{ sha }}' -- required +; +``` + + diff --git a/website/docs/services/gists/starred_gists/index.md b/website/docs/services/gists/starred_gists/index.md index f0bbc93..50de9be 100644 --- a/website/docs/services/gists/starred_gists/index.md +++ b/website/docs/services/gists/starred_gists/index.md @@ -1,56 +1,262 @@ ---- +--- title: starred_gists hide_title: false hide_table_of_contents: false keywords: - starred_gists - gists - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a starred_gists resource. ## Overview - +
Namestarred_gists
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
integer
boolean
string (uri)
string (uri)
string (date-time)
string
object
array
string (uri)
string (uri)
string (uri)
array
string (uri)
objectA GitHub user. (title: Simple User)
boolean
boolean
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
since, per_page, pageList the authenticated user's starred gists:
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +List the authenticated user's starred gists: + +```sql +SELECT +id, +node_id, +comments, +comments_enabled, +comments_url, +commits_url, +created_at, +description, +files, +forks, +forks_url, +git_pull_url, +git_push_url, +history, +html_url, +owner, +public, +truncated, +updated_at, +url, +user +FROM github.gists.starred_gists +WHERE since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/git/blobs/index.md b/website/docs/services/git/blobs/index.md index 322cd99..9f39667 100644 --- a/website/docs/services/git/blobs/index.md +++ b/website/docs/services/git/blobs/index.md @@ -1,44 +1,242 @@ ---- +--- title: blobs hide_title: false hide_table_of_contents: false keywords: - blobs - git - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a blobs resource. ## Overview - +
Nameblobs
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
string
string
integer
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | The `content` in the response will always be Base64 encoded.

_Note_: This API supports blobs up to 100 megabytes in size. | -| | `INSERT` | | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, file_shaThe `content` in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw blob data.
- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.

**Note** This endpoint supports blobs up to 100 megabytes in size.
owner, repo, content
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +The `content` in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw blob data.
- **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified.

**Note** This endpoint supports blobs up to 100 megabytes in size. + +```sql +SELECT +node_id, +content, +encoding, +highlighted_content, +sha, +size, +url +FROM github.git.blobs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND file_sha = '{{ file_sha }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +No description available. + +```sql +INSERT INTO github.git.blobs ( +content, +encoding, +owner, +repo +) +SELECT +'{{ content }}' /* required */, +'{{ encoding }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +sha, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: blobs + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the blobs resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the blobs resource. + - name: content + value: "{{ content }}" + description: | + The new blob's content. + - name: encoding + value: "{{ encoding }}" + description: | + The encoding used for \`content\`. Currently, \`"utf-8"\` and \`"base64"\` are supported. + default: utf-8 +`} + + + diff --git a/website/docs/services/git/commits/index.md b/website/docs/services/git/commits/index.md index 740872a..077773e 100644 --- a/website/docs/services/git/commits/index.md +++ b/website/docs/services/git/commits/index.md @@ -1,47 +1,298 @@ ---- +--- title: commits hide_title: false hide_table_of_contents: false keywords: - commits - git - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commits resource. ## Overview - +
Namecommits
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | Identifying information for the git-user | -| | `object` | Identifying information for the git-user | -| | `string` | | -| | `string` | Message describing the purpose of the commit | -| | `string` | | -| | `array` | | -| | `string` | SHA for the commit | -| | `object` | | -| | `string` | | -| | `object` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
objectIdentifying information for the git-user
objectIdentifying information for the git-user
string (uri)
stringMessage describing the purpose of the commit (example: Fix #42)
array
stringSHA for the commit (example: 7638417db6d59f3c431d3e1f261cc637155684cd)
object
string (uri)
object
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in the table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | -| | `INSERT` | | Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in the table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, commit_shaGets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

To get the contents of a commit, see "[Get a commit](https://docs.github.com/rest/commits/commits#get-a-commit)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
owner, repo, message, treeCreates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe SHA of the commit.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

To get the contents of a commit, see "[Get a commit](https://docs.github.com/rest/commits/commits#get-a-commit)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +SELECT +node_id, +author, +committer, +html_url, +message, +parents, +sha, +tree, +url, +verification +FROM github.git.commits +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND commit_sha = '{{ commit_sha }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +INSERT INTO github.git.commits ( +message, +tree, +parents, +author, +committer, +signature, +owner, +repo +) +SELECT +'{{ message }}' /* required */, +'{{ tree }}' /* required */, +'{{ parents }}', +'{{ author }}', +'{{ committer }}', +'{{ signature }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +node_id, +author, +committer, +html_url, +message, +parents, +sha, +tree, +url, +verification +; +``` + + + +{`# Description fields are for documentation purposes +- name: commits + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the commits resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the commits resource. + - name: message + value: "{{ message }}" + description: | + The commit message + - name: tree + value: "{{ tree }}" + description: | + The SHA of the tree object this commit points to + - name: parents + value: + - "{{ parents }}" + description: | + The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + - name: author + description: | + Information about the author of the commit. By default, the \`author\` will be the authenticated user and the current date. See the \`author\` and \`committer\` object below for details. + value: + name: "{{ name }}" + email: "{{ email }}" + date: "{{ date }}" + - name: committer + description: | + Information about the person who is making the commit. By default, \`committer\` will use the information set in \`author\`. See the \`author\` and \`committer\` object below for details. + value: + name: "{{ name }}" + email: "{{ email }}" + date: "{{ date }}" + - name: signature + value: "{{ signature }}" + description: | + The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the \`gpgsig\` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a \`signature\` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. +`} + + + diff --git a/website/docs/services/git/index.md b/website/docs/services/git/index.md index 7decfc8..0002d90 100644 --- a/website/docs/services/git/index.md +++ b/website/docs/services/git/index.md @@ -9,44 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Raw Git Functionality. - -:::info Service Summary +git service documentation. -
-
-total resources: 6
-total selectable resources: 6
-total methods: 13
-
-
+:::info[Service Summary] -::: +total resources: __6__ -## Overview - - - - - - -
Namegithub.git
TypeService
TitleGitHub V3 REST API - Git
DescriptionRaw Git Functionality.
Idgit:v24.04.00227
+::: ## Resources
blobs
commits
-ref
+ref
refs
tags
-trees
-
+trees
+ \ No newline at end of file diff --git a/website/docs/services/git/ref/index.md b/website/docs/services/git/ref/index.md index 78d8cb9..6095d43 100644 --- a/website/docs/services/git/ref/index.md +++ b/website/docs/services/git/ref/index.md @@ -1,40 +1,160 @@ ---- +--- title: ref hide_title: false hide_table_of_contents: false keywords: - ref - git - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a ref resource. ## Overview - +
Nameref
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `object` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, refReturns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. (example: heads/feature-a)
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + +```sql +SELECT +node_id, +object, +ref, +url +FROM github.git.ref +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +; +``` + + diff --git a/website/docs/services/git/refs/index.md b/website/docs/services/git/refs/index.md index 54bec4e..5e1bf6e 100644 --- a/website/docs/services/git/refs/index.md +++ b/website/docs/services/git/refs/index.md @@ -1,43 +1,294 @@ ---- +--- title: refs hide_title: false hide_table_of_contents: false keywords: - refs - git - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a refs resource. ## Overview - +
Namerefs
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `object` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.

When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.

**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. | -| | `INSERT` | | Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. | -| | `DELETE` | | | -| | `EXEC` | | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, refReturns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.

When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.
owner, repo, ref, shaCreates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
owner, repo, ref, shaUpdates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
owner, repo, refDeletes the provided reference.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. (example: heads/feature-a)
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.

When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.

> [!NOTE]
> You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + +```sql +SELECT +node_id, +object, +ref, +url +FROM github.git.refs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. + +```sql +INSERT INTO github.git.refs ( +ref, +sha, +owner, +repo +) +SELECT +'{{ ref }}' /* required */, +'{{ sha }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +node_id, +object, +ref, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: refs + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the refs resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the refs resource. + - name: ref + value: "{{ ref }}" + description: | + The name of the fully qualified reference (ie: \`refs/heads/master\`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. + - name: sha + value: "{{ sha }}" + description: | + The SHA1 value for this reference. +`} + + + + + +## `UPDATE` examples + + + + +Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + +```sql +UPDATE github.git.refs +SET +sha = '{{ sha }}', +force = {{ force }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND ref = '{{ ref }}' --required +AND sha = '{{ sha }}' --required +RETURNING +node_id, +object, +ref, +url; +``` + + + + +## `DELETE` examples + + + + +Deletes the provided reference. + +```sql +DELETE FROM github.git.refs +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND ref = '{{ ref }}' --required +; +``` + + diff --git a/website/docs/services/git/tags/index.md b/website/docs/services/git/tags/index.md index cf92958..79e14a7 100644 --- a/website/docs/services/git/tags/index.md +++ b/website/docs/services/git/tags/index.md @@ -1,45 +1,275 @@ ---- +--- title: tags hide_title: false hide_table_of_contents: false keywords: - tags - git - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a tags resource. ## Overview - +
Nametags
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | Message describing the purpose of the tag | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | Name of the tag | -| | `object` | | -| | `string` | URL for the tag | -| | `object` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==)
stringMessage describing the purpose of the tag (example: Initial public release)
object
string (example: 940bd336248efae0f9ee5bc7b2d5c985887b16ac)
stringName of the tag (example: v0.0.1)
object
string (uri)URL for the tag (example: https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac)
object (title: Verification)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | **Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | -| | `INSERT` | | Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, tag_sha**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
owner, repo, tag, message, object, typeNote that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
string
+ +## `SELECT` examples + + + + +**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +SELECT +node_id, +message, +object, +sha, +tag, +tagger, +url, +verification +FROM github.git.tags +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND tag_sha = '{{ tag_sha }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +INSERT INTO github.git.tags ( +tag, +message, +object, +type, +tagger, +owner, +repo +) +SELECT +'{{ tag }}' /* required */, +'{{ message }}' /* required */, +'{{ object }}' /* required */, +'{{ type }}' /* required */, +'{{ tagger }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +node_id, +message, +object, +sha, +tag, +tagger, +url, +verification +; +``` + + + +{`# Description fields are for documentation purposes +- name: tags + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the tags resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the tags resource. + - name: tag + value: "{{ tag }}" + description: | + The tag's name. This is typically a version (e.g., "v0.0.1"). + - name: message + value: "{{ message }}" + description: | + The tag message. + - name: object + value: "{{ object }}" + description: | + The SHA of the git object this is tagging. + - name: type + value: "{{ type }}" + description: | + The type of the object we're tagging. Normally this is a \`commit\` but it can also be a \`tree\` or a \`blob\`. + valid_values: ['commit', 'tree', 'blob'] + - name: tagger + description: | + An object with information about the individual creating the tag. + value: + name: "{{ name }}" + email: "{{ email }}" + date: "{{ date }}" +`} + + + diff --git a/website/docs/services/git/trees/index.md b/website/docs/services/git/trees/index.md index 4d70494..98191ce 100644 --- a/website/docs/services/git/trees/index.md +++ b/website/docs/services/git/trees/index.md @@ -1,41 +1,237 @@ ---- +--- title: trees hide_title: false hide_table_of_contents: false keywords: - trees - git - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a trees resource. ## Overview - +
Nametrees
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `array` | Objects specifying a tree structure | -| | `boolean` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
arrayObjects specifying a tree structure
boolean
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns a single tree using the SHA1 value or ref name for that tree.

If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.


**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. | -| | `INSERT` | | The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."

Returns an error if you try to delete a file that does not exist. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, tree_sharecursiveReturns a single tree using the SHA1 value or ref name for that tree.

If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

> [!NOTE]
> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.
owner, repo, treeThe tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."

Returns an error if you try to delete a file that does not exist.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe SHA1 value or ref (branch or tag) name of the tree.
stringSetting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees.
+ +## `SELECT` examples + + + + +Returns a single tree using the SHA1 value or ref name for that tree.

If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.

> [!NOTE]
> The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + +```sql +SELECT +sha, +tree, +truncated, +url +FROM github.git.trees +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND tree_sha = '{{ tree_sha }}' -- required +AND recursive = '{{ recursive }}' +; +``` + + + + +## `INSERT` examples + + + + +The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)."

Returns an error if you try to delete a file that does not exist. + +```sql +INSERT INTO github.git.trees ( +tree, +base_tree, +owner, +repo +) +SELECT +'{{ tree }}' /* required */, +'{{ base_tree }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +sha, +tree, +truncated, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: trees + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the trees resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the trees resource. + - name: tree + description: | + Objects (of \`path\`, \`mode\`, \`type\`, and \`sha\`) specifying a tree structure. + value: + - path: "{{ path }}" + mode: "{{ mode }}" + type: "{{ type }}" + sha: "{{ sha }}" + content: "{{ content }}" + - name: base_tree + value: "{{ base_tree }}" + description: | + The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by \`base_tree\` and entries defined in the \`tree\` parameter. Entries defined in the \`tree\` parameter will overwrite items from \`base_tree\` with the same \`path\`. If you're creating new changes on a branch, then normally you'd set \`base_tree\` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + If not provided, GitHub will create a new Git tree object from only the entries defined in the \`tree\` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the \`tree\` parameter will be listed as deleted by the new commit. +`} + + + diff --git a/website/docs/services/gitignore/gitignore/index.md b/website/docs/services/gitignore/gitignore/index.md index 109bcdf..980838e 100644 --- a/website/docs/services/gitignore/gitignore/index.md +++ b/website/docs/services/gitignore/gitignore/index.md @@ -1,39 +1,172 @@ ---- +--- title: gitignore hide_title: false hide_table_of_contents: false keywords: - gitignore - gitignore - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a gitignore resource. ## Overview - +
Namegitignore
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: C)
string (example: # Object files
*.o

# Libraries
*.lib
*.a

# Shared objects (inc. Windows DLLs)
*.dll
*.so
*.so.*
*.dylib

# Executables
*.exe
*.out
*.app
)
+ + + +Response + + + + + + + + + + + +
NameDatatypeDescription
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). | -| | `SELECT` | | The API also allows fetching the source of a single template.
Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
nameGet the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents.
List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
+ +## `SELECT` examples + + + + +Get the content of a gitignore template.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + +```sql +SELECT +name, +source +FROM github.gitignore.gitignore +WHERE name = '{{ name }}' -- required +; +``` + + + +List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). + +```sql +SELECT +* +FROM github.gitignore.gitignore +; +``` + + diff --git a/website/docs/services/gitignore/index.md b/website/docs/services/gitignore/index.md index 1f676c4..88c886d 100644 --- a/website/docs/services/gitignore/index.md +++ b/website/docs/services/gitignore/index.md @@ -9,39 +9,25 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -View Gitignore Templates - -:::info Service Summary +gitignore service documentation. -
-
-total resources: 1
-total selectable resources: 1
-total methods: 2
-
-
+:::info[Service Summary] -::: +total resources: __1__ -## Overview - - - - - - -
Namegithub.gitignore
TypeService
TitleGitHub V3 REST API - Gitignore
DescriptionView Gitignore Templates
Idgitignore:v24.04.00227
+::: ## Resources
-gitignore
+gitignore
+
-
+ \ No newline at end of file diff --git a/website/docs/services/hosted_compute/index.md b/website/docs/services/hosted_compute/index.md new file mode 100644 index 0000000..2164574 --- /dev/null +++ b/website/docs/services/hosted_compute/index.md @@ -0,0 +1,33 @@ +--- +title: hosted_compute +hide_title: false +hide_table_of_contents: false +keywords: + - hosted_compute + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +hosted_compute service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+org_network_configurations +
+
+org_network_settings +
+
\ No newline at end of file diff --git a/website/docs/services/hosted_compute/org_network_configurations/index.md b/website/docs/services/hosted_compute/org_network_configurations/index.md new file mode 100644 index 0000000..569d87b --- /dev/null +++ b/website/docs/services/hosted_compute/org_network_configurations/index.md @@ -0,0 +1,388 @@ +--- +title: org_network_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - org_network_configurations + - hosted_compute + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_network_configurations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the network configuration. (example: 123ABC456DEF789)
stringThe name of the network configuration. (example: my-network-configuration)
stringThe hosted compute service the network configuration supports. (none, actions, codespaces)
string (date-time)The time at which the network configuration was created, in ISO 8601 format. (example: 2024-04-26T11:31:07Z)
booleanIndicates whether the failover network resource is enabled.
arrayThe unique identifier of each failover network settings in the configuration. (example: 123ABC456DEF789)
arrayThe unique identifier of each network settings in the configuration. (example: 123ABC456DEF789)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, network_configuration_idGets a hosted compute network configuration configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.
orgper_page, pageLists all hosted compute network configurations configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.
org, name, network_settings_idsCreates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.
org, network_configuration_idUpdates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.
org, network_configuration_idDeletes a hosted compute network configuration from an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier of the hosted compute network configuration.
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a hosted compute network configuration configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + +```sql +SELECT +id, +name, +compute_service, +created_on, +failover_network_enabled, +failover_network_settings_ids, +network_settings_ids +FROM github.hosted_compute.org_network_configurations +WHERE org = '{{ org }}' -- required +AND network_configuration_id = '{{ network_configuration_id }}' -- required +; +``` + + + +Lists all hosted compute network configurations configured in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + +```sql +SELECT +network_configurations, +total_count +FROM github.hosted_compute.org_network_configurations +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + +```sql +INSERT INTO github.hosted_compute.org_network_configurations ( +name, +compute_service, +network_settings_ids, +failover_network_settings_ids, +failover_network_enabled, +org +) +SELECT +'{{ name }}' /* required */, +'{{ compute_service }}', +'{{ network_settings_ids }}' /* required */, +'{{ failover_network_settings_ids }}', +{{ failover_network_enabled }}, +'{{ org }}' +RETURNING +id, +name, +compute_service, +created_on, +failover_network_enabled, +failover_network_settings_ids, +network_settings_ids +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_network_configurations + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_network_configurations resource. + - name: name + value: "{{ name }}" + description: | + Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. + - name: compute_service + value: "{{ compute_service }}" + description: | + The hosted compute service to use for the network configuration. + valid_values: ['none', 'actions'] + - name: network_settings_ids + value: + - "{{ network_settings_ids }}" + description: | + A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. + - name: failover_network_settings_ids + value: + - "{{ failover_network_settings_ids }}" + description: | + A list of identifiers of the failover network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. + - name: failover_network_enabled + value: {{ failover_network_enabled }} + description: | + Indicates whether the failover network resource is enabled. +`} + + + + + +## `UPDATE` examples + + + + +Updates a hosted compute network configuration for an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + +```sql +UPDATE github.hosted_compute.org_network_configurations +SET +name = '{{ name }}', +compute_service = '{{ compute_service }}', +network_settings_ids = '{{ network_settings_ids }}', +failover_network_settings_ids = '{{ failover_network_settings_ids }}', +failover_network_enabled = {{ failover_network_enabled }} +WHERE +org = '{{ org }}' --required +AND network_configuration_id = '{{ network_configuration_id }}' --required +RETURNING +id, +name, +compute_service, +created_on, +failover_network_enabled, +failover_network_settings_ids, +network_settings_ids; +``` + + + + +## `DELETE` examples + + + + +Deletes a hosted compute network configuration from an organization.

OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + +```sql +DELETE FROM github.hosted_compute.org_network_configurations +WHERE org = '{{ org }}' --required +AND network_configuration_id = '{{ network_configuration_id }}' --required +; +``` + + diff --git a/website/docs/services/hosted_compute/org_network_settings/index.md b/website/docs/services/hosted_compute/org_network_settings/index.md new file mode 100644 index 0000000..eaebb3f --- /dev/null +++ b/website/docs/services/hosted_compute/org_network_settings/index.md @@ -0,0 +1,160 @@ +--- +title: org_network_settings +hide_title: false +hide_table_of_contents: false +keywords: + - org_network_settings + - hosted_compute + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_network_settings resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe unique identifier of the network settings resource. (example: 220F78DACB92BBFBC5E6F22DE1CCF52309D)
stringThe name of the network settings resource. (example: my-network-settings)
stringThe identifier of the network configuration that is using this settings resource. (example: 934E208B3EE0BD60CF5F752C426BFB53562)
stringThe subnet this network settings resource is configured for. (example: /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet)
stringThe location of the subnet this network settings resource is configured for. (example: eastus)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, network_settings_idGets a hosted compute network settings resource configured for an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUnique identifier of the hosted compute network settings.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a hosted compute network settings resource configured for an organization.

OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + +```sql +SELECT +id, +name, +network_configuration_id, +subnet_id, +region +FROM github.hosted_compute.org_network_settings +WHERE org = '{{ org }}' -- required +AND network_settings_id = '{{ network_settings_id }}' -- required +; +``` + + diff --git a/website/docs/services/interactions/index.md b/website/docs/services/interactions/index.md index b4abdc9..6e40002 100644 --- a/website/docs/services/interactions/index.md +++ b/website/docs/services/interactions/index.md @@ -9,41 +9,26 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Owner Or Admin Management Of Users Interactions. - -:::info Service Summary +interactions service documentation. -
-
-total resources: 3
-total selectable resources: 3
-total methods: 9
-
-
+:::info[Service Summary] -::: +total resources: __3__ -## Overview - - - - - - -
Namegithub.interactions
TypeService
TitleGitHub V3 REST API - Interactions
DescriptionOwner Or Admin Management Of Users Interactions.
Idinteractions:v24.04.00227
+::: ## Resources
orgs
-repos
+repos
-user
-
+user
+ \ No newline at end of file diff --git a/website/docs/services/interactions/orgs/index.md b/website/docs/services/interactions/orgs/index.md index d076975..3d527a8 100644 --- a/website/docs/services/interactions/orgs/index.md +++ b/website/docs/services/interactions/orgs/index.md @@ -1,41 +1,206 @@ ---- +--- title: orgs hide_title: false hide_table_of_contents: false keywords: - orgs - interactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an orgs resource. ## Overview - +
Nameorgs
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time) (example: 2018-08-17T04:18:39Z)
stringThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. (existing_users, contributors_only, collaborators_only) (example: collaborators_only)
string (example: repository)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. | -| | `DELETE` | | Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. | -| | `EXEC` | | Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgShows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
org, limitTemporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
orgRemoves all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. + +```sql +SELECT +expires_at, +limit, +origin +FROM github.interactions.orgs +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. + +```sql +REPLACE github.interactions.orgs +SET +limit = '{{ limit }}', +expiry = '{{ expiry }}' +WHERE +org = '{{ org }}' --required +AND limit = '{{ limit }}' --required +RETURNING +expires_at, +limit, +origin; +``` + + + + +## `DELETE` examples + + + + +Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. + +```sql +DELETE FROM github.interactions.orgs +WHERE org = '{{ org }}' --required +; +``` + + diff --git a/website/docs/services/interactions/repos/index.md b/website/docs/services/interactions/repos/index.md index 241d711..1262c17 100644 --- a/website/docs/services/interactions/repos/index.md +++ b/website/docs/services/interactions/repos/index.md @@ -1,41 +1,214 @@ ---- +--- title: repos hide_title: false hide_table_of_contents: false keywords: - repos - interactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos resource. ## Overview - +
Namerepos
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time) (example: 2018-08-17T04:18:39Z)
stringThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. (existing_users, contributors_only, collaborators_only) (example: collaborators_only)
string (example: repository)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. | -| | `DELETE` | | Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. | -| | `EXEC` | | Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoShows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.
owner, repo, limitTemporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
owner, repoRemoves all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. + +```sql +SELECT +expires_at, +limit, +origin +FROM github.interactions.repos +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + +```sql +REPLACE github.interactions.repos +SET +limit = '{{ limit }}', +expiry = '{{ expiry }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND limit = '{{ limit }}' --required +RETURNING +expires_at, +limit, +origin; +``` + + + + +## `DELETE` examples + + + + +Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. + +```sql +DELETE FROM github.interactions.repos +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/interactions/user/index.md b/website/docs/services/interactions/user/index.md index e3bff88..db8e7eb 100644 --- a/website/docs/services/interactions/user/index.md +++ b/website/docs/services/interactions/user/index.md @@ -1,41 +1,198 @@ ---- +--- title: user hide_title: false hide_table_of_contents: false keywords: - user - interactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a user resource. ## Overview - +
Nameuser
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Default response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (date-time) (example: 2018-08-17T04:18:39Z)
stringThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. (existing_users, contributors_only, collaborators_only) (example: collaborators_only)
string (example: repository)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows which type of GitHub user can interact with your public repositories and when the restriction expires. | -| | `DELETE` | | Removes any interaction restrictions from your public repositories. | -| | `EXEC` | | Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
limitTemporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
Removes any interaction restrictions from your public repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Shows which type of GitHub user can interact with your public repositories and when the restriction expires. + +```sql +SELECT +expires_at, +limit, +origin +FROM github.interactions.user +; +``` + + + + +## `REPLACE` examples + + + + +Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. + +```sql +REPLACE github.interactions.user +SET +limit = '{{ limit }}', +expiry = '{{ expiry }}' +WHERE +limit = '{{ limit }}' --required +RETURNING +expires_at, +limit, +origin; +``` + + + + +## `DELETE` examples + + + + +Removes any interaction restrictions from your public repositories. + +```sql +DELETE FROM github.interactions.user +; +``` + + diff --git a/website/docs/services/issues/assignees/index.md b/website/docs/services/issues/assignees/index.md index 7288af1..89929b3 100644 --- a/website/docs/services/issues/assignees/index.md +++ b/website/docs/services/issues/assignees/index.md @@ -1,61 +1,466 @@ ---- +--- title: assignees hide_title: false hide_table_of_contents: false keywords: - assignees - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an assignees resource. ## Overview - +
Nameassignees
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. | -| | `INSERT` | | Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. | -| | `DELETE` | | Removes one or more assignees from an issue. | -| | `EXEC` | | Checks if a user has permission to be assigned to an issue in this repository.

If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.

Otherwise a `404` status code is returned. | -| | `EXEC` | | Checks if a user has permission to be assigned to a specific issue.

If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.

Otherwise a `404` status code is returned. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.
owner, repo, issue_numberAdds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
owner, repo, issue_numberRemoves one or more assignees from an issue.
owner, repo, assigneeChecks if a user has permission to be assigned to an issue in this repository.

If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.

Otherwise a `404` status code is returned.
owner, repo, issue_number, assigneeChecks if a user has permission to be assigned to a specific issue.

If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.

Otherwise a `404` status code is returned.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.issues.assignees +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. + +```sql +INSERT INTO github.issues.assignees ( +assignees, +owner, +repo, +issue_number +) +SELECT +'{{ assignees }}', +'{{ owner }}', +'{{ repo }}', +'{{ issue_number }}' +RETURNING +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: assignees + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the assignees resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the assignees resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the assignees resource. + - name: assignees + value: + - "{{ assignees }}" + description: | + Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ +`} + + + + + +## `DELETE` examples + + + + +Removes one or more assignees from an issue. + +```sql +DELETE FROM github.issues.assignees +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Checks if a user has permission to be assigned to an issue in this repository.

If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.

Otherwise a `404` status code is returned. + +```sql +EXEC github.issues.assignees.check_user_can_be_assigned +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@assignee='{{ assignee }}' --required +; +``` + + + +Checks if a user has permission to be assigned to a specific issue.

If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.

Otherwise a `404` status code is returned. + +```sql +EXEC github.issues.assignees.check_user_can_be_assigned_to_issue +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@issue_number='{{ issue_number }}' --required, +@assignee='{{ assignee }}' --required +; +``` + + diff --git a/website/docs/services/issues/comments/index.md b/website/docs/services/issues/comments/index.md index caf9382..5c56b44 100644 --- a/website/docs/services/issues/comments/index.md +++ b/website/docs/services/issues/comments/index.md @@ -1,55 +1,673 @@ ---- +--- title: comments hide_title: false hide_table_of_contents: false keywords: - comments - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a comments resource. ## Overview - +
Namecomments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the issue comment | -| | `string` | How the author is associated with the repository. | -| | `string` | Contents of the issue comment | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `object` | | -| | `string` | | -| | `string` | URL for the issue comment | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the issue comment
string
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue comment (example: What version of Safari were you using when you observed this bug?)
string
string
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri)
string (uri)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectContext around who pinned an issue comment and when it was pinned. (title: Pinned Issue Comment)
object (title: Reaction Rollup)
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri)URL for the issue comment (example: https://api.github.com/repositories/42/issues/comments/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the issue comment
string
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue comment (example: What version of Safari were you using when you observed this bug?)
string
string
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri)
string (uri)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectContext around who pinned an issue comment and when it was pinned. (title: Pinned Issue Comment)
object (title: Reaction Rollup)
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri)URL for the issue comment (example: https://api.github.com/repositories/42/issues/comments/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the issue comment
string
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue comment (example: What version of Safari were you using when you observed this bug?)
string
string
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri)
string (uri)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectContext around who pinned an issue comment and when it was pinned. (title: Pinned Issue Comment)
object (title: Reaction Rollup)
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri)URL for the issue comment (example: https://api.github.com/repositories/42/issues/comments/1)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. | -| | `SELECT` | | You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Issue comments are ordered by ascending ID. | -| | `SELECT` | | You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

By default, issue comments are ordered by ascending ID. | -| | `INSERT` | |
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
Creating content too quickly using this endpoint may result in secondary rate limiting.
See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)"
and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)"
for details. | -| | `DELETE` | | You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. | -| | `EXEC` | | You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idYou can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_numbersince, per_page, pageYou can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, reposort, direction, since, per_page, pageYou can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

By default, issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_number, bodyYou can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_id, bodyYou can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_idYou can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringEither `asc` or `desc`. Ignored without the `sort` parameter.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe property to sort the results by.
+ +## `SELECT` examples + + + + +You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +author_association, +body, +body_html, +body_text, +created_at, +html_url, +issue_url, +performed_via_github_app, +pin, +reactions, +updated_at, +url, +user +FROM github.issues.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND comment_id = '{{ comment_id }}' -- required +; +``` + + + +You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

Issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +author_association, +body, +body_html, +body_text, +created_at, +html_url, +issue_url, +performed_via_github_app, +pin, +reactions, +updated_at, +url, +user +FROM github.issues.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

By default, issue comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +author_association, +body, +body_html, +body_text, +created_at, +html_url, +issue_url, +performed_via_github_app, +pin, +reactions, +updated_at, +url, +user +FROM github.issues.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.issues.comments ( +body, +owner, +repo, +issue_number +) +SELECT +'{{ body }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ issue_number }}' +RETURNING +id, +node_id, +author_association, +body, +body_html, +body_text, +created_at, +html_url, +issue_url, +performed_via_github_app, +pin, +reactions, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the comments resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the comments resource. + - name: body + value: "{{ body }}" + description: | + The contents of the comment. +`} + + + + + +## `UPDATE` examples + + + + +You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +UPDATE github.issues.comments +SET +body = '{{ body }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +AND body = '{{ body }}' --required +RETURNING +id, +node_id, +author_association, +body, +body_html, +body_text, +created_at, +html_url, +issue_url, +performed_via_github_app, +pin, +reactions, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + +```sql +DELETE FROM github.issues.comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +; +``` + + diff --git a/website/docs/services/issues/events/index.md b/website/docs/services/issues/events/index.md index ee39200..dd5ad8e 100644 --- a/website/docs/services/issues/events/index.md +++ b/website/docs/services/issues/events/index.md @@ -1,60 +1,614 @@ ---- +--- title: events hide_title: false hide_table_of_contents: false keywords: - events - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an events resource. ## Overview - +
Nameevents
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | A GitHub user. | -| | `object` | A GitHub user. | -| | `string` | How the author is associated with the repository. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `object` | Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. | -| | `object` | Issue Event Label | -| | `string` | | -| | `object` | Issue Event Milestone | -| | `string` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `object` | Issue Event Project Card | -| | `object` | Issue Event Rename | -| | `object` | A GitHub user. | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `object` | A GitHub user. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
string (example: MDEwOklzc3VlRXZlbnQx)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
string (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e)
string (date-time) (example: 2011-04-14T16:00:49Z)
object (title: Issue Event Dismissed Review)
string (example: closed)
objectIssues are a great way to keep track of tasks, enhancements, and bugs for your projects. (title: Issue)
objectIssue Event Label (title: Issue Event Label)
string
objectIssue Event Milestone (title: Issue Event Milestone)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectIssue Event Project Card (title: Issue Event Project Card)
objectIssue Event Rename (title: Issue Event Rename)
objectA GitHub user. (title: Simple User)
objectGroups of organization members that gives permissions on specified repositories. (title: Team)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/events/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
string
string
object
string
object
string (example: "off-topic")
object
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
object
object
objectA GitHub user. (title: Simple User)
objectGroups of organization members that gives permissions on specified repositories. (title: Team)
objectA GitHub user. (title: Simple User)
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
string (example: MDEwOklzc3VlRXZlbnQx)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
string (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e)
string (date-time) (example: 2011-04-14T16:00:49Z)
object (title: Issue Event Dismissed Review)
string (example: closed)
objectIssues are a great way to keep track of tasks, enhancements, and bugs for your projects. (title: Issue)
objectIssue Event Label (title: Issue Event Label)
string
objectIssue Event Milestone (title: Issue Event Milestone)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectIssue Event Project Card (title: Issue Event Project Card)
objectIssue Event Rename (title: Issue Event Rename)
objectA GitHub user. (title: Simple User)
objectGroups of organization members that gives permissions on specified repositories. (title: Team)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/events/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single event by the event id. | -| | `SELECT` | | Lists all events for an issue. | -| | `SELECT` | | Lists events for a repository. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, event_idGets a single event by the event id.
owner, repo, issue_numberper_page, pageLists all events for an issue.
owner, repoper_page, pageLists events for a repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a single event by the event id. + +```sql +SELECT +id, +commit_id, +node_id, +actor, +assignee, +assigner, +author_association, +commit_url, +created_at, +dismissed_review, +event, +issue, +label, +lock_reason, +milestone, +performed_via_github_app, +project_card, +rename, +requested_reviewer, +requested_team, +review_requester, +url +FROM github.issues.events +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND event_id = '{{ event_id }}' -- required +; +``` + + + +Lists all events for an issue. + +```sql +SELECT +id, +commit_id, +node_id, +actor, +assignee, +assigner, +commit_url, +created_at, +dismissed_review, +event, +label, +lock_reason, +milestone, +performed_via_github_app, +project_card, +rename, +requested_reviewer, +requested_team, +review_requester, +url +FROM github.issues.events +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists events for a repository. + +```sql +SELECT +id, +commit_id, +node_id, +actor, +assignee, +assigner, +author_association, +commit_url, +created_at, +dismissed_review, +event, +issue, +label, +lock_reason, +milestone, +performed_via_github_app, +project_card, +rename, +requested_reviewer, +requested_team, +review_requester, +url +FROM github.issues.events +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/issues/index.md b/website/docs/services/issues/index.md index 8b45940..daf2ef5 100644 --- a/website/docs/services/issues/index.md +++ b/website/docs/services/issues/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With GitHub Issues. - -:::info Service Summary +issues service documentation. -
-
-total resources: 8
-total selectable resources: 8
-total methods: 40
-
-
+:::info[Service Summary] -::: +total resources: __14__ -## Overview - - - - - - -
Namegithub.issues
TypeService
TitleGitHub V3 REST API - Issues
DescriptionInteract With GitHub Issues.
Idissues:v24.04.00227
+::: ## Resources
@@ -43,12 +28,18 @@ Interact With GitHub Issues. assignees
comments
events
-issues
+issue_blocked_by_dependencies
+issue_blocking_dependencies
+issue_comment_pins
+issue_field_values
+issue_parent
+issue_sub_issues
+issues
labels
milestones
timeline
-user_issues
-
+user_issues + \ No newline at end of file diff --git a/website/docs/services/issues/issue_blocked_by_dependencies/index.md b/website/docs/services/issues/issue_blocked_by_dependencies/index.md new file mode 100644 index 0000000..d5e1de1 --- /dev/null +++ b/website/docs/services/issues/issue_blocked_by_dependencies/index.md @@ -0,0 +1,524 @@ +--- +title: issue_blocked_by_dependencies +hide_title: false +hide_table_of_contents: false +keywords: + - issue_blocked_by_dependencies + - issues + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_blocked_by_dependencies resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberper_page, pageYou can use the REST API to list the dependencies an issue is blocked by.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_number, issue_idYou can use the REST API to add a 'blocked by' relationship to an issue.

Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_number, issue_idYou can use the REST API to remove a dependency that an issue is blocked by.

Removing content too quickly using this endpoint may result in secondary rate limiting.
For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe id of the blocking issue to remove as a dependency
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +You can use the REST API to list the dependencies an issue is blocked by.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issue_blocked_by_dependencies +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +You can use the REST API to add a 'blocked by' relationship to an issue.

Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.issues.issue_blocked_by_dependencies ( +issue_id, +owner, +repo, +issue_number +) +SELECT +{{ issue_id }} /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ issue_number }}' +RETURNING +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: issue_blocked_by_dependencies + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the issue_blocked_by_dependencies resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the issue_blocked_by_dependencies resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the issue_blocked_by_dependencies resource. + - name: issue_id + value: {{ issue_id }} + description: | + The id of the issue that blocks the current issue +`} + + + + + +## `DELETE` examples + + + + +You can use the REST API to remove a dependency that an issue is blocked by.

Removing content too quickly using this endpoint may result in secondary rate limiting.
For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)
and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +DELETE FROM github.issues.issue_blocked_by_dependencies +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +AND issue_id = '{{ issue_id }}' --required +; +``` + + diff --git a/website/docs/services/issues/issue_blocking_dependencies/index.md b/website/docs/services/issues/issue_blocking_dependencies/index.md new file mode 100644 index 0000000..8de0ccb --- /dev/null +++ b/website/docs/services/issues/issue_blocking_dependencies/index.md @@ -0,0 +1,388 @@ +--- +title: issue_blocking_dependencies +hide_title: false +hide_table_of_contents: false +keywords: + - issue_blocking_dependencies + - issues + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_blocking_dependencies resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberper_page, pageYou can use the REST API to list the dependencies an issue is blocking.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +You can use the REST API to list the dependencies an issue is blocking.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issue_blocking_dependencies +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/issues/issue_comment_pins/index.md b/website/docs/services/issues/issue_comment_pins/index.md new file mode 100644 index 0000000..6f3799c --- /dev/null +++ b/website/docs/services/issues/issue_comment_pins/index.md @@ -0,0 +1,162 @@ +--- +title: issue_comment_pins +hide_title: false +hide_table_of_contents: false +keywords: + - issue_comment_pins + - issues + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_comment_pins resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idYou can use the REST API to pin comments on issues.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_idYou can use the REST API to unpin comments on issues.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `REPLACE` examples + + + + +You can use the REST API to pin comments on issues.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +REPLACE github.issues.issue_comment_pins +SET +-- No updatable properties +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +RETURNING +id, +node_id, +author_association, +body, +body_html, +body_text, +created_at, +html_url, +issue_url, +performed_via_github_app, +pin, +reactions, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +You can use the REST API to unpin comments on issues. + +```sql +DELETE FROM github.issues.issue_comment_pins +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +; +``` + + diff --git a/website/docs/services/issues/issue_field_values/index.md b/website/docs/services/issues/issue_field_values/index.md new file mode 100644 index 0000000..0eff8c5 --- /dev/null +++ b/website/docs/services/issues/issue_field_values/index.md @@ -0,0 +1,317 @@ +--- +title: issue_field_values +hide_title: false +hide_table_of_contents: false +keywords: + - issue_field_values + - issues + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_field_values resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier for the issue field.
string (example: IFT_GDKND)
stringThe data type of the issue field (text, single_select, number, date) (example: text)
objectDetails about the selected option (only present for single_select fields)
stringThe value of the issue field (example: Sample text)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberper_page, pageLists all issue field values for an issue.
repository_id, issue_numberAdd custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.
Adding an empty array will clear all existing field values for the issue.

This endpoint supports the following field data types:
- **`text`**: String values for text fields
- **`single_select`**: Option names for single-select fields (must match an existing option name)
- **`number`**: Numeric values for number fields
- **`date`**: ISO 8601 date strings for date fields

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
repository_id, issue_numberSet custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

This endpoint supports the following field data types:
- **`text`**: String values for text fields
- **`single_select`**: Option names for single-select fields (must match an existing option name)
- **`number`**: Numeric values for number fields
- **`date`**: ISO 8601 date strings for date fields

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
repository_id, issue_number, issue_field_idRemove a specific custom field value from an issue.

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.

If the specified field does not have a value set on the issue, this operation will return a `404` error.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the issue field.
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the repository.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all issue field values for an issue. + +```sql +SELECT +issue_field_id, +node_id, +data_type, +single_select_option, +value +FROM github.issues.issue_field_values +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.
Adding an empty array will clear all existing field values for the issue.

This endpoint supports the following field data types:
- **`text`**: String values for text fields
- **`single_select`**: Option names for single-select fields (must match an existing option name)
- **`number`**: Numeric values for number fields
- **`date`**: ISO 8601 date strings for date fields

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +INSERT INTO github.issues.issue_field_values ( +issue_field_values, +repository_id, +issue_number +) +SELECT +'{{ issue_field_values }}', +'{{ repository_id }}', +'{{ issue_number }}' +RETURNING +issue_field_id, +node_id, +data_type, +single_select_option, +value +; +``` + + + +{`# Description fields are for documentation purposes +- name: issue_field_values + props: + - name: repository_id + value: {{ repository_id }} + description: Required parameter for the issue_field_values resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the issue_field_values resource. + - name: issue_field_values + description: | + An array of issue field values to add to this issue. Each field value must include the field ID and the value to set. + value: + - field_id: {{ field_id }} + value: "{{ value }}" +`} + + + + + +## `REPLACE` examples + + + + +Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

This endpoint supports the following field data types:
- **`text`**: String values for text fields
- **`single_select`**: Option names for single-select fields (must match an existing option name)
- **`number`**: Numeric values for number fields
- **`date`**: ISO 8601 date strings for date fields

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the `POST` endpoint instead.

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +REPLACE github.issues.issue_field_values +SET +issue_field_values = '{{ issue_field_values }}' +WHERE +repository_id = '{{ repository_id }}' --required +AND issue_number = '{{ issue_number }}' --required +RETURNING +issue_field_id, +node_id, +data_type, +single_select_option, +value; +``` + + + + +## `DELETE` examples + + + + +Remove a specific custom field value from an issue.

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a `403 Forbidden` response.

If the specified field does not have a value set on the issue, this operation will return a `404` error.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +DELETE FROM github.issues.issue_field_values +WHERE repository_id = '{{ repository_id }}' --required +AND issue_number = '{{ issue_number }}' --required +AND issue_field_id = '{{ issue_field_id }}' --required +; +``` + + diff --git a/website/docs/services/issues/issue_parent/index.md b/website/docs/services/issues/issue_parent/index.md new file mode 100644 index 0000000..0e754b1 --- /dev/null +++ b/website/docs/services/issues/issue_parent/index.md @@ -0,0 +1,376 @@ +--- +title: issue_parent +hide_title: false +hide_table_of_contents: false +keywords: + - issue_parent + - issues + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_parent resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberYou can use the REST API to get the parent issue of a sub-issue.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +You can use the REST API to get the parent issue of a sub-issue.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issue_parent +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +; +``` + + diff --git a/website/docs/services/issues/issue_sub_issues/index.md b/website/docs/services/issues/issue_sub_issues/index.md new file mode 100644 index 0000000..37b2651 --- /dev/null +++ b/website/docs/services/issues/issue_sub_issues/index.md @@ -0,0 +1,600 @@ +--- +title: issue_sub_issues +hide_title: false +hide_table_of_contents: false +keywords: + - issue_sub_issues + - issues + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_sub_issues resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberper_page, pageYou can use the REST API to list the sub-issues on an issue.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_number, sub_issue_idYou can use the REST API to add sub-issues to issues.

Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_number, sub_issue_idYou can use the REST API to reprioritize a sub-issue to a different position in the parent list.
owner, repo, issue_numberYou can use the REST API to remove a sub-issue from an issue.
Removing content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +You can use the REST API to list the sub-issues on an issue.

This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).

- **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issue_sub_issues +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +You can use the REST API to add sub-issues to issues.

Creating content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.issues.issue_sub_issues ( +sub_issue_id, +replace_parent, +owner, +repo, +issue_number +) +SELECT +{{ sub_issue_id }} /* required */, +{{ replace_parent }}, +'{{ owner }}', +'{{ repo }}', +'{{ issue_number }}' +RETURNING +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: issue_sub_issues + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the issue_sub_issues resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the issue_sub_issues resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the issue_sub_issues resource. + - name: sub_issue_id + value: {{ sub_issue_id }} + description: | + The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue + - name: replace_parent + value: {{ replace_parent }} + description: | + Option that, when true, instructs the operation to replace the sub-issues current parent issue +`} + + + + + +## `UPDATE` examples + + + + +You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + +```sql +UPDATE github.issues.issue_sub_issues +SET +sub_issue_id = {{ sub_issue_id }}, +after_id = {{ after_id }}, +before_id = {{ before_id }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +AND sub_issue_id = '{{ sub_issue_id }}' --required +RETURNING +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +You can use the REST API to remove a sub-issue from an issue.
Removing content too quickly using this endpoint may result in secondary rate limiting.
For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass a specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +DELETE FROM github.issues.issue_sub_issues +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +; +``` + + diff --git a/website/docs/services/issues/issues/index.md b/website/docs/services/issues/issues/index.md index 4b361ba..4e56dc9 100644 --- a/website/docs/services/issues/issues/index.md +++ b/website/docs/services/issues/issues/index.md @@ -1,77 +1,1595 @@ ---- +--- title: issues hide_title: false hide_table_of_contents: false keywords: - issues - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an issues resource. ## Overview - +
Nameissues
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | How the author is associated with the repository. | -| | `string` | Contents of the issue | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `array` | Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository | -| | `string` | | -| | `boolean` | | -| | `object` | A collection of related issues and pull requests. | -| | `string` | | -| | `integer` | Number uniquely identifying the issue within its repository | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `object` | | -| | `object` | | -| | `object` | A repository on GitHub. | -| | `string` | | -| | `string` | State of the issue; either 'open' or 'closed' | -| | `string` | The reason for the current state | -| | `string` | | -| | `string` | Title of the issue | -| | `string` | | -| | `string` | URL for the issue | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was
[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.

**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. | -| | `SELECT` | | List issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
necessarily assigned to you.


**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. | -| | `SELECT` | | List issues in an organization assigned to the authenticated user.

**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. | -| | `SELECT` | | List issues in a repository. Only open issues will be listed.

**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. | -| | `INSERT` | | Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `EXEC` | | Users with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." | -| | `EXEC` | | Users with push access can unlock an issue's conversation. | -| | `EXEC` | | Issue owners and users with push access can edit an issue. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberThe API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repomilestone, state, assignee, type, creator, mentioned, labels, sort, direction, since, per_page, pageList issues in a repository. Only open issues will be listed.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
orgfilter, state, labels, type, sort, direction, since, per_page, pageList issues in an organization assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
filter, state, labels, sort, direction, since, collab, orgs, owned, pulls, per_page, pageList issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
necessarily assigned to you.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, titleAny user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_numberIssue owners and users with push access or Triage role can edit an issue.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, issue_numberUsers with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
owner, repo, issue_numberUsers with push access can unlock an issue's conversation.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the issue.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringCan be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.
boolean
stringThe user that created the issue.
stringThe direction to sort the results by.
stringIndicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.
stringA list of comma separated label names. Example: `bug,ui,@high`
stringA user that's mentioned in the issue.
stringIf an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.
boolean
boolean
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
boolean
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringWhat to sort results by.
stringIndicates the state of the issues to return.
stringCan be the name of an issue type.
+ +## `SELECT` examples + + + + +The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was
[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issues +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +; +``` + + + +List issues in a repository. Only open issues will be listed.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issues +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND milestone = '{{ milestone }}' +AND state = '{{ state }}' +AND assignee = '{{ assignee }}' +AND type = '{{ type }}' +AND creator = '{{ creator }}' +AND mentioned = '{{ mentioned }}' +AND labels = '{{ labels }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +List issues in an organization assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issues +WHERE org = '{{ org }}' -- required +AND filter = '{{ filter }}' +AND state = '{{ state }}' +AND labels = '{{ labels }}' +AND type = '{{ type }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +List issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
necessarily assigned to you.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.issues +WHERE filter = '{{ filter }}' +AND state = '{{ state }}' +AND labels = '{{ labels }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND collab = '{{ collab }}' +AND orgs = '{{ orgs }}' +AND owned = '{{ owned }}' +AND pulls = '{{ pulls }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.issues.issues ( +title, +body, +assignee, +milestone, +labels, +assignees, +type, +owner, +repo +) +SELECT +'{{ title }}' /* required */, +'{{ body }}', +'{{ assignee }}', +'{{ milestone }}', +'{{ labels }}', +'{{ assignees }}', +'{{ type }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: issues + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the issues resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the issues resource. + - name: title + value: "{{ title }}" + description: | + The title of the issue. + - name: body + value: "{{ body }}" + description: | + The contents of the issue. + - name: assignee + value: "{{ assignee }}" + description: | + Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ + - name: milestone + value: "{{ milestone }}" + description: | + The \`number\` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._ + - name: labels + value: "{{ labels }}" + description: | + Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ + - name: assignees + value: + - "{{ assignees }}" + description: | + Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ + - name: type + value: "{{ type }}" + description: | + The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ +`} + + + + + +## `UPDATE` examples + + + + +Issue owners and users with push access or Triage role can edit an issue.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +UPDATE github.issues.issues +SET +title = '{{ title }}', +body = '{{ body }}', +assignee = '{{ assignee }}', +state = '{{ state }}', +state_reason = '{{ state_reason }}', +milestone = '{{ milestone }}', +labels = '{{ labels }}', +assignees = '{{ assignees }}', +issue_field_values = '{{ issue_field_values }}', +type = '{{ type }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +RETURNING +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user; +``` + + + + +## Lifecycle Methods + + + + +Users with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + +```sql +EXEC github.issues.issues.lock +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@issue_number='{{ issue_number }}' --required +@@json= +'{ +"lock_reason": "{{ lock_reason }}" +}' +; +``` + + + +Users with push access can unlock an issue's conversation. + +```sql +EXEC github.issues.issues.unlock +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@issue_number='{{ issue_number }}' --required +; +``` + + diff --git a/website/docs/services/issues/labels/index.md b/website/docs/services/issues/labels/index.md index d25e21a..8a9669f 100644 --- a/website/docs/services/issues/labels/index.md +++ b/website/docs/services/issues/labels/index.md @@ -1,53 +1,713 @@ ---- +--- title: labels hide_title: false hide_table_of_contents: false keywords: - labels - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a labels resource. ## Overview - +
Namelabels
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The name of the label. | -| | `string` | | -| | `string` | 6-character hex code, without the leading #, identifying the color | -| | `boolean` | | -| | `string` | | -| | `string` | URL for the label | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier for the label.
stringThe name of the label. (example: bug)
string (example: MDU6TGFiZWwyMDgwNDU5NDY=)
string6-character hex code, without the leading #, identifying the color (example: FFFFFF)
booleanWhether this label comes by default in a new repository.
stringOptional description of the label, such as its purpose. (example: Something isn't working)
string (uri)URL for the label (example: https://api.github.com/repositories/42/labels/bug)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier for the label.
stringThe name of the label. (example: bug)
string (example: MDU6TGFiZWwyMDgwNDU5NDY=)
string6-character hex code, without the leading #, identifying the color (example: FFFFFF)
booleanWhether this label comes by default in a new repository.
stringOptional description of the label, such as its purpose. (example: Something isn't working)
string (uri)URL for the label (example: https://api.github.com/repositories/42/labels/bug)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier for the label.
stringThe name of the label. (example: bug)
string (example: MDU6TGFiZWwyMDgwNDU5NDY=)
string6-character hex code, without the leading #, identifying the color (example: FFFFFF)
booleanWhether this label comes by default in a new repository.
stringOptional description of the label, such as its purpose. (example: Something isn't working)
string (uri)URL for the label (example: https://api.github.com/repositories/42/labels/bug)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier for the label.
stringThe name of the label. (example: bug)
string (example: MDU6TGFiZWwyMDgwNDU5NDY=)
string6-character hex code, without the leading #, identifying the color (example: FFFFFF)
booleanWhether this label comes by default in a new repository.
stringOptional description of the label, such as its purpose. (example: Something isn't working)
string (uri)URL for the label (example: https://api.github.com/repositories/42/labels/bug)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a label using the given name. | -| | `SELECT` | | Lists labels for issues in a milestone. | -| | `SELECT` | | Lists all labels for a repository. | -| | `SELECT` | | Lists all labels for an issue. | -| | `INSERT` | | Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. | -| | `INSERT` | | Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). | -| | `DELETE` | | Deletes a label using the given label name. | -| | `DELETE` | | Removes all labels from an issue. | -| | `DELETE` | | Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. | -| | `EXEC` | | Removes any previous labels and sets the new labels for an issue. | -| | `EXEC` | | Updates a label using the given label name. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberper_page, pageLists all labels for an issue.
owner, repo, nameGets a label using the given name.
owner, repo, milestone_numberper_page, pageLists labels for issues in a milestone.
owner, repoper_page, pageLists all labels for a repository.
owner, repo, issue_numberAdds labels to an issue.
owner, repo, nameCreates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).
owner, repo, nameUpdates a label using the given label name.
owner, repo, issue_numberRemoves any previous labels and sets the new labels for an issue.
owner, repo, issue_number, nameRemoves the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.
owner, repo, issue_numberRemoves all labels from an issue.
owner, repo, nameDeletes a label using the given label name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the issue.
integerThe number that identifies the milestone.
string
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all labels for an issue. + +```sql +SELECT +id, +name, +node_id, +color, +default, +description, +url +FROM github.issues.labels +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Gets a label using the given name. + +```sql +SELECT +id, +name, +node_id, +color, +default, +description, +url +FROM github.issues.labels +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND name = '{{ name }}' -- required +; +``` + + + +Lists labels for issues in a milestone. + +```sql +SELECT +id, +name, +node_id, +color, +default, +description, +url +FROM github.issues.labels +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND milestone_number = '{{ milestone_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all labels for a repository. + +```sql +SELECT +id, +name, +node_id, +color, +default, +description, +url +FROM github.issues.labels +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds labels to an issue. + +```sql +INSERT INTO github.issues.labels ( +labels, +owner, +repo, +issue_number +) +SELECT +'{{ labels }}', +'{{ owner }}', +'{{ repo }}', +'{{ issue_number }}' +RETURNING +id, +name, +node_id, +color, +default, +description, +url +; +``` + + + +Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). + +```sql +INSERT INTO github.issues.labels ( +name, +color, +description, +owner, +repo +) +SELECT +'{{ name }}' /* required */, +'{{ color }}', +'{{ description }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +node_id, +color, +default, +description, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: labels + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the labels resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the labels resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the labels resource. + - name: labels + value: + - "{{ labels }}" + description: | + The names of the labels to add to the issue's existing labels. You can also pass an \`array\` of labels directly, but GitHub recommends passing an object with the \`labels\` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." + - name: name + value: "{{ name }}" + description: | + The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing \`:strawberry:\` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." + - name: color + value: "{{ color }}" + description: | + The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading \`#\`. + - name: description + value: "{{ description }}" + description: | + A short description of the label. Must be 100 characters or fewer. +`} + + + + + +## `UPDATE` examples + + + + +Updates a label using the given label name. + +```sql +UPDATE github.issues.labels +SET +new_name = '{{ new_name }}', +color = '{{ color }}', +description = '{{ description }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND name = '{{ name }}' --required +RETURNING +id, +name, +node_id, +color, +default, +description, +url; +``` + + + + +## `REPLACE` examples + + + + +Removes any previous labels and sets the new labels for an issue. + +```sql +REPLACE github.issues.labels +SET +labels = '{{ labels }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +RETURNING +id, +name, +node_id, +color, +default, +description, +url; +``` + + + + +## `DELETE` examples + + + + +Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. + +```sql +DELETE FROM github.issues.labels +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +AND name = '{{ name }}' --required +; +``` + + + +Removes all labels from an issue. + +```sql +DELETE FROM github.issues.labels +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +; +``` + + + +Deletes a label using the given label name. + +```sql +DELETE FROM github.issues.labels +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND name = '{{ name }}' --required +; +``` + + diff --git a/website/docs/services/issues/milestones/index.md b/website/docs/services/issues/milestones/index.md index 6adefe7..9941ce7 100644 --- a/website/docs/services/issues/milestones/index.md +++ b/website/docs/services/issues/milestones/index.md @@ -1,56 +1,568 @@ ---- +--- title: milestones hide_title: false hide_table_of_contents: false keywords: - milestones - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a milestones resource. ## Overview - +
Namemilestones
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | The number of the milestone. | -| | `integer` | | -| | `string` | The state of the milestone. | -| | `string` | The title of the milestone. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDk6TWlsZXN0b25lMTAwMjYwNA==)
string (date-time) (example: 2013-02-12T13:22:01Z)
integer
string (date-time) (example: 2011-04-10T20:09:31Z)
objectA GitHub user. (title: Simple User)
string (example: Tracking milestone for version 1.0)
string (date-time) (example: 2012-10-09T23:39:01Z)
string (uri) (example: https://github.com/octocat/Hello-World/milestones/v1.0)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels)
integerThe number of the milestone.
integer
stringThe state of the milestone. (open, closed) (example: open, default: open)
stringThe title of the milestone. (example: v1.0)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/milestones/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDk6TWlsZXN0b25lMTAwMjYwNA==)
string (date-time) (example: 2013-02-12T13:22:01Z)
integer
string (date-time) (example: 2011-04-10T20:09:31Z)
objectA GitHub user. (title: Simple User)
string (example: Tracking milestone for version 1.0)
string (date-time) (example: 2012-10-09T23:39:01Z)
string (uri) (example: https://github.com/octocat/Hello-World/milestones/v1.0)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels)
integerThe number of the milestone.
integer
stringThe state of the milestone. (open, closed) (example: open, default: open)
stringThe title of the milestone. (example: v1.0)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/milestones/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a milestone using the given milestone number. | -| | `SELECT` | | Lists milestones for a repository. | -| | `INSERT` | | Creates a milestone. | -| | `DELETE` | | Deletes a milestone using the given milestone number. | -| | `EXEC` | | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, milestone_numberGets a milestone using the given milestone number.
owner, repostate, sort, direction, per_page, pageLists milestones for a repository.
owner, repo, titleCreates a milestone.
owner, repo, milestone_number
owner, repo, milestone_numberDeletes a milestone using the given milestone number.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the milestone.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe direction of the sort. Either `asc` or `desc`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringWhat to sort results by. Either `due_on` or `completeness`.
stringThe state of the milestone. Either `open`, `closed`, or `all`.
+ +## `SELECT` examples + + + + +Gets a milestone using the given milestone number. + +```sql +SELECT +id, +node_id, +closed_at, +closed_issues, +created_at, +creator, +description, +due_on, +html_url, +labels_url, +number, +open_issues, +state, +title, +updated_at, +url +FROM github.issues.milestones +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND milestone_number = '{{ milestone_number }}' -- required +; +``` + + + +Lists milestones for a repository. + +```sql +SELECT +id, +node_id, +closed_at, +closed_issues, +created_at, +creator, +description, +due_on, +html_url, +labels_url, +number, +open_issues, +state, +title, +updated_at, +url +FROM github.issues.milestones +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND state = '{{ state }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a milestone. + +```sql +INSERT INTO github.issues.milestones ( +title, +state, +description, +due_on, +owner, +repo +) +SELECT +'{{ title }}' /* required */, +'{{ state }}', +'{{ description }}', +'{{ due_on }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +node_id, +closed_at, +closed_issues, +created_at, +creator, +description, +due_on, +html_url, +labels_url, +number, +open_issues, +state, +title, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: milestones + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the milestones resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the milestones resource. + - name: title + value: "{{ title }}" + description: | + The title of the milestone. + - name: state + value: "{{ state }}" + description: | + The state of the milestone. Either \`open\` or \`closed\`. + valid_values: ['open', 'closed'] + default: open + - name: description + value: "{{ description }}" + description: | + A description of the milestone. + - name: due_on + value: "{{ due_on }}" + description: | + The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: \`YYYY-MM-DDTHH:MM:SSZ\`. +`} + + + + + +## `UPDATE` examples + + + + +No description available. + +```sql +UPDATE github.issues.milestones +SET +title = '{{ title }}', +state = '{{ state }}', +description = '{{ description }}', +due_on = '{{ due_on }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND milestone_number = '{{ milestone_number }}' --required +RETURNING +id, +node_id, +closed_at, +closed_issues, +created_at, +creator, +description, +due_on, +html_url, +labels_url, +number, +open_issues, +state, +title, +updated_at, +url; +``` + + + + +## `DELETE` examples + + + + +Deletes a milestone using the given milestone number. + +```sql +DELETE FROM github.issues.milestones +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND milestone_number = '{{ milestone_number }}' --required +; +``` + + diff --git a/website/docs/services/issues/timeline/index.md b/website/docs/services/issues/timeline/index.md index 2a4c404..936a4e5 100644 --- a/website/docs/services/issues/timeline/index.md +++ b/website/docs/services/issues/timeline/index.md @@ -1,46 +1,406 @@ ---- +--- title: timeline hide_title: false hide_table_of_contents: false keywords: - timeline - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a timeline resource. ## Overview - +
Nametimeline
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
object
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
objectIdentifying information for the git-user
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue comment (example: What version of Safari were you using when you observed this bug?)
string
string
array
string
objectIdentifying information for the git-user
string
object
string
string (uri)
string (uri)
object
string (example: "off-topic")
stringMessage describing the purpose of the commit (example: Fix #42)
object
array
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectContext around who pinned an issue comment and when it was pinned. (title: Pinned Issue Comment)
object
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/12)
object (title: Reaction Rollup)
object
objectA GitHub user. (title: Simple User)
objectGroups of organization members that gives permissions on specified repositories. (title: Team)
objectA GitHub user. (title: Simple User)
stringSHA for the commit (example: 7638417db6d59f3c431d3e1f261cc637155684cd)
object
string (example: CHANGES_REQUESTED)
string
string (date-time)
object
string (date-time) (example: 2011-04-14T16:00:49Z)
string
objectA GitHub user. (title: Simple User)
object
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, issue_numberper_page, pageList all timeline events for an issue.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List all timeline events for an issue. + +```sql +SELECT +id, +commit_id, +node_id, +_links, +actor, +assignee, +author, +author_association, +body, +body_html, +body_text, +comments, +commit_url, +committer, +created_at, +dismissed_review, +event, +html_url, +issue_url, +label, +lock_reason, +message, +milestone, +parents, +performed_via_github_app, +pin, +project_card, +pull_request_url, +reactions, +rename, +requested_reviewer, +requested_team, +review_requester, +sha, +source, +state, +state_reason, +submitted_at, +tree, +updated_at, +url, +user, +verification +FROM github.issues.timeline +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/issues/user_issues/index.md b/website/docs/services/issues/user_issues/index.md index 1ad2d82..0c30d76 100644 --- a/website/docs/services/issues/user_issues/index.md +++ b/website/docs/services/issues/user_issues/index.md @@ -1,70 +1,406 @@ ---- +--- title: user_issues hide_title: false hide_table_of_contents: false keywords: - user_issues - issues - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a user_issues resource. ## Overview - +
Nameuser_issues
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | How the author is associated with the repository. | -| | `string` | Contents of the issue | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `array` | Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository | -| | `string` | | -| | `boolean` | | -| | `object` | A collection of related issues and pull requests. | -| | `string` | | -| | `integer` | Number uniquely identifying the issue within its repository | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `object` | | -| | `object` | | -| | `object` | A repository on GitHub. | -| | `string` | | -| | `string` | State of the issue; either 'open' or 'closed' | -| | `string` | The reason for the current state | -| | `string` | | -| | `string` | Title of the issue | -| | `string` | | -| | `string` | URL for the issue | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringContents of the issue (example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?)
string
string
string (date-time)
objectA GitHub user. (title: Simple User)
integer
string (uri)
string (date-time)
boolean
string (uri)
string (uri)
object (title: Issue Dependencies Summary)
array
arrayLabels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
string
boolean
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the issue within its repository
string (uri)URL to get the parent issue of this issue, if it is a sub-issue
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
objectComments provide a way for people to collaborate on an issue. (title: Issue Comment)
object
object (title: Reaction Rollup)
objectA repository on GitHub. (title: Repository)
string (uri)
stringState of the issue; either 'open' or 'closed' (example: open)
stringThe reason for the current state (completed, reopened, not_planned, duplicate) (example: not_planned)
object (title: Sub-issues Summary)
string (uri)
stringTitle of the issue (example: Widget creation fails in Safari on OS X 10.8)
objectThe type of issue. (title: Issue Type)
string (date-time)
string (uri)URL for the issue (example: https://api.github.com/repositories/42/issues/1)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
filter, state, labels, sort, direction, since, per_page, pageList issues across owned and member repositories assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe direction to sort the results by.
stringIndicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.
stringA list of comma separated label names. Example: `bug,ui,@high`
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringWhat to sort results by.
stringIndicates the state of the issues to return.
+ +## `SELECT` examples + + + + +List issues across owned and member repositories assigned to the authenticated user.

> [!NOTE]
> GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +active_lock_reason, +assignee, +assignees, +author_association, +body, +body_html, +body_text, +closed_at, +closed_by, +comments, +comments_url, +created_at, +draft, +events_url, +html_url, +issue_dependencies_summary, +issue_field_values, +labels, +labels_url, +locked, +milestone, +number, +parent_issue_url, +performed_via_github_app, +pinned_comment, +pull_request, +reactions, +repository, +repository_url, +state, +state_reason, +sub_issues_summary, +timeline_url, +title, +type, +updated_at, +url, +user +FROM github.issues.user_issues +WHERE filter = '{{ filter }}' +AND state = '{{ state }}' +AND labels = '{{ labels }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/licenses/index.md b/website/docs/services/licenses/index.md index 1b18a97..eabd1e2 100644 --- a/website/docs/services/licenses/index.md +++ b/website/docs/services/licenses/index.md @@ -9,39 +9,25 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -View Various OSS Licenses. - -:::info Service Summary +licenses service documentation. -
-
-total resources: 1
-total selectable resources: 1
-total methods: 3
-
-
+:::info[Service Summary] -::: +total resources: __1__ -## Overview - - - - - - -
Namegithub.licenses
TypeService
TitleGitHub V3 REST API - Licenses
DescriptionView Various OSS Licenses.
Idlicenses:v24.04.00227
+::: ## Resources
-licenses
+licenses
+
-
+ \ No newline at end of file diff --git a/website/docs/services/licenses/licenses/index.md b/website/docs/services/licenses/licenses/index.md index 94c24a6..408a3d4 100644 --- a/website/docs/services/licenses/licenses/index.md +++ b/website/docs/services/licenses/licenses/index.md @@ -1,51 +1,422 @@ ---- +--- title: licenses hide_title: false hide_table_of_contents: false keywords: - licenses - licenses - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a licenses resource. ## Overview - +
Namelicenses
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | License Simple | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string (uri)
string
string (uri)
string (uri)
objectLicense Simple (title: License Simple)
string
string
integer
string
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: MIT License)
string (example: MDc6TGljZW5zZW1pdA==)
string (example: MIT)
string (example:

The MIT License (MIT)

Copyright (c) [year] [fullname]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
)
array
string (example: A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.)
boolean
string (uri) (example: http://choosealicense.com/licenses/mit/)
string (example: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.)
string (example: mit)
array
array
string (uri) (example: https://api.github.com/licenses/mit)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: MIT License)
string (example: MDc6TGljZW5zZW1pdA==)
string (example: MIT)
string (uri)
string (example: mit)
string (uri) (example: https://api.github.com/licenses/mit)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." | -| | `SELECT` | | Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." | -| | `SELECT` | | This method returns the contents of the repository's license file, if one is detected.

Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, reporefThis method returns the contents of the repository's license file, if one is detected.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
licenseGets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
featured, per_page, pageLists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.
+ +## `SELECT` examples + + + + +This method returns the contents of the repository's license file, if one is detected.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw contents of the license.
- **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + +```sql +SELECT +name, +_links, +content, +download_url, +encoding, +git_url, +html_url, +license, +path, +sha, +size, +type, +url +FROM github.licenses.licenses +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' +; +``` + + + +Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + +```sql +SELECT +name, +node_id, +spdx_id, +body, +conditions, +description, +featured, +html_url, +implementation, +key, +limitations, +permissions, +url +FROM github.licenses.licenses +WHERE license = '{{ license }}' -- required +; +``` + + + +Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + +```sql +SELECT +name, +node_id, +spdx_id, +html_url, +key, +url +FROM github.licenses.licenses +WHERE featured = '{{ featured }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/markdown/index.md b/website/docs/services/markdown/index.md new file mode 100644 index 0000000..eba8b08 --- /dev/null +++ b/website/docs/services/markdown/index.md @@ -0,0 +1,33 @@ +--- +title: markdown +hide_title: false +hide_table_of_contents: false +keywords: + - markdown + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +markdown service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+rendered_markdown +
+
+rendered_markdown_raw +
+
\ No newline at end of file diff --git a/website/docs/services/markdown/rendered_markdown/index.md b/website/docs/services/markdown/rendered_markdown/index.md new file mode 100644 index 0000000..173a4fd --- /dev/null +++ b/website/docs/services/markdown/rendered_markdown/index.md @@ -0,0 +1,127 @@ +--- +title: rendered_markdown +hide_title: false +hide_table_of_contents: false +keywords: + - rendered_markdown + - markdown + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a rendered_markdown resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
textDepending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `INSERT` examples + + + + +Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + +```sql +INSERT INTO github.markdown.rendered_markdown ( +text, +mode, +context +) +SELECT +'{{ text }}' /* required */, +'{{ mode }}', +'{{ context }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: rendered_markdown + props: + - name: text + value: "{{ text }}" + description: | + The Markdown text to render in HTML. + - name: mode + value: "{{ mode }}" + description: | + The rendering mode. + valid_values: ['markdown', 'gfm'] + default: markdown + - name: context + value: "{{ context }}" + description: | + The repository context to use when creating references in \`gfm\` mode. For example, setting \`context\` to \`octo-org/octo-repo\` will change the text \`#42\` into an HTML link to issue 42 in the \`octo-org/octo-repo\` repository. +`} + + + diff --git a/website/docs/services/markdown/rendered_markdown_raw/index.md b/website/docs/services/markdown/rendered_markdown_raw/index.md new file mode 100644 index 0000000..25ed698 --- /dev/null +++ b/website/docs/services/markdown/rendered_markdown_raw/index.md @@ -0,0 +1,109 @@ +--- +title: rendered_markdown_raw +hide_title: false +hide_table_of_contents: false +keywords: + - rendered_markdown_raw + - markdown + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a rendered_markdown_raw resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `INSERT` examples + + + + +You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. + +```sql +INSERT INTO github.markdown.rendered_markdown_raw ( + +) +SELECT + +; +``` + + + +{`# Description fields are for documentation purposes +- name: rendered_markdown_raw + props: +`} + + + diff --git a/website/docs/services/meta/index.md b/website/docs/services/meta/index.md new file mode 100644 index 0000000..b6ec04a --- /dev/null +++ b/website/docs/services/meta/index.md @@ -0,0 +1,36 @@ +--- +title: meta +hide_title: false +hide_table_of_contents: false +keywords: + - meta + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +meta service documentation. + +:::info[Service Summary] + +total resources: __5__ + +::: + +## Resources +
+
+meta
+octocat
+root +
+
+versions
+zen +
+
\ No newline at end of file diff --git a/website/docs/services/meta/meta/index.md b/website/docs/services/meta/meta/index.md new file mode 100644 index 0000000..ca68e83 --- /dev/null +++ b/website/docs/services/meta/meta/index.md @@ -0,0 +1,220 @@ +--- +title: meta +hide_title: false +hide_table_of_contents: false +keywords: + - meta + - meta + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a meta resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
array
array
array
array
object
array
array
array
array
array
array
object
array
boolean
array
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."

The API's response also includes a list of GitHub's domain names.

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

> [!NOTE]
> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)."

The API's response also includes a list of GitHub's domain names.

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

> [!NOTE]
> This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + +```sql +SELECT +actions, +actions_macos, +api, +codespaces, +copilot, +dependabot, +domains, +git, +github_enterprise_importer, +hooks, +importer, +packages, +pages, +ssh_key_fingerprints, +ssh_keys, +verifiable_password_authentication, +web +FROM github.meta.meta +; +``` + + diff --git a/website/docs/services/meta/octocat/index.md b/website/docs/services/meta/octocat/index.md new file mode 100644 index 0000000..29f3663 --- /dev/null +++ b/website/docs/services/meta/octocat/index.md @@ -0,0 +1,102 @@ +--- +title: octocat +hide_title: false +hide_table_of_contents: false +keywords: + - octocat + - meta + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an octocat resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
sGet the octocat as ASCII art
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe words to show in Octocat's speech bubble
+ +## Lifecycle Methods + + + + +Get the octocat as ASCII art + +```sql +EXEC github.meta.octocat.get_octocat +@s='{{ s }}' +; +``` + + diff --git a/website/docs/services/meta/root/index.md b/website/docs/services/meta/root/index.md new file mode 100644 index 0000000..30c4262 --- /dev/null +++ b/website/docs/services/meta/root/index.md @@ -0,0 +1,316 @@ +--- +title: root +hide_title: false +hide_table_of_contents: false +keywords: + - root + - meta + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a root resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
string (uri-template)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get Hypermedia links to resources accessible in GitHub's REST API
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Get Hypermedia links to resources accessible in GitHub's REST API + +```sql +SELECT +authorizations_url, +code_search_url, +commit_search_url, +current_user_authorizations_html_url, +current_user_repositories_url, +current_user_url, +emails_url, +emojis_url, +events_url, +feeds_url, +followers_url, +following_url, +gists_url, +hub_url, +issue_search_url, +issues_url, +keys_url, +label_search_url, +notifications_url, +organization_repositories_url, +organization_teams_url, +organization_url, +public_gists_url, +rate_limit_url, +repository_search_url, +repository_url, +starred_gists_url, +starred_url, +topic_search_url, +user_organizations_url, +user_repositories_url, +user_search_url, +user_url +FROM github.meta.root +; +``` + + diff --git a/website/docs/services/meta/versions/index.md b/website/docs/services/meta/versions/index.md new file mode 100644 index 0000000..6adc03f --- /dev/null +++ b/website/docs/services/meta/versions/index.md @@ -0,0 +1,119 @@ +--- +title: versions +hide_title: false +hide_table_of_contents: false +keywords: + - versions + - meta + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a versions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + +
NameDatatypeDescription
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get all supported GitHub API versions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +Get all supported GitHub API versions. + +```sql +SELECT +* +FROM github.meta.versions +; +``` + + diff --git a/website/docs/services/meta/zen/index.md b/website/docs/services/meta/zen/index.md new file mode 100644 index 0000000..8cf068d --- /dev/null +++ b/website/docs/services/meta/zen/index.md @@ -0,0 +1,97 @@ +--- +title: zen +hide_title: false +hide_table_of_contents: false +keywords: + - zen + - meta + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a zen resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
Get a random sentence from the Zen of GitHub
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## Lifecycle Methods + + + + +Get a random sentence from the Zen of GitHub + +```sql +EXEC github.meta.zen.get_zen + +; +``` + + diff --git a/website/docs/services/migrations/commit_authors/index.md b/website/docs/services/migrations/commit_authors/index.md index d5ebdeb..98bcb42 100644 --- a/website/docs/services/migrations/commit_authors/index.md +++ b/website/docs/services/migrations/commit_authors/index.md @@ -1,44 +1,224 @@ ---- +--- title: commit_authors hide_title: false hide_table_of_contents: false keywords: - commit_authors - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commit_authors resource. ## Overview - +
Namecommit_authors
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
string
string
string (uri)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.

This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. | -| | `EXEC` | | Update an author's identity for the import. Your application can continue updating authors any time before you push
new commits to the repository.

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
| + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, reposinceEach type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.

This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
owner, repo, author_idUpdate an author's identity for the import. Your application can continue updating authors any time before you push
new commits to the repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerA user ID. Only return users with an ID greater than this ID.
+ +## `SELECT` examples + + + + +Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.

This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +SELECT +id, +name, +remote_id, +remote_name, +email, +import_url, +url +FROM github.migrations.commit_authors +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND since = '{{ since }}' +; +``` + + + + +## `UPDATE` examples + + + + +Update an author's identity for the import. Your application can continue updating authors any time before you push
new commits to the repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +UPDATE github.migrations.commit_authors +SET +email = '{{ email }}', +name = '{{ name }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND author_id = '{{ author_id }}' --required +RETURNING +id, +name, +remote_id, +remote_name, +email, +import_url, +url; +``` + + diff --git a/website/docs/services/migrations/index.md b/website/docs/services/migrations/index.md index 6e424d6..ad5c3bb 100644 --- a/website/docs/services/migrations/index.md +++ b/website/docs/services/migrations/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Move Projects To Or From GitHub. - -:::info Service Summary +migrations service documentation. -
-
-total resources: 7
-total selectable resources: 5
-total methods: 22
-
-
+:::info[Service Summary] -::: +total resources: __7__ -## Overview - - - - - - -
Namegithub.migrations
TypeService
TitleGitHub V3 REST API - Migrations
DescriptionMove Projects To Or From GitHub.
Idmigrations:v24.04.00227
+::: ## Resources
@@ -43,11 +28,11 @@ Move Projects To Or From GitHub. commit_authors
lfs
migrations
-orgs
+orgs
repos
source_imports
-users
-
+users + \ No newline at end of file diff --git a/website/docs/services/migrations/lfs/index.md b/website/docs/services/migrations/lfs/index.md index 75a0b39..3dfd5fb 100644 --- a/website/docs/services/migrations/lfs/index.md +++ b/website/docs/services/migrations/lfs/index.md @@ -1,41 +1,210 @@ ---- +--- title: lfs hide_title: false hide_table_of_contents: false keywords: - lfs - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a lfs resource. ## Overview - +
Namelfs
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `string` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
string
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List files larger than 100MB found during the import

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
| -| | `EXEC` | | You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
is powered by [Git LFS](https://git-lfs.com).

You can learn more about our LFS feature and working with large files [on our help
site](https://docs.github.com/repositories/working-with-files/managing-large-files).

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
| + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoList files larger than 100MB found during the import

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
owner, repo, use_lfsYou can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
is powered by [Git LFS](https://git-lfs.com).

You can learn more about our LFS feature and working with large files [on our help
site](https://docs.github.com/repositories/working-with-files/managing-large-files).

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +List files larger than 100MB found during the import

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +SELECT +ref_name, +oid, +path, +size +FROM github.migrations.lfs +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
is powered by [Git LFS](https://git-lfs.com).

You can learn more about our LFS feature and working with large files [on our help
site](https://docs.github.com/repositories/working-with-files/managing-large-files).

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +UPDATE github.migrations.lfs +SET +use_lfs = '{{ use_lfs }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND use_lfs = '{{ use_lfs }}' --required +RETURNING +authors_count, +authors_url, +commit_count, +error_message, +failed_step, +has_large_files, +html_url, +import_percent, +large_files_count, +large_files_size, +message, +project_choices, +push_percent, +repository_url, +status, +status_text, +svc_root, +svn_root, +tfvc_project, +url, +use_lfs, +vcs, +vcs_url; +``` + + diff --git a/website/docs/services/migrations/migrations/index.md b/website/docs/services/migrations/migrations/index.md index 35549c0..c83af07 100644 --- a/website/docs/services/migrations/migrations/index.md +++ b/website/docs/services/migrations/migrations/index.md @@ -1,59 +1,760 @@ ---- +--- title: migrations hide_title: false hide_table_of_contents: false keywords: - migrations - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a migrations resource. ## Overview - +
Namemigrations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `array` | Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `object` | A GitHub user. | -| | `array` | The repositories included in the migration. Only returned for export migrations. | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +* `pending`, which means the migration hasn't started yet.
* `exporting`, which means the migration is in progress.
* `exported`, which means the migration finished successfully.
* `failed`, which means the migration failed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (uri)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
arrayExclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.
boolean
boolean
boolean
boolean
boolean
string (example: 0b989ba4-242f-11e5-81e1-c7b6966d2516)
boolean
boolean
objectA GitHub user. (title: Simple User)
arrayThe repositories included in the migration. Only returned for export migrations.
string (example: pending)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
string (uri) (example: https://api.github.com/orgs/octo-org/migrations/79)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (uri)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
arrayExclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.
boolean
boolean
boolean
boolean
boolean
string (example: 0b989ba4-242f-11e5-81e1-c7b6966d2516)
boolean
boolean
objectA GitHub user. (title: Simple User)
arrayThe repositories included in the migration. Only returned for export migrations.
string (example: pending)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
string (uri) (example: https://api.github.com/orgs/octo-org/migrations/79)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (uri)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
arrayExclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.
boolean
boolean
boolean
boolean
boolean
string (example: 0b989ba4-242f-11e5-81e1-c7b6966d2516)
boolean
boolean
objectA GitHub user. (title: Simple User)
arrayThe repositories included in the migration. Only returned for export migrations.
string (example: pending)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
string (uri) (example: https://api.github.com/orgs/octo-org/migrations/79)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (uri)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
arrayExclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`.
boolean
boolean
boolean
boolean
boolean
string (example: 0b989ba4-242f-11e5-81e1-c7b6966d2516)
boolean
boolean
objectA GitHub user. (title: Simple User)
arrayThe repositories included in the migration. Only returned for export migrations.
string (example: pending)
string (date-time) (example: 2015-07-06T15:33:38-07:00)
string (uri) (example: https://api.github.com/orgs/octo-org/migrations/79)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:

* `pending` - the migration hasn't started yet.
* `exporting` - the migration is in progress.
* `exported` - the migration finished successfully.
* `failed` - the migration failed.

Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). | -| | `SELECT` | | Fetches the status of a migration.

The `state` of a migration can be one of the following values:

* `pending`, which means the migration hasn't started yet.
* `exporting`, which means the migration is in progress.
* `exported`, which means the migration finished successfully.
* `failed`, which means the migration failed. | -| | `SELECT` | | Lists all migrations a user has started. | -| | `SELECT` | | Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

A list of `repositories` is only returned for export migrations. | -| | `EXEC` | | Initiates the generation of a user migration archive. | -| | `EXEC` | | Initiates the generation of a migration archive. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, migration_idexcludeFetches the status of a migration.

The `state` of a migration can be one of the following values:

* `pending`, which means the migration hasn't started yet.
* `exporting`, which means the migration is in progress.
* `exported`, which means the migration finished successfully.
* `failed`, which means the migration failed.
orgper_page, page, excludeLists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

A list of `repositories` is only returned for export migrations.
migration_idexcludeFetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:

* `pending` - the migration hasn't started yet.
* `exporting` - the migration is in progress.
* `exported` - the migration finished successfully.
* `failed` - the migration failed.

Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive).
per_page, pageLists all migrations a user has started.
org, repositoriesInitiates the generation of a migration archive.
repositoriesInitiates the generation of a user migration archive.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the migration.
stringThe organization name. The name is not case sensitive.
array
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Fetches the status of a migration.

The `state` of a migration can be one of the following values:

* `pending`, which means the migration hasn't started yet.
* `exporting`, which means the migration is in progress.
* `exported`, which means the migration finished successfully.
* `failed`, which means the migration failed. + +```sql +SELECT +id, +node_id, +archive_url, +created_at, +exclude, +exclude_attachments, +exclude_git_data, +exclude_metadata, +exclude_owner_projects, +exclude_releases, +guid, +lock_repositories, +org_metadata_only, +owner, +repositories, +state, +updated_at, +url +FROM github.migrations.migrations +WHERE org = '{{ org }}' -- required +AND migration_id = '{{ migration_id }}' -- required +AND exclude = '{{ exclude }}' +; +``` + + + +Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).

A list of `repositories` is only returned for export migrations. + +```sql +SELECT +id, +node_id, +archive_url, +created_at, +exclude, +exclude_attachments, +exclude_git_data, +exclude_metadata, +exclude_owner_projects, +exclude_releases, +guid, +lock_repositories, +org_metadata_only, +owner, +repositories, +state, +updated_at, +url +FROM github.migrations.migrations +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND exclude = '{{ exclude }}' +; +``` + + + +Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:

* `pending` - the migration hasn't started yet.
* `exporting` - the migration is in progress.
* `exported` - the migration finished successfully.
* `failed` - the migration failed.

Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). + +```sql +SELECT +id, +node_id, +archive_url, +created_at, +exclude, +exclude_attachments, +exclude_git_data, +exclude_metadata, +exclude_owner_projects, +exclude_releases, +guid, +lock_repositories, +org_metadata_only, +owner, +repositories, +state, +updated_at, +url +FROM github.migrations.migrations +WHERE migration_id = '{{ migration_id }}' -- required +AND exclude = '{{ exclude }}' +; +``` + + + +Lists all migrations a user has started. + +```sql +SELECT +id, +node_id, +archive_url, +created_at, +exclude, +exclude_attachments, +exclude_git_data, +exclude_metadata, +exclude_owner_projects, +exclude_releases, +guid, +lock_repositories, +org_metadata_only, +owner, +repositories, +state, +updated_at, +url +FROM github.migrations.migrations +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## Lifecycle Methods + + + + +Initiates the generation of a migration archive. + +```sql +EXEC github.migrations.migrations.start_for_org +@org='{{ org }}' --required +@@json= +'{ +"repositories": "{{ repositories }}", +"lock_repositories": {{ lock_repositories }}, +"exclude_metadata": {{ exclude_metadata }}, +"exclude_git_data": {{ exclude_git_data }}, +"exclude_attachments": {{ exclude_attachments }}, +"exclude_releases": {{ exclude_releases }}, +"exclude_owner_projects": {{ exclude_owner_projects }}, +"org_metadata_only": {{ org_metadata_only }}, +"exclude": "{{ exclude }}" +}' +; +``` + + + +Initiates the generation of a user migration archive. + +```sql +EXEC github.migrations.migrations.start_for_authenticated_user +@@json= +'{ +"lock_repositories": {{ lock_repositories }}, +"exclude_metadata": {{ exclude_metadata }}, +"exclude_git_data": {{ exclude_git_data }}, +"exclude_attachments": {{ exclude_attachments }}, +"exclude_releases": {{ exclude_releases }}, +"exclude_owner_projects": {{ exclude_owner_projects }}, +"org_metadata_only": {{ org_metadata_only }}, +"exclude": "{{ exclude }}", +"repositories": "{{ repositories }}" +}' +; +``` + + diff --git a/website/docs/services/migrations/orgs/index.md b/website/docs/services/migrations/orgs/index.md index c5a9408..c20c41d 100644 --- a/website/docs/services/migrations/orgs/index.md +++ b/website/docs/services/migrations/orgs/index.md @@ -1,36 +1,108 @@ ---- +--- title: orgs hide_title: false hide_table_of_contents: false keywords: - orgs - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an orgs resource. ## Overview - +
Nameorgs
Name
TypeResource
Id
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | Deletes a previous migration archive. Migration archives are automatically deleted after seven days. | -| | `EXEC` | | Fetches the URL to a migration archive. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, migration_idDeletes a previous migration archive. Migration archives are automatically deleted after seven days.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the migration.
stringThe organization name. The name is not case sensitive.
+ +## `DELETE` examples + + + + +Deletes a previous migration archive. Migration archives are automatically deleted after seven days. + +```sql +DELETE FROM github.migrations.orgs +WHERE org = '{{ org }}' --required +AND migration_id = '{{ migration_id }}' --required +; +``` + + diff --git a/website/docs/services/migrations/repos/index.md b/website/docs/services/migrations/repos/index.md index 8f3b8f5..9c93621 100644 --- a/website/docs/services/migrations/repos/index.md +++ b/website/docs/services/migrations/repos/index.md @@ -1,126 +1,1314 @@ ---- +--- title: repos hide_title: false hide_table_of_contents: false keywords: - repos - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos resource. ## Overview - +
Namerepos
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all the repositories for this user migration. | -| | `SELECT` | | List all the repositories for this organization migration. | -| | `EXEC` | | Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. | -| | `EXEC` | | Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, migration_idper_page, pageList all the repositories for this organization migration.
migration_idper_page, pageLists all the repositories for this user migration.
org, migration_id, repo_nameUnlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data.
migration_id, repo_nameUnlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the migration.
stringThe organization name. The name is not case sensitive.
stringrepo_name parameter
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List all the repositories for this organization migration. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.migrations.repos +WHERE org = '{{ org }}' -- required +AND migration_id = '{{ migration_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all the repositories for this user migration. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.migrations.repos +WHERE migration_id = '{{ migration_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `DELETE` examples + + + + +Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. + +```sql +DELETE FROM github.migrations.repos +WHERE org = '{{ org }}' --required +AND migration_id = '{{ migration_id }}' --required +AND repo_name = '{{ repo_name }}' --required +; +``` + + + +Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. + +```sql +DELETE FROM github.migrations.repos +WHERE migration_id = '{{ migration_id }}' --required +AND repo_name = '{{ repo_name }}' --required +; +``` + + diff --git a/website/docs/services/migrations/source_imports/index.md b/website/docs/services/migrations/source_imports/index.md index 9b097cb..73b65dc 100644 --- a/website/docs/services/migrations/source_imports/index.md +++ b/website/docs/services/migrations/source_imports/index.md @@ -1,62 +1,382 @@ ---- +--- title: source_imports hide_title: false hide_table_of_contents: false keywords: - source_imports - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a source_imports resource. ## Overview - +
Namesource_imports
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `array` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | The URL of the originating repository. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (uri)
integer
string
string
boolean
string (uri)
integer
integer
integer
string
array
integer
string (uri)
string (auth, error, none, detecting, choose, auth_failed, importing, mapping, waiting_to_push, pushing, complete, setup, unknown, detection_found_multiple, detection_found_nothing, detection_needs_auth)
string
string
string
string
string (uri)
boolean
string
stringThe URL of the originating repository.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | View the progress of an import.

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.

**Import status**

This section includes details about the possible values of the `status` field of the Import Progress response.

An import that does not have errors will progress through these steps:

* `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
* `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
* `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
* `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
* `complete` - the import is complete, and the repository is ready on GitHub.

If there are problems, you will see one of these in the `status` field:

* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.

**The project_choices field**

When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

**Git LFS related fields**

This section includes details about Git LFS related fields that may be present in the Import Progress response.

* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. | -| | `EXEC` | | Stop an import for a repository.

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API.
| -| | `EXEC` | | Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.
**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. | -| | `EXEC` | | An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
request. If no parameters are provided, the import will be restarted.

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
You can select the project to import by providing one of the objects in the `project_choices` array in the update request.

**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end
on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update
these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoView the progress of an import.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).

**Import status**

This section includes details about the possible values of the `status` field of the Import Progress response.

An import that does not have errors will progress through these steps:

* `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
* `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
* `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
* `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
* `complete` - the import is complete, and the repository is ready on GitHub.

If there are problems, you will see one of these in the `status` field:

* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.

**The project_choices field**

When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

**Git LFS related fields**

This section includes details about Git LFS related fields that may be present in the Import Progress response.

* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request.
owner, repoAn import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
request. If no parameters are provided, the import will be restarted.

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
You can select the project to import by providing one of the objects in the `project_choices` array in the update request.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
owner, repo, vcs_urlStart a source import to a GitHub repository using GitHub Importer.
Importing into a GitHub repository with GitHub Actions enabled is not supported and will
return a status `422 Unprocessable Entity` response.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
owner, repoStop an import for a repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +View the progress of an import.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).

**Import status**

This section includes details about the possible values of the `status` field of the Import Progress response.

An import that does not have errors will progress through these steps:

* `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.
* `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).
* `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
* `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects".
* `complete` - the import is complete, and the repository is ready on GitHub.

If there are problems, you will see one of these in the `status` field:

* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.
* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.
* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.
* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.

**The project_choices field**

When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

**Git LFS related fields**

This section includes details about Git LFS related fields that may be present in the Import Progress response.

* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.
* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.
* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.
* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + +```sql +SELECT +authors_count, +authors_url, +commit_count, +error_message, +failed_step, +has_large_files, +html_url, +import_percent, +large_files_count, +large_files_size, +message, +project_choices, +push_percent, +repository_url, +status, +status_text, +svc_root, +svn_root, +tfvc_project, +url, +use_lfs, +vcs, +vcs_url +FROM github.migrations.source_imports +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API
request. If no parameters are provided, the import will be restarted.

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will
have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.
You can select the project to import by providing one of the objects in the `project_choices` array in the update request.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +UPDATE github.migrations.source_imports +SET +vcs_username = '{{ vcs_username }}', +vcs_password = '{{ vcs_password }}', +vcs = '{{ vcs }}', +tfvc_project = '{{ tfvc_project }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +RETURNING +authors_count, +authors_url, +commit_count, +error_message, +failed_step, +has_large_files, +html_url, +import_percent, +large_files_count, +large_files_size, +message, +project_choices, +push_percent, +repository_url, +status, +status_text, +svc_root, +svn_root, +tfvc_project, +url, +use_lfs, +vcs, +vcs_url; +``` + + + + +## Lifecycle Methods + + + + +Start a source import to a GitHub repository using GitHub Importer.
Importing into a GitHub repository with GitHub Actions enabled is not supported and will
return a status `422 Unprocessable Entity` response.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +EXEC github.migrations.source_imports.start_import +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +@@json= +'{ +"vcs_url": "{{ vcs_url }}", +"vcs": "{{ vcs }}", +"vcs_username": "{{ vcs_username }}", +"vcs_password": "{{ vcs_password }}", +"tfvc_project": "{{ tfvc_project }}" +}' +; +``` + + + +Stop an import for a repository.

> [!WARNING]
> **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + +```sql +EXEC github.migrations.source_imports.cancel_import +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/migrations/users/index.md b/website/docs/services/migrations/users/index.md index bc34730..1c468b2 100644 --- a/website/docs/services/migrations/users/index.md +++ b/website/docs/services/migrations/users/index.md @@ -1,36 +1,102 @@ ---- +--- title: users hide_title: false hide_table_of_contents: false keywords: - users - migrations - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a users resource. ## Overview - +
Nameusers
Name
TypeResource
Id
## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `EXEC` | | Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. | -| | `EXEC` | | Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:

* attachments
* bases
* commit\_comments
* issue\_comments
* issue\_events
* issues
* milestones
* organizations
* projects
* protected\_branches
* pull\_request\_reviews
* pull\_requests
* releases
* repositories
* review\_comments
* schema
* users

The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
migration_idDeletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the migration.
+ +## `DELETE` examples + + + + +Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. + +```sql +DELETE FROM github.migrations.users +WHERE migration_id = '{{ migration_id }}' --required +; +``` + + diff --git a/website/docs/services/oidc/index.md b/website/docs/services/oidc/index.md index 25c991b..9bc71ed 100644 --- a/website/docs/services/oidc/index.md +++ b/website/docs/services/oidc/index.md @@ -9,39 +9,26 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Endpoints To Manage GitHub OIDC Configuration Using The REST API. - -:::info Service Summary +oidc service documentation. -
-
-total resources: 1
-total selectable resources: 1
-total methods: 2
-
-
+:::info[Service Summary] -::: +total resources: __3__ -## Overview - - - - - - -
Namegithub.oidc
TypeService
TitleGitHub V3 REST API - Oidc
DescriptionEndpoints To Manage GitHub OIDC Configuration Using The REST API.
Idoidc:v24.04.00227
+::: ## Resources
oidc
+oidc_custom_property_inclusions
+org_oidc_custom_property_inclusions
-
+ \ No newline at end of file diff --git a/website/docs/services/oidc/oidc/index.md b/website/docs/services/oidc/oidc/index.md index a353eb1..eb9c7b0 100644 --- a/website/docs/services/oidc/oidc/index.md +++ b/website/docs/services/oidc/oidc/index.md @@ -1,35 +1,155 @@ ---- +--- title: oidc hide_title: false hide_table_of_contents: false keywords: - oidc - oidc - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an oidc resource. ## Overview - +
Nameoidc
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +A JSON serialized template for OIDC subject claim customization + + + + + + + + + + + +
NameDatatypeDescription
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `read:org` scope to use this endpoint.
GitHub Apps must have the `organization_administration:write` permission to use this endpoint. | -| | `EXEC` | | Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.
You must authenticate using an access token with the `write:org` scope to use this endpoint.
GitHub Apps must have the `admin:org` permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
orgCreates or updates the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +* +FROM github.oidc.oidc +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Creates or updates the customization template for an OpenID Connect (OIDC) subject claim.

OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +REPLACE github.oidc.oidc +SET +include_claim_keys = '{{ include_claim_keys }}' +WHERE +org = '{{ org }}' --required; +``` + + diff --git a/website/docs/services/oidc/oidc_custom_property_inclusions/index.md b/website/docs/services/oidc/oidc_custom_property_inclusions/index.md new file mode 100644 index 0000000..ec72d47 --- /dev/null +++ b/website/docs/services/oidc/oidc_custom_property_inclusions/index.md @@ -0,0 +1,222 @@ +--- +title: oidc_custom_property_inclusions +hide_title: false +hide_table_of_contents: false +keywords: + - oidc_custom_property_inclusions + - oidc + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an oidc_custom_property_inclusions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A JSON array of OIDC custom property inclusions + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom property that is included in the OIDC token
stringWhether the inclusion was defined at the organization or enterprise level (organization, enterprise) (example: organization)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
enterpriseLists the repository custom properties that are included in the OIDC token for repository actions in an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
enterprise, custom_property_nameAdds a repository custom property to be included in the OIDC token for repository actions in an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
enterprise, custom_property_nameRemoves a repository custom property from being included in the OIDC token for repository actions in an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom property to remove from OIDC token inclusion
stringThe slug version of the enterprise name.
+ +## `SELECT` examples + + + + +Lists the repository custom properties that are included in the OIDC token for repository actions in an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +SELECT +custom_property_name, +inclusion_source +FROM github.oidc.oidc_custom_property_inclusions +WHERE enterprise = '{{ enterprise }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository custom property to be included in the OIDC token for repository actions in an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +INSERT INTO github.oidc.oidc_custom_property_inclusions ( +custom_property_name, +enterprise +) +SELECT +'{{ custom_property_name }}' /* required */, +'{{ enterprise }}' +RETURNING +custom_property_name, +inclusion_source +; +``` + + + +{`# Description fields are for documentation purposes +- name: oidc_custom_property_inclusions + props: + - name: enterprise + value: "{{ enterprise }}" + description: Required parameter for the oidc_custom_property_inclusions resource. + - name: custom_property_name + value: "{{ custom_property_name }}" + description: | + The name of the custom property to include in the OIDC token +`} + + + + + +## `DELETE` examples + + + + +Removes a repository custom property from being included in the OIDC token for repository actions in an enterprise.

OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + +```sql +DELETE FROM github.oidc.oidc_custom_property_inclusions +WHERE enterprise = '{{ enterprise }}' --required +AND custom_property_name = '{{ custom_property_name }}' --required +; +``` + + diff --git a/website/docs/services/oidc/org_oidc_custom_property_inclusions/index.md b/website/docs/services/oidc/org_oidc_custom_property_inclusions/index.md new file mode 100644 index 0000000..223e830 --- /dev/null +++ b/website/docs/services/oidc/org_oidc_custom_property_inclusions/index.md @@ -0,0 +1,222 @@ +--- +title: org_oidc_custom_property_inclusions +hide_title: false +hide_table_of_contents: false +keywords: + - org_oidc_custom_property_inclusions + - oidc + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_oidc_custom_property_inclusions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +A JSON array of OIDC custom property inclusions + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom property that is included in the OIDC token
stringWhether the inclusion was defined at the organization or enterprise level (organization, enterprise) (example: organization)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgLists the repository custom properties that are included in the OIDC token for repository actions in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.
org, custom_property_nameAdds a repository custom property to be included in the OIDC token for repository actions in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, custom_property_nameRemoves a repository custom property from being included in the OIDC token for repository actions in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the custom property to remove from OIDC token inclusion
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists the repository custom properties that are included in the OIDC token for repository actions in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +custom_property_name, +inclusion_source +FROM github.oidc.org_oidc_custom_property_inclusions +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Adds a repository custom property to be included in the OIDC token for repository actions in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.oidc.org_oidc_custom_property_inclusions ( +custom_property_name, +org +) +SELECT +'{{ custom_property_name }}' /* required */, +'{{ org }}' +RETURNING +custom_property_name, +inclusion_source +; +``` + + + +{`# Description fields are for documentation purposes +- name: org_oidc_custom_property_inclusions + props: + - name: org + value: "{{ org }}" + description: Required parameter for the org_oidc_custom_property_inclusions resource. + - name: custom_property_name + value: "{{ custom_property_name }}" + description: | + The name of the custom property to include in the OIDC token +`} + + + + + +## `DELETE` examples + + + + +Removes a repository custom property from being included in the OIDC token for repository actions in an organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.oidc.org_oidc_custom_property_inclusions +WHERE org = '{{ org }}' --required +AND custom_property_name = '{{ custom_property_name }}' --required +; +``` + + diff --git a/website/docs/services/orgs/api_insights_route_stats/index.md b/website/docs/services/orgs/api_insights_route_stats/index.md new file mode 100644 index 0000000..004aa05 --- /dev/null +++ b/website/docs/services/orgs/api_insights_route_stats/index.md @@ -0,0 +1,214 @@ +--- +title: api_insights_route_stats +hide_title: false +hide_table_of_contents: false +keywords: + - api_insights_route_stats + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an api_insights_route_stats resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe API path's route template
stringThe HTTP method
string
string
integer (int64)The total number of requests that were rate limited within the queried time period
integer (int64)The total number of requests within the queried time period
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, actor_type, actor_id, min_timestampmax_timestamp, page, per_page, direction, sort, api_route_substringGet API request count statistics for an actor broken down by route within a specified time frame.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the actor
stringThe type of the actor
stringThe minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe organization name. The name is not case sensitive.
stringProviding a substring will filter results where the API route contains the substring. This is a case-insensitive search.
stringThe direction to sort the results by.
stringThe maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
arrayThe property to sort the results by.
+ +## `SELECT` examples + + + + +Get API request count statistics for an actor broken down by route within a specified time frame. + +```sql +SELECT +api_route, +http_method, +last_rate_limited_timestamp, +last_request_timestamp, +rate_limited_request_count, +total_request_count +FROM github.orgs.api_insights_route_stats +WHERE org = '{{ org }}' -- required +AND actor_type = '{{ actor_type }}' -- required +AND actor_id = '{{ actor_id }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND direction = '{{ direction }}' +AND sort = '{{ sort }}' +AND api_route_substring = '{{ api_route_substring }}' +; +``` + + diff --git a/website/docs/services/orgs/api_insights_subject_stats/index.md b/website/docs/services/orgs/api_insights_subject_stats/index.md new file mode 100644 index 0000000..592ef88 --- /dev/null +++ b/website/docs/services/orgs/api_insights_subject_stats/index.md @@ -0,0 +1,208 @@ +--- +title: api_insights_subject_stats +hide_title: false +hide_table_of_contents: false +keywords: + - api_insights_subject_stats + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an api_insights_subject_stats resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string
string
integer
string
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, min_timestampmax_timestamp, page, per_page, direction, sort, subject_name_substringGet API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe organization name. The name is not case sensitive.
stringThe direction to sort the results by.
stringThe maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
arrayThe property to sort the results by.
stringProviding a substring will filter results where the subject name contains the substring. This is a case-insensitive search.
+ +## `SELECT` examples + + + + +Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + +```sql +SELECT +subject_id, +subject_name, +last_rate_limited_timestamp, +last_request_timestamp, +rate_limited_request_count, +subject_type, +total_request_count +FROM github.orgs.api_insights_subject_stats +WHERE org = '{{ org }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND direction = '{{ direction }}' +AND sort = '{{ sort }}' +AND subject_name_substring = '{{ subject_name_substring }}' +; +``` + + diff --git a/website/docs/services/orgs/api_insights_summary_stats/index.md b/website/docs/services/orgs/api_insights_summary_stats/index.md new file mode 100644 index 0000000..d10aceb --- /dev/null +++ b/website/docs/services/orgs/api_insights_summary_stats/index.md @@ -0,0 +1,266 @@ +--- +title: api_insights_summary_stats +hide_title: false +hide_table_of_contents: false +keywords: + - api_insights_summary_stats + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an api_insights_summary_stats resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The total number of requests that were rate limited within the queried time period
integer (int64)The total number of requests within the queried time period
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The total number of requests that were rate limited within the queried time period
integer (int64)The total number of requests within the queried time period
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The total number of requests that were rate limited within the queried time period
integer (int64)The total number of requests within the queried time period
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, min_timestamp, actor_type, actor_idmax_timestampGet overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.
org, user_id, min_timestampmax_timestampGet overall statistics of API requests within the organization for a user.
org, min_timestampmax_timestampGet overall statistics of API requests made within an organization by all users and apps within a specified time frame.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the actor
stringThe type of the actor
stringThe minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe organization name. The name is not case sensitive.
stringThe ID of the user to query for stats
stringThe maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + +```sql +SELECT +rate_limited_request_count, +total_request_count +FROM github.orgs.api_insights_summary_stats +WHERE org = '{{ org }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND actor_type = '{{ actor_type }}' -- required +AND actor_id = '{{ actor_id }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +; +``` + + + +Get overall statistics of API requests within the organization for a user. + +```sql +SELECT +rate_limited_request_count, +total_request_count +FROM github.orgs.api_insights_summary_stats +WHERE org = '{{ org }}' -- required +AND user_id = '{{ user_id }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +; +``` + + + +Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + +```sql +SELECT +rate_limited_request_count, +total_request_count +FROM github.orgs.api_insights_summary_stats +WHERE org = '{{ org }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +; +``` + + diff --git a/website/docs/services/orgs/api_insights_time_stats/index.md b/website/docs/services/orgs/api_insights_time_stats/index.md new file mode 100644 index 0000000..654479d --- /dev/null +++ b/website/docs/services/orgs/api_insights_time_stats/index.md @@ -0,0 +1,292 @@ +--- +title: api_insights_time_stats +hide_title: false +hide_table_of_contents: false +keywords: + - api_insights_time_stats + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an api_insights_time_stats resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
integer (int64)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
integer (int64)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
integer (int64)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, actor_type, actor_id, min_timestamp, timestamp_incrementmax_timestampGet the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
org, user_id, min_timestamp, timestamp_incrementmax_timestampGet the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
org, min_timestamp, timestamp_incrementmax_timestampGet the number of API requests and rate-limited requests made within an organization over a specified time period.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the actor
stringThe type of the actor
stringThe minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe organization name. The name is not case sensitive.
stringThe increment of time used to breakdown the query results (5m, 10m, 1h, etc.)
stringThe ID of the user to query for stats
stringThe maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
+ +## `SELECT` examples + + + + +Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + +```sql +SELECT +rate_limited_request_count, +timestamp, +total_request_count +FROM github.orgs.api_insights_time_stats +WHERE org = '{{ org }}' -- required +AND actor_type = '{{ actor_type }}' -- required +AND actor_id = '{{ actor_id }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND timestamp_increment = '{{ timestamp_increment }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +; +``` + + + +Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + +```sql +SELECT +rate_limited_request_count, +timestamp, +total_request_count +FROM github.orgs.api_insights_time_stats +WHERE org = '{{ org }}' -- required +AND user_id = '{{ user_id }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND timestamp_increment = '{{ timestamp_increment }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +; +``` + + + +Get the number of API requests and rate-limited requests made within an organization over a specified time period. + +```sql +SELECT +rate_limited_request_count, +timestamp, +total_request_count +FROM github.orgs.api_insights_time_stats +WHERE org = '{{ org }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND timestamp_increment = '{{ timestamp_increment }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +; +``` + + diff --git a/website/docs/services/orgs/api_insights_user_stats/index.md b/website/docs/services/orgs/api_insights_user_stats/index.md new file mode 100644 index 0000000..521f630 --- /dev/null +++ b/website/docs/services/orgs/api_insights_user_stats/index.md @@ -0,0 +1,226 @@ +--- +title: api_insights_user_stats +hide_title: false +hide_table_of_contents: false +keywords: + - api_insights_user_stats + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an api_insights_user_stats resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
integer (int64)
integer (int64)
string
string
string
string
integer
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, user_id, min_timestampmax_timestamp, page, per_page, direction, sort, actor_name_substringGet API usage statistics within an organization for a user broken down by the type of access.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe organization name. The name is not case sensitive.
stringThe ID of the user to query for stats
stringProviding a substring will filter results where the actor name contains the substring. This is a case-insensitive search.
stringThe direction to sort the results by.
stringThe maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
arrayThe property to sort the results by.
+ +## `SELECT` examples + + + + +Get API usage statistics within an organization for a user broken down by the type of access. + +```sql +SELECT +actor_id, +integration_id, +oauth_application_id, +actor_name, +actor_type, +last_rate_limited_timestamp, +last_request_timestamp, +rate_limited_request_count, +total_request_count +FROM github.orgs.api_insights_user_stats +WHERE org = '{{ org }}' -- required +AND user_id = '{{ user_id }}' -- required +AND min_timestamp = '{{ min_timestamp }}' -- required +AND max_timestamp = '{{ max_timestamp }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND direction = '{{ direction }}' +AND sort = '{{ sort }}' +AND actor_name_substring = '{{ actor_name_substring }}' +; +``` + + diff --git a/website/docs/services/orgs/app_installations/index.md b/website/docs/services/orgs/app_installations/index.md index e881262..b866ee8 100644 --- a/website/docs/services/orgs/app_installations/index.md +++ b/website/docs/services/orgs/app_installations/index.md @@ -1,38 +1,148 @@ ---- +--- title: app_installations hide_title: false hide_table_of_contents: false keywords: - app_installations - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an app_installations resource. ## Overview - +
Nameapp_installations
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageLists all GitHub Apps in an organization. The installation count includes
all GitHub Apps installed on repositories in the organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all GitHub Apps in an organization. The installation count includes
all GitHub Apps installed on repositories in the organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + +```sql +SELECT +installations, +total_count +FROM github.orgs.app_installations +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/artifact_deployment_records/index.md b/website/docs/services/orgs/artifact_deployment_records/index.md new file mode 100644 index 0000000..4ccc6a0 --- /dev/null +++ b/website/docs/services/orgs/artifact_deployment_records/index.md @@ -0,0 +1,321 @@ +--- +title: artifact_deployment_records +hide_title: false +hide_table_of_contents: false +keywords: + - artifact_deployment_records + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an artifact_deployment_records resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerThe number of deployment records for this digest and organization
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, subject_digestList deployment records for an artifact metadata associated with an organization.
org, cluster, logical_environment, deploymentsSet deployment records for a given cluster.
If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',
'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.
If no existing records match, new records will be created.
org, name, digest, status, logical_environment, deployment_nameCreate or update deployment records for an artifact associated
with an organization.
This endpoint allows you to record information about a specific
artifact, such as its name, digest, environments, cluster, and
deployment.
The deployment name has to be uniqe within a cluster (i.e a
combination of logical, physical environment and cluster) as it
identifies unique deployment.
Multiple requests for the same combination of logical, physical
environment, cluster and deployment name will only create one
record, successive request will update the existing record.
This allows for a stable tracking of a deployment where the actual
deployed artifact can change over time.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe cluster name.
stringThe organization name. The name is not case sensitive.
stringThe SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`.
+ +## `SELECT` examples + + + + +List deployment records for an artifact metadata associated with an organization. + +```sql +SELECT +deployment_records, +total_count +FROM github.orgs.artifact_deployment_records +WHERE org = '{{ org }}' -- required +AND subject_digest = '{{ subject_digest }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Set deployment records for a given cluster.
If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',
'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.
If no existing records match, new records will be created. + +```sql +INSERT INTO github.orgs.artifact_deployment_records ( +logical_environment, +physical_environment, +deployments, +return_records, +org, +cluster +) +SELECT +'{{ logical_environment }}' /* required */, +'{{ physical_environment }}', +'{{ deployments }}' /* required */, +{{ return_records }}, +'{{ org }}', +'{{ cluster }}' +RETURNING +deployment_records, +total_count +; +``` + + + +Create or update deployment records for an artifact associated
with an organization.
This endpoint allows you to record information about a specific
artifact, such as its name, digest, environments, cluster, and
deployment.
The deployment name has to be uniqe within a cluster (i.e a
combination of logical, physical environment and cluster) as it
identifies unique deployment.
Multiple requests for the same combination of logical, physical
environment, cluster and deployment name will only create one
record, successive request will update the existing record.
This allows for a stable tracking of a deployment where the actual
deployed artifact can change over time. + +```sql +INSERT INTO github.orgs.artifact_deployment_records ( +name, +digest, +version, +status, +logical_environment, +physical_environment, +cluster, +deployment_name, +tags, +runtime_risks, +github_repository, +return_records, +org +) +SELECT +'{{ name }}' /* required */, +'{{ digest }}' /* required */, +'{{ version }}', +'{{ status }}' /* required */, +'{{ logical_environment }}' /* required */, +'{{ physical_environment }}', +'{{ cluster }}', +'{{ deployment_name }}' /* required */, +'{{ tags }}', +'{{ runtime_risks }}', +'{{ github_repository }}', +{{ return_records }}, +'{{ org }}' +RETURNING +deployment_records, +total_count +; +``` + + + +{`# Description fields are for documentation purposes +- name: artifact_deployment_records + props: + - name: org + value: "{{ org }}" + description: Required parameter for the artifact_deployment_records resource. + - name: cluster + value: "{{ cluster }}" + description: Required parameter for the artifact_deployment_records resource. + - name: logical_environment + value: "{{ logical_environment }}" + description: | + The stage of the deployment. + - name: physical_environment + value: "{{ physical_environment }}" + description: | + The physical region of the deployment. + - name: deployments + description: | + The list of deployments to record. + value: + - name: "{{ name }}" + digest: "{{ digest }}" + version: "{{ version }}" + status: "{{ status }}" + deployment_name: "{{ deployment_name }}" + github_repository: "{{ github_repository }}" + tags: "{{ tags }}" + runtime_risks: "{{ runtime_risks }}" + - name: return_records + value: {{ return_records }} + description: | + If true, the endpoint will return the created or updated record in the response body. + default: true + - name: name + value: "{{ name }}" + description: | + The name of the artifact. + - name: digest + value: "{{ digest }}" + description: | + The hex encoded digest of the artifact. + - name: version + value: "{{ version }}" + description: | + The artifact version. + - name: status + value: "{{ status }}" + description: | + The status of the artifact. Can be either deployed or decommissioned. + valid_values: ['deployed', 'decommissioned'] + - name: cluster + value: "{{ cluster }}" + description: | + The deployment cluster. + - name: deployment_name + value: "{{ deployment_name }}" + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + - name: tags + value: "{{ tags }}" + description: | + The tags associated with the deployment. + - name: runtime_risks + value: + - "{{ runtime_risks }}" + description: | + A list of runtime risks associated with the deployment. + - name: github_repository + value: "{{ github_repository }}" + description: | + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. +`} + + + diff --git a/website/docs/services/orgs/artifact_storage_records/index.md b/website/docs/services/orgs/artifact_storage_records/index.md new file mode 100644 index 0000000..b4ae3f1 --- /dev/null +++ b/website/docs/services/orgs/artifact_storage_records/index.md @@ -0,0 +1,255 @@ +--- +title: artifact_storage_records +hide_title: false +hide_table_of_contents: false +keywords: + - artifact_storage_records + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an artifact_storage_records resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerThe number of storage records for this digest and organization
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, subject_digestList a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization.

The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required.
org, name, digest, registry_urlCreate metadata storage records for artifacts associated with an organization.
This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and
associated with a repository owned by the organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. (example: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72)
+ +## `SELECT` examples + + + + +List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization.

The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + +```sql +SELECT +storage_records, +total_count +FROM github.orgs.artifact_storage_records +WHERE org = '{{ org }}' -- required +AND subject_digest = '{{ subject_digest }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Create metadata storage records for artifacts associated with an organization.
This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and
associated with a repository owned by the organization. + +```sql +INSERT INTO github.orgs.artifact_storage_records ( +name, +digest, +version, +artifact_url, +path, +registry_url, +repository, +status, +github_repository, +return_records, +org +) +SELECT +'{{ name }}' /* required */, +'{{ digest }}' /* required */, +'{{ version }}', +'{{ artifact_url }}', +'{{ path }}', +'{{ registry_url }}' /* required */, +'{{ repository }}', +'{{ status }}', +'{{ github_repository }}', +{{ return_records }}, +'{{ org }}' +RETURNING +storage_records, +total_count +; +``` + + + +{`# Description fields are for documentation purposes +- name: artifact_storage_records + props: + - name: org + value: "{{ org }}" + description: Required parameter for the artifact_storage_records resource. + - name: name + value: "{{ name }}" + description: | + The name of the artifact. + - name: digest + value: "{{ digest }}" + description: | + The digest of the artifact (algorithm:hex-encoded-digest). + - name: version + value: "{{ version }}" + description: | + The artifact version. + - name: artifact_url + value: "{{ artifact_url }}" + description: | + The URL where the artifact is stored. + - name: path + value: "{{ path }}" + description: | + The path of the artifact. + - name: registry_url + value: "{{ registry_url }}" + description: | + The base URL of the artifact registry. + - name: repository + value: "{{ repository }}" + description: | + The repository name within the registry. + - name: status + value: "{{ status }}" + description: | + The status of the artifact (e.g., active, inactive). + valid_values: ['active', 'eol', 'deleted'] + default: active + - name: github_repository + value: "{{ github_repository }}" + description: | + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + - name: return_records + value: {{ return_records }} + description: | + If true, the endpoint will return the created record in the response body. + default: true +`} + + + diff --git a/website/docs/services/orgs/attestation_repositories/index.md b/website/docs/services/orgs/attestation_repositories/index.md new file mode 100644 index 0000000..fdfeefb --- /dev/null +++ b/website/docs/services/orgs/attestation_repositories/index.md @@ -0,0 +1,160 @@ +--- +title: attestation_repositories +hide_title: false +hide_table_of_contents: false +keywords: + - attestation_repositories + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an attestation_repositories resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, before, after, predicate_typeList repositories owned by the provided organization that have created at least one attested artifact
Results will be sorted in ascending order by repository ID
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringOptional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types.
+ +## `SELECT` examples + + + + +List repositories owned by the provided organization that have created at least one attested artifact
Results will be sorted in ascending order by repository ID + +```sql +SELECT +id, +name +FROM github.orgs.attestation_repositories +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND predicate_type = '{{ predicate_type }}' +; +``` + + diff --git a/website/docs/services/orgs/attestations/index.md b/website/docs/services/orgs/attestations/index.md new file mode 100644 index 0000000..8aea5f3 --- /dev/null +++ b/website/docs/services/orgs/attestations/index.md @@ -0,0 +1,290 @@ +--- +title: attestations +hide_title: false +hide_table_of_contents: false +keywords: + - attestations + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an attestations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
objectThe attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, subject_digestper_page, before, after, predicate_typeList a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
org, subject_digestDelete an artifact attestation by subject digest.
org, attestation_idDelete an artifact attestation by unique ID that is associated with a repository owned by an org.
org, subject_digestsper_page, before, afterList a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
org, subject_digests, attestation_idsDelete artifact attestations in bulk by either subject digests or unique ID.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerAttestation ID
stringThe organization name. The name is not case sensitive.
stringSubject Digest
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringOptional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types.
+ +## `SELECT` examples + + + + +List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + +```sql +SELECT +repository_id, +bundle, +bundle_url, +initiator +FROM github.orgs.attestations +WHERE org = '{{ org }}' -- required +AND subject_digest = '{{ subject_digest }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND predicate_type = '{{ predicate_type }}' +; +``` + + + + +## `DELETE` examples + + + + +Delete an artifact attestation by subject digest. + +```sql +DELETE FROM github.orgs.attestations +WHERE org = '{{ org }}' --required +AND subject_digest = '{{ subject_digest }}' --required +; +``` + + + +Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + +```sql +DELETE FROM github.orgs.attestations +WHERE org = '{{ org }}' --required +AND attestation_id = '{{ attestation_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + +```sql +EXEC github.orgs.attestations.list_attestations_bulk +@org='{{ org }}' --required, +@per_page='{{ per_page }}', +@before='{{ before }}', +@after='{{ after }}' +@@json= +'{ +"subject_digests": "{{ subject_digests }}", +"predicate_type": "{{ predicate_type }}" +}' +; +``` + + + +Delete artifact attestations in bulk by either subject digests or unique ID. + +```sql +EXEC github.orgs.attestations.delete_attestations_bulk +@org='{{ org }}' --required +@@json= +'{ +"subject_digests": "{{ subject_digests }}", +"attestation_ids": "{{ attestation_ids }}" +}' +; +``` + + diff --git a/website/docs/services/orgs/blocking/index.md b/website/docs/services/orgs/blocking/index.md index 5bafbde..fd3746d 100644 --- a/website/docs/services/orgs/blocking/index.md +++ b/website/docs/services/orgs/blocking/index.md @@ -1,60 +1,340 @@ ---- +--- title: blocking hide_title: false hide_table_of_contents: false keywords: - blocking - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a blocking resource. ## Overview - +
Nameblocking
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the users blocked by an organization. | -| | `EXEC` | | Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. | -| | `EXEC` | | Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. | -| | `EXEC` | | Unblocks the given user on behalf of the specified organization. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageList the users blocked by an organization.
org, usernameReturns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.
org, usernameBlocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.
org, usernameUnblocks the given user on behalf of the specified organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List the users blocked by an organization. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.orgs.blocking +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## Lifecycle Methods + + + + +Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. + +```sql +EXEC github.orgs.blocking.check_blocked_user +@org='{{ org }}' --required, +@username='{{ username }}' --required +; +``` + + + +Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. + +```sql +EXEC github.orgs.blocking.block_user +@org='{{ org }}' --required, +@username='{{ username }}' --required +; +``` + + + +Unblocks the given user on behalf of the specified organization. + +```sql +EXEC github.orgs.blocking.unblock_user +@org='{{ org }}' --required, +@username='{{ username }}' --required +; +``` + + diff --git a/website/docs/services/orgs/custom_properties/index.md b/website/docs/services/orgs/custom_properties/index.md new file mode 100644 index 0000000..da52dc6 --- /dev/null +++ b/website/docs/services/orgs/custom_properties/index.md @@ -0,0 +1,406 @@ +--- +title: custom_properties +hide_title: false +hide_table_of_contents: false +keywords: + - custom_properties + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_properties resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the property
arrayAn ordered list of the allowed values of the property. The property can have up to 200 allowed values.
stringDefault value of the property
stringShort description of the property
booleanWhether setting properties values is mandatory
booleanWhether the property is required.
stringThe source type of the property (organization, enterprise) (example: organization)
string (uri)The URL that can be used to fetch, update, or delete info about this property via the API.
stringThe type of the value for the property (string, single_select, multi_select, true_false, url) (example: single_select)
stringWho can edit the values of the property (org_actors, org_and_repo_actors) (example: org_actors)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the property
arrayAn ordered list of the allowed values of the property. The property can have up to 200 allowed values.
stringDefault value of the property
stringShort description of the property
booleanWhether setting properties values is mandatory
booleanWhether the property is required.
stringThe source type of the property (organization, enterprise) (example: organization)
string (uri)The URL that can be used to fetch, update, or delete info about this property via the API.
stringThe type of the value for the property (string, single_select, multi_select, true_false, url) (example: single_select)
stringWho can edit the values of the property (org_actors, org_and_repo_actors) (example: org_actors)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, custom_property_nameGets a custom property that is defined for an organization.
Organization members can read these properties.
orgGets all custom properties defined for an organization.
Organization members can read these properties.
org, propertiesCreates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values.
Missing optional values will fall back to default values, previous values will be overwritten.
E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
org, custom_property_name, value_typeCreates a new or updates an existing custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
org, custom_property_nameRemoves a custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe custom property name
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a custom property that is defined for an organization.
Organization members can read these properties. + +```sql +SELECT +property_name, +allowed_values, +default_value, +description, +require_explicit_values, +required, +source_type, +url, +value_type, +values_editable_by +FROM github.orgs.custom_properties +WHERE org = '{{ org }}' -- required +AND custom_property_name = '{{ custom_property_name }}' -- required +; +``` + + + +Gets all custom properties defined for an organization.
Organization members can read these properties. + +```sql +SELECT +property_name, +allowed_values, +default_value, +description, +require_explicit_values, +required, +source_type, +url, +value_type, +values_editable_by +FROM github.orgs.custom_properties +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Creates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values.
Missing optional values will fall back to default values, previous values will be overwritten.
E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + +```sql +UPDATE github.orgs.custom_properties +SET +properties = '{{ properties }}' +WHERE +org = '{{ org }}' --required +AND properties = '{{ properties }}' --required +RETURNING +property_name, +allowed_values, +default_value, +description, +require_explicit_values, +required, +source_type, +url, +value_type, +values_editable_by; +``` + + + + +## `REPLACE` examples + + + + +Creates a new or updates an existing custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + +```sql +REPLACE github.orgs.custom_properties +SET +value_type = '{{ value_type }}', +required = {{ required }}, +default_value = '{{ default_value }}', +description = '{{ description }}', +allowed_values = '{{ allowed_values }}', +values_editable_by = '{{ values_editable_by }}', +require_explicit_values = {{ require_explicit_values }} +WHERE +org = '{{ org }}' --required +AND custom_property_name = '{{ custom_property_name }}' --required +AND value_type = '{{ value_type }}' --required +RETURNING +property_name, +allowed_values, +default_value, +description, +require_explicit_values, +required, +source_type, +url, +value_type, +values_editable_by; +``` + + + + +## `DELETE` examples + + + + +Removes a custom property that is defined for an organization.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + +```sql +DELETE FROM github.orgs.custom_properties +WHERE org = '{{ org }}' --required +AND custom_property_name = '{{ custom_property_name }}' --required +; +``` + + diff --git a/website/docs/services/orgs/custom_property_values/index.md b/website/docs/services/orgs/custom_property_values/index.md new file mode 100644 index 0000000..9c41919 --- /dev/null +++ b/website/docs/services/orgs/custom_property_values/index.md @@ -0,0 +1,199 @@ +--- +title: custom_property_values +hide_title: false +hide_table_of_contents: false +keywords: + - custom_property_values + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_property_values resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: octocat/Hello-World)
string (example: Hello-World)
arrayList of custom property names and associated values
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, page, repository_queryLists organization repositories with all of their custom property values.
Organization members can read these properties.
org, repository_names, propertiesCreate new or update existing custom property values for repositories in a batch that belong to an organization.
Each target repository will have its custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFinds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers.
+ +## `SELECT` examples + + + + +Lists organization repositories with all of their custom property values.
Organization members can read these properties. + +```sql +SELECT +repository_id, +repository_full_name, +repository_name, +properties +FROM github.orgs.custom_property_values +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND repository_query = '{{ repository_query }}' +; +``` + + + + +## `UPDATE` examples + + + + +Create new or update existing custom property values for repositories in a batch that belong to an organization.
Each target repository will have its custom property values updated to match the values provided in the request.

A maximum of 30 repositories can be updated in a single request.

Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

To use this endpoint, the authenticated user must be one of:
- An administrator for the organization.
- A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + +```sql +UPDATE github.orgs.custom_property_values +SET +repository_names = '{{ repository_names }}', +properties = '{{ properties }}' +WHERE +org = '{{ org }}' --required +AND repository_names = '{{ repository_names }}' --required +AND properties = '{{ properties }}' --required; +``` + + diff --git a/website/docs/services/orgs/failed_invitations/index.md b/website/docs/services/orgs/failed_invitations/index.md index 3740d4e..86345a9 100644 --- a/website/docs/services/orgs/failed_invitations/index.md +++ b/website/docs/services/orgs/failed_invitations/index.md @@ -1,48 +1,208 @@ ---- +--- title: failed_invitations hide_title: false hide_table_of_contents: false keywords: - failed_invitations - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a failed_invitations resource. ## Overview - +
Namefailed_invitations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x")
string
string
string
string
string (example: "member")
string (example: "https://api.github.com/organizations/16/invitations/1/teams")
objectA GitHub user. (title: Simple User)
string
string
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageThe return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. + +```sql +SELECT +id, +node_id, +created_at, +email, +failed_at, +failed_reason, +invitation_source, +invitation_teams_url, +inviter, +login, +role, +team_count +FROM github.orgs.failed_invitations +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/immutable_releases_repos/index.md b/website/docs/services/orgs/immutable_releases_repos/index.md new file mode 100644 index 0000000..24a79a1 --- /dev/null +++ b/website/docs/services/orgs/immutable_releases_repos/index.md @@ -0,0 +1,234 @@ +--- +title: immutable_releases_repos +hide_title: false +hide_table_of_contents: false +keywords: + - immutable_releases_repos + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an immutable_releases_repos resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgpage, per_pageList all of the repositories that have been selected for immutable releases enforcement in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, repository_idAdds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, selected_repository_idsReplaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, repository_idRemoves a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the repository.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List all of the repositories that have been selected for immutable releases enforcement in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +repositories, +total_count +FROM github.orgs.immutable_releases_repos +WHERE org = '{{ org }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.orgs.immutable_releases_repos +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required; +``` + + + +Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.orgs.immutable_releases_repos +SET +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND selected_repository_ids = '{{ selected_repository_ids }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.immutable_releases_repos +WHERE org = '{{ org }}' --required +AND repository_id = '{{ repository_id }}' --required +; +``` + + diff --git a/website/docs/services/orgs/immutable_releases_settings/index.md b/website/docs/services/orgs/immutable_releases_settings/index.md new file mode 100644 index 0000000..5f6c6a5 --- /dev/null +++ b/website/docs/services/orgs/immutable_releases_settings/index.md @@ -0,0 +1,168 @@ +--- +title: immutable_releases_settings +hide_title: false +hide_table_of_contents: false +keywords: + - immutable_releases_settings + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an immutable_releases_settings resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Immutable releases settings response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe policy that controls how immutable releases are enforced in the organization. (all, none, selected) (example: all)
stringThe API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGets the immutable releases policy for repositories in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, enforced_repositoriesSets the immutable releases policy for repositories in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the immutable releases policy for repositories in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +enforced_repositories, +selected_repositories_url +FROM github.orgs.immutable_releases_settings +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Sets the immutable releases policy for repositories in an organization.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.orgs.immutable_releases_settings +SET +enforced_repositories = '{{ enforced_repositories }}', +selected_repository_ids = '{{ selected_repository_ids }}' +WHERE +org = '{{ org }}' --required +AND enforced_repositories = '{{ enforced_repositories }}' --required; +``` + + diff --git a/website/docs/services/orgs/index.md b/website/docs/services/orgs/index.md index 3d83c57..8a1212b 100644 --- a/website/docs/services/orgs/index.md +++ b/website/docs/services/orgs/index.md @@ -9,58 +9,62 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With GitHub Orgs. - -:::info Service Summary +orgs service documentation. -
-
-total resources: 20
-total selectable resources: 20
-total methods: 55
-
-
+:::info[Service Summary] -::: +total resources: __39__ -## Overview - - - - - - -
Namegithub.orgs
TypeService
TitleGitHub V3 REST API - Orgs
DescriptionInteract With GitHub Orgs.
Idorgs:v24.04.00227
+::: ## Resources
+api_insights_route_stats
+api_insights_subject_stats
+api_insights_summary_stats
+api_insights_time_stats
+api_insights_user_stats
app_installations
+artifact_deployment_records
+artifact_storage_records
+attestation_repositories
+attestations
blocking
+custom_properties
+custom_property_values
failed_invitations
+immutable_releases_repos
+immutable_releases_settings
invitation_teams
invitations
+issue_fields
+issue_types +
+
members
memberships
-org
orgs
orgs_for_user
-
-
outside_collaborators
pat_grant_requests
pat_grants
+public_members
repos_for_pat_grant_requests
repos_for_pat_grants
+role_team_assignments
+role_user_assignments
+roles
+ruleset_history
security_managers
webhook_config
webhook_deliveries
webhook_delivery
-webhooks
-
+webhooks
+ \ No newline at end of file diff --git a/website/docs/services/orgs/invitation_teams/index.md b/website/docs/services/orgs/invitation_teams/index.md index f92fdd1..ad0bd0c 100644 --- a/website/docs/services/orgs/invitation_teams/index.md +++ b/website/docs/services/orgs/invitation_teams/index.md @@ -1,50 +1,244 @@ ---- +--- title: invitation_teams hide_title: false hide_table_of_contents: false keywords: - invitation_teams - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an invitation_teams resource. ## Overview - +
Nameinvitation_teams
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, invitation_idper_page, pageList all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the invitation.
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.orgs.invitation_teams +WHERE org = '{{ org }}' -- required +AND invitation_id = '{{ invitation_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/invitations/index.md b/website/docs/services/orgs/invitations/index.md index a93614c..62e7fff 100644 --- a/website/docs/services/orgs/invitations/index.md +++ b/website/docs/services/orgs/invitations/index.md @@ -1,50 +1,341 @@ ---- +--- title: invitations hide_title: false hide_table_of_contents: false keywords: - invitations - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an invitations resource. ## Overview - +
Nameinvitations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x")
string
string
string
string
string (example: "member")
string (example: "https://api.github.com/organizations/16/invitations/1/teams")
objectA GitHub user. (title: Simple User)
string
string
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. | -| | `INSERT` | | Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `EXEC` | | Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, page, role, invitation_sourceThe return hash contains a `role` field which refers to the Organization
Invitation role and will be one of the following values: `direct_member`, `admin`,
`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub
member, the `login` field in the return hash will be `null`.
orgInvite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
org, invitation_idCancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the invitation.
stringThe organization name. The name is not case sensitive.
stringFilter invitations by their invitation source.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFilter invitations by their member role.
+ +## `SELECT` examples + + + + +The return hash contains a `role` field which refers to the Organization
Invitation role and will be one of the following values: `direct_member`, `admin`,
`billing_manager`, or `hiring_manager`. If the invitee is not a GitHub
member, the `login` field in the return hash will be `null`. + +```sql +SELECT +id, +node_id, +created_at, +email, +failed_at, +failed_reason, +invitation_source, +invitation_teams_url, +inviter, +login, +role, +team_count +FROM github.orgs.invitations +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND role = '{{ role }}' +AND invitation_source = '{{ invitation_source }}' +; +``` + + + + +## `INSERT` examples + + + + +Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +INSERT INTO github.orgs.invitations ( +invitee_id, +email, +role, +team_ids, +org +) +SELECT +{{ invitee_id }}, +'{{ email }}', +'{{ role }}', +'{{ team_ids }}', +'{{ org }}' +RETURNING +id, +node_id, +created_at, +email, +failed_at, +failed_reason, +invitation_source, +invitation_teams_url, +inviter, +login, +role, +team_count +; +``` + + + +{`# Description fields are for documentation purposes +- name: invitations + props: + - name: org + value: "{{ org }}" + description: Required parameter for the invitations resource. + - name: invitee_id + value: {{ invitee_id }} + description: | + **Required unless you provide \`email\`**. GitHub user ID for the person you are inviting. + - name: email + value: "{{ email }}" + description: | + **Required unless you provide \`invitee_id\`**. Email address of the person you are inviting, which can be an existing GitHub user. + - name: role + value: "{{ role }}" + description: | + The role for the new member. + * \`admin\` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * \`direct_member\` - Non-owner organization members with ability to see other members and join teams by invitation. + * \`billing_manager\` - Non-owner organization members with ability to manage the billing settings of your organization. + * \`reinstate\` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + valid_values: ['admin', 'direct_member', 'billing_manager', 'reinstate'] + default: direct_member + - name: team_ids + value: + - {{ team_ids }} + description: | + Specify IDs for the teams you want to invite new members to. +`} + + + + + +## `DELETE` examples + + + + +Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). + +```sql +DELETE FROM github.orgs.invitations +WHERE org = '{{ org }}' --required +AND invitation_id = '{{ invitation_id }}' --required +; +``` + + diff --git a/website/docs/services/orgs/issue_fields/index.md b/website/docs/services/orgs/issue_fields/index.md new file mode 100644 index 0000000..d09ed2f --- /dev/null +++ b/website/docs/services/orgs/issue_fields/index.md @@ -0,0 +1,345 @@ +--- +title: issue_fields +hide_title: false +hide_table_of_contents: false +keywords: + - issue_fields + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_fields resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the issue field.
stringThe name of the issue field.
stringThe node identifier of the issue field.
string (date-time)The time the issue field was created.
stringThe data type of the issue field. (text, date, single_select, number)
stringThe description of the issue field.
arrayAvailable options for single select fields.
string (date-time)The time the issue field was last updated.
stringThe visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). (organization_members_only, all)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgLists all issue fields for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
org, name, data_typeCreates a new issue field for an organization.

You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, issue_field_idUpdates an issue field for an organization.

You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, issue_field_idDeletes an issue field for an organization.

You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the issue field.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists all issue fields for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + +```sql +SELECT +id, +name, +node_id, +created_at, +data_type, +description, +options, +updated_at, +visibility +FROM github.orgs.issue_fields +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Creates a new issue field for an organization.

You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.orgs.issue_fields ( +name, +description, +data_type, +visibility, +options, +org +) +SELECT +'{{ name }}' /* required */, +'{{ description }}', +'{{ data_type }}' /* required */, +'{{ visibility }}', +'{{ options }}', +'{{ org }}' +RETURNING +id, +name, +node_id, +created_at, +data_type, +description, +options, +updated_at, +visibility +; +``` + + + +{`# Description fields are for documentation purposes +- name: issue_fields + props: + - name: org + value: "{{ org }}" + description: Required parameter for the issue_fields resource. + - name: name + value: "{{ name }}" + description: | + Name of the issue field. + - name: description + value: "{{ description }}" + description: | + Description of the issue field. + - name: data_type + value: "{{ data_type }}" + description: | + The data type of the issue field. + valid_values: ['text', 'date', 'single_select', 'number'] + - name: visibility + value: "{{ visibility }}" + description: | + The visibility of the issue field. Can be \`organization_members_only\` (visible only within the organization) or \`all\` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to \`organization_members_only\`. + valid_values: ['organization_members_only', 'all'] + - name: options + description: | + Options for single select fields. Required when data_type is 'single_select'. + value: + - name: "{{ name }}" + description: "{{ description }}" + color: "{{ color }}" + priority: {{ priority }} +`} + + + + + +## `UPDATE` examples + + + + +Updates an issue field for an organization.

You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +UPDATE github.orgs.issue_fields +SET +name = '{{ name }}', +description = '{{ description }}', +visibility = '{{ visibility }}', +options = '{{ options }}' +WHERE +org = '{{ org }}' --required +AND issue_field_id = '{{ issue_field_id }}' --required +RETURNING +id, +name, +node_id, +created_at, +data_type, +description, +options, +updated_at, +visibility; +``` + + + + +## `DELETE` examples + + + + +Deletes an issue field for an organization.

You can find out more about issue fields in [Managing issue fields in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/using-issues/managing-issue-fields-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.issue_fields +WHERE org = '{{ org }}' --required +AND issue_field_id = '{{ issue_field_id }}' --required +; +``` + + diff --git a/website/docs/services/orgs/issue_types/index.md b/website/docs/services/orgs/issue_types/index.md new file mode 100644 index 0000000..cc39a1e --- /dev/null +++ b/website/docs/services/orgs/issue_types/index.md @@ -0,0 +1,328 @@ +--- +title: issue_types +hide_title: false +hide_table_of_contents: false +keywords: + - issue_types + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an issue_types resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the issue type.
stringThe name of the issue type.
stringThe node identifier of the issue type.
stringThe color of the issue type. (gray, blue, green, yellow, orange, red, pink, purple)
string (date-time)The time the issue type created.
stringThe description of the issue type.
booleanThe enabled state of the issue type.
string (date-time)The time the issue type last updated.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgLists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.
org, name, is_enabledCreate a new issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, issue_type_id, name, is_enabledUpdates an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, issue_type_idDeletes an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the issue type.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + +```sql +SELECT +id, +name, +node_id, +color, +created_at, +description, +is_enabled, +updated_at +FROM github.orgs.issue_types +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Create a new issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.orgs.issue_types ( +name, +is_enabled, +description, +color, +org +) +SELECT +'{{ name }}' /* required */, +{{ is_enabled }} /* required */, +'{{ description }}', +'{{ color }}', +'{{ org }}' +RETURNING +id, +name, +node_id, +color, +created_at, +description, +is_enabled, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: issue_types + props: + - name: org + value: "{{ org }}" + description: Required parameter for the issue_types resource. + - name: name + value: "{{ name }}" + description: | + Name of the issue type. + - name: is_enabled + value: {{ is_enabled }} + description: | + Whether or not the issue type is enabled at the organization level. + - name: description + value: "{{ description }}" + description: | + Description of the issue type. + - name: color + value: "{{ color }}" + description: | + Color for the issue type. + valid_values: ['gray', 'blue', 'green', 'yellow', 'orange', 'red', 'pink', 'purple'] +`} + + + + + +## `REPLACE` examples + + + + +Updates an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.orgs.issue_types +SET +name = '{{ name }}', +is_enabled = {{ is_enabled }}, +description = '{{ description }}', +color = '{{ color }}' +WHERE +org = '{{ org }}' --required +AND issue_type_id = '{{ issue_type_id }}' --required +AND name = '{{ name }}' --required +AND is_enabled = {{ is_enabled }} --required +RETURNING +id, +name, +node_id, +color, +created_at, +description, +is_enabled, +updated_at; +``` + + + + +## `DELETE` examples + + + + +Deletes an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.issue_types +WHERE org = '{{ org }}' --required +AND issue_type_id = '{{ issue_type_id }}' --required +; +``` + + diff --git a/website/docs/services/orgs/members/index.md b/website/docs/services/orgs/members/index.md index 85d9039..bb1054c 100644 --- a/website/docs/services/orgs/members/index.md +++ b/website/docs/services/orgs/members/index.md @@ -1,59 +1,314 @@ ---- +--- title: members hide_title: false hide_table_of_contents: false keywords: - members - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a members resource. ## Overview - +
Namemembers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. | -| | `DELETE` | | Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. | -| | `EXEC` | | Members of an organization can choose to have their membership publicized or not. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgfilter, role, per_page, pageList all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.
org, usernameRemoving a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

> [!NOTE]
> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
stringFilter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFilter members returned by their role.
+ +## `SELECT` examples + + + + +List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.orgs.members +WHERE org = '{{ org }}' -- required +AND filter = '{{ filter }}' +AND role = '{{ role }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `DELETE` examples + + + + +Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

> [!NOTE]
> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. + +```sql +DELETE FROM github.orgs.members +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +; +``` + + diff --git a/website/docs/services/orgs/memberships/index.md b/website/docs/services/orgs/memberships/index.md index 36ef0df..b86a81b 100644 --- a/website/docs/services/orgs/memberships/index.md +++ b/website/docs/services/orgs/memberships/index.md @@ -1,52 +1,521 @@ ---- +--- title: memberships hide_title: false hide_table_of_contents: false keywords: - memberships - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a memberships resource. ## Overview - +
Namememberships
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub organization. | -| | `string` | | -| | `object` | | -| | `string` | The user's membership type in the organization. | -| | `string` | The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether the user has direct membership in the organization.
arrayThe slugs of the enterprise teams providing the user with indirect membership in the organization. A limit of 100 enterprise team slugs is returned.
objectA GitHub organization. (title: Organization Simple)
string (uri) (example: https://api.github.com/orgs/octocat)
object
stringThe user's membership type in the organization. (admin, member, billing_manager) (example: admin)
stringThe state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. (active, pending) (example: active)
string (uri) (example: https://api.github.com/orgs/octocat/memberships/defunkt)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether the user has direct membership in the organization.
arrayThe slugs of the enterprise teams providing the user with indirect membership in the organization. A limit of 100 enterprise team slugs is returned.
objectA GitHub organization. (title: Organization Simple)
string (uri) (example: https://api.github.com/orgs/octocat)
object
stringThe user's membership type in the organization. (admin, member, billing_manager) (example: admin)
stringThe state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. (active, pending) (example: active)
string (uri) (example: https://api.github.com/orgs/octocat/memberships/defunkt)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether the user has direct membership in the organization.
arrayThe slugs of the enterprise teams providing the user with indirect membership in the organization. A limit of 100 enterprise team slugs is returned.
objectA GitHub organization. (title: Organization Simple)
string (uri) (example: https://api.github.com/orgs/octocat)
object
stringThe user's membership type in the organization. (admin, member, billing_manager) (example: admin)
stringThe state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. (active, pending) (example: active)
string (uri) (example: https://api.github.com/orgs/octocat/memberships/defunkt)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. | -| | `SELECT` | | In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. | -| | `SELECT` | | Lists all of the authenticated user's organization memberships. | -| | `DELETE` | | In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. | -| | `EXEC` | | Check if a user is, publicly or privately, a member of the organization. | -| | `EXEC` | | Check if the provided user is a public member of the organization. | -| | `EXEC` | | Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. | -| | `EXEC` | | Only authenticated organization owners can add a member to the organization or update the member's role.

* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.

* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.

**Rate limits**

To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. | -| | `EXEC` | | The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." | -| | `EXEC` | | Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, usernameIn order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.
orgIf the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.
state, per_page, pageLists all of the authenticated user's organization memberships.
org, stateConverts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.
org, usernameOnly authenticated organization owners can add a member to the organization or update the member's role.

* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.

* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.

**Rate limits**

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.
org, usernameIn order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

> [!NOTE]
> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team.
org, usernameCheck if a user is, publicly or privately, a member of the organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringIndicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.
+ +## `SELECT` examples + + + + +In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. + +```sql +SELECT +direct_membership, +enterprise_teams_providing_indirect_membership, +organization, +organization_url, +permissions, +role, +state, +url, +user +FROM github.orgs.memberships +WHERE org = '{{ org }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. + +```sql +SELECT +direct_membership, +enterprise_teams_providing_indirect_membership, +organization, +organization_url, +permissions, +role, +state, +url, +user +FROM github.orgs.memberships +WHERE org = '{{ org }}' -- required +; +``` + + + +Lists all of the authenticated user's organization memberships. + +```sql +SELECT +direct_membership, +enterprise_teams_providing_indirect_membership, +organization, +organization_url, +permissions, +role, +state, +url, +user +FROM github.orgs.memberships +WHERE state = '{{ state }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `UPDATE` examples + + + + +Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. + +```sql +UPDATE github.orgs.memberships +SET +state = '{{ state }}' +WHERE +org = '{{ org }}' --required +AND state = '{{ state }}' --required +RETURNING +direct_membership, +enterprise_teams_providing_indirect_membership, +organization, +organization_url, +permissions, +role, +state, +url, +user; +``` + + + + +## `REPLACE` examples + + + + +Only authenticated organization owners can add a member to the organization or update the member's role.

* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.

* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.

**Rate limits**

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + +```sql +REPLACE github.orgs.memberships +SET +role = '{{ role }}' +WHERE +org = '{{ org }}' --required +AND username = '{{ username }}' --required +RETURNING +direct_membership, +enterprise_teams_providing_indirect_membership, +organization, +organization_url, +permissions, +role, +state, +url, +user; +``` + + + + +## `DELETE` examples + + + + +In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

> [!NOTE]
> If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. + +```sql +DELETE FROM github.orgs.memberships +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Check if a user is, publicly or privately, a member of the organization. + +```sql +EXEC github.orgs.memberships.check_membership_for_user +@org='{{ org }}' --required, +@username='{{ username }}' --required +; +``` + + diff --git a/website/docs/services/orgs/org/index.md b/website/docs/services/orgs/org/index.md deleted file mode 100644 index 863e474..0000000 --- a/website/docs/services/orgs/org/index.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: org -hide_title: false -hide_table_of_contents: false -keywords: - - org - - orgs - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.

This field is only visible to organization owners or members of a team with the security manager role. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to
this organization.

This field is only visible to organization owners or members of a team with the security manager role. | -| | `boolean` | Whether dependabot security updates are automatically enabled for new repositories and repositories transferred
to this organization.

This field is only visible to organization owners or members of a team with the security manager role. | -| | `boolean` | Whether dependency graph is automatically enabled for new repositories and repositories transferred to this
organization.

This field is only visible to organization owners or members of a team with the security manager role. | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `object` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `boolean` | Whether secret scanning is automatically enabled for new repositories and repositories transferred to this
organization.

This field is only visible to organization owners or members of a team with the security manager role. | -| | `string` | An optional URL string to display to contributors who are blocked from pushing a secret. | -| | `boolean` | Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. | -| | `boolean` | Whether secret scanning push protection is automatically enabled for new repositories and repositories
transferred to this organization.

This field is only visible to organization owners or members of a team with the security manager role. | -| | `integer` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/orgs/orgs/index.md b/website/docs/services/orgs/orgs/index.md index 4a5321e..b6f0aea 100644 --- a/website/docs/services/orgs/orgs/index.md +++ b/website/docs/services/orgs/orgs/index.md @@ -1,52 +1,964 @@ ---- +--- title: orgs hide_title: false hide_table_of_contents: false keywords: - orgs - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an orgs resource. ## Overview - +
Nameorgs
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: github)
string (example: MDEyOk9yZ2FuaXphdGlvbjE=)
boolean**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
string (date-time)
string (example: https://github.com/images/error/octocat_happy.gif)
string (email) (example: org@example.com)
string (uri) (example: https://github.com/blog)
integerThe number of collaborators on private repositories. This field may be null if the number of private repositories is over 50,000.
string (example: GitHub)
string (date-time) (example: 2008-01-14T04:33:35Z)
stringThe default branch for repositories created in this organization. (example: main)
string
boolean**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
boolean**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
boolean**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
booleanControls whether or not deploy keys may be added and used for repositories in the organization.
string (example: A great organization)
integer
boolean
string (email) (example: octocat@github.com)
string (uri) (example: https://api.github.com/orgs/github/events)
integer
integer
boolean
boolean
string (example: https://api.github.com/orgs/github/hooks)
string (uri) (example: https://github.com/octocat)
boolean
string (example: https://api.github.com/orgs/github/issues)
string (example: San Francisco)
string (example: github)
string (example: all)
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string (example: https://api.github.com/orgs/github/members{/member})
integer
object
integer
integer
string (example: https://api.github.com/orgs/github/public_members{/member})
integer
boolean
string (uri) (example: https://api.github.com/orgs/github/repos)
boolean**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
stringAn optional URL string to display to contributors who are blocked from pushing a secret. (example: https://github.com/test-org/test-repo/blob/main/README.md)
booleanWhether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
boolean**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization. This field is only visible to organization owners or members of a team with the security manager role.
integer
string (example: github)
boolean
string (example: Organization)
string (date-time)
string (uri) (example: https://api.github.com/orgs/github)
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDEyOk9yZ2FuaXphdGlvbjE=)
string (example: https://github.com/images/error/octocat_happy.gif)
string (example: A great organization)
string (uri) (example: https://api.github.com/orgs/github/events)
string (example: https://api.github.com/orgs/github/hooks)
string (example: https://api.github.com/orgs/github/issues)
string (example: github)
string (example: https://api.github.com/orgs/github/members{/member})
string (example: https://api.github.com/orgs/github/public_members{/member})
string (uri) (example: https://api.github.com/orgs/github/repos)
string (uri) (example: https://api.github.com/orgs/github)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDEyOk9yZ2FuaXphdGlvbjE=)
string (example: https://github.com/images/error/octocat_happy.gif)
string (example: A great organization)
string (uri) (example: https://api.github.com/orgs/github/events)
string (example: https://api.github.com/orgs/github/hooks)
string (example: https://api.github.com/orgs/github/issues)
string (example: github)
string (example: https://api.github.com/orgs/github/members{/member})
string (example: https://api.github.com/orgs/github/public_members{/member})
string (uri) (example: https://api.github.com/orgs/github/repos)
string (uri) (example: https://api.github.com/orgs/github)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all organizations, in the order that they were created on GitHub.

**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. | -| | `SELECT` | | List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.

This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. | -| | `DELETE` | | Deletes an organization and all its repositories.

The organization login will be unavailable for 90 days after deletion.

Please review the Terms of Service regarding account deletion before using this endpoint:

https://docs.github.com/site-policy/github-terms/github-terms-of-service | -| | `EXEC` | | Enables or disables the specified security feature for all eligible repositories in an organization.

To use this endpoint, you must be an organization owner or be member of a team with the security manager role.
A token with the 'write:org' scope is also required.

GitHub Apps must have the `organization_administration:write` permission to use this endpoint.

For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." | -| | `EXEC` | | **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).

Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgGets information about an organization.

When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).

To see the full details about an organization, the authenticated user must be an organization owner.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.

To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
usernameper_page, pageList [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.

This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.
since, per_pageLists all organizations, in the order that they were created.

> [!NOTE]
> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.
org> [!WARNING]
> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).

> [!WARNING]
> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).

Updates the organization's profile and member privileges.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
orgDeletes an organization and all its repositories.

The organization login will be unavailable for 90 days after deletion.

Please review the Terms of Service regarding account deletion before using this endpoint:

https://docs.github.com/site-policy/github-terms/github-terms-of-service
org, security_product, enablement> [!WARNING]
> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe action to take. `enable_all` means to enable the specified security feature for all repositories in the organization. `disable_all` means to disable the specified security feature for all repositories in the organization.
stringThe organization name. The name is not case sensitive.
stringThe security feature to enable or disable.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerAn organization ID. Only return organizations with an ID greater than this ID.
+ +## `SELECT` examples + + + + +Gets information about an organization.

When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).

To see the full details about an organization, the authenticated user must be an organization owner.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.

To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. + +```sql +SELECT +id, +name, +node_id, +advanced_security_enabled_for_new_repositories, +archived_at, +avatar_url, +billing_email, +blog, +collaborators, +company, +created_at, +default_repository_branch, +default_repository_permission, +dependabot_alerts_enabled_for_new_repositories, +dependabot_security_updates_enabled_for_new_repositories, +dependency_graph_enabled_for_new_repositories, +deploy_keys_enabled_for_repositories, +description, +disk_usage, +display_commenter_full_name_setting_enabled, +email, +events_url, +followers, +following, +has_organization_projects, +has_repository_projects, +hooks_url, +html_url, +is_verified, +issues_url, +location, +login, +members_allowed_repository_creation_type, +members_can_change_repo_visibility, +members_can_create_internal_repositories, +members_can_create_pages, +members_can_create_private_pages, +members_can_create_private_repositories, +members_can_create_public_pages, +members_can_create_public_repositories, +members_can_create_repositories, +members_can_create_teams, +members_can_delete_issues, +members_can_delete_repositories, +members_can_fork_private_repositories, +members_can_invite_outside_collaborators, +members_can_view_dependency_insights, +members_url, +owned_private_repos, +plan, +private_gists, +public_gists, +public_members_url, +public_repos, +readers_can_create_discussions, +repos_url, +secret_scanning_enabled_for_new_repositories, +secret_scanning_push_protection_custom_link, +secret_scanning_push_protection_custom_link_enabled, +secret_scanning_push_protection_enabled_for_new_repositories, +total_private_repos, +twitter_username, +two_factor_requirement_enabled, +type, +updated_at, +url, +web_commit_signoff_required +FROM github.orgs.orgs +WHERE org = '{{ org }}' -- required +; +``` + + + +List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.

This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + +```sql +SELECT +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url +FROM github.orgs.orgs +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all organizations, in the order that they were created.

> [!NOTE]
> Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + +```sql +SELECT +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url +FROM github.orgs.orgs +WHERE since = '{{ since }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `UPDATE` examples + + + + +> [!WARNING]
> **Closing down notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).

> [!WARNING]
> **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/).

Updates the organization's profile and member privileges.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + +```sql +UPDATE github.orgs.orgs +SET +billing_email = '{{ billing_email }}', +company = '{{ company }}', +email = '{{ email }}', +twitter_username = '{{ twitter_username }}', +location = '{{ location }}', +name = '{{ name }}', +description = '{{ description }}', +has_organization_projects = {{ has_organization_projects }}, +has_repository_projects = {{ has_repository_projects }}, +default_repository_permission = '{{ default_repository_permission }}', +members_can_create_repositories = {{ members_can_create_repositories }}, +members_can_create_internal_repositories = {{ members_can_create_internal_repositories }}, +members_can_create_private_repositories = {{ members_can_create_private_repositories }}, +members_can_create_public_repositories = {{ members_can_create_public_repositories }}, +members_allowed_repository_creation_type = '{{ members_allowed_repository_creation_type }}', +members_can_create_pages = {{ members_can_create_pages }}, +members_can_create_public_pages = {{ members_can_create_public_pages }}, +members_can_create_private_pages = {{ members_can_create_private_pages }}, +members_can_fork_private_repositories = {{ members_can_fork_private_repositories }}, +web_commit_signoff_required = {{ web_commit_signoff_required }}, +blog = '{{ blog }}', +advanced_security_enabled_for_new_repositories = {{ advanced_security_enabled_for_new_repositories }}, +dependabot_alerts_enabled_for_new_repositories = {{ dependabot_alerts_enabled_for_new_repositories }}, +dependabot_security_updates_enabled_for_new_repositories = {{ dependabot_security_updates_enabled_for_new_repositories }}, +dependency_graph_enabled_for_new_repositories = {{ dependency_graph_enabled_for_new_repositories }}, +secret_scanning_enabled_for_new_repositories = {{ secret_scanning_enabled_for_new_repositories }}, +secret_scanning_push_protection_enabled_for_new_repositories = {{ secret_scanning_push_protection_enabled_for_new_repositories }}, +secret_scanning_push_protection_custom_link_enabled = {{ secret_scanning_push_protection_custom_link_enabled }}, +secret_scanning_push_protection_custom_link = '{{ secret_scanning_push_protection_custom_link }}', +deploy_keys_enabled_for_repositories = {{ deploy_keys_enabled_for_repositories }} +WHERE +org = '{{ org }}' --required +RETURNING +id, +name, +node_id, +advanced_security_enabled_for_new_repositories, +archived_at, +avatar_url, +billing_email, +blog, +collaborators, +company, +created_at, +default_repository_branch, +default_repository_permission, +dependabot_alerts_enabled_for_new_repositories, +dependabot_security_updates_enabled_for_new_repositories, +dependency_graph_enabled_for_new_repositories, +deploy_keys_enabled_for_repositories, +description, +disk_usage, +display_commenter_full_name_setting_enabled, +email, +events_url, +followers, +following, +has_organization_projects, +has_repository_projects, +hooks_url, +html_url, +is_verified, +issues_url, +location, +login, +members_allowed_repository_creation_type, +members_can_change_repo_visibility, +members_can_create_internal_repositories, +members_can_create_pages, +members_can_create_private_pages, +members_can_create_private_repositories, +members_can_create_public_pages, +members_can_create_public_repositories, +members_can_create_repositories, +members_can_create_teams, +members_can_delete_issues, +members_can_delete_repositories, +members_can_fork_private_repositories, +members_can_invite_outside_collaborators, +members_can_view_dependency_insights, +members_url, +owned_private_repos, +plan, +private_gists, +public_gists, +public_members_url, +public_repos, +readers_can_create_discussions, +repos_url, +secret_scanning_enabled_for_new_repositories, +secret_scanning_push_protection_custom_link, +secret_scanning_push_protection_custom_link_enabled, +secret_scanning_push_protection_enabled_for_new_repositories, +total_private_repos, +twitter_username, +two_factor_requirement_enabled, +type, +updated_at, +url, +web_commit_signoff_required; +``` + + + + +## `DELETE` examples + + + + +Deletes an organization and all its repositories.

The organization login will be unavailable for 90 days after deletion.

Please review the Terms of Service regarding account deletion before using this endpoint:

https://docs.github.com/site-policy/github-terms/github-terms-of-service + +```sql +DELETE FROM github.orgs.orgs +WHERE org = '{{ org }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +> [!WARNING]
> **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/).

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. + +```sql +EXEC github.orgs.orgs.enable_or_disable_security_product_on_all_org_repos +@org='{{ org }}' --required, +@security_product='{{ security_product }}' --required, +@enablement='{{ enablement }}' --required +@@json= +'{ +"query_suite": "{{ query_suite }}" +}' +; +``` + + diff --git a/website/docs/services/orgs/orgs_for_user/index.md b/website/docs/services/orgs/orgs_for_user/index.md index 2b4417e..2840082 100644 --- a/website/docs/services/orgs/orgs_for_user/index.md +++ b/website/docs/services/orgs/orgs_for_user/index.md @@ -1,48 +1,202 @@ ---- +--- title: orgs_for_user hide_title: false hide_table_of_contents: false keywords: - orgs_for_user - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an orgs_for_user resource. ## Overview - +
Nameorgs_for_user
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDEyOk9yZ2FuaXphdGlvbjE=)
string (example: https://github.com/images/error/octocat_happy.gif)
string (example: A great organization)
string (uri) (example: https://api.github.com/orgs/github/events)
string (example: https://api.github.com/orgs/github/hooks)
string (example: https://api.github.com/orgs/github/issues)
string (example: github)
string (example: https://api.github.com/orgs/github/members{/member})
string (example: https://api.github.com/orgs/github/public_members{/member})
string (uri) (example: https://api.github.com/orgs/github/repos)
string (uri) (example: https://api.github.com/orgs/github)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageList organizations for the authenticated user.

For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.

> [!NOTE]
> Requests using a fine-grained access token will receive a `200 Success` response with an empty list.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List organizations for the authenticated user.

For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.

> [!NOTE]
> Requests using a fine-grained access token will receive a `200 Success` response with an empty list. + +```sql +SELECT +id, +node_id, +avatar_url, +description, +events_url, +hooks_url, +issues_url, +login, +members_url, +public_members_url, +repos_url, +url +FROM github.orgs.orgs_for_user +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/outside_collaborators/index.md b/website/docs/services/orgs/outside_collaborators/index.md index 4fc557e..1f7e17f 100644 --- a/website/docs/services/orgs/outside_collaborators/index.md +++ b/website/docs/services/orgs/outside_collaborators/index.md @@ -1,59 +1,341 @@ ---- +--- title: outside_collaborators hide_title: false hide_table_of_contents: false keywords: - outside_collaborators - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an outside_collaborators resource. ## Overview - +
Nameoutside_collaborators
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List all users who are outside collaborators of an organization. | -| | `DELETE` | | Removing a user from this list will remove them from all the organization's repositories. | -| | `EXEC` | | When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgfilter, per_page, pageList all users who are outside collaborators of an organization.
org, usernameRemoving a user from this list will remove them from all the organization's repositories.
org, usernameWhen an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
stringFilter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List all users who are outside collaborators of an organization. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.orgs.outside_collaborators +WHERE org = '{{ org }}' -- required +AND filter = '{{ filter }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `DELETE` examples + + + + +Removing a user from this list will remove them from all the organization's repositories. + +```sql +DELETE FROM github.orgs.outside_collaborators +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + +```sql +EXEC github.orgs.outside_collaborators.convert_member_to_outside_collaborator +@org='{{ org }}' --required, +@username='{{ username }}' --required +@@json= +'{ +"async": {{ async }} +}' +; +``` + + diff --git a/website/docs/services/orgs/pat_grant_requests/index.md b/website/docs/services/orgs/pat_grant_requests/index.md index 9497b5d..f595d65 100644 --- a/website/docs/services/orgs/pat_grant_requests/index.md +++ b/website/docs/services/orgs/pat_grant_requests/index.md @@ -1,48 +1,319 @@ ---- +--- title: pat_grant_requests hide_title: false hide_table_of_contents: false keywords: - pat_grant_requests - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pat_grant_requests resource. ## Overview - +
Namepat_grant_requests
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. | -| | `string` | Date and time when the request for access was created. | -| | `object` | A GitHub user. | -| | `object` | Permissions requested, categorized by type of permission. | -| | `string` | Reason for requesting access. | -| | `string` | URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. | -| | `string` | Type of repository selection requested. | -| | `boolean` | Whether the associated fine-grained personal access token has expired. | -| | `string` | Date and time when the associated fine-grained personal access token expires. | -| | `string` | Date and time when the associated fine-grained personal access token was last used for authentication. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests.
integerUnique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
stringThe name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.
stringDate and time when the request for access was created.
objectA GitHub user. (title: Simple User)
objectPermissions requested, categorized by type of permission.
stringReason for requesting access.
stringURL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`.
stringType of repository selection requested. (none, all, subset)
booleanWhether the associated fine-grained personal access token has expired.
stringDate and time when the associated fine-grained personal access token expires.
stringDate and time when the associated fine-grained personal access token was last used for authentication.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,
using the `organization_personal_access_token_requests: read` permission.

**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. | -| | `EXEC` | | Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
using the `organization_personal_access_token_requests: write` permission.

**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. | -| | `EXEC` | | Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,
using the `organization_personal_access_token_requests: write` permission.

**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, page, sort, direction, owner, repository, permission, last_used_before, last_used_after, token_idLists requests from organization members to access organization resources with a fine-grained personal access token.

Only GitHub Apps can use this endpoint.
org, actionApproves or denies multiple pending requests to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint.
org, pat_request_id, actionApproves or denies a pending request to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerUnique identifier of the request for access via fine-grained personal access token.
stringThe direction to sort the results by.
string (date-time)Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
string (date-time)Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
arrayA list of owner usernames to use to filter the results.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe permission to use to filter the results.
stringThe name of the repository to use to filter the results.
stringThe property by which to sort the results.
arrayThe ID of the token
+ +## `SELECT` examples + + + + +Lists requests from organization members to access organization resources with a fine-grained personal access token.

Only GitHub Apps can use this endpoint. + +```sql +SELECT +id, +token_id, +token_name, +created_at, +owner, +permissions, +reason, +repositories_url, +repository_selection, +token_expired, +token_expires_at, +token_last_used_at +FROM github.orgs.pat_grant_requests +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND owner = '{{ owner }}' +AND repository = '{{ repository }}' +AND permission = '{{ permission }}' +AND last_used_before = '{{ last_used_before }}' +AND last_used_after = '{{ last_used_after }}' +AND token_id = '{{ token_id }}' +; +``` + + + + +## Lifecycle Methods + + + + +Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint. + +```sql +EXEC github.orgs.pat_grant_requests.review_pat_grant_requests_in_bulk +@org='{{ org }}' --required +@@json= +'{ +"pat_request_ids": "{{ pat_request_ids }}", +"action": "{{ action }}", +"reason": "{{ reason }}" +}' +; +``` + + + +Approves or denies a pending request to access organization resources via a fine-grained personal access token.

Only GitHub Apps can use this endpoint. + +```sql +EXEC github.orgs.pat_grant_requests.review_pat_grant_request +@org='{{ org }}' --required, +@pat_request_id='{{ pat_request_id }}' --required +@@json= +'{ +"action": "{{ action }}", +"reason": "{{ reason }}" +}' +; +``` + + diff --git a/website/docs/services/orgs/pat_grants/index.md b/website/docs/services/orgs/pat_grants/index.md index 19eb8ac..eba1d52 100644 --- a/website/docs/services/orgs/pat_grants/index.md +++ b/website/docs/services/orgs/pat_grants/index.md @@ -1,47 +1,311 @@ ---- +--- title: pat_grants hide_title: false hide_table_of_contents: false keywords: - pat_grants - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pat_grants resource. ## Overview - +
Namepat_grants
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. | -| | `string` | Date and time when the fine-grained personal access token was approved to access the organization. | -| | `object` | A GitHub user. | -| | `object` | Permissions requested, categorized by type of permission. | -| | `string` | URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. | -| | `string` | Type of repository selection requested. | -| | `boolean` | Whether the associated fine-grained personal access token has expired. | -| | `string` | Date and time when the associated fine-grained personal access token expires. | -| | `string` | Date and time when the associated fine-grained personal access token was last used for authentication. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token.
integerUnique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants.
stringThe name given to the user's token. This field can also be found in an organization's settings page for Active Tokens.
stringDate and time when the fine-grained personal access token was approved to access the organization.
objectA GitHub user. (title: Simple User)
objectPermissions requested, categorized by type of permission.
stringURL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`.
stringType of repository selection requested. (none, all, subset)
booleanWhether the associated fine-grained personal access token has expired.
stringDate and time when the associated fine-grained personal access token expires.
stringDate and time when the associated fine-grained personal access token was last used for authentication.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,
using the `organization_personal_access_tokens: read` permission.

**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. | -| | `EXEC` | | Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
using the `organization_personal_access_tokens: write` permission.

**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. | -| | `EXEC` | | Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,
using the `organization_personal_access_tokens: write` permission.

**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, page, sort, direction, owner, repository, permission, last_used_before, last_used_after, token_idLists approved fine-grained personal access tokens owned by organization members that can access organization resources.

Only GitHub Apps can use this endpoint.
org, action, pat_idsUpdates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint.
org, pat_id, actionUpdates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the fine-grained personal access token.
stringThe direction to sort the results by.
string (date-time)Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
string (date-time)Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
arrayA list of owner usernames to use to filter the results.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe permission to use to filter the results.
stringThe name of the repository to use to filter the results.
stringThe property by which to sort the results.
arrayThe ID of the token
+ +## `SELECT` examples + + + + +Lists approved fine-grained personal access tokens owned by organization members that can access organization resources.

Only GitHub Apps can use this endpoint. + +```sql +SELECT +id, +token_id, +token_name, +access_granted_at, +owner, +permissions, +repositories_url, +repository_selection, +token_expired, +token_expires_at, +token_last_used_at +FROM github.orgs.pat_grants +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND owner = '{{ owner }}' +AND repository = '{{ repository }}' +AND permission = '{{ permission }}' +AND last_used_before = '{{ last_used_before }}' +AND last_used_after = '{{ last_used_after }}' +AND token_id = '{{ token_id }}' +; +``` + + + + +## Lifecycle Methods + + + + +Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint. + +```sql +EXEC github.orgs.pat_grants.update_pat_accesses +@org='{{ org }}' --required +@@json= +'{ +"action": "{{ action }}", +"pat_ids": "{{ pat_ids }}" +}' +; +``` + + + +Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access.

Only GitHub Apps can use this endpoint. + +```sql +EXEC github.orgs.pat_grants.update_pat_access +@org='{{ org }}' --required, +@pat_id='{{ pat_id }}' --required +@@json= +'{ +"action": "{{ action }}" +}' +; +``` + + diff --git a/website/docs/services/orgs/public_members/index.md b/website/docs/services/orgs/public_members/index.md new file mode 100644 index 0000000..4a013df --- /dev/null +++ b/website/docs/services/orgs/public_members/index.md @@ -0,0 +1,362 @@ +--- +title: public_members +hide_title: false +hide_table_of_contents: false +keywords: + - public_members + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a public_members resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, pageMembers of an organization can choose to have their membership publicized or not.
org, usernameThe user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
org, usernameRemoves the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.
org, usernameCheck if the provided user is a public member of the organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Members of an organization can choose to have their membership publicized or not. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.orgs.public_members +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + +```sql +REPLACE github.orgs.public_members +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND username = '{{ username }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. + +```sql +DELETE FROM github.orgs.public_members +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Check if the provided user is a public member of the organization. + +```sql +EXEC github.orgs.public_members.check_public_membership_for_user +@org='{{ org }}' --required, +@username='{{ username }}' --required +; +``` + + diff --git a/website/docs/services/orgs/repos_for_pat_grant_requests/index.md b/website/docs/services/orgs/repos_for_pat_grant_requests/index.md index 80b5ff0..c95eeb9 100644 --- a/website/docs/services/orgs/repos_for_pat_grant_requests/index.md +++ b/website/docs/services/orgs/repos_for_pat_grant_requests/index.md @@ -1,123 +1,682 @@ ---- +--- title: repos_for_pat_grant_requests hide_title: false hide_table_of_contents: false keywords: - repos_for_pat_grant_requests - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos_for_pat_grant_requests resource. ## Overview - +
Namerepos_for_pat_grant_requests
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, pat_request_idper_page, pageLists the repositories a fine-grained personal access token request is requesting access to.

Only GitHub Apps can use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerUnique identifier of the request for access via fine-grained personal access token.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the repositories a fine-grained personal access token request is requesting access to.

Only GitHub Apps can use this endpoint. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.orgs.repos_for_pat_grant_requests +WHERE org = '{{ org }}' -- required +AND pat_request_id = '{{ pat_request_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/repos_for_pat_grants/index.md b/website/docs/services/orgs/repos_for_pat_grants/index.md index d3885ab..5c52639 100644 --- a/website/docs/services/orgs/repos_for_pat_grants/index.md +++ b/website/docs/services/orgs/repos_for_pat_grants/index.md @@ -1,123 +1,682 @@ ---- +--- title: repos_for_pat_grants hide_title: false hide_table_of_contents: false keywords: - repos_for_pat_grants - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos_for_pat_grants resource. ## Overview - +
Namerepos_for_pat_grants
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, pat_idper_page, pageLists the repositories a fine-grained personal access token has access to.

Only GitHub Apps can use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerUnique identifier of the fine-grained personal access token.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the repositories a fine-grained personal access token has access to.

Only GitHub Apps can use this endpoint. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.orgs.repos_for_pat_grants +WHERE org = '{{ org }}' -- required +AND pat_id = '{{ pat_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/role_team_assignments/index.md b/website/docs/services/orgs/role_team_assignments/index.md new file mode 100644 index 0000000..ac6cb0a --- /dev/null +++ b/website/docs/services/orgs/role_team_assignments/index.md @@ -0,0 +1,336 @@ +--- +title: role_team_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - role_team_assignments + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a role_team_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response - List of assigned teams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
stringDetermines if the team has a direct, indirect, or mixed relationship to a role (direct, indirect, mixed) (example: direct)
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, role_idper_page, pageLists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, team_slug, role_idAssigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, team_slug, role_idRemoves an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, team_slugRemoves all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the role.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +assignment, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.orgs.role_team_assignments +WHERE org = '{{ org }}' -- required +AND role_id = '{{ role_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.orgs.role_team_assignments +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +AND role_id = '{{ role_id }}' --required; +``` + + + + +## `DELETE` examples + + + + +Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.role_team_assignments +WHERE org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +AND role_id = '{{ role_id }}' --required +; +``` + + + +Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.role_team_assignments +WHERE org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +; +``` + + diff --git a/website/docs/services/orgs/role_user_assignments/index.md b/website/docs/services/orgs/role_user_assignments/index.md new file mode 100644 index 0000000..aef416c --- /dev/null +++ b/website/docs/services/orgs/role_user_assignments/index.md @@ -0,0 +1,372 @@ +--- +title: role_user_assignments +hide_title: false +hide_table_of_contents: false +keywords: + - role_user_assignments + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a role_user_assignments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response - List of assigned users + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
stringDetermines if the user has a direct, indirect, or mixed relationship to a role (direct, indirect, mixed) (example: direct)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
arrayTeam the user has gotten the role through
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, role_idper_page, pageLists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, username, role_idAssigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, username, role_idRemove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, usernameRevokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the role.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, you must be an administrator for the organization.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +assignment, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +inherited_from, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.orgs.role_user_assignments +WHERE org = '{{ org }}' -- required +AND role_id = '{{ role_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +REPLACE github.orgs.role_user_assignments +SET +-- No updatable properties +WHERE +org = '{{ org }}' --required +AND username = '{{ username }}' --required +AND role_id = '{{ role_id }}' --required; +``` + + + + +## `DELETE` examples + + + + +Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.role_user_assignments +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +AND role_id = '{{ role_id }}' --required +; +``` + + + +Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.orgs.role_user_assignments +WHERE org = '{{ org }}' --required +AND username = '{{ username }}' --required +; +``` + + diff --git a/website/docs/services/orgs/roles/index.md b/website/docs/services/orgs/roles/index.md new file mode 100644 index 0000000..067094c --- /dev/null +++ b/website/docs/services/orgs/roles/index.md @@ -0,0 +1,232 @@ +--- +title: roles +hide_title: false +hide_table_of_contents: false +keywords: + - roles + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a roles resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the role.
stringThe name of the role.
stringThe system role from which this role inherits permissions. (read, triage, write, maintain, admin)
string (date-time)The date and time the role was created.
stringA short description about who this role is for or what permissions it grants.
objectA GitHub user. (title: Simple User)
arrayA list of permissions included in this role.
stringSource answers the question, "where did this role come from?" (Organization, Enterprise, Predefined)
string (date-time)The date and time the role was last updated.
+ + + +Response - list of organization roles + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayThe list of organization roles available to the organization.
integerThe total number of organization roles available to the organization.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, role_idGets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
orgLists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the role.
+ +## `SELECT` examples + + + + +Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +id, +name, +base_role, +created_at, +description, +organization, +permissions, +source, +updated_at +FROM github.orgs.roles +WHERE org = '{{ org }}' -- required +AND role_id = '{{ role_id }}' -- required +; +``` + + + +Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)."

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
- An organization member (or a member of a team) assigned a custom organization role that includes the **View organization roles** (`read_organization_custom_org_role`) permission. For more information, see "[Permissions for organization access](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles#permissions-for-organization-access)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +roles, +total_count +FROM github.orgs.roles +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/orgs/ruleset_history/index.md b/website/docs/services/orgs/ruleset_history/index.md new file mode 100644 index 0000000..0f19625 --- /dev/null +++ b/website/docs/services/orgs/ruleset_history/index.md @@ -0,0 +1,227 @@ +--- +title: ruleset_history +hide_title: false +hide_table_of_contents: false +keywords: + - ruleset_history + - orgs + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a ruleset_history resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the previous version of the ruleset
objectThe actor who updated the ruleset
stringThe state of the ruleset version (opaque JSON object)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the previous version of the ruleset
objectThe actor who updated the ruleset
string (date-time)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, ruleset_id, version_idGet a version of an organization ruleset.
org, ruleset_idper_page, pageGet the history of an organization ruleset.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe ID of the ruleset.
integerThe ID of the version
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Get a version of an organization ruleset. + +```sql +SELECT +version_id, +actor, +state, +updated_at +FROM github.orgs.ruleset_history +WHERE org = '{{ org }}' -- required +AND ruleset_id = '{{ ruleset_id }}' -- required +AND version_id = '{{ version_id }}' -- required +; +``` + + + +Get the history of an organization ruleset. + +```sql +SELECT +version_id, +actor, +updated_at +FROM github.orgs.ruleset_history +WHERE org = '{{ org }}' -- required +AND ruleset_id = '{{ ruleset_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/orgs/security_managers/index.md b/website/docs/services/orgs/security_managers/index.md index 8529b42..c5ca626 100644 --- a/website/docs/services/orgs/security_managers/index.md +++ b/website/docs/services/orgs/security_managers/index.md @@ -1,51 +1,302 @@ ---- +--- title: security_managers hide_title: false hide_table_of_contents: false keywords: - security_managers - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a security_managers resource. ## Overview - +
Namesecurity_managers
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the team | -| | `string` | Name of the team | -| | `string` | Description of the team | -| | `string` | | -| | `string` | Distinguished Name (DN) that team maps to within LDAP environment | -| | `string` | | -| | `string` | | -| | `string` | The notification setting the team has set | -| | `string` | Permission that the team will have for its repositories | -| | `string` | The level of privacy this team should have | -| | `string` | | -| | `string` | | -| | `string` | URL for the team | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the team
stringName of the team (example: Justice League)
integerUnique identifier of the enterprise to which this team belongs
string (example: MDQ6VGVhbTE=)
integerUnique identifier of the organization to which this team belongs
stringDescription of the team (example: A great team.)
string (uri) (example: https://github.com/orgs/rails/teams/core)
stringDistinguished Name (DN) that team maps to within LDAP environment (example: uid=example,ou=users,dc=github,dc=com)
string (example: https://api.github.com/organizations/1/team/1/members{/member})
stringThe notification setting the team has set (example: notifications_enabled)
stringPermission that the team will have for its repositories (example: admin)
stringThe level of privacy this team should have (example: closed)
string (uri) (example: https://api.github.com/organizations/1/team/1/repos)
string (example: justice-league)
stringThe ownership type of the team (enterprise, organization)
string (uri)URL for the team (example: https://api.github.com/organizations/1/team/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."

To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.

GitHub Apps must have the `administration` organization read permission to use this endpoint. | -| | `DELETE` | | Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization."

To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.

GitHub Apps must have the `administration` organization read-write permission to use this endpoint. | -| | `EXEC` | | Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization."

To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.

GitHub Apps must have the `administration` organization read-write permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.
org, team_slug> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.
org, team_slug> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe slug of the team name.
+ +## `SELECT` examples + + + + +> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +ldap_dn, +members_url, +notification_setting, +permission, +privacy, +repositories_url, +slug, +type, +url +FROM github.orgs.security_managers +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. + +```sql +INSERT INTO github.orgs.security_managers ( +org, +team_slug +) +SELECT +'{{ org }}', +'{{ team_slug }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: security_managers + props: + - name: org + value: "{{ org }}" + description: Required parameter for the security_managers resource. + - name: team_slug + value: "{{ team_slug }}" + description: Required parameter for the security_managers resource. +`} + + + + + +## `DELETE` examples + + + + +> [!WARNING]
> **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. + +```sql +DELETE FROM github.orgs.security_managers +WHERE org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +; +``` + + diff --git a/website/docs/services/orgs/webhook_config/index.md b/website/docs/services/orgs/webhook_config/index.md index 7b9dd5d..02e917d 100644 --- a/website/docs/services/orgs/webhook_config/index.md +++ b/website/docs/services/orgs/webhook_config/index.md @@ -1,41 +1,193 @@ ---- +--- title: webhook_config hide_title: false hide_table_of_contents: false keywords: - webhook_config - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_config resource. ## Overview - +
Namewebhook_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. | -| | `` | | -| | `string` | If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). | -| | `string` | The URL to which the payloads will be delivered. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. (example: "json")
stringDetermines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** (example: "0")
stringIf provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). (example: "********")
string (uri)The URL to which the payloads will be delivered. (example: https://example.com/webhook)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)."

Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. | -| | `EXEC` | | Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."

Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, hook_idReturns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
org, hook_idUpdates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +SELECT +content_type, +insecure_ssl, +secret, +url +FROM github.orgs.webhook_config +WHERE org = '{{ org }}' -- required +AND hook_id = '{{ hook_id }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook)."

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +UPDATE github.orgs.webhook_config +SET +url = '{{ url }}', +content_type = '{{ content_type }}', +secret = '{{ secret }}', +insecure_ssl = '{{ insecure_ssl }}' +WHERE +org = '{{ org }}' --required +AND hook_id = '{{ hook_id }}' --required +RETURNING +content_type, +insecure_ssl, +secret, +url; +``` + + diff --git a/website/docs/services/orgs/webhook_deliveries/index.md b/website/docs/services/orgs/webhook_deliveries/index.md index 5af211a..689585c 100644 --- a/website/docs/services/orgs/webhook_deliveries/index.md +++ b/website/docs/services/orgs/webhook_deliveries/index.md @@ -1,47 +1,220 @@ ---- +--- title: webhook_deliveries hide_title: false hide_table_of_contents: false keywords: - webhook_deliveries - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_deliveries resource. ## Overview - +
Namewebhook_deliveries
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the webhook delivery. | -| | `string` | The type of activity for the event that triggered the delivery. | -| | `string` | Time when the webhook delivery occurred. | -| | `number` | Time spent delivering. | -| | `string` | The event that triggered the delivery. | -| | `string` | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). | -| | `integer` | The id of the GitHub App installation associated with this event. | -| | `boolean` | Whether the webhook delivery is a redelivery. | -| | `integer` | The id of the repository associated with this event. | -| | `string` | Describes the response returned after attempting the delivery. | -| | `integer` | Status code received when delivery was made. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the webhook delivery.
integer (int64)The id of the GitHub App installation associated with this event.
integer (int64)The id of the repository associated with this event.
stringThe type of activity for the event that triggered the delivery. (example: opened)
string (date-time)Time when the webhook delivery occurred. (example: 2021-05-12T20:33:44Z)
numberTime spent delivering.
stringThe event that triggered the delivery. (example: issues)
stringUnique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). (example: 58474f00-b361-11eb-836d-0e4f3503ccbe)
booleanWhether the webhook delivery is a redelivery.
stringDescribes the response returned after attempting the delivery. (example: failed to connect)
integerStatus code received when delivery was made.
string (date-time)Time when the webhook delivery was throttled. (example: 2021-05-12T20:33:44Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, hook_idper_page, cursor, statusReturns a list of webhook deliveries for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe organization name. The name is not case sensitive.
stringUsed for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringReturns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).
+ +## `SELECT` examples + + + + +Returns a list of webhook deliveries for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +SELECT +id, +installation_id, +repository_id, +action, +delivered_at, +duration, +event, +guid, +redelivery, +status, +status_code, +throttled_at +FROM github.orgs.webhook_deliveries +WHERE org = '{{ org }}' -- required +AND hook_id = '{{ hook_id }}' -- required +AND per_page = '{{ per_page }}' +AND cursor = '{{ cursor }}' +AND status = '{{ status }}' +; +``` + + diff --git a/website/docs/services/orgs/webhook_delivery/index.md b/website/docs/services/orgs/webhook_delivery/index.md index e06d53a..9861383 100644 --- a/website/docs/services/orgs/webhook_delivery/index.md +++ b/website/docs/services/orgs/webhook_delivery/index.md @@ -1,51 +1,256 @@ ---- +--- title: webhook_delivery hide_title: false hide_table_of_contents: false keywords: - webhook_delivery - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_delivery resource. ## Overview - +
Namewebhook_delivery
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the delivery. | -| | `string` | The type of activity for the event that triggered the delivery. | -| | `string` | Time when the delivery was delivered. | -| | `number` | Time spent delivering. | -| | `string` | The event that triggered the delivery. | -| | `string` | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). | -| | `integer` | The id of the GitHub App installation associated with this event. | -| | `boolean` | Whether the delivery is a redelivery. | -| | `integer` | The id of the repository associated with this event. | -| | `object` | | -| | `object` | | -| | `string` | Description of the status of the attempted delivery | -| | `integer` | Status code received when delivery was made. | -| | `string` | The URL target of the delivery. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the delivery.
integerThe id of the GitHub App installation associated with this event.
integerThe id of the repository associated with this event.
stringThe type of activity for the event that triggered the delivery. (example: opened)
string (date-time)Time when the delivery was delivered. (example: 2021-05-12T20:33:44Z)
numberTime spent delivering.
stringThe event that triggered the delivery. (example: issues)
stringUnique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). (example: 58474f00-b361-11eb-836d-0e4f3503ccbe)
booleanWhether the delivery is a redelivery.
object
object
stringDescription of the status of the attempted delivery (example: failed to connect)
integerStatus code received when delivery was made.
string (date-time)Time when the webhook delivery was throttled. (example: 2021-05-12T20:33:44Z)
stringThe URL target of the delivery. (example: https://www.example.com)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns a delivery for a webhook configured in an organization. | -| | `EXEC` | | Redeliver a delivery for a webhook configured in an organization. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, hook_id, delivery_idReturns a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
org, hook_id, delivery_idRedeliver a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +SELECT +id, +installation_id, +repository_id, +action, +delivered_at, +duration, +event, +guid, +redelivery, +request, +response, +status, +status_code, +throttled_at, +url +FROM github.orgs.webhook_delivery +WHERE org = '{{ org }}' -- required +AND hook_id = '{{ hook_id }}' -- required +AND delivery_id = '{{ delivery_id }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Redeliver a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +EXEC github.orgs.webhook_delivery.redeliver_webhook_delivery +@org='{{ org }}' --required, +@hook_id='{{ hook_id }}' --required, +@delivery_id='{{ delivery_id }}' --required +; +``` + + diff --git a/website/docs/services/orgs/webhooks/index.md b/website/docs/services/orgs/webhooks/index.md index 56901a0..1d37a96 100644 --- a/website/docs/services/orgs/webhooks/index.md +++ b/website/docs/services/orgs/webhooks/index.md @@ -1,52 +1,502 @@ ---- +--- title: webhooks hide_title: false hide_table_of_contents: false keywords: - webhooks - orgs - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhooks resource. ## Overview - +
Namewebhooks
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `boolean` | -| | `object` | -| | `string` | -| | `string` | -| | `array` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: web)
boolean
object
string (date-time) (example: 2011-09-06T17:26:27Z)
string (uri) (example: https://api.github.com/orgs/octocat/hooks/1/deliveries)
array
string (uri) (example: https://api.github.com/orgs/octocat/hooks/1/pings)
string
string (date-time) (example: 2011-09-06T20:39:23Z)
string (uri) (example: https://api.github.com/orgs/octocat/hooks/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: web)
boolean
object
string (date-time) (example: 2011-09-06T17:26:27Z)
string (uri) (example: https://api.github.com/orgs/octocat/hooks/1/deliveries)
array
string (uri) (example: https://api.github.com/orgs/octocat/hooks/1/pings)
string
string (date-time) (example: 2011-09-06T20:39:23Z)
string (uri) (example: https://api.github.com/orgs/octocat/hooks/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." | -| | `SELECT` | | | -| | `INSERT` | | Here's how you can create a hook that posts payloads in JSON format: | -| | `DELETE` | | | -| | `EXEC` | | This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. | -| | `EXEC` | | Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, hook_idReturns a webhook configured in an organization. To get only the webhook
`config` properties, see "[Get a webhook configuration for an organization](https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
orgper_page, pageList webhooks for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
org, name, configCreate a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
org, hook_idUpdates a webhook configured in an organization. When you update a webhook,
the `secret` will be overwritten. If you previously had a `secret` set, you must
provide the same `secret` or set a new `secret` or the secret will be removed. If
you are only updating individual webhook `config` properties, use "[Update a webhook
configuration for an organization](https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
org, hook_idDelete a webhook for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
org, hook_idThis will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
to be sent to the hook.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe organization name. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Returns a webhook configured in an organization. To get only the webhook
`config` properties, see "[Get a webhook configuration for an organization](https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +SELECT +id, +name, +active, +config, +created_at, +deliveries_url, +events, +ping_url, +type, +updated_at, +url +FROM github.orgs.webhooks +WHERE org = '{{ org }}' -- required +AND hook_id = '{{ hook_id }}' -- required +; +``` + + + +List webhooks for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +SELECT +id, +name, +active, +config, +created_at, +deliveries_url, +events, +ping_url, +type, +updated_at, +url +FROM github.orgs.webhooks +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +INSERT INTO github.orgs.webhooks ( +name, +config, +events, +active, +org +) +SELECT +'{{ name }}' /* required */, +'{{ config }}' /* required */, +'{{ events }}', +{{ active }}, +'{{ org }}' +RETURNING +id, +name, +active, +config, +created_at, +deliveries_url, +events, +ping_url, +type, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: webhooks + props: + - name: org + value: "{{ org }}" + description: Required parameter for the webhooks resource. + - name: name + value: "{{ name }}" + description: | + Must be passed as "web". + - name: config + description: | + Key/value pairs to provide settings for this webhook. + value: + url: "{{ url }}" + content_type: "{{ content_type }}" + secret: "{{ secret }}" + insecure_ssl: "{{ insecure_ssl }}" + username: "{{ username }}" + password: "{{ password }}" + - name: events + value: + - "{{ events }}" + description: | + Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to \`["*"]\` to receive all possible events. + default: push + - name: active + value: {{ active }} + description: | + Determines if notifications are sent when the webhook is triggered. Set to \`true\` to send notifications. + default: true +`} + + + + + +## `UPDATE` examples + + + + +Updates a webhook configured in an organization. When you update a webhook,
the `secret` will be overwritten. If you previously had a `secret` set, you must
provide the same `secret` or set a new `secret` or the secret will be removed. If
you are only updating individual webhook `config` properties, use "[Update a webhook
configuration for an organization](https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +UPDATE github.orgs.webhooks +SET +config = '{{ config }}', +events = '{{ events }}', +active = {{ active }}, +name = '{{ name }}' +WHERE +org = '{{ org }}' --required +AND hook_id = '{{ hook_id }}' --required +RETURNING +id, +name, +active, +config, +created_at, +deliveries_url, +events, +ping_url, +type, +updated_at, +url; +``` + + + + +## `DELETE` examples + + + + +Delete a webhook for an organization.

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +DELETE FROM github.orgs.webhooks +WHERE org = '{{ org }}' --required +AND hook_id = '{{ hook_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
to be sent to the hook.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + +```sql +EXEC github.orgs.webhooks.ping_webhook +@org='{{ org }}' --required, +@hook_id='{{ hook_id }}' --required +; +``` + + diff --git a/website/docs/services/packages/auth_user_packages/index.md b/website/docs/services/packages/auth_user_packages/index.md deleted file mode 100644 index a04fb6c..0000000 --- a/website/docs/services/packages/auth_user_packages/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: auth_user_packages -hide_title: false -hide_table_of_contents: false -keywords: - - auth_user_packages - - packages - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameauth_user_packages
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package. | -| | `string` | The name of the package. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | Minimal Repository | -| | `string` | | -| | `string` | | -| | `integer` | The number of versions of the package. | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific package for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `SELECT` | | Lists packages owned by the authenticated user within the user's namespace.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `DELETE` | | Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.
If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `EXEC` | | Restores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | diff --git a/website/docs/services/packages/auth_user_versions/index.md b/website/docs/services/packages/auth_user_versions/index.md deleted file mode 100644 index 607be2f..0000000 --- a/website/docs/services/packages/auth_user_versions/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: auth_user_versions -hide_title: false -hide_table_of_contents: false -keywords: - - auth_user_versions - - packages - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameauth_user_versions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package version. | -| | `string` | The name of the package version. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists package versions for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `SELECT` | | Gets a specific package version for a package owned by the authenticated user.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `DELETE` | | Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes.
If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `EXEC` | | Restores a package version owned by the authenticated user.

You can restore a deleted package version under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | diff --git a/website/docs/services/packages/docker_migration_packages/index.md b/website/docs/services/packages/docker_migration_packages/index.md index 1c13006..a26208c 100644 --- a/website/docs/services/packages/docker_migration_packages/index.md +++ b/website/docs/services/packages/docker_migration_packages/index.md @@ -1,49 +1,398 @@ ---- +--- title: docker_migration_packages hide_title: false hide_table_of_contents: false keywords: - docker_migration_packages - packages - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a docker_migration_packages resource. ## Overview - +
Namedocker_migration_packages
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package. | -| | `string` | The name of the package. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | Minimal Repository | -| | `string` | | -| | `string` | | -| | `integer` | The number of versions of the package. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.
To use this endpoint, you must authenticate using an access token with the `read:packages` scope. | -| | `SELECT` | | Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.
To use this endpoint, you must authenticate using an access token with the `read:packages` scope. | -| | `SELECT` | | Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.
To use this endpoint, you must authenticate using an access token with the `read:packages` scope. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgLists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
usernameLists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe handle for the GitHub user account.
+ +## `SELECT` examples + + + + +Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.docker_migration_packages +WHERE org = '{{ org }}' -- required +; +``` + + + +Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.docker_migration_packages +WHERE username = '{{ username }}' -- required +; +``` + + + +Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.docker_migration_packages +; +``` + + diff --git a/website/docs/services/packages/index.md b/website/docs/services/packages/index.md index 7a22e1e..0378f63 100644 --- a/website/docs/services/packages/index.md +++ b/website/docs/services/packages/index.md @@ -9,45 +9,26 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Manage Packages For Authenticated Users And Organizations. - -:::info Service Summary +packages service documentation. -
-
-total resources: 7
-total selectable resources: 7
-total methods: 27
-
-
+:::info[Service Summary] -::: +total resources: __3__ -## Overview - - - - - - -
Namegithub.packages
TypeService
TitleGitHub V3 REST API - Packages
DescriptionManage Packages For Authenticated Users And Organizations.
Idpackages:v24.04.00227
+::: ## Resources
-auth_user_packages
-auth_user_versions
docker_migration_packages
-org_packages
+package_versions
-org_versions
-user_packages
-user_versions
-
+packages
+ \ No newline at end of file diff --git a/website/docs/services/packages/org_packages/index.md b/website/docs/services/packages/org_packages/index.md deleted file mode 100644 index fb6ce53..0000000 --- a/website/docs/services/packages/org_packages/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: org_packages -hide_title: false -hide_table_of_contents: false -keywords: - - org_packages - - packages - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_packages
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package. | -| | `string` | The name of the package. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | Minimal Repository | -| | `string` | | -| | `string` | | -| | `integer` | The number of versions of the package. | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific package in an organization.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `SELECT` | | Lists packages in an organization readable by the user.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `DELETE` | | Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | -| | `EXEC` | | Restores an entire package in an organization.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | diff --git a/website/docs/services/packages/org_versions/index.md b/website/docs/services/packages/org_versions/index.md deleted file mode 100644 index 6e907f0..0000000 --- a/website/docs/services/packages/org_versions/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: org_versions -hide_title: false -hide_table_of_contents: false -keywords: - - org_versions - - packages - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_versions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package version. | -| | `string` | The name of the package version. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists package versions for a package owned by an organization.

If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `SELECT` | | Gets a specific package version in an organization.

You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `DELETE` | | Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | -| | `EXEC` | | Restores a specific package version in an organization.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | diff --git a/website/docs/services/packages/package_versions/index.md b/website/docs/services/packages/package_versions/index.md new file mode 100644 index 0000000..25b01c9 --- /dev/null +++ b/website/docs/services/packages/package_versions/index.md @@ -0,0 +1,898 @@ +--- +title: package_versions +hide_title: false +hide_table_of_contents: false +keywords: + - package_versions + - packages + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a package_versions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package version.
stringThe name of the package version. (example: latest)
string (date-time) (example: 2011-04-10T20:09:31Z)
string (date-time) (example: 2014-03-03T18:58:10Z)
string
string (example: https://github.com/orgs/github/packages/container/super-linter/786068)
string (example: MIT)
object (title: Package Version Metadata)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package version.
stringThe name of the package version. (example: latest)
string (date-time) (example: 2011-04-10T20:09:31Z)
string (date-time) (example: 2014-03-03T18:58:10Z)
string
string (example: https://github.com/orgs/github/packages/container/super-linter/786068)
string (example: MIT)
object (title: Package Version Metadata)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package version.
stringThe name of the package version. (example: latest)
string (date-time) (example: 2011-04-10T20:09:31Z)
string (date-time) (example: 2014-03-03T18:58:10Z)
string
string (example: https://github.com/orgs/github/packages/container/super-linter/786068)
string (example: MIT)
object (title: Package Version Metadata)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package version.
stringThe name of the package version. (example: latest)
string (date-time) (example: 2011-04-10T20:09:31Z)
string (date-time) (example: 2014-03-03T18:58:10Z)
string
string (example: https://github.com/orgs/github/packages/container/super-linter/786068)
string (example: MIT)
object (title: Package Version Metadata)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package version.
stringThe name of the package version. (example: latest)
string (date-time) (example: 2011-04-10T20:09:31Z)
string (date-time) (example: 2014-03-03T18:58:10Z)
string
string (example: https://github.com/orgs/github/packages/container/super-linter/786068)
string (example: MIT)
object (title: Package Version Metadata)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package version.
stringThe name of the package version. (example: latest)
string (date-time) (example: 2011-04-10T20:09:31Z)
string (date-time) (example: 2014-03-03T18:58:10Z)
string
string (example: https://github.com/orgs/github/packages/container/super-linter/786068)
string (example: MIT)
object (title: Package Version Metadata)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
string (date-time) (example: 2014-03-03T18:58:10Z)
string (example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
package_type, package_name, org, package_version_idGets a specific package version in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, package_version_id, usernameGets a specific package version for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, orgpage, per_page, stateLists package versions for a package owned by an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, package_version_idGets a specific package version for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, usernameLists package versions for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_namepage, per_page, stateLists package versions for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, org, package_version_idDeletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, username, package_version_idDeletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, package_version_idDeletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, org, package_version_idRestores a specific package version in an organization.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, package_version_idRestores a package version owned by the authenticated user.

You can restore a deleted package version under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, username, package_version_idRestores a specific package version for a user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe name of the package.
stringThe type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.
integerUnique identifier of the package version.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe state of the package, either active or deleted.
+ +## `SELECT` examples + + + + +Gets a specific package version in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +deleted_at, +description, +html_url, +license, +metadata, +package_html_url, +updated_at, +url +FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND org = '{{ org }}' -- required +AND package_version_id = '{{ package_version_id }}' -- required +; +``` + + + +Gets a specific package version for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +deleted_at, +description, +html_url, +license, +metadata, +package_html_url, +updated_at, +url +FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND package_version_id = '{{ package_version_id }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +Lists package versions for a package owned by an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +deleted_at, +description, +html_url, +license, +metadata, +package_html_url, +updated_at, +url +FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND org = '{{ org }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND state = '{{ state }}' +; +``` + + + +Gets a specific package version for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +deleted_at, +description, +html_url, +license, +metadata, +package_html_url, +updated_at, +url +FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND package_version_id = '{{ package_version_id }}' -- required +; +``` + + + +Lists package versions for a public package owned by a specified user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +deleted_at, +description, +html_url, +license, +metadata, +package_html_url, +updated_at, +url +FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +Lists package versions for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +deleted_at, +description, +html_url, +license, +metadata, +package_html_url, +updated_at, +url +FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND state = '{{ state }}' +; +``` + + + + +## `DELETE` examples + + + + +Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +DELETE FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' --required +AND package_name = '{{ package_name }}' --required +AND org = '{{ org }}' --required +AND package_version_id = '{{ package_version_id }}' --required +; +``` + + + +Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +DELETE FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' --required +AND package_name = '{{ package_name }}' --required +AND username = '{{ username }}' --required +AND package_version_id = '{{ package_version_id }}' --required +; +``` + + + +Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +DELETE FROM github.packages.package_versions +WHERE package_type = '{{ package_type }}' --required +AND package_name = '{{ package_name }}' --required +AND package_version_id = '{{ package_version_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Restores a specific package version in an organization.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +EXEC github.packages.package_versions.restore_package_version_for_org +@package_type='{{ package_type }}' --required, +@package_name='{{ package_name }}' --required, +@org='{{ org }}' --required, +@package_version_id='{{ package_version_id }}' --required +; +``` + + + +Restores a package version owned by the authenticated user.

You can restore a deleted package version under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +EXEC github.packages.package_versions.restore_package_version_for_authenticated_user +@package_type='{{ package_type }}' --required, +@package_name='{{ package_name }}' --required, +@package_version_id='{{ package_version_id }}' --required +; +``` + + + +Restores a specific package version for a user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +EXEC github.packages.package_versions.restore_package_version_for_user +@package_type='{{ package_type }}' --required, +@package_name='{{ package_name }}' --required, +@username='{{ username }}' --required, +@package_version_id='{{ package_version_id }}' --required +; +``` + + diff --git a/website/docs/services/packages/packages/index.md b/website/docs/services/packages/packages/index.md new file mode 100644 index 0000000..2c823ca --- /dev/null +++ b/website/docs/services/packages/packages/index.md @@ -0,0 +1,892 @@ +--- +title: packages +hide_title: false +hide_table_of_contents: false +keywords: + - packages + - packages + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a packages resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the package.
stringThe name of the package. (example: super-linter)
string (date-time)
string (example: https://github.com/orgs/github/packages/container/package/super-linter)
objectA GitHub user. (title: Simple User)
string (npm, maven, rubygems, docker, nuget, container) (example: docker)
objectMinimal Repository (title: Minimal Repository)
string (date-time)
string (example: https://api.github.com/orgs/github/packages/container/super-linter)
integerThe number of versions of the package.
string (private, public) (example: private)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
package_type, package_name, orgGets a specific package in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, usernameGets a specific package metadata for a public package owned by a user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_nameGets a specific package for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, orgvisibility, page, per_pageLists packages in an organization readable by the user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, usernamevisibility, page, per_pageLists all packages in a user's namespace for which the requesting user has access.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_typevisibility, page, per_pageLists packages owned by the authenticated user within the user's namespace.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, orgDeletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, usernameDeletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_nameDeletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, orgtokenRestores an entire package in an organization.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_nametokenRestores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
package_type, package_name, usernametokenRestores an entire package for a user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe name of the package.
stringThe type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringpackage token
stringThe selected visibility of the packages. This parameter is optional and only filters an existing result set. The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ +## `SELECT` examples + + + + +Gets a specific package in an organization.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.packages +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND org = '{{ org }}' -- required +; +``` + + + +Gets a specific package metadata for a public package owned by a user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.packages +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +Gets a specific package for a package owned by the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.packages +WHERE package_type = '{{ package_type }}' -- required +AND package_name = '{{ package_name }}' -- required +; +``` + + + +Lists packages in an organization readable by the user.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.packages +WHERE package_type = '{{ package_type }}' -- required +AND org = '{{ org }}' -- required +AND visibility = '{{ visibility }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + +Lists all packages in a user's namespace for which the requesting user has access.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.packages +WHERE package_type = '{{ package_type }}' -- required +AND username = '{{ username }}' -- required +AND visibility = '{{ visibility }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + +Lists packages owned by the authenticated user within the user's namespace.

OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +SELECT +id, +name, +created_at, +html_url, +owner, +package_type, +repository, +updated_at, +url, +version_count, +visibility +FROM github.packages.packages +WHERE package_type = '{{ package_type }}' -- required +AND visibility = '{{ visibility }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `DELETE` examples + + + + +Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +DELETE FROM github.packages.packages +WHERE package_type = '{{ package_type }}' --required +AND package_name = '{{ package_name }}' --required +AND org = '{{ org }}' --required +; +``` + + + +Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +DELETE FROM github.packages.packages +WHERE package_type = '{{ package_type }}' --required +AND package_name = '{{ package_name }}' --required +AND username = '{{ username }}' --required +; +``` + + + +Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +DELETE FROM github.packages.packages +WHERE package_type = '{{ package_type }}' --required +AND package_name = '{{ package_name }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Restores an entire package in an organization.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +EXEC github.packages.packages.restore_package_for_org +@package_type='{{ package_type }}' --required, +@package_name='{{ package_name }}' --required, +@org='{{ org }}' --required, +@token='{{ token }}' +; +``` + + + +Restores a package owned by the authenticated user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +EXEC github.packages.packages.restore_package_for_authenticated_user +@package_type='{{ package_type }}' --required, +@package_name='{{ package_name }}' --required, +@token='{{ token }}' +; +``` + + + +Restores an entire package for a user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."

OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. For more information, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + +```sql +EXEC github.packages.packages.restore_package_for_user +@package_type='{{ package_type }}' --required, +@package_name='{{ package_name }}' --required, +@username='{{ username }}' --required, +@token='{{ token }}' +; +``` + + diff --git a/website/docs/services/packages/user_packages/index.md b/website/docs/services/packages/user_packages/index.md deleted file mode 100644 index b6f9e2b..0000000 --- a/website/docs/services/packages/user_packages/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: user_packages -hide_title: false -hide_table_of_contents: false -keywords: - - user_packages - - packages - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameuser_packages
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package. | -| | `string` | The name of the package. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | Minimal Repository | -| | `string` | | -| | `string` | | -| | `integer` | The number of versions of the package. | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a specific package metadata for a public package owned by a user.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `SELECT` | | Lists all packages in a user's namespace for which the requesting user has access.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `DELETE` | | Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | -| | `EXEC` | | Restores an entire package for a user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | diff --git a/website/docs/services/packages/user_versions/index.md b/website/docs/services/packages/user_versions/index.md deleted file mode 100644 index b94a0a9..0000000 --- a/website/docs/services/packages/user_versions/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: user_versions -hide_title: false -hide_table_of_contents: false -keywords: - - user_versions - - packages - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameuser_versions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the package version. | -| | `string` | The name of the package version. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists package versions for a public package owned by a specified user.

To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `SELECT` | | Gets a specific package version for a public package owned by a specified user.

At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." | -| | `DELETE` | | Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | -| | `EXEC` | | Restores a specific package version for a user.

You can restore a deleted package under the following conditions:
- The package was deleted within the last 30 days.
- The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.

To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." | diff --git a/website/docs/services/private_registries/index.md b/website/docs/services/private_registries/index.md new file mode 100644 index 0000000..4376174 --- /dev/null +++ b/website/docs/services/private_registries/index.md @@ -0,0 +1,33 @@ +--- +title: private_registries +hide_title: false +hide_table_of_contents: false +keywords: + - private_registries + - github + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +private_registries service documentation. + +:::info[Service Summary] + +total resources: __2__ + +::: + +## Resources +
+
+private_registries +
+
+private_registry_public_key +
+
\ No newline at end of file diff --git a/website/docs/services/private_registries/private_registries/index.md b/website/docs/services/private_registries/private_registries/index.md new file mode 100644 index 0000000..f017a7b --- /dev/null +++ b/website/docs/services/private_registries/private_registries/index.md @@ -0,0 +1,565 @@ +--- +title: private_registries +hide_title: false +hide_table_of_contents: false +keywords: + - private_registries + - private_registries + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a private_registries resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +The specified private registry configuration for the organization + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the private registry configuration. (example: MAVEN_REPOSITORY_SECRET)
stringThe AWS account ID.
stringThe client ID of the Azure AD application.
stringThe tenant ID of the Azure AD application.
stringThe JFrog identity mapping name.
stringThe JFrog OIDC provider name.
stringThe AWS IAM role name.
stringThe OIDC audience.
stringThe authentication type for the private registry. (token, username_password, oidc_azure, oidc_aws, oidc_jfrog)
stringThe AWS region.
string (date-time)
stringThe CodeArtifact domain.
stringThe CodeArtifact domain owner.
stringThe registry type. (maven_repository, nuget_feed, goproxy_server, npm_registry, rubygems_server, cargo_registry, composer_repository, docker_registry, git_source, helm_registry, hex_organization, hex_repository, pub_repository, python_index, terraform_registry)
booleanWhether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.
string (date-time)
string (uri)The URL of the private registry.
stringThe username to use when authenticating with the private registry. (example: monalisa)
stringWhich type of organization repositories have access to the private registry. (all, private, selected)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, secret_name
Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
orgper_page, page
Lists all private registry configurations available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, registry_type, url, visibility
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
org, secret_name
Delete a private registry configuration at the organization-level.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe name of the secret.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +
Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +name, +account_id, +client_id, +tenant_id, +identity_mapping_name, +jfrog_oidc_provider_name, +role_name, +audience, +auth_type, +aws_region, +created_at, +domain, +domain_owner, +registry_type, +replaces_base, +updated_at, +url, +username, +visibility +FROM github.private_registries.private_registries +WHERE org = '{{ org }}' -- required +AND secret_name = '{{ secret_name }}' -- required +; +``` + + + +
Lists all private registry configurations available at the organization-level without revealing their encrypted
values.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +configurations, +total_count +FROM github.private_registries.private_registries +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +INSERT INTO github.private_registries.private_registries ( +registry_type, +url, +username, +replaces_base, +encrypted_value, +key_id, +visibility, +selected_repository_ids, +auth_type, +tenant_id, +client_id, +aws_region, +account_id, +role_name, +domain, +domain_owner, +jfrog_oidc_provider_name, +audience, +identity_mapping_name, +org +) +SELECT +'{{ registry_type }}' /* required */, +'{{ url }}' /* required */, +'{{ username }}', +{{ replaces_base }}, +'{{ encrypted_value }}', +'{{ key_id }}', +'{{ visibility }}' /* required */, +'{{ selected_repository_ids }}', +'{{ auth_type }}', +'{{ tenant_id }}', +'{{ client_id }}', +'{{ aws_region }}', +'{{ account_id }}', +'{{ role_name }}', +'{{ domain }}', +'{{ domain_owner }}', +'{{ jfrog_oidc_provider_name }}', +'{{ audience }}', +'{{ identity_mapping_name }}', +'{{ org }}' +RETURNING +name, +account_id, +client_id, +tenant_id, +identity_mapping_name, +jfrog_oidc_provider_name, +role_name, +audience, +auth_type, +aws_region, +created_at, +domain, +domain_owner, +registry_type, +replaces_base, +selected_repository_ids, +updated_at, +url, +username, +visibility +; +``` + + + +{`# Description fields are for documentation purposes +- name: private_registries + props: + - name: org + value: "{{ org }}" + description: Required parameter for the private_registries resource. + - name: registry_type + value: "{{ registry_type }}" + description: | + The registry type. + valid_values: ['maven_repository', 'nuget_feed', 'goproxy_server', 'npm_registry', 'rubygems_server', 'cargo_registry', 'composer_repository', 'docker_registry', 'git_source', 'helm_registry', 'hex_organization', 'hex_repository', 'pub_repository', 'python_index', 'terraform_registry'] + - name: url + value: "{{ url }}" + description: | + The URL of the private registry. + - name: username + value: "{{ username }}" + description: | + The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. + - name: replaces_base + value: {{ replaces_base }} + description: | + Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to \`true\`, Dependabot will only use this registry and will not fall back to the public registry. When set to \`false\` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + default: false + - name: encrypted_value + value: "{{ encrypted_value }}" + description: | + The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. Required when \`auth_type\` is \`token\` or \`username_password\`. Should be omitted for OIDC auth types. + - name: key_id + value: "{{ key_id }}" + description: | + The ID of the key you used to encrypt the secret. Required when \`auth_type\` is \`token\` or \`username_password\`. Should be omitted for OIDC auth types. + - name: visibility + value: "{{ visibility }}" + description: | + Which type of organization repositories have access to the private registry. \`selected\` means only the repositories specified by \`selected_repository_ids\` can access the private registry. + valid_values: ['all', 'private', 'selected'] + - name: selected_repository_ids + value: + - {{ selected_repository_ids }} + description: | + An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when \`visibility\` is set to \`selected\`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if \`visibility\` is set to \`all\` or \`private\`. + - name: auth_type + value: "{{ auth_type }}" + description: | + The authentication type for the private registry. Defaults to \`token\` if not specified. Use \`oidc_azure\`, \`oidc_aws\`, or \`oidc_jfrog\` for OIDC authentication. + valid_values: ['token', 'username_password', 'oidc_azure', 'oidc_aws', 'oidc_jfrog'] + - name: tenant_id + value: "{{ tenant_id }}" + description: | + The tenant ID of the Azure AD application. Required when \`auth_type\` is \`oidc_azure\`. + - name: client_id + value: "{{ client_id }}" + description: | + The client ID of the Azure AD application. Required when \`auth_type\` is \`oidc_azure\`. + - name: aws_region + value: "{{ aws_region }}" + description: | + The AWS region. Required when \`auth_type\` is \`oidc_aws\`. + - name: account_id + value: "{{ account_id }}" + description: | + The AWS account ID. Required when \`auth_type\` is \`oidc_aws\`. + - name: role_name + value: "{{ role_name }}" + description: | + The AWS IAM role name. Required when \`auth_type\` is \`oidc_aws\`. + - name: domain + value: "{{ domain }}" + description: | + The CodeArtifact domain. Required when \`auth_type\` is \`oidc_aws\`. + - name: domain_owner + value: "{{ domain_owner }}" + description: | + The CodeArtifact domain owner (AWS account ID). Required when \`auth_type\` is \`oidc_aws\`. + - name: jfrog_oidc_provider_name + value: "{{ jfrog_oidc_provider_name }}" + description: | + The JFrog OIDC provider name. Required when \`auth_type\` is \`oidc_jfrog\`. + - name: audience + value: "{{ audience }}" + description: | + The OIDC audience. Optional for \`oidc_aws\` and \`oidc_jfrog\` auth types. + - name: identity_mapping_name + value: "{{ identity_mapping_name }}" + description: | + The JFrog identity mapping name. Optional for \`oidc_jfrog\` auth type. +`} + + + + + +## `UPDATE` examples + + + + +
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
For OIDC-based registries (`oidc_azure`, `oidc_aws`, or `oidc_jfrog`), the `encrypted_value` and `key_id` fields should be omitted.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +UPDATE github.private_registries.private_registries +SET +registry_type = '{{ registry_type }}', +url = '{{ url }}', +username = '{{ username }}', +replaces_base = {{ replaces_base }}, +encrypted_value = '{{ encrypted_value }}', +key_id = '{{ key_id }}', +visibility = '{{ visibility }}', +selected_repository_ids = '{{ selected_repository_ids }}', +auth_type = '{{ auth_type }}', +tenant_id = '{{ tenant_id }}', +client_id = '{{ client_id }}', +aws_region = '{{ aws_region }}', +account_id = '{{ account_id }}', +role_name = '{{ role_name }}', +domain = '{{ domain }}', +domain_owner = '{{ domain_owner }}', +jfrog_oidc_provider_name = '{{ jfrog_oidc_provider_name }}', +audience = '{{ audience }}', +identity_mapping_name = '{{ identity_mapping_name }}' +WHERE +org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required; +``` + + + + +## `DELETE` examples + + + + +
Delete a private registry configuration at the organization-level.

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +DELETE FROM github.private_registries.private_registries +WHERE org = '{{ org }}' --required +AND secret_name = '{{ secret_name }}' --required +; +``` + + diff --git a/website/docs/services/private_registries/private_registry_public_key/index.md b/website/docs/services/private_registries/private_registry_public_key/index.md new file mode 100644 index 0000000..03b03ee --- /dev/null +++ b/website/docs/services/private_registries/private_registry_public_key/index.md @@ -0,0 +1,136 @@ +--- +title: private_registry_public_key +hide_title: false +hide_table_of_contents: false +keywords: + - private_registry_public_key + - private_registries + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a private_registry_public_key resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe identifier for the key. (example: 012345678912345678)
stringThe Base64 encoded public key. (example: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +
Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + +```sql +SELECT +key_id, +key +FROM github.private_registries.private_registry_public_key +WHERE org = '{{ org }}' -- required +; +``` + + diff --git a/website/docs/services/projects/cards/index.md b/website/docs/services/projects/cards/index.md deleted file mode 100644 index f28a3e0..0000000 --- a/website/docs/services/projects/cards/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: cards -hide_title: false -hide_table_of_contents: false -keywords: - - cards - - projects - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecards
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The project card's ID | -| | `boolean` | Whether or not the card is archived | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a project card. | -| | `SELECT` | | Lists the project cards in a project. | -| | `INSERT` | | | -| | `DELETE` | | Deletes a project card | -| | `EXEC` | | | -| | `EXEC` | | | diff --git a/website/docs/services/projects/collaborators/index.md b/website/docs/services/projects/collaborators/index.md deleted file mode 100644 index 658601d..0000000 --- a/website/docs/services/projects/collaborators/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: collaborators -hide_title: false -hide_table_of_contents: false -keywords: - - collaborators - - projects - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecollaborators
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | A GitHub user. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. | -| | `SELECT` | | Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. | -| | `DELETE` | | Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. | -| | `EXEC` | | Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. | diff --git a/website/docs/services/projects/columns/index.md b/website/docs/services/projects/columns/index.md deleted file mode 100644 index 96c40f1..0000000 --- a/website/docs/services/projects/columns/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: columns -hide_title: false -hide_table_of_contents: false -keywords: - - columns - - projects - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namecolumns
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The unique identifier of the project column | -| | `string` | Name of the project column | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a project column. | -| | `SELECT` | | Lists the project columns in a project. | -| | `INSERT` | | Creates a new project column. | -| | `DELETE` | | Deletes a project column. | -| | `EXEC` | | | -| | `EXEC` | | | diff --git a/website/docs/services/projects/index.md b/website/docs/services/projects/index.md index efb3c8d..5fd2fee 100644 --- a/website/docs/services/projects/index.md +++ b/website/docs/services/projects/index.md @@ -9,42 +9,29 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With GitHub Projects. - -:::info Service Summary +projects service documentation. -
-
-total resources: 4
-total selectable resources: 4
-total methods: 25
-
-
+:::info[Service Summary] -::: +total resources: __6__ -## Overview - - - - - - -
Namegithub.projects
TypeService
TitleGitHub V3 REST API - Projects
DescriptionInteract With GitHub Projects.
Idprojects:v24.04.00227
+::: ## Resources
-cards
-collaborators
+project_draft_items
+project_fields
+project_items
-columns
-projects
-
+project_view_items
+project_views
+projects
+ \ No newline at end of file diff --git a/website/docs/services/projects/project_draft_items/index.md b/website/docs/services/projects/project_draft_items/index.md new file mode 100644 index 0000000..0c0ef53 --- /dev/null +++ b/website/docs/services/projects/project_draft_items/index.md @@ -0,0 +1,150 @@ +--- +title: project_draft_items +hide_title: false +hide_table_of_contents: false +keywords: + - project_draft_items + - projects + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a project_draft_items resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, project_number, titleCreate draft issue item for the specified organization owned project.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe project's number.
+ +## `INSERT` examples + + + + +Create draft issue item for the specified organization owned project. + +```sql +INSERT INTO github.projects.project_draft_items ( +title, +body, +org, +project_number +) +SELECT +'{{ title }}' /* required */, +'{{ body }}', +'{{ org }}', +'{{ project_number }}' +RETURNING +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +item_url, +project_url, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: project_draft_items + props: + - name: org + value: "{{ org }}" + description: Required parameter for the project_draft_items resource. + - name: project_number + value: {{ project_number }} + description: Required parameter for the project_draft_items resource. + - name: title + value: "{{ title }}" + description: | + The title of the draft issue item to create in the project. + - name: body + value: "{{ body }}" + description: | + The body content of the draft issue item to create in the project. +`} + + + diff --git a/website/docs/services/projects/project_fields/index.md b/website/docs/services/projects/project_fields/index.md new file mode 100644 index 0000000..d6ce96c --- /dev/null +++ b/website/docs/services/projects/project_fields/index.md @@ -0,0 +1,658 @@ +--- +title: project_fields +hide_title: false +hide_table_of_contents: false +keywords: + - project_fields + - projects + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a project_fields resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the field.
stringThe name of the field.
integerThe ID of the issue field.
stringThe node ID of the field.
objectConfiguration for iteration fields.
string (date-time)The time when the field was created. (example: 2022-04-28T12:00:00Z)
stringThe field's data type. (assignees, linked_pull_requests, reviewers, labels, milestone, repository, title, text, single_select, number, date, iteration, issue_type, parent_issue, sub_issues_progress)
arrayThe options available for single select fields.
stringThe API URL of the project that contains the field. (example: https://api.github.com/projects/1)
string (date-time)The time when the field was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the field.
stringThe name of the field.
integerThe ID of the issue field.
stringThe node ID of the field.
objectConfiguration for iteration fields.
string (date-time)The time when the field was created. (example: 2022-04-28T12:00:00Z)
stringThe field's data type. (assignees, linked_pull_requests, reviewers, labels, milestone, repository, title, text, single_select, number, date, iteration, issue_type, parent_issue, sub_issues_progress)
arrayThe options available for single select fields.
stringThe API URL of the project that contains the field. (example: https://api.github.com/projects/1)
string (date-time)The time when the field was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the field.
stringThe name of the field.
integerThe ID of the issue field.
stringThe node ID of the field.
objectConfiguration for iteration fields.
string (date-time)The time when the field was created. (example: 2022-04-28T12:00:00Z)
stringThe field's data type. (assignees, linked_pull_requests, reviewers, labels, milestone, repository, title, text, single_select, number, date, iteration, issue_type, parent_issue, sub_issues_progress)
arrayThe options available for single select fields.
stringThe API URL of the project that contains the field. (example: https://api.github.com/projects/1)
string (date-time)The time when the field was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the field.
stringThe name of the field.
integerThe ID of the issue field.
stringThe node ID of the field.
objectConfiguration for iteration fields.
string (date-time)The time when the field was created. (example: 2022-04-28T12:00:00Z)
stringThe field's data type. (assignees, linked_pull_requests, reviewers, labels, milestone, repository, title, text, single_select, number, date, iteration, issue_type, parent_issue, sub_issues_progress)
arrayThe options available for single select fields.
stringThe API URL of the project that contains the field. (example: https://api.github.com/projects/1)
string (date-time)The time when the field was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
project_number, field_id, orgGet a specific field for an organization-owned project.
project_number, field_id, usernameGet a specific field for a user-owned project.
project_number, orgper_page, before, afterList all fields for a specific organization-owned project.
project_number, usernameper_page, before, afterList all fields for a specific user-owned project.
project_number, org, issue_field_id, name, data_type, single_select_options, iteration_configurationAdd a field to an organization-owned project.
username, project_number, name, data_type, single_select_options, iteration_configurationAdd a field to a specified user owned project.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the field.
stringThe organization name. The name is not case sensitive.
integerThe project's number.
stringThe handle for the GitHub user account.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Get a specific field for an organization-owned project. + +```sql +SELECT +id, +name, +issue_field_id, +node_id, +configuration, +created_at, +data_type, +options, +project_url, +updated_at +FROM github.projects.project_fields +WHERE project_number = '{{ project_number }}' -- required +AND field_id = '{{ field_id }}' -- required +AND org = '{{ org }}' -- required +; +``` + + + +Get a specific field for a user-owned project. + +```sql +SELECT +id, +name, +issue_field_id, +node_id, +configuration, +created_at, +data_type, +options, +project_url, +updated_at +FROM github.projects.project_fields +WHERE project_number = '{{ project_number }}' -- required +AND field_id = '{{ field_id }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +List all fields for a specific organization-owned project. + +```sql +SELECT +id, +name, +issue_field_id, +node_id, +configuration, +created_at, +data_type, +options, +project_url, +updated_at +FROM github.projects.project_fields +WHERE project_number = '{{ project_number }}' -- required +AND org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +; +``` + + + +List all fields for a specific user-owned project. + +```sql +SELECT +id, +name, +issue_field_id, +node_id, +configuration, +created_at, +data_type, +options, +project_url, +updated_at +FROM github.projects.project_fields +WHERE project_number = '{{ project_number }}' -- required +AND username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +; +``` + + + + +## `INSERT` examples + + + + +Add a field to an organization-owned project. + +```sql +INSERT INTO github.projects.project_fields ( +issue_field_id, +name, +data_type, +single_select_options, +iteration_configuration, +project_number, +org +) +SELECT +{{ issue_field_id }} /* required */, +'{{ name }}' /* required */, +'{{ data_type }}' /* required */, +'{{ single_select_options }}' /* required */, +'{{ iteration_configuration }}' /* required */, +'{{ project_number }}', +'{{ org }}' +RETURNING +id, +name, +issue_field_id, +node_id, +configuration, +created_at, +data_type, +options, +project_url, +updated_at +; +``` + + + +Add a field to a specified user owned project. + +```sql +INSERT INTO github.projects.project_fields ( +name, +data_type, +single_select_options, +iteration_configuration, +username, +project_number +) +SELECT +'{{ name }}' /* required */, +'{{ data_type }}' /* required */, +'{{ single_select_options }}' /* required */, +'{{ iteration_configuration }}' /* required */, +'{{ username }}', +'{{ project_number }}' +RETURNING +id, +name, +issue_field_id, +node_id, +configuration, +created_at, +data_type, +options, +project_url, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: project_fields + props: + - name: project_number + value: {{ project_number }} + description: Required parameter for the project_fields resource. + - name: org + value: "{{ org }}" + description: Required parameter for the project_fields resource. + - name: username + value: "{{ username }}" + description: Required parameter for the project_fields resource. + - name: issue_field_id + value: {{ issue_field_id }} + description: | + The ID of the IssueField to create the field for. + - name: name + value: "{{ name }}" + description: | + The name of the field. + - name: data_type + value: "{{ data_type }}" + description: | + The field's data type. + valid_values: ['text', 'number', 'date'] + - name: single_select_options + description: | + The options available for single select fields. At least one option must be provided when creating a single select field. + value: + - name: "{{ name }}" + color: "{{ color }}" + description: "{{ description }}" + - name: iteration_configuration + description: | + The configuration for iteration fields. + value: + start_date: "{{ start_date }}" + duration: {{ duration }} + iterations: + - title: "{{ title }}" + start_date: "{{ start_date }}" + duration: {{ duration }} +`} + + + diff --git a/website/docs/services/projects/project_items/index.md b/website/docs/services/projects/project_items/index.md new file mode 100644 index 0000000..ec3cb8b --- /dev/null +++ b/website/docs/services/projects/project_items/index.md @@ -0,0 +1,875 @@ +--- +title: project_items +hide_title: false +hide_table_of_contents: false +keywords: + - project_items + - projects + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a project_items resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project item.
stringThe node ID of the project item.
string (date-time)The time when the item was archived. (example: 2022-04-28T12:00:00Z)
objectThe content of the item, which varies by content type.
stringThe type of content tracked in a project item (Issue, PullRequest, DraftIssue) (title: Projects v2 Item Content Type)
string (date-time)The time when the item was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
arrayThe fields and values associated with this item.
string (uri)The API URL of this item. (example: https://api.github.com/users/monalisa/2/projectsV2/items/3)
string (uri)The API URL of the project that contains this item. (example: https://api.github.com/users/monalisa/2/projectsV2/3)
string (date-time)The time when the item was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project item.
stringThe node ID of the project item.
string (date-time)The time when the item was archived. (example: 2022-04-28T12:00:00Z)
objectThe content of the item, which varies by content type.
stringThe type of content tracked in a project item (Issue, PullRequest, DraftIssue) (title: Projects v2 Item Content Type)
string (date-time)The time when the item was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
arrayThe fields and values associated with this item.
string (uri)The API URL of this item. (example: https://api.github.com/users/monalisa/2/projectsV2/items/3)
string (uri)The API URL of the project that contains this item. (example: https://api.github.com/users/monalisa/2/projectsV2/3)
string (date-time)The time when the item was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project item.
stringThe node ID of the project item.
string (date-time)The time when the item was archived. (example: 2022-04-28T12:00:00Z)
objectThe content of the item, which varies by content type.
stringThe type of content tracked in a project item (Issue, PullRequest, DraftIssue) (title: Projects v2 Item Content Type)
string (date-time)The time when the item was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
arrayThe fields and values associated with this item.
string (uri)The API URL of this item. (example: https://api.github.com/users/monalisa/2/projectsV2/items/3)
string (uri)The API URL of the project that contains this item. (example: https://api.github.com/users/monalisa/2/projectsV2/3)
string (date-time)The time when the item was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project item.
stringThe node ID of the project item.
string (date-time)The time when the item was archived. (example: 2022-04-28T12:00:00Z)
objectThe content of the item, which varies by content type.
stringThe type of content tracked in a project item (Issue, PullRequest, DraftIssue) (title: Projects v2 Item Content Type)
string (date-time)The time when the item was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
arrayThe fields and values associated with this item.
string (uri)The API URL of this item. (example: https://api.github.com/users/monalisa/2/projectsV2/items/3)
string (uri)The API URL of the project that contains this item. (example: https://api.github.com/users/monalisa/2/projectsV2/3)
string (date-time)The time when the item was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
project_number, org, item_idfieldsGet a specific item from an organization-owned project.
project_number, username, item_idfieldsGet a specific item from a user-owned project.
project_number, orgq, fields, before, after, per_pageList all items for a specific organization-owned project accessible by the authenticated user.
project_number, usernamebefore, after, per_page, q, fieldsList all items for a specific user-owned project accessible by the authenticated user.
org, project_number, type, id, owner, repo, numberAdd an issue or pull request item to the specified organization owned project.
user_id, project_number, titleCreate draft issue item for the specified user owned project.
username, project_number, type, id, owner, repo, numberAdd an issue or pull request item to the specified user owned project.
project_number, org, item_id, fieldsUpdate a specific item in an organization-owned project.
project_number, username, item_id, fieldsUpdate a specific item in a user-owned project.
project_number, org, item_idDelete a specific item from an organization-owned project.
project_number, username, item_idDelete a specific item from a user-owned project.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the project item.
stringThe organization name. The name is not case sensitive.
integerThe project's number.
stringThe unique identifier of the user.
stringThe handle for the GitHub user account.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringSearch query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.
+ +## `SELECT` examples + + + + +Get a specific item from an organization-owned project. + +```sql +SELECT +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at +FROM github.projects.project_items +WHERE project_number = '{{ project_number }}' -- required +AND org = '{{ org }}' -- required +AND item_id = '{{ item_id }}' -- required +AND fields = '{{ fields }}' +; +``` + + + +Get a specific item from a user-owned project. + +```sql +SELECT +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at +FROM github.projects.project_items +WHERE project_number = '{{ project_number }}' -- required +AND username = '{{ username }}' -- required +AND item_id = '{{ item_id }}' -- required +AND fields = '{{ fields }}' +; +``` + + + +List all items for a specific organization-owned project accessible by the authenticated user. + +```sql +SELECT +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at +FROM github.projects.project_items +WHERE project_number = '{{ project_number }}' -- required +AND org = '{{ org }}' -- required +AND q = '{{ q }}' +AND fields = '{{ fields }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + + +List all items for a specific user-owned project accessible by the authenticated user. + +```sql +SELECT +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at +FROM github.projects.project_items +WHERE project_number = '{{ project_number }}' -- required +AND username = '{{ username }}' -- required +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +AND q = '{{ q }}' +AND fields = '{{ fields }}' +; +``` + + + + +## `INSERT` examples + + + + +Add an issue or pull request item to the specified organization owned project. + +```sql +INSERT INTO github.projects.project_items ( +type, +id, +owner, +repo, +number, +org, +project_number +) +SELECT +'{{ type }}' /* required */, +{{ id }} /* required */, +'{{ owner }}' /* required */, +'{{ repo }}' /* required */, +{{ number }} /* required */, +'{{ org }}', +'{{ project_number }}' +RETURNING +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +item_url, +project_url, +updated_at +; +``` + + + +Create draft issue item for the specified user owned project. + +```sql +INSERT INTO github.projects.project_items ( +title, +body, +user_id, +project_number +) +SELECT +'{{ title }}' /* required */, +'{{ body }}', +'{{ user_id }}', +'{{ project_number }}' +RETURNING +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +item_url, +project_url, +updated_at +; +``` + + + +Add an issue or pull request item to the specified user owned project. + +```sql +INSERT INTO github.projects.project_items ( +type, +id, +owner, +repo, +number, +username, +project_number +) +SELECT +'{{ type }}' /* required */, +{{ id }} /* required */, +'{{ owner }}' /* required */, +'{{ repo }}' /* required */, +{{ number }} /* required */, +'{{ username }}', +'{{ project_number }}' +RETURNING +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +item_url, +project_url, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: project_items + props: + - name: org + value: "{{ org }}" + description: Required parameter for the project_items resource. + - name: project_number + value: {{ project_number }} + description: Required parameter for the project_items resource. + - name: user_id + value: "{{ user_id }}" + description: Required parameter for the project_items resource. + - name: username + value: "{{ username }}" + description: Required parameter for the project_items resource. + - name: type + value: "{{ type }}" + description: | + The type of item to add to the project. Must be either Issue or PullRequest. + valid_values: ['Issue', 'PullRequest'] + - name: id + value: {{ id }} + description: | + The unique identifier of the issue or pull request to add to the project. + - name: owner + value: "{{ owner }}" + description: | + The repository owner login. + - name: repo + value: "{{ repo }}" + description: | + The repository name. + - name: number + value: {{ number }} + description: | + The issue or pull request number. + - name: title + value: "{{ title }}" + description: | + The title of the draft issue item to create in the project. + - name: body + value: "{{ body }}" + description: | + The body content of the draft issue item to create in the project. +`} + + + + + +## `UPDATE` examples + + + + +Update a specific item in an organization-owned project. + +```sql +UPDATE github.projects.project_items +SET +fields = '{{ fields }}' +WHERE +project_number = '{{ project_number }}' --required +AND org = '{{ org }}' --required +AND item_id = '{{ item_id }}' --required +AND fields = '{{ fields }}' --required +RETURNING +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at; +``` + + + +Update a specific item in a user-owned project. + +```sql +UPDATE github.projects.project_items +SET +fields = '{{ fields }}' +WHERE +project_number = '{{ project_number }}' --required +AND username = '{{ username }}' --required +AND item_id = '{{ item_id }}' --required +AND fields = '{{ fields }}' --required +RETURNING +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at; +``` + + + + +## `DELETE` examples + + + + +Delete a specific item from an organization-owned project. + +```sql +DELETE FROM github.projects.project_items +WHERE project_number = '{{ project_number }}' --required +AND org = '{{ org }}' --required +AND item_id = '{{ item_id }}' --required +; +``` + + + +Delete a specific item from a user-owned project. + +```sql +DELETE FROM github.projects.project_items +WHERE project_number = '{{ project_number }}' --required +AND username = '{{ username }}' --required +AND item_id = '{{ item_id }}' --required +; +``` + + diff --git a/website/docs/services/projects/project_view_items/index.md b/website/docs/services/projects/project_view_items/index.md new file mode 100644 index 0000000..9328777 --- /dev/null +++ b/website/docs/services/projects/project_view_items/index.md @@ -0,0 +1,339 @@ +--- +title: project_view_items +hide_title: false +hide_table_of_contents: false +keywords: + - project_view_items + - projects + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a project_view_items resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project item.
stringThe node ID of the project item.
string (date-time)The time when the item was archived. (example: 2022-04-28T12:00:00Z)
objectThe content of the item, which varies by content type.
stringThe type of content tracked in a project item (Issue, PullRequest, DraftIssue) (title: Projects v2 Item Content Type)
string (date-time)The time when the item was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
arrayThe fields and values associated with this item.
string (uri)The API URL of this item. (example: https://api.github.com/users/monalisa/2/projectsV2/items/3)
string (uri)The API URL of the project that contains this item. (example: https://api.github.com/users/monalisa/2/projectsV2/3)
string (date-time)The time when the item was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project item.
stringThe node ID of the project item.
string (date-time)The time when the item was archived. (example: 2022-04-28T12:00:00Z)
objectThe content of the item, which varies by content type.
stringThe type of content tracked in a project item (Issue, PullRequest, DraftIssue) (title: Projects v2 Item Content Type)
string (date-time)The time when the item was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
arrayThe fields and values associated with this item.
string (uri)The API URL of this item. (example: https://api.github.com/users/monalisa/2/projectsV2/items/3)
string (uri)The API URL of the project that contains this item. (example: https://api.github.com/users/monalisa/2/projectsV2/3)
string (date-time)The time when the item was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
project_number, org, view_numberfields, before, after, per_pageList items in an organization project with the saved view's filter applied.
project_number, username, view_numberfields, before, after, per_pageList items in a user project with the saved view's filter applied.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe project's number.
stringThe handle for the GitHub user account.
integerThe number that identifies the project view.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List items in an organization project with the saved view's filter applied. + +```sql +SELECT +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at +FROM github.projects.project_view_items +WHERE project_number = '{{ project_number }}' -- required +AND org = '{{ org }}' -- required +AND view_number = '{{ view_number }}' -- required +AND fields = '{{ fields }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + + +List items in a user project with the saved view's filter applied. + +```sql +SELECT +id, +node_id, +archived_at, +content, +content_type, +created_at, +creator, +fields, +item_url, +project_url, +updated_at +FROM github.projects.project_view_items +WHERE project_number = '{{ project_number }}' -- required +AND username = '{{ username }}' -- required +AND view_number = '{{ view_number }}' -- required +AND fields = '{{ fields }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/projects/project_views/index.md b/website/docs/services/projects/project_views/index.md new file mode 100644 index 0000000..064943f --- /dev/null +++ b/website/docs/services/projects/project_views/index.md @@ -0,0 +1,225 @@ +--- +title: project_views +hide_title: false +hide_table_of_contents: false +keywords: + - project_views + - projects + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a project_views resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, project_number, name, layoutCreate a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.
user_id, project_number, name, layoutCreate a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe project's number.
stringThe unique identifier of the user.
+ +## `INSERT` examples + + + + +Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + +```sql +INSERT INTO github.projects.project_views ( +name, +layout, +filter, +visible_fields, +org, +project_number +) +SELECT +'{{ name }}' /* required */, +'{{ layout }}' /* required */, +'{{ filter }}', +'{{ visible_fields }}', +'{{ org }}', +'{{ project_number }}' +RETURNING +id, +name, +node_id, +created_at, +creator, +filter, +group_by, +html_url, +layout, +number, +project_url, +sort_by, +updated_at, +vertical_group_by, +visible_fields +; +``` + + + +Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + +```sql +INSERT INTO github.projects.project_views ( +name, +layout, +filter, +visible_fields, +user_id, +project_number +) +SELECT +'{{ name }}' /* required */, +'{{ layout }}' /* required */, +'{{ filter }}', +'{{ visible_fields }}', +'{{ user_id }}', +'{{ project_number }}' +RETURNING +id, +name, +node_id, +created_at, +creator, +filter, +group_by, +html_url, +layout, +number, +project_url, +sort_by, +updated_at, +vertical_group_by, +visible_fields +; +``` + + + +{`# Description fields are for documentation purposes +- name: project_views + props: + - name: org + value: "{{ org }}" + description: Required parameter for the project_views resource. + - name: project_number + value: {{ project_number }} + description: Required parameter for the project_views resource. + - name: user_id + value: "{{ user_id }}" + description: Required parameter for the project_views resource. + - name: name + value: "{{ name }}" + description: | + The name of the view. + - name: layout + value: "{{ layout }}" + description: | + The layout of the view. + valid_values: ['table', 'board', 'roadmap'] + - name: filter + value: "{{ filter }}" + description: | + The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + - name: visible_fields + value: + - {{ visible_fields }} + description: | + \`visible_fields\` is not applicable to \`roadmap\` layout views. + For \`table\` and \`board\` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. +`} + + + diff --git a/website/docs/services/projects/projects/index.md b/website/docs/services/projects/projects/index.md index 673e1a7..31c9c78 100644 --- a/website/docs/services/projects/projects/index.md +++ b/website/docs/services/projects/projects/index.md @@ -1,59 +1,680 @@ ---- +--- title: projects hide_title: false hide_table_of_contents: false keywords: - projects - projects - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a projects resource. ## Overview - +
Nameprojects
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | Name of the project | -| | `string` | Body of the project | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | The baseline permission that all organization members have on this project. Only present if owner is an organization. | -| | `string` | | -| | `boolean` | Whether or not this project can be seen by everyone. Only present if owner is an organization. | -| | `string` | State of the project; either 'open' or 'closed' | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project.
stringThe node ID of the project.
string (date-time)The time when the project was closed. (example: 2022-04-28T12:00:00Z)
string (date-time)The time when the project was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
string (date-time)The time when the project was deleted. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
stringA short description of the project.
booleanWhether this project is a template
objectAn status update belonging to a project (title: Projects v2 Status Update)
integerThe project number.
objectA GitHub user. (title: Simple User)
booleanWhether the project is visible to anyone with access to the owner.
stringA concise summary of the project.
stringThe current state of the project. (open, closed)
stringThe project title.
string (date-time)The time when the project was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project.
stringThe node ID of the project.
string (date-time)The time when the project was closed. (example: 2022-04-28T12:00:00Z)
string (date-time)The time when the project was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
string (date-time)The time when the project was deleted. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
stringA short description of the project.
booleanWhether this project is a template
objectAn status update belonging to a project (title: Projects v2 Status Update)
integerThe project number.
objectA GitHub user. (title: Simple User)
booleanWhether the project is visible to anyone with access to the owner.
stringA concise summary of the project.
stringThe current state of the project. (open, closed)
stringThe project title.
string (date-time)The time when the project was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project.
stringThe node ID of the project.
string (date-time)The time when the project was closed. (example: 2022-04-28T12:00:00Z)
string (date-time)The time when the project was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
string (date-time)The time when the project was deleted. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
stringA short description of the project.
booleanWhether this project is a template
objectAn status update belonging to a project (title: Projects v2 Status Update)
integerThe project number.
objectA GitHub user. (title: Simple User)
booleanWhether the project is visible to anyone with access to the owner.
stringA concise summary of the project.
stringThe current state of the project. (open, closed)
stringThe project title.
string (date-time)The time when the project was last updated. (example: 2022-04-28T12:00:00Z)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
numberThe unique identifier of the project.
stringThe node ID of the project.
string (date-time)The time when the project was closed. (example: 2022-04-28T12:00:00Z)
string (date-time)The time when the project was created. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
string (date-time)The time when the project was deleted. (example: 2022-04-28T12:00:00Z)
objectA GitHub user. (title: Simple User)
stringA short description of the project.
booleanWhether this project is a template
objectAn status update belonging to a project (title: Projects v2 Status Update)
integerThe project number.
objectA GitHub user. (title: Simple User)
booleanWhether the project is visible to anyone with access to the owner.
stringA concise summary of the project.
stringThe current state of the project. (open, closed)
stringThe project title.
string (date-time)The time when the project was last updated. (example: 2022-04-28T12:00:00Z)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | -| | `SELECT` | | Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | -| | `SELECT` | | Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | -| | `SELECT` | | Lists projects for a user. | -| | `INSERT` | | Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | -| | `INSERT` | | Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | -| | `INSERT` | | Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | -| | `DELETE` | | Deletes a project board. Returns a `404 Not Found` status if projects are disabled. | -| | `EXEC` | | Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
project_number, orgGet a specific organization-owned project.
project_number, usernameGet a specific user-owned project.
orgq, before, after, per_pageList all projects owned by a specific organization accessible by the authenticated user.
usernameq, before, after, per_pageList all projects owned by a specific user accessible by the authenticated user.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe project's number.
stringThe handle for the GitHub user account.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringLimit results to projects of the specified type.
+ +## `SELECT` examples + + + + +Get a specific organization-owned project. + +```sql +SELECT +id, +node_id, +closed_at, +created_at, +creator, +deleted_at, +deleted_by, +description, +is_template, +latest_status_update, +number, +owner, +public, +short_description, +state, +title, +updated_at +FROM github.projects.projects +WHERE project_number = '{{ project_number }}' -- required +AND org = '{{ org }}' -- required +; +``` + + + +Get a specific user-owned project. + +```sql +SELECT +id, +node_id, +closed_at, +created_at, +creator, +deleted_at, +deleted_by, +description, +is_template, +latest_status_update, +number, +owner, +public, +short_description, +state, +title, +updated_at +FROM github.projects.projects +WHERE project_number = '{{ project_number }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +List all projects owned by a specific organization accessible by the authenticated user. + +```sql +SELECT +id, +node_id, +closed_at, +created_at, +creator, +deleted_at, +deleted_by, +description, +is_template, +latest_status_update, +number, +owner, +public, +short_description, +state, +title, +updated_at +FROM github.projects.projects +WHERE org = '{{ org }}' -- required +AND q = '{{ q }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + + +List all projects owned by a specific user accessible by the authenticated user. + +```sql +SELECT +id, +node_id, +closed_at, +created_at, +creator, +deleted_at, +deleted_by, +description, +is_template, +latest_status_update, +number, +owner, +public, +short_description, +state, +title, +updated_at +FROM github.projects.projects +WHERE username = '{{ username }}' -- required +AND q = '{{ q }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/pulls/comments/index.md b/website/docs/services/pulls/comments/index.md index 5ebe320..255121b 100644 --- a/website/docs/services/pulls/comments/index.md +++ b/website/docs/services/pulls/comments/index.md @@ -1,71 +1,1074 @@ ---- +--- title: comments hide_title: false hide_table_of_contents: false keywords: - comments - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a comments resource. ## Overview - +
Namecomments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The ID of the pull request review comment. | -| | `object` | | -| | `string` | How the author is associated with the repository. | -| | `string` | The text of the comment. | -| | `string` | | -| | `string` | | -| | `string` | The SHA of the commit to which the comment applies. | -| | `string` | | -| | `string` | The diff of the line that the comment refers to. | -| | `string` | HTML URL for the pull request review comment. | -| | `integer` | The comment ID to reply to. | -| | `integer` | The line of the blob to which the comment applies. The last line of the range for a multi-line comment | -| | `string` | The node ID of the pull request review comment. | -| | `string` | The SHA of the original commit to which the comment applies. | -| | `integer` | The line of the blob to which the comment applies. The last line of the range for a multi-line comment | -| | `integer` | The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. | -| | `integer` | The first line of the range for a multi-line comment. | -| | `string` | The relative path of the file to which the comment applies. | -| | `integer` | The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. | -| | `integer` | The ID of the pull request review to which the comment belongs. | -| | `string` | URL for the pull request that the review comment belongs to. | -| | `object` | | -| | `string` | The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment | -| | `integer` | The first line of the range for a multi-line comment. | -| | `string` | The side of the first line of the range for a multi-line comment. | -| | `string` | The level at which the comment is targeted, can be a diff line or a file. | -| | `string` | | -| | `string` | URL for the pull request review comment | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The ID of the pull request review comment.
stringThe SHA of the commit to which the comment applies. (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
integerThe comment ID to reply to.
stringThe node ID of the pull request review comment. (example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw)
stringThe SHA of the original commit to which the comment applies. (example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840)
integer (int64)The ID of the pull request review to which the comment belongs.
object
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe text of the comment. (example: We should probably include a check for null values here.)
string (example: "

comment body

")
string (example: "comment body")
string (date-time) (example: 2011-04-14T16:00:49Z)
stringThe diff of the line that the comment refers to. (example: @@ -16,33 +16,40 @@ public class Connection : IConnection...)
string (uri)HTML URL for the pull request review comment. (example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1)
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.
integerThe first line of the range for a multi-line comment.
stringThe relative path of the file to which the comment applies. (example: config/database.yaml)
integerThe line index in the diff to which the comment applies. This field is closing down; use `line` instead.
string (uri)URL for the pull request that the review comment belongs to. (example: https://api.github.com/repos/octocat/Hello-World/pulls/1)
object (title: Reaction Rollup)
stringThe side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment (LEFT, RIGHT) (default: RIGHT)
integerThe first line of the range for a multi-line comment.
stringThe side of the first line of the range for a multi-line comment. (LEFT, RIGHT) (default: RIGHT)
stringThe level at which the comment is targeted, can be a diff line or a file. (line, file)
string (date-time) (example: 2011-04-14T16:00:49Z)
stringURL for the pull request review comment (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The ID of the pull request review comment.
stringThe SHA of the commit to which the comment applies. (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
integerThe comment ID to reply to.
stringThe node ID of the pull request review comment. (example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw)
stringThe SHA of the original commit to which the comment applies. (example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840)
integer (int64)The ID of the pull request review to which the comment belongs.
object
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe text of the comment. (example: We should probably include a check for null values here.)
string (example: "

comment body

")
string (example: "comment body")
string (date-time) (example: 2011-04-14T16:00:49Z)
stringThe diff of the line that the comment refers to. (example: @@ -16,33 +16,40 @@ public class Connection : IConnection...)
string (uri)HTML URL for the pull request review comment. (example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1)
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.
integerThe first line of the range for a multi-line comment.
stringThe relative path of the file to which the comment applies. (example: config/database.yaml)
integerThe line index in the diff to which the comment applies. This field is closing down; use `line` instead.
string (uri)URL for the pull request that the review comment belongs to. (example: https://api.github.com/repos/octocat/Hello-World/pulls/1)
object (title: Reaction Rollup)
stringThe side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment (LEFT, RIGHT) (default: RIGHT)
integerThe first line of the range for a multi-line comment.
stringThe side of the first line of the range for a multi-line comment. (LEFT, RIGHT) (default: RIGHT)
stringThe level at which the comment is targeted, can be a diff line or a file. (line, file)
string (date-time) (example: 2011-04-14T16:00:49Z)
stringURL for the pull request review comment (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The ID of the pull request review comment.
stringThe SHA of the commit to which the comment applies. (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
integerThe comment ID to reply to.
stringThe node ID of the pull request review comment. (example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw)
stringThe SHA of the original commit to which the comment applies. (example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840)
integer (int64)The ID of the pull request review to which the comment belongs.
object
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe text of the comment. (example: We should probably include a check for null values here.)
string (example: "

comment body

")
string (example: "comment body")
string (date-time) (example: 2011-04-14T16:00:49Z)
stringThe diff of the line that the comment refers to. (example: @@ -16,33 +16,40 @@ public class Connection : IConnection...)
string (uri)HTML URL for the pull request review comment. (example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1)
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.
integerThe first line of the range for a multi-line comment.
stringThe relative path of the file to which the comment applies. (example: config/database.yaml)
integerThe line index in the diff to which the comment applies. This field is closing down; use `line` instead.
string (uri)URL for the pull request that the review comment belongs to. (example: https://api.github.com/repos/octocat/Hello-World/pulls/1)
object (title: Reaction Rollup)
stringThe side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment (LEFT, RIGHT) (default: RIGHT)
integerThe first line of the range for a multi-line comment.
stringThe side of the first line of the range for a multi-line comment. (LEFT, RIGHT) (default: RIGHT)
stringThe level at which the comment is targeted, can be a diff line or a file. (line, file)
string (date-time) (example: 2011-04-14T16:00:49Z)
stringURL for the pull request review comment (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Provides details for a review comment. | -| | `SELECT` | | Lists all review comments for a pull request. By default, review comments are in ascending order by ID. | -| | `SELECT` | | Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. | -| | `INSERT` | |
Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.

The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.

**Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `DELETE` | | Deletes a review comment. | -| | `EXEC` | | Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `EXEC` | | Enables you to edit a review comment. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idProvides details for a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_numbersort, direction, since, per_page, pageLists all review comments for a specified pull request. By default, review comments
are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, reposort, direction, since, per_page, pageLists review comments for all pull requests in a repository. By default,
review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_number, comment_id, bodyCreates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_number, body, commit_id, pathCreates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."

If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.

The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_id, bodyEdits the content of a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_idDeletes a review comment.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe direction to sort results. Ignored without `sort` parameter.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
string
+ +## `SELECT` examples + + + + +Provides details for a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user +FROM github.pulls.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND comment_id = '{{ comment_id }}' -- required +; +``` + + + +Lists all review comments for a specified pull request. By default, review comments
are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user +FROM github.pulls.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists review comments for all pull requests in a repository. By default,
review comments are in ascending order by ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user +FROM github.pulls.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND since = '{{ since }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.pulls.comments ( +body, +owner, +repo, +pull_number, +comment_id +) +SELECT +'{{ body }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ pull_number }}', +'{{ comment_id }}' +RETURNING +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user +; +``` + + + +Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)."

If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request.

The `position` parameter is closing down. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)"
and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.pulls.comments ( +body, +commit_id, +path, +position, +side, +line, +start_line, +start_side, +in_reply_to, +subject_type, +owner, +repo, +pull_number +) +SELECT +'{{ body }}' /* required */, +'{{ commit_id }}' /* required */, +'{{ path }}' /* required */, +{{ position }}, +'{{ side }}', +{{ line }}, +{{ start_line }}, +'{{ start_side }}', +{{ in_reply_to }}, +'{{ subject_type }}', +'{{ owner }}', +'{{ repo }}', +'{{ pull_number }}' +RETURNING +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the comments resource. + - name: pull_number + value: {{ pull_number }} + description: Required parameter for the comments resource. + - name: comment_id + value: "{{ comment_id }}" + description: Required parameter for the comments resource. + - name: body + value: "{{ body }}" + description: | + The text of the review comment. + - name: commit_id + value: "{{ commit_id }}" + description: | + The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the \`position\`. + - name: path + value: "{{ path }}" + description: | + The relative path to the file that necessitates a comment. + - name: position + value: {{ position }} + description: | + **This parameter is closing down. Use \`line\` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + - name: side + value: "{{ side }}" + description: | + In a split diff view, the side of the diff that the pull request's changes appear on. Can be \`LEFT\` or \`RIGHT\`. Use \`LEFT\` for deletions that appear in red. Use \`RIGHT\` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + valid_values: ['LEFT', 'RIGHT'] + - name: line + value: {{ line }} + description: | + **Required unless using \`subject_type:file\`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + - name: start_line + value: {{ start_line }} + description: | + **Required when using multi-line comments unless using \`in_reply_to\`**. The \`start_line\` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + - name: start_side + value: "{{ start_side }}" + description: | + **Required when using multi-line comments unless using \`in_reply_to\`**. The \`start_side\` is the starting side of the diff that the comment applies to. Can be \`LEFT\` or \`RIGHT\`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See \`side\` in this table for additional context. + valid_values: ['LEFT', 'RIGHT', 'side'] + - name: in_reply_to + value: {{ in_reply_to }} + description: | + The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than \`body\` in the request body are ignored. + - name: subject_type + value: "{{ subject_type }}" + description: | + The level at which the comment is targeted. + valid_values: ['line', 'file'] +`} + + + + + +## `UPDATE` examples + + + + +Edits the content of a specified review comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +UPDATE github.pulls.comments +SET +body = '{{ body }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +AND body = '{{ body }}' --required +RETURNING +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +Deletes a review comment. + +```sql +DELETE FROM github.pulls.comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +; +``` + + diff --git a/website/docs/services/pulls/comments_for_review/index.md b/website/docs/services/pulls/comments_for_review/index.md index 7b33ffc..eadc954 100644 --- a/website/docs/services/pulls/comments_for_review/index.md +++ b/website/docs/services/pulls/comments_for_review/index.md @@ -1,64 +1,328 @@ ---- +--- title: comments_for_review hide_title: false hide_table_of_contents: false keywords: - comments_for_review - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a comments_for_review resource. ## Overview - +
Namecomments_for_review
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `object` | | -| | `string` | How the author is associated with the repository. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | The line of the blob to which the comment applies. The last line of the range for a multi-line comment | -| | `string` | | -| | `string` | | -| | `integer` | The original line of the blob to which the comment applies. The last line of the range for a multi-line comment | -| | `integer` | | -| | `integer` | The original first line of the range for a multi-line comment. | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `object` | | -| | `string` | The side of the first line of the range for a multi-line comment. | -| | `integer` | The first line of the range for a multi-line comment. | -| | `string` | The side of the first line of the range for a multi-line comment. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
integer
string (example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw)
string (example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840)
integer (int64)
object
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
string (example: Great stuff)
string
string
string (date-time) (example: 2011-04-14T16:00:49Z)
string (example: @@ -16,33 +16,40 @@ public class Connection : IConnection...)
string (uri) (example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1)
integerThe line of the blob to which the comment applies. The last line of the range for a multi-line comment
integerThe original line of the blob to which the comment applies. The last line of the range for a multi-line comment
integer
integerThe original first line of the range for a multi-line comment.
string (example: file1.txt)
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1)
object (title: Reaction Rollup)
stringThe side of the first line of the range for a multi-line comment. (LEFT, RIGHT) (default: RIGHT)
integerThe first line of the range for a multi-line comment.
stringThe side of the first line of the range for a multi-line comment. (LEFT, RIGHT) (default: RIGHT)
stringThe level at which the comment is targeted, can be a diff line or a file. (line, file)
string (date-time) (example: 2011-04-14T16:00:49Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pull_number, review_idper_page, pageLists comments for a specific pull request review.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the review.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists comments for a specific pull request review.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +in_reply_to_id, +node_id, +original_commit_id, +pull_request_review_id, +_links, +author_association, +body, +body_html, +body_text, +created_at, +diff_hunk, +html_url, +line, +original_line, +original_position, +original_start_line, +path, +position, +pull_request_url, +reactions, +side, +start_line, +start_side, +subject_type, +updated_at, +url, +user +FROM github.pulls.comments_for_review +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +AND review_id = '{{ review_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/pulls/commits/index.md b/website/docs/services/pulls/commits/index.md index 0636431..ed920e0 100644 --- a/website/docs/services/pulls/commits/index.md +++ b/website/docs/services/pulls/commits/index.md @@ -1,47 +1,214 @@ ---- +--- title: commits hide_title: false hide_table_of_contents: false keywords: - commits - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commits resource. ## Overview - +
Namecommits
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments)
object
objectA GitHub user. (title: Simple User)
array
string (uri) (example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e)
array
string (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
object
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pull_numberper_page, pageLists a maximum of 250 commits for a pull request. To receive a complete
commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)
endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists a maximum of 250 commits for a pull request. To receive a complete
commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits)
endpoint.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +node_id, +author, +comments_url, +commit, +committer, +files, +html_url, +parents, +sha, +stats, +url +FROM github.pulls.commits +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/pulls/files/index.md b/website/docs/services/pulls/files/index.md index 4e1b275..9b175a4 100644 --- a/website/docs/services/pulls/files/index.md +++ b/website/docs/services/pulls/files/index.md @@ -1,47 +1,214 @@ ---- +--- title: files hide_title: false hide_table_of_contents: false keywords: - files - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a files resource. ## Overview - +
Namefiles
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `integer` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (uri) (example: https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt)
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e)
integer
string (example: file1.txt)
string (example: @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test)
string (example: file.txt)
string (uri) (example: https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt)
string (example: bbcd538c8e72b8c175046e27cc8f907076331401)
string (added, removed, modified, renamed, copied, changed, unchanged) (example: added)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pull_numberper_page, pageLists the files in a specified pull request.

> [!NOTE]
> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the files in a specified pull request.

> [!NOTE]
> Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +additions, +blob_url, +changes, +contents_url, +deletions, +filename, +patch, +previous_filename, +raw_url, +sha, +status +FROM github.pulls.files +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/pulls/index.md b/website/docs/services/pulls/index.md index 9b8766f..425300b 100644 --- a/website/docs/services/pulls/index.md +++ b/website/docs/services/pulls/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With GitHub Pull Requests. - -:::info Service Summary +pulls service documentation. -
-
-total resources: 8
-total selectable resources: 8
-total methods: 27
-
-
+:::info[Service Summary] -::: +total resources: __8__ -## Overview - - - - - - -
Namegithub.pulls
TypeService
TitleGitHub V3 REST API - Pulls
DescriptionInteract With GitHub Pull Requests.
Idpulls:v24.04.00227
+::: ## Resources
@@ -43,12 +28,12 @@ Interact With GitHub Pull Requests. comments
comments_for_review
commits
-files
+files
pull_request
pull_requests
review_requests
-reviews
-
+reviews + \ No newline at end of file diff --git a/website/docs/services/pulls/pull_request/index.md b/website/docs/services/pulls/pull_request/index.md index bd69b26..fa90c3c 100644 --- a/website/docs/services/pulls/pull_request/index.md +++ b/website/docs/services/pulls/pull_request/index.md @@ -1,89 +1,735 @@ ---- +--- title: pull_request hide_title: false hide_table_of_contents: false keywords: - pull_request - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pull_request resource. ## Overview - +
Namepull_request
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `object` | | -| | `string` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | How the author is associated with the repository. | -| | `object` | The status of auto merging a pull request. | -| | `object` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `boolean` | Indicates whether or not the pull request is a draft. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `boolean` | | -| | `boolean` | Indicates whether maintainers can modify the pull request. | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `object` | A collection of related issues and pull requests. | -| | `string` | | -| | `integer` | Number uniquely identifying the pull request within its repository. | -| | `string` | | -| | `boolean` | | -| | `array` | | -| | `array` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | State of this Pull Request. Either `open` or `closed`. | -| | `string` | | -| | `string` | The title of the pull request. | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: MDExOlB1bGxSZXF1ZXN0MQ==)
object
string (example: too heated)
integer
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
objectThe status of auto merging a pull request. (title: Auto merge)
object
string (example: Please pull these awesome changes)
integer
string (date-time) (example: 2011-01-26T19:01:12Z)
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments)
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits)
string (date-time) (example: 2011-01-26T19:01:12Z)
integer
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347.diff)
booleanIndicates whether or not the pull request is a draft.
object
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/1347)
array
boolean
booleanIndicates whether maintainers can modify the pull request.
string (example: e5bd3914e2e596debea16f433f57875b5b90bcd6)
boolean
string (example: clean)
boolean
string (date-time) (example: 2011-01-26T19:01:12Z)
objectA GitHub user. (title: Simple User)
objectA collection of related issues and pull requests. (title: Milestone)
integerNumber uniquely identifying the pull request within its repository.
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347.patch)
boolean
array
array
string (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number})
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments)
stringState of this Pull Request. Either `open` or `closed`. (open, closed) (example: open)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e)
stringThe title of the pull request. (example: Amazing new feature)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.

The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:

* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.

Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. | -| | `INSERT` | | Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. | -| | `EXEC` | | Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. | -| | `EXEC` | | Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `EXEC` | | Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. | -| | `EXEC` | | Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pull_numberDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.

The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:

* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.

Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.
owner, repo, head, baseDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_numberDraft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_numberChecks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
owner, repo, pull_numberMerges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
owner, repo, pull_numberUpdates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists details of a pull request by providing its number.

When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)".

The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.

The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:

* If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.
* If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.
* If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.

Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + +```sql +SELECT +id, +node_id, +_links, +active_lock_reason, +additions, +assignee, +assignees, +author_association, +auto_merge, +base, +body, +changed_files, +closed_at, +comments, +comments_url, +commits, +commits_url, +created_at, +deletions, +diff_url, +draft, +head, +html_url, +issue_url, +labels, +locked, +maintainer_can_modify, +merge_commit_sha, +mergeable, +mergeable_state, +merged, +merged_at, +merged_by, +milestone, +number, +patch_url, +rebaseable, +requested_reviewers, +requested_teams, +review_comment_url, +review_comments, +review_comments_url, +state, +statuses_url, +title, +updated_at, +url, +user +FROM github.pulls.pull_request +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.pulls.pull_request ( +title, +head, +head_repo, +base, +body, +maintainer_can_modify, +draft, +issue, +owner, +repo +) +SELECT +'{{ title }}', +'{{ head }}' /* required */, +'{{ head_repo }}', +'{{ base }}' /* required */, +'{{ body }}', +{{ maintainer_can_modify }}, +{{ draft }}, +{{ issue }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +node_id, +_links, +active_lock_reason, +additions, +assignee, +assignees, +author_association, +auto_merge, +base, +body, +changed_files, +closed_at, +comments, +comments_url, +commits, +commits_url, +created_at, +deletions, +diff_url, +draft, +head, +html_url, +issue_url, +labels, +locked, +maintainer_can_modify, +merge_commit_sha, +mergeable, +mergeable_state, +merged, +merged_at, +merged_by, +milestone, +number, +patch_url, +rebaseable, +requested_reviewers, +requested_teams, +review_comment_url, +review_comments, +review_comments_url, +state, +statuses_url, +title, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: pull_request + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the pull_request resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the pull_request resource. + - name: title + value: "{{ title }}" + description: | + The title of the new pull request. Required unless \`issue\` is specified. + - name: head + value: "{{ head }}" + description: | + The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace \`head\` with a user like this: \`username:branch\`. + - name: head_repo + value: "{{ head_repo }}" + description: | + The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. + - name: base + value: "{{ base }}" + description: | + The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. + - name: body + value: "{{ body }}" + description: | + The contents of the pull request. + - name: maintainer_can_modify + value: {{ maintainer_can_modify }} + description: | + Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. + - name: draft + value: {{ draft }} + description: | + Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. + - name: issue + value: {{ issue }} + description: | + An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless \`title\` is specified. +`} + + + + + +## `UPDATE` examples + + + + +Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +UPDATE github.pulls.pull_request +SET +title = '{{ title }}', +body = '{{ body }}', +state = '{{ state }}', +base = '{{ base }}', +maintainer_can_modify = {{ maintainer_can_modify }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND pull_number = '{{ pull_number }}' --required +RETURNING +id, +node_id, +_links, +active_lock_reason, +additions, +assignee, +assignees, +author_association, +auto_merge, +base, +body, +changed_files, +closed_at, +comments, +comments_url, +commits, +commits_url, +created_at, +deletions, +diff_url, +draft, +head, +html_url, +issue_url, +labels, +locked, +maintainer_can_modify, +merge_commit_sha, +mergeable, +mergeable_state, +merged, +merged_at, +merged_by, +milestone, +number, +patch_url, +rebaseable, +requested_reviewers, +requested_teams, +review_comment_url, +review_comments, +review_comments_url, +state, +statuses_url, +title, +updated_at, +url, +user; +``` + + + + +## Lifecycle Methods + + + + +Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. + +```sql +EXEC github.pulls.pull_request.check_if_merged +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@pull_number='{{ pull_number }}' --required +; +``` + + + +Merges a pull request into the base branch.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +EXEC github.pulls.pull_request.merge +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@pull_number='{{ pull_number }}' --required +@@json= +'{ +"commit_title": "{{ commit_title }}", +"commit_message": "{{ commit_message }}", +"sha": "{{ sha }}", +"merge_method": "{{ merge_method }}" +}' +; +``` + + + +Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. + +```sql +EXEC github.pulls.pull_request.update_branch +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@pull_number='{{ pull_number }}' --required +@@json= +'{ +"expected_head_sha": "{{ expected_head_sha }}" +}' +; +``` + + diff --git a/website/docs/services/pulls/pull_requests/index.md b/website/docs/services/pulls/pull_requests/index.md index 74aa598..39dbcf6 100644 --- a/website/docs/services/pulls/pull_requests/index.md +++ b/website/docs/services/pulls/pull_requests/index.md @@ -1,72 +1,388 @@ ---- +--- title: pull_requests hide_title: false hide_table_of_contents: false keywords: - pull_requests - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pull_requests resource. ## Overview - +
Namepull_requests
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `object` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | How the author is associated with the repository. | -| | `object` | The status of auto merging a pull request. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Indicates whether or not the pull request is a draft. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `object` | A collection of related issues and pull requests. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `array` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: MDExOlB1bGxSZXF1ZXN0MQ==)
object
string (example: too heated)
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
objectThe status of auto merging a pull request. (title: Auto merge)
object
string (example: Please pull these awesome changes)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347.diff)
booleanIndicates whether or not the pull request is a draft.
object
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/1347)
array
boolean
string (example: e5bd3914e2e596debea16f433f57875b5b90bcd6)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectA collection of related issues and pull requests. (title: Milestone)
integer
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347.patch)
array
array
string (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number})
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments)
string (example: open)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e)
string (example: new-feature)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repostate, head, base, sort, direction, per_page, pageLists pull requests in a specified repository.

Draft pull requests are available in public repositories with GitHub
Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
plans, and in public and private repositories with GitHub Team and GitHub Enterprise
Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
in the GitHub Help documentation.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringFilter pulls by base branch name. Example: `gh-pages`.
stringThe direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.
stringFilter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringWhat to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.
stringEither `open`, `closed`, or `all` to filter by state.
+ +## `SELECT` examples + + + + +Lists pull requests in a specified repository.

Draft pull requests are available in public repositories with GitHub
Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing
plans, and in public and private repositories with GitHub Team and GitHub Enterprise
Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products)
in the GitHub Help documentation.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +node_id, +_links, +active_lock_reason, +assignee, +assignees, +author_association, +auto_merge, +base, +body, +closed_at, +comments_url, +commits_url, +created_at, +diff_url, +draft, +head, +html_url, +issue_url, +labels, +locked, +merge_commit_sha, +merged_at, +milestone, +number, +patch_url, +requested_reviewers, +requested_teams, +review_comment_url, +review_comments_url, +state, +statuses_url, +title, +updated_at, +url, +user +FROM github.pulls.pull_requests +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND state = '{{ state }}' +AND head = '{{ head }}' +AND base = '{{ base }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/pulls/review_requests/index.md b/website/docs/services/pulls/review_requests/index.md index 92fe256..5091010 100644 --- a/website/docs/services/pulls/review_requests/index.md +++ b/website/docs/services/pulls/review_requests/index.md @@ -1,40 +1,282 @@ ---- +--- title: review_requests hide_title: false hide_table_of_contents: false keywords: - review_requests - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a review_requests resource. ## Overview - +
Namereview_requests
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `array` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. | -| | `DELETE` | | Removes review requests from a pull request for a given set of users and/or teams. | -| | `EXEC` | | Requests reviews for a pull request from a given set of users and/or teams.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pull_numberGets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.
owner, repo, pull_number, reviewers, team_reviewersRequests reviews for a pull request from a given set of users and/or teams.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
owner, repo, pull_numberRemoves review requests from a pull request for a given set of users and/or teams.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. + +```sql +SELECT +teams, +users +FROM github.pulls.review_requests +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Requests reviews for a pull request from a given set of users and/or teams.
This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +INSERT INTO github.pulls.review_requests ( +reviewers, +team_reviewers, +owner, +repo, +pull_number +) +SELECT +'{{ reviewers }}' /* required */, +'{{ team_reviewers }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ pull_number }}' +RETURNING +id, +node_id, +_links, +active_lock_reason, +assignee, +assignees, +author_association, +auto_merge, +base, +body, +closed_at, +comments_url, +commits_url, +created_at, +diff_url, +draft, +head, +html_url, +issue_url, +labels, +locked, +merge_commit_sha, +merged_at, +milestone, +number, +patch_url, +requested_reviewers, +requested_teams, +review_comment_url, +review_comments_url, +state, +statuses_url, +title, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: review_requests + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the review_requests resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the review_requests resource. + - name: pull_number + value: {{ pull_number }} + description: Required parameter for the review_requests resource. + - name: reviewers + value: + - "{{ reviewers }}" + description: | + An array of user \`login\`s that will be requested. + - name: team_reviewers + value: + - "{{ team_reviewers }}" + description: | + An array of team \`slug\`s that will be requested. +`} + + + + + +## `DELETE` examples + + + + +Removes review requests from a pull request for a given set of users and/or teams. + +```sql +DELETE FROM github.pulls.review_requests +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND pull_number = '{{ pull_number }}' --required +; +``` + + diff --git a/website/docs/services/pulls/reviews/index.md b/website/docs/services/pulls/reviews/index.md index af1c7f9..b4f19a0 100644 --- a/website/docs/services/pulls/reviews/index.md +++ b/website/docs/services/pulls/reviews/index.md @@ -1,55 +1,588 @@ ---- +--- title: reviews hide_title: false hide_table_of_contents: false keywords: - reviews - pulls - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a reviews resource. ## Overview - +
Namereviews
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the review | -| | `object` | | -| | `string` | How the author is associated with the repository. | -| | `string` | The text of the review. | -| | `string` | | -| | `string` | | -| | `string` | A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the review
stringA commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. (example: 54bb654c9e6025347f57900a4a5c2313a96b8035)
string (example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=)
object
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe text of the review. (example: This looks great.)
string
string
string (uri) (example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/12)
string (example: CHANGES_REQUESTED)
string (date-time)
objectA GitHub user. (title: Simple User)
+ + + +The list of reviews returns in chronological order. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the review
stringA commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. (example: 54bb654c9e6025347f57900a4a5c2313a96b8035)
string (example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=)
object
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
stringThe text of the review. (example: This looks great.)
string
string
string (uri) (example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/12)
string (example: CHANGES_REQUESTED)
string (date-time)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Retrieves a pull request review by its ID. | -| | `SELECT` | | The list of reviews returns in chronological order. | -| | `INSERT` | | This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.

Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."

**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.

The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. | -| | `DELETE` | | Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. | -| | `EXEC` | | **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. | -| | `EXEC` | | Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." | -| | `EXEC` | | Update the review summary comment with new text. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pull_number, review_idRetrieves a pull request review by its ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_numberper_page, pageLists all reviews for a specified pull request. The list of reviews returns in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_numberCreates a review on a specified pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."

> [!NOTE]
> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.

The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_number, review_id, bodyUpdates the contents of a specified review summary comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_number, review_idDeletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_number, review_id, messageDismisses a specified review on a pull request.

> [!NOTE]
> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, pull_number, review_id, eventSubmits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe number that identifies the pull request.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the review.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Retrieves a pull request review by its ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +node_id, +_links, +author_association, +body, +body_html, +body_text, +html_url, +pull_request_url, +state, +submitted_at, +user +FROM github.pulls.reviews +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +AND review_id = '{{ review_id }}' -- required +; +``` + + + +Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +node_id, +_links, +author_association, +body, +body_html, +body_text, +html_url, +pull_request_url, +state, +submitted_at, +user +FROM github.pulls.reviews +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pull_number = '{{ pull_number }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a review on a specified pull request.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)."

> [!NOTE]
> To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint.

The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.pulls.reviews ( +commit_id, +body, +event, +comments, +owner, +repo, +pull_number +) +SELECT +'{{ commit_id }}', +'{{ body }}', +'{{ event }}', +'{{ comments }}', +'{{ owner }}', +'{{ repo }}', +'{{ pull_number }}' +RETURNING +id, +commit_id, +node_id, +_links, +author_association, +body, +body_html, +body_text, +html_url, +pull_request_url, +state, +submitted_at, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: reviews + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the reviews resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the reviews resource. + - name: pull_number + value: {{ pull_number }} + description: Required parameter for the reviews resource. + - name: commit_id + value: "{{ commit_id }}" + description: | + The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the \`position\`. Defaults to the most recent commit in the pull request when you do not specify a value. + - name: body + value: "{{ body }}" + description: | + **Required** when using \`REQUEST_CHANGES\` or \`COMMENT\` for the \`event\` parameter. The body text of the pull request review. + - name: event + value: "{{ event }}" + description: | + The review action you want to perform. The review actions include: \`APPROVE\`, \`REQUEST_CHANGES\`, or \`COMMENT\`. By leaving this blank, you set the review action state to \`PENDING\`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. + valid_values: ['APPROVE', 'REQUEST_CHANGES', 'COMMENT'] + - name: comments + description: | + Use the following table to specify the location, destination, and contents of the draft review comment. + value: + - path: "{{ path }}" + position: {{ position }} + body: "{{ body }}" + line: {{ line }} + side: "{{ side }}" + start_line: {{ start_line }} + start_side: "{{ start_side }}" +`} + + + + + +## `REPLACE` examples + + + + +Updates the contents of a specified review summary comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +REPLACE github.pulls.reviews +SET +body = '{{ body }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND pull_number = '{{ pull_number }}' --required +AND review_id = '{{ review_id }}' --required +AND body = '{{ body }}' --required +RETURNING +id, +commit_id, +node_id, +_links, +author_association, +body, +body_html, +body_text, +html_url, +pull_request_url, +state, +submitted_at, +user; +``` + + + + +## `DELETE` examples + + + + +Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +DELETE FROM github.pulls.reviews +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND pull_number = '{{ pull_number }}' --required +AND review_id = '{{ review_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Dismisses a specified review on a pull request.

> [!NOTE]
> To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +EXEC github.pulls.reviews.dismiss_review +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@pull_number='{{ pull_number }}' --required, +@review_id='{{ review_id }}' --required +@@json= +'{ +"message": "{{ message }}", +"event": "{{ event }}" +}' +; +``` + + + +Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +EXEC github.pulls.reviews.submit_review +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@pull_number='{{ pull_number }}' --required, +@review_id='{{ review_id }}' --required +@@json= +'{ +"body": "{{ body }}", +"event": "{{ event }}" +}' +; +``` + + diff --git a/website/docs/services/rate_limit/index.md b/website/docs/services/rate_limit/index.md index 819ae01..c786739 100644 --- a/website/docs/services/rate_limit/index.md +++ b/website/docs/services/rate_limit/index.md @@ -9,39 +9,25 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Rate Limit - -:::info Service Summary +rate_limit service documentation. -
-
-total resources: 1
-total selectable resources: 1
-total methods: 1
-
-
+:::info[Service Summary] -::: +total resources: __1__ -## Overview - - - - - - -
Namegithub.rate_limit
TypeService
TitleGitHub V3 REST API - Rate Limit
DescriptionRate Limit
Idrate_limit:v24.04.00227
+::: ## Resources
-rate_limit
+rate_limit
+
-
+ \ No newline at end of file diff --git a/website/docs/services/rate_limit/rate_limit/index.md b/website/docs/services/rate_limit/rate_limit/index.md index 8200ed8..15254c0 100644 --- a/website/docs/services/rate_limit/rate_limit/index.md +++ b/website/docs/services/rate_limit/rate_limit/index.md @@ -1,38 +1,130 @@ ---- +--- title: rate_limit hide_title: false hide_table_of_contents: false keywords: - rate_limit - rate_limit - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a rate_limit resource. ## Overview - +
Namerate_limit
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `object` | -| | `object` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object (title: Rate Limit)
object
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
> [!NOTE]
> Accessing this endpoint does not count against your REST API rate limit.

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
* The `core` object provides your rate limit status for all non-search-related resources in the REST API.
* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)."
* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)."
* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)."
* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)."
* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."
* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."

> [!NOTE]
> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + +
NameDatatypeDescription
+ +## `SELECT` examples + + + + +> [!NOTE]
> Accessing this endpoint does not count against your REST API rate limit.

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
* The `core` object provides your rate limit status for all non-search-related resources in the REST API.
* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)."
* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)."
* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)."
* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)."
* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)."
* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."
* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."

> [!NOTE]
> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + +```sql +SELECT +rate, +resources +FROM github.rate_limit.rate_limit +; +``` + + diff --git a/website/docs/services/reactions/commit_comments/index.md b/website/docs/services/reactions/commit_comments/index.md index 8385826..3e164b5 100644 --- a/website/docs/services/reactions/commit_comments/index.md +++ b/website/docs/services/reactions/commit_comments/index.md @@ -1,43 +1,286 @@ ---- +--- title: commit_comments hide_title: false hide_table_of_contents: false keywords: - commit_comments - reactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commit_comments resource. ## Overview - +
Namecommit_comments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The reaction to use | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDg6UmVhY3Rpb24x)
stringThe reaction to use (+1, -1, laugh, confused, heart, hooray, rocket, eyes) (example: heart)
string (date-time) (example: 2016-05-20T20:09:31Z)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). | -| | `INSERT` | | Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. | -| | `DELETE` | | **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idcontent, per_page, pageList the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
owner, repo, comment_id, contentCreate a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.
owner, repo, comment_id, reaction_id> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the reaction.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringReturns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + +```sql +SELECT +id, +node_id, +content, +created_at, +user +FROM github.reactions.commit_comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND comment_id = '{{ comment_id }}' -- required +AND content = '{{ content }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. + +```sql +INSERT INTO github.reactions.commit_comments ( +content, +owner, +repo, +comment_id +) +SELECT +'{{ content }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ comment_id }}' +RETURNING +id, +node_id, +content, +created_at, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: commit_comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the commit_comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the commit_comments resource. + - name: comment_id + value: "{{ comment_id }}" + description: Required parameter for the commit_comments resource. + - name: content + value: "{{ content }}" + description: | + The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. + valid_values: ['+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'] +`} + + + + + +## `DELETE` examples + + + + +> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + +```sql +DELETE FROM github.reactions.commit_comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +AND reaction_id = '{{ reaction_id }}' --required +; +``` + + diff --git a/website/docs/services/reactions/index.md b/website/docs/services/reactions/index.md index dca5e15..003c39d 100644 --- a/website/docs/services/reactions/index.md +++ b/website/docs/services/reactions/index.md @@ -9,43 +9,27 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With Reactions To Various GitHub Entities. - -:::info Service Summary +reactions service documentation. -
-
-total resources: 5
-total selectable resources: 5
-total methods: 25
-
-
+:::info[Service Summary] -::: +total resources: __4__ -## Overview - - - - - - -
Namegithub.reactions
TypeService
TitleGitHub V3 REST API - Reactions
DescriptionInteract With Reactions To Various GitHub Entities.
Idreactions:v24.04.00227
+::: ## Resources
commit_comments
-issue_comments
-pr_comments
+issue_comments
-release_comments
-team_discussions
-
+pr_comments
+release_comments
+ \ No newline at end of file diff --git a/website/docs/services/reactions/issue_comments/index.md b/website/docs/services/reactions/issue_comments/index.md index a675e72..992f1c8 100644 --- a/website/docs/services/reactions/issue_comments/index.md +++ b/website/docs/services/reactions/issue_comments/index.md @@ -1,46 +1,419 @@ ---- +--- title: issue_comments hide_title: false hide_table_of_contents: false keywords: - issue_comments - reactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an issue_comments resource. ## Overview - +
Nameissue_comments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The reaction to use | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDg6UmVhY3Rpb24x)
stringThe reaction to use (+1, -1, laugh, confused, heart, hooray, rocket, eyes) (example: heart)
string (date-time) (example: 2016-05-20T20:09:31Z)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDg6UmVhY3Rpb24x)
stringThe reaction to use (+1, -1, laugh, confused, heart, hooray, rocket, eyes) (example: heart)
string (date-time) (example: 2016-05-20T20:09:31Z)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). | -| | `SELECT` | | List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). | -| | `INSERT` | | Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. | -| | `INSERT` | | Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. | -| | `DELETE` | | **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.

Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). | -| | `DELETE` | | **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idcontent, per_page, pageList the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
owner, repo, issue_numbercontent, per_page, pageList the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
owner, repo, comment_id, contentCreate a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.
owner, repo, issue_number, contentCreate a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.
owner, repo, comment_id, reaction_id> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).
owner, repo, issue_number, reaction_id> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.

Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
integerThe number that identifies the issue.
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the reaction.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringReturns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + +```sql +SELECT +id, +node_id, +content, +created_at, +user +FROM github.reactions.issue_comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND comment_id = '{{ comment_id }}' -- required +AND content = '{{ content }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + +```sql +SELECT +id, +node_id, +content, +created_at, +user +FROM github.reactions.issue_comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND issue_number = '{{ issue_number }}' -- required +AND content = '{{ content }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. + +```sql +INSERT INTO github.reactions.issue_comments ( +content, +owner, +repo, +comment_id +) +SELECT +'{{ content }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ comment_id }}' +RETURNING +id, +node_id, +content, +created_at, +user +; +``` + + + +Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. + +```sql +INSERT INTO github.reactions.issue_comments ( +content, +owner, +repo, +issue_number +) +SELECT +'{{ content }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ issue_number }}' +RETURNING +id, +node_id, +content, +created_at, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: issue_comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the issue_comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the issue_comments resource. + - name: comment_id + value: "{{ comment_id }}" + description: Required parameter for the issue_comments resource. + - name: issue_number + value: {{ issue_number }} + description: Required parameter for the issue_comments resource. + - name: content + value: "{{ content }}" + description: | + The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. + valid_values: ['+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'] +`} + + + + + +## `DELETE` examples + + + + +> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.

Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + +```sql +DELETE FROM github.reactions.issue_comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +AND reaction_id = '{{ reaction_id }}' --required +; +``` + + + +> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.

Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + +```sql +DELETE FROM github.reactions.issue_comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND issue_number = '{{ issue_number }}' --required +AND reaction_id = '{{ reaction_id }}' --required +; +``` + + diff --git a/website/docs/services/reactions/pr_comments/index.md b/website/docs/services/reactions/pr_comments/index.md index 953e25a..b591a48 100644 --- a/website/docs/services/reactions/pr_comments/index.md +++ b/website/docs/services/reactions/pr_comments/index.md @@ -1,43 +1,286 @@ ---- +--- title: pr_comments hide_title: false hide_table_of_contents: false keywords: - pr_comments - reactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pr_comments resource. ## Overview - +
Namepr_comments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The reaction to use | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDg6UmVhY3Rpb24x)
stringThe reaction to use (+1, -1, laugh, confused, heart, hooray, rocket, eyes) (example: heart)
string (date-time) (example: 2016-05-20T20:09:31Z)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). | -| | `INSERT` | | Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. | -| | `DELETE` | | **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`

Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idcontent, per_page, pageList the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
owner, repo, comment_id, contentCreate a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.
owner, repo, comment_id, reaction_id> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`

Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the reaction.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringReturns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + +```sql +SELECT +id, +node_id, +content, +created_at, +user +FROM github.reactions.pr_comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND comment_id = '{{ comment_id }}' -- required +AND content = '{{ content }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. + +```sql +INSERT INTO github.reactions.pr_comments ( +content, +owner, +repo, +comment_id +) +SELECT +'{{ content }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ comment_id }}' +RETURNING +id, +node_id, +content, +created_at, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: pr_comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the pr_comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the pr_comments resource. + - name: comment_id + value: "{{ comment_id }}" + description: Required parameter for the pr_comments resource. + - name: content + value: "{{ content }}" + description: | + The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. + valid_values: ['+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'] +`} + + + + + +## `DELETE` examples + + + + +> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`

Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + +```sql +DELETE FROM github.reactions.pr_comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +AND reaction_id = '{{ reaction_id }}' --required +; +``` + + diff --git a/website/docs/services/reactions/release_comments/index.md b/website/docs/services/reactions/release_comments/index.md index 112bfea..9b123ad 100644 --- a/website/docs/services/reactions/release_comments/index.md +++ b/website/docs/services/reactions/release_comments/index.md @@ -1,43 +1,286 @@ ---- +--- title: release_comments hide_title: false hide_table_of_contents: false keywords: - release_comments - reactions - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a release_comments resource. ## Overview - +
Namerelease_comments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The reaction to use | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDg6UmVhY3Rpb24x)
stringThe reaction to use (+1, -1, laugh, confused, heart, hooray, rocket, eyes) (example: heart)
string (date-time) (example: 2016-05-20T20:09:31Z)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). | -| | `INSERT` | | Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. | -| | `DELETE` | | **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.

Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, release_idcontent, per_page, pageList the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
owner, repo, release_id, contentCreate a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.
owner, repo, release_id, reaction_id> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.

Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the reaction.
integerThe unique identifier of the release.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringReturns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). + +```sql +SELECT +id, +node_id, +content, +created_at, +user +FROM github.reactions.release_comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND release_id = '{{ release_id }}' -- required +AND content = '{{ content }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. + +```sql +INSERT INTO github.reactions.release_comments ( +content, +owner, +repo, +release_id +) +SELECT +'{{ content }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ release_id }}' +RETURNING +id, +node_id, +content, +created_at, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: release_comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the release_comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the release_comments resource. + - name: release_id + value: {{ release_id }} + description: Required parameter for the release_comments resource. + - name: content + value: "{{ content }}" + description: | + The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. + valid_values: ['+1', 'laugh', 'heart', 'hooray', 'rocket', 'eyes'] +`} + + + + + +## `DELETE` examples + + + + +> [!NOTE]
> You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.

Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). + +```sql +DELETE FROM github.reactions.release_comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND release_id = '{{ release_id }}' --required +AND reaction_id = '{{ reaction_id }}' --required +; +``` + + diff --git a/website/docs/services/reactions/team_discussions/index.md b/website/docs/services/reactions/team_discussions/index.md deleted file mode 100644 index b72a48a..0000000 --- a/website/docs/services/reactions/team_discussions/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: team_discussions -hide_title: false -hide_table_of_contents: false -keywords: - - team_discussions - - reactions - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameteam_discussions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The reaction to use | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.

List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `SELECT` | | List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.

List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `INSERT` | | Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. | -| | `INSERT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint.

Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. | -| | `INSERT` | | Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. | -| | `INSERT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.

Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. | -| | `DELETE` | | **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.

Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `DELETE` | | **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.

Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | diff --git a/website/docs/services/repos/activities/index.md b/website/docs/services/repos/activities/index.md index f54d037..4b882d9 100644 --- a/website/docs/services/repos/activities/index.md +++ b/website/docs/services/repos/activities/index.md @@ -1,44 +1,226 @@ ---- +--- title: activities hide_title: false hide_table_of_contents: false keywords: - activities - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an activities resource. ## Overview - +
Nameactivities
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The type of the activity that was performed. | -| | `object` | A GitHub user. | -| | `string` | The SHA of the commit after the activity. | -| | `string` | The SHA of the commit before the activity. | -| | `string` | | -| | `string` | The full Git reference, formatted as `refs/heads/<branch name>`. | -| | `string` | The time when the activity occurred. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
stringThe type of the activity that was performed. (push, force_push, branch_deletion, branch_creation, pr_merge, merge_queue_merge) (example: force_push)
objectA GitHub user. (title: Simple User)
stringThe SHA of the commit after the activity. (example: 827efc6d56897b048c772eb4087f854f46256132)
stringThe SHA of the commit before the activity. (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
stringThe full Git reference, formatted as `refs/heads/`. (example: refs/heads/main)
string (date-time)The time when the activity occurred. (example: 2011-01-26T19:06:43Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repodirection, per_page, before, after, ref, actor, time_period, activity_typeLists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

For more information about viewing repository activity,
see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe activity type to filter by. For example, you can choose to filter by "force_push", to see all force pushes to the repository.
stringThe GitHub username to use to filter by the actor who performed the activity.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe direction to sort the results by.
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe Git reference for the activities you want to list. The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.
stringThe time period to filter by. For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).
+ +## `SELECT` examples + + + + +Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

For more information about viewing repository activity,
see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." + +```sql +SELECT +id, +node_id, +activity_type, +actor, +after, +before, +ref, +timestamp +FROM github.repos.activities +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND ref = '{{ ref }}' +AND actor = '{{ actor }}' +AND time_period = '{{ time_period }}' +AND activity_type = '{{ activity_type }}' +; +``` + + diff --git a/website/docs/services/repos/admin_branch_protection/index.md b/website/docs/services/repos/admin_branch_protection/index.md index 6b385f8..1ac9202 100644 --- a/website/docs/services/repos/admin_branch_protection/index.md +++ b/website/docs/services/repos/admin_branch_protection/index.md @@ -1,40 +1,213 @@ ---- +--- title: admin_branch_protection hide_title: false hide_table_of_contents: false keywords: - admin_branch_protection - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an admin_branch_protection resource. ## Overview - +
Nameadmin_branch_protection
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `boolean` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +SELECT +enabled, +url +FROM github.repos.admin_branch_protection +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + +```sql +REPLACE github.repos.admin_branch_protection +SET +-- No updatable properties +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +RETURNING +enabled, +url; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + +```sql +DELETE FROM github.repos.admin_branch_protection +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/app_access_restrictions/index.md b/website/docs/services/repos/app_access_restrictions/index.md index 4051846..8c5a285 100644 --- a/website/docs/services/repos/app_access_restrictions/index.md +++ b/website/docs/services/repos/app_access_restrictions/index.md @@ -1,56 +1,373 @@ ---- +--- title: app_access_restrictions hide_title: false hide_table_of_contents: false keywords: - app_access_restrictions - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an app_access_restrictions resource. ## Overview - +
Nameapp_access_restrictions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the GitHub app | -| | `string` | The name of the GitHub app | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | The list of events for the GitHub app | -| | `string` | | -| | `string` | | -| | `integer` | The number of installations associated with the GitHub app | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | The set of permissions for the GitHub app | -| | `string` | The slug name of the GitHub app | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the GitHub app
stringThe name of the GitHub app (example: Probot Owners)
string (example: "Iv1.25b5d1e65ffc4022")
string (example: MDExOkludGVncmF0aW9uMQ==)
string (date-time) (example: 2017-07-08T16:18:44-04:00)
string (example: The description of the app.)
arrayThe list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.
string (uri) (example: https://example.com)
string (uri) (example: https://github.com/apps/super-ci)
integerThe number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.
objectA GitHub user. (title: Simple User)
objectThe set of permissions for the GitHub app
stringThe slug name of the GitHub app (example: probot-owners)
string (date-time) (example: 2017-07-08T16:18:44-04:00)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. | -| | `INSERT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
owner, repo, branch, appsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
owner, repo, branch, appsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + +```sql +SELECT +id, +name, +client_id, +node_id, +created_at, +description, +events, +external_url, +html_url, +installations_count, +owner, +permissions, +slug, +updated_at +FROM github.repos.app_access_restrictions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + +```sql +INSERT INTO github.repos.app_access_restrictions ( +apps, +owner, +repo, +branch +) +SELECT +'{{ apps }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ branch }}' +RETURNING +id, +name, +client_id, +node_id, +created_at, +description, +events, +external_url, +html_url, +installations_count, +owner, +permissions, +slug, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: app_access_restrictions + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the app_access_restrictions resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the app_access_restrictions resource. + - name: branch + value: "{{ branch }}" + description: Required parameter for the app_access_restrictions resource. + - name: apps + value: + - "{{ apps }}" + description: | + The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. +`} + + + + + +## `REPLACE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + +```sql +REPLACE github.repos.app_access_restrictions +SET +apps = '{{ apps }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +AND apps = '{{ apps }}' --required +RETURNING +id, +name, +client_id, +node_id, +created_at, +description, +events, +external_url, +html_url, +installations_count, +owner, +permissions, +slug, +updated_at; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + +```sql +DELETE FROM github.repos.app_access_restrictions +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/assets/index.md b/website/docs/services/repos/assets/index.md index 521fa25..d9965f0 100644 --- a/website/docs/services/repos/assets/index.md +++ b/website/docs/services/repos/assets/index.md @@ -1,53 +1,525 @@ ---- +--- title: assets hide_title: false hide_table_of_contents: false keywords: - assets - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an assets resource. ## Overview - +
Nameassets
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | The file name of the asset. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | State of the release asset. | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe file name of the asset. (example: Team Environment)
string
string (uri)
string
string (date-time)
string
integer
string
integer
stringState of the release asset. (uploaded, open)
string (date-time)
objectA GitHub user. (title: Simple User)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe file name of the asset. (example: Team Environment)
string
string (uri)
string
string (date-time)
string
integer
string
integer
stringState of the release asset. (uploaded, open)
string (date-time)
objectA GitHub user. (title: Simple User)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. | -| | `SELECT` | | | -| | `DELETE` | | | -| | `EXEC` | | Users with push access to the repository can edit a release asset. | -| | `EXEC` | | This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.

You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.

Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:

`application/zip`

GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.

**Notes:**
* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, asset_idTo download the asset's binary content:

- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.
- Alternatively, set the `Accept` header of the request to
[`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
The API will either redirect the client to the location, or stream it directly if possible.
API clients should handle both a `200` or `302` response.
owner, repo, release_idper_page, page
owner, repo, release_id, namelabelThis endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.

You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.

Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:

`application/zip`

GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.

**Notes:**
* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
owner, repo, asset_idUsers with push access to the repository can edit a release asset.
owner, repo, asset_id
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the asset.
string
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the release.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
string
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +To download the asset's binary content:

- If within a browser, fetch the location specified in the `browser_download_url` key provided in the response.
- Alternatively, set the `Accept` header of the request to
[`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).
The API will either redirect the client to the location, or stream it directly if possible.
API clients should handle both a `200` or `302` response. + +```sql +SELECT +id, +name, +node_id, +browser_download_url, +content_type, +created_at, +digest, +download_count, +label, +size, +state, +updated_at, +uploader, +url +FROM github.repos.assets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND asset_id = '{{ asset_id }}' -- required +; +``` + + + +Response + +```sql +SELECT +id, +name, +node_id, +browser_download_url, +content_type, +created_at, +digest, +download_count, +label, +size, +state, +updated_at, +uploader, +url +FROM github.repos.assets +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND release_id = '{{ release_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in
the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset.

You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.

Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:

`application/zip`

GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,
you'll still need to pass your authentication to be able to upload an asset.

When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.

**Notes:**
* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)"
endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).
* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release).
* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + +```sql +INSERT INTO github.repos.assets ( +owner, +repo, +release_id, +name, +label +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ release_id }}', +'{{ name }}', +'{{ label }}' +RETURNING +id, +name, +node_id, +browser_download_url, +content_type, +created_at, +digest, +download_count, +label, +size, +state, +updated_at, +uploader, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: assets + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the assets resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the assets resource. + - name: release_id + value: {{ release_id }} + description: Required parameter for the assets resource. + - name: name + value: "{{ name }}" + description: Required parameter for the assets resource. + - name: label + value: "{{ label }}" +`} + + + + + +## `UPDATE` examples + + + + +Users with push access to the repository can edit a release asset. + +```sql +UPDATE github.repos.assets +SET +name = '{{ name }}', +label = '{{ label }}', +state = '{{ state }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND asset_id = '{{ asset_id }}' --required +RETURNING +id, +name, +node_id, +browser_download_url, +content_type, +created_at, +digest, +download_count, +label, +size, +state, +updated_at, +uploader, +url; +``` + + + + +## `DELETE` examples + + + + +No description available. + +```sql +DELETE FROM github.repos.assets +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND asset_id = '{{ asset_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/attestations/index.md b/website/docs/services/repos/attestations/index.md new file mode 100644 index 0000000..2e6bee7 --- /dev/null +++ b/website/docs/services/repos/attestations/index.md @@ -0,0 +1,244 @@ +--- +title: attestations +hide_title: false +hide_table_of_contents: false +keywords: + - attestations + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an attestations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
objectThe attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, subject_digestper_page, before, after, predicate_typeList a collection of artifact attestations with a given subject digest that are associated with a repository.

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
owner, repo, bundleStore an artifact attestation and associate it with a repository.

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.

Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringOptional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types.
+ +## `SELECT` examples + + + + +List a collection of artifact attestations with a given subject digest that are associated with a repository.

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + +```sql +SELECT +repository_id, +bundle, +bundle_url, +initiator +FROM github.repos.attestations +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND subject_digest = '{{ subject_digest }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND predicate_type = '{{ predicate_type }}' +; +``` + + + + +## `INSERT` examples + + + + +Store an artifact attestation and associate it with a repository.

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required.

Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + +```sql +INSERT INTO github.repos.attestations ( +bundle, +owner, +repo +) +SELECT +'{{ bundle }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +id +; +``` + + + +{`# Description fields are for documentation purposes +- name: attestations + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the attestations resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the attestations resource. + - name: bundle + description: | + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + value: + mediaType: "{{ mediaType }}" + verificationMaterial: "{{ verificationMaterial }}" + dsseEnvelope: "{{ dsseEnvelope }}" +`} + + + diff --git a/website/docs/services/repos/autolinks/index.md b/website/docs/services/repos/autolinks/index.md index 1b9e2d2..9621e01 100644 --- a/website/docs/services/repos/autolinks/index.md +++ b/website/docs/services/repos/autolinks/index.md @@ -1,43 +1,336 @@ ---- +--- title: autolinks hide_title: false hide_table_of_contents: false keywords: - autolinks - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an autolinks resource. ## Overview - +
Nameautolinks
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `boolean` | Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. | -| | `string` | The prefix of a key that is linkified. | -| | `string` | A template for the target URL that is generated if a key was found. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
booleanWhether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
stringThe prefix of a key that is linkified. (example: TICKET-)
string (date-time)
stringA template for the target URL that is generated if a key was found. (example: https://example.com/TICKET?query=<num>)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
booleanWhether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
stringThe prefix of a key that is linkified. (example: TICKET-)
string (date-time)
stringA template for the target URL that is generated if a key was found. (example: https://example.com/TICKET?query=<num>)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators. | -| | `SELECT` | | This returns a list of autolinks configured for the given repository.

Information about autolinks are only available to repository administrators. | -| | `INSERT` | | Users with admin access to the repository can create an autolink. | -| | `DELETE` | | This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, autolink_idThis returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
owner, repoGets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators.
owner, repo, key_prefix, url_templateUsers with admin access to the repository can create an autolink.
owner, repo, autolink_idThis deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators. + +```sql +SELECT +id, +is_alphanumeric, +key_prefix, +updated_at, +url_template +FROM github.repos.autolinks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND autolink_id = '{{ autolink_id }}' -- required +; +``` + + + +Gets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators. + +```sql +SELECT +id, +is_alphanumeric, +key_prefix, +updated_at, +url_template +FROM github.repos.autolinks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Users with admin access to the repository can create an autolink. + +```sql +INSERT INTO github.repos.autolinks ( +key_prefix, +url_template, +is_alphanumeric, +owner, +repo +) +SELECT +'{{ key_prefix }}' /* required */, +'{{ url_template }}' /* required */, +{{ is_alphanumeric }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +is_alphanumeric, +key_prefix, +updated_at, +url_template +; +``` + + + +{`# Description fields are for documentation purposes +- name: autolinks + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the autolinks resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the autolinks resource. + - name: key_prefix + value: "{{ key_prefix }}" + description: | + This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. + - name: url_template + value: "{{ url_template }}" + description: | + The URL must contain \`\` for the reference number. \`\` matches different characters depending on the value of \`is_alphanumeric\`. + - name: is_alphanumeric + value: {{ is_alphanumeric }} + description: | + Whether this autolink reference matches alphanumeric characters. If true, the \`\` parameter of the \`url_template\` matches alphanumeric characters \`A-Z\` (case insensitive), \`0-9\`, and \`-\`. If false, this autolink reference only matches numeric characters. + default: true +`} + + + + + +## `DELETE` examples + + + + +This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators. + +```sql +DELETE FROM github.repos.autolinks +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND autolink_id = '{{ autolink_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/branch/index.md b/website/docs/services/repos/branch/index.md index 4d45666..472ef77 100644 --- a/website/docs/services/repos/branch/index.md +++ b/website/docs/services/repos/branch/index.md @@ -1,47 +1,266 @@ ---- +--- title: branch hide_title: false hide_table_of_contents: false keywords: - branch - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a branch resource. ## Overview - +
Namebranch
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | | -| | `object` | Commit | -| | `string` | | -| | `boolean` | | -| | `object` | Branch Protection | -| | `string` | | -| | `integer` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
objectCommit (title: Commit)
string (example: "mas*")
boolean
objectBranch Protection (title: Branch Protection)
string (uri)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `EXEC` | | | -| | `EXEC` | | Sync a branch of a forked repository to keep it up-to-date with the upstream repository. | -| | `EXEC` | | Renames a branch in a repository.

**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".

The permissions required to use this endpoint depends on whether you are renaming the default branch.

To rename a non-default branch:

* Users must have push access.
* GitHub Apps must have the `contents:write` repository permission.

To rename the default branch:

* Users must have admin or owner permissions.
* GitHub Apps must have the `administration:write` repository permission. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branch
owner, repo, branch, new_nameRenames a branch in a repository.

> [!NOTE]
> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission.
owner, repo, branchSync a branch of a forked repository to keep it up-to-date with the upstream repository.
owner, repo, base, head
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +name, +_links, +commit, +pattern, +protected, +protection, +protection_url, +required_approving_review_count +FROM github.repos.branch +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Renames a branch in a repository.

> [!NOTE]
> Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)".

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + +```sql +EXEC github.repos.branch.rename_branch +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@branch='{{ branch }}' --required +@@json= +'{ +"new_name": "{{ new_name }}" +}' +; +``` + + + +Sync a branch of a forked repository to keep it up-to-date with the upstream repository. + +```sql +EXEC github.repos.branch.merge_upstream +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +@@json= +'{ +"branch": "{{ branch }}" +}' +; +``` + + + +Successful Response (The resulting merge commit) + +```sql +EXEC github.repos.branch.merge +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +@@json= +'{ +"base": "{{ base }}", +"head": "{{ head }}", +"commit_message": "{{ commit_message }}" +}' +; +``` + + diff --git a/website/docs/services/repos/branch_policies/index.md b/website/docs/services/repos/branch_policies/index.md index d7adf4a..6989d3e 100644 --- a/website/docs/services/repos/branch_policies/index.md +++ b/website/docs/services/repos/branch_policies/index.md @@ -1,43 +1,371 @@ ---- +--- title: branch_policies hide_title: false hide_table_of_contents: false keywords: - branch_policies - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a branch_policies resource. ## Overview - +
Namebranch_policies
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The unique identifier of the branch policy. | -| | `string` | The name pattern that branches must match in order to deploy to the environment. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the branch or tag policy.
stringThe name pattern that branches or tags must match in order to deploy to the environment. (example: release/*)
string (example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=)
stringWhether this rule targets a branch or tag. (branch, tag) (example: branch)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerThe number of deployment branch policies for the environment.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a deployment branch policy for an environment.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | Lists the deployment branch policies for an environment.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `INSERT` | | Creates a deployment branch policy for an environment.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. | -| | `DELETE` | | Deletes a deployment branch policy for an environment.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. | -| | `EXEC` | | Updates a deployment branch policy for an environment.

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, environment_name, branch_policy_idGets a deployment branch or tag policy for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, environment_nameper_page, pageLists the deployment branch policies for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, environment_name, nameCreates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, environment_name, branch_policy_id, nameUpdates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, environment_name, branch_policy_idDeletes a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the branch policy.
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a deployment branch or tag policy for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +name, +node_id, +type +FROM github.repos.branch_policies +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND branch_policy_id = '{{ branch_policy_id }}' -- required +; +``` + + + +Lists the deployment branch policies for an environment.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +branch_policies, +total_count +FROM github.repos.branch_policies +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.repos.branch_policies ( +name, +type, +owner, +repo, +environment_name +) +SELECT +'{{ name }}' /* required */, +'{{ type }}', +'{{ owner }}', +'{{ repo }}', +'{{ environment_name }}' +RETURNING +id, +name, +node_id, +type +; +``` + + + +{`# Description fields are for documentation purposes +- name: branch_policies + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the branch_policies resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the branch_policies resource. + - name: environment_name + value: "{{ environment_name }}" + description: Required parameter for the branch_policies resource. + - name: name + value: "{{ name }}" + description: | + The name pattern that branches or tags must match in order to deploy to the environment. + Wildcard characters will not match \`/\`. For example, to match branches that begin with \`release/\` and contain an additional single slash, use \`release/*/*\`. + For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + - name: type + value: "{{ type }}" + description: | + Whether this rule targets a branch or tag + valid_values: ['branch', 'tag'] +`} + + + + + +## `REPLACE` examples + + + + +Updates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.repos.branch_policies +SET +name = '{{ name }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND environment_name = '{{ environment_name }}' --required +AND branch_policy_id = '{{ branch_policy_id }}' --required +AND name = '{{ name }}' --required +RETURNING +id, +name, +node_id, +type; +``` + + + + +## `DELETE` examples + + + + +Deletes a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.repos.branch_policies +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND environment_name = '{{ environment_name }}' --required +AND branch_policy_id = '{{ branch_policy_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/branch_protection/index.md b/website/docs/services/repos/branch_protection/index.md index de39cfe..f8e4841 100644 --- a/website/docs/services/repos/branch_protection/index.md +++ b/website/docs/services/repos/branch_protection/index.md @@ -1,54 +1,322 @@ ---- +--- title: branch_protection hide_title: false hide_table_of_contents: false keywords: - branch_protection - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a branch_protection resource. ## Overview - +
Namebranch_protection
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | | -| | `object` | | -| | `object` | Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. | -| | `object` | | -| | `boolean` | | -| | `object` | Protected Branch Admin Enforced | -| | `object` | Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. | -| | `string` | | -| | `object` | | -| | `object` | | -| | `object` | Protected Branch Pull Request Review | -| | `object` | | -| | `object` | Protected Branch Required Status Check | -| | `object` | Branch Restriction Policy | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: "branch/with/protection")
object
object
objectWhether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.
object
boolean
objectProtected Branch Admin Enforced (title: Protected Branch Admin Enforced)
objectWhether to set the branch as read-only. If this is true, users will not be able to push to the branch.
string (example: "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection")
object
object
objectProtected Branch Pull Request Review (title: Protected Branch Pull Request Review)
object
objectProtected Branch Required Status Check (title: Protected Branch Required Status Check)
objectBranch Restriction Policy (title: Branch Restriction Policy)
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

**Note**: Passing new arrays of `users` and `teams` replaces their previous values.

**Note**: The list of users, apps, and teams in total is limited to 100 items. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictionsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

> [!NOTE]
> Passing new arrays of `users` and `teams` replaces their previous values.

> [!NOTE]
> The list of users, apps, and teams in total is limited to 100 items.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +SELECT +name, +allow_deletions, +allow_force_pushes, +allow_fork_syncing, +block_creations, +enabled, +enforce_admins, +lock_branch, +protection_url, +required_conversation_resolution, +required_linear_history, +required_pull_request_reviews, +required_signatures, +required_status_checks, +restrictions, +url +FROM github.repos.branch_protection +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Protecting a branch requires admin or owner permissions to the repository.

> [!NOTE]
> Passing new arrays of `users` and `teams` replaces their previous values.

> [!NOTE]
> The list of users, apps, and teams in total is limited to 100 items. + +```sql +REPLACE github.repos.branch_protection +SET +required_status_checks = '{{ required_status_checks }}', +enforce_admins = {{ enforce_admins }}, +required_pull_request_reviews = '{{ required_pull_request_reviews }}', +restrictions = '{{ restrictions }}', +required_linear_history = {{ required_linear_history }}, +allow_force_pushes = {{ allow_force_pushes }}, +allow_deletions = {{ allow_deletions }}, +block_creations = {{ block_creations }}, +required_conversation_resolution = {{ required_conversation_resolution }}, +lock_branch = {{ lock_branch }}, +allow_fork_syncing = {{ allow_fork_syncing }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +AND required_status_checks = '{{ required_status_checks }}' --required +AND enforce_admins = {{ enforce_admins }} --required +AND required_pull_request_reviews = '{{ required_pull_request_reviews }}' --required +AND restrictions = '{{ restrictions }}' --required +RETURNING +allow_deletions, +allow_force_pushes, +allow_fork_syncing, +block_creations, +enforce_admins, +lock_branch, +required_conversation_resolution, +required_linear_history, +required_pull_request_reviews, +required_signatures, +required_status_checks, +restrictions, +url; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +DELETE FROM github.repos.branch_protection +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/branch_restrictions/index.md b/website/docs/services/repos/branch_restrictions/index.md index d3ae58d..085b1d3 100644 --- a/website/docs/services/repos/branch_restrictions/index.md +++ b/website/docs/services/repos/branch_restrictions/index.md @@ -1,44 +1,208 @@ ---- +--- title: branch_restrictions hide_title: false hide_table_of_contents: false keywords: - branch_restrictions - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a branch_restrictions resource. ## Overview - +
Namebranch_restrictions
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `string` | -| | `array` | -| | `string` | -| | `string` | -| | `array` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
string (uri)
array
string (uri)
string (uri)
array
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists who has access to this protected branch.

**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists who has access to this protected branch.

> [!NOTE]
> Users, apps, and teams `restrictions` are only available for organization-owned repositories.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists who has access to this protected branch.

> [!NOTE]
> Users, apps, and teams `restrictions` are only available for organization-owned repositories. + +```sql +SELECT +apps, +apps_url, +teams, +teams_url, +url, +users, +users_url +FROM github.repos.branch_restrictions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Disables the ability to restrict who can push to this branch. + +```sql +DELETE FROM github.repos.branch_restrictions +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/branches/index.md b/website/docs/services/repos/branches/index.md index 2103219..92ae006 100644 --- a/website/docs/services/repos/branches/index.md +++ b/website/docs/services/repos/branches/index.md @@ -1,41 +1,178 @@ ---- +--- title: branches hide_title: false hide_table_of_contents: false keywords: - branches - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a branches resource. ## Overview - +
Namebranches
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | | -| | `boolean` | | -| | `object` | Branch Protection | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
boolean
objectBranch Protection (title: Branch Protection)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoprotected, per_page, page
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
booleanSetting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +name, +commit, +protected, +protection, +protection_url +FROM github.repos.branches +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND protected = '{{ protected }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/clone_traffic/index.md b/website/docs/services/repos/clone_traffic/index.md index b2b5143..fb3bcdb 100644 --- a/website/docs/services/repos/clone_traffic/index.md +++ b/website/docs/services/repos/clone_traffic/index.md @@ -1,39 +1,154 @@ ---- +--- title: clone_traffic hide_title: false hide_table_of_contents: false keywords: - clone_traffic - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a clone_traffic resource. ## Overview - +
Nameclone_traffic
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoperGet the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe time frame to display results for.
+ +## `SELECT` examples + + + + +Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + +```sql +SELECT +clones, +count, +uniques +FROM github.repos.clone_traffic +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per = '{{ per }}' +; +``` + + diff --git a/website/docs/services/repos/codeowners/index.md b/website/docs/services/repos/codeowners/index.md new file mode 100644 index 0000000..0ab6764 --- /dev/null +++ b/website/docs/services/repos/codeowners/index.md @@ -0,0 +1,178 @@ +--- +title: codeowners +hide_title: false +hide_table_of_contents: false +keywords: + - codeowners + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a codeowners resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe column number where this errors occurs.
stringThe type of error. (example: Invalid owner)
integerThe line number where this errors occurs.
stringA human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). (example: Invalid owner on line 7:

* user
^)
stringThe path of the file where the error occured. (example: .github/CODEOWNERS)
stringThe contents of the line where the error occurs. (example: * user)
stringSuggested action to fix the error. This will usually be `null`, but is provided for some common errors. (example: The pattern `/` will never match anything, did you mean `*` instead?)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, reporefList any syntax errors that are detected in the CODEOWNERS
file.

For more information about the correct CODEOWNERS syntax,
see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringA branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`)
+ +## `SELECT` examples + + + + +List any syntax errors that are detected in the CODEOWNERS
file.

For more information about the correct CODEOWNERS syntax,
see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + +```sql +SELECT +column, +kind, +line, +message, +path, +source, +suggestion +FROM github.repos.codeowners +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' +; +``` + + diff --git a/website/docs/services/repos/collaborator_permissions/index.md b/website/docs/services/repos/collaborator_permissions/index.md index 6112bca..0876b47 100644 --- a/website/docs/services/repos/collaborator_permissions/index.md +++ b/website/docs/services/repos/collaborator_permissions/index.md @@ -1,39 +1,154 @@ ---- +--- title: collaborator_permissions hide_title: false hide_table_of_contents: false keywords: - collaborator_permissions - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a collaborator_permissions resource. ## Overview - +
Namecollaborator_permissions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `object` | Collaborator | + +The following fields are returned by `SELECT` queries: + + + + +if user has admin permissions + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: admin)
string
objectCollaborator (title: Collaborator)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, usernameChecks the repository permission and role of a collaborator.

The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the
`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.
The `role_name` attribute provides the name of the assigned role, including custom roles. The
`permission` can also be used to determine which base level of access the collaborator has to the repository.

The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.
There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
+ +## `SELECT` examples + + + + +Checks the repository permission and role of a collaborator.

The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the
`maintain` role is mapped to `write` and the `triage` role is mapped to `read`.
The `role_name` attribute provides the name of the assigned role, including custom roles. The
`permission` can also be used to determine which base level of access the collaborator has to the repository.

The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.
There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. + +```sql +SELECT +role_name, +permission, +user +FROM github.repos.collaborator_permissions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND username = '{{ username }}' -- required +; +``` + + diff --git a/website/docs/services/repos/collaborators/index.md b/website/docs/services/repos/collaborators/index.md index ea4cf7f..6bb3140 100644 --- a/website/docs/services/repos/collaborators/index.md +++ b/website/docs/services/repos/collaborators/index.md @@ -1,61 +1,428 @@ ---- +--- title: collaborators hide_title: false hide_table_of_contents: false keywords: - collaborators - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a collaborators resource. ## Overview - +
Namecollaborators
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (example: admin)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
object
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint.

Team members will include the members of child teams.

You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
endpoint. | -| | `DELETE` | | Removes a collaborator from a repository.

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

This endpoint also:
- Cancels any outstanding invitations
- Unasigns the user from any issues
- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
- Unstars the repository
- Updates access permissions to packages

Removing a user as a collaborator has the following effects on forks:
- If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
- If the user had their own fork of the repository, the fork will be deleted.
- If the user still has read access to the repository, open pull requests by this user from a fork will be denied.

**Note**: A user can still have access to the repository through organization permissions like base repository permissions.

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". | -| | `EXEC` | | This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.

Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."

For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

```
Cannot assign {member} permission of {role name}
```

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).

**Updating an existing collaborator's permission level**

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.

**Rate limits**

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. | -| | `EXEC` | | For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this
endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this
endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoaffiliation, permission, per_page, pageFor organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.
There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.

Team members will include the members of child teams.

The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.
OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
owner, repo, usernameAdd a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).

Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings.

For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

```
Cannot assign {member} permission of {role name}
```

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).

For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.

**Updating an existing collaborator's permission level**

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.

**Rate limits**

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.
owner, repo, usernameRemoves a collaborator from a repository.

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

This endpoint also:
- Cancels any outstanding invitations sent by the collaborator
- Unassigns the user from any issues
- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
- Unstars the repository
- Updates access permissions to packages

Removing a user as a collaborator has the following effects on forks:
- If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
- If the user had their own fork of the repository, the fork will be deleted.
- If the user still has read access to the repository, open pull requests by this user from a fork will be denied.

> [!NOTE]
> A user can still have access to the repository through organization permissions like base repository permissions.

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)".
owner, repo, usernameFor organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

The authenticated user must have push access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
stringFilter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFilter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.
+ +## `SELECT` examples + + + + +For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.
The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise.
There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response.

Team members will include the members of child teams.

The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization.
OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +role_name, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +permissions, +received_events_url, +repos_url, +site_admin, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.repos.collaborators +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND affiliation = '{{ affiliation }}' +AND permission = '{{ permission }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).

Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings.

For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

```
Cannot assign {member} permission of {role name}
```

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations).

For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.

**Updating an existing collaborator's permission level**

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.

**Rate limits**

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + +```sql +INSERT INTO github.repos.collaborators ( +permission, +owner, +repo, +username +) +SELECT +'{{ permission }}', +'{{ owner }}', +'{{ repo }}', +'{{ username }}' +RETURNING +id, +node_id, +created_at, +expired, +html_url, +invitee, +inviter, +permissions, +repository, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: collaborators + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the collaborators resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the collaborators resource. + - name: username + value: "{{ username }}" + description: Required parameter for the collaborators resource. + - name: permission + value: "{{ permission }}" + description: | + The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: \`pull\`, \`triage\`, \`push\`, \`maintain\`, \`admin\` and you can also specify a custom repository role name, if the owning organization has defined any. + default: push +`} + + + + + +## `DELETE` examples + + + + +Removes a collaborator from a repository.

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

This endpoint also:
- Cancels any outstanding invitations sent by the collaborator
- Unassigns the user from any issues
- Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
- Unstars the repository
- Updates access permissions to packages

Removing a user as a collaborator has the following effects on forks:
- If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
- If the user had their own fork of the repository, the fork will be deleted.
- If the user still has read access to the repository, open pull requests by this user from a fork will be denied.

> [!NOTE]
> A user can still have access to the repository through organization permissions like base repository permissions.

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + +```sql +DELETE FROM github.repos.collaborators +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND username = '{{ username }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

Team members will include the members of child teams.

The authenticated user must have push access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + +```sql +EXEC github.repos.collaborators.check_collaborator +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@username='{{ username }}' --required +; +``` + + diff --git a/website/docs/services/repos/comments/index.md b/website/docs/services/repos/comments/index.md index ddade15..0c7350b 100644 --- a/website/docs/services/repos/comments/index.md +++ b/website/docs/services/repos/comments/index.md @@ -1,55 +1,652 @@ ---- +--- title: comments hide_title: false hide_table_of_contents: false keywords: - comments - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a comments resource. ## Overview - +
Namecomments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | How the author is associated with the repository. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
string
string (date-time)
string (uri)
integer
string
integer
object (title: Reaction Rollup)
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
string
string (date-time)
string (uri)
integer
string
integer
object (title: Reaction Rollup)
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
string
string (date-time)
string (uri)
integer
string
integer
object (title: Reaction Rollup)
string (date-time)
string (uri)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `SELECT` | | Use the `:commit_sha` to specify the commit that will have its comments listed. | -| | `SELECT` | | Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/).

Comments are ordered by ascending ID. | -| | `INSERT` | | Create a comment for a commit using its `:commit_sha`.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `DELETE` | | | -| | `EXEC` | | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, comment_idGets a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, commit_shaper_page, pageLists the comments for a specified commit.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repoper_page, pageLists the commit comments for a specified repository. Comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, commit_sha, bodyCreate a comment for a commit using its `:commit_sha`.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_id, bodyUpdates the contents of a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
owner, repo, comment_id
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The unique identifier of the comment.
stringThe SHA of the commit.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +node_id, +author_association, +body, +created_at, +html_url, +line, +path, +position, +reactions, +updated_at, +url, +user +FROM github.repos.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND comment_id = '{{ comment_id }}' -- required +; +``` + + + +Lists the comments for a specified commit.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +node_id, +author_association, +body, +created_at, +html_url, +line, +path, +position, +reactions, +updated_at, +url, +user +FROM github.repos.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND commit_sha = '{{ commit_sha }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +SELECT +id, +commit_id, +node_id, +author_association, +body, +created_at, +html_url, +line, +path, +position, +reactions, +updated_at, +url, +user +FROM github.repos.comments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a comment for a commit using its `:commit_sha`.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +INSERT INTO github.repos.comments ( +body, +path, +position, +line, +owner, +repo, +commit_sha +) +SELECT +'{{ body }}' /* required */, +'{{ path }}', +{{ position }}, +{{ line }}, +'{{ owner }}', +'{{ repo }}', +'{{ commit_sha }}' +RETURNING +id, +commit_id, +node_id, +author_association, +body, +created_at, +html_url, +line, +path, +position, +reactions, +updated_at, +url, +user +; +``` + + + +{`# Description fields are for documentation purposes +- name: comments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the comments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the comments resource. + - name: commit_sha + value: "{{ commit_sha }}" + description: Required parameter for the comments resource. + - name: body + value: "{{ body }}" + description: | + The contents of the comment. + - name: path + value: "{{ path }}" + description: | + Relative path of the file to comment on. + - name: position + value: {{ position }} + description: | + Line index in the diff to comment on. + - name: line + value: {{ line }} + description: | + **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. +`} + + + + + +## `UPDATE` examples + + + + +Updates the contents of a specified commit comment.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + +```sql +UPDATE github.repos.comments +SET +body = '{{ body }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +AND body = '{{ body }}' --required +RETURNING +id, +commit_id, +node_id, +author_association, +body, +created_at, +html_url, +line, +path, +position, +reactions, +updated_at, +url, +user; +``` + + + + +## `DELETE` examples + + + + +No description available. + +```sql +DELETE FROM github.repos.comments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND comment_id = '{{ comment_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/commit_pr_branches/index.md b/website/docs/services/repos/commit_pr_branches/index.md index 84150ec..3e62361 100644 --- a/website/docs/services/repos/commit_pr_branches/index.md +++ b/website/docs/services/repos/commit_pr_branches/index.md @@ -1,72 +1,364 @@ ---- +--- title: commit_pr_branches hide_title: false hide_table_of_contents: false keywords: - commit_pr_branches - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commit_pr_branches resource. ## Overview - +
Namecommit_pr_branches
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `object` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | How the author is associated with the repository. | -| | `object` | The status of auto merging a pull request. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Indicates whether or not the pull request is a draft. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `object` | A collection of related issues and pull requests. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `array` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: MDExOlB1bGxSZXF1ZXN0MQ==)
object
string (example: too heated)
objectA GitHub user. (title: Simple User)
array
stringHow the author is associated with the repository. (COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER) (title: author_association, example: OWNER)
objectThe status of auto merging a pull request. (title: Auto merge)
object
string (example: Please pull these awesome changes)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347.diff)
booleanIndicates whether or not the pull request is a draft.
object
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/issues/1347)
array
boolean
string (example: e5bd3914e2e596debea16f433f57875b5b90bcd6)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectA collection of related issues and pull requests. (title: Milestone)
integer
string (uri) (example: https://github.com/octocat/Hello-World/pull/1347.patch)
array
array
string (example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number})
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments)
string (example: open)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e)
string (example: new-feature)
string (date-time) (example: 2011-01-26T19:01:12Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/pulls/1347)
objectA GitHub user. (title: Simple User)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, commit_shaper_page, pageLists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.

To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe SHA of the commit.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit.

To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + +```sql +SELECT +id, +node_id, +_links, +active_lock_reason, +assignee, +assignees, +author_association, +auto_merge, +base, +body, +closed_at, +comments_url, +commits_url, +created_at, +diff_url, +draft, +head, +html_url, +issue_url, +labels, +locked, +merge_commit_sha, +merged_at, +milestone, +number, +patch_url, +requested_reviewers, +requested_teams, +review_comment_url, +review_comments_url, +state, +statuses_url, +title, +updated_at, +url, +user +FROM github.repos.commit_pr_branches +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND commit_sha = '{{ commit_sha }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/commit_signature_protection/index.md b/website/docs/services/repos/commit_signature_protection/index.md index cb3de16..750b00e 100644 --- a/website/docs/services/repos/commit_signature_protection/index.md +++ b/website/docs/services/repos/commit_signature_protection/index.md @@ -1,40 +1,234 @@ ---- +--- title: commit_signature_protection hide_title: false hide_table_of_contents: false keywords: - commit_signature_protection - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commit_signature_protection resource. ## Overview - +
Namecommit_signature_protection
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `boolean` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.

**Note**: You must enable branch protection to require signed commits. | -| | `INSERT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.

> [!NOTE]
> You must enable branch protection to require signed commits.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.

> [!NOTE]
> You must enable branch protection to require signed commits. + +```sql +SELECT +enabled, +url +FROM github.repos.commit_signature_protection +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. + +```sql +INSERT INTO github.repos.commit_signature_protection ( +owner, +repo, +branch +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ branch }}' +RETURNING +enabled, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: commit_signature_protection + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the commit_signature_protection resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the commit_signature_protection resource. + - name: branch + value: "{{ branch }}" + description: Required parameter for the commit_signature_protection resource. +`} + + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. + +```sql +DELETE FROM github.repos.commit_signature_protection +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/commits/index.md b/website/docs/services/repos/commits/index.md index 1c4fe7c..64f39ea 100644 --- a/website/docs/services/repos/commits/index.md +++ b/website/docs/services/repos/commits/index.md @@ -1,49 +1,478 @@ ---- +--- title: commits hide_title: false hide_table_of_contents: false keywords: - commits - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commits resource. ## Overview - +
Namecommits
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `object` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments)
object
objectA GitHub user. (title: Simple User)
array
string (uri) (example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e)
array
string (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
object
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
objectCommit (title: Commit)
integer
array
string (uri) (example: https://github.com/octocat/Hello-World/compare/master...topic.diff)
array
string (uri) (example: https://github.com/octocat/Hello-World/compare/master...topic)
objectCommit (title: Commit)
string (uri) (example: https://github.com/octocat/Hello-World/compare/master...topic.patch)
string (uri) (example: https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17)
string (diverged, ahead, behind, identical) (example: ahead)
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/compare/master...topic)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments)
object
objectA GitHub user. (title: Simple User)
array
string (uri) (example: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e)
array
string (example: 6dcb09b5b57875f334f61aebed695e2e4193db5e)
object
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.

**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.

To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | -| | `SELECT` | | **Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | -| | `EXEC` | | Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."

This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.

When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

**Working with large comparisons**

To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:

- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.

For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:

\| Name \| Type \| Description \|
\| ---- \| ---- \| ----------- \|
\| `verified` \| `boolean` \| Indicates whether GitHub considers the signature in this commit to be verified. \|
\| `reason` \| `string` \| The reason for verified value. Possible values and their meanings are enumerated in table below. \|
\| `signature` \| `string` \| The signature that was extracted from the commit. \|
\| `payload` \| `string` \| The value that was signed. \|

These are the possible values for `reason` in the `verification` object:

\| Value \| Description \|
\| ----- \| ----------- \|
\| `expired_key` \| The key that made the signature is expired. \|
\| `not_signing_key` \| The "signing" flag is not among the usage flags in the GPG key that made the signature. \|
\| `gpgverify_error` \| There was an error communicating with the signature verification service. \|
\| `gpgverify_unavailable` \| The signature verification service is currently unavailable. \|
\| `unsigned` \| The object does not include a signature. \|
\| `unknown_signature_type` \| A non-PGP signature was found in the commit. \|
\| `no_user` \| No user was associated with the `committer` email address in the commit. \|
\| `unverified_email` \| The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. \|
\| `bad_email` \| The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. \|
\| `unknown_key` \| The key that made the signature has not been registered with any user's account. \|
\| `malformed_signature` \| There was an error parsing the signature. \|
\| `invalid` \| The signature could not be cryptographically verified using the key whose key-id was found in the signature. \|
\| `valid` \| None of the above errors applied, so the signature is considered to be verified. \| | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, refpage, per_pageReturns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.

> [!NOTE]
> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.

- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
owner, repo, baseheadpage, per_pageCompares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."

This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.diff`**: Returns the diff of the commit.
- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.

When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

**Working with large comparisons**

To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:

- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.

For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
owner, reposha, path, author, committer, since, until, per_page, page**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. |
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.
stringThe account owner of the repository. The name is not case sensitive.
stringThe commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringGitHub username or email address to use to filter by commit author.
stringGitHub username or email address to use to filter by commit committer.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringOnly commits containing this file path will be returned.
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringSHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).
string (date-time)Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.
string (date-time)Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned.
+ +## `SELECT` examples + + + + +Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.

> [!NOTE]
> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types.

- **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code.
- **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +SELECT +node_id, +author, +comments_url, +commit, +committer, +files, +html_url, +parents, +sha, +stats, +url +FROM github.repos.commits +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + +Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."

This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.diff`**: Returns the diff of the commit.
- **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property.

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.

When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

**Working with large comparisons**

To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:

- The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.

For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."

**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +SELECT +ahead_by, +base_commit, +behind_by, +commits, +diff_url, +files, +html_url, +merge_base_commit, +patch_url, +permalink_url, +status, +total_commits, +url +FROM github.repos.commits +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND basehead = '{{ basehead }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + +**Signature verification object**

The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:

| Name | Type | Description |
| ---- | ---- | ----------- |
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
| `signature` | `string` | The signature that was extracted from the commit. |
| `payload` | `string` | The value that was signed. |
| `verified_at` | `string` | The date the signature was verified by GitHub. |

These are the possible values for `reason` in the `verification` object:

| Value | Description |
| ----- | ----------- |
| `expired_key` | The key that made the signature is expired. |
| `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. |
| `gpgverify_error` | There was an error communicating with the signature verification service. |
| `gpgverify_unavailable` | The signature verification service is currently unavailable. |
| `unsigned` | The object does not include a signature. |
| `unknown_signature_type` | A non-PGP signature was found in the commit. |
| `no_user` | No user was associated with the `committer` email address in the commit. |
| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. |
| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |
| `unknown_key` | The key that made the signature has not been registered with any user's account. |
| `malformed_signature` | There was an error parsing the signature. |
| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
| `valid` | None of the above errors applied, so the signature is considered to be verified. | + +```sql +SELECT +node_id, +author, +comments_url, +commit, +committer, +files, +html_url, +parents, +sha, +stats, +url +FROM github.repos.commits +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND sha = '{{ sha }}' +AND path = '{{ path }}' +AND author = '{{ author }}' +AND committer = '{{ committer }}' +AND since = '{{ since }}' +AND until = '{{ until }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/community/index.md b/website/docs/services/repos/community/index.md index 8aa77d5..52acd5c 100644 --- a/website/docs/services/repos/community/index.md +++ b/website/docs/services/repos/community/index.md @@ -1,42 +1,166 @@ ---- +--- title: community hide_title: false hide_table_of_contents: false keywords: - community - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a community resource. ## Overview - +
Namecommunity
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `boolean` | -| | `string` | -| | `object` | -| | `integer` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
string (example: My first repository on GitHub!)
string (example: example.com)
object
integer
string (date-time) (example: 2017-02-28T19:09:29Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns all community profile metrics for a repository. The repository cannot be a fork.

The returned metrics include an overall health score, the repository description, the presence of documentation, the
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
README, and CONTRIBUTING files.

The `health_percentage` score is defined as a percentage of how many of
the recommended community health files are present. For more information, see
"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."

`content_reports_enabled` is only returned for organization-owned repositories.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns all community profile metrics for a repository. The repository cannot be a fork.

The returned metrics include an overall health score, the repository description, the presence of documentation, the
detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
README, and CONTRIBUTING files.

The `health_percentage` score is defined as a percentage of how many of
the recommended community health files are present. For more information, see
"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)."

`content_reports_enabled` is only returned for organization-owned repositories. + +```sql +SELECT +content_reports_enabled, +description, +documentation, +files, +health_percentage, +updated_at +FROM github.repos.community +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/content_traffic/index.md b/website/docs/services/repos/content_traffic/index.md index a2eccbe..6e58f84 100644 --- a/website/docs/services/repos/content_traffic/index.md +++ b/website/docs/services/repos/content_traffic/index.md @@ -1,40 +1,154 @@ ---- +--- title: content_traffic hide_title: false hide_table_of_contents: false keywords: - content_traffic - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a content_traffic resource. ## Overview - +
Namecontent_traffic
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: /github/hubot)
string (example: github/hubot: A customizable life embetterment robot.)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGet the top 10 popular contents over the last 14 days.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the top 10 popular contents over the last 14 days. + +```sql +SELECT +count, +path, +title, +uniques +FROM github.repos.content_traffic +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/content_tree/index.md b/website/docs/services/repos/content_tree/index.md index d9bbdba..287628e 100644 --- a/website/docs/services/repos/content_tree/index.md +++ b/website/docs/services/repos/content_tree/index.md @@ -1,72 +1,220 @@ ---- +--- title: content_tree hide_title: false hide_table_of_contents: false keywords: - content_tree - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a content_tree resource. ## Overview - +
Namecontent_tree
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `object` | -| | `string` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string (uri)
string
array
string (uri)
string (uri)
string
string
integer
string
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pathrefGets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.

**Notes**:

- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve
more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).
- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
- If the requested file's size is:
- 1 MB or smaller: All features of this endpoint are supported.
- Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
- Greater than 100 MB: This endpoint is not supported.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringpath parameter
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe name of the commit/branch/tag. Default: the repository’s default branch.
+ +## `SELECT` examples + + + + +Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks.
- **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
- **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects.

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values.

**Notes**:

- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).
- This API has an upper limit of 1,000 files for a directory. If you need to retrieve
more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree).
- Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
- If the requested file's size is:
- 1 MB or smaller: All features of this endpoint are supported.
- Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty
string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type.
- Greater than 100 MB: This endpoint is not supported. + +```sql +SELECT +name, +_links, +content, +download_url, +encoding, +entries, +git_url, +html_url, +path, +sha, +size, +type, +url +FROM github.repos.content_tree +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND path = '{{ path }}' -- required +AND ref = '{{ ref }}' +; +``` + + diff --git a/website/docs/services/repos/contents/index.md b/website/docs/services/repos/contents/index.md index 1d3e439..3f6cdbe 100644 --- a/website/docs/services/repos/contents/index.md +++ b/website/docs/services/repos/contents/index.md @@ -1,55 +1,481 @@ ---- +--- title: contents hide_title: false hide_table_of_contents: false keywords: - contents - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a contents resource. ## Overview - +
Namecontents
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string (uri)
string
string (uri)
string (uri)
string
string
integer
string (example: "git://example.com/defunkt/dotjs.git")
string (example: "actual/actual.md")
string (file)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
string
string (uri)
string
string (uri)
string (uri)
string
string
integer
string (example: "git://example.com/defunkt/dotjs.git")
string (example: "actual/actual.md")
string (file)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets the preferred README for a repository.

READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. | -| | `SELECT` | | Gets the README from a repository directory.

READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. | -| | `INSERT` | | Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.

**Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. | -| | `DELETE` | | Deletes a file in a repository.

You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.

The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.

You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.

**Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. | -| | `EXEC` | | Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the `Location` header to make a second `GET` request.
**Note**: For private repositories, these links are temporary and expire after five minutes. | -| | `EXEC` | | Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
the `Location` header to make a second `GET` request.

**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, dirrefGets the README from a repository directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
owner, reporefGets the preferred README for a repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup).
owner, repo, path, message, contentCreates a new file or replaces an existing file in a repository.

> [!NOTE]
> If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.
owner, repo, pathDeletes a file in a repository.

You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.

The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.

You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.

> [!NOTE]
> If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe alternate path to look for a README file
stringThe account owner of the repository. The name is not case sensitive.
stringpath parameter
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe name of the commit/branch/tag. Default: the repository’s default branch.
+ +## `SELECT` examples + + + + +Gets the README from a repository directory.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + +```sql +SELECT +name, +_links, +content, +download_url, +encoding, +git_url, +html_url, +path, +sha, +size, +submodule_git_url, +target, +type, +url +FROM github.repos.contents +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND dir = '{{ dir }}' -- required +AND ref = '{{ ref }}' +; +``` + + + +Gets the preferred README for a repository.

This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."

- **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type.
- **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + +```sql +SELECT +name, +_links, +content, +download_url, +encoding, +git_url, +html_url, +path, +sha, +size, +submodule_git_url, +target, +type, +url +FROM github.repos.contents +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a new file or replaces an existing file in a repository.

> [!NOTE]
> If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + +```sql +INSERT INTO github.repos.contents ( +message, +content, +sha, +branch, +committer, +author, +owner, +repo, +path +) +SELECT +'{{ message }}' /* required */, +'{{ content }}' /* required */, +'{{ sha }}', +'{{ branch }}', +'{{ committer }}', +'{{ author }}', +'{{ owner }}', +'{{ repo }}', +'{{ path }}' +RETURNING +commit, +content +; +``` + + + +{`# Description fields are for documentation purposes +- name: contents + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the contents resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the contents resource. + - name: path + value: "{{ path }}" + description: Required parameter for the contents resource. + - name: message + value: "{{ message }}" + description: | + The commit message. + - name: content + value: "{{ content }}" + description: | + The new file content, using Base64 encoding. + - name: sha + value: "{{ sha }}" + description: | + **Required if you are updating a file**. The blob SHA of the file being replaced. + - name: branch + value: "{{ branch }}" + description: | + The branch name. Default: the repository’s default branch. + - name: committer + description: | + The person that committed the file. Default: the authenticated user. + value: + name: "{{ name }}" + email: "{{ email }}" + date: "{{ date }}" + - name: author + description: | + The author of the file. Default: The \`committer\` or the authenticated user if you omit \`committer\`. + value: + name: "{{ name }}" + email: "{{ email }}" + date: "{{ date }}" +`} + + + + + +## `DELETE` examples + + + + +Deletes a file in a repository.

You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.

The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.

You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.

> [!NOTE]
> If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + +```sql +DELETE FROM github.repos.contents +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND path = '{{ path }}' --required +; +``` + + diff --git a/website/docs/services/repos/contributors/index.md b/website/docs/services/repos/contributors/index.md index 02b1a2a..3a9942f 100644 --- a/website/docs/services/repos/contributors/index.md +++ b/website/docs/services/repos/contributors/index.md @@ -1,57 +1,280 @@ ---- +--- title: contributors hide_title: false hide_table_of_contents: false keywords: - contributors - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a contributors resource. ## Overview - +
Namecontributors
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +If repository contains content + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
string
string (uri)
integer
string
string
string (uri)
string
string
string (uri)
string
string (uri)
string (uri)
string (uri)
boolean
string
string (uri)
string
string (uri)
string
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoanon, per_page, pageLists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringSet to `1` or `true` to include anonymous contributors in results.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.

GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +contributions, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.repos.contributors +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND anon = '{{ anon }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/custom_property_values/index.md b/website/docs/services/repos/custom_property_values/index.md new file mode 100644 index 0000000..7a84e5a --- /dev/null +++ b/website/docs/services/repos/custom_property_values/index.md @@ -0,0 +1,174 @@ +--- +title: custom_property_values +hide_title: false +hide_table_of_contents: false +keywords: + - custom_property_values + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a custom_property_values resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the property
stringThe value assigned to the property
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets all custom property values that are set for a repository.
Users with read access to the repository can use this endpoint.
owner, repo, propertiesCreate new or update existing custom property values for a repository.
Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets all custom property values that are set for a repository.
Users with read access to the repository can use this endpoint. + +```sql +SELECT +property_name, +value +FROM github.repos.custom_property_values +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Create new or update existing custom property values for a repository.
Using a value of `null` for a custom property will remove or 'unset' the property value from the repository.

Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + +```sql +UPDATE github.repos.custom_property_values +SET +properties = '{{ properties }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND properties = '{{ properties }}' --required; +``` + + diff --git a/website/docs/services/repos/deploy_keys/index.md b/website/docs/services/repos/deploy_keys/index.md index e8e1bdc..e1cb949 100644 --- a/website/docs/services/repos/deploy_keys/index.md +++ b/website/docs/services/repos/deploy_keys/index.md @@ -1,48 +1,413 @@ ---- +--- title: deploy_keys hide_title: false hide_table_of_contents: false keywords: - deploy_keys - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a deploy_keys resource. ## Overview - +
Namedeploy_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `boolean` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
boolean
string
string (date-time)
boolean
string
string
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
boolean
string
string (date-time)
boolean
string
string
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `SELECT` | | | -| | `INSERT` | | You can create a read-only deploy key. | -| | `DELETE` | | Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, key_id
owner, repoper_page, page
owner, repo, keyYou can create a read-only deploy key.
owner, repo, key_idDeploy keys are immutable. If you need to update a key, remove the key and create a new one instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the key.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +id, +added_by, +created_at, +enabled, +key, +last_used, +read_only, +title, +url, +verified +FROM github.repos.deploy_keys +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND key_id = '{{ key_id }}' -- required +; +``` + + + +Response + +```sql +SELECT +id, +added_by, +created_at, +enabled, +key, +last_used, +read_only, +title, +url, +verified +FROM github.repos.deploy_keys +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +You can create a read-only deploy key. + +```sql +INSERT INTO github.repos.deploy_keys ( +title, +key, +read_only, +owner, +repo +) +SELECT +'{{ title }}', +'{{ key }}' /* required */, +{{ read_only }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +added_by, +created_at, +enabled, +key, +last_used, +read_only, +title, +url, +verified +; +``` + + + +{`# Description fields are for documentation purposes +- name: deploy_keys + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the deploy_keys resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the deploy_keys resource. + - name: title + value: "{{ title }}" + description: | + A name for the key. + - name: key + value: "{{ key }}" + description: | + The contents of the key. + - name: read_only + value: {{ read_only }} + description: | + If \`true\`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." +`} + + + + + +## `DELETE` examples + + + + +Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. + +```sql +DELETE FROM github.repos.deploy_keys +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND key_id = '{{ key_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/deployment_rule_integrations/index.md b/website/docs/services/repos/deployment_rule_integrations/index.md index 6199e42..5eaaefa 100644 --- a/website/docs/services/repos/deployment_rule_integrations/index.md +++ b/website/docs/services/repos/deployment_rule_integrations/index.md @@ -1,38 +1,160 @@ ---- +--- title: deployment_rule_integrations hide_title: false hide_table_of_contents: false keywords: - deployment_rule_integrations - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a deployment_rule_integrations resource. ## Overview - +
Namedeployment_rule_integrations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `array` | | -| | `integer` | The total number of custom deployment protection rule integrations available for this environment. | + +The following fields are returned by `SELECT` queries: + + + + +A list of custom deployment rule integrations available for this environment. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerThe total number of custom deployment protection rule integrations available for this environment.
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
environment_name, repo, ownerpage, per_pageGets all custom deployment protection rule integrations that are available for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets all custom deployment protection rule integrations that are available for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)".

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +available_custom_deployment_protection_rule_integrations, +total_count +FROM github.repos.deployment_rule_integrations +WHERE environment_name = '{{ environment_name }}' -- required +AND repo = '{{ repo }}' -- required +AND owner = '{{ owner }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/repos/deployments/index.md b/website/docs/services/repos/deployments/index.md index b26b6ca..d0fb5ac 100644 --- a/website/docs/services/repos/deployments/index.md +++ b/website/docs/services/repos/deployments/index.md @@ -1,57 +1,583 @@ ---- +--- title: deployments hide_title: false hide_table_of_contents: false keywords: - deployments - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a deployments resource. ## Overview - +
Namedeployments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the deployment | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | Name for the target deployment environment. | -| | `string` | | -| | `string` | | -| | `` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `boolean` | Specifies if the given environment is one that end-users directly interact with. Default: false. | -| | `string` | The ref to deploy. This can be a branch, tag, or sha. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | Parameter to specify a task to execute | -| | `boolean` | Specifies if the given environment is will no longer exist at some point in the future. Default: false. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the deployment
string (example: MDEwOkRlcGxveW1lbnQx)
string (date-time) (example: 2012-07-20T01:19:13Z)
objectA GitHub user. (title: Simple User)
string (example: Deploy request from hubot)
stringName for the target deployment environment. (example: production)
string (example: staging)
object
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
booleanSpecifies if the given environment is one that end-users directly interact with. Default: false.
stringThe ref to deploy. This can be a branch, tag, or sha. (example: topic-branch)
string (uri) (example: https://api.github.com/repos/octocat/example)
string (example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/1/statuses)
stringParameter to specify a task to execute (example: deploy)
booleanSpecifies if the given environment is will no longer exist at some point in the future. Default: false.
string (date-time) (example: 2012-07-20T01:19:13Z)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the deployment
string (example: MDEwOkRlcGxveW1lbnQx)
string (date-time) (example: 2012-07-20T01:19:13Z)
objectA GitHub user. (title: Simple User)
string (example: Deploy request from hubot)
stringName for the target deployment environment. (example: production)
string (example: staging)
object
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
booleanSpecifies if the given environment is one that end-users directly interact with. Default: false.
stringThe ref to deploy. This can be a branch, tag, or sha. (example: topic-branch)
string (uri) (example: https://api.github.com/repos/octocat/example)
string (example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/1/statuses)
stringParameter to specify a task to execute (example: deploy)
booleanSpecifies if the given environment is will no longer exist at some point in the future. Default: false.
string (date-time) (example: 2012-07-20T01:19:13Z)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `SELECT` | | Simple filtering of deployments is available via query parameters: | -| | `INSERT` | | Deployments offer a few configurable parameters with certain defaults.

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

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

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

By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`
state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.

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

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

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

Merged branch response:

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
* Auto-merge option is enabled in the repository
* Topic branch does not include the latest changes on the base branch, which is `master` in the response example
* There are no merge conflicts

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

Merge conflict response:

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

Failed commit status checks:

This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`
status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. | -| | `DELETE` | | If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.

To set a deployment as inactive, you must:

* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, deployment_id
owner, reposha, ref, task, environment, per_page, pageSimple filtering of deployments is available via query parameters:
owner, repo, refDeployments offer a few configurable parameters with certain defaults.

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

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

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

By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`
state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.

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

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

Merged branch response:

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
* Auto-merge option is enabled in the repository
* Topic branch does not include the latest changes on the base branch, which is `master` in the response example
* There are no merge conflicts

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

Merge conflict response:

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

Failed commit status checks:

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

OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
owner, repo, deployment_idIf the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

To set a deployment as inactive, you must:

* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerdeployment_id parameter
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe name of the environment that was deployed to (e.g., `staging` or `production`).
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe name of the ref. This can be a branch, tag, or SHA.
stringThe SHA recorded at creation time.
stringThe name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +id, +node_id, +created_at, +creator, +description, +environment, +original_environment, +payload, +performed_via_github_app, +production_environment, +ref, +repository_url, +sha, +statuses_url, +task, +transient_environment, +updated_at, +url +FROM github.repos.deployments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND deployment_id = '{{ deployment_id }}' -- required +; +``` + + + +Simple filtering of deployments is available via query parameters: + +```sql +SELECT +id, +node_id, +created_at, +creator, +description, +environment, +original_environment, +payload, +performed_via_github_app, +production_environment, +ref, +repository_url, +sha, +statuses_url, +task, +transient_environment, +updated_at, +url +FROM github.repos.deployments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND sha = '{{ sha }}' +AND ref = '{{ ref }}' +AND task = '{{ task }}' +AND environment = '{{ environment }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Deployments offer a few configurable parameters with certain defaults.

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

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

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

By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`
state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.

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

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

Merged branch response:

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
* Auto-merge option is enabled in the repository
* Topic branch does not include the latest changes on the base branch, which is `master` in the response example
* There are no merge conflicts

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

Merge conflict response:

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

Failed commit status checks:

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

OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + +```sql +INSERT INTO github.repos.deployments ( +ref, +task, +auto_merge, +required_contexts, +payload, +environment, +description, +transient_environment, +production_environment, +owner, +repo +) +SELECT +'{{ ref }}' /* required */, +'{{ task }}', +{{ auto_merge }}, +'{{ required_contexts }}', +'{{ payload }}', +'{{ environment }}', +'{{ description }}', +{{ transient_environment }}, +{{ production_environment }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +node_id, +created_at, +creator, +description, +environment, +original_environment, +payload, +performed_via_github_app, +production_environment, +ref, +repository_url, +sha, +statuses_url, +task, +transient_environment, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: deployments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the deployments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the deployments resource. + - name: ref + value: "{{ ref }}" + description: | + The ref to deploy. This can be a branch, tag, or SHA. + - name: task + value: "{{ task }}" + description: | + Specifies a task to execute (e.g., \`deploy\` or \`deploy:migrations\`). + default: deploy + - name: auto_merge + value: {{ auto_merge }} + description: | + Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. + default: true + - name: required_contexts + value: + - "{{ required_contexts }}" + description: | + The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. + - name: payload + value: "{{ payload }}" + description: | + JSON payload with extra information about the deployment. + default: + - name: environment + value: "{{ environment }}" + description: | + Name for the target deployment environment (e.g., \`production\`, \`staging\`, \`qa\`). + default: production + - name: description + value: "{{ description }}" + description: | + Short description of the deployment. + default: + - name: transient_environment + value: {{ transient_environment }} + description: | + Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: \`false\` + default: false + - name: production_environment + value: {{ production_environment }} + description: | + Specifies if the given environment is one that end-users directly interact with. Default: \`true\` when \`environment\` is \`production\` and \`false\` otherwise. +`} + + + + + +## `DELETE` examples + + + + +If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

To set a deployment as inactive, you must:

* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* Mark the active deployment as inactive by adding any non-successful deployment status.

For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + +```sql +DELETE FROM github.repos.deployments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND deployment_id = '{{ deployment_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/details/index.md b/website/docs/services/repos/details/index.md index acf68de..5a1a1a4 100644 --- a/website/docs/services/repos/details/index.md +++ b/website/docs/services/repos/details/index.md @@ -1,138 +1,760 @@ ---- +--- title: details hide_title: false hide_table_of_contents: false keywords: - details - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a details resource. ## Overview - +
Namedetails
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | Whether anonymous git access is allowed. | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code of Conduct Simple | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | Returns whether or not this repository disabled. | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | License Simple | -| | `string` | | -| | `string` | The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message. | -| | `string` | The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | A GitHub user. | -| | `object` | A repository on GitHub. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `object` | A repository on GitHub. | -| | `string` | The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message. | -| | `string` | The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A repository on GitHub. | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | The repository visibility: public, private, or internal. | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
boolean
boolean
boolean
boolean
boolean
boolean
booleanWhether anonymous git access is allowed.
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string (example: https://github.com/octocat/Hello-World.git)
objectCode of Conduct Simple (title: Code Of Conduct Simple)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string (example: master)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
booleanReturns whether or not this repository disabled.
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string (example: git:github.com/octocat/Hello-World.git)
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string (uri) (example: https://github.com)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
objectLicense Simple (title: License Simple)
string
stringThe default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. (PR_BODY, PR_TITLE, BLANK) (example: PR_BODY)
stringThe default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). (PR_TITLE, MERGE_MESSAGE) (example: PR_TITLE)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string (uri) (example: git:git.example.com/octocat/Hello-World)
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
objectA repository on GitHub. (title: Repository)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only) (example: all)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
objectA repository on GitHub. (title: Repository)
stringThe default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. (PR_BODY, COMMIT_MESSAGES, BLANK) (example: PR_BODY)
stringThe default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). (PR_TITLE, COMMIT_OR_PR_TITLE) (example: PR_TITLE)
string (example: git@github.com:octocat/Hello-World.git)
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string (uri) (example: https://svn.github.com/octocat/Hello-World)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
objectA repository on GitHub. (title: Repository)
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
boolean
stringThe repository visibility: public, private, or internal. (example: public)
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.

> [!NOTE]
> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.

> [!NOTE]
> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. + +```sql +SELECT +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.repos.details +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/environments/index.md b/website/docs/services/repos/environments/index.md index 84ca06d..b215ac0 100644 --- a/website/docs/services/repos/environments/index.md +++ b/website/docs/services/repos/environments/index.md @@ -1,48 +1,372 @@ ---- +--- title: environments hide_title: false hide_table_of_contents: false keywords: - environments - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an environments resource. ## Overview - +
Nameenvironments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The id of the environment. | -| | `string` | The name of the environment. | -| | `string` | The time that the environment was created, in ISO 8601 format. | -| | `object` | The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. | -| | `string` | | -| | `string` | | -| | `array` | Built-in deployment protection rules for the environment. | -| | `string` | The time that the environment was last updated, in ISO 8601 format. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)The id of the environment.
stringThe name of the environment. (example: staging)
string (example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg=)
string (date-time)The time that the environment was created, in ISO 8601 format. (example: 2020-11-23T22:00:40Z)
objectThe type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.
string (example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging)
arrayBuilt-in deployment protection rules for the environment.
string (date-time)The time that the environment was last updated, in ISO 8601 format. (example: 2020-11-23T22:00:40Z)
string (example: https://api.github.com/repos/github/hello-world/environments/staging)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerThe number of environments in this repository
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the environments for a repository.

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. | -| | `SELECT` | | **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)."

Anyone with read access to the repository can use this endpoint. If the
repository is private, you must use an access token with the `repo` scope. GitHub
Apps must have the `actions:read` permission to use this endpoint. | -| | `INSERT` | | Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."

**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."

**Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)."

You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. | -| | `DELETE` | | You must authenticate using an access token with the repo scope to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, environment_name> [!NOTE]
> To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy)."

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repoper_page, pageLists the environments for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
owner, repo, environment_nameCreate or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](https://docs.github.com/actions/reference/environments#environment-protection-rules)."

> [!NOTE]
> To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](https://docs.github.com/rest/deployments/branch-policies)."

> [!NOTE]
> To create or update secrets for an environment, see "[GitHub Actions secrets](https://docs.github.com/rest/actions/secrets)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, environment_nameOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +> [!NOTE]
> To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy)."

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +name, +node_id, +created_at, +deployment_branch_policy, +html_url, +protection_rules, +updated_at, +url +FROM github.repos.environments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +; +``` + + + +Lists the environments for a repository.

Anyone with read access to the repository can use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +environments, +total_count +FROM github.repos.environments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](https://docs.github.com/actions/reference/environments#environment-protection-rules)."

> [!NOTE]
> To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](https://docs.github.com/rest/deployments/branch-policies)."

> [!NOTE]
> To create or update secrets for an environment, see "[GitHub Actions secrets](https://docs.github.com/rest/actions/secrets)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.repos.environments ( +wait_timer, +prevent_self_review, +reviewers, +deployment_branch_policy, +owner, +repo, +environment_name +) +SELECT +{{ wait_timer }}, +{{ prevent_self_review }}, +'{{ reviewers }}', +'{{ deployment_branch_policy }}', +'{{ owner }}', +'{{ repo }}', +'{{ environment_name }}' +RETURNING +id, +name, +node_id, +created_at, +deployment_branch_policy, +html_url, +protection_rules, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: environments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the environments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the environments resource. + - name: environment_name + value: "{{ environment_name }}" + description: Required parameter for the environments resource. + - name: wait_timer + value: {{ wait_timer }} + description: | + The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). + - name: prevent_self_review + value: {{ prevent_self_review }} + description: | + Whether or not a user who created the job is prevented from approving their own job. + - name: reviewers + description: | + The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. + value: + - type: "{{ type }}" + id: {{ id }} + - name: deployment_branch_policy + description: | + The type of deployment branch policy for this environment. To allow all branches to deploy, set to \`null\`. + value: + protected_branches: {{ protected_branches }} + custom_branch_policies: {{ custom_branch_policies }} +`} + + + + + +## `DELETE` examples + + + + +OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.repos.environments +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND environment_name = '{{ environment_name }}' --required +; +``` + + diff --git a/website/docs/services/repos/forks/index.md b/website/docs/services/repos/forks/index.md index cac56e3..ff5af08 100644 --- a/website/docs/services/repos/forks/index.md +++ b/website/docs/services/repos/forks/index.md @@ -1,124 +1,860 @@ ---- +--- title: forks hide_title: false hide_table_of_contents: false keywords: - forks - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a forks resource. ## Overview - +
Nameforks
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | | -| | `INSERT` | | Create a fork for the authenticated user.

**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).

**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, reposort, per_page, page
owner, repoCreate a fork for the authenticated user.

> [!NOTE]
> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).

> [!NOTE]
> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe sort order. `stargazers` will sort by star count.
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.repos.forks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND sort = '{{ sort }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a fork for the authenticated user.

> [!NOTE]
> Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).

> [!NOTE]
> Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + +```sql +INSERT INTO github.repos.forks ( +organization, +name, +default_branch_only, +owner, +repo +) +SELECT +'{{ organization }}', +'{{ name }}', +{{ default_branch_only }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +; +``` + + + +{`# Description fields are for documentation purposes +- name: forks + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the forks resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the forks resource. + - name: organization + value: "{{ organization }}" + description: | + Optional parameter to specify the organization name if forking into an organization. + - name: name + value: "{{ name }}" + description: | + When forking from an existing repository, a new name for the fork. + - name: default_branch_only + value: {{ default_branch_only }} + description: | + When forking from an existing repository, fork with only the default branch. +`} + + + diff --git a/website/docs/services/repos/head_commit_branches/index.md b/website/docs/services/repos/head_commit_branches/index.md index 53af973..1a52742 100644 --- a/website/docs/services/repos/head_commit_branches/index.md +++ b/website/docs/services/repos/head_commit_branches/index.md @@ -1,39 +1,154 @@ ---- +--- title: head_commit_branches hide_title: false hide_table_of_contents: false keywords: - head_commit_branches - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a head_commit_branches resource. ## Overview - +
Namehead_commit_branches
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `object` | -| | `boolean` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
object
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, commit_shaProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe SHA of the commit.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + +```sql +SELECT +name, +commit, +protected +FROM github.repos.head_commit_branches +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND commit_sha = '{{ commit_sha }}' -- required +; +``` + + diff --git a/website/docs/services/repos/index.md b/website/docs/services/repos/index.md index cd00cb3..4b7068c 100644 --- a/website/docs/services/repos/index.md +++ b/website/docs/services/repos/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With GitHub Repos. - -:::info Service Summary +repos service documentation. -
-
-total resources: 65
-total selectable resources: 65
-total methods: 188
-
-
+:::info[Service Summary] -::: +total resources: __73__ -## Overview - - - - - - -
Namegithub.repos
TypeService
TitleGitHub V3 REST API - Repos
DescriptionInteract With GitHub Repos.
Idrepos:v24.04.00227
+::: ## Resources
@@ -44,6 +29,7 @@ Interact With GitHub Repos. admin_branch_protection
app_access_restrictions
assets
+attestations
autolinks
branch
branch_policies
@@ -51,6 +37,7 @@ Interact With GitHub Repos. branch_restrictions
branches
clone_traffic
+codeowners
collaborator_permissions
collaborators
comments
@@ -62,6 +49,7 @@ Interact With GitHub Repos. content_tree
contents
contributors
+custom_property_values
deploy_keys
deployment_rule_integrations
deployments
@@ -70,21 +58,26 @@ Interact With GitHub Repos. forks
head_commit_branches
invitations
-org_rules
page_build_latest
page_builds
+pages
+pages_health_check
-pages
-pages_health_check
pr_review_protection
+private_vulnerability_reporting
protection_rules
referrer_traffic
releases
releases_latest
+repo_immutable_releases
+repo_pages_deployments
repos
repos_for_auth_user
+repository_dispatches
+rule_suites
rules
+ruleset_history
security_fixes
stats_code_frequency
stats_commit_activity
@@ -96,16 +89,16 @@ Interact With GitHub Repos. status_combined
status_commits
status_deployments
-tag_protection
tags
team_access_restrictions
teams
topics
user_access_restrictions
view_traffic
+vulnerability_alerts
webhook_config
webhook_deliveries
webhook_delivery
-webhooks
-
+webhooks + \ No newline at end of file diff --git a/website/docs/services/repos/invitations/index.md b/website/docs/services/repos/invitations/index.md index a717a02..8f66448 100644 --- a/website/docs/services/repos/invitations/index.md +++ b/website/docs/services/repos/invitations/index.md @@ -1,51 +1,423 @@ ---- +--- title: invitations hide_title: false hide_table_of_contents: false keywords: - invitations - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an invitations resource. ## Overview - +
Nameinvitations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the repository invitation. | -| | `string` | | -| | `boolean` | Whether or not the invitation has expired | -| | `string` | | -| | `object` | A GitHub user. | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | The permission associated with the invitation. | -| | `object` | Minimal Repository | -| | `string` | URL for the repository invitation | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the repository invitation.
string
string (date-time) (example: 2016-06-13T14:52:50-05:00)
booleanWhether or not the invitation has expired
string (example: https://github.com/octocat/Hello-World/invitations)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
stringThe permission associated with the invitation. (read, write, admin, triage, maintain) (example: read)
objectMinimal Repository (title: Minimal Repository)
stringURL for the repository invitation (example: https://api.github.com/user/repository-invitations/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the repository invitation.
string
string (date-time) (example: 2016-06-13T14:52:50-05:00)
booleanWhether or not the invitation has expired
string (example: https://github.com/octocat/Hello-World/invitations)
objectA GitHub user. (title: Simple User)
objectA GitHub user. (title: Simple User)
stringThe permission associated with the invitation. (read, write, admin, triage, maintain) (example: read)
objectMinimal Repository (title: Minimal Repository)
stringURL for the repository invitation (example: https://api.github.com/user/repository-invitations/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. | -| | `SELECT` | | When authenticating as a user, this endpoint will list all currently open repository invitations for that user. | -| | `DELETE` | | | -| | `EXEC` | | | -| | `EXEC` | | | -| | `EXEC` | | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageWhen authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.
per_page, pageWhen authenticating as a user, this endpoint will list all currently open repository invitations for that user.
owner, repo, invitation_id
owner, repo, invitation_id
invitation_id
invitation_id
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the invitation.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. + +```sql +SELECT +id, +node_id, +created_at, +expired, +html_url, +invitee, +inviter, +permissions, +repository, +url +FROM github.repos.invitations +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +When authenticating as a user, this endpoint will list all currently open repository invitations for that user. + +```sql +SELECT +id, +node_id, +created_at, +expired, +html_url, +invitee, +inviter, +permissions, +repository, +url +FROM github.repos.invitations +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `UPDATE` examples + + + + +No description available. + +```sql +UPDATE github.repos.invitations +SET +permissions = '{{ permissions }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND invitation_id = '{{ invitation_id }}' --required +RETURNING +id, +node_id, +created_at, +expired, +html_url, +invitee, +inviter, +permissions, +repository, +url; +``` + + + + +## `DELETE` examples + + + + +No description available. + +```sql +DELETE FROM github.repos.invitations +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND invitation_id = '{{ invitation_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Response + +```sql +EXEC github.repos.invitations.accept_invitation_for_authenticated_user +@invitation_id='{{ invitation_id }}' --required +; +``` + + + +Response + +```sql +EXEC github.repos.invitations.decline_invitation_for_authenticated_user +@invitation_id='{{ invitation_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/org_rules/index.md b/website/docs/services/repos/org_rules/index.md deleted file mode 100644 index 6639735..0000000 --- a/website/docs/services/repos/org_rules/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: org_rules -hide_title: false -hide_table_of_contents: false -keywords: - - org_rules - - repos - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameorg_rules
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The ID of the ruleset | -| | `string` | The name of the ruleset | -| | `object` | | -| | `array` | The actors that can bypass the rules in this ruleset | -| | `object` | Parameters for a repository ruleset ref name condition | -| | `string` | | -| | `string` | The bypass type of the user making the API request for this ruleset. This field is only returned when
querying the repository-level endpoint. | -| | `string` | The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). | -| | `string` | | -| | `array` | | -| | `string` | The name of the source | -| | `string` | The type of the source of the ruleset | -| | `string` | The target of the ruleset | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get a repository ruleset for an organization. | -| | `SELECT` | | Get all the repository rulesets for an organization. | -| | `INSERT` | | Create a repository ruleset for an organization. | -| | `DELETE` | | Delete a ruleset for an organization. | -| | `EXEC` | | Update a ruleset for an organization. | diff --git a/website/docs/services/repos/page_build_latest/index.md b/website/docs/services/repos/page_build_latest/index.md index 7ed6015..6c18316 100644 --- a/website/docs/services/repos/page_build_latest/index.md +++ b/website/docs/services/repos/page_build_latest/index.md @@ -1,44 +1,178 @@ ---- +--- title: page_build_latest hide_title: false hide_table_of_contents: false keywords: - page_build_latest - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a page_build_latest resource. ## Overview - +
Namepage_build_latest
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `object` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (date-time)
integer
object
objectA GitHub user. (title: Simple User)
string
string (date-time)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets information about the single most recent build of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets information about the single most recent build of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +commit, +created_at, +duration, +error, +pusher, +status, +updated_at, +url +FROM github.repos.page_build_latest +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/page_builds/index.md b/website/docs/services/repos/page_builds/index.md index 67b6d48..43c80f2 100644 --- a/website/docs/services/repos/page_builds/index.md +++ b/website/docs/services/repos/page_builds/index.md @@ -1,47 +1,395 @@ ---- +--- title: page_builds hide_title: false hide_table_of_contents: false keywords: - page_builds - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a page_builds resource. ## Overview - +
Namepage_builds
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `string` | | -| | `integer` | | -| | `object` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (date-time)
integer
object
objectA GitHub user. (title: Simple User)
string
string (date-time)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string (date-time)
integer
object
objectA GitHub user. (title: Simple User)
string
string (date-time)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a GitHub Pages build.

A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. | -| | `SELECT` | | Lists builts of a GitHub Pages site.

A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. | -| | `EXEC` | | Create a GitHub Pages deployment for a repository.

Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. | -| | `EXEC` | | You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, build_idGets information about a GitHub Pages build.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repoper_page, pageLists builts of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, pages_build_version, oidc_tokenCreate a GitHub Pages deployment for a repository.

The authenticated user must have write permission to the repository.
owner, repoYou can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets information about a GitHub Pages build.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +commit, +created_at, +duration, +error, +pusher, +status, +updated_at, +url +FROM github.repos.page_builds +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND build_id = '{{ build_id }}' -- required +; +``` + + + +Lists builts of a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +commit, +created_at, +duration, +error, +pusher, +status, +updated_at, +url +FROM github.repos.page_builds +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a GitHub Pages deployment for a repository.

The authenticated user must have write permission to the repository. + +```sql +INSERT INTO github.repos.page_builds ( +artifact_id, +artifact_url, +environment, +pages_build_version, +oidc_token, +owner, +repo +) +SELECT +{{ artifact_id }}, +'{{ artifact_url }}', +'{{ environment }}', +'{{ pages_build_version }}' /* required */, +'{{ oidc_token }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +page_url, +preview_url, +status_url +; +``` + + + +{`# Description fields are for documentation purposes +- name: page_builds + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the page_builds resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the page_builds resource. + - name: artifact_id + value: {{ artifact_id }} + description: | + The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either \`artifact_id\` or \`artifact_url\` are required. + - name: artifact_url + value: "{{ artifact_url }}" + description: | + The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either \`artifact_id\` or \`artifact_url\` are required. + - name: environment + value: "{{ environment }}" + description: | + The target environment for this GitHub Pages deployment. + default: github-pages + - name: pages_build_version + value: "{{ pages_build_version }}" + description: | + A unique string that represents the version of the build for this deployment. + default: GITHUB_SHA + - name: oidc_token + value: "{{ oidc_token }}" + description: | + The OIDC token issued by GitHub Actions certifying the origin of the deployment. +`} + + + + + +## Lifecycle Methods + + + + +You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.

Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + +```sql +EXEC github.repos.page_builds.request_pages_build +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/repos/pages/index.md b/website/docs/services/repos/pages/index.md index 09e7d10..9548ef3 100644 --- a/website/docs/services/repos/pages/index.md +++ b/website/docs/services/repos/pages/index.md @@ -1,51 +1,345 @@ ---- +--- title: pages hide_title: false hide_table_of_contents: false keywords: - pages - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pages resource. ## Overview - +
Namepages
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The process in which the Page will be built. | -| | `string` | The Pages site's custom domain | -| | `boolean` | Whether the Page has a custom 404 page. | -| | `string` | The web address the Page can be accessed from. | -| | `object` | | -| | `boolean` | Whether https is enabled on the domain | -| | `string` | The timestamp when a pending domain becomes unverified. | -| | `string` | The state if the domain is verified | -| | `boolean` | Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. | -| | `object` | | -| | `string` | The status of the most recent build of the Page. | -| | `string` | The API address for accessing this Page resource. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe process in which the Page will be built. (legacy, workflow) (example: legacy)
stringThe Pages site's custom domain (example: example.com)
booleanWhether the Page has a custom 404 page.
string (uri)The web address the Page can be accessed from. (example: https://example.com)
object (title: Pages Https Certificate)
booleanWhether https is enabled on the domain
string (date-time)The timestamp when a pending domain becomes unverified.
stringThe state if the domain is verified (pending, verified, unverified) (example: pending)
booleanWhether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.
object (title: Pages Source Hash)
stringThe status of the most recent build of the Page. (built, building, errored) (example: built)
string (uri)The API address for accessing this Page resource. (example: https://api.github.com/repos/github/hello-world/pages)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets information about a GitHub Pages site.

A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. | -| | `INSERT` | | Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."

To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. | -| | `DELETE` | | Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).

To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. | -| | `EXEC` | | Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).

To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets information about a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, source, build_typeConfigures a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages)."

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repo, build_type, source, cname, public, https_enforcedUpdates information for a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
owner, repoDeletes a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets information about a GitHub Pages site.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +build_type, +cname, +custom_404, +html_url, +https_certificate, +https_enforced, +pending_domain_unverified_at, +protected_domain_state, +public, +source, +status, +url +FROM github.repos.pages +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Configures a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages)."

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.repos.pages ( +build_type, +source, +owner, +repo +) +SELECT +'{{ build_type }}' /* required */, +'{{ source }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +build_type, +cname, +custom_404, +html_url, +https_certificate, +https_enforced, +pending_domain_unverified_at, +protected_domain_state, +public, +source, +status, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: pages + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the pages resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the pages resource. + - name: build_type + value: "{{ build_type }}" + description: | + The process in which the Page will be built. Possible values are \`"legacy"\` and \`"workflow"\`. + valid_values: ['legacy', 'workflow'] + - name: source + description: | + The source branch and directory used to publish your Pages site. + value: + branch: "{{ branch }}" + path: "{{ path }}" +`} + + + + + +## `REPLACE` examples + + + + +Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +REPLACE github.repos.pages +SET +cname = '{{ cname }}', +https_enforced = {{ https_enforced }}, +build_type = '{{ build_type }}', +source = '{{ source }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND build_type = '{{ build_type }}' --required +AND source = '{{ source }}' --required +AND cname = '{{ cname }}' --required +AND https_enforced = {{ https_enforced }} --required; +``` + + + + +## `DELETE` examples + + + + +Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](https://docs.github.com/github/working-with-github-pages/about-github-pages).

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.repos.pages +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/repos/pages_health_check/index.md b/website/docs/services/repos/pages_health_check/index.md index feaf2f7..b79fb64 100644 --- a/website/docs/services/repos/pages_health_check/index.md +++ b/website/docs/services/repos/pages_health_check/index.md @@ -1,38 +1,142 @@ ---- +--- title: pages_health_check hide_title: false hide_table_of_contents: false keywords: - pages_health_check - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pages_health_check resource. ## Overview - +
Namepages_health_check
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `object` | -| | `object` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
object
object
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.

The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.

The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.

The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +alt_domain, +domain +FROM github.repos.pages_health_check +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/pr_review_protection/index.md b/website/docs/services/repos/pr_review_protection/index.md index 90e34ef..73b2498 100644 --- a/website/docs/services/repos/pr_review_protection/index.md +++ b/website/docs/services/repos/pr_review_protection/index.md @@ -1,45 +1,253 @@ ---- +--- title: pr_review_protection hide_title: false hide_table_of_contents: false keywords: - pr_review_protection - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a pr_review_protection resource. ## Overview - +
Namepr_review_protection
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | Allow specific users, teams, or apps to bypass pull request requirements. | -| | `boolean` | | -| | `object` | | -| | `boolean` | | -| | `boolean` | Whether the most recent push must be approved by someone other than the person who pushed it. | -| | `integer` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectAllow specific users, teams, or apps to bypass pull request requirements.
boolean
object
boolean
booleanWhether the most recent push must be approved by someone other than the person who pushed it.
integer
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

**Note**: Passing new arrays of `users` and `teams` replaces their previous values. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

> [!NOTE]
> Passing new arrays of `users` and `teams` replaces their previous values.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +SELECT +bypass_pull_request_allowances, +dismiss_stale_reviews, +dismissal_restrictions, +require_code_owner_reviews, +require_last_push_approval, +required_approving_review_count, +url +FROM github.repos.pr_review_protection +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

> [!NOTE]
> Passing new arrays of `users` and `teams` replaces their previous values. + +```sql +UPDATE github.repos.pr_review_protection +SET +dismissal_restrictions = '{{ dismissal_restrictions }}', +dismiss_stale_reviews = {{ dismiss_stale_reviews }}, +require_code_owner_reviews = {{ require_code_owner_reviews }}, +required_approving_review_count = {{ required_approving_review_count }}, +require_last_push_approval = {{ require_last_push_approval }}, +bypass_pull_request_allowances = '{{ bypass_pull_request_allowances }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +RETURNING +bypass_pull_request_allowances, +dismiss_stale_reviews, +dismissal_restrictions, +require_code_owner_reviews, +require_last_push_approval, +required_approving_review_count, +url; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +DELETE FROM github.repos.pr_review_protection +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/private_vulnerability_reporting/index.md b/website/docs/services/repos/private_vulnerability_reporting/index.md new file mode 100644 index 0000000..9c89654 --- /dev/null +++ b/website/docs/services/repos/private_vulnerability_reporting/index.md @@ -0,0 +1,184 @@ +--- +title: private_vulnerability_reporting +hide_title: false +hide_table_of_contents: false +keywords: + - private_vulnerability_reporting + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a private_vulnerability_reporting resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Private vulnerability reporting status + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether or not private vulnerability reporting is enabled for the repository.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".
owner, repoEnables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)."
owner, repoDisables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)".
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + +```sql +SELECT +enabled +FROM github.repos.private_vulnerability_reporting +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + +```sql +EXEC github.repos.private_vulnerability_reporting.enable_private_vulnerability_reporting +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + +```sql +EXEC github.repos.private_vulnerability_reporting.disable_private_vulnerability_reporting +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/repos/protection_rules/index.md b/website/docs/services/repos/protection_rules/index.md index ef52bef..128c9e3 100644 --- a/website/docs/services/repos/protection_rules/index.md +++ b/website/docs/services/repos/protection_rules/index.md @@ -1,43 +1,311 @@ ---- +--- title: protection_rules hide_title: false hide_table_of_contents: false keywords: - protection_rules - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a protection_rules resource. ## Overview - +
Nameprotection_rules
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The unique identifier for the deployment protection rule. | -| | `object` | A GitHub App that is providing a custom deployment protection rule. | -| | `boolean` | Whether the deployment protection rule is enabled for the environment. | -| | `string` | The node ID for the deployment protection rule. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier for the deployment protection rule.
stringThe node ID for the deployment protection rule. (example: MDQ6R2F0ZTM1MTU=)
objectA GitHub App that is providing a custom deployment protection rule. (title: Custom deployment protection rule app)
booleanWhether the deployment protection rule is enabled for the environment.
+ + + +List of deployment protection rules + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integerThe number of enabled custom deployment protection rules for this environment
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). | -| | `SELECT` | | Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). | -| | `INSERT` | | Enable a custom deployment protection rule for an environment.

You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). | -| | `EXEC` | | Disables a custom deployment protection rule for an environment.

You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, environment_name, protection_rule_idGets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
environment_name, repo, ownerGets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
environment_name, repo, ownerEnable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
environment_name, repo, owner, protection_rule_idDisables a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the protection rule.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +node_id, +app, +enabled +FROM github.repos.protection_rules +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND environment_name = '{{ environment_name }}' -- required +AND protection_rule_id = '{{ protection_rule_id }}' -- required +; +``` + + + +Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +custom_deployment_protection_rules, +total_count +FROM github.repos.protection_rules +WHERE environment_name = '{{ environment_name }}' -- required +AND repo = '{{ repo }}' -- required +AND owner = '{{ owner }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Enable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.repos.protection_rules ( +integration_id, +environment_name, +repo, +owner +) +SELECT +{{ integration_id }}, +'{{ environment_name }}', +'{{ repo }}', +'{{ owner }}' +RETURNING +id, +node_id, +app, +enabled +; +``` + + + +{`# Description fields are for documentation purposes +- name: protection_rules + props: + - name: environment_name + value: "{{ environment_name }}" + description: Required parameter for the protection_rules resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the protection_rules resource. + - name: owner + value: "{{ owner }}" + description: Required parameter for the protection_rules resource. + - name: integration_id + value: {{ integration_id }} + description: | + The ID of the custom app that will be enabled on the environment. +`} + + + + + +## `DELETE` examples + + + + +Disables a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +DELETE FROM github.repos.protection_rules +WHERE environment_name = '{{ environment_name }}' --required +AND repo = '{{ repo }}' --required +AND owner = '{{ owner }}' --required +AND protection_rule_id = '{{ protection_rule_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/referrer_traffic/index.md b/website/docs/services/repos/referrer_traffic/index.md index e8d695e..287ceb4 100644 --- a/website/docs/services/repos/referrer_traffic/index.md +++ b/website/docs/services/repos/referrer_traffic/index.md @@ -1,39 +1,148 @@ ---- +--- title: referrer_traffic hide_title: false hide_table_of_contents: false keywords: - referrer_traffic - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a referrer_traffic resource. ## Overview - +
Namereferrer_traffic
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (example: Google)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoGet the top 10 referrers over the last 14 days.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Get the top 10 referrers over the last 14 days. + +```sql +SELECT +count, +referrer, +uniques +FROM github.repos.referrer_traffic +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/releases/index.md b/website/docs/services/repos/releases/index.md index 533e95e..45e31b8 100644 --- a/website/docs/services/repos/releases/index.md +++ b/website/docs/services/repos/releases/index.md @@ -1,65 +1,942 @@ ---- +--- title: releases hide_title: false hide_table_of_contents: false keywords: - releases - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a releases resource. ## Overview - +
Namereleases
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | The URL of the release discussion. | -| | `boolean` | true to create a draft (unpublished) release, false to create a published one. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `boolean` | Whether to identify the release as a prerelease or a full release. | -| | `string` | | -| | `object` | | -| | `string` | The name of the tag. | -| | `string` | | -| | `string` | Specifies the commitish value that determines where the Git tag is created from. | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringThe name of the tag. (example: v1.0.0)
array
string (uri)
objectA GitHub user. (title: Simple User)
string
string
string
string (date-time)
string (uri)The URL of the release discussion.
booleantrue to create a draft (unpublished) release, false to create a published one.
string (uri)
booleanWhether or not the release is immutable.
integer
booleanWhether to identify the release as a prerelease or a full release.
string (date-time)
object (title: Reaction Rollup)
string (uri)
stringSpecifies the commitish value that determines where the Git tag is created from. (example: master)
string (date-time)
string
string (uri)
string (uri)
+ + + +**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringThe name of the tag. (example: v1.0.0)
array
string (uri)
objectA GitHub user. (title: Simple User)
string
string
string
string (date-time)
string (uri)The URL of the release discussion.
booleantrue to create a draft (unpublished) release, false to create a published one.
string (uri)
booleanWhether or not the release is immutable.
integer
booleanWhether to identify the release as a prerelease or a full release.
string (date-time)
object (title: Reaction Rollup)
string (uri)
stringSpecifies the commitish value that determines where the Git tag is created from. (example: master)
string (date-time)
string
string (uri)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringThe name of the tag. (example: v1.0.0)
array
string (uri)
objectA GitHub user. (title: Simple User)
string
string
string
string (date-time)
string (uri)The URL of the release discussion.
booleantrue to create a draft (unpublished) release, false to create a published one.
string (uri)
booleanWhether or not the release is immutable.
integer
booleanWhether to identify the release as a prerelease or a full release.
string (date-time)
object (title: Reaction Rollup)
string (uri)
stringSpecifies the commitish value that determines where the Git tag is created from. (example: master)
string (date-time)
string
string (uri)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). | -| | `SELECT` | | Get a published release with the specified tag. | -| | `SELECT` | | This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. | -| | `INSERT` | | Users with push access to the repository can create a release.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `DELETE` | | Users with push access to the repository can delete a release. | -| | `EXEC` | | Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. | -| | `EXEC` | | Users with push access to the repository can edit a release. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, tagGet a published release with the specified tag.
owner, repo, release_idGets a public release with the specified release ID.

> [!NOTE]
> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."
owner, repoper_page, pageThis returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
owner, repo, tag_nameUsers with push access to the repository can create a release.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)."
owner, repo, release_idUsers with push access to the repository can edit a release.
owner, repo, release_idUsers with push access to the repository can delete a release.
owner, repo, tag_nameGenerate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
integerThe unique identifier of the release.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringtag parameter
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Get a published release with the specified tag. + +```sql +SELECT +id, +name, +node_id, +tag_name, +assets, +assets_url, +author, +body, +body_html, +body_text, +created_at, +discussion_url, +draft, +html_url, +immutable, +mentions_count, +prerelease, +published_at, +reactions, +tarball_url, +target_commitish, +updated_at, +upload_url, +url, +zipball_url +FROM github.repos.releases +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND tag = '{{ tag }}' -- required +; +``` + + + +Gets a public release with the specified release ID.

> [!NOTE]
> This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + +```sql +SELECT +id, +name, +node_id, +tag_name, +assets, +assets_url, +author, +body, +body_html, +body_text, +created_at, +discussion_url, +draft, +html_url, +immutable, +mentions_count, +prerelease, +published_at, +reactions, +tarball_url, +target_commitish, +updated_at, +upload_url, +url, +zipball_url +FROM github.repos.releases +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND release_id = '{{ release_id }}' -- required +; +``` + + + +This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags).

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + +```sql +SELECT +id, +name, +node_id, +tag_name, +assets, +assets_url, +author, +body, +body_html, +body_text, +created_at, +discussion_url, +draft, +html_url, +immutable, +mentions_count, +prerelease, +published_at, +reactions, +tarball_url, +target_commitish, +updated_at, +upload_url, +url, +zipball_url +FROM github.repos.releases +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Users with push access to the repository can create a release.

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + +```sql +INSERT INTO github.repos.releases ( +tag_name, +target_commitish, +name, +body, +draft, +prerelease, +discussion_category_name, +generate_release_notes, +make_latest, +owner, +repo +) +SELECT +'{{ tag_name }}' /* required */, +'{{ target_commitish }}', +'{{ name }}', +'{{ body }}', +{{ draft }}, +{{ prerelease }}, +'{{ discussion_category_name }}', +{{ generate_release_notes }}, +'{{ make_latest }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +node_id, +tag_name, +assets, +assets_url, +author, +body, +body_html, +body_text, +created_at, +discussion_url, +draft, +html_url, +immutable, +mentions_count, +prerelease, +published_at, +reactions, +tarball_url, +target_commitish, +updated_at, +upload_url, +url, +zipball_url +; +``` + + + +{`# Description fields are for documentation purposes +- name: releases + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the releases resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the releases resource. + - name: tag_name + value: "{{ tag_name }}" + description: | + The name of the tag. + - name: target_commitish + value: "{{ target_commitish }}" + description: | + Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. + - name: name + value: "{{ name }}" + description: | + The name of the release. + - name: body + value: "{{ body }}" + description: | + Text describing the contents of the tag. + - name: draft + value: {{ draft }} + description: | + \`true\` to create a draft (unpublished) release, \`false\` to create a published one. + default: false + - name: prerelease + value: {{ prerelease }} + description: | + \`true\` to identify the release as a prerelease. \`false\` to identify the release as a full release. + default: false + - name: discussion_category_name + value: "{{ discussion_category_name }}" + description: | + If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." + - name: generate_release_notes + value: {{ generate_release_notes }} + description: | + Whether to automatically generate the name and body for this release. If \`name\` is specified, the specified name will be used; otherwise, a name will be automatically generated. If \`body\` is specified, the body will be pre-pended to the automatically generated notes. + default: false + - name: make_latest + value: "{{ make_latest }}" + description: | + Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to \`true\` for newly published releases. \`legacy\` specifies that the latest release should be determined based on the release creation date and higher semantic version. + valid_values: ['true', 'false', 'legacy'] + default: true +`} + + + + + +## `UPDATE` examples + + + + +Users with push access to the repository can edit a release. + +```sql +UPDATE github.repos.releases +SET +tag_name = '{{ tag_name }}', +target_commitish = '{{ target_commitish }}', +name = '{{ name }}', +body = '{{ body }}', +draft = {{ draft }}, +prerelease = {{ prerelease }}, +make_latest = '{{ make_latest }}', +discussion_category_name = '{{ discussion_category_name }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND release_id = '{{ release_id }}' --required +RETURNING +id, +name, +node_id, +tag_name, +assets, +assets_url, +author, +body, +body_html, +body_text, +created_at, +discussion_url, +draft, +html_url, +immutable, +mentions_count, +prerelease, +published_at, +reactions, +tarball_url, +target_commitish, +updated_at, +upload_url, +url, +zipball_url; +``` + + + + +## `DELETE` examples + + + + +Users with push access to the repository can delete a release. + +```sql +DELETE FROM github.repos.releases +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND release_id = '{{ release_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + +```sql +EXEC github.repos.releases.generate_release_notes +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +@@json= +'{ +"tag_name": "{{ tag_name }}", +"target_commitish": "{{ target_commitish }}", +"previous_tag_name": "{{ previous_tag_name }}", +"configuration_file_path": "{{ configuration_file_path }}" +}' +; +``` + + diff --git a/website/docs/services/repos/releases_latest/index.md b/website/docs/services/repos/releases_latest/index.md index 1c45eb4..acb291a 100644 --- a/website/docs/services/repos/releases_latest/index.md +++ b/website/docs/services/repos/releases_latest/index.md @@ -1,59 +1,280 @@ ---- +--- title: releases_latest hide_title: false hide_table_of_contents: false keywords: - releases_latest - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a releases_latest resource. ## Overview - +
Namereleases_latest
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | The URL of the release discussion. | -| | `boolean` | true to create a draft (unpublished) release, false to create a published one. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `boolean` | Whether to identify the release as a prerelease or a full release. | -| | `string` | | -| | `object` | | -| | `string` | The name of the tag. | -| | `string` | | -| | `string` | Specifies the commitish value that determines where the Git tag is created from. | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
stringThe name of the tag. (example: v1.0.0)
array
string (uri)
objectA GitHub user. (title: Simple User)
string
string
string
string (date-time)
string (uri)The URL of the release discussion.
booleantrue to create a draft (unpublished) release, false to create a published one.
string (uri)
booleanWhether or not the release is immutable.
integer
booleanWhether to identify the release as a prerelease or a full release.
string (date-time)
object (title: Reaction Rollup)
string (uri)
stringSpecifies the commitish value that determines where the Git tag is created from. (example: master)
string (date-time)
string
string (uri)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoView the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +View the latest published full release for the repository.

The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + +```sql +SELECT +id, +name, +node_id, +tag_name, +assets, +assets_url, +author, +body, +body_html, +body_text, +created_at, +discussion_url, +draft, +html_url, +immutable, +mentions_count, +prerelease, +published_at, +reactions, +tarball_url, +target_commitish, +updated_at, +upload_url, +url, +zipball_url +FROM github.repos.releases_latest +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/repo_immutable_releases/index.md b/website/docs/services/repos/repo_immutable_releases/index.md new file mode 100644 index 0000000..a47aabc --- /dev/null +++ b/website/docs/services/repos/repo_immutable_releases/index.md @@ -0,0 +1,202 @@ +--- +title: repo_immutable_releases +hide_title: false +hide_table_of_contents: false +keywords: + - repo_immutable_releases + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repo_immutable_releases resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response if immutable releases are enabled + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether immutable releases are enabled for the repository.
booleanWhether immutable releases are enforced by the repository owner.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoShows whether immutable releases are enabled or disabled. Also identifies whether immutability is being
enforced by the repository owner. The authenticated user must have admin read access to the repository.
owner, repoEnables immutable releases for a repository. The authenticated user must have admin access to the repository.
owner, repoDisables immutable releases for a repository. The authenticated user must have admin access to the repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being
enforced by the repository owner. The authenticated user must have admin read access to the repository. + +```sql +SELECT +enabled, +enforced_by_owner +FROM github.repos.repo_immutable_releases +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + +```sql +REPLACE github.repos.repo_immutable_releases +SET +-- No updatable properties +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + + + +## `DELETE` examples + + + + +Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + +```sql +DELETE FROM github.repos.repo_immutable_releases +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/repos/repo_pages_deployments/index.md b/website/docs/services/repos/repo_pages_deployments/index.md new file mode 100644 index 0000000..4d3f492 --- /dev/null +++ b/website/docs/services/repos/repo_pages_deployments/index.md @@ -0,0 +1,195 @@ +--- +title: repo_pages_deployments +hide_title: false +hide_table_of_contents: false +keywords: + - repo_pages_deployments + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repo_pages_deployments resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe current status of the deployment. (deployment_in_progress, syncing_files, finished_file_sync, updating_pages, purging_cdn, deployment_cancelled, deployment_failed, deployment_content_failed, deployment_attempt_error, deployment_lost, succeed)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, pages_deployment_idGets the current status of a GitHub Pages deployment.

The authenticated user must have read permission for the GitHub Pages site.
owner, repo, pages_deployment_idCancels a GitHub Pages deployment.

The authenticated user must have write permissions for the GitHub Pages site.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
The ID of the Pages deployment. You can also give the commit SHA of the deployment.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Gets the current status of a GitHub Pages deployment.

The authenticated user must have read permission for the GitHub Pages site. + +```sql +SELECT +status +FROM github.repos.repo_pages_deployments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND pages_deployment_id = '{{ pages_deployment_id }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Cancels a GitHub Pages deployment.

The authenticated user must have write permissions for the GitHub Pages site. + +```sql +INSERT INTO github.repos.repo_pages_deployments ( +owner, +repo, +pages_deployment_id +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ pages_deployment_id }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: repo_pages_deployments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the repo_pages_deployments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the repo_pages_deployments resource. + - name: pages_deployment_id + value: "{{ pages_deployment_id }}" + description: Required parameter for the repo_pages_deployments resource. +`} + + + diff --git a/website/docs/services/repos/repos/index.md b/website/docs/services/repos/repos/index.md index d61455a..b463fbc 100644 --- a/website/docs/services/repos/repos/index.md +++ b/website/docs/services/repos/repos/index.md @@ -1,138 +1,2608 @@ ---- +--- title: repos hide_title: false hide_table_of_contents: false keywords: - repos - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos resource. ## Overview - +
Namerepos
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists repositories for the specified organization.

**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." | -| | `SELECT` | | Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. | -| | `SELECT` | | Lists all public repositories in the order that they were created.

Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. | -| | `INSERT` | | Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

**OAuth scope requirements**

When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:

* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* `repo` scope to create a private repository | -| | `DELETE` | | Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.

If an organization owner has configured the organization to prevent members from deleting organization-owned
repositories, you will get a `403 Forbidden` response. | -| | `EXEC` | | Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". | -| | `EXEC` | | List any syntax errors that are detected in the CODEOWNERS
file.

For more information about the correct CODEOWNERS syntax,
see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." | -| | `EXEC` | | You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."

The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.

This endpoint requires write access to the repository by providing either:

- Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation.
- GitHub Apps with both `metadata:read` and `contents:read&write` permissions.

This input example shows how you can use the `client_payload` as a test to debug your workflow. | -| | `EXEC` | | Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.

**OAuth scope requirements**

When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:

* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* `repo` scope to create a private repository | -| | `EXEC` | | Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". | -| | `EXEC` | | Disables dependency alerts and the dependency graph for a repository.
The authenticated user must have admin access to the repository. For more information,
see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". | -| | `EXEC` | | Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." | -| | `EXEC` | | Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". | -| | `EXEC` | | Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. | -| | `EXEC` | | A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. | -| | `EXEC` | | **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgtype, sort, direction, per_page, pageLists repositories for the specified organization.

> [!NOTE]
> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
usernametype, sort, direction, per_page, pageLists public repositories for the specified user.
sinceLists all public repositories in the order that they were created.

Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.
template_owner, template_repo, nameCreates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
org, nameCreates a new repository in the specified organization. The authenticated user must be a member of the organization.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
owner, repo**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.
owner, repoDeleting a repository requires admin access.

If an organization owner has configured the organization to prevent members from deleting organization-owned
repositories, you will get a `403 Forbidden` response.

OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint.
owner, repoLists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.
owner, repo, new_ownerA transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe account owner of the template repository. The name is not case sensitive.
stringThe name of the template repository without the `.git` extension. The name is not case sensitive.
stringThe handle for the GitHub user account.
stringThe order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerA repository ID. Only return repositories with an ID greater than this ID.
stringThe property to sort the results by.
stringLimit results to repositories of the specified type.
+ +## `SELECT` examples + + + + +Lists repositories for the specified organization.

> [!NOTE]
> In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.repos.repos +WHERE org = '{{ org }}' -- required +AND type = '{{ type }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists public repositories for the specified user. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.repos.repos +WHERE username = '{{ username }}' -- required +AND type = '{{ type }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all public repositories in the order that they were created.

Note:
- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.repos.repos +WHERE since = '{{ since }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + +```sql +INSERT INTO github.repos.repos ( +owner, +name, +description, +include_all_branches, +private, +template_owner, +template_repo +) +SELECT +'{{ owner }}', +'{{ name }}' /* required */, +'{{ description }}', +{{ include_all_branches }}, +{{ private }}, +'{{ template_owner }}', +'{{ template_repo }}' +RETURNING +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +; +``` + + + +Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + +```sql +INSERT INTO github.repos.repos ( +name, +description, +homepage, +private, +visibility, +has_issues, +has_projects, +has_wiki, +has_downloads, +is_template, +team_id, +auto_init, +gitignore_template, +license_template, +allow_squash_merge, +allow_merge_commit, +allow_rebase_merge, +allow_auto_merge, +delete_branch_on_merge, +use_squash_pr_title_as_default, +squash_merge_commit_title, +squash_merge_commit_message, +merge_commit_title, +merge_commit_message, +custom_properties, +org +) +SELECT +'{{ name }}' /* required */, +'{{ description }}', +'{{ homepage }}', +{{ private }}, +'{{ visibility }}', +{{ has_issues }}, +{{ has_projects }}, +{{ has_wiki }}, +{{ has_downloads }}, +{{ is_template }}, +{{ team_id }}, +{{ auto_init }}, +'{{ gitignore_template }}', +'{{ license_template }}', +{{ allow_squash_merge }}, +{{ allow_merge_commit }}, +{{ allow_rebase_merge }}, +{{ allow_auto_merge }}, +{{ delete_branch_on_merge }}, +{{ use_squash_pr_title_as_default }}, +'{{ squash_merge_commit_title }}', +'{{ squash_merge_commit_message }}', +'{{ merge_commit_title }}', +'{{ merge_commit_message }}', +'{{ custom_properties }}', +'{{ org }}' +RETURNING +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +; +``` + + + +{`# Description fields are for documentation purposes +- name: repos + props: + - name: template_owner + value: "{{ template_owner }}" + description: Required parameter for the repos resource. + - name: template_repo + value: "{{ template_repo }}" + description: Required parameter for the repos resource. + - name: org + value: "{{ org }}" + description: Required parameter for the repos resource. + - name: owner + value: "{{ owner }}" + description: | + The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. + - name: name + value: "{{ name }}" + description: | + The name of the repository. + - name: description + value: "{{ description }}" + description: | + A short description of the repository. + - name: include_all_branches + value: {{ include_all_branches }} + description: | + Set to \`true\` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: \`false\`. + default: false + - name: private + value: {{ private }} + description: | + Whether the repository is private. + default: false + - name: homepage + value: "{{ homepage }}" + description: | + A URL with more information about the repository. + - name: visibility + value: "{{ visibility }}" + description: | + The visibility of the repository. + valid_values: ['public', 'private'] + - name: has_issues + value: {{ has_issues }} + description: | + Either \`true\` to enable issues for this repository or \`false\` to disable them. + default: true + - name: has_projects + value: {{ has_projects }} + description: | + Either \`true\` to enable projects for this repository or \`false\` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is \`false\`, and if you pass \`true\`, the API returns an error. + default: true + - name: has_wiki + value: {{ has_wiki }} + description: | + Either \`true\` to enable the wiki for this repository or \`false\` to disable it. + default: true + - name: has_downloads + value: {{ has_downloads }} + description: | + Whether downloads are enabled. + default: true + - name: is_template + value: {{ is_template }} + description: | + Either \`true\` to make this repo available as a template repository or \`false\` to prevent it. + default: false + - name: team_id + value: {{ team_id }} + description: | + The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + - name: auto_init + value: {{ auto_init }} + description: | + Pass \`true\` to create an initial commit with empty README. + default: false + - name: gitignore_template + value: "{{ gitignore_template }}" + description: | + Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". + - name: license_template + value: "{{ license_template }}" + description: | + Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the \`license_template\` string. For example, "mit" or "mpl-2.0". + - name: allow_squash_merge + value: {{ allow_squash_merge }} + description: | + Either \`true\` to allow squash-merging pull requests, or \`false\` to prevent squash-merging. + default: true + - name: allow_merge_commit + value: {{ allow_merge_commit }} + description: | + Either \`true\` to allow merging pull requests with a merge commit, or \`false\` to prevent merging pull requests with merge commits. + default: true + - name: allow_rebase_merge + value: {{ allow_rebase_merge }} + description: | + Either \`true\` to allow rebase-merging pull requests, or \`false\` to prevent rebase-merging. + default: true + - name: allow_auto_merge + value: {{ allow_auto_merge }} + description: | + Either \`true\` to allow auto-merge on pull requests, or \`false\` to disallow auto-merge. + default: false + - name: delete_branch_on_merge + value: {{ delete_branch_on_merge }} + description: | + Either \`true\` to allow automatically deleting head branches when pull requests are merged, or \`false\` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to \`true\`.** + default: false + - name: use_squash_pr_title_as_default + value: {{ use_squash_pr_title_as_default }} + description: | + Either \`true\` to allow squash-merge commits to use pull request title, or \`false\` to use commit message. **This property is closing down. Please use \`squash_merge_commit_title\` instead. + default: false + - name: squash_merge_commit_title + value: "{{ squash_merge_commit_title }}" + description: | + Required when using \`squash_merge_commit_message\`. + The default value for a squash merge commit title: + - \`PR_TITLE\` - default to the pull request's title. + - \`COMMIT_OR_PR_TITLE\` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + valid_values: ['PR_TITLE', 'COMMIT_OR_PR_TITLE'] + - name: squash_merge_commit_message + value: "{{ squash_merge_commit_message }}" + description: | + The default value for a squash merge commit message: + - \`PR_BODY\` - default to the pull request's body. + - \`COMMIT_MESSAGES\` - default to the branch's commit messages. + - \`BLANK\` - default to a blank commit message. + valid_values: ['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'] + - name: merge_commit_title + value: "{{ merge_commit_title }}" + description: | + Required when using \`merge_commit_message\`. + The default value for a merge commit title. + - \`PR_TITLE\` - default to the pull request's title. + - \`MERGE_MESSAGE\` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + valid_values: ['PR_TITLE', 'MERGE_MESSAGE'] + - name: merge_commit_message + value: "{{ merge_commit_message }}" + description: | + The default value for a merge commit message. + - \`PR_TITLE\` - default to the pull request's title. + - \`PR_BODY\` - default to the pull request's body. + - \`BLANK\` - default to a blank commit message. + valid_values: ['PR_BODY', 'PR_TITLE', 'BLANK'] + - name: custom_properties + value: "{{ custom_properties }}" + description: | + The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. +`} + + + + + +## `UPDATE` examples + + + + +**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. + +```sql +UPDATE github.repos.repos +SET +name = '{{ name }}', +description = '{{ description }}', +homepage = '{{ homepage }}', +private = {{ private }}, +visibility = '{{ visibility }}', +security_and_analysis = '{{ security_and_analysis }}', +has_issues = {{ has_issues }}, +has_projects = {{ has_projects }}, +has_wiki = {{ has_wiki }}, +is_template = {{ is_template }}, +default_branch = '{{ default_branch }}', +allow_squash_merge = {{ allow_squash_merge }}, +allow_merge_commit = {{ allow_merge_commit }}, +allow_rebase_merge = {{ allow_rebase_merge }}, +allow_auto_merge = {{ allow_auto_merge }}, +delete_branch_on_merge = {{ delete_branch_on_merge }}, +allow_update_branch = {{ allow_update_branch }}, +use_squash_pr_title_as_default = {{ use_squash_pr_title_as_default }}, +squash_merge_commit_title = '{{ squash_merge_commit_title }}', +squash_merge_commit_message = '{{ squash_merge_commit_message }}', +merge_commit_title = '{{ merge_commit_title }}', +merge_commit_message = '{{ merge_commit_message }}', +archived = {{ archived }}, +allow_forking = {{ allow_forking }}, +web_commit_signoff_required = {{ web_commit_signoff_required }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +RETURNING +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required; +``` + + + + +## `DELETE` examples + + + + +Deleting a repository requires admin access.

If an organization owner has configured the organization to prevent members from deleting organization-owned
repositories, you will get a `403 Forbidden` response.

OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + +```sql +DELETE FROM github.repos.repos +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. + +```sql +EXEC github.repos.repos.list_languages +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). + +```sql +EXEC github.repos.repos.transfer +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +@@json= +'{ +"new_owner": "{{ new_owner }}", +"new_name": "{{ new_name }}", +"team_ids": "{{ team_ids }}" +}' +; +``` + + diff --git a/website/docs/services/repos/repos_for_auth_user/index.md b/website/docs/services/repos/repos_for_auth_user/index.md index daf8393..109e7de 100644 --- a/website/docs/services/repos/repos_for_auth_user/index.md +++ b/website/docs/services/repos/repos_for_auth_user/index.md @@ -1,136 +1,1071 @@ ---- +--- title: repos_for_auth_user hide_title: false hide_table_of_contents: false keywords: - repos_for_auth_user - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos_for_auth_user resource. ## Overview - +
Namerepos_for_auth_user
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the repository | -| | `string` | The name of the repository. | -| | `string` | | -| | `boolean` | Whether to allow Auto-merge to be used on pull requests. | -| | `boolean` | Whether to allow forking this repo | -| | `boolean` | Whether to allow merge commits for pull requests. | -| | `boolean` | Whether to allow rebase merges for pull requests. | -| | `boolean` | Whether to allow squash merges for pull requests. | -| | `boolean` | Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. | -| | `boolean` | Whether anonymous git access is enabled for this repository | -| | `string` | | -| | `boolean` | Whether the repository is archived. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | The default branch of the repository. | -| | `boolean` | Whether to delete head branches when pull requests are merged | -| | `string` | | -| | `boolean` | Returns whether or not this repository disabled. | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether discussions are enabled. | -| | `boolean` | Whether downloads are enabled. | -| | `boolean` | Whether issues are enabled. | -| | `boolean` | | -| | `boolean` | Whether projects are enabled. | -| | `boolean` | Whether the wiki is enabled. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether this repository acts as a template that can be used to generate new repositories. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | License Simple | -| | `string` | | -| | `string` | The default value for a merge commit message.

- `PR_TITLE` - default to the pull request's title.
- `PR_BODY` - default to the pull request's body.
- `BLANK` - default to a blank commit message. | -| | `string` | The default value for a merge commit title.

- `PR_TITLE` - default to the pull request's title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | Whether the repository is private or public. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | The default value for a squash merge commit message:

- `PR_BODY` - default to the pull request's body.
- `COMMIT_MESSAGES` - default to the branch's commit messages.
- `BLANK` - default to a blank commit message. | -| | `string` | The default value for a squash merge commit title:

- `PR_TITLE` - default to the pull request's title.
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. | -| | `string` | The repository visibility: public, private, or internal. | -| | `integer` | | -| | `integer` | | -| | `boolean` | Whether to require contributors to sign off on web-based commits | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the repository
stringThe name of the repository. (example: Team Environment)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
booleanWhether to allow Auto-merge to be used on pull requests.
booleanWhether to allow forking this repo
booleanWhether to allow merge commits for pull requests.
booleanWhether to allow rebase merges for pull requests.
booleanWhether to allow squash merges for pull requests.
booleanWhether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
booleanWhether anonymous git access is enabled for this repository
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
booleanWhether the repository is archived.
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string (example: https://github.com/octocat/Hello-World.git)
objectThe status of the code search index for this repository
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
stringThe default branch of the repository. (example: master)
booleanWhether to delete head branches when pull requests are merged
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
booleanReturns whether or not this repository disabled.
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string (example: git:github.com/octocat/Hello-World.git)
booleanWhether discussions are enabled.
booleanWhether downloads are enabled.
booleanWhether issues are enabled.
boolean
booleanWhether projects are enabled.
booleanWhether pull requests are enabled.
booleanWhether the wiki is enabled.
string (uri) (example: https://github.com)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
booleanWhether this repository acts as a template that can be used to generate new repositories.
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
objectLicense Simple (title: License Simple)
string
stringThe default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. (PR_BODY, PR_TITLE, BLANK)
stringThe default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). (PR_TITLE, MERGE_MESSAGE)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string (uri) (example: git:git.example.com/octocat/Hello-World)
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
booleanWhether the repository is private or public.
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only) (example: all)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
stringThe default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. (PR_BODY, COMMIT_MESSAGES, BLANK)
stringThe default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). (PR_TITLE, COMMIT_OR_PR_TITLE)
string (example: git@github.com:octocat/Hello-World.git)
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: "2020-07-09T00:17:42Z")
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string (uri) (example: https://svn.github.com/octocat/Hello-World)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
booleanWhether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
stringThe repository visibility: public, private, or internal. (default: public)
integer
integer
booleanWhether to require contributors to sign off on web-based commits
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. | -| | `INSERT` | | Creates a new repository for the authenticated user.

**OAuth scope requirements**

When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:

* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.
* `repo` scope to create a private repository. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
visibility, affiliation, type, sort, direction, per_page, page, since, beforeLists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.
nameCreates a new repository for the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringComma-separated list of values. Can include: * `owner`: Repositories that are owned by the authenticated user. * `collaborator`: Repositories that the user has been added to as a collaborator. * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.
string (date-time)Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string (date-time)Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
stringThe property to sort the results by.
stringLimit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.
stringLimit results to repositories with the specified visibility.
+ +## `SELECT` examples + + + + +Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.

The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + +```sql +SELECT +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_search_index_status, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +size, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +starred_at, +statuses_url, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.repos.repos_for_auth_user +WHERE visibility = '{{ visibility }}' +AND affiliation = '{{ affiliation }}' +AND type = '{{ type }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND since = '{{ since }}' +AND before = '{{ before }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates a new repository for the authenticated user.

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + +```sql +INSERT INTO github.repos.repos_for_auth_user ( +name, +description, +homepage, +private, +has_issues, +has_projects, +has_wiki, +has_discussions, +team_id, +auto_init, +gitignore_template, +license_template, +allow_squash_merge, +allow_merge_commit, +allow_rebase_merge, +allow_auto_merge, +delete_branch_on_merge, +squash_merge_commit_title, +squash_merge_commit_message, +merge_commit_title, +merge_commit_message, +has_downloads, +is_template +) +SELECT +'{{ name }}' /* required */, +'{{ description }}', +'{{ homepage }}', +{{ private }}, +{{ has_issues }}, +{{ has_projects }}, +{{ has_wiki }}, +{{ has_discussions }}, +{{ team_id }}, +{{ auto_init }}, +'{{ gitignore_template }}', +'{{ license_template }}', +{{ allow_squash_merge }}, +{{ allow_merge_commit }}, +{{ allow_rebase_merge }}, +{{ allow_auto_merge }}, +{{ delete_branch_on_merge }}, +'{{ squash_merge_commit_title }}', +'{{ squash_merge_commit_message }}', +'{{ merge_commit_title }}', +'{{ merge_commit_message }}', +{{ has_downloads }}, +{{ is_template }} +RETURNING +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +; +``` + + + +{`# Description fields are for documentation purposes +- name: repos_for_auth_user + props: + - name: name + value: "{{ name }}" + description: | + The name of the repository. + - name: description + value: "{{ description }}" + description: | + A short description of the repository. + - name: homepage + value: "{{ homepage }}" + description: | + A URL with more information about the repository. + - name: private + value: {{ private }} + description: | + Whether the repository is private. + default: false + - name: has_issues + value: {{ has_issues }} + description: | + Whether issues are enabled. + default: true + - name: has_projects + value: {{ has_projects }} + description: | + Whether projects are enabled. + default: true + - name: has_wiki + value: {{ has_wiki }} + description: | + Whether the wiki is enabled. + default: true + - name: has_discussions + value: {{ has_discussions }} + description: | + Whether discussions are enabled. + default: false + - name: team_id + value: {{ team_id }} + description: | + The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. + - name: auto_init + value: {{ auto_init }} + description: | + Whether the repository is initialized with a minimal README. + default: false + - name: gitignore_template + value: "{{ gitignore_template }}" + description: | + The desired language or platform to apply to the .gitignore. + - name: license_template + value: "{{ license_template }}" + description: | + The license keyword of the open source license for this repository. + - name: allow_squash_merge + value: {{ allow_squash_merge }} + description: | + Whether to allow squash merges for pull requests. + default: true + - name: allow_merge_commit + value: {{ allow_merge_commit }} + description: | + Whether to allow merge commits for pull requests. + default: true + - name: allow_rebase_merge + value: {{ allow_rebase_merge }} + description: | + Whether to allow rebase merges for pull requests. + default: true + - name: allow_auto_merge + value: {{ allow_auto_merge }} + description: | + Whether to allow Auto-merge to be used on pull requests. + default: false + - name: delete_branch_on_merge + value: {{ delete_branch_on_merge }} + description: | + Whether to delete head branches when pull requests are merged + default: false + - name: squash_merge_commit_title + value: "{{ squash_merge_commit_title }}" + description: | + Required when using \`squash_merge_commit_message\`. + The default value for a squash merge commit title: + - \`PR_TITLE\` - default to the pull request's title. + - \`COMMIT_OR_PR_TITLE\` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + valid_values: ['PR_TITLE', 'COMMIT_OR_PR_TITLE'] + - name: squash_merge_commit_message + value: "{{ squash_merge_commit_message }}" + description: | + The default value for a squash merge commit message: + - \`PR_BODY\` - default to the pull request's body. + - \`COMMIT_MESSAGES\` - default to the branch's commit messages. + - \`BLANK\` - default to a blank commit message. + valid_values: ['PR_BODY', 'COMMIT_MESSAGES', 'BLANK'] + - name: merge_commit_title + value: "{{ merge_commit_title }}" + description: | + Required when using \`merge_commit_message\`. + The default value for a merge commit title. + - \`PR_TITLE\` - default to the pull request's title. + - \`MERGE_MESSAGE\` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + valid_values: ['PR_TITLE', 'MERGE_MESSAGE'] + - name: merge_commit_message + value: "{{ merge_commit_message }}" + description: | + The default value for a merge commit message. + - \`PR_TITLE\` - default to the pull request's title. + - \`PR_BODY\` - default to the pull request's body. + - \`BLANK\` - default to a blank commit message. + valid_values: ['PR_BODY', 'PR_TITLE', 'BLANK'] + - name: has_downloads + value: {{ has_downloads }} + description: | + Whether downloads are enabled. + default: true + - name: is_template + value: {{ is_template }} + description: | + Whether this repository acts as a template that can be used to generate new repositories. + default: false +`} + + + diff --git a/website/docs/services/repos/repository_dispatches/index.md b/website/docs/services/repos/repository_dispatches/index.md new file mode 100644 index 0000000..42fff1b --- /dev/null +++ b/website/docs/services/repos/repository_dispatches/index.md @@ -0,0 +1,139 @@ +--- +title: repository_dispatches +hide_title: false +hide_table_of_contents: false +keywords: + - repository_dispatches + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repository_dispatches resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, event_typeYou can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."

The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.

This input example shows how you can use the `client_payload` as a test to debug your workflow.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)."

The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.

This input example shows how you can use the `client_payload` as a test to debug your workflow.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.repos.repository_dispatches ( +event_type, +client_payload, +owner, +repo +) +SELECT +'{{ event_type }}' /* required */, +'{{ client_payload }}', +'{{ owner }}', +'{{ repo }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: repository_dispatches + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the repository_dispatches resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the repository_dispatches resource. + - name: event_type + value: "{{ event_type }}" + description: | + A custom webhook event name. Must be 100 characters or fewer. + - name: client_payload + value: "{{ client_payload }}" + description: | + JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. +`} + + + diff --git a/website/docs/services/repos/rule_suites/index.md b/website/docs/services/repos/rule_suites/index.md new file mode 100644 index 0000000..6a0792a --- /dev/null +++ b/website/docs/services/repos/rule_suites/index.md @@ -0,0 +1,575 @@ +--- +title: rule_suites +hide_title: false +hide_table_of_contents: false +keywords: + - rule_suites + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a rule_suites resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the rule insight.
integerThe number that identifies the user.
integerThe ID of the repository associated with the rule evaluation.
stringThe handle for the GitHub user account.
stringThe name of the repository without the `.git` extension.
stringThe new commit SHA of the ref.
stringThe previous commit SHA of the ref.
stringThe result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. (pass, fail, bypass)
string (date-time) (example: 2011-01-26T19:06:43Z)
stringThe ref name that the evaluation ran on.
stringThe result of the rule evaluations for rules with the `active` enforcement status. (pass, fail, bypass)
arrayDetails on the evaluated rules.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the rule insight.
integerThe number that identifies the user.
integerThe ID of the repository associated with the rule evaluation.
stringThe handle for the GitHub user account.
stringThe name of the repository without the `.git` extension.
stringThe new commit SHA of the ref.
stringThe previous commit SHA of the ref.
stringThe result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. (pass, fail, bypass)
string (date-time) (example: 2011-01-26T19:06:43Z)
stringThe ref name that the evaluation ran on.
stringThe result of the rule evaluations for rules with the `active` enforcement status. (pass, fail, bypass)
arrayDetails on the evaluated rules.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the rule insight.
integerThe number that identifies the user.
integerThe ID of the repository associated with the rule evaluation.
stringThe handle for the GitHub user account.
stringThe name of the repository without the `.git` extension.
stringThe last commit sha in the push evaluation.
stringThe first commit sha before the push evaluation.
stringThe result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. (pass, fail, bypass)
string (date-time) (example: 2011-01-26T19:06:43Z)
stringThe ref name that the evaluation ran on.
stringThe result of the rule evaluations for rules with the `active` enforcement status. (pass, fail, bypass)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the rule insight.
integerThe number that identifies the user.
integerThe ID of the repository associated with the rule evaluation.
stringThe handle for the GitHub user account.
stringThe name of the repository without the `.git` extension.
stringThe last commit sha in the push evaluation.
stringThe first commit sha before the push evaluation.
stringThe result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. (pass, fail, bypass)
string (date-time) (example: 2011-01-26T19:06:43Z)
stringThe ref name that the evaluation ran on.
stringThe result of the rule evaluations for rules with the `active` enforcement status. (pass, fail, bypass)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, rule_suite_idGets information about a suite of rule evaluations from within a repository.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)."
org, rule_suite_idGets information about a suite of rule evaluations from within an organization.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
owner, reporef, time_period, actor_name, rule_suite_result, per_page, pageLists suites of rule evaluations at the repository level.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)."
orgref, repository_name, time_period, actor_name, rule_suite_result, per_page, pageLists suites of rule evaluations at the organization level.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the rule suite result. To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) for organizations.
stringThe handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned.
stringThe name of the repository to filter on.
stringThe rule suite results to filter on. When specified, only suites with this result will be returned.
stringThe time period to filter by. For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).
+ +## `SELECT` examples + + + + +Gets information about a suite of rule evaluations from within a repository.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + +```sql +SELECT +id, +actor_id, +repository_id, +actor_name, +repository_name, +after_sha, +before_sha, +evaluation_result, +pushed_at, +ref, +result, +rule_evaluations +FROM github.repos.rule_suites +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND rule_suite_id = '{{ rule_suite_id }}' -- required +; +``` + + + +Gets information about a suite of rule evaluations from within an organization.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + +```sql +SELECT +id, +actor_id, +repository_id, +actor_name, +repository_name, +after_sha, +before_sha, +evaluation_result, +pushed_at, +ref, +result, +rule_evaluations +FROM github.repos.rule_suites +WHERE org = '{{ org }}' -- required +AND rule_suite_id = '{{ rule_suite_id }}' -- required +; +``` + + + +Lists suites of rule evaluations at the repository level.
For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + +```sql +SELECT +id, +actor_id, +repository_id, +actor_name, +repository_name, +after_sha, +before_sha, +evaluation_result, +pushed_at, +ref, +result +FROM github.repos.rule_suites +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' +AND time_period = '{{ time_period }}' +AND actor_name = '{{ actor_name }}' +AND rule_suite_result = '{{ rule_suite_result }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists suites of rule evaluations at the organization level.
For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + +```sql +SELECT +id, +actor_id, +repository_id, +actor_name, +repository_name, +after_sha, +before_sha, +evaluation_result, +pushed_at, +ref, +result +FROM github.repos.rule_suites +WHERE org = '{{ org }}' -- required +AND ref = '{{ ref }}' +AND repository_name = '{{ repository_name }}' +AND time_period = '{{ time_period }}' +AND actor_name = '{{ actor_name }}' +AND rule_suite_result = '{{ rule_suite_result }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/rules/index.md b/website/docs/services/repos/rules/index.md index a132176..a5550ff 100644 --- a/website/docs/services/repos/rules/index.md +++ b/website/docs/services/repos/rules/index.md @@ -1,55 +1,1017 @@ ---- +--- title: rules hide_title: false hide_table_of_contents: false keywords: - rules - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a rules resource. ## Overview - +
Namerules
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | The ID of the ruleset | -| | `string` | The name of the ruleset | -| | `object` | | -| | `array` | The actors that can bypass the rules in this ruleset | -| | `object` | Parameters for a repository ruleset ref name condition | -| | `string` | | -| | `string` | The bypass type of the user making the API request for this ruleset. This field is only returned when
querying the repository-level endpoint. | -| | `string` | The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). | -| | `string` | | -| | `array` | | -| | `string` | The name of the source | -| | `string` | The type of the source of the ruleset | -| | `string` | The target of the ruleset | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the ruleset that includes this rule.
object
stringThe name of the source of the ruleset that includes this rule.
stringThe type of source for the ruleset that includes this rule. (Repository, Organization)
string (creation)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the ruleset
stringThe name of the ruleset
string
object
arrayThe actors that can bypass the rules in this ruleset
objectParameters for a repository ruleset ref name condition (title: Repository ruleset conditions for ref names)
string (date-time)
stringThe bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint. (always, pull_requests_only, never, exempt)
stringThe enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). (disabled, active, evaluate)
array
stringThe name of the source
stringThe type of the source of the ruleset (Repository, Organization, Enterprise)
stringThe target of the ruleset (branch, tag, push, repository)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the ruleset
stringThe name of the ruleset
string
object
arrayThe actors that can bypass the rules in this ruleset
objectParameters for a repository ruleset ref name condition (title: Repository ruleset conditions for ref names)
string (date-time)
stringThe bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint. (always, pull_requests_only, never, exempt)
stringThe enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). (disabled, active, evaluate)
array
stringThe name of the source
stringThe type of the source of the ruleset (Repository, Organization, Enterprise)
stringThe target of the ruleset (branch, tag, push, repository)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the ruleset
stringThe name of the ruleset
string
object
arrayThe actors that can bypass the rules in this ruleset
objectParameters for a repository ruleset ref name condition (title: Repository ruleset conditions for ref names)
string (date-time)
stringThe bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint. (always, pull_requests_only, never, exempt)
stringThe enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). (disabled, active, evaluate)
array
stringThe name of the source
stringThe type of the source of the ruleset (Repository, Organization, Enterprise)
stringThe target of the ruleset (branch, tag, push, repository)
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the ruleset
stringThe name of the ruleset
string
object
arrayThe actors that can bypass the rules in this ruleset
objectParameters for a repository ruleset ref name condition (title: Repository ruleset conditions for ref names)
string (date-time)
stringThe bypass type of the user making the API request for this ruleset. This field is only returned when querying the repository-level endpoint. (always, pull_requests_only, never, exempt)
stringThe enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). (disabled, active, evaluate)
array
stringThe name of the source
stringThe type of the source of the ruleset (Repository, Organization, Enterprise)
stringThe target of the ruleset (branch, tag, push, repository)
string (date-time)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get a ruleset for a repository. | -| | `SELECT` | | Get all the rulesets for a repository. | -| | `INSERT` | | Create a ruleset for a repository. | -| | `DELETE` | | Delete a ruleset for a repository. | -| | `EXEC` | | Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
enforcement statuses are not returned. | -| | `EXEC` | | Update a ruleset for a repository. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchper_page, pageReturns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
enforcement statuses are not returned.
owner, repo, ruleset_idincludes_parentsGet a ruleset for a repository.

**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
making the API request has write access to the ruleset.
org, ruleset_idGet a repository ruleset for an organization.

**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
making the API request has write access to the ruleset.
owner, repoper_page, page, includes_parents, targetsGet all the rulesets for a repository.
orgper_page, page, targetsGet all the repository rulesets for an organization.
owner, repo, name, enforcementCreate a ruleset for a repository.
org, name, enforcementCreate a repository ruleset for an organization.
owner, repo, ruleset_idUpdate a ruleset for a repository.
org, ruleset_idUpdate a ruleset for an organization.
owner, repo, ruleset_idDelete a ruleset for a repository.
org, ruleset_idDelete a ruleset for an organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe ID of the ruleset.
booleanInclude rulesets configured at higher levels that apply to this repository
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA comma-separated list of rule targets to filter by. If provided, only rulesets that apply to the specified targets will be returned. For example, `branch,tag,push`.
+ +## `SELECT` examples + + + + +Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
enforcement statuses are not returned. + +```sql +SELECT +ruleset_id, +parameters, +ruleset_source, +ruleset_source_type, +type +FROM github.repos.rules +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Get a ruleset for a repository.

**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
making the API request has write access to the ruleset. + +```sql +SELECT +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at +FROM github.repos.rules +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ruleset_id = '{{ ruleset_id }}' -- required +AND includes_parents = '{{ includes_parents }}' +; +``` + + + +Get a repository ruleset for an organization.

**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user
making the API request has write access to the ruleset. + +```sql +SELECT +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at +FROM github.repos.rules +WHERE org = '{{ org }}' -- required +AND ruleset_id = '{{ ruleset_id }}' -- required +; +``` + + + +Get all the rulesets for a repository. + +```sql +SELECT +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at +FROM github.repos.rules +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND includes_parents = '{{ includes_parents }}' +AND targets = '{{ targets }}' +; +``` + + + +Get all the repository rulesets for an organization. + +```sql +SELECT +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at +FROM github.repos.rules +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND targets = '{{ targets }}' +; +``` + + + + +## `INSERT` examples + + + + +Create a ruleset for a repository. + +```sql +INSERT INTO github.repos.rules ( +name, +target, +enforcement, +bypass_actors, +conditions, +rules, +owner, +repo +) +SELECT +'{{ name }}' /* required */, +'{{ target }}', +'{{ enforcement }}' /* required */, +'{{ bypass_actors }}', +'{{ conditions }}', +'{{ rules }}', +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at +; +``` + + + +Create a repository ruleset for an organization. + +```sql +INSERT INTO github.repos.rules ( +name, +target, +enforcement, +bypass_actors, +conditions, +rules, +org +) +SELECT +'{{ name }}' /* required */, +'{{ target }}', +'{{ enforcement }}' /* required */, +'{{ bypass_actors }}', +'{{ conditions }}', +'{{ rules }}', +'{{ org }}' +RETURNING +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: rules + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the rules resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the rules resource. + - name: org + value: "{{ org }}" + description: Required parameter for the rules resource. + - name: name + value: "{{ name }}" + description: | + The name of the ruleset. + - name: target + value: "{{ target }}" + description: | + The target of the ruleset + valid_values: ['branch', 'tag', 'push', 'repository'] + default: branch + - name: enforcement + value: "{{ enforcement }}" + description: | + The enforcement level of the ruleset. \`evaluate\` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (\`evaluate\` is only available with GitHub Enterprise). + valid_values: ['disabled', 'active', 'evaluate'] + - name: bypass_actors + description: | + The actors that can bypass the rules in this ruleset + value: + - actor_id: {{ actor_id }} + actor_type: "{{ actor_type }}" + bypass_mode: "{{ bypass_mode }}" + - name: conditions + description: | + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both \`repository_name\` and \`ref_name\` properties, or both \`repository_id\` and \`ref_name\` properties, or both \`repository_property\` and \`ref_name\` properties. + The push rulesets conditions object does not require the \`ref_name\` property. + For repository policy rulesets, the conditions object should only contain the \`repository_name\`, the \`repository_id\`, or the \`repository_property\`. + value: + ref_name: + include: + - "{{ include }}" + exclude: + - "{{ exclude }}" + repository_name: + include: + - "{{ include }}" + exclude: + - "{{ exclude }}" + protected: {{ protected }} + repository_id: + repository_ids: + - {{ repository_ids }} + repository_property: + include: + - name: "{{ name }}" + property_values: "{{ property_values }}" + source: "{{ source }}" + exclude: + - name: "{{ name }}" + property_values: "{{ property_values }}" + source: "{{ source }}" + - name: rules + description: | + An array of rules within the ruleset. + value: + - type: "{{ type }}" + parameters: + update_allows_fetch_and_merge: {{ update_allows_fetch_and_merge }} +`} + + + + + +## `REPLACE` examples + + + + +Update a ruleset for a repository. + +```sql +REPLACE github.repos.rules +SET +name = '{{ name }}', +target = '{{ target }}', +enforcement = '{{ enforcement }}', +bypass_actors = '{{ bypass_actors }}', +conditions = '{{ conditions }}', +rules = '{{ rules }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND ruleset_id = '{{ ruleset_id }}' --required +RETURNING +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at; +``` + + + +Update a ruleset for an organization. + +```sql +REPLACE github.repos.rules +SET +name = '{{ name }}', +target = '{{ target }}', +enforcement = '{{ enforcement }}', +bypass_actors = '{{ bypass_actors }}', +conditions = '{{ conditions }}', +rules = '{{ rules }}' +WHERE +org = '{{ org }}' --required +AND ruleset_id = '{{ ruleset_id }}' --required +RETURNING +id, +name, +node_id, +_links, +bypass_actors, +conditions, +created_at, +current_user_can_bypass, +enforcement, +rules, +source, +source_type, +target, +updated_at; +``` + + + + +## `DELETE` examples + + + + +Delete a ruleset for a repository. + +```sql +DELETE FROM github.repos.rules +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND ruleset_id = '{{ ruleset_id }}' --required +; +``` + + + +Delete a ruleset for an organization. + +```sql +DELETE FROM github.repos.rules +WHERE org = '{{ org }}' --required +AND ruleset_id = '{{ ruleset_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/ruleset_history/index.md b/website/docs/services/repos/ruleset_history/index.md new file mode 100644 index 0000000..fefa3f0 --- /dev/null +++ b/website/docs/services/repos/ruleset_history/index.md @@ -0,0 +1,211 @@ +--- +title: ruleset_history +hide_title: false +hide_table_of_contents: false +keywords: + - ruleset_history + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a ruleset_history resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + +
NameDatatypeDescription
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe ID of the previous version of the ruleset
objectThe actor who updated the ruleset
string (date-time)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, ruleset_id, version_idGet a version of a repository ruleset.
owner, repo, ruleset_idper_page, pageGet the history of a repository ruleset.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe ID of the ruleset.
integerThe ID of the version
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Get a version of a repository ruleset. + +```sql +SELECT +* +FROM github.repos.ruleset_history +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ruleset_id = '{{ ruleset_id }}' -- required +AND version_id = '{{ version_id }}' -- required +; +``` + + + +Get the history of a repository ruleset. + +```sql +SELECT +version_id, +actor, +updated_at +FROM github.repos.ruleset_history +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ruleset_id = '{{ ruleset_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/security_fixes/index.md b/website/docs/services/repos/security_fixes/index.md index 0c51ab1..4711f32 100644 --- a/website/docs/services/repos/security_fixes/index.md +++ b/website/docs/services/repos/security_fixes/index.md @@ -1,40 +1,190 @@ ---- +--- title: security_fixes hide_title: false hide_table_of_contents: false keywords: - security_fixes - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a security_fixes resource. ## Overview - +
Namesecurity_fixes
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `boolean` | Whether automated security fixes are enabled for the repository. | -| | `boolean` | Whether automated security fixes are paused for the repository. | + +The following fields are returned by `SELECT` queries: + + + + +Response if Dependabot is enabled + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
booleanWhether Dependabot security updates are enabled for the repository.
booleanWhether Dependabot security updates are paused for the repository.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". | -| | `EXEC` | | Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". | -| | `EXEC` | | Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoShows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".
owner, repoEnables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".
owner, repoDisables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + +```sql +SELECT +enabled, +paused +FROM github.repos.security_fixes +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + +```sql +EXEC github.repos.security_fixes.enable_automated_security_fixes +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". + +```sql +EXEC github.repos.security_fixes.disable_automated_security_fixes +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/repos/stats_code_frequency/index.md b/website/docs/services/repos/stats_code_frequency/index.md index 6f9da6c..622bdb6 100644 --- a/website/docs/services/repos/stats_code_frequency/index.md +++ b/website/docs/services/repos/stats_code_frequency/index.md @@ -1,34 +1,131 @@ ---- +--- title: stats_code_frequency hide_title: false hide_table_of_contents: false keywords: - stats_code_frequency - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a stats_code_frequency resource. ## Overview - +
Namestats_code_frequency
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + + + + + + + + + + +
NameDatatypeDescription
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns a weekly aggregate of the number of additions and deletions pushed to a repository.

> [!NOTE]
> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns a weekly aggregate of the number of additions and deletions pushed to a repository.

> [!NOTE]
> This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. + +```sql +SELECT +* +FROM github.repos.stats_code_frequency +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/stats_commit_activity/index.md b/website/docs/services/repos/stats_commit_activity/index.md index ee98b72..56a45b8 100644 --- a/website/docs/services/repos/stats_commit_activity/index.md +++ b/website/docs/services/repos/stats_commit_activity/index.md @@ -1,39 +1,148 @@ ---- +--- title: stats_commit_activity hide_title: false hide_table_of_contents: false keywords: - stats_commit_activity - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a stats_commit_activity resource. ## Overview - +
Namestats_commit_activity
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `integer` | -| | `integer` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
integer
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. + +```sql +SELECT +days, +total, +week +FROM github.repos.stats_commit_activity +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/stats_contributors/index.md b/website/docs/services/repos/stats_contributors/index.md index 45bcc46..eadfa49 100644 --- a/website/docs/services/repos/stats_contributors/index.md +++ b/website/docs/services/repos/stats_contributors/index.md @@ -1,39 +1,148 @@ ---- +--- title: stats_contributors hide_title: false hide_table_of_contents: false keywords: - stats_contributors - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a stats_contributors resource. ## Overview - +
Namestats_contributors
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub user. | -| | `integer` | | -| | `array` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectA GitHub user. (title: Simple User)
integer
array
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo
Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:

* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
* `a` - Number of additions
* `d` - Number of deletions
* `c` - Number of commits

> [!NOTE]
> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +
Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:

* `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time).
* `a` - Number of additions
* `d` - Number of deletions
* `c` - Number of commits

> [!NOTE]
> This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + +```sql +SELECT +author, +total, +weeks +FROM github.repos.stats_contributors +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/stats_participation/index.md b/website/docs/services/repos/stats_participation/index.md index eb8fe11..5ff0076 100644 --- a/website/docs/services/repos/stats_participation/index.md +++ b/website/docs/services/repos/stats_participation/index.md @@ -1,38 +1,142 @@ ---- +--- title: stats_participation hide_title: false hide_table_of_contents: false keywords: - stats_participation - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a stats_participation resource. ## Overview - +
Namestats_participation
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `array` | + +The following fields are returned by `SELECT` queries: + + + + +The array order is oldest week (index 0) to most recent week. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoReturns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.

The array order is oldest week (index 0) to most recent week.

The most recent week is seven days ago at UTC midnight to today at UTC midnight.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.

The array order is oldest week (index 0) to most recent week.

The most recent week is seven days ago at UTC midnight to today at UTC midnight. + +```sql +SELECT +all, +owner +FROM github.repos.stats_participation +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/stats_punch_cards/index.md b/website/docs/services/repos/stats_punch_cards/index.md index 1e9312a..21efc75 100644 --- a/website/docs/services/repos/stats_punch_cards/index.md +++ b/website/docs/services/repos/stats_punch_cards/index.md @@ -1,34 +1,131 @@ ---- +--- title: stats_punch_cards hide_title: false hide_table_of_contents: false keywords: - stats_punch_cards - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a stats_punch_cards resource. ## Overview - +
Namestats_punch_cards
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + + + + + + + + + + + +
NameDatatypeDescription
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoEach array contains the day number, hour number, and number of commits:

* `0-6`: Sunday - Saturday
* `0-23`: Hour of day
* Number of commits

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Each array contains the day number, hour number, and number of commits:

* `0-6`: Sunday - Saturday
* `0-23`: Hour of day
* Number of commits

For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + +```sql +SELECT +* +FROM github.repos.stats_punch_cards +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/repos/status_check_contexts/index.md b/website/docs/services/repos/status_check_contexts/index.md index c86c014..bc27109 100644 --- a/website/docs/services/repos/status_check_contexts/index.md +++ b/website/docs/services/repos/status_check_contexts/index.md @@ -1,37 +1,260 @@ ---- +--- title: status_check_contexts hide_title: false hide_table_of_contents: false keywords: - status_check_contexts - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a status_check_contexts resource. ## Overview - +
Namestatus_check_contexts
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + +
NameDatatypeDescription
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `INSERT` | | -| | `DELETE` | | -| | `EXEC` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branch, contextsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branch, contextsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +SELECT +* +FROM github.repos.status_check_contexts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +INSERT INTO github.repos.status_check_contexts ( +contexts, +owner, +repo, +branch +) +SELECT +'{{ contexts }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ branch }}' +; +``` + + + +{`# Description fields are for documentation purposes +- name: status_check_contexts + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the status_check_contexts resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the status_check_contexts resource. + - name: branch + value: "{{ branch }}" + description: Required parameter for the status_check_contexts resource. + - name: contexts + value: + - "{{ contexts }}" + description: | + The name of the status checks +`} + + + + + +## `REPLACE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +REPLACE github.repos.status_check_contexts +SET +contexts = '{{ contexts }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +AND contexts = '{{ contexts }}' --required; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +DELETE FROM github.repos.status_check_contexts +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/status_check_protection/index.md b/website/docs/services/repos/status_check_protection/index.md index 33d21a6..6add4ea 100644 --- a/website/docs/services/repos/status_check_protection/index.md +++ b/website/docs/services/repos/status_check_protection/index.md @@ -1,43 +1,236 @@ ---- +--- title: status_check_protection hide_title: false hide_table_of_contents: false keywords: - status_check_protection - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a status_check_protection resource. ## Overview - +
Namestatus_check_protection
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `array` | -| | `array` | -| | `string` | -| | `boolean` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts)
boolean
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +SELECT +checks, +contexts, +contexts_url, +strict, +url +FROM github.repos.status_check_protection +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + +```sql +UPDATE github.repos.status_check_protection +SET +strict = {{ strict }}, +contexts = '{{ contexts }}', +checks = '{{ checks }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +RETURNING +checks, +contexts, +contexts_url, +strict, +url; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + +```sql +DELETE FROM github.repos.status_check_protection +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/status_combined/index.md b/website/docs/services/repos/status_combined/index.md index 153daf3..1b04b59 100644 --- a/website/docs/services/repos/status_combined/index.md +++ b/website/docs/services/repos/status_combined/index.md @@ -1,43 +1,190 @@ ---- +--- title: status_combined hide_title: false hide_table_of_contents: false keywords: - status_combined - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a status_combined resource. ## Overview - +
Namestatus_combined
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `object` | Minimal Repository | -| | `string` | | -| | `string` | | -| | `array` | | -| | `integer` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (uri)
objectMinimal Repository (title: Minimal Repository)
string
string
array
integer
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, refper_page, pageUsers with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.


Additionally, a combined `state` is returned. The `state` is one of:

* **failure** if any of the contexts report as `error` or `failure`
* **pending** if there are no statuses or a context is `pending`
* **success** if the latest status for all contexts is `success`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.


Additionally, a combined `state` is returned. The `state` is one of:

* **failure** if any of the contexts report as `error` or `failure`
* **pending** if there are no statuses or a context is `pending`
* **success** if the latest status for all contexts is `success` + +```sql +SELECT +commit_url, +repository, +sha, +state, +statuses, +total_count, +url +FROM github.repos.status_combined +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/status_commits/index.md b/website/docs/services/repos/status_commits/index.md index 7c1693b..db859aa 100644 --- a/website/docs/services/repos/status_commits/index.md +++ b/website/docs/services/repos/status_commits/index.md @@ -1,48 +1,312 @@ ---- +--- title: status_commits hide_title: false hide_table_of_contents: false keywords: - status_commits - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a status_commits resource. ## Overview - +
Namestatus_commits
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
string
string
string
objectA GitHub user. (title: Simple User)
string
string
string
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. | -| | `INSERT` | | Users with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, refper_page, pageUsers with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.
owner, repo, sha, stateUsers with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
string
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.

This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + +```sql +SELECT +id, +node_id, +avatar_url, +context, +created_at, +creator, +description, +state, +target_url, +updated_at, +url +FROM github.repos.status_commits +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ref = '{{ ref }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Users with push access in a repository can create commit statuses for a given SHA.

Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + +```sql +INSERT INTO github.repos.status_commits ( +state, +target_url, +description, +context, +owner, +repo, +sha +) +SELECT +'{{ state }}' /* required */, +'{{ target_url }}', +'{{ description }}', +'{{ context }}', +'{{ owner }}', +'{{ repo }}', +'{{ sha }}' +RETURNING +id, +node_id, +avatar_url, +context, +created_at, +creator, +description, +state, +target_url, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: status_commits + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the status_commits resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the status_commits resource. + - name: sha + value: "{{ sha }}" + description: Required parameter for the status_commits resource. + - name: state + value: "{{ state }}" + description: | + The state of the status. + valid_values: ['error', 'failure', 'pending', 'success'] + - name: target_url + value: "{{ target_url }}" + description: | + The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + \`http://ci.example.com/user/repo/build/sha\` + - name: description + value: "{{ description }}" + description: | + A short description of the status. + - name: context + value: "{{ context }}" + description: | + A string label to differentiate this status from the status of other systems. This field is case-insensitive. + default: default +`} + + + diff --git a/website/docs/services/repos/status_deployments/index.md b/website/docs/services/repos/status_deployments/index.md index a9f6e9f..feacc2e 100644 --- a/website/docs/services/repos/status_deployments/index.md +++ b/website/docs/services/repos/status_deployments/index.md @@ -1,53 +1,490 @@ ---- +--- title: status_deployments hide_title: false hide_table_of_contents: false keywords: - status_deployments - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a status_deployments resource. ## Overview - +
Namestatus_deployments
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | A short description of the status. | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | The environment of the deployment that the status is for. | -| | `string` | The URL for accessing your environment. | -| | `string` | The URL to associate with this status. | -| | `string` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `string` | | -| | `string` | The state of the status. | -| | `string` | Deprecated: the URL to associate with this status. | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: MDE2OkRlcGxveW1lbnRTdGF0dXMx)
string (date-time) (example: 2012-07-20T01:19:13Z)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/42)
stringA short description of the status. (default: , example: Deployment finished successfully.)
stringThe environment of the deployment that the status is for. (default: , example: production)
string (uri)The URL for accessing your environment. (default: , example: https://staging.example.com/)
string (uri)The URL to associate with this status. (default: , example: https://example.com/deployment/42/output)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
string (uri) (example: https://api.github.com/repos/octocat/example)
stringThe state of the status. (error, failure, inactive, pending, success, queued, in_progress) (example: success)
string (uri)Closing down notice: the URL to associate with this status. (default: , example: https://example.com/deployment/42/output)
string (date-time) (example: 2012-07-20T01:19:13Z)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: MDE2OkRlcGxveW1lbnRTdGF0dXMx)
string (date-time) (example: 2012-07-20T01:19:13Z)
objectA GitHub user. (title: Simple User)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/42)
stringA short description of the status. (default: , example: Deployment finished successfully.)
stringThe environment of the deployment that the status is for. (default: , example: production)
string (uri)The URL for accessing your environment. (default: , example: https://staging.example.com/)
string (uri)The URL to associate with this status. (default: , example: https://example.com/deployment/42/output)
objectGitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. (title: GitHub app)
string (uri) (example: https://api.github.com/repos/octocat/example)
stringThe state of the status. (error, failure, inactive, pending, success, queued, in_progress) (example: success)
string (uri)Closing down notice: the URL to associate with this status. (default: , example: https://example.com/deployment/42/output)
string (date-time) (example: 2012-07-20T01:19:13Z)
string (uri) (example: https://api.github.com/repos/octocat/example/deployments/42/statuses/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Users with pull access can view a deployment status for a deployment: | -| | `SELECT` | | Users with pull access can view deployment statuses for a deployment: | -| | `INSERT` | | Users with `push` access can create deployment statuses for a given deployment.

GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, deployment_id, status_idUsers with pull access can view a deployment status for a deployment:
owner, repo, deployment_idper_page, pageUsers with pull access can view deployment statuses for a deployment:
owner, repo, deployment_id, stateUsers with `push` access can create deployment statuses for a given deployment.

OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerdeployment_id parameter
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integer
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Users with pull access can view a deployment status for a deployment: + +```sql +SELECT +id, +node_id, +created_at, +creator, +deployment_url, +description, +environment, +environment_url, +log_url, +performed_via_github_app, +repository_url, +state, +target_url, +updated_at, +url +FROM github.repos.status_deployments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND deployment_id = '{{ deployment_id }}' -- required +AND status_id = '{{ status_id }}' -- required +; +``` + + + +Users with pull access can view deployment statuses for a deployment: + +```sql +SELECT +id, +node_id, +created_at, +creator, +deployment_url, +description, +environment, +environment_url, +log_url, +performed_via_github_app, +repository_url, +state, +target_url, +updated_at, +url +FROM github.repos.status_deployments +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND deployment_id = '{{ deployment_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Users with `push` access can create deployment statuses for a given deployment.

OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + +```sql +INSERT INTO github.repos.status_deployments ( +state, +target_url, +log_url, +description, +environment, +environment_url, +auto_inactive, +owner, +repo, +deployment_id +) +SELECT +'{{ state }}' /* required */, +'{{ target_url }}', +'{{ log_url }}', +'{{ description }}', +'{{ environment }}', +'{{ environment_url }}', +{{ auto_inactive }}, +'{{ owner }}', +'{{ repo }}', +'{{ deployment_id }}' +RETURNING +id, +node_id, +created_at, +creator, +deployment_url, +description, +environment, +environment_url, +log_url, +performed_via_github_app, +repository_url, +state, +target_url, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: status_deployments + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the status_deployments resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the status_deployments resource. + - name: deployment_id + value: {{ deployment_id }} + description: Required parameter for the status_deployments resource. + - name: state + value: "{{ state }}" + description: | + The state of the status. When you set a transient deployment to \`inactive\`, the deployment will be shown as \`destroyed\` in GitHub. + valid_values: ['error', 'failure', 'inactive', 'in_progress', 'queued', 'pending', 'success'] + - name: target_url + value: "{{ target_url }}" + description: | + The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + > [!NOTE] + > It's recommended to use the \`log_url\` parameter, which replaces \`target_url\`. + default: + - name: log_url + value: "{{ log_url }}" + description: | + The full URL of the deployment's output. This parameter replaces \`target_url\`. We will continue to accept \`target_url\` to support legacy uses, but we recommend replacing \`target_url\` with \`log_url\`. Setting \`log_url\` will automatically set \`target_url\` to the same value. Default: \`""\` + default: + - name: description + value: "{{ description }}" + description: | + A short description of the status. The maximum description length is 140 characters. + default: + - name: environment + value: "{{ environment }}" + description: | + Name for the target deployment environment, which can be changed when setting a deploy status. For example, \`production\`, \`staging\`, or \`qa\`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. + - name: environment_url + value: "{{ environment_url }}" + description: | + Sets the URL for accessing your environment. Default: \`""\` + default: + - name: auto_inactive + value: {{ auto_inactive }} + description: | + Adds a new \`inactive\` status to all prior non-transient, non-production environment deployments with the same repository and \`environment\` name as the created status's deployment. An \`inactive\` status is only added to deployments that had a \`success\` state. Default: \`true\` +`} + + + diff --git a/website/docs/services/repos/tag_protection/index.md b/website/docs/services/repos/tag_protection/index.md deleted file mode 100644 index 3e1151f..0000000 --- a/website/docs/services/repos/tag_protection/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: tag_protection -hide_title: false -hide_table_of_contents: false -keywords: - - tag_protection - - repos - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nametag_protection
TypeResource
Id
- -## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | This returns the tag protection states of a repository.

This information is only available to repository administrators. | -| | `INSERT` | | This creates a tag protection state for a repository.
This endpoint is only available to repository administrators. | -| | `DELETE` | | This deletes a tag protection state for a repository.
This endpoint is only available to repository administrators. | diff --git a/website/docs/services/repos/tags/index.md b/website/docs/services/repos/tags/index.md index 26b16f5..39507e9 100644 --- a/website/docs/services/repos/tags/index.md +++ b/website/docs/services/repos/tags/index.md @@ -1,41 +1,172 @@ ---- +--- title: tags hide_title: false hide_table_of_contents: false keywords: - tags - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a tags resource. ## Overview - +
Nametags
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `object` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: v0.1)
string
object
string (uri) (example: https://github.com/octocat/Hello-World/tarball/v0.1)
string (uri) (example: https://github.com/octocat/Hello-World/zipball/v0.1)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, page
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +name, +node_id, +commit, +tarball_url, +zipball_url +FROM github.repos.tags +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/team_access_restrictions/index.md b/website/docs/services/repos/team_access_restrictions/index.md index 1029536..49285fc 100644 --- a/website/docs/services/repos/team_access_restrictions/index.md +++ b/website/docs/services/repos/team_access_restrictions/index.md @@ -1,53 +1,397 @@ ---- +--- title: team_access_restrictions hide_title: false hide_table_of_contents: false keywords: - team_access_restrictions - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a team_access_restrictions resource. ## Overview - +
Nameteam_access_restrictions
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams. | -| | `INSERT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams. | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a team to push to this branch. You can also remove push access for child teams. | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams.
owner, repo, branch, teamsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams.
owner, repo, branch, teamsProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a team to push to this branch. You can also remove push access for child teams.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the teams who have push access to this branch. The list includes child teams. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.repos.team_access_restrictions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified teams push access for this branch. You can also give push access to child teams. + +```sql +INSERT INTO github.repos.team_access_restrictions ( +teams, +owner, +repo, +branch +) +SELECT +'{{ teams }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ branch }}' +RETURNING +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: team_access_restrictions + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the team_access_restrictions resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the team_access_restrictions resource. + - name: branch + value: "{{ branch }}" + description: Required parameter for the team_access_restrictions resource. + - name: teams + value: + - "{{ teams }}" + description: | + The slug values for teams +`} + + + + + +## `REPLACE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. + +```sql +REPLACE github.repos.team_access_restrictions +SET +teams = '{{ teams }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +AND teams = '{{ teams }}' --required +RETURNING +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a team to push to this branch. You can also remove push access for child teams. + +```sql +DELETE FROM github.repos.team_access_restrictions +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/teams/index.md b/website/docs/services/repos/teams/index.md index f9784a8..d19303f 100644 --- a/website/docs/services/repos/teams/index.md +++ b/website/docs/services/repos/teams/index.md @@ -1,50 +1,244 @@ ---- +--- title: teams hide_title: false hide_table_of_contents: false keywords: - teams - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a teams resource. ## Overview - +
Nameteams
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoper_page, pageLists the teams that have access to the specified repository and that are also visible to the authenticated user.

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

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the teams that have access to the specified repository and that are also visible to the authenticated user.

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

OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.repos.teams +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/repos/topics/index.md b/website/docs/services/repos/topics/index.md index e0b9dec..4097605 100644 --- a/website/docs/services/repos/topics/index.md +++ b/website/docs/services/repos/topics/index.md @@ -1,35 +1,177 @@ ---- +--- title: topics hide_title: false hide_table_of_contents: false keywords: - topics - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a topics resource. ## Overview - +
Nametopics
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + +
NameDatatypeDescription
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | -| | `EXEC` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repopage, per_page
owner, repo, names
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Response + +```sql +SELECT +* +FROM github.repos.topics +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + + + +## `REPLACE` examples + + + + +No description available. + +```sql +REPLACE github.repos.topics +SET +names = '{{ names }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND names = '{{ names }}' --required +RETURNING +names; +``` + + diff --git a/website/docs/services/repos/user_access_restrictions/index.md b/website/docs/services/repos/user_access_restrictions/index.md index 996a53a..11c734f 100644 --- a/website/docs/services/repos/user_access_restrictions/index.md +++ b/website/docs/services/repos/user_access_restrictions/index.md @@ -1,60 +1,437 @@ ---- +--- title: user_access_restrictions hide_title: false hide_table_of_contents: false keywords: - user_access_restrictions - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a user_access_restrictions resource. ## Overview - +
Nameuser_access_restrictions
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the people who have push access to this branch. | -| | `INSERT` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified people push access for this branch.

\| Type \| Description \|
\| ------- \| ----------------------------------------------------------------------------------------------------------------------------- \|
\| `array` \| Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. \| | -| | `DELETE` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a user to push to this branch.

\| Type \| Description \|
\| ------- \| --------------------------------------------------------------------------------------------------------------------------------------------- \|
\| `array` \| Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. \| | -| | `EXEC` | | Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

\| Type \| Description \|
\| ------- \| ----------------------------------------------------------------------------------------------------------------------------- \|
\| `array` \| Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. \| | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the people who have push access to this branch.
owner, repo, branch, usersProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified people push access for this branch.

| Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
owner, repo, branch, usersProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

| Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
owner, repo, branchProtected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a user to push to this branch.

| Type | Description |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Lists the people who have push access to this branch. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.repos.user_access_restrictions +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND branch = '{{ branch }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Grants the specified people push access for this branch.

| Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + +```sql +INSERT INTO github.repos.user_access_restrictions ( +users, +owner, +repo, +branch +) +SELECT +'{{ users }}' /* required */, +'{{ owner }}', +'{{ repo }}', +'{{ branch }}' +RETURNING +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +; +``` + + + +{`# Description fields are for documentation purposes +- name: user_access_restrictions + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the user_access_restrictions resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the user_access_restrictions resource. + - name: branch + value: "{{ branch }}" + description: Required parameter for the user_access_restrictions resource. + - name: users + value: + - "{{ users }}" + description: | + The username for users +`} + + + + + +## `REPLACE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

| Type | Description |
| ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + +```sql +REPLACE github.repos.user_access_restrictions +SET +users = '{{ users }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +AND users = '{{ users }}' --required +RETURNING +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type; +``` + + + + +## `DELETE` examples + + + + +Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

Removes the ability of a user to push to this branch.

| Type | Description |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + +```sql +DELETE FROM github.repos.user_access_restrictions +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND branch = '{{ branch }}' --required +; +``` + + diff --git a/website/docs/services/repos/view_traffic/index.md b/website/docs/services/repos/view_traffic/index.md index 60b1242..694efe5 100644 --- a/website/docs/services/repos/view_traffic/index.md +++ b/website/docs/services/repos/view_traffic/index.md @@ -1,39 +1,154 @@ ---- +--- title: view_traffic hide_title: false hide_table_of_contents: false keywords: - view_traffic - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a view_traffic resource. ## Overview - +
Nameview_traffic
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `integer` | -| | `array` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
integer
array
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoperGet the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringThe time frame to display results for.
+ +## `SELECT` examples + + + + +Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. + +```sql +SELECT +count, +uniques, +views +FROM github.repos.view_traffic +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per = '{{ per }}' +; +``` + + diff --git a/website/docs/services/repos/vulnerability_alerts/index.md b/website/docs/services/repos/vulnerability_alerts/index.md new file mode 100644 index 0000000..baa36e5 --- /dev/null +++ b/website/docs/services/repos/vulnerability_alerts/index.md @@ -0,0 +1,146 @@ +--- +title: vulnerability_alerts +hide_title: false +hide_table_of_contents: false +keywords: + - vulnerability_alerts + - repos + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a vulnerability_alerts resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoShows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
owner, repoEnables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
owner, repoDisables dependency alerts and the dependency graph for a repository.
The authenticated user must have admin access to the repository. For more information,
see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## Lifecycle Methods + + + + +Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + +```sql +EXEC github.repos.vulnerability_alerts.check_vulnerability_alerts +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + +```sql +EXEC github.repos.vulnerability_alerts.enable_vulnerability_alerts +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + + +Disables dependency alerts and the dependency graph for a repository.
The authenticated user must have admin access to the repository. For more information,
see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". + +```sql +EXEC github.repos.vulnerability_alerts.disable_vulnerability_alerts +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/repos/webhook_config/index.md b/website/docs/services/repos/webhook_config/index.md index 88c8c04..fb4c5ce 100644 --- a/website/docs/services/repos/webhook_config/index.md +++ b/website/docs/services/repos/webhook_config/index.md @@ -1,41 +1,200 @@ ---- +--- title: webhook_config hide_title: false hide_table_of_contents: false keywords: - webhook_config - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_config resource. ## Overview - +
Namewebhook_config
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. | -| | `` | | -| | `string` | If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). | -| | `string` | The URL to which the payloads will be delivered. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. (example: "json")
stringDetermines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** (example: "0")
stringIf provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). (example: "********")
string (uri)The URL to which the payloads will be delivered. (example: https://example.com/webhook)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)."

Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. | -| | `EXEC` | | Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)."

Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, hook_idReturns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint.
owner, repo, hook_idUpdates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + +```sql +SELECT +content_type, +insecure_ssl, +secret, +url +FROM github.repos.webhook_config +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND hook_id = '{{ hook_id }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook)."

OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + +```sql +UPDATE github.repos.webhook_config +SET +url = '{{ url }}', +content_type = '{{ content_type }}', +secret = '{{ secret }}', +insecure_ssl = '{{ insecure_ssl }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND hook_id = '{{ hook_id }}' --required +RETURNING +content_type, +insecure_ssl, +secret, +url; +``` + + diff --git a/website/docs/services/repos/webhook_deliveries/index.md b/website/docs/services/repos/webhook_deliveries/index.md index ad5a5b4..4a59a5c 100644 --- a/website/docs/services/repos/webhook_deliveries/index.md +++ b/website/docs/services/repos/webhook_deliveries/index.md @@ -1,47 +1,226 @@ ---- +--- title: webhook_deliveries hide_title: false hide_table_of_contents: false keywords: - webhook_deliveries - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_deliveries resource. ## Overview - +
Namewebhook_deliveries
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the webhook delivery. | -| | `string` | The type of activity for the event that triggered the delivery. | -| | `string` | Time when the webhook delivery occurred. | -| | `number` | Time spent delivering. | -| | `string` | The event that triggered the delivery. | -| | `string` | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). | -| | `integer` | The id of the GitHub App installation associated with this event. | -| | `boolean` | Whether the webhook delivery is a redelivery. | -| | `integer` | The id of the repository associated with this event. | -| | `string` | Describes the response returned after attempting the delivery. | -| | `integer` | Status code received when delivery was made. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)Unique identifier of the webhook delivery.
integer (int64)The id of the GitHub App installation associated with this event.
integer (int64)The id of the repository associated with this event.
stringThe type of activity for the event that triggered the delivery. (example: opened)
string (date-time)Time when the webhook delivery occurred. (example: 2021-05-12T20:33:44Z)
numberTime spent delivering.
stringThe event that triggered the delivery. (example: issues)
stringUnique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). (example: 58474f00-b361-11eb-836d-0e4f3503ccbe)
booleanWhether the webhook delivery is a redelivery.
stringDescribes the response returned after attempting the delivery. (example: failed to connect)
integerStatus code received when delivery was made.
string (date-time)Time when the webhook delivery was throttled. (example: 2021-05-12T20:33:44Z)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, hook_idper_page, cursor, statusReturns a list of webhook deliveries for a webhook configured in a repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringUsed for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringReturns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).
+ +## `SELECT` examples + + + + +Returns a list of webhook deliveries for a webhook configured in a repository. + +```sql +SELECT +id, +installation_id, +repository_id, +action, +delivered_at, +duration, +event, +guid, +redelivery, +status, +status_code, +throttled_at +FROM github.repos.webhook_deliveries +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND hook_id = '{{ hook_id }}' -- required +AND per_page = '{{ per_page }}' +AND cursor = '{{ cursor }}' +AND status = '{{ status }}' +; +``` + + diff --git a/website/docs/services/repos/webhook_delivery/index.md b/website/docs/services/repos/webhook_delivery/index.md index 89ee09c..d307989 100644 --- a/website/docs/services/repos/webhook_delivery/index.md +++ b/website/docs/services/repos/webhook_delivery/index.md @@ -1,51 +1,263 @@ ---- +--- title: webhook_delivery hide_title: false hide_table_of_contents: false keywords: - webhook_delivery - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhook_delivery resource. ## Overview - +
Namewebhook_delivery
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the delivery. | -| | `string` | The type of activity for the event that triggered the delivery. | -| | `string` | Time when the delivery was delivered. | -| | `number` | Time spent delivering. | -| | `string` | The event that triggered the delivery. | -| | `string` | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). | -| | `integer` | The id of the GitHub App installation associated with this event. | -| | `boolean` | Whether the delivery is a redelivery. | -| | `integer` | The id of the repository associated with this event. | -| | `object` | | -| | `object` | | -| | `string` | Description of the status of the attempted delivery | -| | `integer` | Status code received when delivery was made. | -| | `string` | The URL target of the delivery. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the delivery.
integerThe id of the GitHub App installation associated with this event.
integerThe id of the repository associated with this event.
stringThe type of activity for the event that triggered the delivery. (example: opened)
string (date-time)Time when the delivery was delivered. (example: 2021-05-12T20:33:44Z)
numberTime spent delivering.
stringThe event that triggered the delivery. (example: issues)
stringUnique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). (example: 58474f00-b361-11eb-836d-0e4f3503ccbe)
booleanWhether the delivery is a redelivery.
object
object
stringDescription of the status of the attempted delivery (example: failed to connect)
integerStatus code received when delivery was made.
string (date-time)Time when the webhook delivery was throttled. (example: 2021-05-12T20:33:44Z)
stringThe URL target of the delivery. (example: https://www.example.com)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns a delivery for a webhook configured in a repository. | -| | `EXEC` | | Redeliver a webhook delivery for a webhook configured in a repository. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, hook_id, delivery_idReturns a delivery for a webhook configured in a repository.
owner, repo, hook_id, delivery_idRedeliver a webhook delivery for a webhook configured in a repository.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Returns a delivery for a webhook configured in a repository. + +```sql +SELECT +id, +installation_id, +repository_id, +action, +delivered_at, +duration, +event, +guid, +redelivery, +request, +response, +status, +status_code, +throttled_at, +url +FROM github.repos.webhook_delivery +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND hook_id = '{{ hook_id }}' -- required +AND delivery_id = '{{ delivery_id }}' -- required +; +``` + + + + +## Lifecycle Methods + + + + +Redeliver a webhook delivery for a webhook configured in a repository. + +```sql +EXEC github.repos.webhook_delivery.redeliver_webhook_delivery +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@hook_id='{{ hook_id }}' --required, +@delivery_id='{{ delivery_id }}' --required +; +``` + + diff --git a/website/docs/services/repos/webhooks/index.md b/website/docs/services/repos/webhooks/index.md index 6b6a0c7..b9204b2 100644 --- a/website/docs/services/repos/webhooks/index.md +++ b/website/docs/services/repos/webhooks/index.md @@ -1,55 +1,564 @@ ---- +--- title: webhooks hide_title: false hide_table_of_contents: false keywords: - webhooks - repos - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a webhooks resource. ## Overview - +
Namewebhooks
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the webhook. | -| | `string` | The name of a valid service, use 'web' for a webhook. | -| | `boolean` | Determines whether the hook is actually triggered on pushes. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `array` | Determines what events the hook is triggered for. Default: ['push']. | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the webhook.
stringThe name of a valid service, use 'web' for a webhook. (example: web)
booleanDetermines whether the hook is actually triggered on pushes.
objectConfiguration object of the webhook (title: Webhook Configuration)
string (date-time) (example: 2011-09-06T17:26:27Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries)
arrayDetermines what events the hook is triggered for. Default: ['push'].
object (title: Hook Response)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test)
string
string (date-time) (example: 2011-09-06T20:39:23Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the webhook.
stringThe name of a valid service, use 'web' for a webhook. (example: web)
booleanDetermines whether the hook is actually triggered on pushes.
objectConfiguration object of the webhook (title: Webhook Configuration)
string (date-time) (example: 2011-09-06T17:26:27Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries)
arrayDetermines what events the hook is triggered for. Default: ['push'].
object (title: Hook Response)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test)
string
string (date-time) (example: 2011-09-06T20:39:23Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World/hooks/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." | -| | `SELECT` | | Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. | -| | `INSERT` | | Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
share the same `config` as long as those webhooks do not have any `events` that overlap. | -| | `DELETE` | | | -| | `EXEC` | | This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. | -| | `EXEC` | | This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.

**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` | -| | `EXEC` | | Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, hook_idReturns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](https://docs.github.com/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)."
owner, repoper_page, pageLists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.
owner, repoRepositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
share the same `config` as long as those webhooks do not have any `events` that overlap.
owner, repo, hook_idUpdates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](https://docs.github.com/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)."
owner, repo, hook_idDelete a webhook for an organization.

The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook.
owner, repo, hook_idThis will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
owner, repo, hook_idThis will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.

> [!NOTE]
> Previously `/repos/:owner/:repo/hooks/:hook_id/test`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](https://docs.github.com/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." + +```sql +SELECT +id, +name, +active, +config, +created_at, +deliveries_url, +events, +last_response, +ping_url, +test_url, +type, +updated_at, +url +FROM github.repos.webhooks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND hook_id = '{{ hook_id }}' -- required +; +``` + + + +Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. + +```sql +SELECT +id, +name, +active, +config, +created_at, +deliveries_url, +events, +last_response, +ping_url, +test_url, +type, +updated_at, +url +FROM github.repos.webhooks +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can
share the same `config` as long as those webhooks do not have any `events` that overlap. + +```sql +INSERT INTO github.repos.webhooks ( +name, +config, +events, +active, +owner, +repo +) +SELECT +'{{ name }}', +'{{ config }}', +'{{ events }}', +{{ active }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +id, +name, +active, +config, +created_at, +deliveries_url, +events, +last_response, +ping_url, +test_url, +type, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: webhooks + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the webhooks resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the webhooks resource. + - name: name + value: "{{ name }}" + description: | + Use \`web\` to create a webhook. Default: \`web\`. This parameter only accepts the value \`web\`. + - name: config + description: | + Key/value pairs to provide settings for this webhook. + value: + url: "{{ url }}" + content_type: "{{ content_type }}" + secret: "{{ secret }}" + insecure_ssl: "{{ insecure_ssl }}" + - name: events + value: + - "{{ events }}" + description: | + Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + default: push + - name: active + value: {{ active }} + description: | + Determines if notifications are sent when the webhook is triggered. Set to \`true\` to send notifications. + default: true +`} + + + + + +## `UPDATE` examples + + + + +Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](https://docs.github.com/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." + +```sql +UPDATE github.repos.webhooks +SET +config = '{{ config }}', +events = '{{ events }}', +add_events = '{{ add_events }}', +remove_events = '{{ remove_events }}', +active = {{ active }} +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND hook_id = '{{ hook_id }}' --required +RETURNING +id, +name, +active, +config, +created_at, +deliveries_url, +events, +last_response, +ping_url, +test_url, +type, +updated_at, +url; +``` + + + + +## `DELETE` examples + + + + +Delete a webhook for an organization.

The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + +```sql +DELETE FROM github.repos.webhooks +WHERE owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND hook_id = '{{ hook_id }}' --required +; +``` + + + + +## Lifecycle Methods + + + + +This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + +```sql +EXEC github.repos.webhooks.ping_webhook +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@hook_id='{{ hook_id }}' --required +; +``` + + + +This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.

> [!NOTE]
> Previously `/repos/:owner/:repo/hooks/:hook_id/test` + +```sql +EXEC github.repos.webhooks.test_push_webhook +@owner='{{ owner }}' --required, +@repo='{{ repo }}' --required, +@hook_id='{{ hook_id }}' --required +; +``` + + diff --git a/website/docs/services/search/code/index.md b/website/docs/services/search/code/index.md index 2c157d4..af0b75c 100644 --- a/website/docs/services/search/code/index.md +++ b/website/docs/services/search/code/index.md @@ -1,49 +1,166 @@ ---- +--- title: code hide_title: false hide_table_of_contents: false keywords: - code - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a code resource. ## Overview - +
Namecode
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `object` | Minimal Repository | -| | `number` | | -| | `string` | | -| | `array` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
qsort, order, per_page, pageSearches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

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](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:

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

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.

Considerations for code search:

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

* Only the _default branch_ is considered. In most cases, this will be the `master` branch.
* Only files smaller than 384 KB are searchable.
* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.

> [!NOTE]
> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.

This endpoint requires you to authenticate and limits you to 10 requests per minute.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers.
string**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
string**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
+ +## `SELECT` examples + + + + +Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

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](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:

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

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.

Considerations for code search:

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

* Only the _default branch_ is considered. In most cases, this will be the `master` branch.
* Only files smaller than 384 KB are searchable.
* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing
language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.

> [!NOTE]
> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.

This endpoint requires you to authenticate and limits you to 10 requests per minute. + +```sql +SELECT +incomplete_results, +items, +total_count +FROM github.search.code +WHERE q = '{{ q }}' -- required +AND sort = '{{ sort }}' +AND order = '{{ order }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/search/commits/index.md b/website/docs/services/search/commits/index.md index 4bf95b6..77307fa 100644 --- a/website/docs/services/search/commits/index.md +++ b/website/docs/services/search/commits/index.md @@ -1,48 +1,166 @@ ---- +--- title: commits hide_title: false hide_table_of_contents: false keywords: - commits - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a commits resource. ## Overview - +
Namecommits
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub user. | -| | `string` | | -| | `object` | | -| | `object` | Metaproperties for Git author/committer information. | -| | `string` | | -| | `string` | | -| | `array` | | -| | `object` | Minimal Repository | -| | `number` | | -| | `string` | | -| | `array` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
qsort, order, per_page, pageFind commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:

`q=repo:octocat/Spoon-Knife+css`
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers.
stringDetermines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringSorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
+ +## `SELECT` examples + + + + +Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:

`q=repo:octocat/Spoon-Knife+css` + +```sql +SELECT +incomplete_results, +items, +total_count +FROM github.search.commits +WHERE q = '{{ q }}' -- required +AND sort = '{{ sort }}' +AND order = '{{ order }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/search/index.md b/website/docs/services/search/index.md index ca50182..72b6fee 100644 --- a/website/docs/services/search/index.md +++ b/website/docs/services/search/index.md @@ -9,33 +9,18 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Look For Stuff On GitHub. - -:::info Service Summary +search service documentation. -
-
-total resources: 7
-total selectable resources: 7
-total methods: 7
-
-
+:::info[Service Summary] -::: +total resources: __7__ -## Overview - - - - - - -
Namegithub.search
TypeService
TitleGitHub V3 REST API - Search
DescriptionLook For Stuff On GitHub.
Idsearch:v24.04.00227
+::: ## Resources
@@ -43,11 +28,11 @@ Look For Stuff On GitHub. code
commits
issues_and_pull_requests
-labels
+labels
repos
topics
-users
-
+users + \ No newline at end of file diff --git a/website/docs/services/search/issues_and_pull_requests/index.md b/website/docs/services/search/issues_and_pull_requests/index.md index f2ba073..663c8f0 100644 --- a/website/docs/services/search/issues_and_pull_requests/index.md +++ b/website/docs/services/search/issues_and_pull_requests/index.md @@ -1,71 +1,190 @@ ---- +--- title: issues_and_pull_requests hide_title: false hide_table_of_contents: false keywords: - issues_and_pull_requests - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an issues_and_pull_requests resource. ## Overview - +
Nameissues_and_pull_requests
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `array` | | -| | `string` | How the author is associated with the repository. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `boolean` | | -| | `object` | A collection of related issues and pull requests. | -| | `string` | | -| | `integer` | | -| | `object` | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. | -| | `object` | | -| | `object` | | -| | `object` | A repository on GitHub. | -| | `string` | | -| | `number` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
arrayWhen a semantic or hybrid search falls back to lexical search, this field contains the reasons for the fallback. Only present when a fallback occurred.
stringThe type of search that was performed. Possible values are `lexical`, `semantic`, or `hybrid`. (lexical, semantic, hybrid)
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
qsort, order, per_page, page, advanced_search, search_typeFind issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted
search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

`q=windows+label:bug+language:python+state:open&sort=created&order=asc`

This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

> [!NOTE]
> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers.
stringDetermines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe type of search to perform on issues. When not specified, the default is lexical search. - `semantic` β€” performs a pure semantic (vector) search using embedding-based understanding. - `hybrid` β€” combines semantic search with lexical search for best results. Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. Only applies to issue searches (`/search/issues`).
stringSorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
+ +## `SELECT` examples + + + + +Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted
search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

`q=windows+label:bug+language:python+state:open&sort=created&order=asc`

This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

> [!NOTE]
> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + +```sql +SELECT +incomplete_results, +items, +lexical_fallback_reason, +search_type, +total_count +FROM github.search.issues_and_pull_requests +WHERE q = '{{ q }}' -- required +AND sort = '{{ sort }}' +AND order = '{{ order }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND advanced_search = '{{ advanced_search }}' +AND search_type = '{{ search_type }}' +; +``` + + diff --git a/website/docs/services/search/labels/index.md b/website/docs/services/search/labels/index.md index 66a7a53..d56e20a 100644 --- a/website/docs/services/search/labels/index.md +++ b/website/docs/services/search/labels/index.md @@ -1,45 +1,172 @@ ---- +--- title: labels hide_title: false hide_table_of_contents: false keywords: - labels - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a labels resource. ## Overview - +
Namelabels
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `number` | -| | `array` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
repository_id, qsort, order, per_page, pageFind labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:

`q=bug+defect+enhancement&repository_id=64778136`

The labels that best match the query appear first in the search results.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).
integerThe id of the repository.
stringDetermines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringSorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
+ +## `SELECT` examples + + + + +Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:

`q=bug+defect+enhancement&repository_id=64778136`

The labels that best match the query appear first in the search results. + +```sql +SELECT +incomplete_results, +items, +total_count +FROM github.search.labels +WHERE repository_id = '{{ repository_id }}' -- required +AND q = '{{ q }}' -- required +AND sort = '{{ sort }}' +AND order = '{{ order }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/search/repos/index.md b/website/docs/services/search/repos/index.md index d74e0c3..a30b5fe 100644 --- a/website/docs/services/search/repos/index.md +++ b/website/docs/services/search/repos/index.md @@ -1,125 +1,166 @@ ---- +--- title: repos hide_title: false hide_table_of_contents: false keywords: - repos - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos resource. ## Overview - +
Namerepos
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | Returns whether or not this repository disabled. | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | License Simple | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `number` | | -| | `integer` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | The repository visibility: public, private, or internal. | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
qsort, order, per_page, pageFind repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

`q=tetris+language:assembly&sort=stars&order=desc`

This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers.
stringDetermines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringSorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
+ +## `SELECT` examples + + + + +Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

`q=tetris+language:assembly&sort=stars&order=desc`

This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + +```sql +SELECT +incomplete_results, +items, +total_count +FROM github.search.repos +WHERE q = '{{ q }}' -- required +AND sort = '{{ sort }}' +AND order = '{{ order }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/search/topics/index.md b/website/docs/services/search/topics/index.md index b5f6945..876776c 100644 --- a/website/docs/services/search/topics/index.md +++ b/website/docs/services/search/topics/index.md @@ -1,52 +1,154 @@ ---- +--- title: topics hide_title: false hide_table_of_contents: false keywords: - topics - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a topics resource. ## Overview - +
Nametopics
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | -| | `array` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `boolean` | -| | `string` | -| | `array` | -| | `string` | -| | `integer` | -| | `number` | -| | `string` | -| | `array` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
qper_page, pageFind topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

`q=ruby+is:featured`

This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers.

When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

`q=ruby+is:featured`

This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + +```sql +SELECT +incomplete_results, +items, +total_count +FROM github.search.topics +WHERE q = '{{ q }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/search/users/index.md b/website/docs/services/search/users/index.md index ce0d4b0..4a67312 100644 --- a/website/docs/services/search/users/index.md +++ b/website/docs/services/search/users/index.md @@ -1,70 +1,166 @@ ---- +--- title: users hide_title: false hide_table_of_contents: false keywords: - users - search - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a users resource. ## Overview - +
Nameusers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `integer` | -| | `string` | -| | `string` | -| | `number` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `array` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
boolean
array
integer
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
qsort, order, per_page, pageFind users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you're looking for a list of popular users, you might try this query:

`q=tom+repos:%3E42+followers:%3E1000`

This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers.
stringDetermines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringSorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)
+ +## `SELECT` examples + + + + +Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).

When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).

For example, if you're looking for a list of popular users, you might try this query:

`q=tom+repos:%3E42+followers:%3E1000`

This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." + +```sql +SELECT +incomplete_results, +items, +total_count +FROM github.search.users +WHERE q = '{{ q }}' -- required +AND sort = '{{ sort }}' +AND order = '{{ order }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/secret_scanning/alerts/index.md b/website/docs/services/secret_scanning/alerts/index.md index e9f03bf..9330bc4 100644 --- a/website/docs/services/secret_scanning/alerts/index.md +++ b/website/docs/services/secret_scanning/alerts/index.md @@ -1,57 +1,1005 @@ ---- +--- title: alerts hide_title: false hide_table_of_contents: false keywords: - alerts - secret_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an alerts resource. ## Overview - +
Namealerts
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The GitHub URL of the alert resource. | -| | `string` | The REST API URL of the code locations for this alert. | -| | `integer` | The security alert number. | -| | `boolean` | Whether push protection was bypassed for the detected secret. | -| | `string` | The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | **Required when the `state` is `resolved`.** The reason for resolving the alert. | -| | `string` | An optional comment to resolve an alert. | -| | `string` | The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `object` | A GitHub user. | -| | `string` | The secret that was detected. | -| | `string` | The type of secret that secret scanning detected. | -| | `string` | User-friendly name for the detected secret, matching the `secret_type`.
For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." | -| | `string` | Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. | -| | `string` | The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. | -| | `string` | The REST API URL of the alert resource. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUser-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."
objectA GitHub user. (title: Simple User)
stringAn optional comment from the closure request author.
objectA GitHub user. (title: Simple User)
stringAn optional comment from the closure request reviewer.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.
booleanA boolean value representing whether or not the token in the alert was detected in more than one location.
string (uri)The GitHub URL of the alert resource.
booleanA boolean value representing whether or not alert is base64 encoded
string (uri)The REST API URL of the code locations for this alert.
booleanWhether the detected secret was found in multiple repositories under the same organization or enterprise.
integerThe security alert number.
stringThe provider of the secret that was detected.
stringThe slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.
booleanWhether the detected secret was publicly leaked.
stringAn optional comment when requesting a push protection bypass.
string (uri)The URL to a push protection bypass request.
objectA GitHub user. (title: Simple User)
stringAn optional comment when reviewing a push protection bypass.
booleanWhether push protection was bypassed for the detected secret.
string (date-time)The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
string**Required when the `state` is `resolved`.** The reason for resolving the alert. (false_positive, wont_fix, revoked, used_in_tests)
stringAn optional comment to resolve an alert.
string (date-time)The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringThe secret that was detected.
stringThe type of secret that secret scanning detected.
stringSets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. (open, resolved)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
stringThe token status as of the latest validity check. (active, inactive, unknown)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUser-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."
objectA GitHub user. (title: Simple User)
stringAn optional comment from the closure request author.
objectA GitHub user. (title: Simple User)
stringAn optional comment from the closure request reviewer.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.
booleanA boolean value representing whether or not the token in the alert was detected in more than one location.
string (uri)The GitHub URL of the alert resource.
booleanA boolean value representing whether or not alert is base64 encoded
string (uri)The REST API URL of the code locations for this alert.
booleanWhether the detected secret was found in multiple repositories under the same organization or enterprise.
integerThe security alert number.
stringThe provider of the secret that was detected.
stringThe slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.
booleanWhether the detected secret was publicly leaked.
stringAn optional comment when requesting a push protection bypass.
string (uri)The URL to a push protection bypass request.
objectA GitHub user. (title: Simple User)
stringAn optional comment when reviewing a push protection bypass.
booleanWhether push protection was bypassed for the detected secret.
string (date-time)The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
string**Required when the `state` is `resolved`.** The reason for resolving the alert. (false_positive, wont_fix, revoked, used_in_tests)
stringAn optional comment to resolve an alert.
string (date-time)The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringThe secret that was detected.
stringThe type of secret that secret scanning detected.
stringSets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. (open, resolved)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
stringThe token status as of the latest validity check. (active, inactive, unknown)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringUser-friendly name for the detected secret, matching the `secret_type`. For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."
objectA GitHub user. (title: Simple User)
stringAn optional comment from the closure request author.
objectA GitHub user. (title: Simple User)
stringAn optional comment from the closure request reviewer.
string (date-time)The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectDetails on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request.
booleanA boolean value representing whether or not the token in the alert was detected in more than one location.
string (uri)The GitHub URL of the alert resource.
booleanA boolean value representing whether or not alert is base64 encoded
string (uri)The REST API URL of the code locations for this alert.
booleanWhether the detected secret was found in multiple repositories in the same organization or enterprise.
integerThe security alert number.
stringThe provider of the secret that was detected.
stringThe slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters.
booleanWhether the secret was publicly leaked.
stringAn optional comment when requesting a push protection bypass.
string (uri)The URL to a push protection bypass request.
objectA GitHub user. (title: Simple User)
stringAn optional comment when reviewing a push protection bypass.
booleanWhether push protection was bypassed for the detected secret.
string (date-time)The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
objectA GitHub repository. (title: Simple Repository)
string**Required when the `state` is `resolved`.** The reason for resolving the alert. (false_positive, wont_fix, revoked, used_in_tests)
stringThe comment that was optionally added when this alert was closed
string (date-time)The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
objectA GitHub user. (title: Simple User)
stringThe secret that was detected.
stringThe type of secret that secret scanning detected.
stringSets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. (open, resolved)
string (date-time)The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
string (uri)The REST API URL of the alert resource.
stringThe token status as of the latest validity check. (active, inactive, unknown)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a single secret scanning alert detected in an eligible repository.
To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
For public repositories, you may instead use the `public_repo` scope.

GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. | -| | `SELECT` | | Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). | -| | `SELECT` | | Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.
To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
For public repositories, you may instead use the `public_repo` scope.

GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. | -| | `SELECT` | | Lists secret scanning alerts for an eligible repository, from newest to oldest.
To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
For public repositories, you may instead use the `public_repo` scope.

GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. | -| | `EXEC` | | Updates the status of a secret scanning alert in an eligible repository.
To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
For public repositories, you may instead use the `public_repo` scope.

GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, alert_numberhide_secretGets a single secret scanning alert detected in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
owner, repostate, secret_type, exclude_secret_types, exclude_providers, providers, resolution, assignee, sort, direction, page, per_page, before, after, validity, is_publicly_leaked, is_multi_repo, hide_secretLists secret scanning alerts for an eligible repository, from newest to oldest.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
orgstate, secret_type, exclude_secret_types, exclude_providers, providers, resolution, assignee, sort, direction, page, per_page, before, after, validity, is_publicly_leaked, is_multi_repo, hide_secretLists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
owner, repo, alert_number, state, assignee, validityUpdates the status of a secret scanning alert in an eligible repository.

You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string.
stringFilters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string.
stringThe direction to sort the results by.
stringA comma-separated list of provider slugs to exclude from the results. Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). You can find the provider slug in the `provider_slug` field of each alert. Cannot be combined with the `providers` parameter.
stringA comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the `secret_type` parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types.
booleanA boolean value representing whether or not to hide literal secrets in the results.
booleanA boolean value representing whether or not to filter alerts by the multi-repo tag being present.
booleanA boolean value representing whether or not to filter alerts by the publicly-leaked tag being present.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA comma-separated list of provider slugs to filter by. Provider slugs use lowercase with underscores (e.g., `github_secret_scanning`, `clojars`). You can find the provider slug in the `provider_slug` field of each alert. Cannot be combined with the `exclude_providers` parameter.
stringA comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.
stringA comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types.
stringThe property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved.
stringSet to `open` or `resolved` to only list secret scanning alerts in a specific state.
stringA comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`.
+ +## `SELECT` examples + + + + +Gets a single secret scanning alert detected in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +secret_type_display_name, +assigned_to, +closure_request_comment, +closure_request_reviewer, +closure_request_reviewer_comment, +created_at, +first_location_detected, +has_more_locations, +html_url, +is_base64_encoded, +locations_url, +multi_repo, +number, +provider, +provider_slug, +publicly_leaked, +push_protection_bypass_request_comment, +push_protection_bypass_request_html_url, +push_protection_bypass_request_reviewer, +push_protection_bypass_request_reviewer_comment, +push_protection_bypassed, +push_protection_bypassed_at, +push_protection_bypassed_by, +resolution, +resolution_comment, +resolved_at, +resolved_by, +secret, +secret_type, +state, +updated_at, +url, +validity +FROM github.secret_scanning.alerts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND alert_number = '{{ alert_number }}' -- required +AND hide_secret = '{{ hide_secret }}' +; +``` + + + +Lists secret scanning alerts for an eligible repository, from newest to oldest.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +secret_type_display_name, +assigned_to, +closure_request_comment, +closure_request_reviewer, +closure_request_reviewer_comment, +created_at, +first_location_detected, +has_more_locations, +html_url, +is_base64_encoded, +locations_url, +multi_repo, +number, +provider, +provider_slug, +publicly_leaked, +push_protection_bypass_request_comment, +push_protection_bypass_request_html_url, +push_protection_bypass_request_reviewer, +push_protection_bypass_request_reviewer_comment, +push_protection_bypassed, +push_protection_bypassed_at, +push_protection_bypassed_by, +resolution, +resolution_comment, +resolved_at, +resolved_by, +secret, +secret_type, +state, +updated_at, +url, +validity +FROM github.secret_scanning.alerts +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND state = '{{ state }}' +AND secret_type = '{{ secret_type }}' +AND exclude_secret_types = '{{ exclude_secret_types }}' +AND exclude_providers = '{{ exclude_providers }}' +AND providers = '{{ providers }}' +AND resolution = '{{ resolution }}' +AND assignee = '{{ assignee }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND validity = '{{ validity }}' +AND is_publicly_leaked = '{{ is_publicly_leaked }}' +AND is_multi_repo = '{{ is_multi_repo }}' +AND hide_secret = '{{ hide_secret }}' +; +``` + + + +Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +secret_type_display_name, +assigned_to, +closure_request_comment, +closure_request_reviewer, +closure_request_reviewer_comment, +created_at, +first_location_detected, +has_more_locations, +html_url, +is_base64_encoded, +locations_url, +multi_repo, +number, +provider, +provider_slug, +publicly_leaked, +push_protection_bypass_request_comment, +push_protection_bypass_request_html_url, +push_protection_bypass_request_reviewer, +push_protection_bypass_request_reviewer_comment, +push_protection_bypassed, +push_protection_bypassed_at, +push_protection_bypassed_by, +repository, +resolution, +resolution_comment, +resolved_at, +resolved_by, +secret, +secret_type, +state, +updated_at, +url, +validity +FROM github.secret_scanning.alerts +WHERE org = '{{ org }}' -- required +AND state = '{{ state }}' +AND secret_type = '{{ secret_type }}' +AND exclude_secret_types = '{{ exclude_secret_types }}' +AND exclude_providers = '{{ exclude_providers }}' +AND providers = '{{ providers }}' +AND resolution = '{{ resolution }}' +AND assignee = '{{ assignee }}' +AND sort = '{{ sort }}' +AND direction = '{{ direction }}' +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND validity = '{{ validity }}' +AND is_publicly_leaked = '{{ is_publicly_leaked }}' +AND is_multi_repo = '{{ is_multi_repo }}' +AND hide_secret = '{{ hide_secret }}' +; +``` + + + + +## `UPDATE` examples + + + + +Updates the status of a secret scanning alert in an eligible repository.

You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +UPDATE github.secret_scanning.alerts +SET +state = '{{ state }}', +resolution = '{{ resolution }}', +resolution_comment = '{{ resolution_comment }}', +assignee = '{{ assignee }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND alert_number = '{{ alert_number }}' --required +AND state = '{{ state }}' --required +AND assignee = '{{ assignee }}' --required +RETURNING +secret_type_display_name, +assigned_to, +closure_request_comment, +closure_request_reviewer, +closure_request_reviewer_comment, +created_at, +first_location_detected, +has_more_locations, +html_url, +is_base64_encoded, +locations_url, +multi_repo, +number, +provider, +provider_slug, +publicly_leaked, +push_protection_bypass_request_comment, +push_protection_bypass_request_html_url, +push_protection_bypass_request_reviewer, +push_protection_bypass_request_reviewer_comment, +push_protection_bypassed, +push_protection_bypassed_at, +push_protection_bypassed_by, +resolution, +resolution_comment, +resolved_at, +resolved_by, +secret, +secret_type, +state, +updated_at, +url, +validity; +``` + + diff --git a/website/docs/services/secret_scanning/index.md b/website/docs/services/secret_scanning/index.md index c92f205..e5b8254 100644 --- a/website/docs/services/secret_scanning/index.md +++ b/website/docs/services/secret_scanning/index.md @@ -9,40 +9,28 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Secret Scanning - -:::info Service Summary +secret_scanning service documentation. -
-
-total resources: 2
-total selectable resources: 2
-total methods: 6
-
-
+:::info[Service Summary] -::: +total resources: __5__ -## Overview - - - - - - -
Namegithub.secret_scanning
TypeService
TitleGitHub V3 REST API - Secret Scanning
DescriptionSecret Scanning
Idsecret_scanning:v24.04.00227
+::: ## Resources
alerts
-
-
locations
+org_secret_scanning_pattern_configurations
+
+repo_push_protection_bypasses
+repo_secret_scan_history
+
\ No newline at end of file diff --git a/website/docs/services/secret_scanning/locations/index.md b/website/docs/services/secret_scanning/locations/index.md index 43dc9e0..9f03123 100644 --- a/website/docs/services/secret_scanning/locations/index.md +++ b/website/docs/services/secret_scanning/locations/index.md @@ -1,38 +1,160 @@ ---- +--- title: locations hide_title: false hide_table_of_contents: false keywords: - locations - secret_scanning - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a locations resource. ## Overview - +
Namelocations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `` | | -| | `string` | The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
objectRepresents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
stringThe location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. (commit, wiki_commit, issue_title, issue_body, issue_comment, discussion_title, discussion_body, discussion_comment, pull_request_title, pull_request_body, pull_request_comment, pull_request_review, pull_request_review_comment) (example: commit)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, alert_numberpage, per_pageLists all locations for a given secret scanning alert for an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all locations for a given secret scanning alert for an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +details, +type +FROM github.secret_scanning.locations +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND alert_number = '{{ alert_number }}' -- required +AND page = '{{ page }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/secret_scanning/org_secret_scanning_pattern_configurations/index.md b/website/docs/services/secret_scanning/org_secret_scanning_pattern_configurations/index.md new file mode 100644 index 0000000..1f67cd5 --- /dev/null +++ b/website/docs/services/secret_scanning/org_secret_scanning_pattern_configurations/index.md @@ -0,0 +1,176 @@ +--- +title: org_secret_scanning_pattern_configurations +hide_title: false +hide_table_of_contents: false +keywords: + - org_secret_scanning_pattern_configurations + - secret_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an org_secret_scanning_pattern_configurations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
arrayOverrides for custom patterns defined by the organization.
stringThe version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.
arrayOverrides for partner patterns.
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgLists the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the `read:org` scope to use this endpoint.
orgUpdates the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the `write:org` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the `read:org` scope to use this endpoint. + +```sql +SELECT +custom_pattern_overrides, +pattern_config_version, +provider_pattern_overrides +FROM github.secret_scanning.org_secret_scanning_pattern_configurations +WHERE org = '{{ org }}' -- required +; +``` + + + + +## `UPDATE` examples + + + + +Updates the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the `write:org` scope to use this endpoint. + +```sql +UPDATE github.secret_scanning.org_secret_scanning_pattern_configurations +SET +pattern_config_version = '{{ pattern_config_version }}', +provider_pattern_settings = '{{ provider_pattern_settings }}', +custom_pattern_settings = '{{ custom_pattern_settings }}' +WHERE +org = '{{ org }}' --required +RETURNING +pattern_config_version; +``` + + diff --git a/website/docs/services/secret_scanning/repo_push_protection_bypasses/index.md b/website/docs/services/secret_scanning/repo_push_protection_bypasses/index.md new file mode 100644 index 0000000..019b189 --- /dev/null +++ b/website/docs/services/secret_scanning/repo_push_protection_bypasses/index.md @@ -0,0 +1,144 @@ +--- +title: repo_push_protection_bypasses +hide_title: false +hide_table_of_contents: false +keywords: + - repo_push_protection_bypasses + - secret_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repo_push_protection_bypasses resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, reason, placeholder_idCreates a bypass for a previously push protected secret.

The authenticated user must be the original author of the committed secret.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Creates a bypass for a previously push protected secret.

The authenticated user must be the original author of the committed secret.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +INSERT INTO github.secret_scanning.repo_push_protection_bypasses ( +reason, +placeholder_id, +owner, +repo +) +SELECT +'{{ reason }}' /* required */, +'{{ placeholder_id }}' /* required */, +'{{ owner }}', +'{{ repo }}' +RETURNING +expire_at, +reason, +token_type +; +``` + + + +{`# Description fields are for documentation purposes +- name: repo_push_protection_bypasses + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the repo_push_protection_bypasses resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the repo_push_protection_bypasses resource. + - name: reason + value: "{{ reason }}" + description: | + The reason for bypassing push protection. + valid_values: ['false_positive', 'used_in_tests', 'will_fix_later'] + - name: placeholder_id + value: "{{ placeholder_id }}" + description: | + The ID of the push protection bypass placeholder. This value is returned on any push protected routes. +`} + + + diff --git a/website/docs/services/secret_scanning/repo_secret_scan_history/index.md b/website/docs/services/secret_scanning/repo_secret_scan_history/index.md new file mode 100644 index 0000000..99456c9 --- /dev/null +++ b/website/docs/services/secret_scanning/repo_secret_scan_history/index.md @@ -0,0 +1,154 @@ +--- +title: repo_secret_scan_history +hide_title: false +hide_table_of_contents: false +keywords: + - repo_secret_scan_history + - secret_scanning + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a repo_secret_scan_history resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
array
array
array
array
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repoLists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

> [!NOTE]
> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `SELECT` examples + + + + +Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

> [!NOTE]
> This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)."

OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + +```sql +SELECT +backfill_scans, +custom_pattern_backfill_scans, +incremental_scans, +pattern_update_scans +FROM github.secret_scanning.repo_secret_scan_history +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + diff --git a/website/docs/services/security_advisories/global_advisories/index.md b/website/docs/services/security_advisories/global_advisories/index.md index 42ab720..dde7467 100644 --- a/website/docs/services/security_advisories/global_advisories/index.md +++ b/website/docs/services/security_advisories/global_advisories/index.md @@ -1,58 +1,543 @@ ---- +--- title: global_advisories hide_title: false hide_table_of_contents: false keywords: - global_advisories - security_advisories - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a global_advisories resource. ## Overview - +
Nameglobal_advisories
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A detailed description of what the advisory entails. | -| | `array` | The users who contributed to the advisory. | -| | `string` | The Common Vulnerabilities and Exposures (CVE) ID. | -| | `object` | | -| | `array` | | -| | `string` | The GitHub Security Advisory ID. | -| | `string` | The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. | -| | `string` | The URL for the advisory. | -| | `array` | | -| | `string` | The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.
This field is only populated when the advisory is imported from the National Vulnerability Database. | -| | `string` | The date and time of when the advisory was published, in ISO 8601 format. | -| | `array` | | -| | `string` | The API URL for the repository advisory. | -| | `string` | The severity of the advisory. | -| | `string` | The URL of the advisory's source code. | -| | `string` | A short summary of the advisory. | -| | `string` | The type of advisory. | -| | `string` | The date and time of when the advisory was last updated, in ISO 8601 format. | -| | `string` | The API URL for the advisory. | -| | `array` | The products and respective version ranges affected by the advisory. | -| | `string` | The date and time of when the advisory was withdrawn, in ISO 8601 format. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Common Vulnerabilities and Exposures (CVE) ID.
stringThe GitHub Security Advisory ID.
arrayThe users who contributed to the advisory.
object
object
array
stringA detailed description of what the advisory entails.
objectThe EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).
string (date-time)The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
string (uri)The URL for the advisory.
array
string (date-time)The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. This field is only populated when the advisory is imported from the National Vulnerability Database.
string (date-time)The date and time of when the advisory was published, in ISO 8601 format.
array
string (uri)The API URL for the repository advisory.
stringThe severity of the advisory. (critical, high, medium, low, unknown)
string (uri)The URL of the advisory's source code.
stringA short summary of the advisory.
stringThe type of advisory. (reviewed, unreviewed, malware)
string (date-time)The date and time of when the advisory was last updated, in ISO 8601 format.
stringThe API URL for the advisory.
arrayThe products and respective version ranges affected by the advisory.
string (date-time)The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Common Vulnerabilities and Exposures (CVE) ID.
stringThe GitHub Security Advisory ID.
arrayThe users who contributed to the advisory.
object
object
array
stringA detailed description of what the advisory entails.
objectThe EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).
string (date-time)The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format.
string (uri)The URL for the advisory.
array
string (date-time)The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. This field is only populated when the advisory is imported from the National Vulnerability Database.
string (date-time)The date and time of when the advisory was published, in ISO 8601 format.
array
string (uri)The API URL for the repository advisory.
stringThe severity of the advisory. (critical, high, medium, low, unknown)
string (uri)The URL of the advisory's source code.
stringA short summary of the advisory.
stringThe type of advisory. (reviewed, unreviewed, malware)
string (date-time)The date and time of when the advisory was last updated, in ISO 8601 format.
stringThe API URL for the advisory.
arrayThe products and respective version ranges affected by the advisory.
string (date-time)The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. | -| | `SELECT` | | Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
ghsa_idGets a global security advisory using its GitHub Security Advisory (GHSA) identifier.
ghsa_id, type, cve_id, ecosystem, severity, cwes, is_withdrawn, affects, published, updated, modified, epss_percentage, epss_percentile, before, after, direction, per_page, sortLists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe GHSA (GitHub Security Advisory) identifier of the advisory.
If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringIf specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.
If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`
stringThe direction to sort the results by.
stringIf specified, only advisories for these ecosystems will be returned.
stringIf specified, only return advisories that have an EPSS percentage score that matches the provided value. The EPSS percentage represents the likelihood of a CVE being exploited.
stringIf specified, only return advisories that have an EPSS percentile score that matches the provided value. The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
stringIf specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.
booleanWhether to only return advisories that have been withdrawn.
stringIf specified, only show advisories that were updated or published on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringIf specified, only return advisories that were published on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
stringIf specified, only advisories with these severities will be returned.
stringThe property to sort the results by.
stringIf specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.
stringIf specified, only return advisories that were updated on a date or date range. For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
+ +## `SELECT` examples + + + + +Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + +```sql +SELECT +cve_id, +ghsa_id, +credits, +cvss, +cvss_severities, +cwes, +description, +epss, +github_reviewed_at, +html_url, +identifiers, +nvd_published_at, +published_at, +references, +repository_advisory_url, +severity, +source_code_location, +summary, +type, +updated_at, +url, +vulnerabilities, +withdrawn_at +FROM github.security_advisories.global_advisories +WHERE ghsa_id = '{{ ghsa_id }}' -- required +; +``` + + + +Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + +```sql +SELECT +cve_id, +ghsa_id, +credits, +cvss, +cvss_severities, +cwes, +description, +epss, +github_reviewed_at, +html_url, +identifiers, +nvd_published_at, +published_at, +references, +repository_advisory_url, +severity, +source_code_location, +summary, +type, +updated_at, +url, +vulnerabilities, +withdrawn_at +FROM github.security_advisories.global_advisories +WHERE ghsa_id = '{{ ghsa_id }}' +AND type = '{{ type }}' +AND cve_id = '{{ cve_id }}' +AND ecosystem = '{{ ecosystem }}' +AND severity = '{{ severity }}' +AND cwes = '{{ cwes }}' +AND is_withdrawn = '{{ is_withdrawn }}' +AND affects = '{{ affects }}' +AND published = '{{ published }}' +AND updated = '{{ updated }}' +AND modified = '{{ modified }}' +AND epss_percentage = '{{ epss_percentage }}' +AND epss_percentile = '{{ epss_percentile }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND direction = '{{ direction }}' +AND per_page = '{{ per_page }}' +AND sort = '{{ sort }}' +; +``` + + diff --git a/website/docs/services/security_advisories/index.md b/website/docs/services/security_advisories/index.md index ca278b4..a2df6b2 100644 --- a/website/docs/services/security_advisories/index.md +++ b/website/docs/services/security_advisories/index.md @@ -9,40 +9,27 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Security Advisories - -:::info Service Summary +security_advisories service documentation. -
-
-total resources: 2
-total selectable resources: 2
-total methods: 9
-
-
+:::info[Service Summary] -::: +total resources: __4__ -## Overview - - - - - - -
Namegithub.security_advisories
TypeService
TitleGitHub V3 REST API - Security Advisories
DescriptionSecurity Advisories
Idsecurity_advisories:v24.04.00227
+::: ## Resources
global_advisories
+private_vulnerability_reports
repository_advisories
+security_advisory_forks
-
+ \ No newline at end of file diff --git a/website/docs/services/security_advisories/private_vulnerability_reports/index.md b/website/docs/services/security_advisories/private_vulnerability_reports/index.md new file mode 100644 index 0000000..a083375 --- /dev/null +++ b/website/docs/services/security_advisories/private_vulnerability_reports/index.md @@ -0,0 +1,206 @@ +--- +title: private_vulnerability_reports +hide_title: false +hide_table_of_contents: false +keywords: + - private_vulnerability_reports + - security_advisories + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a private_vulnerability_reports resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, summary, descriptionReport a security vulnerability to the maintainers of the repository.
See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Report a security vulnerability to the maintainers of the repository.
See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. + +```sql +INSERT INTO github.security_advisories.private_vulnerability_reports ( +summary, +description, +vulnerabilities, +cwe_ids, +severity, +cvss_vector_string, +start_private_fork, +owner, +repo +) +SELECT +'{{ summary }}' /* required */, +'{{ description }}' /* required */, +'{{ vulnerabilities }}', +'{{ cwe_ids }}', +'{{ severity }}', +'{{ cvss_vector_string }}', +{{ start_private_fork }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +cve_id, +ghsa_id, +author, +closed_at, +collaborating_teams, +collaborating_users, +created_at, +credits, +credits_detailed, +cvss, +cvss_severities, +cwe_ids, +cwes, +description, +html_url, +identifiers, +private_fork, +published_at, +publisher, +severity, +state, +submission, +summary, +updated_at, +url, +vulnerabilities, +withdrawn_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: private_vulnerability_reports + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the private_vulnerability_reports resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the private_vulnerability_reports resource. + - name: summary + value: "{{ summary }}" + description: | + A short summary of the advisory. + - name: description + value: "{{ description }}" + description: | + A detailed description of what the advisory impacts. + - name: vulnerabilities + description: | + An array of products affected by the vulnerability detailed in a repository security advisory. + value: + - package: + ecosystem: "{{ ecosystem }}" + name: "{{ name }}" + vulnerable_version_range: "{{ vulnerable_version_range }}" + patched_versions: "{{ patched_versions }}" + vulnerable_functions: "{{ vulnerable_functions }}" + - name: cwe_ids + value: + - "{{ cwe_ids }}" + description: | + A list of Common Weakness Enumeration (CWE) IDs. + - name: severity + value: "{{ severity }}" + description: | + The severity of the advisory. You must choose between setting this field or \`cvss_vector_string\`. + valid_values: ['critical', 'high', 'medium', 'low'] + - name: cvss_vector_string + value: "{{ cvss_vector_string }}" + description: | + The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or \`severity\`. + - name: start_private_fork + value: {{ start_private_fork }} + description: | + Whether to create a temporary private fork of the repository to collaborate on a fix. + default: false +`} + + + diff --git a/website/docs/services/security_advisories/repository_advisories/index.md b/website/docs/services/security_advisories/repository_advisories/index.md index 3f12de7..9805cd8 100644 --- a/website/docs/services/security_advisories/repository_advisories/index.md +++ b/website/docs/services/security_advisories/repository_advisories/index.md @@ -1,68 +1,981 @@ ---- +--- title: repository_advisories hide_title: false hide_table_of_contents: false keywords: - repository_advisories - security_advisories - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repository_advisories resource. ## Overview - +
Namerepository_advisories
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | A detailed description of what the advisory entails. | -| | `null` | The author of the advisory. | -| | `string` | The date and time of when the advisory was closed, in ISO 8601 format. | -| | `array` | A list of teams that collaborate on the advisory. | -| | `array` | A list of users that collaborate on the advisory. | -| | `string` | The date and time of when the advisory was created, in ISO 8601 format. | -| | `array` | | -| | `array` | | -| | `string` | The Common Vulnerabilities and Exposures (CVE) ID. | -| | `object` | | -| | `array` | A list of only the CWE IDs. | -| | `array` | | -| | `string` | The GitHub Security Advisory ID. | -| | `string` | The URL for the advisory. | -| | `array` | | -| | `null` | A temporary private fork of the advisory's repository for collaborating on a fix. | -| | `string` | The date and time of when the advisory was published, in ISO 8601 format. | -| | `null` | The publisher of the advisory. | -| | `string` | The severity of the advisory. | -| | `string` | The state of the advisory. | -| | `object` | | -| | `string` | A short summary of the advisory. | -| | `string` | The date and time of when the advisory was last updated, in ISO 8601 format. | -| | `string` | The API URL for the advisory. | -| | `array` | | -| | `string` | The date and time of when the advisory was withdrawn, in ISO 8601 format. | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Common Vulnerabilities and Exposures (CVE) ID.
stringThe GitHub Security Advisory ID.
objectThe author of the advisory. (title: Simple User)
string (date-time)The date and time of when the advisory was closed, in ISO 8601 format.
arrayA list of teams that collaborate on the advisory.
arrayA list of users that collaborate on the advisory.
string (date-time)The date and time of when the advisory was created, in ISO 8601 format.
array
array
object
object
arrayA list of only the CWE IDs.
array
stringA detailed description of what the advisory entails.
string (uri)The URL for the advisory.
array
objectA temporary private fork of the advisory's repository for collaborating on a fix. (title: Simple Repository)
string (date-time)The date and time of when the advisory was published, in ISO 8601 format.
objectThe publisher of the advisory. (title: Simple User)
stringThe severity of the advisory. (critical, high, medium, low)
stringThe state of the advisory. (published, closed, withdrawn, draft, triage)
object
stringA short summary of the advisory.
string (date-time)The date and time of when the advisory was last updated, in ISO 8601 format.
string (uri)The API URL for the advisory.
array
string (date-time)The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Common Vulnerabilities and Exposures (CVE) ID.
stringThe GitHub Security Advisory ID.
objectThe author of the advisory. (title: Simple User)
string (date-time)The date and time of when the advisory was closed, in ISO 8601 format.
arrayA list of teams that collaborate on the advisory.
arrayA list of users that collaborate on the advisory.
string (date-time)The date and time of when the advisory was created, in ISO 8601 format.
array
array
object
object
arrayA list of only the CWE IDs.
array
stringA detailed description of what the advisory entails.
string (uri)The URL for the advisory.
array
objectA temporary private fork of the advisory's repository for collaborating on a fix. (title: Simple Repository)
string (date-time)The date and time of when the advisory was published, in ISO 8601 format.
objectThe publisher of the advisory. (title: Simple User)
stringThe severity of the advisory. (critical, high, medium, low)
stringThe state of the advisory. (published, closed, withdrawn, draft, triage)
object
stringA short summary of the advisory.
string (date-time)The date and time of when the advisory was last updated, in ISO 8601 format.
string (uri)The API URL for the advisory.
array
string (date-time)The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe Common Vulnerabilities and Exposures (CVE) ID.
stringThe GitHub Security Advisory ID.
objectThe author of the advisory. (title: Simple User)
string (date-time)The date and time of when the advisory was closed, in ISO 8601 format.
arrayA list of teams that collaborate on the advisory.
arrayA list of users that collaborate on the advisory.
string (date-time)The date and time of when the advisory was created, in ISO 8601 format.
array
array
object
object
arrayA list of only the CWE IDs.
array
stringA detailed description of what the advisory entails.
string (uri)The URL for the advisory.
array
objectA temporary private fork of the advisory's repository for collaborating on a fix. (title: Simple Repository)
string (date-time)The date and time of when the advisory was published, in ISO 8601 format.
objectThe publisher of the advisory. (title: Simple User)
stringThe severity of the advisory. (critical, high, medium, low)
stringThe state of the advisory. (published, closed, withdrawn, draft, triage)
object
stringA short summary of the advisory.
string (date-time)The date and time of when the advisory was last updated, in ISO 8601 format.
string (uri)The API URL for the advisory.
array
string (date-time)The date and time of when the advisory was withdrawn, in ISO 8601 format.
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
You can access any published security advisory on a public repository.
You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.

You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a
collaborator on the security advisory. | -| | `SELECT` | | Lists repository security advisories for an organization.

To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. | -| | `SELECT` | | Lists security advisories in a repository.
You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission
in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to.

You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. | -| | `INSERT` | | Creates a new repository security advisory.
You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.

In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. | -| | `EXEC` | | Report a security vulnerability to the maintainers of the repository.
See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. | -| | `EXEC` | | If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."

You may request a CVE for public repositories, but cannot do so for private repositories.

You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.

In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. | -| | `EXEC` | | Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.
You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.

In order to update any security advisory, you must be a security manager or administrator of that repository,
or a collaborator on the repository security advisory. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, ghsa_idGet a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

Anyone can access any published security advisory on a public repository.

The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
collaborator on the security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
owner, repodirection, sort, before, after, per_page, stateLists security advisories in a repository.

The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to.
orgdirection, sort, before, after, per_page, stateLists repository security advisories for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
owner, repo, ghsa_idIf you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."

You may request a CVE for public repositories, but cannot do so for private repositories.

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
owner, repo, summary, description, vulnerabilitiesCreates a new repository security advisory.

In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
owner, repo, ghsa_idUpdate a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
or a collaborator on the repository security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe GHSA (GitHub Security Advisory) identifier of the advisory.
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe direction to sort the results by.
integerThe number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringThe property to sort the results by.
stringFilter by the state of the repository advisories. Only advisories of this state will be returned.
+ +## `SELECT` examples + + + + +Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

Anyone can access any published security advisory on a public repository.

The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a
collaborator on the security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + +```sql +SELECT +cve_id, +ghsa_id, +author, +closed_at, +collaborating_teams, +collaborating_users, +created_at, +credits, +credits_detailed, +cvss, +cvss_severities, +cwe_ids, +cwes, +description, +html_url, +identifiers, +private_fork, +published_at, +publisher, +severity, +state, +submission, +summary, +updated_at, +url, +vulnerabilities, +withdrawn_at +FROM github.security_advisories.repository_advisories +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND ghsa_id = '{{ ghsa_id }}' -- required +; +``` + + + +Lists security advisories in a repository.

The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + +```sql +SELECT +cve_id, +ghsa_id, +author, +closed_at, +collaborating_teams, +collaborating_users, +created_at, +credits, +credits_detailed, +cvss, +cvss_severities, +cwe_ids, +cwes, +description, +html_url, +identifiers, +private_fork, +published_at, +publisher, +severity, +state, +submission, +summary, +updated_at, +url, +vulnerabilities, +withdrawn_at +FROM github.security_advisories.repository_advisories +WHERE owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +AND direction = '{{ direction }}' +AND sort = '{{ sort }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +AND state = '{{ state }}' +; +``` + + + +Lists repository security advisories for an organization.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + +```sql +SELECT +cve_id, +ghsa_id, +author, +closed_at, +collaborating_teams, +collaborating_users, +created_at, +credits, +credits_detailed, +cvss, +cvss_severities, +cwe_ids, +cwes, +description, +html_url, +identifiers, +private_fork, +published_at, +publisher, +severity, +state, +submission, +summary, +updated_at, +url, +vulnerabilities, +withdrawn_at +FROM github.security_advisories.repository_advisories +WHERE org = '{{ org }}' -- required +AND direction = '{{ direction }}' +AND sort = '{{ sort }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND per_page = '{{ per_page }}' +AND state = '{{ state }}' +; +``` + + + + +## `INSERT` examples + + + + +If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."

You may request a CVE for public repositories, but cannot do so for private repositories.

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + +```sql +INSERT INTO github.security_advisories.repository_advisories ( +owner, +repo, +ghsa_id +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ ghsa_id }}' +; +``` + + + +Creates a new repository security advisory.

In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + +```sql +INSERT INTO github.security_advisories.repository_advisories ( +summary, +description, +cve_id, +vulnerabilities, +cwe_ids, +credits, +severity, +cvss_vector_string, +start_private_fork, +owner, +repo +) +SELECT +'{{ summary }}' /* required */, +'{{ description }}' /* required */, +'{{ cve_id }}', +'{{ vulnerabilities }}' /* required */, +'{{ cwe_ids }}', +'{{ credits }}', +'{{ severity }}', +'{{ cvss_vector_string }}', +{{ start_private_fork }}, +'{{ owner }}', +'{{ repo }}' +RETURNING +cve_id, +ghsa_id, +author, +closed_at, +collaborating_teams, +collaborating_users, +created_at, +credits, +credits_detailed, +cvss, +cvss_severities, +cwe_ids, +cwes, +description, +html_url, +identifiers, +private_fork, +published_at, +publisher, +severity, +state, +submission, +summary, +updated_at, +url, +vulnerabilities, +withdrawn_at +; +``` + + + +{`# Description fields are for documentation purposes +- name: repository_advisories + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the repository_advisories resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the repository_advisories resource. + - name: ghsa_id + value: "{{ ghsa_id }}" + description: Required parameter for the repository_advisories resource. + - name: summary + value: "{{ summary }}" + description: | + A short summary of the advisory. + - name: description + value: "{{ description }}" + description: | + A detailed description of what the advisory impacts. + - name: cve_id + value: "{{ cve_id }}" + description: | + The Common Vulnerabilities and Exposures (CVE) ID. + - name: vulnerabilities + description: | + A product affected by the vulnerability detailed in a repository security advisory. + value: + - package: + ecosystem: "{{ ecosystem }}" + name: "{{ name }}" + vulnerable_version_range: "{{ vulnerable_version_range }}" + patched_versions: "{{ patched_versions }}" + vulnerable_functions: "{{ vulnerable_functions }}" + - name: cwe_ids + value: + - "{{ cwe_ids }}" + description: | + A list of Common Weakness Enumeration (CWE) IDs. + - name: credits + description: | + A list of users receiving credit for their participation in the security advisory. + value: + - login: "{{ login }}" + type: "{{ type }}" + - name: severity + value: "{{ severity }}" + description: | + The severity of the advisory. You must choose between setting this field or \`cvss_vector_string\`. + valid_values: ['critical', 'high', 'medium', 'low'] + - name: cvss_vector_string + value: "{{ cvss_vector_string }}" + description: | + The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or \`severity\`. + - name: start_private_fork + value: {{ start_private_fork }} + description: | + Whether to create a temporary private fork of the repository to collaborate on a fix. + default: false +`} + + + + + +## `UPDATE` examples + + + + +Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier.

In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository,
or a collaborator on the repository security advisory.

OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + +```sql +UPDATE github.security_advisories.repository_advisories +SET +summary = '{{ summary }}', +description = '{{ description }}', +cve_id = '{{ cve_id }}', +vulnerabilities = '{{ vulnerabilities }}', +cwe_ids = '{{ cwe_ids }}', +credits = '{{ credits }}', +severity = '{{ severity }}', +cvss_vector_string = '{{ cvss_vector_string }}', +state = '{{ state }}', +collaborating_users = '{{ collaborating_users }}', +collaborating_teams = '{{ collaborating_teams }}' +WHERE +owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +AND ghsa_id = '{{ ghsa_id }}' --required +RETURNING +cve_id, +ghsa_id, +author, +closed_at, +collaborating_teams, +collaborating_users, +created_at, +credits, +credits_detailed, +cvss, +cvss_severities, +cwe_ids, +cwes, +description, +html_url, +identifiers, +private_fork, +published_at, +publisher, +severity, +state, +submission, +summary, +updated_at, +url, +vulnerabilities, +withdrawn_at; +``` + + diff --git a/website/docs/services/security_advisories/security_advisory_forks/index.md b/website/docs/services/security_advisories/security_advisory_forks/index.md new file mode 100644 index 0000000..3c4f532 --- /dev/null +++ b/website/docs/services/security_advisories/security_advisory_forks/index.md @@ -0,0 +1,243 @@ +--- +title: security_advisory_forks +hide_title: false +hide_table_of_contents: false +keywords: + - security_advisory_forks + - security_advisories + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a security_advisory_forks resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
owner, repo, ghsa_idCreate a temporary private fork to collaborate on fixing a security vulnerability in your repository.

> [!NOTE]
> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe GHSA (GitHub Security Advisory) identifier of the advisory.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
+ +## `INSERT` examples + + + + +Create a temporary private fork to collaborate on fixing a security vulnerability in your repository.

> [!NOTE]
> Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + +```sql +INSERT INTO github.security_advisories.security_advisory_forks ( +owner, +repo, +ghsa_id +) +SELECT +'{{ owner }}', +'{{ repo }}', +'{{ ghsa_id }}' +RETURNING +id, +name, +node_id, +full_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +allow_update_branch, +anonymous_access_enabled, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merge_commit_message, +merge_commit_title, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +organization, +owner, +parent, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +source, +squash_merge_commit_message, +squash_merge_commit_title, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +template_repository, +topics, +trees_url, +updated_at, +url, +use_squash_pr_title_as_default, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +; +``` + + + +{`# Description fields are for documentation purposes +- name: security_advisory_forks + props: + - name: owner + value: "{{ owner }}" + description: Required parameter for the security_advisory_forks resource. + - name: repo + value: "{{ repo }}" + description: Required parameter for the security_advisory_forks resource. + - name: ghsa_id + value: "{{ ghsa_id }}" + description: Required parameter for the security_advisory_forks resource. +`} + + + diff --git a/website/docs/services/teams/child_teams/index.md b/website/docs/services/teams/child_teams/index.md new file mode 100644 index 0000000..21a1814 --- /dev/null +++ b/website/docs/services/teams/child_teams/index.md @@ -0,0 +1,389 @@ +--- +title: child_teams +hide_title: false +hide_table_of_contents: false +keywords: + - child_teams + - teams + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a child_teams resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +if child teams exist + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + +if child teams exist + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slugper_page, pageLists the child teams of the team specified by `{team_slug}`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.
team_idper_page, page> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the child teams of the team specified by `{team_slug}`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.teams.child_teams +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.teams.child_teams +WHERE team_id = '{{ team_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/teams/details/index.md b/website/docs/services/teams/details/index.md index f2b173c..78a558a 100644 --- a/website/docs/services/teams/details/index.md +++ b/website/docs/services/teams/details/index.md @@ -1,55 +1,262 @@ ---- +--- title: details hide_title: false hide_table_of_contents: false keywords: - details - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a details resource. ## Overview - +
Namedetails
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the team | -| | `string` | Name of the team | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | Distinguished Name (DN) that team maps to within LDAP environment | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | The notification setting the team has set | -| | `object` | Team Organization | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `string` | Permission that the team will have for its repositories | -| | `string` | The level of privacy this team should have | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | URL for the team | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the team
stringName of the team (example: Developers)
integerUnique identifier of the enterprise to which this team belongs
string (example: MDQ6VGVhbTE=)
integerUnique identifier of the organization to which this team belongs
string (date-time) (example: 2017-07-14T16:53:42Z)
string (example: A great team.)
string (uri) (example: https://github.com/orgs/rails/teams/core)
stringThe [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. (example: cn=Enterprise Ops,ou=teams,dc=github,dc=com)
integer
string (example: https://api.github.com/organizations/1/team/1/members{/member})
stringThe notification setting the team has set (notifications_enabled, notifications_disabled) (example: notifications_enabled)
objectTeam Organization (title: Team Organization)
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
stringPermission that the team will have for its repositories (example: push)
stringThe level of privacy this team should have (closed, secret) (example: closed)
integer
string (uri) (example: https://api.github.com/organizations/1/team/1/repos)
string (example: justice-league)
stringThe ownership type of the team (enterprise, organization)
string (date-time) (example: 2017-08-17T12:37:15Z)
string (uri)URL for the team (example: https://api.github.com/organizations/1/team/1)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slugGets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam NΓ€me"` would become `my-team-name`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe slug of the team name.
+ +## `SELECT` examples + + + + +Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam NΓ€me"` would become `my-team-name`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +created_at, +description, +html_url, +ldap_dn, +members_count, +members_url, +notification_setting, +organization, +parent, +permission, +privacy, +repos_count, +repositories_url, +slug, +type, +updated_at, +url +FROM github.teams.details +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +; +``` + + diff --git a/website/docs/services/teams/discussion_comments/index.md b/website/docs/services/teams/discussion_comments/index.md deleted file mode 100644 index 36baefa..0000000 --- a/website/docs/services/teams/discussion_comments/index.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: discussion_comments -hide_title: false -hide_table_of_contents: false -keywords: - - discussion_comments - - teams - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namediscussion_comments
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub user. | -| | `string` | The main text of the comment. | -| | `string` | | -| | `string` | The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | The unique sequence number of a team discussion comment. | -| | `object` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint.

Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `SELECT` | | List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint.

List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `INSERT` | | Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. | -| | `DELETE` | | Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint.

Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint.

Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `EXEC` | | Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.

Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | diff --git a/website/docs/services/teams/discussions/index.md b/website/docs/services/teams/discussions/index.md deleted file mode 100644 index f8e79b7..0000000 --- a/website/docs/services/teams/discussions/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: discussions -hide_title: false -hide_table_of_contents: false -keywords: - - discussions - - teams - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namediscussions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `object` | A GitHub user. | -| | `string` | The main text of the discussion. | -| | `string` | | -| | `string` | The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | The unique sequence number of a team discussion. | -| | `boolean` | Whether or not this discussion should be pinned for easy retrieval. | -| | `boolean` | Whether or not this discussion should be restricted to team members and organization administrators. | -| | `object` | | -| | `string` | | -| | `string` | The title of the discussion. | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint.

Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `SELECT` | | List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint.

List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `INSERT` | | Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. | -| | `DELETE` | | Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint.

Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint.

Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `EXEC` | | Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).

**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint.

Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | diff --git a/website/docs/services/teams/index.md b/website/docs/services/teams/index.md index f150d2f..f0ef630 100644 --- a/website/docs/services/teams/index.md +++ b/website/docs/services/teams/index.md @@ -9,50 +9,32 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With GitHub Teams. - -:::info Service Summary +teams service documentation. -
-
-total resources: 12
-total selectable resources: 12
-total methods: 60
-
-
+:::info[Service Summary] -::: +total resources: __9__ -## Overview - - - - - - -
Namegithub.teams
TypeService
TitleGitHub V3 REST API - Teams
DescriptionInteract With GitHub Teams.
Idteams:v24.04.00227
+::: ## Resources
+child_teams
details
-discussion_comments
-discussions
invitations
members
-membership
+membership
-project_permissions
-projects
-repo_permissions
+permissions
repos
teams
-teams_for_auth_user
-
+teams_for_auth_user
+ \ No newline at end of file diff --git a/website/docs/services/teams/invitations/index.md b/website/docs/services/teams/invitations/index.md index f7a10fb..e739292 100644 --- a/website/docs/services/teams/invitations/index.md +++ b/website/docs/services/teams/invitations/index.md @@ -1,49 +1,329 @@ ---- +--- title: invitations hide_title: false hide_table_of_contents: false keywords: - invitations - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an invitations resource. ## Overview - +
Nameinvitations
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x")
string
string
string
string
string (example: "member")
string (example: "https://api.github.com/organizations/16/invitations/1/teams")
objectA GitHub user. (title: Simple User)
string
string
integer
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x")
string
string
string
string
string (example: "member")
string (example: "https://api.github.com/organizations/16/invitations/1/teams")
objectA GitHub user. (title: Simple User)
string
string
integer
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.

The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slugper_page, pageThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.
team_idper_page, page> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.

The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + +```sql +SELECT +id, +node_id, +created_at, +email, +failed_at, +failed_reason, +invitation_source, +invitation_teams_url, +inviter, +login, +role, +team_count +FROM github.teams.invitations +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint.

The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + +```sql +SELECT +id, +node_id, +created_at, +email, +failed_at, +failed_reason, +invitation_source, +invitation_teams_url, +inviter, +login, +role, +team_count +FROM github.teams.invitations +WHERE team_id = '{{ team_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/teams/members/index.md b/website/docs/services/teams/members/index.md index a827582..2a07dbc 100644 --- a/website/docs/services/teams/members/index.md +++ b/website/docs/services/teams/members/index.md @@ -1,61 +1,559 @@ ---- +--- title: members hide_title: false hide_table_of_contents: false keywords: - members - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a members resource. ## Overview - +
Namemembers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +if user is a member + + + + + + + + + + + +
NameDatatypeDescription
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.

Team members will include the members of child teams. | -| | `DELETE` | | The "Remove team member" endpoint (described below) is deprecated.

We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." | -| | `EXEC` | | The "Add team member" endpoint (described below) is deprecated.

We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." | -| | `EXEC` | | The "Get team member" endpoint (described below) is deprecated.

We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slugrole, per_page, pageTeam members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user.
team_id, usernameThe "Get team member" endpoint (described below) is closing down.

We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user.
team_idrole, per_page, page> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.

Team members will include the members of child teams.
team_id, usernameThe "Add team member" endpoint (described below) is closing down.

We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
team_id, usernameThe "Remove team member" endpoint (described below) is closing down.

We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFilters members returned by their role in the team.
+ +## `SELECT` examples + + + + +Team members will include the members of child teams.

To list members in a team, the team must be visible to the authenticated user. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.teams.members +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND role = '{{ role }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +The "Get team member" endpoint (described below) is closing down.

We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.

To list members in a team, the team must be visible to the authenticated user. + +```sql +SELECT +* +FROM github.teams.members +WHERE team_id = '{{ team_id }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint.

Team members will include the members of child teams. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.teams.members +WHERE team_id = '{{ team_id }}' -- required +AND role = '{{ role }}' +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `REPLACE` examples + + + + +The "Add team member" endpoint (described below) is closing down.

We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + +```sql +REPLACE github.teams.members +SET +-- No updatable properties +WHERE +team_id = '{{ team_id }}' --required +AND username = '{{ username }}' --required; +``` + + + + +## `DELETE` examples + + + + +The "Remove team member" endpoint (described below) is closing down.

We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + +```sql +DELETE FROM github.teams.members +WHERE team_id = '{{ team_id }}' --required +AND username = '{{ username }}' --required +; +``` + + diff --git a/website/docs/services/teams/membership/index.md b/website/docs/services/teams/membership/index.md index 4d16e9c..a9fdccd 100644 --- a/website/docs/services/teams/membership/index.md +++ b/website/docs/services/teams/membership/index.md @@ -1,44 +1,324 @@ ---- +--- title: membership hide_title: false hide_table_of_contents: false keywords: - membership - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a membership resource. ## Overview - +
Namemembership
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `string` | The role of the user in the team. | -| | `string` | The state of the user's membership in the team. | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe role of the user in the team. (member, maintainer) (default: member, example: member)
stringThe state of the user's membership in the team. (active, pending)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe role of the user in the team. (member, maintainer) (default: member, example: member)
stringThe state of the user's membership in the team. (active, pending)
string (uri)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.

**Note:**
The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

**Note:**
The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). | -| | `DELETE` | | To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. | -| | `EXEC` | | Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slug, usernameTeam members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.

> [!NOTE]
> The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
team_id, username> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

**Note:**
The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).
org, team_slug, usernameAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.
team_id, username> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
org, team_slug, usernameTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.
team_id, username> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
stringThe handle for the GitHub user account.
+ +## `SELECT` examples + + + + +Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.

> [!NOTE]
> The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + +```sql +SELECT +role, +state, +url +FROM github.teams.membership +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint.

Team members will include the members of child teams.

To get a user's membership with a team, the team must be visible to the authenticated user.

**Note:**
The response contains the `state` of the membership and the member's `role`.

The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + +```sql +SELECT +role, +state, +url +FROM github.teams.membership +WHERE team_id = '{{ team_id }}' -- required +AND username = '{{ username }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + +```sql +REPLACE github.teams.membership +SET +role = '{{ role }}' +WHERE +org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +AND username = '{{ username }}' --required +RETURNING +role, +state, +url; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. + +```sql +REPLACE github.teams.membership +SET +role = '{{ role }}' +WHERE +team_id = '{{ team_id }}' --required +AND username = '{{ username }}' --required +RETURNING +role, +state, +url; +``` + + + + +## `DELETE` examples + + + + +To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + +```sql +DELETE FROM github.teams.membership +WHERE org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +AND username = '{{ username }}' --required +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

> [!NOTE]
> When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + +```sql +DELETE FROM github.teams.membership +WHERE team_id = '{{ team_id }}' --required +AND username = '{{ username }}' --required +; +``` + + diff --git a/website/docs/services/teams/permissions/index.md b/website/docs/services/teams/permissions/index.md new file mode 100644 index 0000000..f883323 --- /dev/null +++ b/website/docs/services/teams/permissions/index.md @@ -0,0 +1,1308 @@ +--- +title: permissions +hide_title: false +hide_table_of_contents: false +keywords: + - permissions + - teams + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists a permissions resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Alternative response with repository permissions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the repository
stringThe name of the repository. (example: Team Environment)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
booleanWhether to allow Auto-merge to be used on pull requests.
booleanWhether to allow forking this repo
booleanWhether to allow merge commits for pull requests.
booleanWhether to allow rebase merges for pull requests.
booleanWhether to allow squash merges for pull requests.
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
booleanWhether the repository is archived.
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string (example: https://github.com/octocat/Hello-World.git)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
stringThe default branch of the repository. (example: master)
booleanWhether to delete head branches when pull requests are merged
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
booleanReturns whether or not this repository disabled.
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string (example: git:github.com/octocat/Hello-World.git)
booleanWhether downloads are enabled.
booleanWhether issues are enabled.
boolean
booleanWhether projects are enabled.
booleanWhether the wiki is enabled.
string (uri) (example: https://github.com)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
booleanWhether this repository acts as a template that can be used to generate new repositories.
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
objectLicense Simple (title: License Simple)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string (uri) (example: git:git.example.com/octocat/Hello-World)
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
booleanWhether the repository is private or public.
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
integer
string (example: git@github.com:octocat/Hello-World.git)
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string (uri) (example: https://svn.github.com/octocat/Hello-World)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
stringThe repository visibility: public, private, or internal. (default: public)
integer
integer
booleanWhether to require contributors to sign off on web-based commits
+ + + +Alternative response with extra repository information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the repository
stringThe name of the repository. (example: Team Environment)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
booleanWhether to allow Auto-merge to be used on pull requests.
booleanWhether to allow forking this repo
booleanWhether to allow merge commits for pull requests.
booleanWhether to allow rebase merges for pull requests.
booleanWhether to allow squash merges for pull requests.
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
booleanWhether the repository is archived.
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string (example: https://github.com/octocat/Hello-World.git)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
stringThe default branch of the repository. (example: master)
booleanWhether to delete head branches when pull requests are merged
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
booleanReturns whether or not this repository disabled.
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string (example: git:github.com/octocat/Hello-World.git)
booleanWhether downloads are enabled.
booleanWhether issues are enabled.
boolean
booleanWhether projects are enabled.
booleanWhether the wiki is enabled.
string (uri) (example: https://github.com)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
booleanWhether this repository acts as a template that can be used to generate new repositories.
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
objectLicense Simple (title: License Simple)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string (uri) (example: git:git.example.com/octocat/Hello-World)
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
booleanWhether the repository is private or public.
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
integer
string (example: git@github.com:octocat/Hello-World.git)
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string (uri) (example: https://svn.github.com/octocat/Hello-World)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
stringThe repository visibility: public, private, or internal. (default: public)
integer
integer
booleanWhether to require contributors to sign off on web-based commits
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slug, owner, repoChecks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.

If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.

If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
team_id, owner, repo> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.

> [!NOTE]
> Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header:
org, team_slug, owner, repoTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.

For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
team_id, owner, repo> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
+ +## `SELECT` examples + + + + +Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `application/vnd.github.v3.repository+json` accept header.

If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.

If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_downloads, +has_issues, +has_pages, +has_projects, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pulls_url, +pushed_at, +releases_url, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.teams.permissions +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.

> [!NOTE]
> Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_auto_merge, +allow_forking, +allow_merge_commit, +allow_rebase_merge, +allow_squash_merge, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_downloads, +has_issues, +has_pages, +has_projects, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +master_branch, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pulls_url, +pushed_at, +releases_url, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.teams.permissions +WHERE team_id = '{{ team_id }}' -- required +AND owner = '{{ owner }}' -- required +AND repo = '{{ repo }}' -- required +; +``` + + + + +## `REPLACE` examples + + + + +To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.

For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". + +```sql +REPLACE github.teams.permissions +SET +permission = '{{ permission }}' +WHERE +org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +AND owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + +```sql +REPLACE github.teams.permissions +SET +permission = '{{ permission }}' +WHERE +team_id = '{{ team_id }}' --required +AND owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required; +``` + + diff --git a/website/docs/services/teams/project_permissions/index.md b/website/docs/services/teams/project_permissions/index.md deleted file mode 100644 index 4aef697..0000000 --- a/website/docs/services/teams/project_permissions/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: project_permissions -hide_title: false -hide_table_of_contents: false -keywords: - - project_permissions - - teams - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameproject_permissions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | The organization permission for this project. Only present when owner is an organization. | -| | `string` | | -| | `object` | | -| | `boolean` | Whether the project is private or not. Only present when owner is an organization. | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint.

Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. | -| | `EXEC` | | Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint.

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. | diff --git a/website/docs/services/teams/projects/index.md b/website/docs/services/teams/projects/index.md deleted file mode 100644 index 0f2fbe1..0000000 --- a/website/docs/services/teams/projects/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: projects -hide_title: false -hide_table_of_contents: false -keywords: - - projects - - teams - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Nameprojects
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A GitHub user. | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | The organization permission for this project. Only present when owner is an organization. | -| | `string` | | -| | `object` | | -| | `boolean` | Whether the project is private or not. Only present when owner is an organization. | -| | `string` | | -| | `string` | | -| | `string` | | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the organization projects for a team.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint.

Lists the organization projects for a team. | -| | `DELETE` | | Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint.

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. | diff --git a/website/docs/services/teams/repo_permissions/index.md b/website/docs/services/teams/repo_permissions/index.md deleted file mode 100644 index 6c06d30..0000000 --- a/website/docs/services/teams/repo_permissions/index.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: repo_permissions -hide_title: false -hide_table_of_contents: false -keywords: - - repo_permissions - - teams - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namerepo_permissions
TypeResource
Id
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the repository | -| | `string` | The name of the repository. | -| | `string` | | -| | `boolean` | Whether to allow Auto-merge to be used on pull requests. | -| | `boolean` | Whether to allow forking this repo | -| | `boolean` | Whether to allow merge commits for pull requests. | -| | `boolean` | Whether to allow rebase merges for pull requests. | -| | `boolean` | Whether to allow squash merges for pull requests. | -| | `string` | | -| | `boolean` | Whether the repository is archived. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | The default branch of the repository. | -| | `boolean` | Whether to delete head branches when pull requests are merged | -| | `string` | | -| | `boolean` | Returns whether or not this repository disabled. | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether downloads are enabled. | -| | `boolean` | Whether issues are enabled. | -| | `boolean` | | -| | `boolean` | Whether projects are enabled. | -| | `boolean` | Whether the wiki is enabled. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | Whether this repository acts as a template that can be used to generate new repositories. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | License Simple | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | Whether the repository is private or public. | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | A repository on GitHub. | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | The repository visibility: public, private, or internal. | -| | `integer` | | -| | `integer` | | -| | `boolean` | Whether to require contributors to sign off on web-based commits | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.

If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. | -| | `SELECT` | | **Note**: Repositories inherited through a parent team will also be checked.

**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint.

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: | -| | `EXEC` | | To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."

**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.

For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.

Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." | diff --git a/website/docs/services/teams/repos/index.md b/website/docs/services/teams/repos/index.md index 1b12d3f..013fbad 100644 --- a/website/docs/services/teams/repos/index.md +++ b/website/docs/services/teams/repos/index.md @@ -1,126 +1,1326 @@ ---- +--- title: repos hide_title: false hide_table_of_contents: false keywords: - repos - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a repos resource. ## Overview - +
Namerepos
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Code Of Conduct | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `integer` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `object` | A GitHub user. | -| | `object` | | -| | `boolean` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | | -| | `integer` | The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `array` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `integer` | | -| | `integer` | | -| | `boolean` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Hello-World)
string (example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
string (example: octocat/Hello-World)
string (example: admin)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
string (example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
string
objectCode Of Conduct (title: Code Of Conduct)
string (example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
string (example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
string (example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/contributors)
string (date-time) (example: 2011-01-26T19:01:12Z)
objectThe custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.
string
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/deployments)
string (example: This your first repo!)
boolean
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/downloads)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/events)
boolean
integer
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/forks)
string (example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
string (example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
string
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/hooks)
string (uri) (example: https://github.com/octocat/Hello-World)
boolean
string (example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
string (example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
string (example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/languages)
object
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/merges)
string (example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
string
integer
string (example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
integer
integer
objectA GitHub user. (title: Simple User)
object
boolean
stringThe policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only)
string (example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
string (date-time) (example: 2011-01-26T19:06:43Z)
string (example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
object
integerThe size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
string
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/stargazers)
string (example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
integer
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscribers)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/subscription)
string
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/tags)
string (uri) (example: http://api.github.com/repos/octocat/Hello-World/teams)
string
array
string (example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
string (date-time) (example: 2011-01-26T19:14:43Z)
string (uri) (example: https://api.github.com/repos/octocat/Hello-World)
string
integer
integer
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists a team's repositories visible to the authenticated user.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. | -| | `DELETE` | | If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
org, team_slugper_page, pageLists a team's repositories visible to the authenticated user.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.
team_idper_page, page> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.
org, team_slug, owner, repoIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
team_id, owner, repo> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
stringThe account owner of the repository. The name is not case sensitive.
stringThe name of the repository without the `.git` extension. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists a team's repositories visible to the authenticated user.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.teams.repos +WHERE org = '{{ org }}' -- required +AND team_slug = '{{ team_slug }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + +```sql +SELECT +id, +name, +node_id, +full_name, +role_name, +allow_forking, +archive_url, +archived, +assignees_url, +blobs_url, +branches_url, +clone_url, +code_of_conduct, +collaborators_url, +comments_url, +commits_url, +compare_url, +contents_url, +contributors_url, +created_at, +custom_properties, +default_branch, +delete_branch_on_merge, +deployments_url, +description, +disabled, +downloads_url, +events_url, +fork, +forks, +forks_count, +forks_url, +git_commits_url, +git_refs_url, +git_tags_url, +git_url, +has_discussions, +has_downloads, +has_issues, +has_pages, +has_projects, +has_pull_requests, +has_wiki, +homepage, +hooks_url, +html_url, +is_template, +issue_comment_url, +issue_events_url, +issues_url, +keys_url, +labels_url, +language, +languages_url, +license, +merges_url, +milestones_url, +mirror_url, +network_count, +notifications_url, +open_issues, +open_issues_count, +owner, +permissions, +private, +pull_request_creation_policy, +pulls_url, +pushed_at, +releases_url, +security_and_analysis, +size, +ssh_url, +stargazers_count, +stargazers_url, +statuses_url, +subscribers_count, +subscribers_url, +subscription_url, +svn_url, +tags_url, +teams_url, +temp_clone_token, +topics, +trees_url, +updated_at, +url, +visibility, +watchers, +watchers_count, +web_commit_signoff_required +FROM github.teams.repos +WHERE team_id = '{{ team_id }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `DELETE` examples + + + + +If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + +```sql +DELETE FROM github.teams.repos +WHERE org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +AND owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint.

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + +```sql +DELETE FROM github.teams.repos +WHERE team_id = '{{ team_id }}' --required +AND owner = '{{ owner }}' --required +AND repo = '{{ repo }}' --required +; +``` + + diff --git a/website/docs/services/teams/teams/index.md b/website/docs/services/teams/teams/index.md index 204e4b4..e377571 100644 --- a/website/docs/services/teams/teams/index.md +++ b/website/docs/services/teams/teams/index.md @@ -1,58 +1,707 @@ ---- +--- title: teams hide_title: false hide_table_of_contents: false keywords: - teams - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a teams resource. ## Overview - +
Nameteams
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `string` | | -| | `object` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string
integerUnique identifier of the enterprise to which this team belongs
string
integerUnique identifier of the organization to which this team belongs
string
string (uri) (example: https://github.com/orgs/rails/teams/core)
string
string
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
string
object
string
string (uri)
string
stringThe ownership type of the team (enterprise, organization)
string (uri)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the team
stringName of the team (example: Developers)
integerUnique identifier of the enterprise to which this team belongs
string (example: MDQ6VGVhbTE=)
integerUnique identifier of the organization to which this team belongs
string (date-time) (example: 2017-07-14T16:53:42Z)
string (example: A great team.)
string (uri) (example: https://github.com/orgs/rails/teams/core)
stringThe [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. (example: cn=Enterprise Ops,ou=teams,dc=github,dc=com)
integer
string (example: https://api.github.com/organizations/1/team/1/members{/member})
stringThe notification setting the team has set (notifications_enabled, notifications_disabled) (example: notifications_enabled)
objectTeam Organization (title: Team Organization)
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
stringPermission that the team will have for its repositories (example: push)
stringThe level of privacy this team should have (closed, secret) (example: closed)
integer
string (uri) (example: https://api.github.com/organizations/1/team/1/repos)
string (example: justice-league)
stringThe ownership type of the team (enterprise, organization)
string (date-time) (example: 2017-08-17T12:37:15Z)
string (uri)URL for the team (example: https://api.github.com/organizations/1/team/1)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all teams in an organization that are visible to the authenticated user. | -| | `SELECT` | | Lists the child teams of the team specified by `{team_slug}`.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. | -| | `SELECT` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. | -| | `INSERT` | | To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". | -| | `DELETE` | | To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. | -| | `EXEC` | | To edit a team, the authenticated user must either be an organization owner or a team maintainer.

**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. | -| | `EXEC` | | **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
orgper_page, page, team_typeLists all teams in an organization that are visible to the authenticated user.
team_id> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint.
org, nameTo create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
org, team_slugTo edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.
team_id, name> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> With nested teams, the `privacy` for parent teams cannot be `secret`.
org, team_slugTo delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.
team_id> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe organization name. The name is not case sensitive.
integerThe unique identifier of the team.
stringThe slug of the team name.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringFilter team results by their type. For more information, see "[What kind of team should I use?](https://docs.github.com/enterprise-cloud@latest/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise#what-kind-of-team-should-i-use)"
+ +## `SELECT` examples + + + + +Lists all teams in an organization that are visible to the authenticated user. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +description, +html_url, +members_url, +notification_setting, +parent, +permission, +permissions, +privacy, +repositories_url, +slug, +type, +url +FROM github.teams.teams +WHERE org = '{{ org }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +AND team_type = '{{ team_type }}' +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +created_at, +description, +html_url, +ldap_dn, +members_count, +members_url, +notification_setting, +organization, +parent, +permission, +privacy, +repos_count, +repositories_url, +slug, +type, +updated_at, +url +FROM github.teams.teams +WHERE team_id = '{{ team_id }}' -- required +; +``` + + + + +## `INSERT` examples + + + + +To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". + +```sql +INSERT INTO github.teams.teams ( +name, +description, +maintainers, +repo_names, +privacy, +notification_setting, +permission, +parent_team_id, +org +) +SELECT +'{{ name }}' /* required */, +'{{ description }}', +'{{ maintainers }}', +'{{ repo_names }}', +'{{ privacy }}', +'{{ notification_setting }}', +'{{ permission }}', +{{ parent_team_id }}, +'{{ org }}' +RETURNING +id, +name, +enterprise_id, +node_id, +organization_id, +created_at, +description, +html_url, +ldap_dn, +members_count, +members_url, +notification_setting, +organization, +parent, +permission, +privacy, +repos_count, +repositories_url, +slug, +type, +updated_at, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: teams + props: + - name: org + value: "{{ org }}" + description: Required parameter for the teams resource. + - name: name + value: "{{ name }}" + description: | + The name of the team. + - name: description + value: "{{ description }}" + description: | + The description of the team. + - name: maintainers + value: + - "{{ maintainers }}" + description: | + List GitHub usernames for organization members who will become team maintainers. + - name: repo_names + value: + - "{{ repo_names }}" + description: | + The full name (e.g., "organization-name/repository-name") of repositories to add the team to. + - name: privacy + value: "{{ privacy }}" + description: | + The level of privacy this team should have. The options are: + **For a non-nested team:** + * \`secret\` - only visible to organization owners and members of this team. + * \`closed\` - visible to all members of this organization. + Default: \`secret\` + **For a parent or child team:** + * \`closed\` - visible to all members of this organization. + Default for child team: \`closed\` + valid_values: ['secret', 'closed'] + - name: notification_setting + value: "{{ notification_setting }}" + description: | + The notification setting the team has chosen. The options are: + * \`notifications_enabled\` - team members receive notifications when the team is @mentioned. + * \`notifications_disabled\` - no one receives notifications. + Default: \`notifications_enabled\` + valid_values: ['notifications_enabled', 'notifications_disabled'] + - name: permission + value: "{{ permission }}" + description: | + **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + valid_values: ['pull', 'push'] + default: pull + - name: parent_team_id + value: {{ parent_team_id }} + description: | + The ID of a team to set as the parent team. +`} + + + + + +## `UPDATE` examples + + + + +To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + +```sql +UPDATE github.teams.teams +SET +name = '{{ name }}', +description = '{{ description }}', +privacy = '{{ privacy }}', +notification_setting = '{{ notification_setting }}', +permission = '{{ permission }}', +parent_team_id = {{ parent_team_id }} +WHERE +org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +RETURNING +id, +name, +enterprise_id, +node_id, +organization_id, +created_at, +description, +html_url, +ldap_dn, +members_count, +members_url, +notification_setting, +organization, +parent, +permission, +privacy, +repos_count, +repositories_url, +slug, +type, +updated_at, +url; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint.

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

> [!NOTE]
> With nested teams, the `privacy` for parent teams cannot be `secret`. + +```sql +UPDATE github.teams.teams +SET +name = '{{ name }}', +description = '{{ description }}', +privacy = '{{ privacy }}', +notification_setting = '{{ notification_setting }}', +permission = '{{ permission }}', +parent_team_id = {{ parent_team_id }} +WHERE +team_id = '{{ team_id }}' --required +AND name = '{{ name }}' --required +RETURNING +id, +name, +enterprise_id, +node_id, +organization_id, +created_at, +description, +html_url, +ldap_dn, +members_count, +members_url, +notification_setting, +organization, +parent, +permission, +privacy, +repos_count, +repositories_url, +slug, +type, +updated_at, +url; +``` + + + + +## `DELETE` examples + + + + +To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

> [!NOTE]
> You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + +```sql +DELETE FROM github.teams.teams +WHERE org = '{{ org }}' --required +AND team_slug = '{{ team_slug }}' --required +; +``` + + + +> [!WARNING]
> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint.

To delete a team, the authenticated user must be an organization owner or team maintainer.

If you are an organization owner, deleting a parent team will delete all of its child teams as well. + +```sql +DELETE FROM github.teams.teams +WHERE team_id = '{{ team_id }}' --required +; +``` + + diff --git a/website/docs/services/teams/teams_for_auth_user/index.md b/website/docs/services/teams/teams_for_auth_user/index.md index c6c4971..00cbe4a 100644 --- a/website/docs/services/teams/teams_for_auth_user/index.md +++ b/website/docs/services/teams/teams_for_auth_user/index.md @@ -1,55 +1,262 @@ ---- +--- title: teams_for_auth_user hide_title: false hide_table_of_contents: false keywords: - teams_for_auth_user - teams - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a teams_for_auth_user resource. ## Overview - +
Nameteams_for_auth_user
Name
TypeResource
Id
## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| | `integer` | Unique identifier of the team | -| | `string` | Name of the team | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | Distinguished Name (DN) that team maps to within LDAP environment | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | The notification setting the team has set | -| | `object` | Team Organization | -| | `object` | Groups of organization members that gives permissions on specified repositories. | -| | `string` | Permission that the team will have for its repositories | -| | `string` | The level of privacy this team should have | -| | `integer` | | -| | `string` | | -| | `string` | | -| | `string` | | -| | `string` | URL for the team | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerUnique identifier of the team
stringName of the team (example: Developers)
integerUnique identifier of the enterprise to which this team belongs
string (example: MDQ6VGVhbTE=)
integerUnique identifier of the organization to which this team belongs
string (date-time) (example: 2017-07-14T16:53:42Z)
string (example: A great team.)
string (uri) (example: https://github.com/orgs/rails/teams/core)
stringThe [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. (example: cn=Enterprise Ops,ou=teams,dc=github,dc=com)
integer
string (example: https://api.github.com/organizations/1/team/1/members{/member})
stringThe notification setting the team has set (notifications_enabled, notifications_disabled) (example: notifications_enabled)
objectTeam Organization (title: Team Organization)
objectGroups of organization members that gives permissions on specified repositories. (title: Team Simple)
stringPermission that the team will have for its repositories (example: push)
stringThe level of privacy this team should have (closed, secret) (example: closed)
integer
string (uri) (example: https://api.github.com/organizations/1/team/1/repos)
string (example: justice-league)
stringThe ownership type of the team (enterprise, organization)
string (date-time) (example: 2017-08-17T12:37:15Z)
string (uri)URL for the team (example: https://api.github.com/organizations/1/team/1)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageList all of the teams across all of the organizations to which the authenticated
user belongs.

OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.

When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List all of the teams across all of the organizations to which the authenticated
user belongs.

OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint.

When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + +```sql +SELECT +id, +name, +enterprise_id, +node_id, +organization_id, +created_at, +description, +html_url, +ldap_dn, +members_count, +members_url, +notification_setting, +organization, +parent, +permission, +privacy, +repos_count, +repositories_url, +slug, +type, +updated_at, +url +FROM github.teams.teams_for_auth_user +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/users/attestations/index.md b/website/docs/services/users/attestations/index.md new file mode 100644 index 0000000..63e2a10 --- /dev/null +++ b/website/docs/services/users/attestations/index.md @@ -0,0 +1,231 @@ +--- +title: attestations +hide_title: false +hide_table_of_contents: false +keywords: + - attestations + - users + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an attestations resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
objectThe attestation's Sigstore Bundle. Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.
string
string
+ + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
username, subject_digestper_page, before, after, predicate_typeList a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
username, subject_digestDelete an artifact attestation by subject digest.
username, attestation_idDelete an artifact attestation by unique ID that is associated with a repository owned by a user.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerAttestation ID
stringSubject Digest
stringThe handle for the GitHub user account.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringOptional filter for fetching attestations with a given predicate type. This option accepts `provenance`, `sbom`, `release`, or freeform text for custom predicate types.
+ +## `SELECT` examples + + + + +List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + +```sql +SELECT +repository_id, +bundle, +bundle_url, +initiator +FROM github.users.attestations +WHERE username = '{{ username }}' -- required +AND subject_digest = '{{ subject_digest }}' -- required +AND per_page = '{{ per_page }}' +AND before = '{{ before }}' +AND after = '{{ after }}' +AND predicate_type = '{{ predicate_type }}' +; +``` + + + + +## `DELETE` examples + + + + +Delete an artifact attestation by subject digest. + +```sql +DELETE FROM github.users.attestations +WHERE username = '{{ username }}' --required +AND subject_digest = '{{ subject_digest }}' --required +; +``` + + + +Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + +```sql +DELETE FROM github.users.attestations +WHERE username = '{{ username }}' --required +AND attestation_id = '{{ attestation_id }}' --required +; +``` + + diff --git a/website/docs/services/users/attestations_bulk_deletes/index.md b/website/docs/services/users/attestations_bulk_deletes/index.md new file mode 100644 index 0000000..d8ea8a7 --- /dev/null +++ b/website/docs/services/users/attestations_bulk_deletes/index.md @@ -0,0 +1,107 @@ +--- +title: attestations_bulk_deletes +hide_title: false +hide_table_of_contents: false +keywords: + - attestations_bulk_deletes + - users + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an attestations_bulk_deletes resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
username, subject_digests, attestation_idsDelete artifact attestations in bulk by either subject digests or unique ID.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
+ +## Lifecycle Methods + + + + +Delete artifact attestations in bulk by either subject digests or unique ID. + +```sql +EXEC github.users.attestations_bulk_deletes.delete_attestations_bulk +@username='{{ username }}' --required +@@json= +'{ +"subject_digests": "{{ subject_digests }}", +"attestation_ids": "{{ attestation_ids }}" +}' +; +``` + + diff --git a/website/docs/services/users/attestations_bulk_list/index.md b/website/docs/services/users/attestations_bulk_list/index.md new file mode 100644 index 0000000..7b34041 --- /dev/null +++ b/website/docs/services/users/attestations_bulk_list/index.md @@ -0,0 +1,168 @@ +--- +title: attestations_bulk_list +hide_title: false +hide_table_of_contents: false +keywords: + - attestations_bulk_list + - users + - github + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage github resources using SQL +custom_edit_url: null +image: /img/stackql-github-provider-featured-image.png +--- + +import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Creates, updates, deletes, gets or lists an attestations_bulk_list resource. + +## Overview + + + + +
Name
TypeResource
Id
+ +## Fields + +The following fields are returned by `SELECT` queries: + +`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource. + + +## Methods + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
username, subject_digestsper_page, before, afterList a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
stringA cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `INSERT` examples + + + + +List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required.

**Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + +```sql +INSERT INTO github.users.attestations_bulk_list ( +subject_digests, +predicate_type, +username, +per_page, +before, +after +) +SELECT +'{{ subject_digests }}' /* required */, +'{{ predicate_type }}', +'{{ username }}', +'{{ per_page }}', +'{{ before }}', +'{{ after }}' +RETURNING +attestations_subject_digests, +page_info +; +``` + + + +{`# Description fields are for documentation purposes +- name: attestations_bulk_list + props: + - name: username + value: "{{ username }}" + description: Required parameter for the attestations_bulk_list resource. + - name: subject_digests + value: + - "{{ subject_digests }}" + description: | + List of subject digests to fetch attestations for. + - name: predicate_type + value: "{{ predicate_type }}" + description: | + Optional filter for fetching attestations with a given predicate type. + This option accepts \`provenance\`, \`sbom\`, \`release\`, or freeform text + for custom predicate types. + - name: per_page + value: {{ per_page }} + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + - name: before + value: "{{ before }}" + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + - name: after + value: "{{ after }}" + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." +`} + + + diff --git a/website/docs/services/users/blocking/index.md b/website/docs/services/users/blocking/index.md index 811036c..09b6dfc 100644 --- a/website/docs/services/users/blocking/index.md +++ b/website/docs/services/users/blocking/index.md @@ -1,60 +1,331 @@ ---- +--- title: blocking hide_title: false hide_table_of_contents: false keywords: - blocking - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a blocking resource. ## Overview - +
Nameblocking
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | List the users you've blocked on your personal account. | -| | `EXEC` | | Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. | -| | `EXEC` | | Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. | -| | `EXEC` | | Unblocks the given user and returns a 204. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageList the users you've blocked on your personal account.
usernameReturns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.
usernameBlocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.
usernameUnblocks the given user and returns a 204.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +List the users you've blocked on your personal account. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.users.blocking +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## Lifecycle Methods + + + + +Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. + +```sql +EXEC github.users.blocking.check_blocked +@username='{{ username }}' --required +; +``` + + + +Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. + +```sql +EXEC github.users.blocking.block +@username='{{ username }}' --required +; +``` + + + +Unblocks the given user and returns a 204. + +```sql +EXEC github.users.blocking.unblock +@username='{{ username }}' --required +; +``` + + diff --git a/website/docs/services/users/emails/index.md b/website/docs/services/users/emails/index.md index 63646b5..85fab8c 100644 --- a/website/docs/services/users/emails/index.md +++ b/website/docs/services/users/emails/index.md @@ -1,43 +1,266 @@ ---- +--- title: emails hide_title: false hide_table_of_contents: false keywords: - emails - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists an emails resource. ## Overview - +
Nameemails
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `boolean` | -| | `boolean` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email) (example: octocat@github.com)
boolean
boolean
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. | -| | `INSERT` | | This endpoint is accessible with the `user` scope. | -| | `DELETE` | | This endpoint is accessible with the `user` scope. | -| | `EXEC` | | Sets the visibility for your primary email addresses. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists all of your email addresses, and specifies which one is visible
to the public.

OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
emailsOAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
visibilitySets the visibility for your primary email addresses.
OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists all of your email addresses, and specifies which one is visible
to the public.

OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + +```sql +SELECT +email, +primary, +verified, +visibility +FROM github.users.emails +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + +```sql +INSERT INTO github.users.emails ( +emails +) +SELECT +'{{ emails }}' /* required */ +RETURNING +email, +primary, +verified, +visibility +; +``` + + + +{`# Description fields are for documentation purposes +- name: emails + props: + - name: emails + value: + - "{{ emails }}" + description: | + Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an \`array\` of emails addresses directly, but we recommend that you pass an object using the \`emails\` key. +`} + + + + + +## `UPDATE` examples + + + + +Sets the visibility for your primary email addresses. + +```sql +UPDATE github.users.emails +SET +visibility = '{{ visibility }}' +WHERE +visibility = '{{ visibility }}' --required +RETURNING +email, +primary, +verified, +visibility; +``` + + + + +## `DELETE` examples + + + + +OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + +```sql +DELETE FROM github.users.emails +; +``` + + diff --git a/website/docs/services/users/followers/index.md b/website/docs/services/users/followers/index.md index 8948e98..bf9a05f 100644 --- a/website/docs/services/users/followers/index.md +++ b/website/docs/services/users/followers/index.md @@ -1,58 +1,437 @@ ---- +--- title: followers hide_title: false hide_table_of_contents: false keywords: - followers - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a followers resource. ## Overview - +
Namefollowers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the people following the authenticated user. | -| | `SELECT` | | Lists the people following the specified user. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameper_page, pageLists the people following the specified user.
per_page, pageLists the people following the authenticated user.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the people following the specified user. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.users.followers +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the people following the authenticated user. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.users.followers +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/users/following/index.md b/website/docs/services/users/following/index.md index 9408f46..85288c3 100644 --- a/website/docs/services/users/following/index.md +++ b/website/docs/services/users/following/index.md @@ -1,62 +1,525 @@ ---- +--- title: following hide_title: false hide_table_of_contents: false keywords: - following - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a following resource. ## Overview - +
Namefollowing
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists the people who the authenticated user follows. | -| | `SELECT` | | Lists the people who the specified user follows. | -| | `EXEC` | | | -| | `EXEC` | | | -| | `EXEC` | | Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."

Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. | -| | `EXEC` | | Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameper_page, pageLists the people who the specified user follows.
per_page, pageLists the people who the authenticated user follows.
username
usernameNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
usernameOAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint.
username, target_user
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists the people who the specified user follows. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.users.following +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the people who the authenticated user follows. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.users.following +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## Lifecycle Methods + + + + +if the person is followed by the authenticated user + +```sql +EXEC github.users.following.check_person_is_followed_by_authenticated +@username='{{ username }}' --required +; +``` + + + +Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."

OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + +```sql +EXEC github.users.following.follow +@username='{{ username }}' --required +; +``` + + + +OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + +```sql +EXEC github.users.following.unfollow +@username='{{ username }}' --required +; +``` + + + +if the user follows the target user + +```sql +EXEC github.users.following.check_following_for_user +@username='{{ username }}' --required, +@target_user='{{ target_user }}' --required +; +``` + + diff --git a/website/docs/services/users/gpg_keys/index.md b/website/docs/services/users/gpg_keys/index.md index 1c04f2b..103a2fd 100644 --- a/website/docs/services/users/gpg_keys/index.md +++ b/website/docs/services/users/gpg_keys/index.md @@ -1,55 +1,578 @@ ---- +--- title: gpg_keys hide_title: false hide_table_of_contents: false keywords: - gpg_keys - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a gpg_keys resource. ## Overview - +
Namegpg_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `boolean` | -| | `boolean` | -| | `boolean` | -| | `boolean` | -| | `string` | -| | `array` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `boolean` | -| | `array` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Octocat's GPG Key)
string (example: 3262EFF25BA0D270)
integer
boolean
boolean
boolean
boolean
string (date-time) (example: 2016-03-24T11:31:04-06:00)
array
string (date-time)
string (example: xsBNBFayYZ...)
string
boolean
array
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Octocat's GPG Key)
string (example: 3262EFF25BA0D270)
integer
boolean
boolean
boolean
boolean
string (date-time) (example: 2016-03-24T11:31:04-06:00)
array
string (date-time)
string (example: xsBNBFayYZ...)
string
boolean
array
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: Octocat's GPG Key)
string (example: 3262EFF25BA0D270)
integer
boolean
boolean
boolean
boolean
string (date-time) (example: 2016-03-24T11:31:04-06:00)
array
string (date-time)
string (example: xsBNBFayYZ...)
string
boolean
array
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `SELECT` | | Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `SELECT` | | Lists the GPG keys for a user. This information is accessible by anyone. | -| | `INSERT` | | Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `DELETE` | | Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
gpg_key_idView extended details for a single GPG key.

OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
usernameper_page, pageLists the GPG keys for a user. This information is accessible by anyone.
per_page, pageLists the current user's GPG keys.

OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.
armored_public_keyAdds a GPG key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.
gpg_key_idRemoves a GPG key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the GPG key.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +View extended details for a single GPG key.

OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + +```sql +SELECT +id, +name, +key_id, +primary_key_id, +can_certify, +can_encrypt_comms, +can_encrypt_storage, +can_sign, +created_at, +emails, +expires_at, +public_key, +raw_key, +revoked, +subkeys +FROM github.users.gpg_keys +WHERE gpg_key_id = '{{ gpg_key_id }}' -- required +; +``` + + + +Lists the GPG keys for a user. This information is accessible by anyone. + +```sql +SELECT +id, +name, +key_id, +primary_key_id, +can_certify, +can_encrypt_comms, +can_encrypt_storage, +can_sign, +created_at, +emails, +expires_at, +public_key, +raw_key, +revoked, +subkeys +FROM github.users.gpg_keys +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the current user's GPG keys.

OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + +```sql +SELECT +id, +name, +key_id, +primary_key_id, +can_certify, +can_encrypt_comms, +can_encrypt_storage, +can_sign, +created_at, +emails, +expires_at, +public_key, +raw_key, +revoked, +subkeys +FROM github.users.gpg_keys +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds a GPG key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + +```sql +INSERT INTO github.users.gpg_keys ( +name, +armored_public_key +) +SELECT +'{{ name }}', +'{{ armored_public_key }}' /* required */ +RETURNING +id, +name, +key_id, +primary_key_id, +can_certify, +can_encrypt_comms, +can_encrypt_storage, +can_sign, +created_at, +emails, +expires_at, +public_key, +raw_key, +revoked, +subkeys +; +``` + + + +{`# Description fields are for documentation purposes +- name: gpg_keys + props: + - name: name + value: "{{ name }}" + description: | + A descriptive name for the new key. + - name: armored_public_key + value: "{{ armored_public_key }}" + description: | + A GPG key in ASCII-armored format. +`} + + + + + +## `DELETE` examples + + + + +Removes a GPG key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + +```sql +DELETE FROM github.users.gpg_keys +WHERE gpg_key_id = '{{ gpg_key_id }}' --required +; +``` + + diff --git a/website/docs/services/users/hovercard/index.md b/website/docs/services/users/hovercard/index.md index ac30df7..70c5fd4 100644 --- a/website/docs/services/users/hovercard/index.md +++ b/website/docs/services/users/hovercard/index.md @@ -1,34 +1,148 @@ ---- +--- title: hovercard hide_title: false hide_table_of_contents: false keywords: - hovercard - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a hovercard resource. ## Overview - +
Namehovercard
Name
TypeResource
Id
## Fields + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernamesubject_type, subject_idProvides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
stringUses the ID for the `subject_type` you specified. **Required** when using `subject_type`.
stringIdentifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.
+ +## `SELECT` examples + + + + +Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.

The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + +```sql +SELECT +message, +octicon +FROM github.users.hovercard +WHERE username = '{{ username }}' -- required +AND subject_type = '{{ subject_type }}' +AND subject_id = '{{ subject_id }}' +; +``` + + diff --git a/website/docs/services/users/index.md b/website/docs/services/users/index.md index c2049bc..54edf27 100644 --- a/website/docs/services/users/index.md +++ b/website/docs/services/users/index.md @@ -9,51 +9,38 @@ keywords: - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- -Interact With And View Information About Users And Also Current User. - -:::info Service Summary +users service documentation. -
-
-total resources: 13
-total selectable resources: 13
-total methods: 41
-
-
+:::info[Service Summary] -::: +total resources: __15__ -## Overview - - - - - - -
Namegithub.users
TypeService
TitleGitHub V3 REST API - Users
DescriptionInteract With And View Information About Users And Also Current User.
Idusers:v24.04.00227
+::: ## Resources
+attestations
+attestations_bulk_deletes
+attestations_bulk_list
blocking
emails
followers
following
-gpg_keys
-hovercard
-keys
+gpg_keys
-keys_for_user
+hovercard
+keys
public_emails
public_users
social_accounts
ssh_signing_keys
-users
-
+users
+ \ No newline at end of file diff --git a/website/docs/services/users/keys/index.md b/website/docs/services/users/keys/index.md index 063e224..c7bd09e 100644 --- a/website/docs/services/users/keys/index.md +++ b/website/docs/services/users/keys/index.md @@ -1,46 +1,421 @@ ---- +--- title: keys hide_title: false hide_table_of_contents: false keywords: - keys - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a keys resource. ## Overview - +
Namekeys
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `boolean` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (date-time)
string
string (date-time)
boolean
string
string
boolean
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (date-time)
string
string (date-time)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (date-time)
string
string (date-time)
boolean
string
string
boolean
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `SELECT` | | Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `INSERT` | | Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | -| | `DELETE` | | Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
key_idView extended details for a single public SSH key.

OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
usernameper_page, pageLists the _verified_ public SSH keys for a user. This is accessible by anyone.
per_page, pageLists the public SSH keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.
keyAdds a public SSH key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint.
key_idRemoves a public SSH key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the key.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +View extended details for a single public SSH key.

OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + +```sql +SELECT +id, +created_at, +key, +last_used, +read_only, +title, +url, +verified +FROM github.users.keys +WHERE key_id = '{{ key_id }}' -- required +; +``` + + + +Lists the _verified_ public SSH keys for a user. This is accessible by anyone. + +```sql +SELECT +id, +created_at, +key, +last_used +FROM github.users.keys +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the public SSH keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + +```sql +SELECT +id, +created_at, +key, +last_used, +read_only, +title, +url, +verified +FROM github.users.keys +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Adds a public SSH key to the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. + +```sql +INSERT INTO github.users.keys ( +title, +key +) +SELECT +'{{ title }}', +'{{ key }}' /* required */ +RETURNING +id, +created_at, +key, +last_used, +read_only, +title, +url, +verified +; +``` + + + +{`# Description fields are for documentation purposes +- name: keys + props: + - name: title + value: "{{ title }}" + description: | + A descriptive name for the new key. + - name: key + value: "{{ key }}" + description: | + The public SSH key to add to your GitHub account. +`} + + + + + +## `DELETE` examples + + + + +Removes a public SSH key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + +```sql +DELETE FROM github.users.keys +WHERE key_id = '{{ key_id }}' --required +; +``` + + diff --git a/website/docs/services/users/keys_for_user/index.md b/website/docs/services/users/keys_for_user/index.md deleted file mode 100644 index e0d158a..0000000 --- a/website/docs/services/users/keys_for_user/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: keys_for_user -hide_title: false -hide_table_of_contents: false -keywords: - - keys_for_user - - users - - github - - stackql - - infrastructure-as-code - - configuration-as-data - - cloud inventory -description: Query, deploy and manage GitHub resources using SQL -custom_edit_url: null -image: /img/stackql-github-provider-featured-image.png ---- - -import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; - - - - -## Overview - - - - -
Namekeys_for_user
TypeResource
Id
- -## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | diff --git a/website/docs/services/users/public_emails/index.md b/website/docs/services/users/public_emails/index.md index 7546cb1..1c85969 100644 --- a/website/docs/services/users/public_emails/index.md +++ b/website/docs/services/users/public_emails/index.md @@ -1,40 +1,154 @@ ---- +--- title: public_emails hide_title: false hide_table_of_contents: false keywords: - public_emails - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_emails resource. ## Overview - +
Namepublic_emails
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `boolean` | -| | `boolean` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (email) (example: octocat@github.com)
boolean
boolean
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
per_page, pageLists your publicly visible email address, which you can set with the
[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
endpoint.

OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists your publicly visible email address, which you can set with the
[Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user)
endpoint.

OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + +```sql +SELECT +email, +primary, +verified, +visibility +FROM github.users.public_emails +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + diff --git a/website/docs/services/users/public_users/index.md b/website/docs/services/users/public_users/index.md index cbb5ee5..aaabf23 100644 --- a/website/docs/services/users/public_users/index.md +++ b/website/docs/services/users/public_users/index.md @@ -1,57 +1,262 @@ ---- +--- title: public_users hide_title: false hide_table_of_contents: false keywords: - public_users - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a public_users resource. ## Overview - +
Namepublic_users
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string
string (example: https://api.github.com/users/octocat/events{/privacy})
string (uri) (example: https://api.github.com/users/octocat/followers)
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
string (uri) (example: https://github.com/octocat)
string (example: octocat)
string (uri) (example: https://api.github.com/users/octocat/orgs)
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: "2020-07-09T00:17:55Z")
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
string (example: User)
string (uri) (example: https://api.github.com/users/octocat)
string (example: public)
+ + + ## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| | `SELECT` | | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
since, per_pageLists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerA user ID. Only return users with an ID greater than this ID.
+ +## `SELECT` examples + + + + +Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.

Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +email, +events_url, +followers_url, +following_url, +gists_url, +html_url, +login, +organizations_url, +received_events_url, +repos_url, +site_admin, +starred_at, +starred_url, +subscriptions_url, +type, +url, +user_view_type +FROM github.users.public_users +WHERE since = '{{ since }}' +AND per_page = '{{ per_page }}' +; +``` + + diff --git a/website/docs/services/users/social_accounts/index.md b/website/docs/services/users/social_accounts/index.md index 0e9f7a2..170f910 100644 --- a/website/docs/services/users/social_accounts/index.md +++ b/website/docs/services/users/social_accounts/index.md @@ -1,41 +1,272 @@ ---- +--- title: social_accounts hide_title: false hide_table_of_contents: false keywords: - social_accounts - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a social_accounts resource. ## Overview - +
Namesocial_accounts
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: linkedin)
string (example: https://www.linkedin.com/company/github/)
+ + + +Response + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
string (example: linkedin)
string (example: https://www.linkedin.com/company/github/)
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Lists all of your social accounts. | -| | `SELECT` | | Lists social media accounts for a user. This endpoint is accessible by anyone. | -| | `INSERT` | | Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. | -| | `DELETE` | | Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
usernameper_page, pageLists social media accounts for a user. This endpoint is accessible by anyone.
per_page, pageLists all of your social accounts.
account_urlsAdd one or more social accounts to the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
Deletes one or more social accounts from the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Lists social media accounts for a user. This endpoint is accessible by anyone. + +```sql +SELECT +provider, +url +FROM github.users.social_accounts +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists all of your social accounts. + +```sql +SELECT +provider, +url +FROM github.users.social_accounts +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Add one or more social accounts to the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + +```sql +INSERT INTO github.users.social_accounts ( +account_urls +) +SELECT +'{{ account_urls }}' /* required */ +RETURNING +provider, +url +; +``` + + + +{`# Description fields are for documentation purposes +- name: social_accounts + props: + - name: account_urls + value: + - "{{ account_urls }}" + description: | + Full URLs for the social media profiles to add. +`} + + + + + +## `DELETE` examples + + + + +Deletes one or more social accounts from the authenticated user's profile.

OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + +```sql +DELETE FROM github.users.social_accounts +; +``` + + diff --git a/website/docs/services/users/ssh_signing_keys/index.md b/website/docs/services/users/ssh_signing_keys/index.md index 39b3b0a..25dab35 100644 --- a/website/docs/services/users/ssh_signing_keys/index.md +++ b/website/docs/services/users/ssh_signing_keys/index.md @@ -1,44 +1,369 @@ ---- +--- title: ssh_signing_keys hide_title: false hide_table_of_contents: false keywords: - ssh_signing_keys - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a ssh_signing_keys resource. ## Overview - +
Namessh_signing_keys
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (date-time)
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (date-time)
string
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer
string (date-time)
string
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." | -| | `SELECT` | | Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." | -| | `SELECT` | | Lists the SSH signing keys for a user. This operation is accessible by anyone. | -| | `INSERT` | | Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." | -| | `DELETE` | | Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
ssh_signing_key_idGets extended details for an SSH signing key.

OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
usernameper_page, pageLists the SSH signing keys for a user. This operation is accessible by anyone.
per_page, pageLists the SSH signing keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.
keyCreates an SSH signing key for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.
ssh_signing_key_idDeletes an SSH signing key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integerThe unique identifier of the SSH signing key.
stringThe handle for the GitHub user account.
integerThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
integerThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
+ +## `SELECT` examples + + + + +Gets extended details for an SSH signing key.

OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + +```sql +SELECT +id, +created_at, +key, +title +FROM github.users.ssh_signing_keys +WHERE ssh_signing_key_id = '{{ ssh_signing_key_id }}' -- required +; +``` + + + +Lists the SSH signing keys for a user. This operation is accessible by anyone. + +```sql +SELECT +id, +created_at, +key, +title +FROM github.users.ssh_signing_keys +WHERE username = '{{ username }}' -- required +AND per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + +Lists the SSH signing keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + +```sql +SELECT +id, +created_at, +key, +title +FROM github.users.ssh_signing_keys +WHERE per_page = '{{ per_page }}' +AND page = '{{ page }}' +; +``` + + + + +## `INSERT` examples + + + + +Creates an SSH signing key for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + +```sql +INSERT INTO github.users.ssh_signing_keys ( +title, +key +) +SELECT +'{{ title }}', +'{{ key }}' /* required */ +RETURNING +id, +created_at, +key, +title +; +``` + + + +{`# Description fields are for documentation purposes +- name: ssh_signing_keys + props: + - name: title + value: "{{ title }}" + description: | + A descriptive name for the new key. + - name: key + value: "{{ key }}" + description: | + The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." +`} + + + + + +## `DELETE` examples + + + + +Deletes an SSH signing key from the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + +```sql +DELETE FROM github.users.ssh_signing_keys +WHERE ssh_signing_key_id = '{{ ssh_signing_key_id }}' --required +; +``` + + diff --git a/website/docs/services/users/users/index.md b/website/docs/services/users/users/index.md index 63ae6c1..51d4646 100644 --- a/website/docs/services/users/users/index.md +++ b/website/docs/services/users/users/index.md @@ -1,119 +1,1053 @@ ---- +--- title: users hide_title: false hide_table_of_contents: false keywords: - users - users - - github - - stackql + - github - infrastructure-as-code - configuration-as-data - cloud inventory -description: Query, deploy and manage GitHub resources using SQL +description: Query, deploy and manage github resources using SQL custom_edit_url: null image: /img/stackql-github-provider-featured-image.png --- import CopyableCode from '@site/src/components/CopyableCode/CopyableCode'; +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; - - +Creates, updates, deletes, gets or lists a users resource. ## Overview - +
Nameusers
Name
TypeResource
Id
## Fields -| Name | Datatype | -|:-----|:---------| -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `integer` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `object` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `object` | -| | `integer` | -| | `integer` | -| | `integer` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `integer` | -| | `string` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | -| | `integer` | -| | `string` | -| | `boolean` | -| | `string` | -| | `string` | -| | `string` | + +The following fields are returned by `SELECT` queries: + + + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: monalisa octocat)
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string (example: There once was...)
string (example: https://github.com/blog)
boolean
integer
string (example: GitHub)
string (date-time) (example: 2008-01-14T04:33:35Z)
integer
string (email) (example: octocat@github.com)
string (example: https://api.github.com/users/octocat/events{/privacy})
integer
string (uri) (example: https://api.github.com/users/octocat/followers)
integer
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
boolean
string (uri) (example: https://github.com/octocat)
string
string (example: San Francisco)
string (example: octocat)
string (email) (example: octocat@github.com)
string (uri) (example: https://api.github.com/users/octocat/orgs)
integer
object
integer
integer
integer
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
integer
string (example: monalisa)
boolean
string (example: User)
string (date-time) (example: 2008-01-14T04:33:35Z)
string (uri) (example: https://api.github.com/users/octocat)
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: monalisa octocat)
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string (example: There once was...)
string (example: https://github.com/blog)
boolean
integer
string (example: GitHub)
string (date-time) (example: 2008-01-14T04:33:35Z)
integer
string (email) (example: octocat@github.com)
string (example: https://api.github.com/users/octocat/events{/privacy})
integer
string (uri) (example: https://api.github.com/users/octocat/followers)
integer
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
boolean
string (uri) (example: https://github.com/octocat)
string
string (example: San Francisco)
string (example: octocat)
string (email) (example: octocat@github.com)
string (uri) (example: https://api.github.com/users/octocat/orgs)
integer
object
integer
integer
integer
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
integer
string (example: monalisa)
boolean
string (example: User)
string (date-time) (example: 2008-01-14T04:33:35Z)
string (uri) (example: https://api.github.com/users/octocat)
string
+ + + +Response + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integer (int64)
string (example: monalisa octocat)
string (example: 41d064eb2195891e12d0413f63227ea7)
string (example: MDQ6VXNlcjE=)
string (uri) (example: https://github.com/images/error/octocat_happy.gif)
string (example: There once was...)
string (example: https://github.com/blog)
boolean
integer
string (example: GitHub)
string (date-time) (example: 2008-01-14T04:33:35Z)
integer
string (email) (example: octocat@github.com)
string (example: https://api.github.com/users/octocat/events{/privacy})
integer
string (uri) (example: https://api.github.com/users/octocat/followers)
integer
string (example: https://api.github.com/users/octocat/following{/other_user})
string (example: https://api.github.com/users/octocat/gists{/gist_id})
boolean
string (uri) (example: https://github.com/octocat)
string
string (example: San Francisco)
string (example: octocat)
string (email) (example: octocat@github.com)
string (uri) (example: https://api.github.com/users/octocat/orgs)
integer
object
integer
integer
integer
string (uri) (example: https://api.github.com/users/octocat/received_events)
string (uri) (example: https://api.github.com/users/octocat/repos)
boolean
string (example: https://api.github.com/users/octocat/starred{/owner}{/repo})
string (uri) (example: https://api.github.com/users/octocat/subscriptions)
integer
string (example: monalisa)
boolean
string (example: User)
string (date-time) (example: 2008-01-14T04:33:35Z)
string (uri) (example: https://api.github.com/users/octocat)
string
+ + + ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| | `SELECT` | | If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information.

If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. | -| | `SELECT` | | Provides publicly available information about someone with a GitHub account.

GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below"

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be β€œpublic” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". | -| | `EXEC` | | **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. | + +The following methods are available for this resource: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAccessible byRequired ParamsOptional ParamsDescription
account_idProvides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
usernameProvides publicly available information about someone with a GitHub account.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails).
OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information.
**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.
+ +## Parameters + +Parameters can be passed in the `WHERE` clause of a query. Check the [Methods](#methods) section to see which parameters are required or optional for each operation. + + + + + + + + + + + + + + + + + + + + + +
NameDatatypeDescription
integeraccount_id parameter
stringThe handle for the GitHub user account.
+ +## `SELECT` examples + + + + +Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +bio, +blog, +business_plus, +collaborators, +company, +created_at, +disk_usage, +email, +events_url, +followers, +followers_url, +following, +following_url, +gists_url, +hireable, +html_url, +ldap_dn, +location, +login, +notification_email, +organizations_url, +owned_private_repos, +plan, +private_gists, +public_gists, +public_repos, +received_events_url, +repos_url, +site_admin, +starred_url, +subscriptions_url, +total_private_repos, +twitter_username, +two_factor_authentication, +type, +updated_at, +url, +user_view_type +FROM github.users.users +WHERE account_id = '{{ account_id }}' -- required +; +``` + + + +Provides publicly available information about someone with a GitHub account.

If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status.

The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication).

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +bio, +blog, +business_plus, +collaborators, +company, +created_at, +disk_usage, +email, +events_url, +followers, +followers_url, +following, +following_url, +gists_url, +hireable, +html_url, +ldap_dn, +location, +login, +notification_email, +organizations_url, +owned_private_repos, +plan, +private_gists, +public_gists, +public_repos, +received_events_url, +repos_url, +site_admin, +starred_url, +subscriptions_url, +total_private_repos, +twitter_username, +two_factor_authentication, +type, +updated_at, +url, +user_view_type +FROM github.users.users +WHERE username = '{{ username }}' -- required +; +``` + + + +OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. + +```sql +SELECT +id, +name, +gravatar_id, +node_id, +avatar_url, +bio, +blog, +business_plus, +collaborators, +company, +created_at, +disk_usage, +email, +events_url, +followers, +followers_url, +following, +following_url, +gists_url, +hireable, +html_url, +ldap_dn, +location, +login, +notification_email, +organizations_url, +owned_private_repos, +plan, +private_gists, +public_gists, +public_repos, +received_events_url, +repos_url, +site_admin, +starred_url, +subscriptions_url, +total_private_repos, +twitter_username, +two_factor_authentication, +type, +updated_at, +url, +user_view_type +FROM github.users.users +; +``` + + + + +## `UPDATE` examples + + + + +**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. + +```sql +UPDATE github.users.users +SET +name = '{{ name }}', +email = '{{ email }}', +blog = '{{ blog }}', +twitter_username = '{{ twitter_username }}', +company = '{{ company }}', +location = '{{ location }}', +hireable = {{ hireable }}, +bio = '{{ bio }}' +RETURNING +id, +name, +gravatar_id, +node_id, +avatar_url, +bio, +blog, +business_plus, +collaborators, +company, +created_at, +disk_usage, +email, +events_url, +followers, +followers_url, +following, +following_url, +gists_url, +hireable, +html_url, +ldap_dn, +location, +login, +notification_email, +organizations_url, +owned_private_repos, +plan, +private_gists, +public_gists, +public_repos, +received_events_url, +repos_url, +site_admin, +starred_url, +subscriptions_url, +total_private_repos, +twitter_username, +two_factor_authentication, +type, +updated_at, +url, +user_view_type; +``` + +